[
{
"path": ".dockerignore",
"content": ".git\n/shared-*\nrelease-v*/**\n"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: '[Bug]: '\nlabels: [\"bug\", \"needs-triage\"]\ntype: bug\n\n---\n\n_**Important Note: NVIDIA AI Enterprise customers can get support from NVIDIA Enterprise support. Please open a case [here](https://enterprise-support.nvidia.com/s/create-case)**._\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To Reproduce**\nDetailed steps to reproduce the issue.\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Environment (please provide the following information):**\n - `nvidia-container-toolkit` version: [e.g. `v1.18.2`]\n - NVIDIA Driver Version: [e.g. 580.105.08]\n - Host OS: [e.g. Ubuntu24.04]\n - Kernel Version: [e.g. 6.8.0-generic]\n - Container Runtime Version: [e.g. containerd 2.0.0]\n - CPU Architecture [e.g. `x86_64`, `arm64` ]\n - GPU Model(s) [e.g. A100, L40, RTX 3090]\n\n If applicable, also provide:\n - Kubernetes Distro and Version: [e.g. K8s, OpenShift, Rancher, GKE, EKS]\n - NVIDIA GPU Operator version\n - CUDA Version\n\n**Information to [attach](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/)** (optional if deemed irrelevant)\n\n- Output of `nvidia-smi`\n- Container logs\n"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"content": "blank_issues_enabled: false\n"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"content": "---\nname: Feature request\nabout: Submit a feature request\ntitle: \"[Feature]: \"\nlabels: [\"feature\", \"needs-triage\", \"lifecycle/frozen\"]\ntype: enhancement\n\n---\n\n\n"
},
{
"path": ".github/ISSUE_TEMPLATE/question.md",
"content": "---\nname: Question / General Discussion\nabout: Ask a question or raise a discussion\ntitle: \"[Question]: \"\nlabels: [\"question\"]\n---\n\n\n"
},
{
"path": ".github/copy-pr-bot.yaml",
"content": "# https://docs.gha-runners.nvidia.com/apps/copy-pr-bot/#configuration\n\nenabled: true\n"
},
{
"path": ".github/dependabot.yml",
"content": "# Please see the documentation for all configuration options:\n# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates\n\nversion: 2\nupdates:\n# main branch\n - package-ecosystem: \"gomod\"\n target-branch: main\n directories:\n - \"/\"\n - \"deployments/devel\"\n - \"tests\"\n schedule:\n interval: \"daily\"\n labels:\n - dependencies\n groups:\n k8sio:\n patterns:\n - k8s.io/*\n exclude-patterns:\n - k8s.io/klog/*\n\n - package-ecosystem: \"docker\"\n target-branch: main\n directories:\n # CUDA image\n - \"/deployments/container\"\n # Golang version\n - \"/deployments/devel\"\n schedule:\n interval: \"daily\"\n labels:\n - dependencies\n\n - package-ecosystem: \"github-actions\"\n target-branch: main\n directory: \"/\"\n schedule:\n interval: \"daily\"\n labels:\n - dependencies\n\n # Allow dependabot to update the libnvidia-container submodule.\n - package-ecosystem: \"gitsubmodule\"\n target-branch: main\n directory: \"/\"\n allow:\n - dependency-name: \"third_party/libnvidia-container\"\n schedule:\n interval: \"daily\"\n labels:\n - dependencies\n - libnvidia-container\n\n# The release branch(es):\n - package-ecosystem: \"gomod\"\n target-branch: release-1.18\n directories:\n - \"/\"\n # We don't update development or test dependencies on release branches\n # - \"deployments/devel\"\n # - \"tests\"\n schedule:\n interval: \"weekly\"\n day: \"sunday\"\n labels:\n - dependencies\n - maintenance\n ignore:\n # For release branches we only consider patch updates.\n - dependency-name: \"*\"\n update-types:\n - version-update:semver-major\n - version-update:semver-minor\n groups:\n k8sio:\n patterns:\n - k8s.io/*\n exclude-patterns:\n - k8s.io/klog/*\n\n - package-ecosystem: \"docker\"\n target-branch: release-1.18\n directories:\n # CUDA image\n - \"/deployments/container\"\n # Golang version\n - \"/deployments/devel\"\n schedule:\n interval: \"weekly\"\n day: \"sunday\"\n ignore:\n # For release branches we only apply patch updates to the golang version.\n - dependency-name: \"*golang*\"\n update-types:\n - version-update:semver-major\n - version-update:semver-minor\n labels:\n - dependencies\n - maintenance\n\n - package-ecosystem: \"github-actions\"\n target-branch: release-1.18\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n day: \"sunday\"\n labels:\n - dependencies\n - maintenance\n\n # Github actions need to be gh-pages branches.\n - package-ecosystem: \"github-actions\"\n target-branch: gh-pages\n directory: \"/\"\n schedule:\n interval: \"daily\"\n labels:\n - dependencies\n"
},
{
"path": ".github/scripts/add-labels-from-comment.js",
"content": "/**\n * Copyright 2025 NVIDIA CORPORATION\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nmodule.exports = async ({ github, context, core }) => {\n const commentBody = context.payload.comment.body;\n const prNumber = context.payload.issue.number;\n\n core.info(`Processing comment: ${commentBody}`);\n\n // Parse comment for /cherry-pick branches\n const cherryPickPattern = /^\\/cherry-pick\\s+(.+)$/m;\n const match = commentBody.match(cherryPickPattern);\n\n if (!match) {\n core.warning('Comment does not match /cherry-pick pattern');\n return { success: false, message: 'Invalid format' };\n }\n\n // Extract all release branches (space-separated)\n const branchesText = match[1].trim();\n const branchPattern = /release-\\d+\\.\\d+(?:\\.\\d+)?/g;\n const branches = branchesText.match(branchPattern) || [];\n\n if (branches.length === 0) {\n core.warning('No valid release branches found in comment');\n await github.rest.reactions.createForIssueComment({\n owner: context.repo.owner,\n repo: context.repo.repo,\n comment_id: context.payload.comment.id,\n content: 'confused'\n });\n return { success: false, message: 'No valid branches found' };\n }\n\n core.info(`Found branches: ${branches.join(', ')}`);\n\n // Add labels to PR\n const labels = branches.map(branch => `cherry-pick/${branch}`);\n \n try {\n await github.rest.issues.addLabels({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: prNumber,\n labels: labels\n });\n core.info(`Added labels: ${labels.join(', ')}`);\n } catch (error) {\n core.error(`Failed to add labels: ${error.message}`);\n await github.rest.reactions.createForIssueComment({\n owner: context.repo.owner,\n repo: context.repo.repo,\n comment_id: context.payload.comment.id,\n content: '-1'\n });\n return { success: false, message: error.message };\n }\n\n // React with checkmark emoji\n await github.rest.reactions.createForIssueComment({\n owner: context.repo.owner,\n repo: context.repo.repo,\n comment_id: context.payload.comment.id,\n content: '+1'\n });\n\n // Check if PR is already merged\n const { data: pullRequest } = await github.rest.pulls.get({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: prNumber\n });\n\n if (pullRequest.merged) {\n core.info('PR is already merged - triggering backport immediately');\n \n // Set branches in environment and trigger backport\n process.env.BRANCHES_JSON = JSON.stringify(branches);\n \n // Run backport script\n const backportScript = require('./backport.js');\n const results = await backportScript({ github, context, core });\n \n return { \n success: true, \n message: `Labels added and backport triggered for: ${branches.join(', ')}`,\n backportResults: results\n };\n } else {\n core.info('PR not yet merged - labels added, backport will trigger on merge');\n return { \n success: true, \n message: `Labels added for: ${branches.join(', ')}. Backport will trigger on merge.`\n };\n }\n};\n\n"
},
{
"path": ".github/scripts/backport.js",
"content": "/**\n * Copyright 2025 NVIDIA CORPORATION\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nmodule.exports = async ({ github, context, core }) => {\nconst branches = JSON.parse(process.env.BRANCHES_JSON || '[]');\n\n// Get PR number from event\nconst prNumber = context.payload.pull_request?.number || context.payload.issue.number;\n\n// Fetch full PR data (needed when triggered via issue_comment)\nconst { data: pullRequest } = await github.rest.pulls.get({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: prNumber\n});\n\nconst prTitle = pullRequest.title;\nconst prAuthor = pullRequest.user.login;\n\n// Get all commits from the PR\nconst { data: commits } = await github.rest.pulls.listCommits({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: prNumber\n});\n\nif (commits.length === 0) {\n core.warning('No commits found in PR - skipping backport');\n return [];\n}\n\ncore.info(`Backporting PR #${prNumber}: \"${prTitle}\"`);\ncore.info(`Commits to cherry-pick: ${commits.length}`);\ncommits.forEach((commit, index) => {\n core.info(` ${index + 1}. ${commit.sha.substring(0, 7)} - ${commit.commit.message.split('\\n')[0]}`);\n});\n\nconst { execSync } = require('child_process');\n\nconst results = [];\n\nfor (const targetBranch of branches) {\n core.info(`\\n========================================`);\n core.info(`Backporting to ${targetBranch}`);\n core.info(`========================================`);\n const backportBranch = `backport-${prNumber}-to-${targetBranch}`;\n try {\n // Create/reset backport branch from target release branch\n core.info(`Creating/resetting branch ${backportBranch} from ${targetBranch}`);\n execSync(`git fetch origin ${targetBranch}:${targetBranch}`, { stdio: 'inherit' });\n execSync(`git checkout -B ${backportBranch} ${targetBranch}`, { stdio: 'inherit' });\n // Cherry-pick each commit from the PR\n let hasConflicts = false;\n for (let i = 0; i < commits.length; i++) {\n const commit = commits[i];\n const commitSha = commit.sha;\n const commitMessage = commit.commit.message.split('\\n')[0];\n core.info(`Cherry-picking commit ${i + 1}/${commits.length}: ${commitSha.substring(0, 7)} - ${commitMessage}`);\n try {\n execSync(`git cherry-pick -m 1 -x ${commitSha}`, { \n encoding: 'utf-8',\n stdio: 'pipe'\n });\n } catch (error) {\n // Check if it's a conflict\n const status = execSync('git status', { encoding: 'utf-8' });\n if (status.includes('Unmerged paths') || status.includes('both modified')) {\n hasConflicts = true;\n core.warning(`Cherry-pick has conflicts for commit ${commitSha.substring(0, 7)}.`);\n // Add all files (including conflicted ones) and commit\n execSync('git add .', { stdio: 'inherit' });\n try {\n execSync(`git -c core.editor=true cherry-pick --continue`, { stdio: 'inherit' });\n } catch (e) {\n // If continue fails, make a simple commit\n execSync(`git commit --no-edit --allow-empty-message || git commit -m \"Cherry-pick ${commitSha} (with conflicts)\"`, { stdio: 'inherit' });\n }\n } else if (error.message && error.message.includes('previous cherry-pick is now empty')) {\n // Handle empty commits (changes already exist in target branch)\n core.info(`Commit ${commitSha.substring(0, 7)} is empty (changes already in target branch), skipping`);\n execSync('git cherry-pick --skip', { stdio: 'inherit' });\n } else {\n throw error;\n }\n }\n }\n // Push the backport branch (force to handle updates)\n core.info(`Pushing ${backportBranch} to origin`);\n execSync(`git push --force-with-lease origin ${backportBranch}`, { stdio: 'inherit' });\n \n // Check if a PR already exists for this backport branch\n const { data: existingPRs } = await github.rest.pulls.list({\n owner: context.repo.owner,\n repo: context.repo.repo,\n head: `${context.repo.owner}:${backportBranch}`,\n base: targetBranch,\n state: 'open'\n });\n const existingPR = existingPRs.length > 0 ? existingPRs[0] : null;\n \n // Create pull request\n const commitList = commits.map(c => `- \\`${c.sha.substring(0, 7)}\\` ${c.commit.message.split('\\n')[0]}`).join('\\n');\n \n // Build PR body based on conflict status\n let prBody = `🤖 **Automated backport of #${prNumber} to \\`${targetBranch}\\`**\\n\\n`;\n \n if (hasConflicts) {\n prBody += `⚠️ **This PR has merge conflicts that need manual resolution.**\n\nOriginal PR: #${prNumber}\nOriginal Author: @${prAuthor}\n\n**Cherry-picked commits (${commits.length}):**\n${commitList}\n\n**Next Steps:**\n1. Review the conflicts in the \"Files changed\" tab\n2. Check out this branch locally: \\`git fetch origin ${backportBranch} && git checkout ${backportBranch}\\`\n3. Resolve conflicts manually\n4. Push the resolution: \\`git push --force-with-lease origin ${backportBranch}\\`\n\n---\n\nInstructions for resolving conflicts\n\n\\`\\`\\`bash\ngit fetch origin ${backportBranch}\ngit checkout ${backportBranch}\n# Resolve conflicts in your editor\ngit add .\ngit commit\ngit push --force-with-lease origin ${backportBranch}\n\\`\\`\\`\n`;\n } else {\n prBody += `✅ Cherry-pick completed successfully with no conflicts.\n\nOriginal PR: #${prNumber}\nOriginal Author: @${prAuthor}\n\n**Cherry-picked commits (${commits.length}):**\n${commitList}\n\nThis backport was automatically created by the backport bot.`;\n }\n\n if (existingPR) {\n // Update existing PR\n core.info(`Found existing PR #${existingPR.number}, updating it`);\n await github.rest.pulls.update({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: existingPR.number,\n body: prBody,\n draft: hasConflicts\n });\n \n // Update labels\n const currentLabels = existingPR.labels.map(l => l.name);\n const desiredLabels = ['backport', hasConflicts ? 'needs-manual-resolution' : 'auto-backport'];\n \n // Remove old labels if conflict status changed\n if (hasConflicts && currentLabels.includes('auto-backport')) {\n await github.rest.issues.removeLabel({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: existingPR.number,\n name: 'auto-backport'\n }).catch(() => {}); // Ignore if label doesn't exist\n } else if (!hasConflicts && currentLabels.includes('needs-manual-resolution')) {\n await github.rest.issues.removeLabel({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: existingPR.number,\n name: 'needs-manual-resolution'\n }).catch(() => {}); // Ignore if label doesn't exist\n }\n \n // Add current labels\n await github.rest.issues.addLabels({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: existingPR.number,\n labels: desiredLabels\n });\n \n // Comment about the update\n await github.rest.issues.createComment({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: prNumber,\n body: `🤖 Updated existing backport PR for \\`${targetBranch}\\`: #${existingPR.number} ${hasConflicts ? '⚠️ (has conflicts)' : '✅'}`\n });\n \n results.push({\n branch: targetBranch,\n success: true,\n prNumber: existingPR.number,\n prUrl: existingPR.html_url,\n hasConflicts,\n updated: true\n });\n core.info(`✅ Successfully updated backport PR #${existingPR.number}`);\n } else {\n // Create new PR\n const newPR = await github.rest.pulls.create({\n owner: context.repo.owner,\n repo: context.repo.repo,\n title: `[${targetBranch}] ${prTitle}`,\n head: backportBranch,\n base: targetBranch,\n body: prBody,\n draft: hasConflicts\n });\n // Add labels\n await github.rest.issues.addLabels({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: newPR.data.number,\n labels: ['backport', hasConflicts ? 'needs-manual-resolution' : 'auto-backport']\n });\n // Link to original PR\n await github.rest.issues.createComment({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: prNumber,\n body: `🤖 Backport PR created for \\`${targetBranch}\\`: #${newPR.data.number} ${hasConflicts ? '⚠️ (has conflicts)' : '✅'}`\n });\n results.push({\n branch: targetBranch,\n success: true,\n prNumber: newPR.data.number,\n prUrl: newPR.data.html_url,\n hasConflicts,\n updated: false\n });\n core.info(`✅ Successfully created backport PR #${newPR.data.number}`);\n }\n } catch (error) {\n core.error(`❌ Failed to backport to ${targetBranch}: ${error.message}`);\n // Comment on original PR about the failure\n await github.rest.issues.createComment({\n owner: context.repo.owner,\n repo: context.repo.repo,\n issue_number: prNumber,\n body: `❌ Failed to create backport PR for \\`${targetBranch}\\`\\n\\nError: ${error.message}\\n\\nPlease backport manually.`\n });\n results.push({\n branch: targetBranch,\n success: false,\n error: error.message\n });\n } finally {\n // Clean up: go back to main branch\n try {\n execSync('git checkout main', { stdio: 'inherit' });\n execSync(`git branch -D ${backportBranch} 2>/dev/null || true`, { stdio: 'inherit' });\n } catch (e) {\n // Ignore cleanup errors\n }\n }\n}\n\n// Summary (console only)\ncore.info('\\n========================================');\ncore.info('Backport Summary');\ncore.info('========================================');\nfor (const result of results) {\n if (result.success) {\n const action = result.updated ? 'Updated' : 'Created';\n core.info(`✅ ${result.branch}: ${action} PR #${result.prNumber} ${result.hasConflicts ? '(has conflicts)' : ''}`);\n } else {\n core.error(`❌ ${result.branch}: ${result.error}`);\n }\n}\nreturn results;\n};\n"
},
{
"path": ".github/scripts/extract-branches.js",
"content": "/**\n * Copyright 2025 NVIDIA CORPORATION\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nmodule.exports = async ({ github, context, core }) => {\n let branches = [];\n\n // Get PR labels\n const labels = context.payload.pull_request?.labels || [];\n\n if (labels.length === 0) {\n core.info('No labels found on PR - skipping backport');\n return [];\n }\n\n // Extract branches from cherry-pick/* labels\n const cherryPickPattern = /^cherry-pick\\/(release-\\d+\\.\\d+(?:\\.\\d+)?)$/;\n \n for (const label of labels) {\n const match = label.name.match(cherryPickPattern);\n if (match) {\n branches.push(match[1]);\n core.info(`Found cherry-pick label: ${label.name} -> ${match[1]}`);\n }\n }\n\n if (branches.length === 0) {\n core.info('No cherry-pick labels found - skipping backport');\n return [];\n }\n\n core.info(`Target branches: ${branches.join(', ')}`);\n return branches;\n};\n"
},
{
"path": ".github/workflows/cherrypick.yml",
"content": "# Copyright 2025 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nname: Cherry-Pick\n\non:\n issue_comment:\n types: [created]\n pull_request_target:\n types: [closed]\n\npermissions:\n contents: write\n pull-requests: write\n issues: write\n\njobs:\n add-labels:\n name: Add Cherry-Pick Labels from Comment\n runs-on: ubuntu-latest\n # Run on /cherry-pick comments on PRs\n if: |\n github.event_name == 'issue_comment' &&\n github.event.issue.pull_request && \n startsWith(github.event.comment.body, '/cherry-pick')\n \n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n with:\n fetch-depth: 0\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Configure git\n run: |\n git config user.name \"github-actions[bot]\"\n git config user.email \"41898282+github-actions[bot]@users.noreply.github.com\"\n\n - name: Add labels and handle backport\n uses: actions/github-script@v8\n with:\n script: |\n const run = require('./.github/scripts/add-labels-from-comment.js');\n return await run({ github, context, core });\n\n backport:\n name: Backport PR\n runs-on: ubuntu-latest\n # Run when PR is merged and has cherry-pick labels\n if: |\n github.event_name == 'pull_request_target' &&\n github.event.pull_request.merged == true &&\n contains(join(github.event.pull_request.labels.*.name, ','), 'cherry-pick/')\n \n steps:\n - name: Checkout base branch repository\n uses: actions/checkout@v6\n with:\n fetch-depth: 0\n ref: ${{ github.event.pull_request.base.ref }}\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Extract target branches from PR labels\n id: extract-branches\n uses: actions/github-script@v8\n with:\n script: |\n const run = require('./.github/scripts/extract-branches.js');\n return await run({ github, context, core });\n\n - name: Configure git\n if: steps.extract-branches.outputs.result != '[]'\n run: |\n git config user.name \"nvidia-backport-bot\"\n git config user.email \"noreply@nvidia.com\"\n\n - name: Backport to release branches\n id: backport\n if: steps.extract-branches.outputs.result != '[]'\n uses: actions/github-script@v8\n env:\n BRANCHES_JSON: ${{ steps.extract-branches.outputs.result }}\n with:\n script: |\n const run = require('./.github/scripts/backport.js');\n return await run({ github, context, core });\n"
},
{
"path": ".github/workflows/ci.yaml",
"content": "# Copyright 2025 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nname: CI Pipeline\n\non:\n push:\n branches:\n - \"pull-request/[0-9]+\"\n - main\n - release-*\n\njobs:\n code-scanning:\n uses: ./.github/workflows/code_scanning.yaml\n\n variables:\n runs-on: ubuntu-latest\n outputs:\n version: ${{ steps.version.outputs.version }}\n steps:\n - name: Generate Commit Short SHA\n id: version\n run: echo \"version=$(echo $GITHUB_SHA | cut -c1-8)\" >> \"$GITHUB_OUTPUT\"\n\n golang:\n secrets: inherit\n uses: ./.github/workflows/golang.yaml\n\n image:\n uses: ./.github/workflows/image.yaml\n needs: [variables, golang, code-scanning]\n secrets: inherit\n with:\n version: ${{ needs.variables.outputs.version }}\n build_multi_arch_images: ${{ github.ref_name == 'main' || startsWith(github.ref_name, 'release-') }}\n\n e2e-test:\n needs: [image, variables]\n secrets: inherit\n uses: ./.github/workflows/e2e.yaml\n with:\n version: ${{ needs.variables.outputs.version }}\n"
},
{
"path": ".github/workflows/code_scanning.yaml",
"content": "# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nname: \"CodeQL\"\n\non:\n workflow_call: {}\n pull_request:\n types:\n - opened\n - synchronize\n branches:\n - main\n - release-*\n\njobs:\n analyze:\n name: Analyze Go code with CodeQL\n runs-on: ubuntu-latest\n timeout-minutes: 360\n permissions:\n security-events: write\n packages: read\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v4\n with:\n languages: go\n build-mode: manual\n - shell: bash\n run: |\n make build\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v4\n with:\n category: \"/language:go\"\n"
},
{
"path": ".github/workflows/e2e.yaml",
"content": "# Copyright 2025 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nname: End-to-end Tests\n\non:\n workflow_call:\n inputs:\n version:\n required: true\n type: string\n secrets:\n AWS_ACCESS_KEY_ID:\n required: true\n AWS_SECRET_ACCESS_KEY:\n required: true\n AWS_SSH_KEY:\n required: true\n E2E_SSH_USER:\n required: true\n SLACK_BOT_TOKEN:\n required: true\n SLACK_CHANNEL_ID:\n required: true\n\njobs:\n e2e-tests:\n runs-on: linux-amd64-cpu4\n strategy:\n matrix:\n ispr:\n - ${{ github.ref_name != 'main' && !startsWith( github.ref_name, 'release-' ) }}\n driver_branch:\n # LTS branch. EOL June 2026\n - 535\n # Production branch. EOL February 2026\n - 570\n # LTS branch. EOL August 2028\n - 580\n exclude:\n - ispr: true\n driver_branch: 570\n - ispr: true\n driver_branch: 580\n steps:\n - name: Check out code\n uses: actions/checkout@v6\n\n - name: Calculate build vars\n id: vars\n run: |\n echo \"COMMIT_SHORT_SHA=${GITHUB_SHA:0:8}\" >> $GITHUB_ENV\n echo \"LOWERCASE_REPO_OWNER=$(echo \"${GITHUB_REPOSITORY_OWNER}\" | awk '{print tolower($0)}')\" >> $GITHUB_ENV\n GOLANG_VERSION=$(./hack/golang-version.sh)\n echo \"GOLANG_VERSION=${GOLANG_VERSION##GOLANG_VERSION := }\" >> $GITHUB_ENV\n\n - name: Install Go\n uses: actions/setup-go@v6\n with:\n go-version: ${{ env.GOLANG_VERSION }}\n\n - name: Set up Holodeck (${{ matrix.driver_branch }})\n uses: NVIDIA/holodeck@v0.2.13\n with:\n aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}\n aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}\n aws_ssh_key: ${{ secrets.AWS_SSH_KEY }}\n holodeck_config: tests/e2e/infra/driver-branch-${{ matrix.driver_branch }}.yaml\n\n - name: Get public dns name\n id: holodeck_public_dns_name\n uses: mikefarah/yq@master\n with:\n cmd: yq '.status.properties[] | select(.name == \"public-dns-name\") | .value' /github/workspace/.cache/holodeck.yaml\n\n - name: Run e2e tests (${{ matrix.driver_branch }})\n env:\n E2E_INSTALL_CTK: \"true\"\n E2E_IMAGE_NAME: ghcr.io/nvidia/container-toolkit\n E2E_IMAGE_TAG: ${{ inputs.version }}\n E2E_SSH_USER: ${{ secrets.E2E_SSH_USER }}\n E2E_SSH_HOST: ${{ steps.holodeck_public_dns_name.outputs.result }}\n run: |\n e2e_ssh_key=$(mktemp)\n echo \"${{ secrets.AWS_SSH_KEY }}\" > \"$e2e_ssh_key\"\n chmod 600 \"$e2e_ssh_key\"\n export E2E_SSH_KEY=\"$e2e_ssh_key\"\n\n make -f tests/e2e/Makefile test\n\n - name: Archive Ginkgo logs\n uses: actions/upload-artifact@v7\n with:\n name: ginkgo-logs-${{ matrix.driver_branch }}\n path: ginkgo.json\n retention-days: 15\n\n - name: Send Slack alert notification\n if: ${{ failure() }}\n uses: slackapi/slack-github-action@v2.1.1\n with:\n method: chat.postMessage\n token: ${{ secrets.SLACK_BOT_TOKEN }}\n payload: |\n channel: ${{ secrets.SLACK_CHANNEL_ID }}\n text: |\n :x: On repository ${{ github.repository }}, the Workflow *${{ github.workflow }}-driver-branch-${{ matrix.driver_branch }}* has failed.\n\n Details: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n"
},
{
"path": ".github/workflows/golang.yaml",
"content": "# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nname: Golang\n\non:\n workflow_call: {}\n pull_request:\n types:\n - opened\n - synchronize\n branches:\n - main\n - release-*\n\njobs:\n check:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n name: Checkout code\n\n - name: Get Golang version\n id: vars\n run: |\n GOLANG_VERSION=$(./hack/golang-version.sh)\n echo \"GOLANG_VERSION=${GOLANG_VERSION##GOLANG_VERSION := }\" >> $GITHUB_ENV\n\n - name: Install Go\n uses: actions/setup-go@v6\n with:\n go-version: ${{ env.GOLANG_VERSION }}\n\n - name: Lint\n uses: golangci/golangci-lint-action@v9\n with:\n version: latest\n args: -v --timeout 5m\n skip-cache: true\n\n - name: Check golang modules\n run: |\n make check-vendor\n make -C deployments/devel check-modules\n\n test:\n name: Unit test\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@v6\n\n - name: Get Golang version\n id: vars\n run: |\n GOLANG_VERSION=$(./hack/golang-version.sh)\n echo \"GOLANG_VERSION=${GOLANG_VERSION##GOLANG_VERSION := }\" >> $GITHUB_ENV\n\n - name: Install Go\n uses: actions/setup-go@v6\n with:\n go-version: ${{ env.GOLANG_VERSION }}\n\n - name: Run unit tests and generate coverage report\n run: make coverage\n\n - name: Upload to Coveralls\n continue-on-error: true\n uses: coverallsapp/github-action@v2\n with:\n github-token: ${{ secrets.GITHUB_TOKEN }}\n file: coverage.out\n\n build:\n name: Build\n runs-on: ${{ ( github.event_name == 'pull_request' ) && 'ubuntu-latest' || 'linux-amd64-cpu4' }}\n permissions:\n contents: read\n id-token: write\n steps:\n - name: Checkout code\n uses: actions/checkout@v6\n\n - name: Get Golang version\n id: vars\n run: |\n GOLANG_VERSION=$(./hack/golang-version.sh)\n echo \"GOLANG_VERSION=${GOLANG_VERSION##GOLANG_VERSION ?= }\" >> $GITHUB_ENV\n\n - name: Install Go\n uses: actions/setup-go@v6\n with:\n go-version: ${{ env.GOLANG_VERSION }}\n\n - name: Setup Go Proxy\n if: ${{ !( github.event_name == 'pull_request' ) }}\n id: setup-go-proxy\n uses: nv-gha-runners/setup-artifactory-go-proxy@main\n\n - env:\n GOPROXY: ${{ ( github.event_name == 'pull_request' ) && '' || steps.setup-go-proxy.outputs.goproxy-url }}\n run: |\n make build\n"
},
{
"path": ".github/workflows/image.yaml",
"content": "# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# Run this workflow on pull requests\nname: image\n\non:\n workflow_call:\n inputs:\n version:\n required: true\n type: string\n build_multi_arch_images:\n required: true\n type: string\n\njobs:\n packages:\n runs-on: ubuntu-latest\n strategy:\n matrix:\n target:\n - ubuntu18.04-arm64\n - ubuntu18.04-amd64\n - centos7-aarch64\n - centos7-x86_64\n ispr:\n - ${{ github.ref_name != 'main' && !startsWith( github.ref_name, 'release-' ) }}\n exclude:\n - ispr: true\n target: ubuntu18.04-arm64\n - ispr: true\n target: centos7-aarch64\n fail-fast: false\n\n steps:\n - uses: actions/checkout@v6\n name: Check out code\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@v3\n with:\n image: tonistiigi/binfmt:master\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@v3\n\n - name: build ${{ matrix.target }} packages\n run: |\n sudo apt-get install -y coreutils build-essential sed git bash make\n echo \"Building packages\"\n ./scripts/build-packages.sh ${{ matrix.target }}\n\n - name: 'Upload Artifacts'\n uses: actions/upload-artifact@v7\n with:\n compression-level: 0\n name: toolkit-container-${{ matrix.target }}-${{ github.run_id }}\n path: ${{ github.workspace }}/dist/*\n\n image:\n runs-on: linux-amd64-cpu4\n permissions:\n contents: read\n id-token: write\n packages: write\n strategy:\n matrix:\n target:\n - application\n - packaging\n needs: packages\n steps:\n - uses: actions/checkout@v6\n name: Check out code\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@v3\n with:\n image: tonistiigi/binfmt:master\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@v3\n\n - name: Get built packages\n uses: actions/download-artifact@v8\n with:\n path: ${{ github.workspace }}/dist/\n pattern: toolkit-container-*-${{ github.run_id }}\n merge-multiple: true\n\n - name: Login to GitHub Container Registry\n uses: docker/login-action@v3\n with:\n registry: ghcr.io\n username: ${{ github.actor }}\n password: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Setup Go Proxy\n id: setup-go-proxy\n uses: nv-gha-runners/setup-artifactory-go-proxy@main\n\n - name: Build image\n env:\n IMAGE_NAME: ghcr.io/nvidia/container-toolkit\n VERSION: ${{ inputs.version }}\n PUSH_ON_BUILD: \"true\"\n BUILD_MULTI_ARCH_IMAGES: ${{ inputs.build_multi_arch_images }}\n GOPROXY: ${{ steps.setup-go-proxy.outputs.goproxy-url }}\n run: |\n echo \"${VERSION}\"\n make -f deployments/container/Makefile build-${{ matrix.target }}\n"
},
{
"path": ".github/workflows/release.yaml",
"content": "# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# Run this workflow on new tags\nname: Release\n\non:\n push:\n tags:\n - v*\n\njobs:\n release:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n name: Check out code\n\n - name: Prepare Artifacts\n run: |\n ./hack/prepare-artifacts.sh ${{ github.ref_name }}\n\n - name: Create Draft Release\n env:\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n run: |\n ./hack/create-release.sh ${{ github.ref_name }}\n"
},
{
"path": ".github/workflows/stale.yaml",
"content": "name: Stale issues\n\non:\n workflow_dispatch:\n schedule:\n - cron: \"21 4 * * *\"\n\njobs:\n stale:\n permissions:\n actions: write\n issues: write\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/stale@v10\n with:\n stale-issue-message: 'This issue is stale because it has been open 90 days with no activity. This issue will be closed in 30 days unless new comments are made or the stale label is removed. To skip these checks, apply the \"lifecycle/frozen\" label.'\n stale-issue-label: 'lifecycle/stale'\n exempt-issue-labels: 'lifecycle/frozen,feature,enhancement'\n days-before-stale: 90\n close-issue-message: 'This issue was automatically closed due to inactivity.'\n days-before-issue-close: 30\n remove-stale-when-updated: true\n operations-per-run: 1000\n"
},
{
"path": ".gitignore",
"content": "/dist\n/artifacts\n*.swp\n*.swo\n/coverage.out*\n/tests/output/\n/nvidia-*\n/shared-*\n/release-*\n/bin\n/toolkit-test\n"
},
{
"path": ".gitmodules",
"content": "[submodule \"third_party/libnvidia-container\"]\n\tpath = third_party/libnvidia-container\n\turl = https://github.com/NVIDIA/libnvidia-container.git\n\tbranch = main\n"
},
{
"path": ".golangci.yml",
"content": "# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nversion: \"2\"\nlinters:\n enable:\n - contextcheck\n - gocritic\n - gosec\n - misspell\n - unconvert\n exclusions:\n generated: lax\n presets:\n - comments\n - common-false-positives\n - legacy\n - std-error-handling\n rules:\n # Exclude the gocritic dupSubExpr issue for cgo files.\n - linters:\n - gocritic\n path: internal/dxcore/dxcore.go\n text: dupSubExpr\n # Exclude the checks for usage of returns to config.Delete(Path) in the\n # crio and containerd config packages.\n - linters:\n - errcheck\n path: pkg/config/engine/\n text: config.Delete\n # RENDERD refers to the Render Device and not the past tense of render.\n - linters:\n - misspell\n path: .*.go\n text: '`RENDERD` is a misspelling of `RENDERED`'\n # The legacy hook relies on spec.Hooks.Prestart, which is deprecated as of\n # the v1.2.0 OCI runtime spec.\n - path: (.+)\\.go$\n text: SA1019:(.+).Prestart is deprecated(.+)\n # TODO: We should address each of the following integer overflows.\n - path: (.+)\\.go$\n text: 'G115: integer overflow conversion(.+)'\n paths:\n - third_party$\n - builtin$\n - examples$\nformatters:\n enable:\n - gofmt\n - goimports\n settings:\n goimports:\n local-prefixes:\n - github.com/NVIDIA/nvidia-container-toolkit\n exclusions:\n generated: lax\n paths:\n - third_party$\n - builtin$\n - examples$\n"
},
{
"path": ".nvidia-ci.yml",
"content": "# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\ndefault:\n image: docker\n services:\n - name: docker:dind\n command: [\"--experimental\"]\n tags:\n - cnt\n - container-dev\n - docker/multi-arch\n - docker/privileged\n - os/linux\n - type/docker\n\nvariables:\n GIT_SUBMODULE_STRATEGY: recursive\n\n DOCKER_DRIVER: overlay2\n DOCKER_TLS_CERTDIR: \"/certs\"\n # Release \"devel\"-tagged images off the main branch\n RELEASE_DEVEL_BRANCH: \"main\"\n DEVEL_RELEASE_IMAGE_VERSION: \"devel\"\n # On the multi-arch builder we don't need the qemu setup.\n SKIP_QEMU_SETUP: \"1\"\n # Define the public staging registry\n STAGING_REGISTRY: ghcr.io/nvidia\n STAGING_VERSION: ${CI_COMMIT_SHORT_SHA}\n ARTIFACTORY_REPO_BASE: \"https://urm.nvidia.com/artifactory/sw-gpu-cloudnative\"\n KITMAKER_RELEASE_FOLDER: \"kitmaker\"\n PACKAGE_ARCHIVE_RELEASE_FOLDER: \"releases\"\n\nstages:\n - pull\n - scan\n - release\n - ngc-publish\n\n.pipeline-trigger-rules:\n rules:\n # We trigger the pipeline if started manually\n - if: $CI_PIPELINE_SOURCE == \"web\"\n # We trigger the pipeline on the main branch\n - if: $CI_COMMIT_BRANCH == \"main\"\n # We trigger the pipeline on the release- branches\n - if: $CI_COMMIT_BRANCH =~ /^release-.*$/\n # We trigger the pipeline on tags\n - if: $CI_COMMIT_TAG && $CI_COMMIT_TAG != \"\"\n\nworkflow:\n rules:\n # We trigger the pipeline on a merge request\n - if: $CI_PIPELINE_SOURCE == 'merge_request_event'\n # We then add all the regular triggers\n - !reference [.pipeline-trigger-rules, rules]\n\n# Download the regctl binary for use in the release steps\n.regctl-setup:\n before_script:\n - export REGCTL_VERSION=v0.4.5\n - apk add --no-cache curl\n - mkdir -p bin\n - curl -sSLo bin/regctl https://github.com/regclient/regclient/releases/download/${REGCTL_VERSION}/regctl-linux-amd64\n - chmod a+x bin/regctl\n - export PATH=$(pwd)/bin:${PATH}\n\n# .copy-images copies the required application and packaging images from the\n# IN_IMAGE=\"${IN_IMAGE_NAME}:${IN_IMAGE_TAG}${TAG_SUFFIX}\"\n# to\n# OUT_IMAGE=\"${OUT_IMAGE_NAME}:${OUT_IMAGE_TAG}${TAG_SUFFIX}\"\n# The script also logs into IN_REGISTRY and OUT_REGISTRY using the supplied\n# username and tokens.\n.copy-images:\n parallel:\n matrix:\n - TAG_SUFFIX: [\"\", \"-packaging\"]\n before_script:\n - !reference [.regctl-setup, before_script]\n - apk add --no-cache make bash\n variables:\n REGCTL: regctl\n script:\n - |\n if [ -n ${IN_REGISTRY} ] && [ -n ${IN_REGISTRY_USER} ]; then\n echo \"Logging in to ${IN_REGISTRY}\"\n ${REGCTL} registry login \"${IN_REGISTRY}\" -u \"${IN_REGISTRY_USER}\" -p \"${IN_REGISTRY_TOKEN}\" || exit 1\n fi\n\n if [ -n ${OUT_REGISTRY} ] && [ -n ${OUT_REGISTRY_USER} ] && [ \"${IN_REGISTRY}\" != \"${OUT_REGISTRY}\" ]; then\n echo \"Logging in to ${OUT_REGISTRY}\"\n ${REGCTL} registry login \"${OUT_REGISTRY}\" -u \"${OUT_REGISTRY_USER}\" -p \"${OUT_REGISTRY_TOKEN}\" || exit 1\n fi\n\n export IN_IMAGE=\"${IN_IMAGE_NAME}:${IN_IMAGE_TAG}${TAG_SUFFIX}\"\n export OUT_IMAGE=\"${OUT_IMAGE_NAME}:${OUT_IMAGE_TAG}${TAG_SUFFIX}\"\n\n echo \"Copying ${IN_IMAGE} to ${OUT_IMAGE}\"\n ${REGCTL} image copy ${IN_IMAGE} ${OUT_IMAGE}\n\n# pull-images pulls images from the public CI registry to the internal CI registry.\npull-images:\n extends:\n - .copy-images\n stage: pull\n variables:\n IN_REGISTRY: \"${STAGING_REGISTRY}\"\n IN_IMAGE_NAME: ${STAGING_REGISTRY}/container-toolkit\n IN_IMAGE_TAG: \"${STAGING_VERSION}\"\n\n OUT_REGISTRY: \"${CI_REGISTRY}\"\n OUT_REGISTRY_USER: \"${CI_REGISTRY_USER}\"\n OUT_REGISTRY_TOKEN: \"${CI_REGISTRY_PASSWORD}\"\n OUT_IMAGE_NAME: \"${CI_REGISTRY_IMAGE}/container-toolkit\"\n OUT_IMAGE_TAG: \"${CI_COMMIT_SHORT_SHA}\"\n # We delay the job start to allow the public pipeline to generate the required images.\n rules:\n # If the pipeline is triggered from a tag or the WEB UI we don't delay the\n # start of the pipeline.\n - if: $CI_COMMIT_TAG || $CI_PIPELINE_SOURCE == \"web\"\n # If the pipeline is triggered through other means (i.e. a branch or MR)\n # we add a 30 minute delay to ensure that the images are available in the\n # public CI registry.\n - when: delayed\n start_in: 30 minutes\n timeout: 30 minutes\n retry:\n max: 2\n when:\n - job_execution_timeout\n - stuck_or_timeout_failure\n\n# We skip the integration tests for the internal CI:\n.integration:\n stage: test\n before_script:\n - echo \"Skipped in internal CI\"\n script:\n - echo \"Skipped in internal CI\"\n\n# The .scan step forms the base of the image scan operation performed before releasing\n# images.\nscan-images:\n stage: scan\n needs:\n - pull-images\n image: \"${PULSE_IMAGE}\"\n parallel:\n matrix:\n - TAG_SUFFIX: [\"\"]\n PLATFORM: [\"linux/amd64\", \"linux/arm64\"]\n - TAG_SUFFIX: \"-packaging\"\n PLATFORM: \"linux/amd64\"\n variables:\n IMAGE: \"${CI_REGISTRY_IMAGE}/container-toolkit:${CI_COMMIT_SHORT_SHA}\"\n IMAGE_ARCHIVE: \"container-toolkit-${CI_JOB_ID}.tar\"\n allow_failure: true\n script:\n - |\n docker login -u \"${CI_REGISTRY_USER}\" -p \"${CI_REGISTRY_PASSWORD}\" \"${CI_REGISTRY}\"\n export SCAN_IMAGE=${IMAGE}${TAG_SUFFIX}\n echo \"Scanning image ${SCAN_IMAGE} for ${PLATFORM}\"\n docker pull --platform=\"${PLATFORM}\" \"${SCAN_IMAGE}\"\n docker save \"${SCAN_IMAGE}\" -o \"${IMAGE_ARCHIVE}\"\n AuthHeader=$(echo -n $SSA_CLIENT_ID:$SSA_CLIENT_SECRET | base64 -w0)\n export SSA_TOKEN=$(curl --request POST --header \"Authorization: Basic $AuthHeader\" --header \"Content-Type: application/x-www-form-urlencoded\" ${SSA_ISSUER_URL} | jq \".access_token\" | tr -d '\"')\n if [ -z \"$SSA_TOKEN\" ]; then exit 1; else echo \"SSA_TOKEN set!\"; fi\n\n pulse-cli -n $NSPECT_ID --ssa $SSA_TOKEN scan -i $IMAGE_ARCHIVE -p $CONTAINER_POLICY -o\n rm -f \"${IMAGE_ARCHIVE}\"\n artifacts:\n when: always\n expire_in: 1 week\n paths:\n - pulse-cli.log\n - licenses.json\n - sbom.json\n - vulns.json\n - policy_evaluation.json\n\nupload-kitmaker-packages:\n stage: release\n needs:\n - pull-images\n variables:\n VERSION: \"${CI_COMMIT_SHORT_SHA}\"\n PACKAGE_REGISTRY: \"${CI_REGISTRY}\"\n PACKAGE_REGISTRY_USER: \"${CI_REGISTRY_USER}\"\n PACKAGE_REGISTRY_TOKEN: \"${CI_REGISTRY_PASSWORD}\"\n PACKAGE_IMAGE_NAME: \"${CI_REGISTRY_IMAGE}/container-toolkit\"\n PACKAGE_IMAGE_TAG: \"${CI_COMMIT_SHORT_SHA}-packaging\"\n KITMAKER_ARTIFACTORY_REPO: \"${ARTIFACTORY_REPO_BASE}-generic-local/${KITMAKER_RELEASE_FOLDER}\"\n ARTIFACTS_DIR: \"${CI_PROJECT_DIR}/artifacts\"\n script:\n - !reference [.regctl-setup, before_script]\n - apk add --no-cache bash git\n - regctl registry login \"${PACKAGE_REGISTRY}\" -u \"${PACKAGE_REGISTRY_USER}\" -p \"${PACKAGE_REGISTRY_TOKEN}\"\n - ./scripts/extract-packages.sh \"${PACKAGE_IMAGE_NAME}:${PACKAGE_IMAGE_TAG}\"\n - ./scripts/release-kitmaker-artifactory.sh \"${KITMAKER_ARTIFACTORY_REPO}\"\n - rm -rf ${ARTIFACTS_DIR}\n\npush-images-to-staging:\n extends:\n - .copy-images\n stage: release\n needs:\n - scan-images\n variables:\n IN_REGISTRY: \"${CI_REGISTRY}\"\n IN_REGISTRY_USER: \"${CI_REGISTRY_USER}\"\n IN_REGISTRY_TOKEN: \"${CI_REGISTRY_PASSWORD}\"\n IN_IMAGE_NAME: \"${CI_REGISTRY_IMAGE}/container-toolkit\"\n IN_IMAGE_TAG: \"${CI_COMMIT_SHORT_SHA}\"\n\n OUT_REGISTRY: \"${NGC_REGISTRY}\"\n OUT_REGISTRY_USER: \"${NGC_REGISTRY_USER}\"\n OUT_REGISTRY_TOKEN: \"${NGC_REGISTRY_TOKEN}\"\n OUT_IMAGE_NAME: \"${NGC_STAGING_REGISTRY}/container-toolkit\"\n OUT_IMAGE_TAG: \"${CI_COMMIT_SHORT_SHA}\"\n\n.publish-images:\n stage: ngc-publish\n needs:\n - scan-images\n - push-images-to-staging\n image:\n name: \"${CNT_NGC_PUBLISH_IMAGE}\"\n pull_policy: always\n variables:\n\n variables:\n GITLAB_ACCESS_TOKEN: \"${CNT_GITLAB_TOKEN}\"\n\n IN_IMAGE_TAG: \"${CI_COMMIT_SHORT_SHA}\"\n OUT_IMAGE_TAG: \"${CI_COMMIT_TAG}\"\n\n VERSION_FILE: \"build-info-${CI_PIPELINE_ID}.txt\"\n PROJECT_NAME: \"nvidia-container-toolkit\"\n before_script:\n - |\n if [ -n \"${OVERRIDE_PUBLISHING_PROJECT_PATH}\" ]; then\n NGC_PUBLISHING_PROJECT_PATH=\"${OVERRIDE_PUBLISHING_PROJECT_PATH}\"\n fi\n\n if [ -z \"${NGC_PUBLISHING_PROJECT_PATH}\" ]; then\n echo \"NGC_PUBLISHING_PROJECT_PATH not set\"\n exit 1\n fi\n\n echo \"publishing to ${NGC_PUBLISHING_PROJECT_PATH}\"\n\n rm -f ${VERSION_FILE}\n echo \"${IN_IMAGE_TAG} ${OUT_IMAGE_TAG}\" >> ${VERSION_FILE}\n echo \"${IN_IMAGE_TAG}-packaging ${OUT_IMAGE_TAG}-packaging\" >> ${VERSION_FILE}\n cat ${VERSION_FILE}\n script:\n - cnt-ngc-publish render --project-name \"${PROJECT_NAME}\" --versions-file \"${VERSION_FILE}\" --output \"${PROJECT_NAME}\".yaml\n - cnt-ngc-publish merge-request --files \"${PROJECT_NAME}.yaml\"\n artifacts:\n paths:\n - \"${VERSION_FILE}\"\n - \"${PROJECT_NAME}.yaml\"\n\n\npublish-images-to-ngc:\n extends:\n - .publish-images\n rules:\n - if: $CI_COMMIT_TAG\n\n# We create a dummy MR that exercises the publishing logic.\n# TODO: This MR should be closed automatically.\npublish-images-dummy:\n extends:\n - .publish-images\n variables:\n OVERRIDE_PUBLISHING_PROJECT_PATH: \"dl/container-dev/ngc-automation\"\n OUT_IMAGE_TAG: \"publish-${CI_COMMIT_SHORT_SHA}\"\n rules:\n - if: $CI_COMMIT_TAG == null || $CI_COMMIT_TAG == \"\"\n"
},
{
"path": "CHANGELOG.md",
"content": "# NVIDIA Container Toolkit Changelog\n\n## v1.19.0\n- Promote v1.19.0-rc.7 to v1.19.0\n\n## v1.19.0-rc.7\n- fix: Reuse instantiated editsFactory in CDI\n- fix: Don't use driver version in ELF header for compat check\n- Use jit-cdi modifier for gated modifiers\n- refactor: Use automatic CDI modifier for CSV\n- fix: Use driver.Root instead of config option in modifier Factory\n- test: Improve csv modifier tests\n- test: Add IsOverrideApplied function to devices package\n- chore: Run goimports on mocks\n- fix: Ensure that CUDA Compat Container path is set by default\n- chore: Update isIntegratedGPU for readability\n- chore: Rename isIntegratedGPUID function to isOrinGPUID\n- fix: Use correct version when updating versions.mk\n\n## v1.19.0-rc.6\n\n- Use host CUDA version for all CSV compat checks\n\n## v1.19.0-rc.5\n\n- Remove dlopen locator added in v1.19.0-rc.4\n\n### Changes in the Toolkit Container\n\n- build(deps): Bump nvidia/distroless/go to v4.0.2-dev in /deployments/container\n\n## v1.19.0-rc.4\n\n- Add a Dlopen-based library locator\n- Add support for injecting additional GIDs\n- Add support for CUDA forward compat on Orin systems\n\n## v1.19.0-rc.3\n- Remove restart logic from nvidia-cdi-refresh.service.\n- fix: Set device node GID in CDI specs\n- fix: Log actual CDI spec version\n- Make internal/system packages public\n- Move config to api\n- Make internal lookup package exportable\n- fix: Allow config options to be set to default values\n- test: Add failing test for setting debug log\n- test: Adjust e2e test for Docker 29.2.0\n\n### Changes in the Toolkit Container\n\n- build(deps): Bump nvidia/distroless/go to v4.0.1-dev in /deployments/container\n- Replace repackaging using fpm with rpmrebuild\n\n### Changes in libnvidia-container\n\n- Add libnvidia-tileiras.so to the list of compute libs\n\n## v1.19.0-rc.2\n\n- fix: Ensure that iGPU device nodes includes /dev/nvidia2\n- restrict NRI injection of CDI devices to pods in the toolkit's namespace\n- test: Add test for CSV-based device spec generation\n- fix: Add docker swarm support to jit-cdi mode\n- feat: Check ELF note for CUDA compat\n- Refactor enable-cuda-compat hook\n- fix: Allow nvidia-cdi-refresh.service to be restarted\n- fix: permissions sync\n- fix(discover): remove ro mount option from IPC sockets\n- Simplify logger.Interface\n- Add --no-runtime-config option to toolkit installer\n- Add interface for runtime configuration to installer\n- implement NRI plugin server to inject management CDI devices\n- Generate none device spec\n- fix: Fix arguments when creating DRM device symlinks\n- fix: Skip device node injection if NVIDIA_VISIBLE_DEVICES=none\n- test: Add failing test for NVIDIA_VISIBLE_DEVICES=none\n- Fix library paths in Apline containers\n- fix: Use pure CSV mode when a single device is found\n- fix: Don't filter device nodes when disable-multiple-csv-devices is enabled\n- trim extraneous whitespaces when parsing comma-separated config sources\n- fix: Return error on JIT CDI spec generation failure\n\n### Changes in the Toolkit Container\n\n- Bump nvidia/distroless/go in /deployments/container\n- Bump nvidia/distroless/go in /deployments/container\n\n### Changes in libnvidia-container\n\n- Add tooling to auto-bump golang version\n- Allow GOLANG_VERSION to be overridden\n\n## v1.19.0-rc.1\n\n- Add enable-cuda-compat on Tegra-based systems\n- Add --cuda-compat-container-root\n- Add --device-id flag to nvidia-ctk cdi generate command\n- Handle multiple GPUs in CDI spec generation from CSV\n- Fix trigger of CDI refresh service\n- Add --no-all-device option to nvidia-ctk cd generate\n- Default to strict decoding of OCI runtime spec\n- Load minimal spec to extract container root\n- Allow update-ldcache to work when pivot-root is not supported\n- Extract device information from host path if possible\n- Fix update of ldcache for non-matching host and container distros\n- Use enable-cuda-compat hook when ldcache does not exist\n- ldconfig: Create ld.so.conf file if missing\n- ldconfig: Determine container \"debian-ness\" after root pivot\n- Add missing return in `getSystemSearchPaths` for debian like containers\n- Use requested devices for CSV CDI spec generation\n- Also consider libnvidia-ml.so for extracting driver version\n- Switch to go 1.25 os.Root\n- Filter already tracked directories from ldcache update\n- Correct typo in nvsandboxutils feature flag\n- Allow nvcdi FeatureFlags to be configured for jit-cdi mode\n- Fix duplicate specs for jit-cdi mode\n- Fix trigger of CDI refresh service\n- Update rpm package to have 256bit digests\n- Fix generate tests when cdi hook exists in path\n- Fix containerd drop-in config path\n- Redirect log message to stderr in nvidia runtime wrapper script\n- chore: fix issues raised by govet and gocritic\n- Fix handling of existing imports in containerd\n- Don't read cdi generate mode from runtime mode\n- Fix bug in create-dev-char-symlinks command\n- Fix typo in nvidia-container-runtime's README\n\n### Changes in the Toolkit Container\n\n- Update rpm package to have 256bit digests\n- Bump nvidia/distroless/go in /deployments/container\n- Bump nvidia/distroless/go in /deployments/container\n\n## v1.18.0\n- Fix bug in device selection in jit-cdi mode\n- Make list of explicit driver libraries opt-in\n\n### Changes in the Toolkit Container\n- Invoke the actual default low-level runtime in the nvidia-ctk wrapper script\n- Remove default_runtime from cri-o config on cleanup\n- Do not remove cri-o drop-in file on shutdown.\n\n## v1.18.0-rc.6\n- Remove ppc64le artifacts from build\n- Add support for building artifacts with custom GOPROXY\n- Always update the ldcache in the container.\n\n### Changes in the Toolkit Container\n\n- Bump nvidia/distroless/go to v3.1.13-dev in /deployments/container\n- Allow config sources to be specified for containerd and crio\n- Allow file for config source to be specified explicitly\n\n## Changes in libnvidia-container\n- Add clock_gettime to the set of allowed syscalls under seccomp.\n\n## v1.18.0-rc.5\n- Fix handling of unrecognised hooks\n- Disable generation of coherent CDI specs by default\n- Update go-nvlib to restrict nvidia.com/gpu.coherent devices to devices with an ATS addressing mode.\n- Deprecate the hook config mode for cri-o\n\n### Changes in the Toolkit Container\n- Deprecate the hook config mode for cri-o\n- Add CRI plugin config from source containerd config to drop-in file\n- Add support for drop-in config files in a container\n\n## v1.18.0-rc.4\n\n- Add drop-in file support for containerd and crio\n- Add support for IMEX_CHANNELS to jit-cdi mode\n- Refactor IMEX channel requests from image\n- Remove redundant CDI annotations\n- support running and degraded systemd state during install\n- Don't inject enable-cuda-compat hook in CSV mode\n- Cleanup default runtime in runtime config when setAsDefault=false\n\n### Changes in the Toolkit Container\n\n- Bump nvidia/distroless/go to v3.1.12-dev in /deployments/container\n\n## v1.18.0-rc.3\n\n- Generate separate specs for coherent and noncoherent devices\n- Disable chmod hook by default\n- Add support for gated modifications jit-cdi mode\n- Add support for nvswitch mode to nvcdi API\n- Add support for gdrcopy mode to nvcdi API\n- Consolidate CDI spec generation of gated modes\n- Add missing imex mode to Valid modes\n- Add explicitLibs list to libs discovery\n- Consolidate logic to determine driver version\n- Fix: Enable local YUM repo by default in CentOS8 and Fedora35 entrypoints\n\n### Changes in the Toolkit Container\n\n- Bump nvidia/distroless/go to v3.1.11-dev in /deployments/container\n\n## v1.18.0-rc.2\n\n- Ensure that .so symlinks are created for driver libraries in the container\n- Load settings from config.toml file during CDI generation\n- Use securejoin to resolve /proc\n- Refactor nvml CDI spec generation for consistency\n- Simplify nvcdi interface\n- Add SpecGenerator interface\n- Ensure that modified params file mount does not leak to host\n- Add test for leaking mounts with shared mount propagation\n\n### Changes in the Toolkit Container\n\n- Bump nvidia/distroless/go to v3.1.10-dev in /deployments/container\n- Bump nvidia/cuda to 12.9.1-base-ubi9 in /deployments/container\n\n## v1.18.0-rc.1\n\n- Add create-soname-symlinks hook\n- Require matching version of libnvidia-container-tools\n- Add envvar for libcuda.so parent dir to CDI spec\n- Add EnvVar to Discover interface\n- Resolve to legacy by default in nvidia-container-runtime-hook\n- Default to jit-cdi mode in the nvidia runtime\n- Use functional options to construct runtime mode resolver\n- Add NVIDIA_CTK_CONFIG_FILE_PATH envvar\n- Switch to cuda ubi9 base image\n- Use single version tag for image\n- BUGFIX: modifier: respect GPU volume-mount device requests\n- Ensure consistent sorting of annotation devices\n- Extract deb and rpm packages to single image\n- Remove docker-run as default runtime candidate\n- Return annotation devices from VisibleDevices\n- Make CDI device requests consistent with other methods\n- Construct container info once\n- Add logic to extract annotation device requests to image type\n- Add IsPrivileged function to CUDA container type\n- Add device IDs to nvcdi.GetSpec API\n- Refactor extracting requested devices from the container image\n- Add EnvVars option for all nvidia-ctk cdi commands\n- Add nvidia-cdi-refresh service\n- Add discovery of arch-specific vulkan ICD\n- Add disabled-device-node-modification hook to CDI spec\n- Add a hook to disable device node creation in a container\n- Remove redundant deduplication of search paths for WSL\n- Added ability to disable specific (or all) CDI hooks\n- Consolidate HookName functionality on internal/discover pkg\n- Add envvar to control debug logging in CDI hooks\n- Add FeatureFlags to the nvcdi API\n- Reenable nvsandboxutils for driver discovery\n- Edit discover.mounts to have a deterministic output\n- Refactor the way we create CDI Hooks\n- Issue warning on unsupported CDI hook\n- Run update-ldcache in isolated namespaces\n- Add cuda-compat-mode config option\n- Fix mode detection on Thor-based systems\n- Add rprivate to CDI mount options\n- Skip nil discoverers in merge\n- bump runc go dep to v1.3.0\n- Fix resolution of libs in LDCache on ARM\n- Updated .release:staging to stage images in nvstaging\n- Refactor toolkit installer\n- Allow container runtime executable path to be specified\n- Add support for building ubuntu22.04 on arm64\n- Fix race condition in mounts cache\n- Add support for building ubuntu22.04 on amd64\n- Fix update-ldcache arguments\n- Remove positional arguments from nvidia-ctk-installer\n- Remove deprecated --runtime-args from nvidia-ctk-installer\n- Add version info to nvidia-ctk-installer\n- Update nvidia-ctk-installer app name to match binary name\n- Allow nvidia-ctk config --set to accept comma-separated lists\n- Disable enable-cuda-compat hook for management containers\n- Allow enable-cuda-compat hook to be disabled in CDI spec generation\n- Add disable-cuda-compat-lib-hook feature flag\n- Add basic integration tests for forward compat\n- Ensure that mode hook is executed last\n- Add enable-cuda-compat hook to CDI spec generation\n- Add ldconfig hook in legacy mode\n- Add enable-cuda-compat hook if required\n- Add enable-cuda-compat hook to allow compat libs to be discovered\n- Use libcontainer execseal to run ldconfig\n- Add ignore-imex-channel-requests feature flag\n- Disable nvsandboxutils in nvcdi API\n- Allow cdi mode to work with --gpus flag\n- Add E2E GitHub Action for Container Toolkit\n- Add remote-test option for E2E\n- Enable CDI in runtime if CDI_ENABLED is set\n- Fix overwriting docker feature flags\n- Add option in toolkit container to enable CDI in runtime\n- Remove Set from engine config API\n- Add EnableCDI() method to engine.Interface\n- Add IMEX binaries to CDI discovery\n- Rename test folder to tests\n- Add allow-cuda-compat-libs-from-container feature flag\n- Disable mounting of compat libs from container\n- Skip graphics modifier in CSV mode\n- Move nvidia-toolkit to nvidia-ctk-installer\n- Automated regression testing for the NVIDIA Container Toolkit\n- Add support for containerd version 3 config\n- Remove watch option from create-dev-char-symlinks\n- Add string TOML source\n- Improve the implementation for UseLegacyConfig\n- Properly pass configSearchPaths to a Driver constructor\n- Fix create-device-node test when devices exist\n- Add imex mode to CDI spec generation\n- Only allow host-relative LDConfig paths\n- Fix NVIDIA_IMEX_CHANNELS handling on legacy images\n- Fix bug in default config file path\n- Fix fsnotify.Remove logic function.\n- Force symlink creation in create-symlink hook\n\n### Changes in the Toolkit Container\n\n- Create /work/nvidia-toolkit symlink\n- Use Apache license for images\n- Switch to golang distroless image\n- Switch to cuda ubi9 base image\n- Use single version tag for image\n- Extract deb and rpm packages to single image\n- Bump nvidia/cuda in /deployments/container\n- Bump nvidia/cuda in /deployments/container\n- Add E2E GitHub Action for Container Toolkit\n- Bump nvidia/cuda in /deployments/container\n- Move nvidia-toolkit to nvidia-ctk-installer\n- Add support for containerd version 3 config\n- Improve the implementation for UseLegacyConfig\n- Bump nvidia/cuda in /deployments/container\n- Add imex mode to CDI spec generation\n- Only allow host-relative LDConfig paths\n- Fallback to file for runtime config\n\n### Changes in libnvidia-container\n\n- Fix pointer accessing local variable out of scope\n- Require version match between libnvidia-container-tools and libnvidia-container1\n- Add libnvidia-gpucomp.so to the list of compute libs\n- Use VERSION_ prefix for version parts in makefiles\n- Add additional logging\n- Do not discard container flags when --cuda-compat-mode is not specified\n- Remove unneeded --no-cntlibs argument from list command\n- Add cuda-compat-mode flag to configure command\n- Skip files when user has insufficient permissions\n- Fix building with Go 1.24\n- Add no-cntlibs CLI option to nvidia-container-cli\n- Fix always using fallback\n- Add fallback for systems without memfd_create()\n- Create virtual copy of host ldconfig binary before calling fexecve()\n- Fix some typos in text.\n\n\n## v1.17.0\n- Promote v1.17.0-rc.2 to v1.17.0\n- Fix bug when using just-in-time CDI spec generation\n- Check for valid paths in create-symlinks hook\n\n## v1.17.0-rc.2\n- Fix bug in locating libcuda.so from ldcache\n- Fix bug in sorting of symlink chain\n- Remove unsupported print-ldcache command\n- Remove csv-filename support from create-symlinks\n\n### Changes in the Toolkit Container\n- Fallback to `crio-status` if `crio status` does not work when configuring the crio runtime\n\n## v1.17.0-rc.1\n- Allow IMEX channels to be requested as volume mounts\n- Fix typo in error message\n- Add disable-imex-channel-creation feature flag\n- Add -z,lazy to LDFLAGS\n- Add imex channels to management CDI spec\n- Add support to fetch current container runtime config from the command line.\n- Add creation of select driver symlinks to CDI spec generation.\n- Remove support for config overrides when configuring runtimes.\n- Skip explicit creation of libnvidia-allocator.so.1 symlink\n- Add vdpau as as a driver library search path.\n- Add support for using libnvsandboxutils to generate CDI specifications.\n\n### Changes in the Toolkit Container\n\n- Allow opt-in features to be selected when deploying the toolkit-container.\n- Bump CUDA base image version to 12.6.2\n- Remove support for config overrides when configuring runtimes.\n\n### Changes in libnvidia-container\n\n- Add no-create-imex-channels command line option.\n\n## v1.16.2\n- Exclude libnvidia-allocator from graphics mounts. This fixes a bug that leaks mounts when a container is started with bi-directional mount propagation.\n- Use empty string for default runtime-config-override. This removes a redundant warning for runtimes (e.g. Docker) where this is not applicable.\n\n### Changes in the Toolkit Container\n- Bump CUDA base image version to 12.6.0\n\n### Changes in libnvidia-container\n- Add no-gsp-firmware command line option\n- Add no-fabricmanager command line option\n- Add no-persistenced command line option\n- Skip directories and symlinks when mounting libraries.\n\n## v1.16.1\n- Fix bug with processing errors during CDI spec generation for MIG devices\n\n## v1.16.0\n- Promote v1.16.0-rc.2 to v1.16.0\n\n### Changes in the Toolkit Container\n- Bump CUDA base image version to 12.5.1\n\n## v1.16.0-rc.2\n- Use relative path to locate driver libraries\n- Add RelativeToRoot function to Driver\n- Inject additional libraries for full X11 functionality\n- Extract options from default runtime if runc does not exist\n- Avoid using map pointers as maps are always passed by reference\n- Reduce logging for the NVIDIA Container runtime\n- Fix bug in argument parsing for logger creation\n\n## v1.16.0-rc.1\n\n- Support vulkan ICD files directly in a driver root. This allows for the discovery of vulkan files in GKE driver installations.\n- Increase priority of ld.so.conf.d config file injected into container. This ensures that injected libraries are preferred over libraries present in the container.\n- Set default CDI spec permissions to 644. This fixes permission issues when using the `nvidia-ctk cdi transform` functions.\n- Add `dev-root` option to `nvidia-ctk system create-device-nodes` command.\n- Fix location of `libnvidia-ml.so.1` when a non-standard driver root is used. This enabled CDI spec generation when using the driver container on a host.\n- Recalculate minimum required CDI spec version on save.\n- Move `nvidia-ctk hook` commands to a separate `nvidia-cdi-hook` binary. The same subcommands are supported.\n- Use `:` as an `nvidia-ctk config --set` list separator. This fixes a bug when trying to set config options that are lists.\n\n- [toolkit-container] Bump CUDA base image version to 12.5.0\n- [toolkit-container] Allow the path to `toolkit.pid` to be specified directly.\n- [toolkit-container] Remove provenance information from image manifests.\n- [toolkit-container] Add `dev-root` option when configuring the toolkit. This adds support for GKE driver installations.\n\n## v1.15.0\n\n* Remove `nvidia-container-runtime` and `nvidia-docker2` packages.\n* Use `XDG_DATA_DIRS` environment variable when locating config files such as graphics config files.\n* Add support for v0.7.0 Container Device Interface (CDI) specification.\n* Add `--config-search-path` option to `nvidia-ctk cdi generate` command. These paths are used when locating driver files such as graphics config files.\n* Use D3DKMTEnumAdapters3 to enumerate adpaters on WSL2 if available.\n* Add support for v1.2.0 OCI Runtime specification.\n* Explicitly set `NVIDIA_VISIBLE_DEVICES=void` in generated CDI specifications. This prevents the NVIDIA Container Runtime from making additional modifications.\n\n* [libnvidia-container] Use D3DKMTEnumAdapters3 to enumerate adpaters on WSL2 if available.\n\n* [toolkit-container] Bump CUDA base image version to 12.4.1\n\n## v1.15.0-rc.4\n* Add a `--spec-dir` option to the `nvidia-ctk cdi generate` command. This allows specs outside of `/etc/cdi` and `/var/run/cdi` to be processed.\n* Add support for extracting device major number from `/proc/devices` if `nvidia` is used as a device name over `nvidia-frontend`.\n* Allow multiple device naming strategies for `nvidia-ctk cdi generate` command. This allows a single\n CDI spec to be generated that includes GPUs by index and UUID.\n* Set the default `--device-name-strategy` for the `nvidia-ctk cdi generate` command to `[index, uuid]`.\n* Remove `libnvidia-container0` jetpack dependency included for legacy Tegra-based systems.\n* Add `NVIDIA_VISIBLE_DEVICES=void` to generated CDI specifications.\n\n* [toolkit-container] Remove centos7 image. The ubi8 image can be used on all RPM-based platforms.\n* [toolkit-container] Bump CUDA base image version to 12.3.2\n\n## v1.15.0-rc.3\n* Fix bug in `nvidia-ctk hook update-ldcache` where default `--ldconfig-path` value was not applied.\n\n## v1.15.0-rc.2\n* Extend the `runtime.nvidia.com/gpu` CDI kind to support full-GPUs and MIG devices specified by index or UUID.\n* Fix bug when specifying `--dev-root` for Tegra-based systems.\n* Log explicitly requested runtime mode.\n* Remove package dependency on libseccomp.\n* Added detection of libnvdxgdmal.so.1 on WSL2\n* Use devRoot to resolve MIG device nodes.\n* Fix bug in determining default nvidia-container-runtime.user config value on SUSE-based systems.\n* Add `crun` to the list of configured low-level runtimes.\n* Added support for `--ldconfig-path` to `nvidia-ctk cdi generate` command.\n* Fix `nvidia-ctk runtime configure --cdi.enabled` for Docker.\n* Add discovery of the GDRCopy device (`gdrdrv`) if the `NVIDIA_GDRCOPY` environment variable of the container is set to `enabled`\n\n* [toolkit-container] Bump CUDA base image version to 12.3.1.\n\n## v1.15.0-rc.1\n* Skip update of ldcache in containers without ldconfig. The .so.SONAME symlinks are still created.\n* Normalize ldconfig path on use. This automatically adjust the ldconfig setting applied to ldconfig.real on systems where this exists.\n* Include `nvidia/nvoptix.bin` in list of graphics mounts.\n* Include `vulkan/icd.d/nvidia_layers.json` in list of graphics mounts.\n* Add support for `--library-search-paths` to `nvidia-ctk cdi generate` command.\n* Add support for injecting /dev/nvidia-nvswitch* devices if the NVIDIA_NVSWITCH=enabled envvar is specified.\n* Added support for `nvidia-ctk runtime configure --enable-cdi` for the `docker` runtime. Note that this requires Docker >= 25.\n* Fixed bug in `nvidia-ctk config` command when using `--set`. The types of applied config options are now applied correctly.\n* Add `--relative-to` option to `nvidia-ctk transform root` command. This controls whether the root transformation is applied to host or container paths.\n* Added automatic CDI spec generation when the `runtime.nvidia.com/gpu=all` device is requested by a container.\n\n* [libnvidia-container] Fix device permission check when using cgroupv2 (fixes #227)\n\n## v1.14.3\n* [toolkit-container] Bump CUDA base image version to 12.2.2.\n\n## v1.14.2\n* Fix bug on Tegra-based systems where symlinks were not created in containers.\n* Add --csv.ignore-pattern command line option to nvidia-ctk cdi generate command.\n\n## v1.14.1\n* Fixed bug where contents of `/etc/nvidia-container-runtime/config.toml` is ignored by the NVIDIA Container Runtime Hook.\n\n* [libnvidia-container] Use libelf.so on RPM-based systems due to removed mageia repositories hosting pmake and bmake.\n\n## v1.14.0\n* Promote v1.14.0-rc.3 to v1.14.0\n\n## v1.14.0-rc.3\n* Added support for generating OCI hook JSON file to `nvidia-ctk runtime configure` command.\n* Remove installation of OCI hook JSON from RPM package.\n* Refactored config for `nvidia-container-runtime-hook`.\n* Added a `nvidia-ctk config` command which supports setting config options using a `--set` flag.\n* Added `--library-search-path` option to `nvidia-ctk cdi generate` command in `csv` mode. This allows folders where\n libraries are located to be specified explicitly.\n* Updated go-nvlib to support devices which are not present in the PCI device database. This allows the creation of dev/char symlinks on systems with such devices installed.\n* Added `UsesNVGPUModule` info function for more robust platform detection. This is required on Tegra-based systems where libnvidia-ml.so is also supported.\n\n* [toolkit-container] Set `NVIDIA_VISIBLE_DEVICES=void` to prevent injection of NVIDIA devices and drivers into the NVIDIA Container Toolkit container.\n\n## v1.14.0-rc.2\n* Fix bug causing incorrect nvidia-smi symlink to be created on WSL2 systems with multiple driver roots.\n* Remove dependency on coreutils when installing package on RPM-based systems.\n* Create output folders if required when running `nvidia-ctk runtime configure`\n* Generate default config as post-install step.\n* Added support for detecting GSP firmware at custom paths when generating CDI specifications.\n* Added logic to skip the extraction of image requirements if `NVIDIA_DISABLE_REQUIRES` is set to `true`.\n\n* [libnvidia-container] Include Shared Compiler Library (libnvidia-gpucomp.so) in the list of compute libaries.\n\n* [toolkit-container] Ensure that common envvars have higher priority when configuring the container engines.\n* [toolkit-container] Bump CUDA base image version to 12.2.0.\n* [toolkit-container] Remove installation of nvidia-experimental runtime. This is superceded by the NVIDIA Container Runtime in CDI mode.\n\n## v1.14.0-rc.1\n\n* Add support for updating containerd configs to the `nvidia-ctk runtime configure` command.\n* Create file in `etc/ld.so.conf.d` with permissions `644` to support non-root containers.\n* Generate CDI specification files with `644` permissions to allow rootless applications (e.g. podman)\n* Add `nvidia-ctk cdi list` command to show the known CDI devices.\n* Add support for generating merged devices (e.g. `all` device) to the nvcdi API.\n* Use *.* pattern to locate libcuda.so when generating a CDI specification to support platforms where a patch version is not specified.\n* Update go-nvlib to skip devices that are not MIG capable when generating CDI specifications.\n* Add `nvidia-container-runtime-hook.path` config option to specify NVIDIA Container Runtime Hook path explicitly.\n* Fix bug in creation of `/dev/char` symlinks by failing operation if kernel modules are not loaded.\n* Add option to load kernel modules when creating device nodes\n* Add option to create device nodes when creating `/dev/char` symlinks\n\n* [libnvidia-container] Support OpenSSL 3 with the Encrypt/Decrypt library\n\n* [toolkit-container] Allow same envars for all runtime configs\n\n## v1.13.1\n\n* Update `update-ldcache` hook to only update ldcache if it exists.\n* Update `update-ldcache` hook to create `/etc/ld.so.conf.d` folder if it doesn't exist.\n* Fix failure when libcuda cannot be located during XOrg library discovery.\n* Fix CDI spec generation on systems that use `/etc/alternatives` (e.g. Debian)\n\n## v1.13.0\n\n* Promote 1.13.0-rc.3 to 1.13.0\n\n## v1.13.0-rc.3\n\n* Only initialize NVML for modes that require it when runing `nvidia-ctk cdi generate`.\n* Prefer /run over /var/run when locating nvidia-persistenced and nvidia-fabricmanager sockets.\n* Fix the generation of CDI specifications for management containers when the driver libraries are not in the LDCache.\n* Add transformers to deduplicate and simplify CDI specifications.\n* Generate a simplified CDI specification by default. This means that entities in the common edits in a spec are not included in device definitions.\n* Also return an error from the nvcdi.New constructor instead of panicing.\n* Detect XOrg libraries for injection and CDI spec generation.\n* Add `nvidia-ctk system create-device-nodes` command to create control devices.\n* Add `nvidia-ctk cdi transform` command to apply transforms to CDI specifications.\n* Add `--vendor` and `--class` options to `nvidia-ctk cdi generate`\n\n* [libnvidia-container] Fix segmentation fault when RPC initialization fails.\n* [libnvidia-container] Build centos variants of the NVIDIA Container Library with static libtirpc v1.3.2.\n* [libnvidia-container] Remove make targets for fedora35 as the centos8 packages are compatible.\n\n* [toolkit-container] Add `nvidia-container-runtime.modes.cdi.annotation-prefixes` config option that allows the CDI annotation prefixes that are read to be overridden.\n* [toolkit-container] Create device nodes when generating CDI specification for management containers.\n* [toolkit-container] Add `nvidia-container-runtime.runtimes` config option to set the low-level runtime for the NVIDIA Container Runtime\n\n## v1.13.0-rc.2\n\n* Don't fail chmod hook if paths are not injected\n* Only create `by-path` symlinks if CDI devices are actually requested.\n* Fix possible blank `nvidia-ctk` path in generated CDI specifications\n* Fix error in postun scriplet on RPM-based systems\n* Only check `NVIDIA_VISIBLE_DEVICES` for environment variables if no annotations are specified.\n* Add `cdi.default-kind` config option for constructing fully-qualified CDI device names in CDI mode\n* Add support for `accept-nvidia-visible-devices-envvar-unprivileged` config setting in CDI mode\n* Add `nvidia-container-runtime-hook.skip-mode-detection` config option to bypass mode detection. This allows `legacy` and `cdi` mode, for example, to be used at the same time.\n* Add support for generating CDI specifications for GDS and MOFED devices\n* Ensure CDI specification is validated on save when generating a spec\n* Rename `--discovery-mode` argument to `--mode` for `nvidia-ctk cdi generate`\n* [libnvidia-container] Fix segfault on WSL2 systems\n* [toolkit-container] Add `--cdi-enabled` flag to toolkit config\n* [toolkit-container] Install `nvidia-ctk` from toolkit container\n* [toolkit-container] Use installed `nvidia-ctk` path in NVIDIA Container Toolkit config\n* [toolkit-container] Bump CUDA base images to 12.1.0\n* [toolkit-container] Set `nvidia-ctk` path in the\n* [toolkit-container] Add `cdi.k8s.io/*` to set of allowed annotations in containerd config\n* [toolkit-container] Generate CDI specification for use in management containers\n* [toolkit-container] Install experimental runtime as `nvidia-container-runtime.experimental` instead of `nvidia-container-runtime-experimental`\n* [toolkit-container] Install and configure mode-specific runtimes for `cdi` and `legacy` modes\n\n## v1.13.0-rc.1\n\n* Include MIG-enabled devices as GPUs when generating CDI specification\n* Fix missing NVML symbols when running `nvidia-ctk` on some platforms [#49]\n* Add CDI spec generation for WSL2-based systems to `nvidia-ctk cdi generate` command\n* Add `auto` mode to `nvidia-ctk cdi generate` command to automatically detect a WSL2-based system over a standard NVML-based system.\n* Add mode-specific (`.cdi` and `.legacy`) NVIDIA Container Runtime binaries for use in the GPU Operator\n* Discover all `gsb*.bin` GSP firmware files when generating CDI specification.\n* Align `.deb` and `.rpm` release candidate package versions\n* Remove `fedora35` packaging targets\n* [libnvidia-container] Include all `gsp*.bin` firmware files if present\n* [libnvidia-container] Align `.deb` and `.rpm` release candidate package versions\n* [libnvidia-container] Remove `fedora35` packaging targets\n* [toolkit-container] Install `nvidia-container-toolkit-operator-extensions` package for mode-specific executables.\n* [toolkit-container] Allow `nvidia-container-runtime.mode` to be set when configuring the NVIDIA Container Toolkit\n\n## v1.12.0\n\n* Promote `v1.12.0-rc.5` to `v1.12.0`\n* Rename `nvidia cdi generate` `--root` flag to `--driver-root` to better indicate intent\n* [libnvidia-container] Add nvcubins.bin to DriverStore components under WSL2\n* [toolkit-container] Bump CUDA base images to 12.0.1\n\n## v1.12.0-rc.5\n\n* Fix bug here the `nvidia-ctk` path was not properly resolved. This causes failures to run containers when the runtime is configured in `csv` mode or if the `NVIDIA_DRIVER_CAPABILITIES` includes `graphics` or `display` (e.g. `all`).\n\n## v1.12.0-rc.4\n\n* Generate a minimum CDI spec version for improved compatibility.\n* Add `--device-name-strategy` options to the `nvidia-ctk cdi generate` command that can be used to control how device names are constructed.\n* Set default for CDI device name generation to `index` to generate device names such as `nvidia.com/gpu=0` or `nvidia.com/gpu=1:0` by default.\n\n## v1.12.0-rc.3\n\n* Don't fail if by-path symlinks for DRM devices do not exist\n* Replace the --json flag with a --format [json|yaml] flag for the nvidia-ctk cdi generate command\n* Ensure that the CDI output folder is created if required\n* When generating a CDI specification use a blank host path for devices to ensure compatibility with the v0.4.0 CDI specification\n* Add injection of Wayland JSON files\n* Add GSP firmware paths to generated CDI specification\n* Add --root flag to nvidia-ctk cdi generate command\n\n## v1.12.0-rc.2\n\n* Inject Direct Rendering Manager (DRM) devices into a container using the NVIDIA Container Runtime\n* Improve logging of errors from the NVIDIA Container Runtime\n* Improve CDI specification generation to support rootless podman\n* Use `nvidia-ctk cdi generate` to generate CDI specifications instead of `nvidia-ctk info generate-cdi`\n* [libnvidia-container] Skip creation of existing files when these are already mounted\n\n## v1.12.0-rc.1\n\n* Add support for multiple Docker Swarm resources\n* Improve injection of Vulkan configurations and libraries\n* Add `nvidia-ctk info generate-cdi` command to generated CDI specification for available devices\n* [libnvidia-container] Include NVVM compiler library in compute libs\n\n## v1.11.0\n\n* Promote v1.11.0-rc.3 to v1.11.0\n\n## v1.11.0-rc.3\n\n* Build fedora35 packages\n* Introduce an `nvidia-container-toolkit-base` package for better dependency management\n* Fix removal of `nvidia-container-runtime-hook` on RPM-based systems\n* Inject platform files into container on Tegra-based systems\n* [toolkit container] Update CUDA base images to 11.7.1\n* [libnvidia-container] Preload libgcc_s.so.1 on arm64 systems\n\n## v1.11.0-rc.2\n\n* Allow `accept-nvidia-visible-devices-*` config options to be set by toolkit container\n* [libnvidia-container] Fix bug where LDCache was not updated when the `--no-pivot-root` option was specified\n\n## v1.11.0-rc.1\n\n* Add discovery of GPUDirect Storage (`nvidia-fs*`) devices if the `NVIDIA_GDS` environment variable of the container is set to `enabled`\n* Add discovery of MOFED Infiniband devices if the `NVIDIA_MOFED` environment variable of the container is set to `enabled`\n* Fix bug in CSV mode where libraries listed as `sym` entries in mount specification are not added to the LDCache.\n* Rename `nvidia-container-toolkit` executable to `nvidia-container-runtime-hook` and create `nvidia-container-toolkit` as a symlink to `nvidia-container-runtime-hook` instead.\n* Add `nvidia-ctk runtime configure` command to configure the Docker config file (e.g. `/etc/docker/daemon.json`) for use with the NVIDIA Container Runtime.\n\n## v1.10.0\n\n* Promote v1.10.0-rc.3 to v1.10.0\n\n## v1.10.0-rc.3\n\n* Use default config instead of raising an error if config file cannot be found\n* Ignore NVIDIA_REQUIRE_JETPACK* environment variables for requirement checks\n* Fix bug in detection of Tegra systems where `/sys/devices/soc0/family` is ignored\n* Fix bug where links to devices were detected as devices\n* [libnvida-container] Fix bug introduced when adding libcudadebugger.so to list of libraries\n\n## v1.10.0-rc.2\n\n* Add support for NVIDIA_REQUIRE_* checks for cuda version and arch to csv mode\n* Switch to debug logging to reduce log verbosity\n* Support logging to logs requested in command line\n* Fix bug when launching containers with relative root path (e.g. using containerd)\n* Allow low-level runtime path to be set explicitly as nvidia-container-runtime.runtimes option\n* Fix failure to locate low-level runtime if PATH envvar is unset\n* Replace experimental option for NVIDIA Container Runtime with nvidia-container-runtime.mode = csv option\n* Use csv as default mode on Tegra systems without NVML\n* Add --version flag to all CLIs\n* [libnvidia-container] Bump libtirpc to 1.3.2\n* [libnvidia-container] Fix bug when running host ldconfig using glibc compiled with a non-standard prefix\n* [libnvidia-container] Add libcudadebugger.so to list of compute libraries\n\n## v1.10.0-rc.1\n\n* Include nvidia-ctk CLI in installed binaries\n* Add experimental option to NVIDIA Container Runtime\n\n## v1.9.0\n\n* [libnvidia-container] Add additional check for Tegra in /sys/.../family file in CLI\n* [libnvidia-container] Update jetpack-specific CLI option to only load Base CSV files by default\n* [libnvidia-container] Fix bug (from 1.8.0) when mounting GSP firmware into containers without /lib to /usr/lib symlinks\n* [libnvidia-container] Update nvml.h to CUDA 11.6.1 nvML_DEV 11.6.55\n* [libnvidia-container] Update switch statement to include new brands from latest nvml.h\n* [libnvidia-container] Process all --require flags on Jetson platforms\n* [libnvidia-container] Fix long-standing issue with running ldconfig on Debian systems\n\n## v1.8.1\n\n* [libnvidia-container] Fix bug in determining cgroup root when running in nested containers\n* [libnvidia-container] Fix permission issue when determining cgroup version\n\n## v1.8.0\n\n* Promote 1.8.0-rc.2-1 to 1.8.0\n\n## v1.8.0-rc.2\n\n* Remove support for building amazonlinux1 packages\n\n## v1.8.0-rc.1\n\n* [libnvidia-container] Add support for cgroupv2\n* Release toolkit-container images from nvidia-container-toolkit repository\n\n## v1.7.0\n\n* Promote 1.7.0-rc.1-1 to 1.7.0\n * Bump Golang version to 1.16.4\n\n## v1.7.0-rc.1\n\n* Specify containerd runtime type as string in config tools to remove dependency on containerd package\n* Add supported-driver-capabilities config option to allow for a subset of all driver capabilities to be specified\n\n## v1.6.0\n\n* Promote 1.6.0-rc.3-1 to 1.6.0\n * Fix unnecessary logging to stderr instead of configured nvidia-container-runtime log file\n\n## v1.6.0-rc.3\n\n* Add supported-driver-capabilities config option to the nvidia-container-toolkit\n* Move OCI and command line checks for runtime to internal oci package\n\n## v1.6.0-rc.2\n\n* Use relative path to OCI specification file (config.json) if bundle path is not specified as an argument to the nvidia-container-runtime\n\n## v1.6.0-rc.1\n\n* Add AARCH64 package for Amazon Linux 2\n* Include nvidia-container-runtime into nvidia-container-toolkit package\n\n## v1.5.1\n\n* Fix bug where Docker Swarm device selection is ignored if NVIDIA_VISIBLE_DEVICES is also set\n* Improve unit testing by using require package and adding coverage reports\n* Remove unneeded go dependencies by running go mod tidy\n* Move contents of pkg directory to cmd for CLI tools\n* Ensure make binary target explicitly sets GOOS\n\n## v1.5.0\n\n* Add dependence on libnvidia-container-tools >= 1.4.0\n* Add golang check targets to Makefile\n* Add Jenkinsfile definition for build targets\n* Move docker.mk to docker folder\n\n## v1.4.2\n\n* Add dependence on libnvidia-container-tools >= 1.3.3\n\n## v1.4.1\n\n* Ignore NVIDIA_VISIBLE_DEVICES for containers with insufficent privileges\n* Add dependence on libnvidia-container-tools >= 1.3.2\n\n## v1.4.0\n\n* Add 'compute' capability to list of defaults\n* Add dependence on libnvidia-container-tools >= 1.3.1\n\n## v1.3.0\n\n* Promote 1.3.0-rc.2-1 to 1.3.0\n* Add dependence on libnvidia-container-tools >= 1.3.0\n\n## v1.3.0-rc.2\n\n* 2c180947 Add more tests for new semantics with device list from volume mounts\n* 7c003857 Refactor accepting device lists from volume mounts as a boolean\n\n## v1.3.0-rc.1\n\n* b50d86c1 Update build system to accept a TAG variable for things like rc.x\n* fe65573b Add common CI tests for things like golint, gofmt, unit tests, etc.\n* da6fbb34 Revert \"Add ability to merge envars of the form NVIDIA_VISIBLE_DEVICES_*\"\n* a7fb3330 Flip build-all targets to run automatically on merge requests\n* 8b248b66 Rename github.com/NVIDIA/container-toolkit to nvidia-container-toolkit\n* da36874e Add new config options to pull device list from mounted files instead of ENVVAR\n\n## v1.2.1\n\n* 4e6e0ed4 Add 'ngx' to list of*all* driver capabilities\n* 2f4af743 List config.toml as a config file in the RPM SPEC\n\n## v1.2.0\n\n* 8e0aab46 Fix repo listed in changelog for debian distributions\n* 320bb6e4 Update dependence on libnvidia-container to 1.2.0\n* 6cfc8097 Update package license to match source license\n* e7dc3cbb Fix debian copyright file\n* d3aee3e0 Add the 'ngx' driver capability\n\n## v1.1.2\n\n* c32237f3 Add support for parsing Linux Capabilities for older OCI specs\n\n## v1.1.1\n\n* d202aded Update dependence to libnvidia-container 1.1.1\n\n## v1.1.0\n\n* 4e4de762 Update build system to support multi-arch builds\n* fcc1d116 Add support for MIG (Multi-Instance GPUs)\n* d4ff0416 Add ability to merge envars of the form NVIDIA_VISIBLE_DEVICES_*\n* 60f165ad Add no-pivot option to toolkit\n\n## v1.0.5\n\n* Initial release. Replaces older package nvidia-container-runtime-hook. (Closes: #XXXXXX)\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Contribute to the NVIDIA Container Toolkit\n\nWant to hack on the NVIDIA Container Toolkit Project? Awesome!\nWe only require you to sign your work, the below section describes this!\n\n## Sign your work\n\nThe sign-off is a simple line at the end of the explanation for the patch. Your\nsignature certifies that you wrote the patch or otherwise have the right to pass\nit on as an open-source patch. The rules are pretty simple: if you can certify\nthe below (from [developercertificate.org](http://developercertificate.org/)):\n\n```\nDeveloper Certificate of Origin\nVersion 1.1\n\nCopyright (C) 2004, 2006 The Linux Foundation and its contributors.\n1 Letterman Drive\nSuite D4700\nSan Francisco, CA, 94129\n\nEveryone is permitted to copy and distribute verbatim copies of this\nlicense document, but changing it is not allowed.\n\nDeveloper's Certificate of Origin 1.1\n\nBy making a contribution to this project, I certify that:\n\n(a) The contribution was created in whole or in part by me and I\n have the right to submit it under the open source license\n indicated in the file; or\n\n(b) The contribution is based upon previous work that, to the best\n of my knowledge, is covered under an appropriate open source\n license and I have the right under that license to submit that\n work with modifications, whether created in whole or in part\n by me, under the same open source license (unless I am\n permitted to submit under a different license), as indicated\n in the file; or\n\n(c) The contribution was provided directly to me by some other\n person who certified (a), (b) or (c) and I have not modified\n it.\n\n(d) I understand and agree that this project and the contribution\n are public and that a record of the contribution (including all\n personal information I submit with it, including my sign-off) is\n maintained indefinitely and may be redistributed consistent with\n this project or the open source license(s) involved.\n```\n\nThen you just add a line to every git commit message:\n\n Signed-off-by: Joe Smith \n\nUse your real name (sorry, no pseudonyms or anonymous contributions.)\n\nIf you set your `user.name` and `user.email` git configs, you can sign your\ncommit automatically with `git commit -s`.\n\n"
},
{
"path": "DEVELOPMENT.md",
"content": "# NVIDIA Container Toolkit Release Tooling\n\nThis repository allows for the components of the NVIDIA container stack to be\nbuilt and released as the NVIDIA Container Toolkit from a single repository. The components:\n* `libnvidia-container`\n* `nvidia-container-runtime`\n* `nvidia-docker`\nare included as submodules in the `third_party` folder.\n\nThe `nvidia-container-toolkit` resides in this repo directly.\n\n## Building\n\nIn oder to build the packages, the following command is executed\n```sh\n./scripts/build-packages.sh TARGET\n```\nwhere `TARGET` is a make target that is valid for each of the sub-components.\n\nThese include:\n* `ubuntu18.04-amd64`\n* `centos7-x86_64`\n\nIf no `TARGET` is specified, all valid release targets are built.\n\nThe packages are generated in the `dist` folder.\n\n## Testing local changes\n\nIn oder to use the same build logic to be used to generate packages with local changes,\nthe location of the individual components can be overridded using the: `LIBNVIDIA_CONTAINER_ROOT`,\n`NVIDIA_CONTAINER_TOOLKIT_ROOT`, `NVIDIA_CONTAINER_RUNTIME_ROOT`, and `NVIDIA_DOCKER_ROOT`\nenvironment variables.\n\n## Testing packages locally\n\nThe [tests/release](./tests/release/) folder contains documentation on how the installation of local or staged packages can be tested.\n\n\n## Releasing\n\nIn order to release packages required for a release, a utility script\n[`scripts/release-packages.sh`](./scripts/release-packages.sh) is provided.\nThis script can be executed as follows:\n\n```bash\nGPG_LOCAL_USER=\"GPG_USER\" \\\nMASTER_KEY_PATH=/path/to/gpg-master.key \\\nSUB_KEY_PATH=/path/to/gpg-subkey.key \\\n ./scripts/release-packages.sh REPO PACKAGE_REPO_ROOT [REFERENCE]\n```\n\nWhere `REPO` is one of `stable` or `experimental`, `PACKAGE_REPO_ROOT` is the local path to the `libnvidia-container` repository checked out to the `gh-pages` branch, and `REFERENCE` is the git SHA that is to be released. If reference is not specified `HEAD` is assumed.\n\nThis scripts performs the following basic functions:\n* Pulls the package image defined by the `REFERENCE` git SHA from the staging registry,\n* Copies the required packages to the package repository at `PACKAGE_REPO_ROOT/REPO`,\n* Signs the packages using the specified GPG keys\n\nWhile the last two are performed, commits are added to the package repository. These can be pushed to the relevant repository.\n\n"
},
{
"path": "LICENSE",
"content": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n"
},
{
"path": "Makefile",
"content": "# Copyright (c) 2017-2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nDOCKER ?= docker\nMKDIR ?= mkdir\nDIST_DIR ?= $(CURDIR)/dist\n\ninclude $(CURDIR)/versions.mk\n\nMODULE := github.com/NVIDIA/nvidia-container-toolkit\n\n# By default run all native docker-based targets\ndocker-native:\ninclude $(CURDIR)/docker/docker.mk\n\nifeq ($(IMAGE_NAME),)\nREGISTRY ?= nvidia\nIMAGE_NAME = $(REGISTRY)/container-toolkit\nendif\n\nBUILDIMAGE_TAG ?= golang$(GOLANG_VERSION)\nBUILDIMAGE ?= $(IMAGE_NAME)-build:$(BUILDIMAGE_TAG)\n\nEXAMPLES := $(patsubst ./examples/%/,%,$(sort $(dir $(wildcard ./examples/*/))))\nEXAMPLE_TARGETS := $(patsubst %,example-%, $(EXAMPLES))\n\nCMDS := $(patsubst ./cmd/%/,%,$(sort $(dir $(wildcard ./cmd/*/))))\nCMD_TARGETS := $(patsubst %,cmd-%, $(CMDS))\n\nCHECK_TARGETS := lint\nMAKE_TARGETS := binaries build check fmt test examples cmds coverage generate licenses vendor check-vendor $(CHECK_TARGETS)\n\nTARGETS := $(MAKE_TARGETS) $(EXAMPLE_TARGETS) $(CMD_TARGETS)\n\nDOCKER_TARGETS := $(patsubst %,docker-%, $(TARGETS))\n.PHONY: $(TARGETS) $(DOCKER_TARGETS)\n\nifeq ($(VERSION),)\nCLI_VERSION = $(LIB_VERSION)$(if $(LIB_TAG),-$(LIB_TAG))\nelse\nCLI_VERSION = $(VERSION)\nendif\nCLI_VERSION_PACKAGE = github.com/NVIDIA/nvidia-container-toolkit/internal/info\n\nbinaries: cmds\nifneq ($(PREFIX),)\ncmd-%: COMMAND_BUILD_OPTIONS = -o $(PREFIX)/$(*)\nendif\ncmds: $(CMD_TARGETS)\n\nifneq ($(shell uname),Darwin)\nEXTLDFLAGS = -Wl,--export-dynamic -Wl,--unresolved-symbols=ignore-in-object-files -Wl,-z,lazy\nelse\nEXTLDFLAGS = -Wl,-undefined,dynamic_lookup\nendif\n$(CMD_TARGETS): cmd-%:\n\tgo build -ldflags \"-s -w '-extldflags=$(EXTLDFLAGS)' -X $(CLI_VERSION_PACKAGE).gitCommit=$(GIT_COMMIT) -X $(CLI_VERSION_PACKAGE).version=$(CLI_VERSION)\" $(COMMAND_BUILD_OPTIONS) $(MODULE)/cmd/$(*)\n\nbuild:\n\tgo build ./...\n\nexamples: $(EXAMPLE_TARGETS)\n$(EXAMPLE_TARGETS): example-%:\n\tgo build ./examples/$(*)\n\nall: check test build binary\ncheck: $(CHECK_TARGETS)\n\n# Apply go fmt to the codebase\nfmt:\n\tgo list -f '{{.Dir}}' $(MODULE)/... \\\n\t\t| xargs gofmt -s -l -w\n\n# Apply goimports -local github.com/NVIDIA/container-toolkit to the codebase\ngoimports:\n\tgo list -f {{.Dir}} $(MODULE)/... \\\n\t\t| xargs goimports -local $(MODULE) -w\n\nlint:\n\tgolangci-lint run ./...\n\nvendor: | mod-tidy mod-vendor mod-verify\n\nmod-tidy:\n\t@for mod in $$(find . -name go.mod -not -path \"./testdata/*\" -not -path \"./third_party/*\"); do \\\n\t echo \"Tidying $$mod...\"; ( \\\n\t cd $$(dirname $$mod) && go mod tidy \\\n ) || exit 1; \\\n\tdone\n\nmod-vendor:\n\t@for mod in $$(find . -name go.mod -not -path \"./testdata/*\" -not -path \"./third_party/*\" -not -path \"./deployments/*\"); do \\\n\t\techo \"Vendoring $$mod...\"; ( \\\n\t\t\tcd $$(dirname $$mod) && go mod vendor \\\n\t\t\t) || exit 1; \\\n\tdone\n\nmod-verify:\n\t@for mod in $$(find . -name go.mod -not -path \"./testdata/*\" -not -path \"./third_party/*\"); do \\\n\t echo \"Verifying $$mod...\"; ( \\\n\t cd $$(dirname $$mod) && go mod verify | sed 's/^/ /g' \\\n\t ) || exit 1; \\\n\tdone\n\n\ncheck-vendor: vendor\n\tgit diff --exit-code HEAD -- go.mod go.sum vendor\n\nlicenses:\n\tgo-licenses csv $(MODULE)/...\n\nCOVERAGE_FILE := coverage.out\ntest: build cmds\n\tgo test -coverprofile=$(COVERAGE_FILE).with-mocks $(MODULE)/...\n\ncoverage: test\n\tcat $(COVERAGE_FILE).with-mocks | grep -v \"_mock.go\" > $(COVERAGE_FILE)\n\tgo tool cover -func=$(COVERAGE_FILE)\n\ngenerate:\n\tgo generate $(MODULE)/...\n\n# Generate an image for containerized builds\n# Note: This image is local only\n.PHONY: .build-image\n.build-image:\n\tmake -f deployments/devel/Makefile .build-image\n\nifeq ($(BUILD_DEVEL_IMAGE),yes)\n$(DOCKER_TARGETS): .build-image\n.shell: .build-image\nendif\n\n$(DOCKER_TARGETS): docker-%:\n\t@echo \"Running 'make $(*)' in container image $(BUILDIMAGE)\"\n\t$(DOCKER) run \\\n\t\t--rm \\\n\t\t-e GOCACHE=/tmp/.cache/go \\\n\t\t-e GOMODCACHE=/tmp/.cache/gomod \\\n\t\t-e GOLANGCI_LINT_CACHE=/tmp/.cache/golangci-lint \\\n\t\t-v $(PWD):/work \\\n\t\t-w /work \\\n\t\t--user $$(id -u):$$(id -g) \\\n\t\t$(BUILDIMAGE) \\\n\t\t\tmake $(*)\n\n# Start an interactive shell using the development image.\nPHONY: .shell\n.shell:\n\t$(DOCKER) run \\\n\t\t--rm \\\n\t\t-ti \\\n\t\t-e GOCACHE=/tmp/.cache/go \\\n\t\t-e GOMODCACHE=/tmp/.cache/gomod \\\n\t\t-e GOLANGCI_LINT_CACHE=/tmp/.cache/golangci-lint \\\n\t\t-v $(PWD):/work \\\n\t\t-w /work \\\n\t\t--user $$(id -u):$$(id -g) \\\n\t\t$(BUILDIMAGE)\n"
},
{
"path": "README.md",
"content": "# NVIDIA Container Toolkit\n\n[](https://raw.githubusercontent.com/NVIDIA/nvidia-container-toolkit/main/LICENSE)\n[](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/overview.html)\n[](https://nvidia.github.io/libnvidia-container)\n\n\n\n## Introduction\n\nThe NVIDIA Container Toolkit allows users to build and run GPU-accelerated containers. The toolkit includes a container runtime [library](https://github.com/NVIDIA/libnvidia-container) and utilities to automatically configure containers to leverage NVIDIA GPUs.\n\nProduct documentation including an architecture overview, platform support, and installation and usage guides can be found in the [documentation repository](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/overview.html).\n\n## Getting Started\n\n**Make sure you have installed the [NVIDIA driver](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#nvidia-drivers) for your Linux Distribution**\n**Note that you do not need to install the CUDA Toolkit on the host system, but the NVIDIA driver needs to be installed**\n\nFor instructions on getting started with the NVIDIA Container Toolkit, refer to the [installation guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#installation-guide).\n\n## Usage\n\nThe [user guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/user-guide.html) provides information on the configuration and command line options available when running GPU containers with Docker.\n\n## Issues and Contributing\n\n[Checkout the Contributing document!](CONTRIBUTING.md)\n\n* Please let us know by [filing a new issue](https://github.com/NVIDIA/nvidia-container-toolkit/issues/new)\n* You can contribute by creating a [pull request](https://github.com/NVIDIA/nvidia-container-toolkit/compare) to our public GitHub repository\n"
},
{
"path": "RELEASE.md",
"content": "# Release Process\n\nThe NVIDIA Container Toolkit consists of the following artifacts:\n- The NVIDIA Container Toolkit container\n- Packages for debian-based systems\n- Packages for rpm-based systems\n\n# Release Process Checklist:\n- [ ] Create a release PR:\n - [ ] Run the `./hack/prepare-release.sh` script to update the version in all the needed files. This also creates a [release issue](https://github.com/NVIDIA/nvidia-container-toolkit/issues?q=is%3Aissue+is%3Aopen+label%3Arelease)\n - [ ] Run the `./hack/generate-changelog.sh` script to generate the a draft changelog and update `CHANGELOG.md` with the changes.\n - [ ] Create a PR from the created `bump-release-{{ .VERSION }}` branch.\n- [ ] Merge the release PR\n- [ ] Tag the release and push the tag to the `internal` mirror:\n- [ ] Wait for the image release to complete.\n- [ ] Push the tag to the the upstream GitHub repo.\n- [ ] Wait for the [`Release`](https://github.com/NVIDIA/nvidia-container-toolkit/actions/workflows/release.yaml) GitHub Action to complete\n- [ ] Publish the [draft release](https://github.com/NVIDIA/nvidia-container-toolkit/releases) created by the GitHub Action\n- [ ] Publish the packages to the gh-pages branch of the libnvidia-container repo\n- [ ] Create a KitPick\n- [ ] For non-experimental releases, schedule the package for publication to the CUDA Downloads repositories.\n\n## Troubleshooting\n\n*Note*: This assumes that we have the release tag checked out locally.\n\n- If the `Release` GitHub Action fails:\n - Check the logs for the error first.\n - Create the helm packages locally by running:\n ```bash\n ./hack/prepare-artifacts.sh {{ .VERSION }}\n ```\n - Create the draft release by running:\n ```bash\n ./hack/create-release.sh {{ .VERSION }}\n ```\n"
},
{
"path": "SECURITY.md",
"content": "# Security\n\nNVIDIA is dedicated to the security and trust of our software products and services, including all source code repositories managed through our organization.\n\nIf you need to report a security issue, please use the appropriate contact points outlined below. **Please do not report security vulnerabilities through GitHub.**\n\n## Reporting Potential Security Vulnerability in an NVIDIA Product\n\nTo report a potential security vulnerability in any NVIDIA product:\n- Web: [Security Vulnerability Submission Form](https://www.nvidia.com/object/submit-security-vulnerability.html)\n- E-Mail: psirt@nvidia.com\n - We encourage you to use the following PGP key for secure email communication: [NVIDIA public PGP Key for communication](https://www.nvidia.com/en-us/security/pgp-key)\n - Please include the following information:\n - Product/Driver name and version/branch that contains the vulnerability\n - Type of vulnerability (code execution, denial of service, buffer overflow, etc.)\n - Instructions to reproduce the vulnerability\n - Proof-of-concept or exploit code\n - Potential impact of the vulnerability, including how an attacker could exploit the vulnerability\n\nWhile NVIDIA currently does not have a bug bounty program, we do offer acknowledgement when an externally reported security issue is addressed under our coordinated vulnerability disclosure policy. Please visit our [Product Security Incident Response Team (PSIRT)](https://www.nvidia.com/en-us/security/psirt-policies/) policies page for more information.\n\n## NVIDIA Product Security\n\nFor all security-related concerns, please visit NVIDIA's Product Security portal at https://www.nvidia.com/en-us/security\n"
},
{
"path": "api/config/v1/cli.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"strings\"\n)\n\n// ContainerCLIConfig stores the options for the nvidia-container-cli\ntype ContainerCLIConfig struct {\n\tRoot string `toml:\"root\"`\n\tPath string `toml:\"path\"`\n\tEnvironment []string `toml:\"environment\"`\n\tDebug string `toml:\"debug\"`\n\tLdcache string `toml:\"ldcache\"`\n\tLoadKmods bool `toml:\"load-kmods\"`\n\t// NoPivot disables the pivot root operation in the NVIDIA Container CLI.\n\t// This is not exposed in the config if not set.\n\tNoPivot bool `toml:\"no-pivot,omitempty\"`\n\tNoCgroups bool `toml:\"no-cgroups\"`\n\tUser string `toml:\"user\"`\n\t// Ldconfig represents the path to the ldconfig binary to be used to update\n\t// the ldcache in a container as it is being created.\n\t// If this path starts with a '@' the path is relative to the host and if\n\t// not it is treated as a container path.\n\t//\n\t// Note that the use of container paths are disabled by default and if this\n\t// is required, the features.allow-ldconfig-from-container feature gate must\n\t// be enabled explicitly.\n\tLdconfig ldconfigPath `toml:\"ldconfig\"`\n}\n\n// NormalizeLDConfigPath returns the resolved path of the configured LDConfig binary.\n// This is only done for host LDConfigs and is required to handle systems where\n// /sbin/ldconfig is a wrapper around /sbin/ldconfig.real.\nfunc (c *ContainerCLIConfig) NormalizeLDConfigPath() string {\n\treturn string(c.Ldconfig.normalize())\n}\n\n// An ldconfigPath is used to represent the path to ldconfig.\ntype ldconfigPath string\n\nfunc (p ldconfigPath) assertValid(allowContainerRelativePath bool) error {\n\tif p.isHostRelative() {\n\t\treturn nil\n\t}\n\tif allowContainerRelativePath {\n\t\treturn nil\n\t}\n\treturn fmt.Errorf(\"nvidia-container-cli.ldconfig value %q is not host-relative (does not start with a '@')\", p)\n}\n\nfunc (p ldconfigPath) isHostRelative() bool {\n\treturn strings.HasPrefix(string(p), \"@\")\n}\n\n// normalize returns the resolved path of the configured LDConfig binary.\n// This is only done for host LDConfigs and is required to handle systems where\n// /sbin/ldconfig is a wrapper around /sbin/ldconfig.real.\nfunc (p ldconfigPath) normalize() ldconfigPath {\n\tif !p.isHostRelative() {\n\t\treturn p\n\t}\n\n\tpath := string(p)\n\ttrimmedPath := strings.TrimSuffix(strings.TrimPrefix(path, \"@\"), \".real\")\n\t// If the .real path exists, we return that.\n\tif _, err := os.Stat(trimmedPath + \".real\"); err == nil {\n\t\treturn ldconfigPath(\"@\" + trimmedPath + \".real\")\n\t}\n\t// If the .real path does not exists (or cannot be read) we return the non-.real path.\n\treturn ldconfigPath(\"@\" + trimmedPath)\n}\n\n// NormalizeLDConfigPath returns the resolved path of the configured LDConfig binary.\n// This is only done for host LDConfigs and is required to handle systems where\n// /sbin/ldconfig is a wrapper around /sbin/ldconfig.real.\nfunc NormalizeLDConfigPath(path string) string {\n\treturn string(ldconfigPath(path).normalize())\n}\n"
},
{
"path": "api/config/v1/cli_test.go",
"content": "/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNormalizeLDConfigPath(t *testing.T) {\n\ttestDir := t.TempDir()\n\n\tf, err := os.Create(filepath.Join(testDir, \"exists.real\"))\n\trequire.NoError(t, err)\n\t_ = f.Close()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tldconfig ldconfigPath\n\t\texpected string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty input\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-host with .real suffix returns as is\",\n\t\t\tldconfig: \"/some/path/ldconfig.real\",\n\t\t\texpected: \"/some/path/ldconfig.real\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-host without .real suffix returns as is\",\n\t\t\tldconfig: \"/some/path/ldconfig\",\n\t\t\texpected: \"/some/path/ldconfig\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"host .real file exists is returned\",\n\t\t\tldconfig: ldconfigPath(\"@\" + filepath.Join(testDir, \"exists.real\")),\n\t\t\texpected: \"@\" + filepath.Join(testDir, \"exists.real\"),\n\t\t},\n\t\t{\n\t\t\tdescription: \"host resolves .real file\",\n\t\t\tldconfig: ldconfigPath(\"@\" + filepath.Join(testDir, \"exists\")),\n\t\t\texpected: \"@\" + filepath.Join(testDir, \"exists.real\"),\n\t\t},\n\t\t{\n\t\t\tdescription: \"host .real file not exists strips suffix\",\n\t\t\tldconfig: \"@/does/not/exist.real\",\n\t\t\texpected: \"@/does/not/exist\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"host file returned as is if no .real file exsits\",\n\t\t\tldconfig: \"@/does/not/exist\",\n\t\t\texpected: \"@/does/not/exist\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tc := ContainerCLIConfig{\n\t\t\t\tLdconfig: tc.ldconfig,\n\t\t\t}\n\n\t\t\trequire.Equal(t, tc.expected, c.NormalizeLDConfigPath())\n\t\t})\n\t}\n}\n"
},
{
"path": "api/config/v1/config.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"bufio\"\n\t\"errors\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nconst (\n\tFilePathOverrideEnvVar = \"NVIDIA_CTK_CONFIG_FILE_PATH\"\n\tRelativeFilePath = \"nvidia-container-runtime/config.toml\"\n\n\tconfigRootOverride = \"XDG_CONFIG_HOME\"\n\n\tnvidiaCTKExecutable = \"nvidia-ctk\"\n\tnvidiaCTKDefaultFilePath = \"/usr/bin/nvidia-ctk\"\n\tnvidiaCDIHookDefaultFilePath = \"/usr/bin/nvidia-cdi-hook\"\n\n\tnvidiaContainerRuntimeHookExecutable = \"nvidia-container-runtime-hook\"\n\tnvidiaContainerRuntimeHookDefaultPath = \"/usr/bin/nvidia-container-runtime-hook\"\n)\n\nvar (\n\t// DefaultExecutableDir specifies the default path to use for executables if they cannot be located in the path.\n\tDefaultExecutableDir = \"/usr/bin\"\n\n\t// NVIDIAContainerRuntimeHookExecutable is the executable name for the NVIDIA Container Runtime Hook\n\tNVIDIAContainerRuntimeHookExecutable = \"nvidia-container-runtime-hook\"\n\t// NVIDIAContainerToolkitExecutable is the executable name for the NVIDIA Container Toolkit (an alias for the NVIDIA Container Runtime Hook)\n\tNVIDIAContainerToolkitExecutable = \"nvidia-container-toolkit\"\n)\n\nvar errInvalidConfig = errors.New(\"invalid config value\")\n\n// Config represents the contents of the config.toml file for the NVIDIA Container Toolkit\n// Note: This is currently duplicated by the HookConfig in cmd/nvidia-container-toolkit/hook_config.go\ntype Config struct {\n\tDisableRequire bool `toml:\"disable-require\"`\n\tSwarmResource string `toml:\"swarm-resource\"`\n\tAcceptEnvvarUnprivileged bool `toml:\"accept-nvidia-visible-devices-envvar-when-unprivileged\"`\n\tAcceptDeviceListAsVolumeMounts bool `toml:\"accept-nvidia-visible-devices-as-volume-mounts\"`\n\tSupportedDriverCapabilities string `toml:\"supported-driver-capabilities\"`\n\n\tNVIDIAContainerCLIConfig ContainerCLIConfig `toml:\"nvidia-container-cli\"`\n\tNVIDIACTKConfig CTKConfig `toml:\"nvidia-ctk\"`\n\tNVIDIAContainerRuntimeConfig RuntimeConfig `toml:\"nvidia-container-runtime\"`\n\tNVIDIAContainerRuntimeHookConfig RuntimeHookConfig `toml:\"nvidia-container-runtime-hook\"`\n\n\t// Features allows for finer control over optional features.\n\tFeatures features `toml:\"features,omitempty\"`\n}\n\n// GetConfigFilePath returns the path to the config file for the configured system\nfunc GetConfigFilePath() string {\n\tif configFilePathOverride := os.Getenv(FilePathOverrideEnvVar); configFilePathOverride != \"\" {\n\t\treturn configFilePathOverride\n\t}\n\tconfigRoot := \"/etc\"\n\tif XDGConfigDir := os.Getenv(configRootOverride); len(XDGConfigDir) != 0 {\n\t\tconfigRoot = XDGConfigDir\n\t}\n\n\treturn filepath.Join(configRoot, RelativeFilePath)\n}\n\n// GetConfig sets up the config struct. Values are read from a toml file\n// or set via the environment.\nfunc GetConfig() (*Config, error) {\n\tcfg, err := New(\n\t\tWithConfigFile(GetConfigFilePath()),\n\t)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn cfg.Config()\n}\n\n// GetDefault defines the default values for the config\nfunc GetDefault() (*Config, error) {\n\td := Config{\n\t\tAcceptEnvvarUnprivileged: true,\n\t\tSupportedDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\tLoadKmods: true,\n\t\t\tLdconfig: getLdConfigPath(),\n\t\t\tUser: getUserGroup(),\n\t\t},\n\t\tNVIDIACTKConfig: CTKConfig{\n\t\t\tPath: nvidiaCTKExecutable,\n\t\t},\n\t\tNVIDIAContainerRuntimeConfig: RuntimeConfig{\n\t\t\tDebugFilePath: \"/dev/null\",\n\t\t\tLogLevel: \"info\",\n\t\t\tRuntimes: []string{\"runc\", \"crun\"},\n\t\t\tMode: \"auto\",\n\t\t\tModes: modesConfig{\n\t\t\t\tCSV: csvModeConfig{\n\t\t\t\t\tMountSpecPath: \"/etc/nvidia-container-runtime/host-files-for-container.d\",\n\t\t\t\t},\n\t\t\t\tCDI: cdiModeConfig{\n\t\t\t\t\tDefaultKind: \"nvidia.com/gpu\",\n\t\t\t\t\tAnnotationPrefixes: []string{cdi.AnnotationPrefix},\n\t\t\t\t\tSpecDirs: cdi.DefaultSpecDirs,\n\t\t\t\t},\n\t\t\t\tLegacy: legacyModeConfig{\n\t\t\t\t\tCUDACompatMode: defaultCUDACompatMode,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\tNVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{\n\t\t\tPath: NVIDIAContainerRuntimeHookExecutable,\n\t\t},\n\t}\n\treturn &d, nil\n}\n\n// assertValid checks for a valid config.\nfunc (c *Config) assertValid() error {\n\terr := c.NVIDIAContainerCLIConfig.Ldconfig.assertValid(c.Features.AllowLDConfigFromContainer.IsEnabled())\n\tif err != nil {\n\t\treturn errors.Join(err, errInvalidConfig)\n\t}\n\treturn nil\n}\n\n// getLdConfigPath allows us to override this function for testing.\nvar getLdConfigPath = getLdConfigPathStub\n\nfunc getLdConfigPathStub() ldconfigPath {\n\treturn ldconfigPath(\"@/sbin/ldconfig\").normalize()\n}\n\nfunc getUserGroup() string {\n\tif isSuse() {\n\t\treturn \"root:video\"\n\t}\n\treturn \"\"\n}\n\n// isSuse returns whether a SUSE-based distribution was detected.\nfunc isSuse() bool {\n\tsuseDists := map[string]bool{\n\t\t\"suse\": true,\n\t\t\"opensuse\": true,\n\t}\n\n\tidsLike := getDistIDLike()\n\tfor _, id := range idsLike {\n\t\tif suseDists[id] {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\n// getDistIDLike returns the ID_LIKE field from /etc/os-release.\n// We can override this for testing.\nvar getDistIDLike = func() []string {\n\treleaseFile, err := os.Open(\"/etc/os-release\")\n\tif err != nil {\n\t\treturn nil\n\t}\n\tdefer releaseFile.Close()\n\n\tscanner := bufio.NewScanner(releaseFile)\n\tfor scanner.Scan() {\n\t\tline := scanner.Text()\n\t\tif strings.HasPrefix(line, \"ID_LIKE=\") {\n\t\t\tvalue := strings.Trim(strings.TrimPrefix(line, \"ID_LIKE=\"), \"\\\"\")\n\t\t\treturn strings.Split(value, \" \")\n\t\t}\n\t}\n\treturn nil\n}\n\n// ResolveNVIDIACTKPath resolves the path to the nvidia-ctk binary.\n// This executable is used in hooks and needs to be an absolute path.\n// If the path is specified as an absolute path, it is used directly\n// without checking for existence of an executable at that path.\n//\n// Deprecated: Use ResolveNVIDIACDIHookPath directly instead.\nfunc ResolveNVIDIACTKPath(logger logger.Interface, nvidiaCTKPath string) string {\n\treturn resolveWithDefault(\n\t\tlogger,\n\t\t\"NVIDIA Container Toolkit CLI\",\n\t\tnvidiaCTKPath,\n\t\tnvidiaCTKDefaultFilePath,\n\t)\n}\n\n// ResolveNVIDIACDIHookPath resolves the path to the nvidia-cdi-hook binary.\n// This executable is used in hooks and needs to be an absolute path.\n// If the path is specified as an absolute path, it is used directly\n// without checking for existence of an executable at that path.\nfunc ResolveNVIDIACDIHookPath(logger logger.Interface, nvidiaCDIHookPath string) string {\n\tif filepath.Base(nvidiaCDIHookPath) == \"nvidia-ctk\" {\n\t\treturn resolveWithDefault(\n\t\t\tlogger,\n\t\t\t\"NVIDIA Container Toolkit CLI\",\n\t\t\tnvidiaCDIHookPath,\n\t\t\tnvidiaCTKDefaultFilePath,\n\t\t)\n\t}\n\treturn resolveWithDefault(\n\t\tlogger,\n\t\t\"NVIDIA CDI Hook CLI\",\n\t\tnvidiaCDIHookPath,\n\t\tnvidiaCDIHookDefaultFilePath,\n\t)\n}\n\n// ResolveNVIDIAContainerRuntimeHookPath resolves the path the nvidia-container-runtime-hook binary.\nfunc ResolveNVIDIAContainerRuntimeHookPath(logger logger.Interface, nvidiaContainerRuntimeHookPath string) string {\n\treturn resolveWithDefault(\n\t\tlogger,\n\t\t\"NVIDIA Container Runtime Hook\",\n\t\tnvidiaContainerRuntimeHookPath,\n\t\tnvidiaContainerRuntimeHookDefaultPath,\n\t)\n}\n\n// resolveWithDefault resolves the path to the specified binary.\n// If an absolute path is specified, it is used directly without searching for the binary.\n// If the binary cannot be found in the path, the specified default is used instead.\nfunc resolveWithDefault(logger logger.Interface, label string, path string, defaultPath string) string {\n\tif filepath.IsAbs(path) {\n\t\tlogger.Debugf(\"Using specified %v path %v\", label, path)\n\t\treturn path\n\t}\n\n\tif path == \"\" {\n\t\tpath = filepath.Base(defaultPath)\n\t}\n\tlogger.Debugf(\"Locating %v as %v\", label, path)\n\tlookup := lookup.NewExecutableLocator(logger, \"\")\n\n\tresolvedPath := defaultPath\n\ttargets, err := lookup.Locate(path)\n\tif err != nil {\n\t\tlogger.Warningf(\"Failed to locate %v: %v\", path, err)\n\t} else {\n\t\tlogger.Debugf(\"Found %v candidates: %v\", path, targets)\n\t\tresolvedPath = targets[0]\n\t}\n\tlogger.Debugf(\"Using %v path %v\", label, path)\n\n\treturn resolvedPath\n}\n"
},
{
"path": "api/config/v1/config_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test/to\"\n)\n\nfunc TestGetConfigWithCustomConfig(t *testing.T) {\n\ttestDir := t.TempDir()\n\tt.Setenv(configRootOverride, testDir)\n\n\tfilename := filepath.Join(testDir, RelativeFilePath)\n\n\t// By default debug is disabled\n\tcontents := []byte(\"[nvidia-container-runtime]\\ndebug = \\\"/nvidia-container-toolkit.log\\\"\")\n\n\trequire.NoError(t, os.MkdirAll(filepath.Dir(filename), 0766))\n\trequire.NoError(t, os.WriteFile(filename, contents, 0600))\n\n\tcfg, err := GetConfig()\n\trequire.NoError(t, err)\n\trequire.Equal(t, \"/nvidia-container-toolkit.log\", cfg.NVIDIAContainerRuntimeConfig.DebugFilePath)\n}\n\nfunc TestGetConfigWithConfigFilePathOverride(t *testing.T) {\n\ttestDir := t.TempDir()\n\tfilename := filepath.Join(testDir, RelativeFilePath)\n\n\tt.Setenv(FilePathOverrideEnvVar, filename)\n\n\t// By default debug is disabled\n\tcontents := []byte(\"[nvidia-container-runtime]\\ndebug = \\\"/nvidia-container-toolkit.log\\\"\")\n\n\trequire.NoError(t, os.MkdirAll(filepath.Dir(filename), 0766))\n\trequire.NoError(t, os.WriteFile(filename, contents, 0600))\n\n\tcfg, err := GetConfig()\n\trequire.NoError(t, err)\n\trequire.Equal(t, \"/nvidia-container-toolkit.log\", cfg.NVIDIAContainerRuntimeConfig.DebugFilePath)\n}\n\nfunc TestGetConfig(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcontents []string\n\t\texpectedError error\n\t\tdistIdsLike []string\n\t\texpectedConfig *Config\n\t}{\n\t\t{\n\t\t\tdescription: \"empty config is default\",\n\t\t\texpectedConfig: &Config{\n\t\t\t\tAcceptEnvvarUnprivileged: true,\n\t\t\t\tSupportedDriverCapabilities: \"compat32,compute,display,graphics,ngx,utility,video\",\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tRoot: \"\",\n\t\t\t\t\tLoadKmods: true,\n\t\t\t\t\tLdconfig: \"@/test/ld/config/path\",\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeConfig: RuntimeConfig{\n\t\t\t\t\tDebugFilePath: \"/dev/null\",\n\t\t\t\t\tLogLevel: \"info\",\n\t\t\t\t\tRuntimes: []string{\"runc\", \"crun\"},\n\t\t\t\t\tMode: \"auto\",\n\t\t\t\t\tModes: modesConfig{\n\t\t\t\t\t\tCSV: csvModeConfig{\n\t\t\t\t\t\t\tMountSpecPath: \"/etc/nvidia-container-runtime/host-files-for-container.d\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tCDI: cdiModeConfig{\n\t\t\t\t\t\t\tDefaultKind: \"nvidia.com/gpu\",\n\t\t\t\t\t\t\tAnnotationPrefixes: []string{\"cdi.k8s.io/\"},\n\t\t\t\t\t\t\tSpecDirs: []string{\"/etc/cdi\", \"/var/run/cdi\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tLegacy: legacyModeConfig{\n\t\t\t\t\t\t\tCUDACompatMode: \"ldconfig\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{\n\t\t\t\t\tPath: \"nvidia-container-runtime-hook\",\n\t\t\t\t},\n\t\t\t\tNVIDIACTKConfig: CTKConfig{\n\t\t\t\t\tPath: \"nvidia-ctk\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"config options set inline\",\n\t\t\tcontents: []string{\n\t\t\t\t\"accept-nvidia-visible-devices-envvar-when-unprivileged = false\",\n\t\t\t\t\"supported-driver-capabilities = \\\"compute,utility\\\"\",\n\t\t\t\t\"nvidia-container-cli.root = \\\"/bar/baz\\\"\",\n\t\t\t\t\"nvidia-container-cli.load-kmods = false\",\n\t\t\t\t\"nvidia-container-cli.ldconfig = \\\"@/foo/bar/ldconfig\\\"\",\n\t\t\t\t\"nvidia-container-cli.user = \\\"foo:bar\\\"\",\n\t\t\t\t\"nvidia-container-cli.cuda-compat-mode = \\\"mount\\\"\",\n\t\t\t\t\"nvidia-container-runtime.debug = \\\"/foo/bar\\\"\",\n\t\t\t\t\"nvidia-container-runtime.discover-mode = \\\"not-legacy\\\"\",\n\t\t\t\t\"nvidia-container-runtime.log-level = \\\"debug\\\"\",\n\t\t\t\t\"nvidia-container-runtime.runtimes = [\\\"/some/runtime\\\",]\",\n\t\t\t\t\"nvidia-container-runtime.mode = \\\"not-auto\\\"\",\n\t\t\t\t\"nvidia-container-runtime.modes.cdi.default-kind = \\\"example.vendor.com/device\\\"\",\n\t\t\t\t\"nvidia-container-runtime.modes.cdi.annotation-prefixes = [\\\"cdi.k8s.io/\\\", \\\"example.vendor.com/\\\",]\",\n\t\t\t\t\"nvidia-container-runtime.modes.cdi.spec-dirs = [\\\"/except/etc/cdi\\\", \\\"/not/var/run/cdi\\\",]\",\n\t\t\t\t\"nvidia-container-runtime.modes.csv.mount-spec-path = \\\"/not/etc/nvidia-container-runtime/host-files-for-container.d\\\"\",\n\t\t\t\t\"nvidia-container-runtime.modes.legacy.cuda-compat-mode = \\\"mount\\\"\",\n\t\t\t\t\"nvidia-container-runtime-hook.path = \\\"/foo/bar/nvidia-container-runtime-hook\\\"\",\n\t\t\t\t\"nvidia-ctk.path = \\\"/foo/bar/nvidia-ctk\\\"\",\n\t\t\t},\n\t\t\texpectedConfig: &Config{\n\t\t\t\tAcceptEnvvarUnprivileged: false,\n\t\t\t\tSupportedDriverCapabilities: \"compute,utility\",\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tRoot: \"/bar/baz\",\n\t\t\t\t\tLoadKmods: false,\n\t\t\t\t\tLdconfig: \"@/foo/bar/ldconfig\",\n\t\t\t\t\tUser: \"foo:bar\",\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeConfig: RuntimeConfig{\n\t\t\t\t\tDebugFilePath: \"/foo/bar\",\n\t\t\t\t\tLogLevel: \"debug\",\n\t\t\t\t\tRuntimes: []string{\"/some/runtime\"},\n\t\t\t\t\tMode: \"not-auto\",\n\t\t\t\t\tModes: modesConfig{\n\t\t\t\t\t\tCSV: csvModeConfig{\n\t\t\t\t\t\t\tMountSpecPath: \"/not/etc/nvidia-container-runtime/host-files-for-container.d\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tCDI: cdiModeConfig{\n\t\t\t\t\t\t\tDefaultKind: \"example.vendor.com/device\",\n\t\t\t\t\t\t\tAnnotationPrefixes: []string{\n\t\t\t\t\t\t\t\t\"cdi.k8s.io/\",\n\t\t\t\t\t\t\t\t\"example.vendor.com/\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tSpecDirs: []string{\n\t\t\t\t\t\t\t\t\"/except/etc/cdi\",\n\t\t\t\t\t\t\t\t\"/not/var/run/cdi\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tLegacy: legacyModeConfig{\n\t\t\t\t\t\t\tCUDACompatMode: \"mount\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{\n\t\t\t\t\tPath: \"/foo/bar/nvidia-container-runtime-hook\",\n\t\t\t\t},\n\t\t\t\tNVIDIACTKConfig: CTKConfig{\n\t\t\t\t\tPath: \"/foo/bar/nvidia-ctk\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"feature allows ldconfig to be overridden\",\n\t\t\tcontents: []string{\n\t\t\t\t\"[nvidia-container-cli]\",\n\t\t\t\t\"ldconfig = \\\"/foo/bar/ldconfig\\\"\",\n\t\t\t\t\"[features]\",\n\t\t\t\t\"allow-ldconfig-from-container = true\",\n\t\t\t},\n\t\t\texpectedConfig: &Config{\n\t\t\t\tAcceptEnvvarUnprivileged: true,\n\t\t\t\tSupportedDriverCapabilities: \"compat32,compute,display,graphics,ngx,utility,video\",\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tLdconfig: \"/foo/bar/ldconfig\",\n\t\t\t\t\tLoadKmods: true,\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeConfig: RuntimeConfig{\n\t\t\t\t\tDebugFilePath: \"/dev/null\",\n\t\t\t\t\tLogLevel: \"info\",\n\t\t\t\t\tRuntimes: []string{\"runc\", \"crun\"},\n\t\t\t\t\tMode: \"auto\",\n\t\t\t\t\tModes: modesConfig{\n\t\t\t\t\t\tCSV: csvModeConfig{\n\t\t\t\t\t\t\tMountSpecPath: \"/etc/nvidia-container-runtime/host-files-for-container.d\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tCDI: cdiModeConfig{\n\t\t\t\t\t\t\tDefaultKind: \"nvidia.com/gpu\",\n\t\t\t\t\t\t\tAnnotationPrefixes: []string{\n\t\t\t\t\t\t\t\t\"cdi.k8s.io/\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tSpecDirs: []string{\n\t\t\t\t\t\t\t\t\"/etc/cdi\",\n\t\t\t\t\t\t\t\t\"/var/run/cdi\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tLegacy: legacyModeConfig{\n\t\t\t\t\t\t\tCUDACompatMode: \"ldconfig\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{\n\t\t\t\t\tPath: \"nvidia-container-runtime-hook\",\n\t\t\t\t},\n\t\t\t\tNVIDIACTKConfig: CTKConfig{\n\t\t\t\t\tPath: \"nvidia-ctk\",\n\t\t\t\t},\n\t\t\t\tFeatures: features{\n\t\t\t\t\tAllowLDConfigFromContainer: to.Ptr(feature(true)),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"config options set in section\",\n\t\t\tcontents: []string{\n\t\t\t\t\"accept-nvidia-visible-devices-envvar-when-unprivileged = false\",\n\t\t\t\t\"supported-driver-capabilities = \\\"compute,utility\\\"\",\n\t\t\t\t\"[nvidia-container-cli]\",\n\t\t\t\t\"root = \\\"/bar/baz\\\"\",\n\t\t\t\t\"load-kmods = false\",\n\t\t\t\t\"ldconfig = \\\"@/foo/bar/ldconfig\\\"\",\n\t\t\t\t\"cuda-compat-mode = \\\"mount\\\"\",\n\t\t\t\t\"user = \\\"foo:bar\\\"\",\n\t\t\t\t\"[nvidia-container-runtime]\",\n\t\t\t\t\"debug = \\\"/foo/bar\\\"\",\n\t\t\t\t\"discover-mode = \\\"not-legacy\\\"\",\n\t\t\t\t\"log-level = \\\"debug\\\"\",\n\t\t\t\t\"runtimes = [\\\"/some/runtime\\\",]\",\n\t\t\t\t\"mode = \\\"not-auto\\\"\",\n\t\t\t\t\"[nvidia-container-runtime.modes.cdi]\",\n\t\t\t\t\"default-kind = \\\"example.vendor.com/device\\\"\",\n\t\t\t\t\"annotation-prefixes = [\\\"cdi.k8s.io/\\\", \\\"example.vendor.com/\\\",]\",\n\t\t\t\t\"spec-dirs = [\\\"/except/etc/cdi\\\", \\\"/not/var/run/cdi\\\",]\",\n\t\t\t\t\"[nvidia-container-runtime.modes.csv]\",\n\t\t\t\t\"mount-spec-path = \\\"/not/etc/nvidia-container-runtime/host-files-for-container.d\\\"\",\n\t\t\t\t\"[nvidia-container-runtime.modes.legacy]\",\n\t\t\t\t\"cuda-compat-mode = \\\"mount\\\"\",\n\t\t\t\t\"[nvidia-container-runtime-hook]\",\n\t\t\t\t\"path = \\\"/foo/bar/nvidia-container-runtime-hook\\\"\",\n\t\t\t\t\"[nvidia-ctk]\",\n\t\t\t\t\"path = \\\"/foo/bar/nvidia-ctk\\\"\",\n\t\t\t},\n\t\t\texpectedConfig: &Config{\n\t\t\t\tAcceptEnvvarUnprivileged: false,\n\t\t\t\tSupportedDriverCapabilities: \"compute,utility\",\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tRoot: \"/bar/baz\",\n\t\t\t\t\tLoadKmods: false,\n\t\t\t\t\tLdconfig: \"@/foo/bar/ldconfig\",\n\t\t\t\t\tUser: \"foo:bar\",\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeConfig: RuntimeConfig{\n\t\t\t\t\tDebugFilePath: \"/foo/bar\",\n\t\t\t\t\tLogLevel: \"debug\",\n\t\t\t\t\tRuntimes: []string{\"/some/runtime\"},\n\t\t\t\t\tMode: \"not-auto\",\n\t\t\t\t\tModes: modesConfig{\n\t\t\t\t\t\tCSV: csvModeConfig{\n\t\t\t\t\t\t\tMountSpecPath: \"/not/etc/nvidia-container-runtime/host-files-for-container.d\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tCDI: cdiModeConfig{\n\t\t\t\t\t\t\tDefaultKind: \"example.vendor.com/device\",\n\t\t\t\t\t\t\tAnnotationPrefixes: []string{\n\t\t\t\t\t\t\t\t\"cdi.k8s.io/\",\n\t\t\t\t\t\t\t\t\"example.vendor.com/\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tSpecDirs: []string{\n\t\t\t\t\t\t\t\t\"/except/etc/cdi\",\n\t\t\t\t\t\t\t\t\"/not/var/run/cdi\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tLegacy: legacyModeConfig{\n\t\t\t\t\t\t\tCUDACompatMode: \"mount\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{\n\t\t\t\t\tPath: \"/foo/bar/nvidia-container-runtime-hook\",\n\t\t\t\t},\n\t\t\t\tNVIDIACTKConfig: CTKConfig{\n\t\t\t\t\tPath: \"/foo/bar/nvidia-ctk\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"suse config\",\n\t\t\tdistIdsLike: []string{\"suse\", \"opensuse\"},\n\t\t\texpectedConfig: &Config{\n\t\t\t\tAcceptEnvvarUnprivileged: true,\n\t\t\t\tSupportedDriverCapabilities: \"compat32,compute,display,graphics,ngx,utility,video\",\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tRoot: \"\",\n\t\t\t\t\tLoadKmods: true,\n\t\t\t\t\tLdconfig: \"@/test/ld/config/path\",\n\t\t\t\t\tUser: \"root:video\",\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeConfig: RuntimeConfig{\n\t\t\t\t\tDebugFilePath: \"/dev/null\",\n\t\t\t\t\tLogLevel: \"info\",\n\t\t\t\t\tRuntimes: []string{\"runc\", \"crun\"},\n\t\t\t\t\tMode: \"auto\",\n\t\t\t\t\tModes: modesConfig{\n\t\t\t\t\t\tCSV: csvModeConfig{\n\t\t\t\t\t\t\tMountSpecPath: \"/etc/nvidia-container-runtime/host-files-for-container.d\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tCDI: cdiModeConfig{\n\t\t\t\t\t\t\tDefaultKind: \"nvidia.com/gpu\",\n\t\t\t\t\t\t\tAnnotationPrefixes: []string{\"cdi.k8s.io/\"},\n\t\t\t\t\t\t\tSpecDirs: []string{\"/etc/cdi\", \"/var/run/cdi\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tLegacy: legacyModeConfig{\n\t\t\t\t\t\t\tCUDACompatMode: \"ldconfig\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{\n\t\t\t\t\tPath: \"nvidia-container-runtime-hook\",\n\t\t\t\t},\n\t\t\t\tNVIDIACTKConfig: CTKConfig{\n\t\t\t\t\tPath: \"nvidia-ctk\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"suse config overrides user\",\n\t\t\tdistIdsLike: []string{\"suse\", \"opensuse\"},\n\t\t\tcontents: []string{\n\t\t\t\t\"nvidia-container-cli.user = \\\"foo:bar\\\"\",\n\t\t\t},\n\t\t\texpectedConfig: &Config{\n\t\t\t\tAcceptEnvvarUnprivileged: true,\n\t\t\t\tSupportedDriverCapabilities: \"compat32,compute,display,graphics,ngx,utility,video\",\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tRoot: \"\",\n\t\t\t\t\tLoadKmods: true,\n\t\t\t\t\tLdconfig: \"@/test/ld/config/path\",\n\t\t\t\t\tUser: \"foo:bar\",\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeConfig: RuntimeConfig{\n\t\t\t\t\tDebugFilePath: \"/dev/null\",\n\t\t\t\t\tLogLevel: \"info\",\n\t\t\t\t\tRuntimes: []string{\"runc\", \"crun\"},\n\t\t\t\t\tMode: \"auto\",\n\t\t\t\t\tModes: modesConfig{\n\t\t\t\t\t\tCSV: csvModeConfig{\n\t\t\t\t\t\t\tMountSpecPath: \"/etc/nvidia-container-runtime/host-files-for-container.d\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tCDI: cdiModeConfig{\n\t\t\t\t\t\t\tDefaultKind: \"nvidia.com/gpu\",\n\t\t\t\t\t\t\tAnnotationPrefixes: []string{\"cdi.k8s.io/\"},\n\t\t\t\t\t\t\tSpecDirs: []string{\"/etc/cdi\", \"/var/run/cdi\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tLegacy: legacyModeConfig{\n\t\t\t\t\t\t\tCUDACompatMode: \"ldconfig\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tNVIDIAContainerRuntimeHookConfig: RuntimeHookConfig{\n\t\t\t\t\tPath: \"nvidia-container-runtime-hook\",\n\t\t\t\t},\n\t\t\t\tNVIDIACTKConfig: CTKConfig{\n\t\t\t\t\tPath: \"nvidia-ctk\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdefer setGetLdConfigPathForTest()()\n\t\t\tdefer setGetDistIDLikeForTest(tc.distIdsLike)()\n\t\t\treader := strings.NewReader(strings.Join(tc.contents, \"\\n\"))\n\n\t\t\ttomlCfg, err := loadConfigTomlFrom(reader)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\t\t\tcfg, err := tomlCfg.Config()\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedConfig, cfg)\n\t\t})\n\t}\n}\n\nfunc TestAssertValid(t *testing.T) {\n\tdefer setGetLdConfigPathForTest()()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconfig *Config\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"default is valid\",\n\t\t\tconfig: func() *Config {\n\t\t\t\tconfig, _ := GetDefault()\n\t\t\t\treturn config\n\t\t\t}(),\n\t\t},\n\t\t{\n\t\t\tdescription: \"alternative host ldconfig path is valid\",\n\t\t\tconfig: &Config{\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tLdconfig: \"@/some/host/path\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-host path is invalid\",\n\t\t\tconfig: &Config{\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tLdconfig: \"/non/host/path\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: errInvalidConfig,\n\t\t},\n\t\t{\n\t\t\tdescription: \"feature flag allows non-host path\",\n\t\t\tconfig: &Config{\n\t\t\t\tNVIDIAContainerCLIConfig: ContainerCLIConfig{\n\t\t\t\t\tLdconfig: \"/non/host/path\",\n\t\t\t\t},\n\t\t\t\tFeatures: features{\n\t\t\t\t\tAllowLDConfigFromContainer: to.Ptr(feature(true)),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\trequire.ErrorIs(t, tc.config.assertValid(), tc.expectedError)\n\t\t})\n\t}\n}\n\n// setGetDistIDsLikeForTest overrides the distribution IDs that would normally be read from the /etc/os-release file.\nfunc setGetDistIDLikeForTest(ids []string) func() {\n\tif ids == nil {\n\t\treturn func() {}\n\t}\n\toriginal := getDistIDLike\n\n\tgetDistIDLike = func() []string {\n\t\treturn ids\n\t}\n\n\treturn func() {\n\t\tgetDistIDLike = original\n\t}\n}\n\nfunc setGetLdConfigPathForTest() func() {\n\tprevious := getLdConfigPath\n\tgetLdConfigPath = func() ldconfigPath {\n\t\treturn \"@/test/ld/config/path\"\n\t}\n\treturn func() {\n\t\tgetLdConfigPath = previous\n\t}\n}\n"
},
{
"path": "api/config/v1/features.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\n// features specifies a set of named features.\ntype features struct {\n\t// AllowCUDACompatLibsFromContainer allows CUDA compat libs from a container\n\t// to override certain driver library mounts from the host.\n\tAllowCUDACompatLibsFromContainer *feature `toml:\"allow-cuda-compat-libs-from-container,omitempty\"`\n\t// AllowLDConfigFromContainer allows non-host ldconfig paths to be used.\n\t// If this feature flag is not set to 'true' only host-rooted config paths\n\t// (i.e. paths starting with an '@' are considered valid)\n\tAllowLDConfigFromContainer *feature `toml:\"allow-ldconfig-from-container,omitempty\"`\n\t// AllowUnknownOCISpecFields allows the nvidia-container-runtime to ignore\n\t// unknown fields when loading the config (OCI spec) associated with a\n\t// container.\n\t// If this is enabled, these fields are silently dropped.\n\tAllowUnknownOCISpecFields *feature `toml:\"allow-unknown-oci-spec-fields,omitempty\"`\n\t// DisableCUDACompatLibHook, when enabled skips the injection of a specific\n\t// hook to process CUDA compatibility libraries.\n\t//\n\t// Note: Since this mechanism replaces the logic in the `nvidia-container-cli`,\n\t// toggling this feature has no effect if `allow-cuda-compat-libs-from-container` is enabled.\n\tDisableCUDACompatLibHook *feature `toml:\"disable-cuda-compat-lib-hook,omitempty\"`\n\t// DisableImexChannelCreation ensures that the implicit creation of\n\t// requested IMEX channels is skipped when invoking the nvidia-container-cli.\n\tDisableImexChannelCreation *feature `toml:\"disable-imex-channel-creation,omitempty\"`\n\t// IgnoreImexChannelRequests configures the NVIDIA Container Toolkit to\n\t// ignore IMEX channel requests through the NVIDIA_IMEX_CHANNELS envvar or\n\t// volume mounts.\n\t// This ensures that the NVIDIA Container Toolkit cannot be used to provide\n\t// access to an IMEX channel by simply specifying an environment variable,\n\t// possibly bypassing other checks by an orchestration system such as\n\t// kubernetes.\n\tIgnoreImexChannelRequests *feature `toml:\"ignore-imex-channel-requests,omitempty\"`\n\t// NoAdditionalGIDsForDeviceNodes disables the injection of additional GIDs\n\t// for a device node when the node is not readable and writeable by the user.\n\tNoAdditionalGIDsForDeviceNodes *feature `toml:\"no-additional-gids-for-device-nodes,omitempty\"`\n}\n\ntype feature bool\n\n// IsEnabled checks whether a feature is explicitly enabled.\nfunc (f *feature) IsEnabled() bool {\n\tif f != nil {\n\t\treturn bool(*f)\n\t}\n\treturn false\n}\n"
},
{
"path": "api/config/v1/hook.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\n// RuntimeHookConfig stores the config options for the NVIDIA Container Runtime\ntype RuntimeHookConfig struct {\n\t// Path specifies the path to the NVIDIA Container Runtime hook binary.\n\t// If an executable name is specified, this will be resolved in the path.\n\tPath string `toml:\"path\"`\n\t// SkipModeDetection disables the mode check for the runtime hook.\n\tSkipModeDetection bool `toml:\"skip-mode-detection\"`\n}\n"
},
{
"path": "api/config/v1/runtime.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport \"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi\"\n\n// RuntimeConfig stores the config options for the NVIDIA Container Runtime\ntype RuntimeConfig struct {\n\tDebugFilePath string `toml:\"debug\"`\n\t// LogLevel defines the logging level for the application\n\tLogLevel string `toml:\"log-level\"`\n\t// Runtimes defines the candidates for the low-level runtime\n\tRuntimes []string `toml:\"runtimes\"`\n\tMode string `toml:\"mode\"`\n\tModes modesConfig `toml:\"modes\"`\n}\n\n// modesConfig defines (optional) per-mode configs\ntype modesConfig struct {\n\tCSV csvModeConfig `toml:\"csv\"`\n\tCDI cdiModeConfig `toml:\"cdi\"`\n\tJitCDI jitCDIModeConfig `toml:\"jit-cdi,omitempty\"`\n\tLegacy legacyModeConfig `toml:\"legacy\"`\n}\n\ntype cdiModeConfig struct {\n\t// SpecDirs allows for the default spec dirs for CDI to be overridden\n\tSpecDirs []string `toml:\"spec-dirs\"`\n\t// DefaultKind sets the default kind to be used when constructing fully-qualified CDI device names\n\tDefaultKind string `toml:\"default-kind\"`\n\t// AnnotationPrefixes sets the allowed prefixes for CDI annotation-based device injection\n\tAnnotationPrefixes []string `toml:\"annotation-prefixes\"`\n}\n\ntype jitCDIModeConfig struct {\n\t// NVCDIFeatureFlags sets a list of nvcdi features explicitly.\n\tNVCDIFeatureFlags []nvcdi.FeatureFlag `toml:\"nvcdi-feature-flags,omitempty\"`\n}\n\ntype csvModeConfig struct {\n\tMountSpecPath string `toml:\"mount-spec-path\"`\n\t// CompatContainerRoot specifies the compat root used when the the standard\n\t// CUDA compat libraries should not be used.\n\tCompatContainerRoot string `toml:\"compat-container-root,omitempty\"`\n}\n\ntype legacyModeConfig struct {\n\t// CUDACompatMode sets the mode to be used to make CUDA Forward Compat\n\t// libraries discoverable in the container.\n\tCUDACompatMode cudaCompatMode `toml:\"cuda-compat-mode,omitempty\"`\n}\n\ntype cudaCompatMode string\n\nconst (\n\tdefaultCUDACompatMode = CUDACompatModeLdconfig\n\t// CUDACompatModeDisabled explicitly disables the handling of CUDA Forward\n\t// Compatibility in the NVIDIA Container Runtime and NVIDIA Container\n\t// Runtime Hook.\n\tCUDACompatModeDisabled = cudaCompatMode(\"disabled\")\n\t// CUDACompatModeHook uses a container lifecycle hook to implement CUDA\n\t// Forward Compatibility support. This requires the use of the NVIDIA\n\t// Container Runtime and is not compatible with use cases where only the\n\t// NVIDIA Container Runtime Hook is used (e.g. the Docker --gpus flag).\n\tCUDACompatModeHook = cudaCompatMode(\"hook\")\n\t// CUDACompatModeLdconfig adds the folders containing CUDA Forward Compat\n\t// libraries to the ldconfig command invoked from the NVIDIA Container\n\t// Runtime Hook.\n\tCUDACompatModeLdconfig = cudaCompatMode(\"ldconfig\")\n\t// CUDACompatModeMount mounts CUDA Forward Compat folders from the container\n\t// to the container when using the NVIDIA Container Runtime Hook.\n\tCUDACompatModeMount = cudaCompatMode(\"mount\")\n)\n"
},
{
"path": "api/config/v1/toml.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"regexp\"\n\n\t\"github.com/pelletier/go-toml\"\n)\n\n// Toml is a type for the TOML representation of a config.\ntype Toml struct {\n\ttree *toml.Tree\n\t// valuesSet allows us to trac expliclitly set values so that we can\n\t// properly uncomment defaults.\n\tvaluesSet map[string]bool\n}\n\nfunc TreeFromMap(m map[string]any) (*Toml, error) {\n\ttree, err := toml.TreeFromMap(m)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn fromTree(tree), nil\n}\n\nfunc fromTree(t *toml.Tree) *Toml {\n\treturn &Toml{tree: t, valuesSet: make(map[string]bool)}\n}\n\ntype options struct {\n\tconfigFile string\n\trequired bool\n}\n\n// Option is a functional option for loading TOML config files.\ntype Option func(*options)\n\n// WithConfigFile sets the config file option.\nfunc WithConfigFile(configFile string) Option {\n\treturn func(o *options) {\n\t\to.configFile = configFile\n\t}\n}\n\n// WithRequired sets the required option.\n// If this is set to true, a failure to open the specified file is treated as an error\nfunc WithRequired(required bool) Option {\n\treturn func(o *options) {\n\t\to.required = required\n\t}\n}\n\n// New creates a new toml tree based on the provided options\nfunc New(opts ...Option) (*Toml, error) {\n\to := &options{}\n\tfor _, opt := range opts {\n\t\topt(o)\n\t}\n\n\treturn o.loadConfigToml()\n}\n\nfunc (o options) loadConfigToml() (*Toml, error) {\n\tfilename := o.configFile\n\tif filename == \"\" {\n\t\treturn defaultToml()\n\t}\n\n\t_, err := os.Stat(filename)\n\tif os.IsNotExist(err) && o.required {\n\t\treturn nil, os.ErrNotExist\n\t}\n\n\ttomlFile, err := os.Open(filename)\n\tif os.IsNotExist(err) {\n\t\treturn defaultToml()\n\t} else if err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to load specified config file: %w\", err)\n\t}\n\tdefer tomlFile.Close()\n\n\treturn loadConfigTomlFrom(tomlFile)\n\n}\n\nfunc defaultToml() (*Toml, error) {\n\tcfg, err := GetDefault()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tcontents, err := toml.Marshal(cfg)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn loadConfigTomlFrom(bytes.NewReader(contents))\n}\n\nfunc loadConfigTomlFrom(reader io.Reader) (*Toml, error) {\n\ttree, err := toml.LoadReader(reader)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tt := &Toml{\n\t\ttree: tree,\n\t\tvaluesSet: make(map[string]bool),\n\t}\n\n\treturn t, nil\n}\n\n// Config returns the typed config associated with the toml tree.\nfunc (t *Toml) Config() (*Config, error) {\n\tcfg, err := t.configNoOverrides()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif err := cfg.assertValid(); err != nil {\n\t\treturn nil, err\n\t}\n\treturn cfg, nil\n}\n\n// configNoOverrides returns the typed config associated with the toml tree.\n// This config does not include feature-specific overrides.\nfunc (t *Toml) configNoOverrides() (*Config, error) {\n\tcfg, err := GetDefault()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif t == nil {\n\t\treturn cfg, nil\n\t}\n\tif err := t.Unmarshal(cfg); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal config: %v\", err)\n\t}\n\treturn cfg, nil\n}\n\n// Unmarshal wraps the toml.Tree Unmarshal function.\nfunc (t *Toml) Unmarshal(v interface{}) error {\n\treturn t.tree.Unmarshal(v)\n}\n\n// Save saves the config to the specified Writer.\nfunc (t *Toml) Save(w io.Writer) (int64, error) {\n\tcontents, err := t.contents()\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\n\tn, err := w.Write(contents)\n\treturn int64(n), err\n}\n\n// contents returns the config TOML as a byte slice.\n// Any required formatting is applied.\nfunc (t Toml) contents() ([]byte, error) {\n\tcommented := t.commentDefaults()\n\n\tbuffer := bytes.NewBuffer(nil)\n\n\tenc := toml.NewEncoder(buffer).Indentation(\"\")\n\tif err := enc.Encode(commented.tree); err != nil {\n\t\treturn nil, fmt.Errorf(\"invalid config: %v\", err)\n\t}\n\treturn t.format(buffer.Bytes())\n}\n\n// format fixes the comments for the config to ensure that they start in column\n// 1 and are not followed by a space.\nfunc (t Toml) format(contents []byte) ([]byte, error) {\n\tr := regexp.MustCompile(`(\\n*)\\s*?#\\s*(\\S.*)`)\n\treplaced := r.ReplaceAll(contents, []byte(\"$1#$2\"))\n\n\treturn replaced, nil\n}\n\n// Delete deletes the specified key from the TOML config.\nfunc (t *Toml) Delete(key string) error {\n\tdelete(t.valuesSet, key)\n\treturn t.tree.Delete(key)\n}\n\n// Get returns the value for the specified key.\nfunc (t *Toml) Get(key string) interface{} {\n\treturn t.tree.Get(key)\n}\n\n// GetDefault returns the value for the specified key and falls back to the default value if the Get call fails\nfunc (t *Toml) GetDefault(key string, def interface{}) interface{} {\n\treturn t.tree.GetDefault(key, def)\n}\n\n// Set sets the specified key to the specified value in the TOML config.\nfunc (t *Toml) Set(key string, value interface{}) {\n\tt.tree.Set(key, value)\n\tt.valuesSet[key] = true\n}\n\n// WriteTo encode the Tree as Toml and writes it to the writer w.\n// Returns the number of bytes written in case of success, or an error if anything happened.\nfunc (t *Toml) WriteTo(w io.Writer) (int64, error) {\n\treturn t.tree.WriteTo(w)\n}\n\n// commentDefaults applies the required comments for default values to the Toml.\nfunc (t *Toml) commentDefaults() *Toml {\n\tasToml := t.tree\n\tcommentedDefaults := map[string]interface{}{\n\t\t\"swarm-resource\": \"DOCKER_RESOURCE_GPU\",\n\t\t\"accept-nvidia-visible-devices-envvar-when-unprivileged\": true,\n\t\t\"accept-nvidia-visible-devices-as-volume-mounts\": false,\n\t\t\"nvidia-container-cli.root\": \"/run/nvidia/driver\",\n\t\t\"nvidia-container-cli.path\": \"/usr/bin/nvidia-container-cli\",\n\t\t\"nvidia-container-cli.debug\": \"/var/log/nvidia-container-toolkit.log\",\n\t\t\"nvidia-container-cli.ldcache\": \"/etc/ld.so.cache\",\n\t\t\"nvidia-container-cli.no-cgroups\": false,\n\t\t\"nvidia-container-cli.user\": \"root:video\",\n\t\t\"nvidia-container-runtime.debug\": \"/var/log/nvidia-container-runtime.log\",\n\t}\n\tfor k, v := range commentedDefaults {\n\t\t// If a value has been explicitly set, we don't check whether it should\n\t\t// be commented.\n\t\tif t.valuesSet[k] {\n\t\t\tcontinue\n\t\t}\n\t\tset := asToml.Get(k)\n\t\tif !shouldComment(k, v, set) {\n\t\t\tcontinue\n\t\t}\n\t\tasToml.SetWithComment(k, \"\", true, v)\n\t}\n\tt.tree = asToml\n\treturn t\n}\n\nfunc shouldComment(key string, defaultValue interface{}, setTo interface{}) bool {\n\tif key == \"nvidia-container-cli.user\" && defaultValue == setTo && isSuse() {\n\t\treturn false\n\t}\n\tif key == \"nvidia-container-runtime.debug\" && setTo == \"/dev/null\" {\n\t\treturn true\n\t}\n\tif setTo == nil || defaultValue == setTo || setTo == \"\" {\n\t\treturn true\n\t}\n\n\treturn false\n}\n"
},
{
"path": "api/config/v1/toml_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"bytes\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test/to\"\n)\n\nfunc TestTomlSave(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconfig *Toml\n\t\texpected string\n\t}{\n\t\t{\n\t\t\tdescription: \"defaultConfig\",\n\t\t\tconfig: func() *Toml {\n\t\t\t\tt, _ := defaultToml()\n\t\t\t\t// TODO: We handle the ldconfig path specifically, since this is platform\n\t\t\t\t// dependent.\n\t\t\t\tt.Set(\"nvidia-container-cli.ldconfig\", \"OVERRIDDEN\")\n\t\t\t\treturn t\n\t\t\t}(),\n\t\t\texpected: `\n#accept-nvidia-visible-devices-as-volume-mounts = false\n#accept-nvidia-visible-devices-envvar-when-unprivileged = true\ndisable-require = false\nsupported-driver-capabilities = \"compat32,compute,display,graphics,ngx,utility,video\"\n#swarm-resource = \"DOCKER_RESOURCE_GPU\"\n\n[nvidia-container-cli]\n#debug = \"/var/log/nvidia-container-toolkit.log\"\nenvironment = []\n#ldcache = \"/etc/ld.so.cache\"\nldconfig = \"OVERRIDDEN\"\nload-kmods = true\n#no-cgroups = false\n#path = \"/usr/bin/nvidia-container-cli\"\n#root = \"/run/nvidia/driver\"\n#user = \"root:video\"\n\n[nvidia-container-runtime]\n#debug = \"/var/log/nvidia-container-runtime.log\"\nlog-level = \"info\"\nmode = \"auto\"\nruntimes = [\"runc\", \"crun\"]\n\n[nvidia-container-runtime.modes]\n\n[nvidia-container-runtime.modes.cdi]\nannotation-prefixes = [\"cdi.k8s.io/\"]\ndefault-kind = \"nvidia.com/gpu\"\nspec-dirs = [\"/etc/cdi\", \"/var/run/cdi\"]\n\n[nvidia-container-runtime.modes.csv]\nmount-spec-path = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n\n[nvidia-container-runtime.modes.legacy]\ncuda-compat-mode = \"ldconfig\"\n\n[nvidia-container-runtime-hook]\npath = \"nvidia-container-runtime-hook\"\nskip-mode-detection = false\n\n[nvidia-ctk]\npath = \"nvidia-ctk\"\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"set debug to default uncomments\",\n\t\t\tconfig: func() *Toml {\n\t\t\t\tt, _ := defaultToml()\n\t\t\t\t// TODO: We handle the ldconfig path specifically, since this is platform\n\t\t\t\t// dependent.\n\t\t\t\tt.Set(\"nvidia-container-cli.ldconfig\", \"OVERRIDDEN\")\n\t\t\t\tt.Set(\"nvidia-container-cli.debug\", \"/var/log/nvidia-container-toolkit.log\")\n\t\t\t\tt.Set(\"nvidia-container-runtime.debug\", \"/var/log/nvidia-container-runtime.log\")\n\t\t\t\treturn t\n\t\t\t}(),\n\t\t\texpected: `\n#accept-nvidia-visible-devices-as-volume-mounts = false\n#accept-nvidia-visible-devices-envvar-when-unprivileged = true\ndisable-require = false\nsupported-driver-capabilities = \"compat32,compute,display,graphics,ngx,utility,video\"\n#swarm-resource = \"DOCKER_RESOURCE_GPU\"\n\n[nvidia-container-cli]\ndebug = \"/var/log/nvidia-container-toolkit.log\"\nenvironment = []\n#ldcache = \"/etc/ld.so.cache\"\nldconfig = \"OVERRIDDEN\"\nload-kmods = true\n#no-cgroups = false\n#path = \"/usr/bin/nvidia-container-cli\"\n#root = \"/run/nvidia/driver\"\n#user = \"root:video\"\n\n[nvidia-container-runtime]\ndebug = \"/var/log/nvidia-container-runtime.log\"\nlog-level = \"info\"\nmode = \"auto\"\nruntimes = [\"runc\", \"crun\"]\n\n[nvidia-container-runtime.modes]\n\n[nvidia-container-runtime.modes.cdi]\nannotation-prefixes = [\"cdi.k8s.io/\"]\ndefault-kind = \"nvidia.com/gpu\"\nspec-dirs = [\"/etc/cdi\", \"/var/run/cdi\"]\n\n[nvidia-container-runtime.modes.csv]\nmount-spec-path = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n\n[nvidia-container-runtime.modes.legacy]\ncuda-compat-mode = \"ldconfig\"\n\n[nvidia-container-runtime-hook]\npath = \"nvidia-container-runtime-hook\"\nskip-mode-detection = false\n\n[nvidia-ctk]\npath = \"nvidia-ctk\"\n`,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tbuffer := new(bytes.Buffer)\n\t\t\t_, err := tc.config.Save(buffer)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t,\n\t\t\t\tstrings.TrimSpace(tc.expected),\n\t\t\t\tstrings.TrimSpace(buffer.String()),\n\t\t\t)\n\t\t})\n\t}\n}\n\nfunc TestFormat(t *testing.T) {\n\ttestCases := []struct {\n\t\tinput string\n\t\texpected string\n\t}{\n\t\t{\n\t\t\tinput: \"# comment\",\n\t\t\texpected: \"#comment\",\n\t\t},\n\t\t{\n\t\t\tinput: \" #comment\",\n\t\t\texpected: \"#comment\",\n\t\t},\n\t\t{\n\t\t\tinput: \" # comment\",\n\t\t\texpected: \"#comment\",\n\t\t},\n\t\t{\n\t\t\tinput: strings.Join([]string{\n\t\t\t\t\"some\",\n\t\t\t\t\"# comment\",\n\t\t\t\t\" # comment\",\n\t\t\t\t\" #comment\",\n\t\t\t\t\"other\"}, \"\\n\"),\n\t\t\texpected: strings.Join([]string{\n\t\t\t\t\"some\",\n\t\t\t\t\"#comment\",\n\t\t\t\t\"#comment\",\n\t\t\t\t\"#comment\",\n\t\t\t\t\"other\"}, \"\\n\"),\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.input, func(t *testing.T) {\n\t\t\tactual, _ := (Toml{}).format([]byte(tc.input))\n\t\t\trequire.Equal(t, tc.expected, string(actual))\n\t\t})\n\t}\n}\n\nfunc TestGetFormattedConfig(t *testing.T) {\n\texpectedLines := []string{\n\t\t\"#no-cgroups = false\",\n\t\t\"#debug = \\\"/var/log/nvidia-container-toolkit.log\\\"\",\n\t\t\"#debug = \\\"/var/log/nvidia-container-runtime.log\\\"\",\n\t}\n\n\tcontents, err := createEmpty().contents()\n\trequire.NoError(t, err)\n\tlines := strings.Split(string(contents), \"\\n\")\n\n\tfor _, line := range expectedLines {\n\t\trequire.Contains(t, lines, line)\n\t}\n}\n\nfunc TestTomlContents(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcontents map[string]interface{}\n\t\texpected string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty config returns commented defaults\",\n\t\t\texpected: `\n#accept-nvidia-visible-devices-as-volume-mounts = false\n#accept-nvidia-visible-devices-envvar-when-unprivileged = true\n#swarm-resource = \"DOCKER_RESOURCE_GPU\"\n\n[nvidia-container-cli]\n#debug = \"/var/log/nvidia-container-toolkit.log\"\n#ldcache = \"/etc/ld.so.cache\"\n#no-cgroups = false\n#path = \"/usr/bin/nvidia-container-cli\"\n#root = \"/run/nvidia/driver\"\n#user = \"root:video\"\n\n[nvidia-container-runtime]\n#debug = \"/var/log/nvidia-container-runtime.log\"`,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tcfg, err := TreeFromMap(tc.contents)\n\t\t\trequire.NoError(t, err)\n\t\t\tcontents, err := cfg.contents()\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t,\n\t\t\t\tstrings.TrimSpace(tc.expected),\n\t\t\t\tstrings.TrimSpace(string(contents)),\n\t\t\t)\n\t\t})\n\t}\n}\n\nfunc TestConfigFromToml(t *testing.T) {\n\tdefer setGetLdConfigPathForTest()()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcontents map[string]interface{}\n\t\texpectedError error\n\t\texpectedConfig *Config\n\t}{\n\t\t{\n\t\t\tdescription: \"empty config returns default config\",\n\t\t\tcontents: nil,\n\t\t\texpectedConfig: func() *Config {\n\t\t\t\tc, _ := GetDefault()\n\t\t\t\treturn c\n\t\t\t}(),\n\t\t},\n\t\t{\n\t\t\tdescription: \"contents overrides default\",\n\t\t\tcontents: map[string]interface{}{\n\t\t\t\t\"nvidia-container-runtime\": map[string]interface{}{\n\t\t\t\t\t\"debug\": \"/some/log/file.log\",\n\t\t\t\t\t\"mode\": \"csv\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: func() *Config {\n\t\t\t\tc, _ := GetDefault()\n\t\t\t\tc.NVIDIAContainerRuntimeConfig.DebugFilePath = \"/some/log/file.log\"\n\t\t\t\tc.NVIDIAContainerRuntimeConfig.Mode = \"csv\"\n\t\t\t\treturn c\n\t\t\t}(),\n\t\t},\n\t\t{\n\t\t\tdescription: \"invalid ldconfig value raises error\",\n\t\t\tcontents: map[string]interface{}{\n\t\t\t\t\"nvidia-container-cli\": map[string]interface{}{\n\t\t\t\t\t\"ldconfig\": \"/some/ldconfig/path\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: errInvalidConfig,\n\t\t},\n\t\t{\n\t\t\tdescription: \"feature allows ldconfig override\",\n\t\t\tcontents: map[string]interface{}{\n\t\t\t\t\"nvidia-container-cli\": map[string]interface{}{\n\t\t\t\t\t\"ldconfig\": \"/some/ldconfig/path\",\n\t\t\t\t},\n\t\t\t\t\"features\": map[string]interface{}{\n\t\t\t\t\t\"allow-ldconfig-from-container\": true,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: func() *Config {\n\t\t\t\tc, _ := GetDefault()\n\t\t\t\tc.NVIDIAContainerCLIConfig.Ldconfig = \"/some/ldconfig/path\"\n\t\t\t\tc.Features.AllowLDConfigFromContainer = to.Ptr(feature(true))\n\t\t\t\treturn c\n\t\t\t}(),\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttomlCfg, _ := TreeFromMap(tc.contents)\n\t\t\tconfig, err := tomlCfg.Config()\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\trequire.EqualValues(t, tc.expectedConfig, config)\n\t\t})\n\t}\n}\n\nfunc createEmpty() *Toml {\n\tt, _ := TreeFromMap(nil)\n\treturn t\n}\n"
},
{
"path": "api/config/v1/toolkit-cli.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\n// CTKConfig stores the config options for the NVIDIA Container Toolkit CLI (nvidia-ctk)\ntype CTKConfig struct {\n\tPath string `toml:\"path\"`\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/README.md",
"content": "# NVIDIA CDI Hook\n\nThe CLI `nvidia-cdi-hook` provides container device runtime hook capabilities when\ncalled by a container runtime, as specific in a\n[Container Device Interface](https://tags.cncf.io/container-device-interface/blob/main/SPEC.md)\nfile.\n\n## Generating a CDI\n\nThe CDI itself is created for an NVIDIA-capable device using the\n[`nvidia-ctk cdi generate`](../nvidia-ctk/) command.\n\nWhen `nvidia-ctk cdi generate` is run, the CDI specification is generated as a yaml file.\nThe CDI specification provides instructions for a container runtime to set up devices, files and\nother resources for the container prior to starting it. Those instructions\nmay include executing command-line tools to prepare the filesystem. The execution\nof such command-line tools is called a hook.\n\n`nvidia-cdi-hook` is the CLI tool that is expected to be called by the container runtime,\nwhen specified by the CDI file.\n\nSee the [`nvidia-ctk` documentation](../nvidia-ctk/README.md) for more information\non generating a CDI file.\n\n## Functionality\n\nThe `nvidia-cdi-hook` CLI provides the following functionality:\n\n* `chmod` - Change the permissions of a file or directory inside the directory path to be mounted into a container.\n* `create-symlinks` - Create symlinks inside the directory path to be mounted into a container.\n* `update-ldcache` - Update the dynamic linker cache inside the directory path to be mounted into a container.\n"
},
{
"path": "cmd/nvidia-cdi-hook/chmod/chmod.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage chmod\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io/fs\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\ntype config struct {\n\tpaths []string\n\tmodeStr string\n\tmode fs.FileMode\n\tcontainerSpec string\n}\n\n// NewCommand constructs a chmod command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build the chmod command\nfunc (m command) build() *cli.Command {\n\tcfg := config{}\n\n\t// Create the 'chmod' command\n\tc := cli.Command{\n\t\tName: \"chmod\",\n\t\tUsage: \"Set the permissions of folders in the container by running chmod. The container root is prefixed to the specified paths.\",\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(cmd, &cfg)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(cmd, &cfg)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"path\",\n\t\t\t\tUsage: \"Specify a path to apply the specified mode to\",\n\t\t\t\tDestination: &cfg.paths,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"mode\",\n\t\t\t\tUsage: \"Specify the file mode\",\n\t\t\t\tDestination: &cfg.modeStr,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"container-spec\",\n\t\t\t\tUsage: \"Specify the path to the OCI container spec. If empty or '-' the spec will be read from STDIN\",\n\t\t\t\tDestination: &cfg.containerSpec,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(_ *cli.Command, cfg *config) error {\n\tif strings.TrimSpace(cfg.modeStr) == \"\" {\n\t\treturn fmt.Errorf(\"a non-empty mode must be specified\")\n\t}\n\n\tmodeInt, err := strconv.ParseUint(cfg.modeStr, 8, 32)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to parse mode as octal: %v\", err)\n\t}\n\tcfg.mode = fs.FileMode(modeInt)\n\n\tfor _, p := range cfg.paths {\n\t\tif strings.TrimSpace(p) == \"\" {\n\t\t\treturn fmt.Errorf(\"paths must not be empty\")\n\t\t}\n\t}\n\n\treturn nil\n}\n\nfunc (m command) run(_ *cli.Command, cfg *config) error {\n\ts, err := oci.LoadContainerState(cfg.containerSpec)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to load container state: %v\", err)\n\t}\n\n\tcontainerRoot, err := s.GetContainerRoot()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to determined container root: %v\", err)\n\t}\n\tif containerRoot == \"\" {\n\t\treturn fmt.Errorf(\"empty container root detected\")\n\t}\n\n\tpaths := m.getPaths(containerRoot, cfg.paths, cfg.mode)\n\tif len(paths) == 0 {\n\t\tm.logger.Debugf(\"No paths specified; exiting\")\n\t\treturn nil\n\t}\n\n\tfor _, path := range paths {\n\t\terr = os.Chmod(path, cfg.mode)\n\t\t// in some cases this is not an issue (e.g. whole /dev mounted), see #143\n\t\tif errors.Is(err, fs.ErrPermission) {\n\t\t\tm.logger.Debugf(\"Ignoring permission error with chmod: %v\", err)\n\t\t\terr = nil\n\t\t}\n\t}\n\n\treturn err\n}\n\n// getPaths updates the specified paths relative to the root.\nfunc (m command) getPaths(root string, paths []string, desiredMode fs.FileMode) []string {\n\tvar pathsInRoot []string\n\tfor _, f := range paths {\n\t\tpath := filepath.Join(root, f)\n\t\tstat, err := os.Stat(path)\n\t\tif err != nil {\n\t\t\tm.logger.Debugf(\"Skipping path %q: %v\", path, err)\n\t\t\tcontinue\n\t\t}\n\t\tif (stat.Mode()&(fs.ModePerm|fs.ModeSetuid|fs.ModeSetgid|fs.ModeSticky))^desiredMode == 0 {\n\t\t\tm.logger.Debugf(\"Skipping path %q: already desired mode\", path)\n\t\t\tcontinue\n\t\t}\n\t\tpathsInRoot = append(pathsInRoot, path)\n\t}\n\n\treturn pathsInRoot\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/commands/commands.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage commands\n\nimport (\n\t\"context\"\n\t\"strings\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/chmod\"\n\tsymlinks \"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/create-symlinks\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/cudacompat\"\n\tdisabledevicenodemodification \"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/disable-device-node-modification\"\n\tldcache \"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/update-ldcache\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// ConfigureCDIHookCommand configures a base command with supported CDI hooks\n// and error handling for unsupported hooks.\n// This allows the same command to be used for the nvidia-cdi-hook and\n// nvidia-ctk hook commands.\nfunc ConfigureCDIHookCommand(logger logger.Interface, base *cli.Command) *cli.Command {\n\t// We set the default action for the command to issue a warning and exit\n\t// with no error.\n\t// This means that if an unsupported hook is run, a container will not fail\n\t// to launch. An unsupported hook could be the result of a CDI specification\n\t// referring to a new hook that is not yet supported by an older NVIDIA\n\t// Container Toolkit version or a hook that has been removed in newer\n\t// version.\n\tbase.Action = func(ctx context.Context, cmd *cli.Command) error {\n\t\treturn issueUnsupportedHookWarning(logger, cmd)\n\t}\n\t// CommandNotFound is triggered when an unrecognised (sub)command is detected.\n\t// We assume that an unrecognised (sub)command represents an unsupported hook\n\t// (usually a hook that was added or removed)\n\tbase.CommandNotFound = func(ctx context.Context, cmd *cli.Command, commandName string) {\n\t\t_ = issueUnsupportedHookWarning(logger, cmd)\n\t}\n\t// OnUsageError is triggered when an unexpected flag is detected.\n\t// We check the invoked command to determine whether it is an expected\n\t// hook, and assume that this is an unsupported hook otherwise.\n\tbase.OnUsageError = func(ctx context.Context, cmd *cli.Command, err error, isSubcommand bool) error {\n\t\t// If this is not an error that comes from parsing an unrecognised flag,\n\t\t// return it as is.\n\t\tif !strings.HasPrefix(err.Error(), \"flag provided but not defined: -\") {\n\t\t\treturn err\n\t\t}\n\n\t\t// If the first argument is a recognised command, we return the error as\n\t\t// is since it represents an incorrect argument to the specific hook.\n\t\tvar subcommandName string\n\t\tfor _, arg := range cmd.Args().Slice() {\n\t\t\tif strings.HasPrefix(arg, \"-\") {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tsubcommandName = arg\n\t\t\tbreak\n\t\t}\n\t\t// If a subcommand is detected and is a recognised subcommand, we return\n\t\t// the error as is.\n\t\tif subcommandName != \"\" && cmd.Command(subcommandName) != nil {\n\t\t\treturn err\n\t\t}\n\n\t\t// At this point either no args have been supplied or the (sub)command\n\t\t// (first arg) is not regognised.\n\t\t// We issue a warning and returun nil.\n\t\treturn issueUnsupportedHookWarning(logger, cmd)\n\t}\n\n\t// Define the supported hooks.\n\tbase.Commands = []*cli.Command{\n\t\tldcache.NewCommand(logger),\n\t\tsymlinks.NewCommand(logger),\n\t\tchmod.NewCommand(logger),\n\t\tcudacompat.NewCommand(logger),\n\t\tdisabledevicenodemodification.NewCommand(logger),\n\t\t{\n\t\t\tName: \"noop\",\n\t\t\tUsage: \"The noop hook performs no actions and is only added to facilitate basic testing of the CLI\",\n\t\t\tHidden: true,\n\t\t\tAction: func(_ context.Context, _ *cli.Command) error {\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t}\n\n\treturn base\n}\n\n// issueUnsupportedHookWarning logs a warning that no hook or an unsupported\n// hook has been specified.\n// This happens if a subcommand is provided that does not match one of the\n// subcommands that has been explicitly specified.\nfunc issueUnsupportedHookWarning(logger logger.Interface, c *cli.Command) error {\n\targs := c.Args().Slice()\n\tif len(args) == 0 {\n\t\tlogger.Warningf(\"No CDI hook specified\")\n\t} else {\n\t\tlogger.Warningf(\"Unsupported CDI hook: %v\", args[0])\n\t}\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/create-symlinks/create-symlinks.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage symlinks\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/moby/sys/symlink\"\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup/symlinks\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\ntype config struct {\n\tlinks []string\n\tcontainerSpec string\n}\n\n// NewCommand constructs a hook command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build creates the create-symlink command.\nfunc (m command) build() *cli.Command {\n\tcfg := config{}\n\n\tc := cli.Command{\n\t\tName: \"create-symlinks\",\n\t\tUsage: \"A hook to create symlinks in the container.\",\n\t\tAction: func(_ context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(cmd, &cfg)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"link\",\n\t\t\t\tUsage: \"Specify a specific link to create. The link is specified as target::link. If the link exists in the container root, it is removed.\",\n\t\t\t\tDestination: &cfg.links,\n\t\t\t},\n\t\t\t// The following flags are testing-only flags.\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"container-spec\",\n\t\t\t\tUsage: \"Specify the path to the OCI container spec. If empty or '-' the spec will be read from STDIN. This is only intended for testing.\",\n\t\t\t\tDestination: &cfg.containerSpec,\n\t\t\t\tHidden: true,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) run(_ *cli.Command, cfg *config) error {\n\ts, err := oci.LoadContainerState(cfg.containerSpec)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to load container state: %v\", err)\n\t}\n\n\tcontainerRoot, err := s.GetContainerRoot()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to determined container root: %v\", err)\n\t}\n\n\tcreated := make(map[string]bool)\n\tfor _, l := range cfg.links {\n\t\tif created[l] {\n\t\t\tm.logger.Debugf(\"Link %v already processed\", l)\n\t\t\tcontinue\n\t\t}\n\t\tparts := strings.Split(l, \"::\")\n\t\tif len(parts) != 2 {\n\t\t\treturn fmt.Errorf(\"invalid symlink specification %v\", l)\n\t\t}\n\n\t\terr := m.createLink(containerRoot, parts[0], parts[1])\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to create link %v: %w\", parts, err)\n\t\t}\n\t\tcreated[l] = true\n\t}\n\treturn nil\n}\n\n// createLink creates a symbolic link in the specified container root.\n// This is equivalent to:\n//\n//\tchroot {{ .containerRoot }} ln -f -s {{ .target }} {{ .link }}\n//\n// If the specified link already exists and points to the same target, this\n// operation is a no-op.\n// If a file exists at the link path or the link points to a different target\n// this file is removed before creating the link.\n//\n// Note that if the link path resolves to an absolute path oudside of the\n// specified root, this is treated as an absolute path in this root.\nfunc (m command) createLink(containerRoot string, targetPath string, link string) error {\n\tlinkPath := filepath.Join(containerRoot, link)\n\n\texists, err := linkExists(targetPath, linkPath)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to check if link exists: %w\", err)\n\t}\n\tif exists {\n\t\tm.logger.Debugf(\"Link %s already exists\", linkPath)\n\t\treturn nil\n\t}\n\n\t// We resolve the parent of the symlink that we're creating in the container root.\n\t// If we resolve the full link path, an existing link at the location itself\n\t// is also resolved here and we are unable to force create the link.\n\tresolvedLinkParent, err := symlink.FollowSymlinkInScope(filepath.Dir(linkPath), containerRoot)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to follow path for link %v relative to %v: %w\", link, containerRoot, err)\n\t}\n\tresolvedLinkPath := filepath.Join(resolvedLinkParent, filepath.Base(linkPath))\n\n\tm.logger.Infof(\"Symlinking %v to %v\", resolvedLinkPath, targetPath)\n\terr = os.MkdirAll(filepath.Dir(resolvedLinkPath), 0755)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create directory: %v\", err)\n\t}\n\terr = symlinks.ForceCreate(targetPath, resolvedLinkPath)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create symlink: %v\", err)\n\t}\n\n\treturn nil\n}\n\n// linkExists checks whether the specified link exists.\n// A link exists if the path exists, is a symlink, and points to the specified target.\nfunc linkExists(target string, link string) (bool, error) {\n\tcurrentTarget, err := symlinks.Resolve(link)\n\tif errors.Is(err, os.ErrNotExist) {\n\t\treturn false, nil\n\t}\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"failed to resolve existing symlink %s: %w\", link, err)\n\t}\n\tif currentTarget == target {\n\t\treturn true, nil\n\t}\n\treturn false, nil\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/create-symlinks/create-symlinks_test.go",
"content": "package symlinks\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup/symlinks\"\n)\n\nfunc TestLinkExist(t *testing.T) {\n\ttmpDir := t.TempDir()\n\trequire.NoError(\n\t\tt,\n\t\tmakeFs(tmpDir,\n\t\t\tdirOrLink{path: \"/a/b/c\", target: \"d\"},\n\t\t\tdirOrLink{path: \"/a/b/e\", target: \"/a/b/f\"},\n\t\t),\n\t)\n\n\texists, err := linkExists(\"d\", filepath.Join(tmpDir, \"/a/b/c\"))\n\trequire.NoError(t, err)\n\trequire.True(t, exists)\n\n\texists, err = linkExists(\"/a/b/f\", filepath.Join(tmpDir, \"/a/b/e\"))\n\trequire.NoError(t, err)\n\trequire.True(t, exists)\n\n\texists, err = linkExists(\"different-target\", filepath.Join(tmpDir, \"/a/b/c\"))\n\trequire.NoError(t, err)\n\trequire.False(t, exists)\n\n\texists, err = linkExists(\"/a/b/d\", filepath.Join(tmpDir, \"/a/b/c\"))\n\trequire.NoError(t, err)\n\trequire.False(t, exists)\n\n\texists, err = linkExists(\"foo\", filepath.Join(tmpDir, \"/a/b/does-not-exist\"))\n\trequire.NoError(t, err)\n\trequire.False(t, exists)\n}\n\nfunc TestCreateLink(t *testing.T) {\n\ttype link struct {\n\t\tpath string\n\t\ttarget string\n\t}\n\ttype expectedLink struct {\n\t\tlink\n\t\terr error\n\t}\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcontainerContents []dirOrLink\n\t\tlink link\n\t\texpectedCreateError error\n\t\texpectedLinks []expectedLink\n\t}{\n\t\t{\n\t\t\tdescription: \"link to / resolves to container root\",\n\t\t\tcontainerContents: []dirOrLink{\n\t\t\t\t{path: \"/lib/foo\", target: \"/\"},\n\t\t\t},\n\t\t\tlink: link{\n\t\t\t\tpath: \"/lib/foo/libfoo.so\",\n\t\t\t\ttarget: \"libfoo.so.1\",\n\t\t\t},\n\t\t\texpectedLinks: []expectedLink{\n\t\t\t\t{\n\t\t\t\t\tlink: link{\n\t\t\t\t\t\tpath: \"{{ .containerRoot }}/libfoo.so\",\n\t\t\t\t\t\ttarget: \"libfoo.so.1\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"link to / resolves to container root; parent relative link\",\n\t\t\tcontainerContents: []dirOrLink{\n\t\t\t\t{path: \"/lib/foo\", target: \"/\"},\n\t\t\t},\n\t\t\tlink: link{\n\t\t\t\tpath: \"/lib/foo/libfoo.so\",\n\t\t\t\ttarget: \"../libfoo.so.1\",\n\t\t\t},\n\t\t\texpectedLinks: []expectedLink{\n\t\t\t\t{\n\t\t\t\t\tlink: link{\n\t\t\t\t\t\tpath: \"{{ .containerRoot }}/libfoo.so\",\n\t\t\t\t\t\ttarget: \"../libfoo.so.1\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"link to / resolves to container root; absolute link\",\n\t\t\tcontainerContents: []dirOrLink{\n\t\t\t\t{path: \"/lib/foo\", target: \"/\"},\n\t\t\t},\n\t\t\tlink: link{\n\t\t\t\tpath: \"/lib/foo/libfoo.so\",\n\t\t\t\ttarget: \"/a-path-in-container/foo/libfoo.so.1\",\n\t\t\t},\n\t\t\texpectedLinks: []expectedLink{\n\t\t\t\t{\n\t\t\t\t\tlink: link{\n\t\t\t\t\t\tpath: \"{{ .containerRoot }}/libfoo.so\",\n\t\t\t\t\t\ttarget: \"/a-path-in-container/foo/libfoo.so.1\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t// We also check that the target is NOT created.\n\t\t\t\t\tlink: link{\n\t\t\t\t\t\tpath: \"{{ .containerRoot }}/a-path-in-container/foo/libfoo.so.1\",\n\t\t\t\t\t},\n\t\t\t\t\terr: os.ErrNotExist,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttmpDir := t.TempDir()\n\t\t\thostRoot := filepath.Join(tmpDir, \"/host-root/\")\n\t\t\tcontainerRoot := filepath.Join(tmpDir, \"/container-root\")\n\n\t\t\trequire.NoError(t, makeFs(hostRoot))\n\t\t\trequire.NoError(t, makeFs(containerRoot, tc.containerContents...))\n\n\t\t\t// nvidia-cdi-hook create-symlinks --link linkSpec\n\t\t\terr := getTestCommand().createLink(containerRoot, tc.link.target, tc.link.path)\n\t\t\t// TODO: We may be able to replace this with require.ErrorIs.\n\t\t\tif tc.expectedCreateError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\tfor _, expectedLink := range tc.expectedLinks {\n\t\t\t\tpath := strings.ReplaceAll(expectedLink.path, \"{{ .containerRoot }}\", containerRoot)\n\t\t\t\tpath = strings.ReplaceAll(path, \"{{ .hostRoot }}\", hostRoot)\n\t\t\t\tif expectedLink.target != \"\" {\n\t\t\t\t\ttarget, err := symlinks.Resolve(path)\n\t\t\t\t\trequire.ErrorIs(t, err, expectedLink.err)\n\t\t\t\t\trequire.Equal(t, expectedLink.target, target)\n\t\t\t\t} else {\n\t\t\t\t\t_, err := os.Stat(path)\n\t\t\t\t\trequire.ErrorIs(t, err, expectedLink.err)\n\t\t\t\t}\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestCreateLinkRelativePath(t *testing.T) {\n\ttmpDir := t.TempDir()\n\thostRoot := filepath.Join(tmpDir, \"/host-root/\")\n\tcontainerRoot := filepath.Join(tmpDir, \"/container-root\")\n\n\trequire.NoError(t, makeFs(hostRoot))\n\trequire.NoError(t, makeFs(containerRoot, dirOrLink{path: \"/lib/\"}))\n\n\t// nvidia-cdi-hook create-symlinks --link libfoo.so.1::/lib/libfoo.so\n\terr := getTestCommand().createLink(containerRoot, \"libfoo.so.1\", \"/lib/libfoo.so\")\n\trequire.NoError(t, err)\n\n\ttarget, err := symlinks.Resolve(filepath.Join(containerRoot, \"/lib/libfoo.so\"))\n\trequire.NoError(t, err)\n\trequire.Equal(t, \"libfoo.so.1\", target)\n}\n\nfunc TestCreateLinkAbsolutePath(t *testing.T) {\n\ttmpDir := t.TempDir()\n\thostRoot := filepath.Join(tmpDir, \"/host-root/\")\n\tcontainerRoot := filepath.Join(tmpDir, \"/container-root\")\n\n\trequire.NoError(t, makeFs(hostRoot))\n\trequire.NoError(t, makeFs(containerRoot, dirOrLink{path: \"/lib/\"}))\n\n\t// nvidia-cdi-hook create-symlinks --link /lib/libfoo.so.1::/lib/libfoo.so\n\terr := getTestCommand().createLink(containerRoot, \"/lib/libfoo.so.1\", \"/lib/libfoo.so\")\n\trequire.NoError(t, err)\n\n\ttarget, err := symlinks.Resolve(filepath.Join(containerRoot, \"/lib/libfoo.so\"))\n\trequire.NoError(t, err)\n\trequire.Equal(t, \"/lib/libfoo.so.1\", target)\n}\n\nfunc TestCreateLinkAlreadyExists(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcontainerContents []dirOrLink\n\t\tshouldExist []string\n\t}{\n\t\t{\n\t\t\tdescription: \"link already exists with correct target\",\n\t\t\tcontainerContents: []dirOrLink{{path: \"/lib/libfoo.so\", target: \"libfoo.so.1\"}},\n\t\t\tshouldExist: []string{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"link already exists with different target\",\n\t\t\tcontainerContents: []dirOrLink{{path: \"/lib/libfoo.so\", target: \"different-target\"}, {path: \"different-target\"}},\n\t\t\tshouldExist: []string{\"{{ .containerRoot }}/different-target\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttmpDir := t.TempDir()\n\t\t\thostRoot := filepath.Join(tmpDir, \"/host-root/\")\n\t\t\tcontainerRoot := filepath.Join(tmpDir, \"/container-root\")\n\t\t\trequire.NoError(t, makeFs(hostRoot))\n\t\t\trequire.NoError(t, makeFs(containerRoot, tc.containerContents...))\n\n\t\t\t// nvidia-cdi-hook create-symlinks --link libfoo.so.1::/lib/libfoo.so\n\t\t\terr := getTestCommand().createLink(containerRoot, \"libfoo.so.1\", \"/lib/libfoo.so\")\n\t\t\trequire.NoError(t, err)\n\t\t\ttarget, err := symlinks.Resolve(filepath.Join(containerRoot, \"lib/libfoo.so\"))\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, \"libfoo.so.1\", target)\n\n\t\t\tfor _, p := range tc.shouldExist {\n\t\t\t\trequire.DirExists(t, strings.ReplaceAll(p, \"{{ .containerRoot }}\", containerRoot))\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestCreateLinkOutOfBounds(t *testing.T) {\n\ttmpDir := t.TempDir()\n\thostRoot := filepath.Join(tmpDir, \"/host-root\")\n\tcontainerRoot := filepath.Join(tmpDir, \"/container-root\")\n\n\trequire.NoError(t,\n\t\tmakeFs(hostRoot,\n\t\t\tdirOrLink{path: \"libfoo.so\"},\n\t\t),\n\t)\n\trequire.NoError(t,\n\t\tmakeFs(containerRoot,\n\t\t\tdirOrLink{path: \"/lib\"},\n\t\t\tdirOrLink{path: \"/lib/foo\", target: hostRoot},\n\t\t),\n\t)\n\n\tpath, err := symlinks.Resolve(filepath.Join(containerRoot, \"/lib/foo\"))\n\trequire.NoError(t, err)\n\trequire.Equal(t, hostRoot, path)\n\n\t// nvidia-cdi-hook create-symlinks --link ../libfoo.so.1::/lib/foo/libfoo.so\n\t_ = getTestCommand().createLink(containerRoot, \"../libfoo.so.1\", \"/lib/foo/libfoo.so\")\n\trequire.NoError(t, err)\n\n\ttarget, err := symlinks.Resolve(filepath.Join(containerRoot, hostRoot, \"libfoo.so\"))\n\trequire.NoError(t, err)\n\trequire.Equal(t, \"../libfoo.so.1\", target)\n\n\trequire.DirExists(t, filepath.Join(hostRoot, \"libfoo.so\"))\n}\n\ntype dirOrLink struct {\n\tpath string\n\ttarget string\n}\n\nfunc makeFs(tmpdir string, fs ...dirOrLink) error {\n\tif err := os.MkdirAll(tmpdir, 0o755); err != nil {\n\t\treturn err\n\t}\n\tfor _, s := range fs {\n\t\ts.path = filepath.Join(tmpdir, s.path)\n\t\tif s.target == \"\" {\n\t\t\t_ = os.MkdirAll(s.path, 0o755)\n\t\t\tcontinue\n\t\t}\n\t\tif err := os.MkdirAll(filepath.Dir(s.path), 0o755); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif err := os.Symlink(s.target, s.path); err != nil && !os.IsExist(err) {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\n// getTestCommand creates a command for running tests against.\nfunc getTestCommand() *command {\n\tlogger, _ := testlog.NewNullLogger()\n\treturn &command{\n\t\tlogger: logger,\n\t}\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/cudacompat/container-root.go",
"content": "/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cudacompat\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\n\t\"github.com/moby/sys/symlink\"\n)\n\n// A containerRoot represents the root filesystem of a container.\ntype containerRoot string\n\n// hasPath checks whether the specified path exists in the root.\nfunc (r containerRoot) hasPath(path string) bool {\n\tresolved, err := r.resolve(path)\n\tif err != nil {\n\t\treturn false\n\t}\n\tif _, err := os.Stat(resolved); err != nil && os.IsNotExist(err) {\n\t\treturn false\n\t}\n\treturn true\n}\n\n// globFiles matches the specified pattern in the root.\n// The files that match must be regular files.\nfunc (r containerRoot) globFiles(pattern string) ([]string, error) {\n\tpatternPath, err := r.resolve(pattern)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tmatches, err := filepath.Glob(patternPath)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar files []string\n\tfor _, match := range matches {\n\t\tinfo, err := os.Lstat(match)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\t// Ignore symlinks.\n\t\tif info.Mode()&os.ModeSymlink != 0 {\n\t\t\tcontinue\n\t\t}\n\t\t// Ignore directories.\n\t\tif info.IsDir() {\n\t\t\tcontinue\n\t\t}\n\t\tfiles = append(files, match)\n\t}\n\treturn files, nil\n}\n\n// resolve returns the absolute path including root path.\n// Symlinks are resolved, but are guaranteed to resolve in the root.\nfunc (r containerRoot) resolve(path string) (string, error) {\n\tabsolute := filepath.Clean(filepath.Join(string(r), path))\n\treturn symlink.FollowSymlinkInScope(absolute, string(r))\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/cudacompat/cuda-elf-header.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cudacompat\n\nimport (\n\t\"bytes\"\n\t\"debug/elf\"\n\t\"encoding/binary\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"strings\"\n\n\t\"golang.org/x/mod/semver\"\n)\n\ntype compatElfHeader struct {\n\tFormat int\n\tCUDAVersion cudaVersion `json:\"CUDA Version\"`\n\tDriver []int\n\tDevice []int\n}\n\n// Elf32_Nhdr defines the header information for an ELF note.\n// See https://man7.org/linux/man-pages/man5/elf.5.html#:~:text=by%20the%20linker.-,Notes,-(Nhdr)%0A%20%20%20%20%20%20%20ELF\n// for the definition of an elf note.\n// TODO: When should a 64-bit header be used?\ntype elf32_Nhdr struct {\n\tNameSize uint32\n\tDescSize uint32\n\tDescType uint32\n}\n\nfunc (h elf32_Nhdr) sizeof() int {\n\treturn 12\n}\n\nfunc GetCUDACompatElfHeader(libraryPath string) (*compatElfHeader, error) {\n\tlib, err := elf.Open(libraryPath)\n\tif os.IsNotExist(err) {\n\t\treturn nil, nil\n\t}\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to load elf info for %q: %w\", libraryPath, err)\n\t}\n\tdefer func() {\n\t\t_ = lib.Close()\n\t}()\n\n\ts := getCUDAFwdCompatibilitySection(lib)\n\tif s == nil {\n\t\treturn nil, nil\n\t}\n\tdata, err := s.Data()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tnote := elf32_Nhdr{}\n\tr := bytes.NewReader(data)\n\tif err := binary.Read(r, lib.ByteOrder, ¬e); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to read data header: %w\", err)\n\t}\n\n\tif note.NameSize == 0 || note.DescSize == 0 {\n\t\treturn nil, nil\n\t}\n\n\tname := string(trim(data, note.sizeof(), alignUp(note.NameSize, s.Addralign)))\n\tif name != \"NVIDIA Corporation\" {\n\t\treturn nil, nil\n\t}\n\n\tdescription := trim(data, note.sizeof()+alignUp(note.NameSize, s.Addralign), int(note.DescSize))\n\th := &compatElfHeader{}\n\tif err := json.Unmarshal(description, h); err != nil {\n\t\treturn nil, fmt.Errorf(\"could not unmarshal JSON data: %w\", err)\n\t}\n\n\treturn h, err\n}\n\nfunc alignUp[T uint32 | uint64, S uint64](size T, to S) int {\n\treturn int((size + T(to) - 1) &^ (T(to) - 1))\n}\n\nfunc trim(data []byte, from int, len int) []byte {\n\treturn bytes.Trim(data[from:from+len], \"\\x00\")\n}\n\nfunc getCUDAFwdCompatibilitySection(lib *elf.File) *elf.Section {\n\tfor _, s := range lib.Sections {\n\t\tif s.Type != elf.SHT_NOTE {\n\t\t\tcontinue\n\t\t}\n\t\tif s.Name != \".note.cuda.fwd_compatibility\" {\n\t\t\tcontinue\n\t\t}\n\t\treturn s\n\t}\n\treturn nil\n}\n\n// UseCompat checks whether the CUDA compat libraries with the specified elf\n// header should be used given the specified host versions.\n// This is done by comparing the host CUDA version with the CUDA version\n// specified in the ELF header.\nfunc (h *compatElfHeader) UseCompat(hostCUDAVersion string) bool {\n\tif h == nil {\n\t\treturn false\n\t}\n\n\treturn h.CUDAVersion.UseCompat(hostCUDAVersion)\n}\n\ntype cudaVersion string\n\n// UseCompat is true if the container CUDA version is strictly greater than the\n// host CUDA version.\nfunc (containerVersion cudaVersion) UseCompat(hostVersion string) bool {\n\tif containerVersion == \"\" || hostVersion == \"\" {\n\t\treturn false\n\t}\n\n\treturn semver.Compare(normalizeVersion(containerVersion), normalizeVersion(hostVersion)) > 0\n}\n\nfunc normalizeVersion[T string | cudaVersion](v T) string {\n\treturn \"v\" + strings.TrimPrefix(string(v), \"v\")\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/cudacompat/cuda-elf-header_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cudacompat\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestGetCUDACompatElfHeader(t *testing.T) {\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tdataRoot := filepath.Join(moduleRoot, \"testdata\", \"compat\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tfilename string\n\t\texpected *compatElfHeader\n\t}{\n\t\t{\n\t\t\tdescription: \"wip\",\n\t\t\tfilename: \"libcuda.so.575.57.08\",\n\t\t\texpected: &compatElfHeader{\n\t\t\t\tFormat: 1,\n\t\t\t\tCUDAVersion: \"12.9\",\n\t\t\t\tDriver: []int{535, 550, 560, 565, 570, 575},\n\t\t\t\tDevice: []int{1, 2, 7, 8, 9, 10, 11, 12, 13, 14},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"wip\",\n\t\t\tfilename: \"libcuda.so.590.44.01\",\n\t\t\texpected: &compatElfHeader{\n\t\t\t\tFormat: 1,\n\t\t\t\tCUDAVersion: \"13.1\",\n\t\t\t\tDriver: []int{535, 550, 570, 575, 580, 590},\n\t\t\t\tDevice: []int{1, 2, 7, 8, 9, 10, 11, 12, 13, 14},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tlibpath := filepath.Join(dataRoot, tc.filename)\n\n\t\t\th, err := GetCUDACompatElfHeader(libpath)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expected, h)\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/cudacompat/cudacompat.go",
"content": "/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cudacompat\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\nconst (\n\tdefaultCudaCompatPath = \"/usr/local/cuda/compat\"\n\t// cudaCompatLdsoconfdFilenamePattern specifies the pattern for the filename\n\t// in ld.so.conf.d that includes a reference to the CUDA compat path.\n\t// The 00-compat prefix is chosen to ensure that these libraries have a\n\t// higher precedence than other libraries on the system.\n\tcudaCompatLdsoconfdFilenamePattern = \"00-compat-*.conf\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\ntype options struct {\n\tcudaCompatContainerRoot string\n\thostDriverVersion string\n\thostCudaVersion string\n\t// containerSpec allows the path to the container spec to be specified for\n\t// testing.\n\tcontainerSpec string\n}\n\n// NewCommand constructs a cuda-compat command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build the enable-cuda-compat command\nfunc (m command) build() *cli.Command {\n\toptions := &options{}\n\n\t// Create the 'enable-cuda-compat' command\n\tc := cli.Command{\n\t\tName: \"enable-cuda-compat\",\n\t\tUsage: \"This hook ensures that the folder containing the CUDA compat libraries is added to the ldconfig search path if required.\",\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(cmd, options)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(cmd, options)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"host-driver-version\",\n\t\t\t\tUsage: \"Specify the host driver version. If the CUDA compat libraries detected in the container do not have a higher MAJOR version, the hook is a no-op.\",\n\t\t\t\tDestination: &options.hostDriverVersion,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"host-cuda-version\",\n\t\t\t\tUsage: \"Specify the CUDA version supported by the host driver.\",\n\t\t\t\tDestination: &options.hostCudaVersion,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"cuda-compat-container-root\",\n\t\t\t\tUsage: \"Specify the folder in which CUDA compat libraries are located in the container\",\n\t\t\t\tValue: defaultCudaCompatPath,\n\t\t\t\tDestination: &options.cudaCompatContainerRoot,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"container-spec\",\n\t\t\t\tHidden: true,\n\t\t\t\tCategory: \"testing-only\",\n\t\t\t\tUsage: \"Specify the path to the OCI container spec. If empty or '-' the spec will be read from STDIN\",\n\t\t\t\tDestination: &options.containerSpec,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(_ *cli.Command, _ *options) error {\n\treturn nil\n}\n\nfunc (m command) run(_ *cli.Command, o *options) error {\n\t// If neither the host driver version nor the host cuda version is specified\n\t// the hook is a no-op.\n\tif o.hostDriverVersion == \"\" && o.hostCudaVersion == \"\" {\n\t\treturn nil\n\t}\n\n\ts, err := oci.LoadContainerState(o.containerSpec)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to load container state: %w\", err)\n\t}\n\n\tcontainerRootDir, err := s.GetContainerRoot()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to determined container root: %w\", err)\n\t}\n\n\tcontainerForwardCompatDir, err := m.getContainerForwardCompatDir(containerRoot(containerRootDir), o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to get container forward compat directory: %w\", err)\n\t}\n\tif containerForwardCompatDir == \"\" {\n\t\treturn nil\n\t}\n\n\treturn m.createLdsoconfdFile(containerRoot(containerRootDir), cudaCompatLdsoconfdFilenamePattern, containerForwardCompatDir)\n}\n\nfunc (m command) getContainerForwardCompatDir(containerRoot containerRoot, o *options) (string, error) {\n\tif o.hostDriverVersion == \"\" && o.hostCudaVersion == \"\" {\n\t\tm.logger.Debugf(\"Neither a host driver version nor a host CUDA version was specified\")\n\t\treturn \"\", nil\n\t}\n\tif !containerRoot.hasPath(o.cudaCompatContainerRoot) {\n\t\tm.logger.Debugf(\"No CUDA forward compatibility libraries directory in container\")\n\t\treturn \"\", nil\n\t}\n\n\tlibs, err := containerRoot.globFiles(filepath.Join(o.cudaCompatContainerRoot, \"libcuda.so.*.*\"))\n\tif err != nil {\n\t\tm.logger.Warningf(\"Failed to find CUDA compat library: %w\", err)\n\t\treturn \"\", nil\n\t}\n\n\tif len(libs) == 0 {\n\t\tm.logger.Debugf(\"No CUDA forward compatibility libraries container\")\n\t\treturn \"\", nil\n\t}\n\n\tif len(libs) != 1 {\n\t\tm.logger.Warningf(\"Unexpected number of CUDA compat libraries in container: %v\", libs)\n\t\treturn \"\", nil\n\t}\n\n\tlibCudaCompatPath := libs[0]\n\n\tuseCompatLibs, err := m.useCompatLibraries(libCudaCompatPath, o.hostDriverVersion, o.hostCudaVersion)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tif !useCompatLibs {\n\t\treturn \"\", nil\n\t}\n\n\tresolvedCompatDir := strings.TrimPrefix(filepath.Dir(libCudaCompatPath), string(containerRoot))\n\treturn resolvedCompatDir, nil\n}\n\nfunc (m command) useCompatLibraries(libcudaCompatPath string, hostDriverVersion string, hostCUDAVersion string) (bool, error) {\n\t// If the host CUDA version is specified, we need to inspect the ELF header\n\t// of the compat libraries in the container to determine whether these\n\t// should be used.\n\tif hostCUDAVersion != \"\" {\n\t\tcudaCompatHeader, _ := GetCUDACompatElfHeader(libcudaCompatPath)\n\t\tif cudaCompatHeader != nil {\n\t\t\treturn cudaCompatHeader.UseCompat(hostCUDAVersion), nil\n\t\t}\n\t\t// If we were unable to read the CUDA header, we do not use the compat\n\t\t// libraries.\n\t\treturn false, nil\n\t}\n\n\t// If neither a host driver version nor a host CUDA version is specified,\n\t// we don't use the CUDA compat libraries in the container.\n\tif hostDriverVersion == \"\" {\n\t\treturn false, nil\n\t}\n\n\tdriverMajor, err := extractMajorVersion(hostDriverVersion)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"failed to extract major version from %q: %v\", hostDriverVersion, err)\n\t}\n\n\tcompatDriverVersion := strings.TrimPrefix(filepath.Base(libcudaCompatPath), \"libcuda.so.\")\n\tcompatMajor, err := extractMajorVersion(compatDriverVersion)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"failed to extract major version from %q: %v\", compatDriverVersion, err)\n\t}\n\n\tif driverMajor < compatMajor {\n\t\treturn true, nil\n\t}\n\n\tm.logger.Debugf(\"Compat major version is not greater than the host driver major version (%v >= %v)\", hostDriverVersion, compatDriverVersion)\n\treturn false, nil\n}\n\n// createLdsoconfdFile creates a file at /etc/ld.so.conf.d/ in the specified root.\n// The file is created at /etc/ld.so.conf.d/{{ .pattern }} using `CreateTemp` and\n// contains the specified directories on each line.\nfunc (m command) createLdsoconfdFile(in containerRoot, pattern string, dirs ...string) error {\n\tif len(dirs) == 0 {\n\t\tm.logger.Debugf(\"No directories to add to /etc/ld.so.conf\")\n\t\treturn nil\n\t}\n\n\tldsoconfdDir, err := in.resolve(\"/etc/ld.so.conf.d\")\n\tif err != nil {\n\t\treturn err\n\t}\n\tif err := os.MkdirAll(ldsoconfdDir, 0755); err != nil {\n\t\treturn fmt.Errorf(\"failed to create ld.so.conf.d: %w\", err)\n\t}\n\n\tconfigFile, err := os.CreateTemp(ldsoconfdDir, pattern)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create config file: %w\", err)\n\t}\n\tdefer configFile.Close()\n\n\tm.logger.Debugf(\"Adding directories %v to %v\", dirs, configFile.Name())\n\n\tadded := make(map[string]bool)\n\tfor _, dir := range dirs {\n\t\tif added[dir] {\n\t\t\tcontinue\n\t\t}\n\t\t_, err = fmt.Fprintf(configFile, \"%s\\n\", dir)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to update config file: %w\", err)\n\t\t}\n\t\tadded[dir] = true\n\t}\n\n\t// The created file needs to be world readable for the cases where the container is run as a non-root user.\n\tif err := configFile.Chmod(0644); err != nil {\n\t\treturn fmt.Errorf(\"failed to chmod config file: %w\", err)\n\t}\n\n\treturn nil\n}\n\n// extractMajorVersion parses a version string and returns the major version as an int.\nfunc extractMajorVersion(version string) (int, error) {\n\tif version == \"\" {\n\t\treturn 0, nil\n\t}\n\tmajorString := strings.SplitN(version, \".\", 2)[0]\n\treturn strconv.Atoi(majorString)\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/cudacompat/cudacompat_test.go",
"content": "/*\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage cudacompat\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestCompatLibs(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcontents map[string]string\n\t\toptions options\n\t\texpectedContainerForwardCompatDir string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty root\",\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"222.55.66\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"compat lib is newer; no ldcache\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/usr/local/cuda/compat/libcuda.so.333.88.99\": \"\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"222.55.66\",\n\t\t\t},\n\t\t\texpectedContainerForwardCompatDir: \"/usr/local/cuda/compat\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"compat lib is newer; ldcache\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/etc/ld.so.cache\": \"\",\n\t\t\t\t\"/usr/local/cuda/compat/libcuda.so.333.88.99\": \"\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"222.55.66\",\n\t\t\t},\n\t\t\texpectedContainerForwardCompatDir: \"/usr/local/cuda/compat\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"compat lib is older; ldcache\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/etc/ld.so.cache\": \"\",\n\t\t\t\t\"/usr/local/cuda/compat/libcuda.so.111.88.99\": \"\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"222.55.66\",\n\t\t\t},\n\t\t\texpectedContainerForwardCompatDir: \"\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"compat lib has same major version; ldcache\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/etc/ld.so.cache\": \"\",\n\t\t\t\t\"/usr/local/cuda/compat/libcuda.so.222.88.99\": \"\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"222.55.66\",\n\t\t\t},\n\t\t\texpectedContainerForwardCompatDir: \"\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"numeric comparison is used; ldcache\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/etc/ld.so.cache\": \"\",\n\t\t\t\t\"/usr/local/cuda/compat/libcuda.so.222.88.99\": \"\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"99.55.66\",\n\t\t\t},\n\t\t\texpectedContainerForwardCompatDir: \"/usr/local/cuda/compat\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"driver version empty; ldcache\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/etc/ld.so.cache\": \"\",\n\t\t\t\t\"/usr/local/cuda/compat/libcuda.so.222.88.99\": \"\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"symlinks are followed\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/etc/ld.so.cache\": \"\",\n\t\t\t\t\"/etc/alternatives/cuda/compat/libcuda.so.333.88.99\": \"\",\n\t\t\t\t\"/usr/local/cuda\": \"symlink=/etc/alternatives/cuda\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"222.55.66\",\n\t\t\t},\n\t\t\texpectedContainerForwardCompatDir: \"/etc/alternatives/cuda/compat\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"symlinks stay in container\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/etc/ld.so.cache\": \"\",\n\t\t\t\t\"/compat/libcuda.so.333.88.99\": \"\",\n\t\t\t\t\"/usr/local/cuda\": \"symlink=../../../../../../\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\thostDriverVersion: \"222.55.66\",\n\t\t\t},\n\t\t\texpectedContainerForwardCompatDir: \"/compat\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"specified compat path is used\",\n\t\t\tcontents: map[string]string{\n\t\t\t\t\"/usr/local/cuda/compat/libcuda.so.111.88.99\": \"\",\n\t\t\t\t\"/usr/local/cuda/compat-other/libcuda.so.333.88.99\": \"\",\n\t\t\t},\n\t\t\toptions: options{\n\t\t\t\tcudaCompatContainerRoot: \"/usr/local/cuda/compat-other\",\n\t\t\t\thostDriverVersion: \"222.55.66\",\n\t\t\t},\n\t\t\texpectedContainerForwardCompatDir: \"/usr/local/cuda/compat-other\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tif tc.options.cudaCompatContainerRoot == \"\" {\n\t\t\ttc.options.cudaCompatContainerRoot = defaultCudaCompatPath\n\t\t}\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tcontainerRootDir := t.TempDir()\n\t\t\tfor name, contents := range tc.contents {\n\t\t\t\ttarget := filepath.Join(containerRootDir, name)\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(target), 0755))\n\n\t\t\t\tif strings.HasPrefix(contents, \"symlink=\") {\n\t\t\t\t\trequire.NoError(t, os.Symlink(strings.TrimPrefix(contents, \"symlink=\"), target))\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\n\t\t\t\trequire.NoError(t, os.WriteFile(target, []byte(contents), 0600))\n\t\t\t}\n\n\t\t\tc := command{\n\t\t\t\tlogger: logger,\n\t\t\t}\n\t\t\tcontainerForwardCompatDir, err := c.getContainerForwardCompatDir(containerRoot(containerRootDir), &tc.options)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedContainerForwardCompatDir, containerForwardCompatDir)\n\t\t})\n\t}\n}\n\nfunc TestUpdateLdconfig(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\ttestCases := []struct {\n\t\tdescription string\n\t\tfolders []string\n\t\texpectedContents string\n\t}{\n\t\t{\n\t\t\tdescription: \"no folders; have no contents\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"single folder is added\",\n\t\t\tfolders: []string{\"/usr/local/cuda/compat\"},\n\t\t\texpectedContents: \"/usr/local/cuda/compat\\n\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tcontainerRootDir := t.TempDir()\n\t\t\tc := command{\n\t\t\t\tlogger: logger,\n\t\t\t}\n\t\t\terr := c.createLdsoconfdFile(containerRoot(containerRootDir), cudaCompatLdsoconfdFilenamePattern, tc.folders...)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tmatches, err := filepath.Glob(filepath.Join(containerRootDir, \"/etc/ld.so.conf.d/00-compat-*.conf\"))\n\t\t\trequire.NoError(t, err)\n\n\t\t\tif tc.expectedContents == \"\" {\n\t\t\t\trequire.Empty(t, matches)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\trequire.Len(t, matches, 1)\n\t\t\tcontents, err := os.ReadFile(matches[0])\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedContents, string(contents))\n\t\t})\n\t}\n\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/disable-device-node-modification/disable-device-node-modification.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage disabledevicenodemodification\n\nimport (\n\t\"bufio\"\n\t\"bytes\"\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"strings\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\nconst (\n\tnvidiaDriverParamsPath = \"/proc/driver/nvidia/params\"\n)\n\ntype options struct {\n\tcontainerSpec string\n}\n\n// NewCommand constructs an disable-device-node-modification subcommand with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tcfg := options{}\n\n\tc := cli.Command{\n\t\tName: \"disable-device-node-modification\",\n\t\tUsage: \"Ensure that the /proc/driver/nvidia/params file present in the container does not allow device node modifications.\",\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, validateFlags(cmd, &cfg)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn run(ctx, cmd, &cfg)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"container-spec\",\n\t\t\t\tHidden: true,\n\t\t\t\tUsage: \"Specify the path to the OCI container spec. If empty or '-' the spec will be read from STDIN\",\n\t\t\t\tDestination: &cfg.containerSpec,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc validateFlags(_ *cli.Command, _ *options) error {\n\treturn nil\n}\n\nfunc run(_ context.Context, _ *cli.Command, cfg *options) error {\n\tmodifiedParamsFileContents, err := getModifiedNVIDIAParamsContents()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to get modified params file contents: %w\", err)\n\t}\n\tif len(modifiedParamsFileContents) == 0 {\n\t\treturn nil\n\t}\n\n\ts, err := oci.LoadContainerState(cfg.containerSpec)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to load container state: %w\", err)\n\t}\n\n\tcontainerRootDirPath, err := s.GetContainerRoot()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to determined container root: %w\", err)\n\t}\n\n\tcontainerRoot, err := os.OpenRoot(containerRootDirPath)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to open root: %w\", err)\n\t}\n\tdefer containerRoot.Close()\n\n\treturn createParamsFileInContainer(containerRoot, modifiedParamsFileContents)\n}\n\nfunc getModifiedNVIDIAParamsContents() ([]byte, error) {\n\thostNvidiaParamsFile, err := os.Open(nvidiaDriverParamsPath)\n\tif errors.Is(err, os.ErrNotExist) {\n\t\treturn nil, nil\n\t}\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to load params file: %w\", err)\n\t}\n\tdefer hostNvidiaParamsFile.Close()\n\n\tmodifiedContents, err := getModifiedParamsFileContentsFromReader(hostNvidiaParamsFile)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get modfied params file contents: %w\", err)\n\t}\n\n\treturn modifiedContents, nil\n}\n\n// getModifiedParamsFileContentsFromReader returns the contents of a modified params file from the specified reader.\nfunc getModifiedParamsFileContentsFromReader(r io.Reader) ([]byte, error) {\n\tvar modified bytes.Buffer\n\tscanner := bufio.NewScanner(r)\n\n\tvar requiresModification bool\n\tfor scanner.Scan() {\n\t\tline := scanner.Text()\n\t\tif strings.HasPrefix(line, \"ModifyDeviceFiles: \") {\n\t\t\tif line == \"ModifyDeviceFiles: 0\" {\n\t\t\t\treturn nil, nil\n\t\t\t}\n\t\t\tif line == \"ModifyDeviceFiles: 1\" {\n\t\t\t\tline = \"ModifyDeviceFiles: 0\"\n\t\t\t\trequiresModification = true\n\t\t\t}\n\t\t}\n\t\tif _, err := modified.WriteString(line + \"\\n\"); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to create output buffer: %w\", err)\n\t\t}\n\t}\n\tif err := scanner.Err(); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to read params file: %w\", err)\n\t}\n\n\tif !requiresModification {\n\t\treturn nil, nil\n\t}\n\n\treturn modified.Bytes(), nil\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/disable-device-node-modification/disable-device-node-modification_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage disabledevicenodemodification\n\nimport (\n\t\"bytes\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetModifiedParamsFileContentsFromReader(t *testing.T) {\n\ttestCases := map[string]struct {\n\t\tcontents []byte\n\t\texpectedError error\n\t\texpectedContents []byte\n\t}{\n\t\t\"no contents\": {\n\t\t\tcontents: nil,\n\t\t\texpectedError: nil,\n\t\t\texpectedContents: nil,\n\t\t},\n\t\t\"other contents are ignored\": {\n\t\t\tcontents: []byte(`# Some other content\n\t\t\tthat we don't care about\n\t\t\t`),\n\t\t\texpectedError: nil,\n\t\t\texpectedContents: nil,\n\t\t},\n\t\t\"already zero requires no modification\": {\n\t\t\tcontents: []byte(\"ModifyDeviceFiles: 0\"),\n\t\t\texpectedError: nil,\n\t\t\texpectedContents: nil,\n\t\t},\n\t\t\"leading spaces require no modification\": {\n\t\t\tcontents: []byte(\" ModifyDeviceFiles: 1\"),\n\t\t},\n\t\t\"Trailing spaces require no modification\": {\n\t\t\tcontents: []byte(\"ModifyDeviceFiles: 1 \"),\n\t\t},\n\t\t\"Not 1 require no modification\": {\n\t\t\tcontents: []byte(\"ModifyDeviceFiles: 11\"),\n\t\t},\n\t\t\"single line requires modification\": {\n\t\t\tcontents: []byte(\"ModifyDeviceFiles: 1\"),\n\t\t\texpectedError: nil,\n\t\t\texpectedContents: []byte(\"ModifyDeviceFiles: 0\\n\"),\n\t\t},\n\t\t\"single line with trailing newline requires modification\": {\n\t\t\tcontents: []byte(\"ModifyDeviceFiles: 1\\n\"),\n\t\t\texpectedError: nil,\n\t\t\texpectedContents: []byte(\"ModifyDeviceFiles: 0\\n\"),\n\t\t},\n\t\t\"other content is maintained\": {\n\t\t\tcontents: []byte(`ModifyDeviceFiles: 1\n\t\t\tother content\n\t\t\tthat\n\t\t\tis maintained`),\n\t\t\texpectedError: nil,\n\t\t\texpectedContents: []byte(`ModifyDeviceFiles: 0\n\t\t\tother content\n\t\t\tthat\n\t\t\tis maintained\n`),\n\t\t},\n\t}\n\n\tfor description, tc := range testCases {\n\t\tt.Run(description, func(t *testing.T) {\n\t\t\tcontents, err := getModifiedParamsFileContentsFromReader(bytes.NewReader(tc.contents))\n\t\t\trequire.EqualValues(t, tc.expectedError, err)\n\t\t\trequire.EqualValues(t, string(tc.expectedContents), string(contents))\n\t\t})\n\t}\n\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/disable-device-node-modification/params_linux.go",
"content": "//go:build linux\n\n/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage disabledevicenodemodification\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\n\t\"github.com/google/uuid\"\n\t\"github.com/opencontainers/runc/libcontainer/utils\"\n\t\"golang.org/x/sys/unix\"\n)\n\nfunc createParamsFileInContainer(containerRoot *os.Root, contents []byte) error {\n\tcontainerRootDirPath := containerRoot.Name()\n\n\thookScratchDirPath := \"/run/nvidia-ctk-hook\" + uuid.NewString()\n\tif err := containerRoot.MkdirAll(hookScratchDirPath[1:], 0755); err != nil {\n\t\treturn fmt.Errorf(\"error creating hook scratch folder: %w\", err)\n\t}\n\n\t//nolint:staticcheck // TODO (ArangoGutierrez): Remove the nolint:staticcheck and properly fix the deprecation warning.\n\terr := utils.WithProcfd(containerRootDirPath, hookScratchDirPath, func(hookScratchDirFdPath string) error {\n\t\treturn createTmpFs(hookScratchDirFdPath, len(contents))\n\t})\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create tmpfs mount for params file: %w\", err)\n\t}\n\n\tmodifiedParamsFilePath := filepath.Join(hookScratchDirPath, \"nvct-params\")\n\tif _, err := containerRoot.OpenFile(modifiedParamsFilePath[1:], os.O_CREATE|os.O_RDONLY|os.O_TRUNC, 0444); err != nil {\n\t\treturn fmt.Errorf(\"error creating modified params file: %w\", err)\n\t}\n\n\t//nolint:staticcheck // TODO (ArangoGutierrez): Remove the nolint:staticcheck and properly fix the deprecation warning.\n\terr = utils.WithProcfd(containerRootDirPath, modifiedParamsFilePath, func(modifiedParamsFileFdPath string) error {\n\t\tmodifiedParamsFile, err := os.OpenFile(modifiedParamsFileFdPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0444)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to open modified params file: %w\", err)\n\t\t}\n\t\tdefer modifiedParamsFile.Close()\n\n\t\tif _, err := modifiedParamsFile.Write(contents); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to write temporary params file: %w\", err)\n\t\t}\n\n\t\t//nolint:staticcheck // TODO (ArangoGutierrez): Remove the nolint:staticcheck and properly fix the deprecation warning.\n\t\terr = utils.WithProcfd(containerRootDirPath, nvidiaDriverParamsPath, func(nvidiaDriverParamsFdPath string) error {\n\t\t\treturn unix.Mount(modifiedParamsFileFdPath, nvidiaDriverParamsFdPath, \"\", unix.MS_BIND|unix.MS_RDONLY|unix.MS_NODEV|unix.MS_PRIVATE|unix.MS_NOSYMFOLLOW, \"\")\n\t\t})\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to mount modified params file: %w\", err)\n\t\t}\n\n\t\treturn nil\n\t})\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\nfunc createTmpFs(target string, size int) error {\n\treturn unix.Mount(\"tmpfs\", target, \"tmpfs\", 0, fmt.Sprintf(\"size=%d\", size))\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/disable-device-node-modification/params_other.go",
"content": "//go:build !linux\n\n/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage disabledevicenodemodification\n\nimport (\n\t\"fmt\"\n\t\"os\"\n)\n\nfunc createParamsFileInContainer(containerRootDirPath *os.Root, contents []byte) error {\n\treturn fmt.Errorf(\"not supported\")\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/main.go",
"content": "/**\n# Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/sirupsen/logrus\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\n\tcli \"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/commands\"\n)\n\n// options defines the options that can be set for the CLI through config files,\n// environment variables, or command line flags\ntype options struct {\n\t// Debug indicates whether the CLI is started in \"debug\" mode\n\tDebug bool\n\t// Quiet indicates whether the CLI is started in \"quiet\" mode\n\tQuiet bool\n}\n\nfunc main() {\n\tlogger := logrus.New()\n\n\t// Create a options struct to hold the parsed environment variables or command line flags\n\topts := options{}\n\n\t// Create the top-level CLI\n\tc := commands.ConfigureCDIHookCommand(logger, &cli.Command{\n\t\tName: \"NVIDIA CDI Hook\",\n\t\tUsage: \"Command to structure files for usage inside a container, called as hooks from a container runtime, defined in a CDI yaml file\",\n\t\tVersion: info.GetVersionString(),\n\t\t// Set log-level for all subcommands\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\tlogLevel := logrus.InfoLevel\n\t\t\tif opts.Debug {\n\t\t\t\tlogLevel = logrus.DebugLevel\n\t\t\t}\n\t\t\tif opts.Quiet {\n\t\t\t\tlogLevel = logrus.ErrorLevel\n\t\t\t}\n\t\t\tlogger.SetLevel(logLevel)\n\t\t\treturn ctx, nil\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"debug\",\n\t\t\t\tAliases: []string{\"d\"},\n\t\t\t\tUsage: \"Enable debug-level logging\",\n\t\t\t\tDestination: &opts.Debug,\n\t\t\t\t// TODO: Support for NVIDIA_CDI_DEBUG is deprecated and NVIDIA_CTK_DEBUG should be used instead.\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_DEBUG\", \"NVIDIA_CDI_DEBUG\"),\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"quiet\",\n\t\t\t\tUsage: \"Suppress all output except for errors; overrides --debug\",\n\t\t\t\tDestination: &opts.Quiet,\n\t\t\t\t// TODO: Support for NVIDIA_CDI_QUIET is deprecated and NVIDIA_CTK_QUIET should be used instead.\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_QUIET\", \"NVIDIA_CDI_QUIET\"),\n\t\t\t},\n\t\t},\n\t})\n\n\t// Run the CLI\n\terr := c.Run(context.Background(), os.Args)\n\tif err != nil {\n\t\tlogger.Errorf(\"%v\", err)\n\t\tos.Exit(1)\n\t}\n}\n"
},
{
"path": "cmd/nvidia-cdi-hook/update-ldcache/update-ldcache.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ldcache\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\t\"github.com/moby/sys/reexec\"\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/ldconfig\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\nconst (\n\treexecUpdateLdCacheCommandName = \"reexec-update-ldcache\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\ntype options struct {\n\tfolders []string\n\tldconfigPath string\n\tcontainerSpec string\n}\n\nfunc init() {\n\treexec.Register(reexecUpdateLdCacheCommandName, updateLdCacheHandler)\n\tif reexec.Init() {\n\t\tos.Exit(0)\n\t}\n}\n\n// NewCommand constructs an update-ldcache command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build the update-ldcache command\nfunc (m command) build() *cli.Command {\n\tcfg := options{}\n\n\t// Create the 'update-ldcache' command\n\tc := cli.Command{\n\t\tName: \"update-ldcache\",\n\t\tUsage: \"Update ldcache in a container by running ldconfig\",\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(cmd, &cfg)\n\t\t},\n\t\tAction: func(_ context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(cmd, &cfg)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"folder\",\n\t\t\t\tUsage: \"Specify a folder to add to /etc/ld.so.conf before updating the ld cache\",\n\t\t\t\tDestination: &cfg.folders,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"ldconfig-path\",\n\t\t\t\tUsage: \"Specify the path to the ldconfig program\",\n\t\t\t\tDestination: &cfg.ldconfigPath,\n\t\t\t\tValue: \"/sbin/ldconfig\",\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"container-spec\",\n\t\t\t\tUsage: \"Specify the path to the OCI container spec. If empty or '-' the spec will be read from STDIN\",\n\t\t\t\tDestination: &cfg.containerSpec,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(_ *cli.Command, cfg *options) error {\n\tif cfg.ldconfigPath == \"\" {\n\t\treturn errors.New(\"ldconfig-path must be specified\")\n\t}\n\treturn nil\n}\n\nfunc (m command) run(_ *cli.Command, cfg *options) error {\n\ts, err := oci.LoadContainerState(cfg.containerSpec)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to load container state: %v\", err)\n\t}\n\n\tcontainerRootDir, err := s.GetContainerRoot()\n\tif err != nil || containerRootDir == \"\" || containerRootDir == \"/\" {\n\t\treturn fmt.Errorf(\"failed to determined container root: %v\", err)\n\t}\n\n\trunner, err := ldconfig.NewRunner(\n\t\treexecUpdateLdCacheCommandName,\n\t\tcfg.ldconfigPath,\n\t\tcontainerRootDir,\n\t\tcfg.folders...,\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn runner.Run()\n}\n\n// updateLdCacheHandler wraps updateLdCache with error handling.\nfunc updateLdCacheHandler() {\n\tif err := updateLdCache(os.Args); err != nil {\n\t\tlog.Printf(\"Error updating ldcache: %v\", err)\n\t\tos.Exit(1)\n\t}\n}\n\n// updateLdCache ensures that the ldcache in the container is updated to include\n// libraries that are mounted from the host.\n// It is invoked from a reexec'd handler and provides namespace isolation for\n// the operations performed by this hook. At the point where this is invoked,\n// we are in a new mount namespace that is cloned from the parent.\nfunc updateLdCache(args []string) error {\n\tldconfig, err := ldconfig.NewFromArgs(args...)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to construct ldconfig runner: %w\", err)\n\t}\n\n\treturn ldconfig.UpdateLDCache()\n}\n"
},
{
"path": "cmd/nvidia-container-runtime/README.md",
"content": "# The NVIDIA Container Runtime\n\nThe NVIDIA Container Runtime is a shim for OCI-compliant low-level runtimes such as [runc](https://github.com/opencontainers/runc). When a `create` command is detected, the incoming [OCI runtime specification](https://github.com/opencontainers/runtime-spec) is modified in place and the command is forwarded to the low-level runtime.\n\n## Configuration\n\nThe NVIDIA Container Runtime uses file-based configuration, with the config stored in `/etc/nvidia-container-runtime/config.toml`. The `/etc` path can be overridden using the `XDG_CONFIG_HOME` environment variable with the `${XDG_CONFIG_HOME}/nvidia-container-runtime/config.toml` file used instead if this environment variable is set.\n\nThis config file may contain options for other components of the NVIDIA container stack and for the NVIDIA Container Runtime, the relevant config section is `nvidia-container-runtime`\n\n### Logging\n\nThe `log-level` config option (default: `\"info\"`) specifies the log level to use and the `debug` option, if set, specifies a log file to which logs for the NVIDIA Container Runtime must be written.\n\nIn addition to this, the NVIDIA Container Runtime considers the value of `--log` and `--log-format` flags that may be passed to it by a container runtime such as docker or containerd. If the `--debug` flag is present the log-level specified in the config file is overridden as `\"debug\"`.\n\n### Low-level Runtime Path\n\nThe `runtimes` config option allows for the low-level runtime to be specified. The first entry in this list that is an existing executable file is used as the low-level runtime. If the entry is not a path, the `PATH` is searched for a matching executable. If the entry is a path this is checked instead.\n\nThe default value for this setting is:\n```toml\nruntimes = [\n \"runc\",\n \"crun\",\n]\n```\n\nand if, for example, `crun` is to be used instead this can be changed to:\n```toml\nruntimes = [\n \"crun\",\n]\n```\n\n### Runtime Mode\n\nThe `mode` config option (default `\"auto\"`) controls the high-level behaviour of the runtime.\n\n#### Auto Mode\n\nWhen `mode` is set to `\"auto\"`, the runtime employs heuristics to determine which mode to use based on, for example, the platform where the runtime is being run.\n\n#### Legacy Mode\n\nWhen `mode` is set to `\"legacy\"`, the NVIDIA Container Runtime adds a [`prestart` hook](https://github.com/opencontainers/runtime-spec/blob/master/config.md#prestart) to the incomming OCI specification that invokes the NVIDIA Container Runtime Hook for all containers created. This hook checks whether NVIDIA devices are requested and ensures GPU access is configured using the `nvidia-container-cli` from the [libnvidia-container](https://github.com/NVIDIA/libnvidia-container) project.\n\n#### CSV Mode\n\nWhen `mode` is set to `\"csv\"`, CSV files at `/etc/nvidia-container-runtime/host-files-for-container.d` define the devices and mounts that are to be injected into a container when it is created. The search path for the files can be overridden by modifying the `nvidia-container-runtime.modes.csv.mount-spec-path` in the config as below:\n\n```toml\n[nvidia-container-runtime]\n [nvidia-container-runtime.modes.csv]\n mount-spec-path = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n```\n\nThis mode is primarily targeted at Tegra-based systems without NVML available.\n\n### Notes on using the docker CLI\n\nNote that only the `\"legacy\"` NVIDIA Container Runtime mode is directly compatible with the `--gpus` flag implemented by the `docker` CLI (assuming the NVIDIA Container Runtime is not used). The reason for this is that `docker` inserts the same NVIDIA Container Runtime Hook into the OCI runtime specification.\n\n\nIf a different mode is explicitly set or detected, the NVIDIA Container Runtime Hook will raise the following error when `--gpus` is set:\n```\n$ docker run --rm --gpus all ubuntu:18.04\ndocker: Error response from daemon: failed to create shim: OCI runtime create failed: container_linux.go:380: starting container process caused: process_linux.go:545: container init caused: Running hook #0:: error running hook: exit status 1, stdout: , stderr: Auto-detected mode as 'csv'\ninvoking the NVIDIA Container Runtime Hook directly (e.g. specifying the docker --gpus flag) is not supported. Please use the NVIDIA Container Runtime instead.: unknown.\n```\nHere NVIDIA Container Runtime must be used explicitly. The recommended way to do this is to specify the `--runtime=nvidia` command line argument as part of the `docker run` commmand as follows:\n```\n$ docker run --rm --gpus all --runtime=nvidia ubuntu:18.04\n```\n\nAlternatively the NVIDIA Container Runtime can be set as the default runtime for docker. This can be done by modifying the `/etc/docker/daemon.json` file as follows:\n```json\n{\n \"default-runtime\": \"nvidia\",\n \"runtimes\": {\n \"nvidia\": {\n \"path\": \"nvidia-container-runtime\",\n \"runtimeArgs\": []\n }\n }\n}\n```\n\n## Environment variables (OCI spec)\n\nEach environment variable maps to a command-line argument for `nvidia-container-cli` from [libnvidia-container](https://github.com/NVIDIA/libnvidia-container).\nThese variables are already set in our [official CUDA images](https://hub.docker.com/r/nvidia/cuda/).\n\n### `NVIDIA_VISIBLE_DEVICES`\nThis variable controls which GPUs will be made accessible inside the container.\n\n#### Possible values\n* `0,1,2`, `GPU-fef8089b` …: a comma-separated list of GPU UUID(s) or index(es).\n* `all`: all GPUs will be accessible, this is the default value in our container images.\n* `none`: no GPU will be accessible, but driver capabilities will be enabled.\n* `void` or *empty* or *unset*: `nvidia-container-runtime` will have the same behavior as `runc`.\n\n**Note**: When running on a MIG capable device, the following values will also be available:\n* `0:0,0:1,1:0`, `MIG-GPU-fef8089b/0/1` …: a comma-separated list of MIG Device UUID(s) or index(es).\n\nWhere the MIG device indices have the form `:` as seen in the example output:\n```\n$ nvidia-smi -L\nGPU 0: Graphics Device (UUID: GPU-b8ea3855-276c-c9cb-b366-c6fa655957c5)\n MIG Device 0: (UUID: MIG-GPU-b8ea3855-276c-c9cb-b366-c6fa655957c5/1/0)\n MIG Device 1: (UUID: MIG-GPU-b8ea3855-276c-c9cb-b366-c6fa655957c5/1/1)\n MIG Device 2: (UUID: MIG-GPU-b8ea3855-276c-c9cb-b366-c6fa655957c5/11/0)\n```\n\n### `NVIDIA_MIG_CONFIG_DEVICES`\nThis variable controls which of the visible GPUs can have their MIG\nconfiguration managed from within the container. This includes enabling and\ndisabling MIG mode, creating and destroying GPU Instances and Compute\nInstances, etc.\n\n#### Possible values\n* `all`: Allow all MIG-capable GPUs in the visible device list to have their\n MIG configurations managed.\n\n**Note**:\n* This feature is only available on MIG capable devices (e.g. the A100).\n* To use this feature, the container must be started with `CAP_SYS_ADMIN` privileges.\n* When not running as `root`, the container user must have read access to the\n `/proc/driver/nvidia/capabilities/mig/config` file on the host.\n\n### `NVIDIA_MIG_MONITOR_DEVICES`\nThis variable controls which of the visible GPUs can have aggregate information\nabout all of their MIG devices monitored from within the container. This\nincludes inspecting the aggregate memory usage, listing the aggregate running\nprocesses, etc.\n\n#### Possible values\n* `all`: Allow all MIG-capable GPUs in the visible device list to have their\n MIG devices monitored.\n\n**Note**:\n* This feature is only available on MIG capable devices (e.g. the A100).\n* To use this feature, the container must be started with `CAP_SYS_ADMIN` privileges.\n* When not running as `root`, the container user must have read access to the\n `/proc/driver/nvidia/capabilities/mig/monitor` file on the host.\n\n### `NVIDIA_DRIVER_CAPABILITIES`\nThis option controls which driver libraries/binaries will be mounted inside the container.\n\n#### Possible values\n* `compute,video`, `graphics,utility` …: a comma-separated list of driver features the container needs.\n* `all`: enable all available driver capabilities.\n* *empty* or *unset*: use default driver capability: `utility,compute`.\n\n#### Supported driver capabilities\n* `compute`: required for CUDA and OpenCL applications.\n* `compat32`: required for running 32-bit applications.\n* `graphics`: required for running OpenGL and Vulkan applications.\n* `utility`: required for using `nvidia-smi` and NVML.\n* `video`: required for using the Video Codec SDK.\n* `display`: required for leveraging X11 display.\n\n### `NVIDIA_REQUIRE_*`\nA logical expression to define constraints on the configurations supported by the container.\n\n#### Supported constraints\n* `cuda`: constraint on the CUDA driver version.\n* `driver`: constraint on the driver version.\n* `arch`: constraint on the compute architectures of the selected GPUs.\n* `brand`: constraint on the brand of the selected GPUs (e.g. GeForce, Tesla, GRID).\n\n#### Expressions\nMultiple constraints can be expressed in a single environment variable: space-separated constraints are ORed, comma-separated constraints are ANDed.\nMultiple environment variables of the form `NVIDIA_REQUIRE_*` are ANDed together.\n\n### `NVIDIA_DISABLE_REQUIRE`\nSingle switch to disable all the constraints of the form `NVIDIA_REQUIRE_*`.\n\n### `NVIDIA_REQUIRE_CUDA`\n\nThe version of the CUDA toolkit used by the container. It is an instance of the generic `NVIDIA_REQUIRE_*` case and it is set by official CUDA images.\nIf the version of the NVIDIA driver is insufficient to run this version of CUDA, the container will not be started.\n\n#### Possible values\n* `cuda>=7.5`, `cuda>=8.0`, `cuda>=9.0` …: any valid CUDA version in the form `major.minor`.\n\n### `CUDA_VERSION`\nSimilar to `NVIDIA_REQUIRE_CUDA`, for legacy CUDA images.\nIn addition, if `NVIDIA_REQUIRE_CUDA` is not set, `NVIDIA_VISIBLE_DEVICES` and `NVIDIA_DRIVER_CAPABILITIES` will default to `all`.\n\n## Usage example\n\n**NOTE:** The use of the `nvidia-container-runtime` as CLI replacement for `runc` is uncommon and is only provided for completeness.\n\nAlthough the `nvidia-container-runtime` is typically configured as a replacement for `runc` or `crun` in various container engines, it can also be\ninvoked from the command line as `runc` would. For example:\n\n```sh\n# Setup a rootfs based on Ubuntu 16.04\ncd $(mktemp -d) && mkdir rootfs\ncurl -sS http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.6-base-amd64.tar.gz | tar --exclude 'dev/*' -C rootfs -xz\n\n# Create an OCI runtime spec\nnvidia-container-runtime spec\nsed -i 's;\"sh\";\"nvidia-smi\";' config.json\nsed -i 's;\\(\"TERM=xterm\"\\);\\1, \"NVIDIA_VISIBLE_DEVICES=0\";' config.json\n\n# Run the container\nsudo nvidia-container-runtime run nvidia_smi\n```\n"
},
{
"path": "cmd/nvidia-container-runtime/main.go",
"content": "package main\n\nimport (\n\t\"os\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/runtime\"\n)\n\nfunc main() {\n\tr := runtime.New()\n\terr := r.Run(os.Args)\n\tif err != nil {\n\t\tos.Exit(1)\n\t}\n}\n"
},
{
"path": "cmd/nvidia-container-runtime/main_test.go",
"content": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nconst (\n\tnvidiaRuntime = \"nvidia-container-runtime\"\n\tnvidiaHook = \"nvidia-container-runtime-hook\"\n\tbundlePathSuffix = \"tests/output/bundle/\"\n\tspecFile = \"config.json\"\n\tunmodifiedSpecFileSuffix = \"tests/input/test_spec.json\"\n)\n\nconst (\n\truncExecutableName = \"runc\"\n)\n\ntype testConfig struct {\n\troot string\n\tbinPath string\n}\n\nvar cfg *testConfig\n\nfunc TestMain(m *testing.M) {\n\t// TEST SETUP\n\t// Determine the module root and the test binary path\n\tvar err error\n\tmoduleRoot, err := test.GetModuleRoot()\n\tif err != nil {\n\t\tlog.Fatalf(\"error in test setup: could not get module root: %v\", err)\n\t}\n\ttestBinPath := filepath.Join(moduleRoot, \"tests\", \"bin\")\n\ttestInputPath := filepath.Join(moduleRoot, \"tests\", \"input\")\n\n\t// Set the environment variables for the test\n\tos.Setenv(\"PATH\", test.PrependToPath(testBinPath, moduleRoot))\n\tos.Setenv(\"XDG_CONFIG_HOME\", testInputPath)\n\n\t// Confirm that the environment is configured correctly\n\truncPath, err := exec.LookPath(runcExecutableName)\n\tif err != nil || filepath.Join(testBinPath, runcExecutableName) != runcPath {\n\t\tlog.Fatalf(\"error in test setup: mock runc path set incorrectly in TestMain(): %v\", err)\n\t}\n\thookPath, err := exec.LookPath(nvidiaHook)\n\tif err != nil || filepath.Join(testBinPath, nvidiaHook) != hookPath {\n\t\tlog.Fatalf(\"error in test setup: mock hook path set incorrectly in TestMain(): %v\", err)\n\t}\n\n\t// Store the root and binary paths in the test Config\n\tcfg = &testConfig{\n\t\troot: moduleRoot,\n\t\tbinPath: testBinPath,\n\t}\n\n\t// RUN TESTS\n\texitCode := m.Run()\n\n\t// TEST CLEANUP\n\tos.Remove(specFile)\n\n\tos.Exit(exitCode)\n}\n\n// case 1) nvidia-container-runtime run --bundle\n// case 2) nvidia-container-runtime create --bundle\n// - Confirm the runtime handles bad input correctly\nfunc TestBadInput(t *testing.T) {\n\terr := cfg.generateNewRuntimeSpec()\n\tif err != nil {\n\t\tt.Fatal(err)\n\t}\n\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\tcmdCreate := exec.Command(nvidiaRuntime, \"create\", \"--bundle\")\n\tt.Logf(\"executing: %s\\n\", strings.Join(cmdCreate.Args, \" \"))\n\terr = cmdCreate.Run()\n\trequire.Error(t, err, \"runtime should return an error\")\n}\n\n// case 1) nvidia-container-runtime run --bundle \n// - Confirm the runtime runs with no errors\n//\n// case 2) nvidia-container-runtime create --bundle \n// - Confirm the runtime inserts the NVIDIA prestart hook correctly\nfunc TestGoodInput(t *testing.T) {\n\terr := cfg.generateNewRuntimeSpec()\n\tif err != nil {\n\t\tt.Fatalf(\"error generating runtime spec: %v\", err)\n\t}\n\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\tcmdRun := exec.Command(nvidiaRuntime, \"run\", \"--bundle\", cfg.bundlePath(), \"testcontainer\")\n\tt.Logf(\"executing: %s\\n\", strings.Join(cmdRun.Args, \" \"))\n\toutput, err := cmdRun.CombinedOutput()\n\trequire.NoErrorf(t, err, \"runtime should not return an error\", \"output=%v\", string(output))\n\n\t// Check config.json and confirm there are no hooks\n\tspec, err := cfg.getRuntimeSpec()\n\trequire.NoError(t, err, \"should be no errors when reading and parsing spec from config.json\")\n\trequire.Empty(t, spec.Hooks, \"there should be no hooks in config.json\")\n\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\tcmdCreate := exec.Command(nvidiaRuntime, \"create\", \"--bundle\", cfg.bundlePath(), \"testcontainer\")\n\tt.Logf(\"executing: %s\\n\", strings.Join(cmdCreate.Args, \" \"))\n\terr = cmdCreate.Run()\n\trequire.NoError(t, err, \"runtime should not return an error\")\n\n\t// Check config.json to ensure that the NVIDIA prestart was not inserted.\n\tspec, err = cfg.getRuntimeSpec()\n\trequire.NoError(t, err, \"should be no errors when reading and parsing spec from config.json\")\n\trequire.Empty(t, spec.Hooks, \"there should be no hooks in config.json\")\n}\n\n// NVIDIA prestart hook already present in config file\nfunc TestDuplicateHook(t *testing.T) {\n\terr := cfg.generateNewRuntimeSpec()\n\tif err != nil {\n\t\tt.Fatal(err)\n\t}\n\n\tvar spec specs.Spec\n\tspec, err = cfg.getRuntimeSpec()\n\tif err != nil {\n\t\tt.Fatal(err)\n\t}\n\n\tt.Logf(\"inserting nvidia prestart hook to config.json\")\n\tif err = addNVIDIAHook(&spec); err != nil {\n\t\tt.Fatal(err)\n\t}\n\n\tjsonOutput, err := json.MarshalIndent(spec, \"\", \"\\t\")\n\tif err != nil {\n\t\tt.Fatal(err)\n\t}\n\n\tjsonFile, err := os.OpenFile(cfg.specFilePath(), os.O_RDWR, 0644)\n\tif err != nil {\n\t\tt.Fatal(err)\n\t}\n\t_, err = jsonFile.WriteAt(jsonOutput, 0)\n\tif err != nil {\n\t\tt.Fatal(err)\n\t}\n\n\t// Test how runtime handles already existing prestart hook in config.json\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\tcmdCreate := exec.Command(nvidiaRuntime, \"create\", \"--bundle\", cfg.bundlePath(), \"testcontainer\")\n\tt.Logf(\"executing: %s\\n\", strings.Join(cmdCreate.Args, \" \"))\n\toutput, err := cmdCreate.CombinedOutput()\n\trequire.NoErrorf(t, err, \"runtime should not return an error\", \"output=%v\", string(output))\n\n\t// Check config.json to ensure that the NVIDIA prestart hook was removed.\n\tspec, err = cfg.getRuntimeSpec()\n\trequire.NoError(t, err, \"should be no errors when reading and parsing spec from config.json\")\n\trequire.Empty(t, spec.Hooks, \"there should be no hooks in config.json\")\n}\n\n// addNVIDIAHook is a basic wrapper for an addHookModifier that is used for\n// testing.\nfunc addNVIDIAHook(spec *specs.Spec) error {\n\tif spec.Hooks != nil {\n\t\treturn fmt.Errorf(\"expected empty spec\")\n\t}\n\tspec.Hooks = &specs.Hooks{\n\t\tPrestart: []specs.Hook{\n\t\t\t{\n\t\t\t\tPath: nvidiaHook,\n\t\t\t\tArgs: []string{filepath.Base(nvidiaHook), \"prestart\"},\n\t\t\t},\n\t\t},\n\t}\n\treturn nil\n}\n\nfunc (c testConfig) getRuntimeSpec() (specs.Spec, error) {\n\tfilePath := c.specFilePath()\n\n\tvar spec specs.Spec\n\tjsonFile, err := os.OpenFile(filePath, os.O_RDWR, 0644)\n\tif err != nil {\n\t\treturn spec, err\n\t}\n\tdefer jsonFile.Close()\n\n\tjsonContent, err := io.ReadAll(jsonFile)\n\tswitch {\n\tcase err != nil:\n\t\treturn spec, err\n\tcase json.Valid(jsonContent):\n\t\terr = json.Unmarshal(jsonContent, &spec)\n\t\tif err != nil {\n\t\t\treturn spec, err\n\t\t}\n\tdefault:\n\t\terr = json.NewDecoder(bytes.NewReader(jsonContent)).Decode(&spec)\n\t\tif err != nil {\n\t\t\treturn spec, err\n\t\t}\n\t}\n\n\treturn spec, err\n}\n\nfunc (c testConfig) bundlePath() string {\n\treturn filepath.Join(c.root, bundlePathSuffix)\n}\n\nfunc (c testConfig) specFilePath() string {\n\treturn filepath.Join(c.bundlePath(), specFile)\n}\n\nfunc (c testConfig) unmodifiedSpecFile() string {\n\treturn filepath.Join(c.root, unmodifiedSpecFileSuffix)\n}\n\nfunc (c testConfig) generateNewRuntimeSpec() error {\n\tvar err error\n\n\terr = os.MkdirAll(c.bundlePath(), 0755)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\tcmd := exec.Command(\"cp\", c.unmodifiedSpecFile(), c.specFilePath())\n\terr = cmd.Run()\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-container-runtime-hook/capabilities.go",
"content": "package main\n\nimport (\n\t\"log\"\n)\n\nfunc capabilityToCLI(cap string) string {\n\tswitch cap {\n\tcase \"compute\":\n\t\treturn \"--compute\"\n\tcase \"compat32\":\n\t\treturn \"--compat32\"\n\tcase \"graphics\":\n\t\treturn \"--graphics\"\n\tcase \"utility\":\n\t\treturn \"--utility\"\n\tcase \"video\":\n\t\treturn \"--video\"\n\tcase \"display\":\n\t\treturn \"--display\"\n\tcase \"ngx\":\n\t\treturn \"--ngx\"\n\tdefault:\n\t\tlog.Panicln(\"unknown driver capability:\", cap)\n\t}\n\treturn \"\"\n}\n"
},
{
"path": "cmd/nvidia-container-runtime-hook/container_config.go",
"content": "package main\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"path\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\t\"golang.org/x/mod/semver\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n)\n\ntype nvidiaConfig struct {\n\tDevices []string\n\tMigConfigDevices string\n\tMigMonitorDevices string\n\tImexChannels []string\n\tDriverCapabilities string\n\t// Requirements defines the requirements DSL for the container to run.\n\t// This is empty if no specific requirements are needed, or if requirements are\n\t// explicitly disabled.\n\tRequirements []string\n}\n\ntype containerConfig struct {\n\tPid int\n\tRootfs string\n\tImage image.CUDA\n\tNvidia *nvidiaConfig\n}\n\n// Root from OCI runtime spec\n// github.com/opencontainers/runtime-spec/blob/v1.0.0/specs-go/config.go#L94-L100\ntype Root struct {\n\tPath string `json:\"path\"`\n}\n\n// Process from OCI runtime spec\n// github.com/opencontainers/runtime-spec/blob/v1.0.0/specs-go/config.go#L30-L57\ntype Process struct {\n\tEnv []string `json:\"env,omitempty\"`\n\tCapabilities *json.RawMessage `json:\"capabilities,omitempty\" platform:\"linux\"`\n}\n\n// LinuxCapabilities from OCI runtime spec\n// https://github.com/opencontainers/runtime-spec/blob/v1.0.0/specs-go/config.go#L61\ntype LinuxCapabilities struct {\n\tBounding []string `json:\"bounding,omitempty\" platform:\"linux\"`\n\tEffective []string `json:\"effective,omitempty\" platform:\"linux\"`\n\tInheritable []string `json:\"inheritable,omitempty\" platform:\"linux\"`\n\tPermitted []string `json:\"permitted,omitempty\" platform:\"linux\"`\n\tAmbient []string `json:\"ambient,omitempty\" platform:\"linux\"`\n}\n\n// Spec from OCI runtime spec\n// We use pointers to structs, similarly to the latest version of runtime-spec:\n// https://github.com/opencontainers/runtime-spec/blob/v1.0.0/specs-go/config.go#L5-L28\ntype Spec struct {\n\tVersion *string `json:\"ociVersion\"`\n\tProcess *Process `json:\"process,omitempty\"`\n\tRoot *Root `json:\"root,omitempty\"`\n\tMounts []specs.Mount `json:\"mounts,omitempty\"`\n}\n\n// HookState holds state information about the hook\ntype HookState struct {\n\tPid int `json:\"pid,omitempty\"`\n\t// After 17.06, runc is using the runtime spec:\n\t// github.com/docker/runc/blob/17.06/libcontainer/configs/config.go#L262-L263\n\t// github.com/opencontainers/runtime-spec/blob/v1.0.0/specs-go/state.go#L3-L17\n\tBundle string `json:\"bundle\"`\n\t// Before 17.06, runc used a custom struct that didn't conform to the spec:\n\t// github.com/docker/runc/blob/17.03.x/libcontainer/configs/config.go#L245-L252\n\tBundlePath string `json:\"bundlePath\"`\n}\n\nfunc loadSpec(path string) (spec *Spec) {\n\tf, err := os.Open(path)\n\tif err != nil {\n\t\tlog.Panicln(\"could not open OCI spec:\", err)\n\t}\n\tdefer f.Close()\n\n\tif err = json.NewDecoder(f).Decode(&spec); err != nil {\n\t\tlog.Panicln(\"could not decode OCI spec:\", err)\n\t}\n\tif spec.Version == nil {\n\t\tlog.Panicln(\"Version is empty in OCI spec\")\n\t}\n\tif spec.Process == nil {\n\t\tlog.Panicln(\"Process is empty in OCI spec\")\n\t}\n\tif spec.Root == nil {\n\t\tlog.Panicln(\"Root is empty in OCI spec\")\n\t}\n\treturn\n}\n\nfunc (s *Spec) GetCapabilities() []string {\n\tif s == nil || s.Process == nil || s.Process.Capabilities == nil {\n\t\treturn nil\n\t}\n\n\tvar caps []string\n\t// If v1.0.0-rc1 <= OCI version < v1.0.0-rc5 parse s.Process.Capabilities as:\n\t// github.com/opencontainers/runtime-spec/blob/v1.0.0-rc1/specs-go/config.go#L30-L54\n\trc1cmp := semver.Compare(\"v\"+*s.Version, \"v1.0.0-rc1\")\n\trc5cmp := semver.Compare(\"v\"+*s.Version, \"v1.0.0-rc5\")\n\tif (rc1cmp == 1 || rc1cmp == 0) && (rc5cmp == -1) {\n\t\terr := json.Unmarshal(*s.Process.Capabilities, &caps)\n\t\tif err != nil {\n\t\t\tlog.Panicln(\"could not decode Process.Capabilities in OCI spec:\", err)\n\t\t}\n\t\treturn caps\n\t}\n\n\t// Otherwise, parse s.Process.Capabilities as:\n\t// github.com/opencontainers/runtime-spec/blob/v1.0.0/specs-go/config.go#L30-L54\n\tcapabilities := specs.LinuxCapabilities{}\n\terr := json.Unmarshal(*s.Process.Capabilities, &capabilities)\n\tif err != nil {\n\t\tlog.Panicln(\"could not decode Process.Capabilities in OCI spec:\", err)\n\t}\n\n\treturn image.OCISpecCapabilities(capabilities).GetCapabilities()\n}\n\nfunc isPrivileged(s *Spec) bool {\n\treturn image.IsPrivileged(s)\n}\n\nfunc getMigConfigDevices(i image.CUDA) *string {\n\treturn getMigDevices(i, image.EnvVarNvidiaMigConfigDevices)\n}\n\nfunc getMigMonitorDevices(i image.CUDA) *string {\n\treturn getMigDevices(i, image.EnvVarNvidiaMigMonitorDevices)\n}\n\nfunc getMigDevices(image image.CUDA, envvar string) *string {\n\tif !image.HasEnvvar(envvar) {\n\t\treturn nil\n\t}\n\tdevices := image.Getenv(envvar)\n\treturn &devices\n}\n\nfunc (hookConfig *hookConfig) getDriverCapabilities(cudaImage image.CUDA, legacyImage bool) image.DriverCapabilities {\n\t// We use the default driver capabilities by default. This is filtered to only include the\n\t// supported capabilities\n\tsupportedDriverCapabilities := image.NewDriverCapabilities(hookConfig.SupportedDriverCapabilities)\n\tcapabilities := supportedDriverCapabilities.Intersection(image.DefaultDriverCapabilities)\n\n\tcapsEnvSpecified := cudaImage.HasEnvvar(image.EnvVarNvidiaDriverCapabilities)\n\tcapsEnv := cudaImage.Getenv(image.EnvVarNvidiaDriverCapabilities)\n\n\tif !capsEnvSpecified && legacyImage {\n\t\t// Environment variable unset with legacy image: set all capabilities.\n\t\treturn supportedDriverCapabilities\n\t}\n\n\tif capsEnvSpecified && len(capsEnv) > 0 {\n\t\t// If the envvironment variable is specified and is non-empty, use the capabilities value\n\t\tenvCapabilities := image.NewDriverCapabilities(capsEnv)\n\t\tcapabilities = supportedDriverCapabilities.Intersection(envCapabilities)\n\t\tif !envCapabilities.IsAll() && len(capabilities) != len(envCapabilities) {\n\t\t\tlog.Panicln(fmt.Errorf(\"unsupported capabilities found in '%v' (allowed '%v')\", envCapabilities, capabilities))\n\t\t}\n\t}\n\n\treturn capabilities\n}\n\nfunc (hookConfig *hookConfig) getNvidiaConfig(image image.CUDA, privileged bool) *nvidiaConfig {\n\tlegacyImage := image.IsLegacy()\n\n\tdevices := image.VisibleDevices()\n\tif len(devices) == 0 {\n\t\t// empty devices means this is not a GPU container.\n\t\treturn nil\n\t}\n\n\tvar migConfigDevices string\n\tif d := getMigConfigDevices(image); d != nil {\n\t\tmigConfigDevices = *d\n\t}\n\tif !privileged && migConfigDevices != \"\" {\n\t\tlog.Panicln(\"cannot set MIG_CONFIG_DEVICES in non privileged container\")\n\t}\n\n\tvar migMonitorDevices string\n\tif d := getMigMonitorDevices(image); d != nil {\n\t\tmigMonitorDevices = *d\n\t}\n\tif !privileged && migMonitorDevices != \"\" {\n\t\tlog.Panicln(\"cannot set MIG_MONITOR_DEVICES in non privileged container\")\n\t}\n\n\tdriverCapabilities := hookConfig.getDriverCapabilities(image, legacyImage).String()\n\n\trequirements, err := image.GetRequirements()\n\tif err != nil {\n\t\tlog.Panicln(\"failed to get requirements\", err)\n\t}\n\n\treturn &nvidiaConfig{\n\t\tDevices: devices,\n\t\tMigConfigDevices: migConfigDevices,\n\t\tMigMonitorDevices: migMonitorDevices,\n\t\tImexChannels: image.ImexChannelRequests(),\n\t\tDriverCapabilities: driverCapabilities,\n\t\tRequirements: requirements,\n\t}\n}\n\nfunc (hookConfig *hookConfig) getContainerConfig() (config *containerConfig) {\n\thookConfig.Lock()\n\tdefer hookConfig.Unlock()\n\n\tif hookConfig.containerConfig != nil {\n\t\treturn hookConfig.containerConfig\n\t}\n\n\tvar h HookState\n\td := json.NewDecoder(os.Stdin)\n\tif err := d.Decode(&h); err != nil {\n\t\tlog.Panicln(\"could not decode container state:\", err)\n\t}\n\n\tb := h.Bundle\n\tif len(b) == 0 {\n\t\tb = h.BundlePath\n\t}\n\n\ts := loadSpec(path.Join(b, \"config.json\"))\n\n\tprivileged := isPrivileged(s)\n\n\ti, err := image.New(\n\t\timage.WithEnv(s.Process.Env),\n\t\timage.WithMounts(s.Mounts),\n\t\timage.WithPrivileged(privileged),\n\t\timage.WithDisableRequire(hookConfig.DisableRequire),\n\t\timage.WithAcceptDeviceListAsVolumeMounts(hookConfig.AcceptDeviceListAsVolumeMounts),\n\t\timage.WithAcceptEnvvarUnprivileged(hookConfig.AcceptEnvvarUnprivileged),\n\t\timage.WithPreferredVisibleDevicesEnvVars(hookConfig.getSwarmResource()),\n\t\timage.WithIgnoreImexChannelRequests(hookConfig.Features.IgnoreImexChannelRequests.IsEnabled()),\n\t)\n\tif err != nil {\n\t\tlog.Panicln(err)\n\t}\n\n\tcc := containerConfig{\n\t\tPid: h.Pid,\n\t\tRootfs: s.Root.Path,\n\t\tImage: i,\n\t\tNvidia: hookConfig.getNvidiaConfig(i, privileged),\n\t}\n\thookConfig.containerConfig = &cc\n\n\treturn hookConfig.containerConfig\n}\n"
},
{
"path": "cmd/nvidia-container-runtime-hook/container_config_test.go",
"content": "package main\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n)\n\nfunc TestGetNvidiaConfig(t *testing.T) {\n\tvar tests = []struct {\n\t\tdescription string\n\t\tenv map[string]string\n\t\tprivileged bool\n\t\thookConfig *hookConfig\n\t\texpectedConfig *nvidiaConfig\n\t\texpectedPanic bool\n\t}{\n\t\t{\n\t\t\tdescription: \"No environment, unprivileged\",\n\t\t\tenv: map[string]string{},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"No environment, privileged\",\n\t\t\tenv: map[string]string{},\n\t\t\tprivileged: true,\n\t\t\texpectedConfig: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, no devices, no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices 'all', no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices 'empty', no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices 'void', no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"void\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices 'none', no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"none\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"\"},\n\t\t\t\tDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices set, no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices set, capabilities 'empty', no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices set, capabilities 'all', no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"all\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices set, capabilities set, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"video,display\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: \"display,video\",\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices set, capabilities set, requirements set\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"video,display\",\n\t\t\t\timage.NvidiaRequirePrefix + \"REQ0\": \"req0=true\",\n\t\t\t\timage.NvidiaRequirePrefix + \"REQ1\": \"req1=false\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: \"display,video\",\n\t\t\t\tRequirements: []string{\"cuda>=9.0\", \"req0=true\", \"req1=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Legacy image, devices set, capabilities set, requirements set, disable requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"video,display\",\n\t\t\t\timage.NvidiaRequirePrefix + \"REQ0\": \"req0=true\",\n\t\t\t\timage.NvidiaRequirePrefix + \"REQ1\": \"req1=false\",\n\t\t\t\timage.EnvVarNvidiaDisableRequire: \"true\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: \"display,video\",\n\t\t\t\tRequirements: []string{},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, no devices, no capabilities, no requirements, no image.EnvVarCudaVersion\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, no devices, no capabilities, no requirement, image.EnvVarCudaVersion set\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarCudaVersion: \"9.0\",\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices 'all', no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices 'empty', no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices 'void', no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"void\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices 'none', no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"none\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices set, no capabilities, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices set, capabilities 'empty', no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices set, capabilities 'all', no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"all\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices set, capabilities set, no requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"video,display\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: \"display,video\",\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices set, capabilities set, requirements set\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"video,display\",\n\t\t\t\timage.NvidiaRequirePrefix + \"REQ0\": \"req0=true\",\n\t\t\t\timage.NvidiaRequirePrefix + \"REQ1\": \"req1=false\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: \"display,video\",\n\t\t\t\tRequirements: []string{\"cuda>=9.0\", \"req0=true\", \"req1=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices set, capabilities set, requirements set, disable requirements\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"gpu0,gpu1\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"video,display\",\n\t\t\t\timage.NvidiaRequirePrefix + \"REQ0\": \"req0=true\",\n\t\t\t\timage.NvidiaRequirePrefix + \"REQ1\": \"req1=false\",\n\t\t\t\timage.EnvVarNvidiaDisableRequire: \"true\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"gpu0\", \"gpu1\"},\n\t\t\t\tDriverCapabilities: \"display,video\",\n\t\t\t\tRequirements: []string{},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"No cuda envs, devices 'all'\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t},\n\t\t\tprivileged: false,\n\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices 'all', migConfig set, privileged\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t\timage.EnvVarNvidiaMigConfigDevices: \"mig0,mig1\",\n\t\t\t},\n\t\t\tprivileged: true,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tMigConfigDevices: \"mig0,mig1\",\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices 'all', migConfig set, unprivileged\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t\timage.EnvVarNvidiaMigConfigDevices: \"mig0,mig1\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedPanic: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices 'all', migMonitor set, privileged\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t\timage.EnvVarNvidiaMigMonitorDevices: \"mig0,mig1\",\n\t\t\t},\n\t\t\tprivileged: true,\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tMigMonitorDevices: \"mig0,mig1\",\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t\tRequirements: []string{\"cuda>=9.0\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Modern image, devices 'all', migMonitor set, unprivileged\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaRequireCuda: \"cuda>=9.0\",\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t\timage.EnvVarNvidiaMigMonitorDevices: \"mig0,mig1\",\n\t\t\t},\n\t\t\tprivileged: false,\n\t\t\texpectedPanic: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Hook config set as driver-capabilities-all\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"all\",\n\t\t\t},\n\t\t\tprivileged: true,\n\t\t\thookConfig: &hookConfig{\n\t\t\t\tConfig: &config.Config{\n\t\t\t\t\tSupportedDriverCapabilities: \"video,display\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tDriverCapabilities: \"display,video\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Hook config set, envvar sets driver-capabilities\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"video,display\",\n\t\t\t},\n\t\t\tprivileged: true,\n\t\t\thookConfig: &hookConfig{\n\t\t\t\tConfig: &config.Config{\n\t\t\t\t\tSupportedDriverCapabilities: \"video,display,compute,utility\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tDriverCapabilities: \"display,video\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Hook config set, envvar unset sets default driver-capabilities\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t},\n\t\t\tprivileged: true,\n\t\t\thookConfig: &hookConfig{\n\t\t\t\tConfig: &config.Config{\n\t\t\t\t\tSupportedDriverCapabilities: \"video,display,utility,compute\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"all\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Hook config set, swarmResource overrides device selection\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t\t\"DOCKER_SWARM_RESOURCE\": \"GPU1,GPU2\",\n\t\t\t},\n\t\t\tprivileged: true,\n\t\t\thookConfig: &hookConfig{\n\t\t\t\tConfig: &config.Config{\n\t\t\t\t\tSwarmResource: \"DOCKER_SWARM_RESOURCE\",\n\t\t\t\t\tSupportedDriverCapabilities: \"video,display,utility,compute\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"GPU1\", \"GPU2\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Hook config set, comma separated swarmResource is split and overrides device selection\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaVisibleDevices: \"all\",\n\t\t\t\t\"DOCKER_SWARM_RESOURCE\": \"GPU1,GPU2\",\n\t\t\t},\n\t\t\tprivileged: true,\n\t\t\thookConfig: &hookConfig{\n\t\t\t\tConfig: &config.Config{\n\t\t\t\t\tSwarmResource: \"NOT_DOCKER_SWARM_RESOURCE,DOCKER_SWARM_RESOURCE\",\n\t\t\t\t\tSupportedDriverCapabilities: \"video,display,utility,compute\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: &nvidiaConfig{\n\t\t\t\tDevices: []string{\"GPU1\", \"GPU2\"},\n\t\t\t\tDriverCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t\t},\n\t\t},\n\t}\n\tfor _, tc := range tests {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\timage, _ := image.New(\n\t\t\t\timage.WithEnvMap(tc.env),\n\t\t\t\timage.WithPrivileged(tc.privileged),\n\t\t\t\timage.WithPreferredVisibleDevicesEnvVars(tc.hookConfig.getSwarmResource()),\n\t\t\t)\n\n\t\t\t// Wrap the call to getNvidiaConfig() in a closure.\n\t\t\tvar cfg *nvidiaConfig\n\t\t\tgetConfig := func() {\n\t\t\t\thookCfg := tc.hookConfig\n\t\t\t\tif hookCfg == nil {\n\t\t\t\t\tdefaultConfig, _ := config.GetDefault()\n\t\t\t\t\thookCfg = &hookConfig{Config: defaultConfig}\n\t\t\t\t}\n\t\t\t\tcfg = hookCfg.getNvidiaConfig(image, tc.privileged)\n\t\t\t}\n\n\t\t\t// For any tests that are expected to panic, make sure they do.\n\t\t\tif tc.expectedPanic {\n\t\t\t\trequire.Panics(t, getConfig)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\t// For all other tests, just grab the config\n\t\t\tgetConfig()\n\n\t\t\t// And start comparing the test results to the expected results.\n\t\t\tif tc.expectedConfig == nil {\n\t\t\t\trequire.Nil(t, cfg, tc.description)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\trequire.NotNil(t, cfg, tc.description)\n\n\t\t\trequire.Equal(t, tc.expectedConfig.Devices, cfg.Devices)\n\t\t\trequire.Equal(t, tc.expectedConfig.MigConfigDevices, cfg.MigConfigDevices)\n\t\t\trequire.Equal(t, tc.expectedConfig.MigMonitorDevices, cfg.MigMonitorDevices)\n\t\t\trequire.Equal(t, tc.expectedConfig.DriverCapabilities, cfg.DriverCapabilities)\n\n\t\t\trequire.ElementsMatch(t, tc.expectedConfig.Requirements, cfg.Requirements)\n\t\t})\n\t}\n}\n\nfunc TestGetDriverCapabilities(t *testing.T) {\n\n\tsupportedCapabilities := \"compute,display,utility,video\"\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tenv map[string]string\n\t\tlegacyImage bool\n\t\tsupportedCapabilities string\n\t\texpectedPanic bool\n\t\texpectedCapabilities string\n\t}{\n\t\t{\n\t\t\tdescription: \"Env is set for legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"display,video\",\n\t\t\t},\n\t\t\tlegacyImage: true,\n\t\t\tsupportedCapabilities: supportedCapabilities,\n\t\t\texpectedCapabilities: \"display,video\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"Env is all for legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"all\",\n\t\t\t},\n\t\t\tlegacyImage: true,\n\t\t\tsupportedCapabilities: supportedCapabilities,\n\t\t\texpectedCapabilities: supportedCapabilities,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Env is empty for legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"\",\n\t\t\t},\n\t\t\tlegacyImage: true,\n\t\t\tsupportedCapabilities: supportedCapabilities,\n\t\t\texpectedCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Env unset for legacy image is 'all'\",\n\t\t\tenv: map[string]string{},\n\t\t\tlegacyImage: true,\n\t\t\tsupportedCapabilities: supportedCapabilities,\n\t\t\texpectedCapabilities: supportedCapabilities,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Env is set for modern image\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"display,video\",\n\t\t\t},\n\t\t\tlegacyImage: false,\n\t\t\tsupportedCapabilities: supportedCapabilities,\n\t\t\texpectedCapabilities: \"display,video\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"Env unset for modern image is default\",\n\t\t\tenv: map[string]string{},\n\t\t\tlegacyImage: false,\n\t\t\tsupportedCapabilities: supportedCapabilities,\n\t\t\texpectedCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Env is all for modern image\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"all\",\n\t\t\t},\n\t\t\tlegacyImage: false,\n\t\t\tsupportedCapabilities: supportedCapabilities,\n\t\t\texpectedCapabilities: supportedCapabilities,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Env is empty for modern image\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"\",\n\t\t\t},\n\t\t\tlegacyImage: false,\n\t\t\tsupportedCapabilities: supportedCapabilities,\n\t\t\texpectedCapabilities: image.DefaultDriverCapabilities.String(),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Invalid capabilities panic\",\n\t\t\tenv: map[string]string{\n\t\t\t\timage.EnvVarNvidiaDriverCapabilities: \"compute,utility\",\n\t\t\t},\n\t\t\tsupportedCapabilities: \"not-compute,not-utility\",\n\t\t\texpectedPanic: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Default is restricted for modern image\",\n\t\t\tlegacyImage: false,\n\t\t\tsupportedCapabilities: \"compute\",\n\t\t\texpectedCapabilities: \"compute\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tvar capabilities string\n\n\t\t\tc := hookConfig{\n\t\t\t\tConfig: &config.Config{\n\t\t\t\t\tSupportedDriverCapabilities: tc.supportedCapabilities,\n\t\t\t\t},\n\t\t\t}\n\n\t\t\timage, _ := image.New(\n\t\t\t\timage.WithEnvMap(tc.env),\n\t\t\t)\n\t\t\tgetDriverCapabilities := func() {\n\t\t\t\tcapabilities = c.getDriverCapabilities(image, tc.legacyImage).String()\n\t\t\t}\n\n\t\t\tif tc.expectedPanic {\n\t\t\t\trequire.Panics(t, getDriverCapabilities)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\tgetDriverCapabilities()\n\t\t\trequire.EqualValues(t, tc.expectedCapabilities, capabilities)\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-container-runtime-hook/hook_config.go",
"content": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"reflect\"\n\t\"sync\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n)\n\n// hookConfig wraps the toolkit config.\n// This allows for functions to be defined on the local type.\ntype hookConfig struct {\n\tsync.Mutex\n\t*config.Config\n\tcontainerConfig *containerConfig\n}\n\n// loadConfig loads the required paths for the hook config.\nfunc loadConfig() (*config.Config, error) {\n\tconfigFilePath, required := getConfigFilePath()\n\tcfg, err := config.New(\n\t\tconfig.WithConfigFile(configFilePath),\n\t\tconfig.WithRequired(true),\n\t)\n\tif err == nil {\n\t\treturn cfg.Config()\n\t} else if os.IsNotExist(err) && !required {\n\t\treturn config.GetDefault()\n\t}\n\treturn nil, fmt.Errorf(\"couldn't open required configuration file: %v\", err)\n}\n\nfunc getConfigFilePath() (string, bool) {\n\tif configFromFlag := *configflag; configFromFlag != \"\" {\n\t\treturn configFromFlag, true\n\t}\n\tif configFromEnvvar := os.Getenv(config.FilePathOverrideEnvVar); configFromEnvvar != \"\" {\n\t\treturn configFromEnvvar, true\n\t}\n\treturn config.GetConfigFilePath(), false\n}\n\nfunc getHookConfig() (*hookConfig, error) {\n\tcfg, err := loadConfig()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to load config: %v\", err)\n\t}\n\tconfig := &hookConfig{Config: cfg}\n\n\tallSupportedDriverCapabilities := image.SupportedDriverCapabilities\n\tif config.SupportedDriverCapabilities == \"all\" {\n\t\tconfig.SupportedDriverCapabilities = allSupportedDriverCapabilities.String()\n\t}\n\tconfiguredCapabilities := image.NewDriverCapabilities(config.SupportedDriverCapabilities)\n\t// We ensure that the configured value is a subset of all supported capabilities\n\tif !allSupportedDriverCapabilities.IsSuperset(configuredCapabilities) {\n\t\tconfigName := config.getConfigOption(\"SupportedDriverCapabilities\")\n\t\tlog.Panicf(\"Invalid value for config option '%v'; %v (supported: %v)\\n\", configName, config.SupportedDriverCapabilities, allSupportedDriverCapabilities.String())\n\t}\n\n\treturn config, nil\n}\n\n// getConfigOption returns the toml config option associated with the\n// specified struct field.\nfunc (c *hookConfig) getConfigOption(fieldName string) string {\n\tt := reflect.TypeOf(&c)\n\tf, ok := t.FieldByName(fieldName)\n\tif !ok {\n\t\treturn fieldName\n\t}\n\tv, ok := f.Tag.Lookup(\"toml\")\n\tif !ok {\n\t\treturn fieldName\n\t}\n\treturn v\n}\n\n// getSwarmResource returns the swarm resource envvars for the config.\nfunc (c *hookConfig) getSwarmResource() string {\n\tif c == nil {\n\t\treturn \"\"\n\t}\n\treturn c.SwarmResource\n}\n\n// nvidiaContainerCliCUDACompatModeFlags returns required --cuda-compat-mode\n// flag(s) depending on the hook and runtime configurations.\nfunc (c *hookConfig) nvidiaContainerCliCUDACompatModeFlags() []string {\n\tvar flag string\n\tswitch c.NVIDIAContainerRuntimeConfig.Modes.Legacy.CUDACompatMode {\n\tcase config.CUDACompatModeLdconfig:\n\t\tflag = \"--cuda-compat-mode=ldconfig\"\n\tcase config.CUDACompatModeMount:\n\t\tflag = \"--cuda-compat-mode=mount\"\n\tcase config.CUDACompatModeDisabled, config.CUDACompatModeHook:\n\t\tflag = \"--cuda-compat-mode=disabled\"\n\tdefault:\n\t\tif !c.Features.AllowCUDACompatLibsFromContainer.IsEnabled() {\n\t\t\tflag = \"--cuda-compat-mode=disabled\"\n\t\t}\n\t}\n\n\tif flag == \"\" {\n\t\treturn nil\n\t}\n\treturn []string{flag}\n}\n\nfunc (c *hookConfig) assertModeIsLegacy() error {\n\tif c.NVIDIAContainerRuntimeHookConfig.SkipModeDetection {\n\t\treturn nil\n\t}\n\n\tmr := info.NewRuntimeModeResolver(\n\t\tinfo.WithLogger(&logInterceptor{}),\n\t\tinfo.WithImage(&c.containerConfig.Image),\n\t\tinfo.WithDefaultMode(info.LegacyRuntimeMode),\n\t)\n\n\tmode := mr.ResolveRuntimeMode(c.NVIDIAContainerRuntimeConfig.Mode)\n\tif mode == \"legacy\" {\n\t\treturn nil\n\t}\n\treturn fmt.Errorf(\"invoking the NVIDIA Container Runtime Hook directly (e.g. specifying the docker --gpus flag) is not supported. Please use the NVIDIA Container Runtime (e.g. specify the --runtime=nvidia flag) instead\")\n}\n"
},
{
"path": "cmd/nvidia-container-runtime-hook/hook_config_test.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage main\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n)\n\nfunc TestGetHookConfig(t *testing.T) {\n\ttestCases := []struct {\n\t\tlines []string\n\t\texpectedPanic bool\n\t\texpectedDriverCapabilities string\n\t}{\n\t\t{\n\t\t\texpectedDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t},\n\t\t{\n\t\t\tlines: []string{\n\t\t\t\t\"supported-driver-capabilities = \\\"all\\\"\",\n\t\t\t},\n\t\t\texpectedDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t},\n\t\t{\n\t\t\tlines: []string{\n\t\t\t\t\"supported-driver-capabilities = \\\"compute,utility,not-compute\\\"\",\n\t\t\t},\n\t\t\texpectedPanic: true,\n\t\t},\n\t\t{\n\t\t\tlines: []string{},\n\t\t\texpectedDriverCapabilities: image.SupportedDriverCapabilities.String(),\n\t\t},\n\t\t{\n\t\t\tlines: []string{\n\t\t\t\t\"supported-driver-capabilities = \\\"\\\"\",\n\t\t\t},\n\t\t\texpectedDriverCapabilities: \"\",\n\t\t},\n\t\t{\n\t\t\tlines: []string{\n\t\t\t\t\"supported-driver-capabilities = \\\"compute,utility\\\"\",\n\t\t\t},\n\t\t\texpectedDriverCapabilities: \"compute,utility\",\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"test case %d\", i), func(t *testing.T) {\n\t\t\tvar filename string\n\t\t\tdefer func() {\n\t\t\t\tif len(filename) > 0 {\n\t\t\t\t\tos.Remove(filename)\n\t\t\t\t}\n\t\t\t\tconfigflag = nil\n\t\t\t}()\n\n\t\t\tif tc.lines != nil {\n\t\t\t\tconfigFile, err := os.CreateTemp(\"\", \"*.toml\")\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\tdefer configFile.Close()\n\n\t\t\t\tfilename = configFile.Name()\n\t\t\t\tconfigflag = &filename\n\n\t\t\t\tfor _, line := range tc.lines {\n\t\t\t\t\t_, err := fmt.Fprintf(configFile, \"%s\\n\", line)\n\t\t\t\t\trequire.NoError(t, err)\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tvar cfg *hookConfig\n\t\t\tgetHookConfig := func() {\n\t\t\t\tc, _ := getHookConfig()\n\t\t\t\tcfg = c\n\t\t\t}\n\n\t\t\tif tc.expectedPanic {\n\t\t\t\trequire.Panics(t, getHookConfig)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\tgetHookConfig()\n\n\t\t\trequire.EqualValues(t, tc.expectedDriverCapabilities, cfg.SupportedDriverCapabilities)\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-container-runtime-hook/hook_test.go",
"content": "package main\n\nimport (\n\t\"encoding/json\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestIsPrivileged(t *testing.T) {\n\tvar tests = []struct {\n\t\tspec string\n\t\texpected bool\n\t}{\n\t\t{\n\t\t\t`\n\t\t\t{\n\t\t\t\t\"ociVersion\": \"1.0.0\",\n\t\t\t\t\"process\": {\n\t\t\t\t\t\"capabilities\": {\n\t\t\t\t\t\t\"bounding\": [ \"CAP_SYS_ADMIN\" ]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\t`,\n\t\t\ttrue,\n\t\t},\n\t\t{\n\t\t\t`\n\t\t\t{\n\t\t\t\t\"ociVersion\": \"1.0.0\",\n\t\t\t\t\"process\": {\n\t\t\t\t\t\"capabilities\": {\n\t\t\t\t\t\t\"bounding\": [ \"CAP_SYS_OTHER\" ]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\t`,\n\t\t\tfalse,\n\t\t},\n\t\t{\n\t\t\t`\n\t\t\t{\n\t\t\t\t\"ociVersion\": \"1.0.0\",\n\t\t\t\t\"process\": {}\n\t\t\t}\n\t\t\t`,\n\t\t\tfalse,\n\t\t},\n\t\t{\n\t\t\t`\n\t\t\t{\n\t\t\t\t\"ociVersion\": \"1.0.0-rc2-dev\",\n\t\t\t\t\"process\": {\n\t\t\t\t\t\"capabilities\": [ \"CAP_SYS_ADMIN\" ]\n\t\t\t\t}\n\t\t\t}\n\t\t\t`,\n\t\t\ttrue,\n\t\t},\n\t\t{\n\t\t\t`\n\t\t\t{\n\t\t\t\t\"ociVersion\": \"1.0.0-rc2-dev\",\n\t\t\t\t\"process\": {\n\t\t\t\t\t\"capabilities\": [ \"CAP_SYS_OTHER\" ]\n\t\t\t\t}\n\t\t\t}\n\t\t\t`,\n\t\t\tfalse,\n\t\t},\n\t\t{\n\t\t\t`\n\t\t\t{\n\t\t\t\t\"ociVersion\": \"1.0.0-rc2-dev\",\n\t\t\t\t\"process\": {}\n\t\t\t}\n\t\t\t`,\n\t\t\tfalse,\n\t\t},\n\t}\n\tfor i, tc := range tests {\n\t\tvar spec Spec\n\t\t_ = json.Unmarshal([]byte(tc.spec), &spec)\n\t\tprivileged := isPrivileged(&spec)\n\n\t\trequire.Equal(t, tc.expected, privileged, \"%d: %v\", i, tc)\n\t}\n}\n"
},
{
"path": "cmd/nvidia-container-runtime-hook/main.go",
"content": "package main\n\nimport (\n\t\"flag\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"runtime/debug\"\n\t\"strconv\"\n\t\"strings\"\n\t\"syscall\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nvar (\n\tdebugflag = flag.Bool(\"debug\", false, \"enable debug output\")\n\tversionflag = flag.Bool(\"version\", false, \"enable version output\")\n\tconfigflag = flag.String(\"config\", \"\", \"configuration file\")\n)\n\nfunc exit() {\n\tif err := recover(); err != nil {\n\t\tif _, ok := err.(runtime.Error); ok {\n\t\t\tlog.Println(err)\n\t\t}\n\t\tif *debugflag {\n\t\t\tlog.Printf(\"%s\", debug.Stack())\n\t\t}\n\t\tos.Exit(1)\n\t}\n\tos.Exit(0)\n}\n\nfunc getCLIPath(config config.ContainerCLIConfig) string {\n\tif config.Path != \"\" {\n\t\treturn config.Path\n\t}\n\n\tif err := os.Setenv(\"PATH\", lookup.GetPath(config.Root)); err != nil {\n\t\tlog.Panicln(\"couldn't set PATH variable:\", err)\n\t}\n\n\tpath, err := exec.LookPath(\"nvidia-container-cli\")\n\tif err != nil {\n\t\tlog.Panicf(\"couldn't find binary nvidia-container-cli in PATH: %v\", err)\n\t}\n\treturn path\n}\n\n// getRootfsPath returns an absolute path. We don't need to resolve symlinks for now.\nfunc getRootfsPath(config *containerConfig) string {\n\trootfs, err := filepath.Abs(config.Rootfs)\n\tif err != nil {\n\t\tlog.Panicln(err)\n\t}\n\treturn rootfs\n}\n\nfunc doPrestart() {\n\tvar err error\n\n\tdefer exit()\n\tlog.SetFlags(0)\n\n\thook, err := getHookConfig()\n\tif err != nil || hook == nil {\n\t\tlog.Panicln(\"error getting hook config:\", err)\n\t}\n\tcli := hook.NVIDIAContainerCLIConfig\n\n\tcontainer := hook.getContainerConfig()\n\tnvidia := container.Nvidia\n\tif nvidia == nil {\n\t\t// Not a GPU container, nothing to do.\n\t\treturn\n\t}\n\n\tif err := hook.assertModeIsLegacy(); err != nil {\n\t\tlog.Panicf(\"%v\", err)\n\t}\n\n\trootfs := getRootfsPath(container)\n\n\targs := []string{getCLIPath(cli)}\n\tif cli.Root != \"\" {\n\t\targs = append(args, fmt.Sprintf(\"--root=%s\", cli.Root))\n\t}\n\tif cli.LoadKmods {\n\t\targs = append(args, \"--load-kmods\")\n\t}\n\tif hook.Features.DisableImexChannelCreation.IsEnabled() {\n\t\targs = append(args, \"--no-create-imex-channels\")\n\t}\n\tif cli.NoPivot {\n\t\targs = append(args, \"--no-pivot\")\n\t}\n\tif *debugflag {\n\t\targs = append(args, \"--debug=/dev/stderr\")\n\t} else if cli.Debug != \"\" {\n\t\targs = append(args, fmt.Sprintf(\"--debug=%s\", cli.Debug))\n\t}\n\tif cli.Ldcache != \"\" {\n\t\targs = append(args, fmt.Sprintf(\"--ldcache=%s\", cli.Ldcache))\n\t}\n\tif cli.User != \"\" {\n\t\targs = append(args, fmt.Sprintf(\"--user=%s\", cli.User))\n\t}\n\targs = append(args, \"configure\")\n\n\targs = append(args, hook.nvidiaContainerCliCUDACompatModeFlags()...)\n\n\tif ldconfigPath := cli.NormalizeLDConfigPath(); ldconfigPath != \"\" {\n\t\targs = append(args, fmt.Sprintf(\"--ldconfig=%s\", ldconfigPath))\n\t}\n\tif cli.NoCgroups {\n\t\targs = append(args, \"--no-cgroups\")\n\t}\n\tif devicesString := strings.Join(nvidia.Devices, \",\"); len(devicesString) > 0 {\n\t\targs = append(args, fmt.Sprintf(\"--device=%s\", devicesString))\n\t}\n\tif len(nvidia.MigConfigDevices) > 0 {\n\t\targs = append(args, fmt.Sprintf(\"--mig-config=%s\", nvidia.MigConfigDevices))\n\t}\n\tif len(nvidia.MigMonitorDevices) > 0 {\n\t\targs = append(args, fmt.Sprintf(\"--mig-monitor=%s\", nvidia.MigMonitorDevices))\n\t}\n\tif imexString := strings.Join(nvidia.ImexChannels, \",\"); len(imexString) > 0 {\n\t\targs = append(args, fmt.Sprintf(\"--imex-channel=%s\", imexString))\n\t}\n\n\tfor _, cap := range strings.Split(nvidia.DriverCapabilities, \",\") {\n\t\tif len(cap) == 0 {\n\t\t\tbreak\n\t\t}\n\t\targs = append(args, capabilityToCLI(cap))\n\t}\n\n\tfor _, req := range nvidia.Requirements {\n\t\targs = append(args, fmt.Sprintf(\"--require=%s\", req))\n\t}\n\n\targs = append(args, fmt.Sprintf(\"--pid=%s\", strconv.FormatUint(uint64(container.Pid), 10)))\n\targs = append(args, rootfs)\n\n\tenv := append(os.Environ(), cli.Environment...)\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection?\n\terr = syscall.Exec(args[0], args, env)\n\tlog.Panicln(\"exec failed:\", err)\n}\n\nfunc usage() {\n\tfmt.Fprintf(os.Stderr, \"Usage of nvidia-container-runtime-hook:\\n\")\n\tflag.PrintDefaults()\n\tfmt.Fprintf(os.Stderr, \"\\nCommands:\\n\")\n\tfmt.Fprintf(os.Stderr, \" prestart\\n run the prestart hook\\n\")\n\tfmt.Fprintf(os.Stderr, \" poststart\\n no-op\\n\")\n\tfmt.Fprintf(os.Stderr, \" poststop\\n no-op\\n\")\n}\n\nfunc main() {\n\tflag.Usage = usage\n\tflag.Parse()\n\n\tif *versionflag {\n\t\tfmt.Printf(\"%v version %v\\n\", \"NVIDIA Container Runtime Hook\", info.GetVersionString())\n\t\treturn\n\t}\n\n\targs := flag.Args()\n\tif len(args) == 0 {\n\t\tflag.Usage()\n\t\tos.Exit(2)\n\t}\n\n\tswitch args[0] {\n\tcase \"prestart\":\n\t\tdoPrestart()\n\t\tos.Exit(0)\n\tcase \"poststart\":\n\t\tfallthrough\n\tcase \"poststop\":\n\t\tos.Exit(0)\n\tdefault:\n\t\tflag.Usage()\n\t\tos.Exit(2)\n\t}\n}\n\n// logInterceptor implements the logger.Interface to allow for logging from executable.\ntype logInterceptor struct {\n\tlogger.NullLogger\n}\n\nfunc (l *logInterceptor) Infof(format string, args ...interface{}) {\n\tlog.Printf(format, args...)\n}\n"
},
{
"path": "cmd/nvidia-container-runtime.cdi/main.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage main\n\nimport (\n\t\"os\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/runtime\"\n)\n\nfunc main() {\n\trt := runtime.New(\n\t\truntime.WithModeOverride(\"cdi\"),\n\t)\n\n\terr := rt.Run(os.Args)\n\tif err != nil {\n\t\tos.Exit(1)\n\t}\n}\n"
},
{
"path": "cmd/nvidia-container-runtime.legacy/main.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage main\n\nimport (\n\t\"os\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/runtime\"\n)\n\nfunc main() {\n\trt := runtime.New(\n\t\truntime.WithModeOverride(\"legacy\"),\n\t)\n\n\terr := rt.Run(os.Args)\n\tif err != nil {\n\t\tos.Exit(1)\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk/README.md",
"content": "# NVIDIA Container Toolkit CLI\n\nThe NVIDIA Container Toolkit CLI `nvidia-ctk` provides a number of utilities that are useful for working with the NVIDIA Container Toolkit.\n\n## Functionality\n\n### Configure runtimes\n\nThe `runtime` command of the `nvidia-ctk` CLI provides a set of utilities to related to the configuration\nand management of supported container engines.\n\nFor example, running the following command:\n```bash\nnvidia-ctk runtime configure --set-as-default\n```\nwill ensure that the NVIDIA Container Runtime is added as the default runtime to the default container\nengine.\n\n## Configure the NVIDIA Container Toolkit\n\nThe `config` command of the `nvidia-ctk` CLI allows a user to display and manipulate the NVIDIA Container Toolkit\nconfiguration.\n\nFor example, running the following command:\n```bash\nnvidia-ctk config default\n```\nwill display the default config for the detected platform.\n\nWhereas\n```bash\nnvidia-ctk config\n```\nwill display the effective NVIDIA Container Toolkit config using the configured config file, and running:\n\nIndividual config options can be set by specifying these are key-value pairs to the `--set` argument:\n\n```bash\nnvidia-ctk config --set nvidia-container-cli.no-cgroups=true\n```\n\nBy default, all commands output to `STDOUT`, but specifying the `--output` flag writes the config to the specified file.\n\n### Generate CDI specifications\n\nThe [Container Device Interface (CDI)](https://tags.cncf.io/container-device-interface) provides\na vendor-agnostic mechanism to make arbitrary devices accessible in containerized environments. To allow NVIDIA devices to be\nused in these environments, the NVIDIA Container Toolkit CLI includes functionality to generate a CDI specification for the\navailable NVIDIA GPUs in a system.\n\nIn order to generate the CDI specification for the available devices, run the following command:\\\n```bash\nnvidia-ctk cdi generate\n```\n\nThe default is to print the specification to STDOUT and a filename can be specified using the `--output` flag.\n\nThe specification will contain a device entries as follows (where applicable):\n* An `nvidia.com/gpu=gpu{INDEX}` device for each non-MIG-enabled full GPU in the system\n* An `nvidia.com/gpu=mig{GPU_INDEX}:{MIG_INDEX}` device for each MIG-device in the system\n* A special device called `nvidia.com/gpu=all` which represents all available devices.\n\nFor example, to generate the CDI specification in the default location where CDI-enabled tools such as `podman`, `containerd`, `cri-o`, or the NVIDIA Container Runtime can be configured to load it, the following command can be run:\n\n```bash\nsudo nvidia-ctk cdi generate --output=/etc/cdi/nvidia.yaml\n```\n(Note that `sudo` is used to ensure the correct permissions to write to the `/etc/cdi` folder)\n\nWith the specification generated, a GPU can be requested by specifying the fully-qualified CDI device name. With `podman` as an exmaple:\n```bash\npodman run --rm -ti --device=nvidia.com/gpu=gpu0 ubuntu nvidia-smi -L\n```\n"
},
{
"path": "cmd/nvidia-ctk/cdi/cdi.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cdi\n\nimport (\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/cdi/generate\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/cdi/list\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/cdi/transform\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n\tconfigFilePath *string\n}\n\n// NewCommand constructs a cdi command with the specified logger\nfunc NewCommand(logger logger.Interface, configFilePath *string) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t\tconfigFilePath: configFilePath,\n\t}\n\treturn c.build()\n}\n\n// build\nfunc (m command) build() *cli.Command {\n\t// Create the 'cdi' command\n\tcdi := cli.Command{\n\t\tName: \"cdi\",\n\t\tUsage: \"Provide tools for interacting with Container Device Interface specifications\",\n\t\tCommands: []*cli.Command{\n\t\t\tgenerate.NewCommand(m.logger, m.configFilePath),\n\t\t\tlist.NewCommand(m.logger),\n\t\t\ttransform.NewCommand(m.logger),\n\t\t},\n\t}\n\n\treturn &cdi\n}\n"
},
{
"path": "cmd/nvidia-ctk/cdi/generate/config.go",
"content": "/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage generate\n\nimport (\n\t\"fmt\"\n\t\"sync\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\n\taltsrc \"github.com/urfave/cli-altsrc/v3\"\n\t\"github.com/urfave/cli/v3\"\n)\n\n// New sets the source for the config file path.\n// It uses a string pointer to the config file path option.\nfunc New(config *string) *configAsValueSource {\n\treturn &configAsValueSource{\n\t\tsource: altsrc.NewStringPtrSourcer(config),\n\t}\n}\n\n// configAsValueSource provides flag values from a TOML configuration file, acting as a factory for specific cli.ValueSource instances.\n// It uses an altsrc.Sourcer to find the configuration file path and loads it on demand.\ntype configAsValueSource struct {\n\tsync.Mutex\n\tsource altsrc.Sourcer\n\t*config.Toml\n}\n\n// ValueFrom returns a cli.ValueSource for the given key.\n// This can be used in the Sources chain for a cli.Flag.\nfunc (c *configAsValueSource) ValueFrom(key string) cli.ValueSource {\n\treturn &configValueLookup{\n\t\tkey: key,\n\t\tfrom: c,\n\t}\n}\n\nfunc (c *configAsValueSource) Get(key string) interface{} {\n\tc.Lock()\n\tdefer c.Unlock()\n\n\tif c.Toml == nil {\n\t\tif err := c.loadFromConfig(); err != nil {\n\t\t\treturn nil\n\t\t}\n\t}\n\n\tif c.Toml == nil {\n\t\treturn nil\n\t}\n\n\treturn c.Toml.Get(key)\n}\n\n// loadFromConfig loads the config file if it has not already been loaded.\n// If the config file path is not specified, it uses the default config file path.\nfunc (c *configAsValueSource) loadFromConfig() error {\n\tif c.Toml != nil {\n\t\treturn nil\n\t}\n\n\tconfigFilePath := c.source.SourceURI()\n\tif configFilePath == \"\" {\n\t\tconfigFilePath = config.GetConfigFilePath()\n\t}\n\tconfigToml, err := config.New(\n\t\tconfig.WithConfigFile(configFilePath),\n\t)\n\tif err != nil {\n\t\treturn err\n\t}\n\tc.Toml = configToml\n\n\treturn nil\n}\n\n// configValueLookup is a cli.ValueSource that looks up values from a configAsValueSource.\ntype configValueLookup struct {\n\tkey string\n\tfrom *configAsValueSource\n}\n\n// Lookup returns the value for the key from the config file.\nfunc (c *configValueLookup) Lookup() (string, bool) {\n\tif c == nil || c.from == nil {\n\t\treturn \"\", false\n\t}\n\tif value := c.from.Get(c.key); value != nil {\n\t\treturn fmt.Sprintf(\"%v\", value), true\n\t}\n\n\treturn \"\", false\n}\n\n// GoString returns a Go-syntax representation of the configuration source.\nfunc (c *configValueLookup) GoString() string {\n\treturn c.String()\n}\n\n// String returns a string representation of the configuration source.\nfunc (c *configValueLookup) String() string {\n\tif c.from == nil || c.from.source == nil {\n\t\treturn \"config file\"\n\t}\n\tconfigFile := c.from.source.SourceURI()\n\tif configFile == \"\" {\n\t\tconfigFile = config.GetConfigFilePath()\n\t}\n\tif configFile == \"\" {\n\t\treturn \"config file\"\n\t}\n\treturn fmt.Sprintf(\"config file %q\", configFile)\n}\n"
},
{
"path": "cmd/nvidia-ctk/cdi/generate/generate.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage generate\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"slices\"\n\t\"strings\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\tcdi \"tags.cncf.io/container-device-interface/pkg/parser\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra/csv\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/spec\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\nconst (\n\tallDeviceName = \"all\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n\n\tconfig *configAsValueSource\n}\n\ntype options struct {\n\toutput string\n\tformat string\n\tdeviceNameStrategies []string\n\tdriverRoot string\n\tdevRoot string\n\tnvidiaCDIHookPath string\n\tldconfigPath string\n\tmode string\n\tvendor string\n\tclass string\n\n\tconfigSearchPaths []string\n\tlibrarySearchPaths []string\n\tdisabledHooks []string\n\tenabledHooks []string\n\n\tfeatureFlags []string\n\n\tcsv struct {\n\t\tfiles []string\n\t\tignorePatterns []string\n\t\tCompatContainerRoot string\n\t}\n\n\tnoAllDevice bool\n\tdeviceIDs []string\n\n\t// the following are used for dependency injection during spec generation.\n\tnvmllib nvml.Interface\n}\n\n// NewCommand constructs a generate-cdi command with the specified logger\nfunc NewCommand(logger logger.Interface, configFilePath *string) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t\tconfig: New(configFilePath),\n\t}\n\treturn c.build()\n}\n\n// build creates the CLI command\nfunc (m command) build() *cli.Command {\n\topts := options{}\n\n\t// Create the 'generate-cdi' command\n\tc := cli.Command{\n\t\tName: \"generate\",\n\t\tUsage: \"Generate CDI specifications for use with CDI-enabled runtimes\",\n\t\tUseShortOptionHandling: true,\n\t\tEnableShellCompletion: true,\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(cmd, &opts)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(&opts)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"config-search-path\",\n\t\t\t\tUsage: \"Specify the path to search for config files when discovering the entities that should be included in the CDI specification.\",\n\t\t\t\tDestination: &opts.configSearchPaths,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_CONFIG_SEARCH_PATHS\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"output\",\n\t\t\t\tUsage: \"Specify the file to output the generated CDI specification to. If this is '' the specification is output to STDOUT\",\n\t\t\t\tDestination: &opts.output,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_OUTPUT_FILE_PATH\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"format\",\n\t\t\t\tUsage: \"The output format for the generated spec [json | yaml]. This overrides the format defined by the output file extension (if specified).\",\n\t\t\t\tValue: spec.FormatYAML,\n\t\t\t\tDestination: &opts.format,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_OUTPUT_FORMAT\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"mode\",\n\t\t\t\tAliases: []string{\"discovery-mode\"},\n\t\t\t\tUsage: \"The mode to use when discovering the available entities. \" +\n\t\t\t\t\t\"One of [\" + strings.Join(nvcdi.AllModes[string](), \" | \") + \"]. \" +\n\t\t\t\t\t\"If mode is set to 'auto' the mode will be determined based on the system configuration.\",\n\t\t\t\tValue: string(nvcdi.ModeAuto),\n\t\t\t\tDestination: &opts.mode,\n\t\t\t\tSources: cli.NewValueSourceChain(\n\t\t\t\t\tcli.EnvVar(\"NVIDIA_CTK_CDI_GENERATE_MODE\"),\n\t\t\t\t),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"dev-root\",\n\t\t\t\tUsage: \"Specify the root where `/dev` is located. If this is not specified, the driver-root is assumed.\",\n\t\t\t\tDestination: &opts.devRoot,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_DEV_ROOT\"),\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"device-name-strategy\",\n\t\t\t\tUsage: \"Specify the strategy for generating device names. If this is specified multiple times, the devices will be duplicated for each strategy. One of [index | uuid | type-index]\",\n\t\t\t\tValue: []string{nvcdi.DeviceNameStrategyIndex, nvcdi.DeviceNameStrategyUUID},\n\t\t\t\tDestination: &opts.deviceNameStrategies,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_DEVICE_NAME_STRATEGIES\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"driver-root\",\n\t\t\t\tUsage: \"Specify the NVIDIA GPU driver root to use when discovering the entities that should be included in the CDI specification.\",\n\t\t\t\tDestination: &opts.driverRoot,\n\t\t\t\tSources: cli.NewValueSourceChain(\n\t\t\t\t\tcli.EnvVar(\"NVIDIA_CTK_DRIVER_ROOT\"),\n\t\t\t\t\tm.config.ValueFrom(\"nvidia-container-cli.root\"),\n\t\t\t\t),\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"library-search-path\",\n\t\t\t\tUsage: \"Specify the path to search for libraries when discovering the entities that should be included in the CDI specification.\\n\\tNote: This option only applies to CSV mode.\",\n\t\t\t\tDestination: &opts.librarySearchPaths,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_LIBRARY_SEARCH_PATHS\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"nvidia-cdi-hook-path\",\n\t\t\t\tAliases: []string{\"nvidia-ctk-path\"},\n\t\t\t\tUsage: \"Specify the path to use for the nvidia-cdi-hook in the generated CDI specification. \" +\n\t\t\t\t\t\"If not specified, the PATH will be searched for `nvidia-cdi-hook`. \" +\n\t\t\t\t\t\"NOTE: That if this is specified as `nvidia-ctk`, the PATH will be searched for `nvidia-ctk` instead.\",\n\t\t\t\tDestination: &opts.nvidiaCDIHookPath,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_HOOK_PATH\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"ldconfig-path\",\n\t\t\t\tUsage: \"Specify the path to use for ldconfig in the generated CDI specification\",\n\t\t\t\tDestination: &opts.ldconfigPath,\n\t\t\t\tSources: cli.NewValueSourceChain(\n\t\t\t\t\tcli.EnvVar(\"NVIDIA_CTK_CDI_GENERATE_LDCONFIG_PATH\"),\n\t\t\t\t),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"vendor\",\n\t\t\t\tAliases: []string{\"cdi-vendor\"},\n\t\t\t\tUsage: \"the vendor string to use for the generated CDI specification.\",\n\t\t\t\tValue: \"nvidia.com\",\n\t\t\t\tDestination: &opts.vendor,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_VENDOR\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"class\",\n\t\t\t\tAliases: []string{\"cdi-class\"},\n\t\t\t\tUsage: \"the class string to use for the generated CDI specification.\",\n\t\t\t\tValue: \"gpu\",\n\t\t\t\tDestination: &opts.class,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_CLASS\"),\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"csv.file\",\n\t\t\t\tUsage: \"The path to the list of CSV files to use when generating the CDI specification in CSV mode.\",\n\t\t\t\tValue: csv.DefaultFileList(),\n\t\t\t\tDestination: &opts.csv.files,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_CSV_FILES\"),\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"csv.ignore-pattern\",\n\t\t\t\tUsage: \"specify a pattern the CSV mount specifications.\",\n\t\t\t\tDestination: &opts.csv.ignorePatterns,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_CSV_IGNORE_PATTERNS\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"csv.compat-container-root\",\n\t\t\t\tUsage: \"specify the container folder to use for CUDA Forward Compatibility in non-standard containers\",\n\t\t\t\tDestination: &opts.csv.CompatContainerRoot,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_CSV_CONTAINER_COMPAT_ROOT\"),\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"disable-hook\",\n\t\t\t\tAliases: []string{\"disable-hooks\"},\n\t\t\t\tUsage: \"specify a specific hook to skip when generating CDI \" +\n\t\t\t\t\t\"specifications. This can be specified multiple times and the \" +\n\t\t\t\t\t\"special hook name 'all' can be used ensure that the generated \" +\n\t\t\t\t\t\"CDI specification does not include any hooks.\",\n\t\t\t\tDestination: &opts.disabledHooks,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_DISABLED_HOOKS\"),\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"enable-hook\",\n\t\t\t\tAliases: []string{\"enable-hooks\"},\n\t\t\t\tUsage: \"Explicitly enable a hook in the generated CDI specification. This overrides disabled hooks. This can be specified multiple times.\",\n\t\t\t\tDestination: &opts.enabledHooks,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_ENABLED_HOOKS\"),\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"feature-flag\",\n\t\t\t\tAliases: []string{\"feature-flags\"},\n\t\t\t\tUsage: \"specify feature flags for CDI spec generation\",\n\t\t\t\tDestination: &opts.featureFlags,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_FEATURE_FLAGS\"),\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"no-all-device\",\n\t\t\t\tUsage: \"Don't generate an `all` device for the resultant spec\",\n\t\t\t\tDestination: &opts.noAllDevice,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_NO_ALL_DEVICE\"),\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"device-id\",\n\t\t\t\tAliases: []string{\"device-ids\", \"device\", \"devices\"},\n\t\t\t\tUsage: \"Restrict generation to the specified device identifiers\",\n\t\t\t\tValue: []string{\"all\"},\n\t\t\t\tDestination: &opts.deviceIDs,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_GENERATE_DEVICE_IDS\"),\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(c *cli.Command, opts *options) error {\n\topts.format = strings.ToLower(opts.format)\n\tswitch opts.format {\n\tcase spec.FormatJSON:\n\tcase spec.FormatYAML:\n\tdefault:\n\t\treturn fmt.Errorf(\"invalid output format: %v\", opts.format)\n\t}\n\n\topts.mode = strings.ToLower(opts.mode)\n\tif !nvcdi.IsValidMode(opts.mode) {\n\t\treturn fmt.Errorf(\"invalid discovery mode: %v\", opts.mode)\n\t}\n\n\tfor _, strategy := range opts.deviceNameStrategies {\n\t\t_, err := nvcdi.NewDeviceNamer(strategy)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\topts.nvidiaCDIHookPath = config.ResolveNVIDIACDIHookPath(m.logger, opts.nvidiaCDIHookPath)\n\n\tif outputFileFormat := formatFromFilename(opts.output); outputFileFormat != \"\" {\n\t\tm.logger.Debugf(\"Inferred output format as %q from output file name\", outputFileFormat)\n\t\tif !c.IsSet(\"format\") {\n\t\t\topts.format = outputFileFormat\n\t\t} else if outputFileFormat != opts.format {\n\t\t\tm.logger.Warningf(\"Requested output format %q does not match format implied by output file name: %q\", opts.format, outputFileFormat)\n\t\t}\n\t}\n\n\tif err := cdi.ValidateVendorName(opts.vendor); err != nil {\n\t\treturn fmt.Errorf(\"invalid CDI vendor name: %v\", err)\n\t}\n\tif err := cdi.ValidateClassName(opts.class); err != nil {\n\t\treturn fmt.Errorf(\"invalid CDI class name: %v\", err)\n\t}\n\n\tfor _, hook := range opts.enabledHooks {\n\t\tif hook == \"all\" {\n\t\t\treturn fmt.Errorf(\"enabling all hooks is not supported\")\n\t\t}\n\t}\n\n\tif slices.Contains(opts.deviceIDs, \"none\") && !opts.noAllDevice {\n\t\tm.logger.Warningf(\"Disabling generation of 'all' device\")\n\t\topts.noAllDevice = true\n\t}\n\treturn nil\n}\n\nfunc (m command) run(opts *options) error {\n\tspecs, err := m.generateSpecs(opts)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to generate CDI spec: %v\", err)\n\t}\n\n\tvar errs error\n\tfor _, spec := range specs {\n\t\terrs = errors.Join(errs, spec.Save(opts.output))\n\t\t// We query the raw spec version after calling spec.Save since this may\n\t\t// update the spec version to the minimum required version.\n\t\tm.logger.Infof(\"Generated CDI spec with version %v\", spec.Raw().Version)\n\t}\n\n\treturn errs\n}\n\nfunc formatFromFilename(filename string) string {\n\text := filepath.Ext(filename)\n\tswitch strings.ToLower(ext) {\n\tcase \".json\":\n\t\treturn spec.FormatJSON\n\tcase \".yaml\", \".yml\":\n\t\treturn spec.FormatYAML\n\t}\n\n\treturn \"\"\n}\n\ntype generatedSpecs struct {\n\tspec.Interface\n\tfilenameInfix string\n}\n\nfunc (g *generatedSpecs) Save(filename string) error {\n\tfilename = g.updateFilename(filename)\n\n\tif filename == \"\" {\n\t\t_, err := g.WriteTo(os.Stdout)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to write CDI spec to STDOUT: %v\", err)\n\t\t}\n\t\treturn nil\n\t}\n\n\treturn g.Interface.Save(filename)\n}\n\nfunc (g generatedSpecs) updateFilename(filename string) string {\n\tif g.filenameInfix == \"\" || filename == \"\" {\n\t\treturn filename\n\t}\n\text := filepath.Ext(filepath.Base(filename))\n\treturn strings.TrimSuffix(filename, ext) + g.filenameInfix + ext\n}\n\nfunc (m command) generateSpecs(opts *options) ([]generatedSpecs, error) {\n\tvar deviceNamers []nvcdi.DeviceNamer\n\tfor _, strategy := range opts.deviceNameStrategies {\n\t\tdeviceNamer, err := nvcdi.NewDeviceNamer(strategy)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to create device namer: %v\", err)\n\t\t}\n\t\tdeviceNamers = append(deviceNamers, deviceNamer)\n\t}\n\n\tcdiOptions := []nvcdi.Option{\n\t\tnvcdi.WithLogger(m.logger),\n\t\tnvcdi.WithDriverRoot(opts.driverRoot),\n\t\tnvcdi.WithDevRoot(opts.devRoot),\n\t\tnvcdi.WithNVIDIACDIHookPath(opts.nvidiaCDIHookPath),\n\t\tnvcdi.WithLdconfigPath(opts.ldconfigPath),\n\t\tnvcdi.WithDeviceNamers(deviceNamers...),\n\t\tnvcdi.WithMode(opts.mode),\n\t\tnvcdi.WithConfigSearchPaths(opts.configSearchPaths),\n\t\tnvcdi.WithLibrarySearchPaths(opts.librarySearchPaths),\n\t\tnvcdi.WithCSVFiles(opts.csv.files),\n\t\tnvcdi.WithCSVIgnorePatterns(opts.csv.ignorePatterns),\n\t\tnvcdi.WithCSVCompatContainerRoot(opts.csv.CompatContainerRoot),\n\t\tnvcdi.WithDisabledHooks(opts.disabledHooks...),\n\t\tnvcdi.WithEnabledHooks(opts.enabledHooks...),\n\t\tnvcdi.WithFeatureFlags(opts.featureFlags...),\n\t\t// We set the following to allow for dependency injection:\n\t\tnvcdi.WithNvmlLib(opts.nvmllib),\n\t}\n\n\tcdilib, err := nvcdi.New(cdiOptions...)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create CDI library: %v\", err)\n\t}\n\n\tallDeviceSpecs, err := cdilib.GetDeviceSpecsByID(opts.deviceIDs...)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create device CDI specs: %v\", err)\n\t}\n\n\tcommonEdits, err := cdilib.GetCommonEdits()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create edits common for entities: %v\", err)\n\t}\n\n\tcommonSpecOptions := []spec.Option{\n\t\tspec.WithVendor(opts.vendor),\n\t\tspec.WithEdits(*commonEdits.ContainerEdits),\n\t\tspec.WithFormat(opts.format),\n\t\tspec.WithPermissions(0644),\n\t}\n\n\tif !opts.noAllDevice {\n\t\tcommonSpecOptions = append(commonSpecOptions,\n\t\t\tspec.WithMergedDeviceOptions(\n\t\t\t\ttransform.WithName(allDeviceName),\n\t\t\t\ttransform.WithSkipIfExists(true),\n\t\t\t),\n\t\t)\n\t}\n\n\tfullSpec, err := spec.New(\n\t\tappend(commonSpecOptions,\n\t\t\tspec.WithClass(opts.class),\n\t\t\tspec.WithDeviceSpecs(allDeviceSpecs),\n\t\t)...,\n\t)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar allSpecs []generatedSpecs\n\n\tallSpecs = append(allSpecs, generatedSpecs{Interface: fullSpec, filenameInfix: \"\"})\n\n\tdeviceSpecsByDeviceCoherence := (deviceSpecs)(allDeviceSpecs).splitOnAnnotation(\"gpu.nvidia.com/coherent\")\n\n\tif coherentDeviceSpecs := deviceSpecsByDeviceCoherence[\"gpu.nvidia.com/coherent=true\"]; len(coherentDeviceSpecs) > 0 {\n\t\tinfix := \".coherent\"\n\t\tcoherentSpecs, err := spec.New(\n\t\t\tappend(commonSpecOptions,\n\t\t\t\tspec.WithClass(opts.class+infix),\n\t\t\t\tspec.WithDeviceSpecs(coherentDeviceSpecs),\n\t\t\t)...,\n\t\t)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tallSpecs = append(allSpecs, generatedSpecs{Interface: coherentSpecs, filenameInfix: infix})\n\t}\n\n\tif noncoherentDeviceSpecs := deviceSpecsByDeviceCoherence[\"gpu.nvidia.com/coherent=false\"]; len(noncoherentDeviceSpecs) > 0 {\n\t\tinfix := \".noncoherent\"\n\t\tnoncoherentSpecs, err := spec.New(\n\t\t\tappend(commonSpecOptions,\n\t\t\t\tspec.WithClass(opts.class+infix),\n\t\t\t\tspec.WithDeviceSpecs(noncoherentDeviceSpecs),\n\t\t\t)...,\n\t\t)\n\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tallSpecs = append(allSpecs, generatedSpecs{Interface: noncoherentSpecs, filenameInfix: infix})\n\t}\n\n\treturn allSpecs, nil\n}\n\ntype deviceSpecs []specs.Device\n\nfunc (d deviceSpecs) splitOnAnnotation(key string) map[string][]specs.Device {\n\tsplitSpecs := make(map[string][]specs.Device)\n\n\tvar specsToRemoveAnnotations []*specs.Device\n\tfor _, deviceSpec := range d {\n\t\tvalue, ok := deviceSpec.Annotations[key]\n\t\tif !ok {\n\t\t\tcontinue\n\t\t}\n\t\tsplitSpecs[key+\"=\"+value] = append(splitSpecs[key+\"=\"+value], deviceSpec)\n\t\tspecsToRemoveAnnotations = append(specsToRemoveAnnotations, &deviceSpec)\n\t}\n\n\t// We also remove the annotations that were used to split the devices:\n\tfor _, deviceSpec := range specsToRemoveAnnotations {\n\t\tif _, ok := deviceSpec.Annotations[key]; !ok {\n\t\t\tcontinue\n\t\t}\n\t\tdelete(deviceSpec.Annotations, key)\n\t}\n\n\treturn splitSpecs\n}\n"
},
{
"path": "cmd/nvidia-ctk/cdi/generate/generate_test.go",
"content": "/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage generate\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml/mock/dgxa100\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestGenerateSpec(t *testing.T) {\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tdriverRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\", \"rootfs-1\")\n\n\tlogger, _ := testlog.NewNullLogger()\n\ttestCases := []struct {\n\t\tdescription string\n\t\toptions options\n\t\texpectedValidateError error\n\t\texpectedOptions options\n\t\texpectedError error\n\t\texpectedSpec string\n\t}{\n\t\t{\n\t\t\tdescription: \"invalid device id\",\n\t\t\toptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tdeviceIDs: []string{\"99\"},\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t},\n\t\t\texpectedOptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tnvidiaCDIHookPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\tdeviceIDs: []string{\"99\"},\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t},\n\t\t\texpectedError: fmt.Errorf(\"failed to create device CDI specs: failed to construct device spec generators: failed to get device handle from index: ERROR_INVALID_ARGUMENT\"),\n\t\t},\n\t\t{\n\t\t\tdescription: \"default\",\n\t\t\toptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t},\n\t\t\texpectedOptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tnvidiaCDIHookPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.5.0\nkind: example.com/device\ndevices:\n - name: \"0\"\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\n - name: all\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\ncontainerEdits:\n env:\n - NVIDIA_CTK_LIBCUDA_DIR=/lib/x86_64-linux-gnu\n - NVIDIA_VISIBLE_DEVICES=void\n deviceNodes:\n - path: /dev/nvidiactl\n hostPath: {{ .driverRoot }}/dev/nvidiactl\n hooks:\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - create-symlinks\n - --link\n - libcuda.so.1::/lib/x86_64-linux-gnu/libcuda.so\n env:\n - NVIDIA_CTK_DEBUG=false\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - enable-cuda-compat\n - --host-driver-version=999.88.77\n env:\n - NVIDIA_CTK_DEBUG=false\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - update-ldcache\n - --folder\n - /lib/x86_64-linux-gnu\n - --folder\n - /lib/x86_64-linux-gnu/vdpau\n env:\n - NVIDIA_CTK_DEBUG=false\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - disable-device-node-modification\n env:\n - NVIDIA_CTK_DEBUG=false\n mounts:\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/libcuda.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/libcuda.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"disableHooks1\",\n\t\t\toptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t\tdisabledHooks: []string{\"enable-cuda-compat\"},\n\t\t\t},\n\t\t\texpectedOptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tnvidiaCDIHookPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t\tdisabledHooks: []string{\"enable-cuda-compat\"},\n\t\t\t},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.5.0\nkind: example.com/device\ndevices:\n - name: \"0\"\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\n - name: all\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\ncontainerEdits:\n env:\n - NVIDIA_CTK_LIBCUDA_DIR=/lib/x86_64-linux-gnu\n - NVIDIA_VISIBLE_DEVICES=void\n deviceNodes:\n - path: /dev/nvidiactl\n hostPath: {{ .driverRoot }}/dev/nvidiactl\n hooks:\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - create-symlinks\n - --link\n - libcuda.so.1::/lib/x86_64-linux-gnu/libcuda.so\n env:\n - NVIDIA_CTK_DEBUG=false\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - update-ldcache\n - --folder\n - /lib/x86_64-linux-gnu\n - --folder\n - /lib/x86_64-linux-gnu/vdpau\n env:\n - NVIDIA_CTK_DEBUG=false\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - disable-device-node-modification\n env:\n - NVIDIA_CTK_DEBUG=false\n mounts:\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/libcuda.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/libcuda.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"disableHooks2\",\n\t\t\toptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t\tdisabledHooks: []string{\"enable-cuda-compat\", \"update-ldcache\"},\n\t\t\t},\n\t\t\texpectedOptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tnvidiaCDIHookPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t\tdisabledHooks: []string{\"enable-cuda-compat\", \"update-ldcache\"},\n\t\t\t},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.5.0\nkind: example.com/device\ndevices:\n - name: \"0\"\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\n - name: all\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\ncontainerEdits:\n env:\n - NVIDIA_CTK_LIBCUDA_DIR=/lib/x86_64-linux-gnu\n - NVIDIA_VISIBLE_DEVICES=void\n deviceNodes:\n - path: /dev/nvidiactl\n hostPath: {{ .driverRoot }}/dev/nvidiactl\n hooks:\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - create-symlinks\n - --link\n - libcuda.so.1::/lib/x86_64-linux-gnu/libcuda.so\n env:\n - NVIDIA_CTK_DEBUG=false\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - disable-device-node-modification\n env:\n - NVIDIA_CTK_DEBUG=false\n mounts:\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/libcuda.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/libcuda.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"disableHooksAll\",\n\t\t\toptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t\tdisabledHooks: []string{\"all\"},\n\t\t\t},\n\t\t\texpectedOptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"nvml\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tnvidiaCDIHookPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t\tdisabledHooks: []string{\"all\"},\n\t\t\t},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.5.0\nkind: example.com/device\ndevices:\n - name: \"0\"\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\n - name: all\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\ncontainerEdits:\n env:\n - NVIDIA_CTK_LIBCUDA_DIR=/lib/x86_64-linux-gnu\n - NVIDIA_VISIBLE_DEVICES=void\n deviceNodes:\n - path: /dev/nvidiactl\n hostPath: {{ .driverRoot }}/dev/nvidiactl\n mounts:\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/libcuda.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/libcuda.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"enableChmodHook\",\n\t\t\toptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"management\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t\tenabledHooks: []string{\"chmod\"},\n\t\t\t\tdisabledHooks: []string{\"enable-cuda-compat\", \"update-ldcache\", \"disable-device-node-modification\"},\n\t\t\t},\n\t\t\texpectedOptions: options{\n\t\t\t\tformat: \"yaml\",\n\t\t\t\tmode: \"management\",\n\t\t\t\tvendor: \"example.com\",\n\t\t\t\tclass: \"device\",\n\t\t\t\tnvidiaCDIHookPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\tdriverRoot: driverRoot,\n\t\t\t\tenabledHooks: []string{\"chmod\"},\n\t\t\t\tdisabledHooks: []string{\"enable-cuda-compat\", \"update-ldcache\", \"disable-device-node-modification\"},\n\t\t\t},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.5.0\nkind: example.com/device\ndevices:\n - name: all\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: {{ .driverRoot }}/dev/nvidia0\n - path: /dev/nvidiactl\n hostPath: {{ .driverRoot }}/dev/nvidiactl\n - path: /dev/nvidia-caps-imex-channels/channel0\n hostPath: {{ .driverRoot }}/dev/nvidia-caps-imex-channels/channel0\n - path: /dev/nvidia-caps-imex-channels/channel1\n hostPath: {{ .driverRoot }}/dev/nvidia-caps-imex-channels/channel1\n - path: /dev/nvidia-caps-imex-channels/channel2047\n hostPath: {{ .driverRoot }}/dev/nvidia-caps-imex-channels/channel2047\n - path: /dev/nvidia-caps/nvidia-cap1\n hostPath: {{ .driverRoot }}/dev/nvidia-caps/nvidia-cap1\n hooks:\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - chmod\n - --mode\n - \"755\"\n - --path\n - /dev/nvidia-caps\n env:\n - NVIDIA_CTK_DEBUG=false\ncontainerEdits:\n env:\n - NVIDIA_CTK_LIBCUDA_DIR=/lib/x86_64-linux-gnu\n - NVIDIA_VISIBLE_DEVICES=void\n hooks:\n - hookName: createContainer\n path: /usr/bin/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - create-symlinks\n - --link\n - libcuda.so.1::/lib/x86_64-linux-gnu/libcuda.so\n env:\n - NVIDIA_CTK_DEBUG=false\n mounts:\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/libcuda.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/libcuda.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n - hostPath: {{ .driverRoot }}/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n`,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\t// Apply overrides for all test cases:\n\t\ttc.options.nvidiaCDIHookPath = \"/usr/bin/nvidia-cdi-hook\"\n\t\tif tc.options.deviceIDs == nil {\n\t\t\ttc.options.deviceIDs = []string{\"all\"}\n\t\t\ttc.expectedOptions.deviceIDs = []string{\"all\"}\n\t\t}\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tc := command{\n\t\t\t\tlogger: logger,\n\t\t\t}\n\n\t\t\terr := c.validateFlags(nil, &tc.options)\n\t\t\trequire.ErrorIs(t, err, tc.expectedValidateError)\n\t\t\trequire.EqualValues(t, tc.expectedOptions, tc.options)\n\n\t\t\t// Set up a mock server, reusing the DGX A100 mock.\n\t\t\tserver := dgxa100.New()\n\t\t\t// Override the driver version to match the version in our mock filesystem.\n\t\t\tserver.SystemGetDriverVersionFunc = func() (string, nvml.Return) {\n\t\t\t\treturn \"999.88.77\", nvml.SUCCESS\n\t\t\t}\n\t\t\t// Set the device count to 1 explicitly since we only have a single device node.\n\t\t\tserver.DeviceGetCountFunc = func() (int, nvml.Return) {\n\t\t\t\treturn 1, nvml.SUCCESS\n\t\t\t}\n\t\t\tfor _, d := range server.Devices {\n\t\t\t\t// TODO: This is not implemented in the mock.\n\t\t\t\t(d.(*dgxa100.Device)).GetMaxMigDeviceCountFunc = func() (int, nvml.Return) {\n\t\t\t\t\treturn 0, nvml.SUCCESS\n\t\t\t\t}\n\t\t\t}\n\t\t\ttc.options.nvmllib = server\n\n\t\t\tspecs, err := c.generateSpecs(&tc.options)\n\t\t\trequire.EqualValues(t, err, tc.expectedError)\n\n\t\t\tvar buf bytes.Buffer\n\t\t\tfor _, spec := range specs {\n\t\t\t\t_, err = spec.WriteTo(&buf)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\trequire.Equal(t, strings.ReplaceAll(tc.expectedSpec, \"{{ .driverRoot }}\", driverRoot), buf.String())\n\t\t})\n\t}\n}\n\nfunc TestSplitOnAnnotation(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tinput deviceSpecs\n\t\tannotation string\n\t\texpectedInputPostSplit deviceSpecs\n\t\texpectedOutput map[string][]specs.Device\n\t}{\n\t\t{\n\t\t\tdescription: \"non-matching annotation\",\n\t\t\tinput: deviceSpecs{\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"foo\",\n\t\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\t\"key\": \"value\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tannotation: \"not-key\",\n\t\t\texpectedInputPostSplit: deviceSpecs{\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"foo\",\n\t\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\t\"key\": \"value\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedOutput: map[string][]specs.Device{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"single annotation present\",\n\t\t\tinput: deviceSpecs{\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"foo\",\n\t\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\t\"key\": \"value\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tannotation: \"key\",\n\t\t\texpectedInputPostSplit: deviceSpecs{\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"foo\",\n\t\t\t\t\tAnnotations: map[string]string{},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedOutput: map[string][]specs.Device{\n\t\t\t\t\"key=value\": {\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"foo\",\n\t\t\t\t\t\tAnnotations: map[string]string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-matching annotations are not removed\",\n\t\t\tinput: deviceSpecs{\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"foo\",\n\t\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\t\"key\": \"value\",\n\t\t\t\t\t\t\"another\": \"foo\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tannotation: \"key\",\n\t\t\texpectedInputPostSplit: deviceSpecs{\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"foo\",\n\t\t\t\t\tAnnotations: map[string]string{\"another\": \"foo\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedOutput: map[string][]specs.Device{\n\t\t\t\t\"key=value\": {\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"foo\",\n\t\t\t\t\t\tAnnotations: map[string]string{\"another\": \"foo\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicated annotations different names\",\n\t\t\tinput: func() deviceSpecs {\n\t\t\t\tannotations := map[string]string{\n\t\t\t\t\t\"key\": \"value\",\n\t\t\t\t}\n\t\t\t\treturn deviceSpecs{\n\t\t\t\t\t{Name: \"0\", Annotations: annotations},\n\t\t\t\t\t{Name: \"first\", Annotations: annotations},\n\t\t\t\t}\n\t\t\t}(),\n\t\t\tannotation: \"key\",\n\t\t\texpectedInputPostSplit: deviceSpecs{\n\t\t\t\tspecs.Device{Name: \"0\", Annotations: map[string]string{}},\n\t\t\t\tspecs.Device{Name: \"first\", Annotations: map[string]string{}},\n\t\t\t},\n\t\t\texpectedOutput: map[string][]specs.Device{\n\t\t\t\t\"key=value\": {\n\t\t\t\t\t{Name: \"0\", Annotations: map[string]string{}},\n\t\t\t\t\t{Name: \"first\", Annotations: map[string]string{}},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"annotation with different values\",\n\t\t\tinput: deviceSpecs{\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"foo\",\n\t\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\t\"key\": \"value\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"bar\",\n\t\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\t\"key\": \"another\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tannotation: \"key\",\n\t\t\texpectedInputPostSplit: deviceSpecs{\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"foo\",\n\t\t\t\t\tAnnotations: map[string]string{},\n\t\t\t\t},\n\t\t\t\tspecs.Device{\n\t\t\t\t\tName: \"bar\",\n\t\t\t\t\tAnnotations: map[string]string{},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedOutput: map[string][]specs.Device{\n\t\t\t\t\"key=value\": {\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"foo\",\n\t\t\t\t\t\tAnnotations: map[string]string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\"key=another\": {\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"bar\",\n\t\t\t\t\t\tAnnotations: map[string]string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tresult := tc.input.splitOnAnnotation(tc.annotation)\n\n\t\t\trequire.EqualValues(t, tc.expectedOutput, result)\n\t\t\trequire.EqualValues(t, tc.expectedInputPostSplit, tc.input)\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk/cdi/list/list.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage list\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/urfave/cli/v3\"\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\ntype config struct {\n\tcdiSpecDirs []string\n}\n\n// NewCommand constructs a cdi list command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build creates the CLI command\nfunc (m command) build() *cli.Command {\n\tcfg := config{}\n\n\t// Create the command\n\tc := cli.Command{\n\t\tName: \"list\",\n\t\tUsage: \"List the available CDI devices\",\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(&cfg)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(&cfg)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"spec-dir\",\n\t\t\t\tUsage: \"specify the directories to scan for CDI specifications\",\n\t\t\t\tValue: cdi.DefaultSpecDirs,\n\t\t\t\tDestination: &cfg.cdiSpecDirs,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CDI_SPEC_DIRS\"),\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(cfg *config) error {\n\tif len(cfg.cdiSpecDirs) == 0 {\n\t\treturn errors.New(\"at least one CDI specification directory must be specified\")\n\t}\n\treturn nil\n}\n\nfunc (m command) run(cfg *config) error {\n\tregistry, err := cdi.NewCache(\n\t\tcdi.WithAutoRefresh(false),\n\t\tcdi.WithSpecDirs(cfg.cdiSpecDirs...),\n\t)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create CDI cache: %v\", err)\n\t}\n\n\t_ = registry.Refresh()\n\tif errors := registry.GetErrors(); len(errors) > 0 {\n\t\tm.logger.Warningf(\"The following registry errors were reported:\")\n\t\tfor k, err := range errors {\n\t\t\tm.logger.Warningf(\"%v: %v\", k, err)\n\t\t}\n\t}\n\n\tdevices := registry.ListDevices()\n\tm.logger.Infof(\"Found %d CDI devices\", len(devices))\n\tfor _, device := range devices {\n\t\tfmt.Printf(\"%s\\n\", device)\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk/cdi/transform/root/root.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\n\t\"github.com/urfave/cli/v3\"\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/spec\"\n\ttransformroot \"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform/root\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\ntype transformOptions struct {\n\tinput string\n\toutput string\n}\n\ntype options struct {\n\ttransformOptions\n\tfrom string\n\tto string\n\trelativeTo string\n}\n\n// NewCommand constructs a generate-cdi command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build creates the CLI command\nfunc (m command) build() *cli.Command {\n\topts := options{}\n\n\tc := cli.Command{\n\t\tName: \"root\",\n\t\tUsage: \"Apply a root transform to a CDI specification\",\n\t\tUseShortOptionHandling: true,\n\t\tEnableShellCompletion: true,\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(&opts)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(&opts)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"from\",\n\t\t\t\tUsage: \"specify the root to be transformed\",\n\t\t\t\tDestination: &opts.from,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"input\",\n\t\t\t\tUsage: \"Specify the file to read the CDI specification from. If this is '-' the specification is read from STDIN\",\n\t\t\t\tValue: \"-\",\n\t\t\t\tDestination: &opts.input,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"output\",\n\t\t\t\tUsage: \"Specify the file to output the generated CDI specification to. If this is '' the specification is output to STDOUT\",\n\t\t\t\tDestination: &opts.output,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"relative-to\",\n\t\t\t\tUsage: \"specify whether the transform is relative to the host or to the container. One of [ host | container ]\",\n\t\t\t\tValue: \"host\",\n\t\t\t\tDestination: &opts.relativeTo,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"to\",\n\t\t\t\tUsage: \"specify the replacement root. If this is the same as the from root, the transform is a no-op.\",\n\t\t\t\tValue: \"\",\n\t\t\t\tDestination: &opts.to,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(opts *options) error {\n\tswitch opts.relativeTo {\n\tcase \"host\":\n\tcase \"container\":\n\tdefault:\n\t\treturn fmt.Errorf(\"invalid --relative-to value: %v\", opts.relativeTo)\n\t}\n\treturn nil\n}\n\nfunc (m command) run(opts *options) error {\n\tspec, err := opts.Load()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to load CDI specification: %w\", err)\n\t}\n\n\terr = transformroot.New(\n\t\ttransformroot.WithRoot(opts.from),\n\t\ttransformroot.WithTargetRoot(opts.to),\n\t\ttransformroot.WithRelativeTo(opts.relativeTo),\n\t).Transform(spec.Raw())\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to transform CDI specification: %w\", err)\n\t}\n\n\treturn opts.Save(spec)\n}\n\n// Load lodas the input CDI specification\nfunc (o transformOptions) Load() (spec.Interface, error) {\n\tcontents, err := o.getContents()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to read spec contents: %v\", err)\n\t}\n\n\traw, err := cdi.ParseSpec(contents)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to parse CDI spec: %v\", err)\n\t}\n\n\treturn spec.New(\n\t\tspec.WithRawSpec(raw),\n\t)\n}\n\nfunc (o transformOptions) getContents() ([]byte, error) {\n\tif o.input == \"-\" {\n\t\treturn io.ReadAll(os.Stdin)\n\t}\n\n\treturn os.ReadFile(o.input)\n}\n\n// Save saves the CDI specification to the output file\nfunc (o transformOptions) Save(s spec.Interface) error {\n\tif o.output == \"\" {\n\t\t_, err := s.WriteTo(os.Stdout)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to write CDI spec to STDOUT: %v\", err)\n\t\t}\n\t\treturn nil\n\t}\n\n\treturn s.Save(o.output)\n}\n"
},
{
"path": "cmd/nvidia-ctk/cdi/transform/transform.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/cdi/transform/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\n// NewCommand constructs a command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build creates the CLI command\nfunc (m command) build() *cli.Command {\n\tc := cli.Command{\n\t\tName: \"transform\",\n\t\tUsage: \"Apply a transform to a CDI specification\",\n\t\tCommands: []*cli.Command{\n\t\t\troot.NewCommand(m.logger),\n\t\t},\n\t}\n\n\treturn &c\n}\n"
},
{
"path": "cmd/nvidia-ctk/config/config.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"reflect\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\tcreatedefault \"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/config/create-default\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/config/flags\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\n// options stores the subcommand options\ntype options struct {\n\tflags.Options\n\tsetListSeparator string\n\tsets []string\n}\n\n// NewCommand constructs an config command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build\nfunc (m command) build() *cli.Command {\n\topts := options{}\n\n\t// Create the 'config' command\n\tc := cli.Command{\n\t\tName: \"config\",\n\t\tUsage: \"Interact with the NVIDIA Container Toolkit configuration\",\n\t\tUseShortOptionHandling: true,\n\t\tEnableShellCompletion: true,\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(&opts)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(&opts)\n\t\t},\n\t\tCommands: []*cli.Command{\n\t\t\tcreatedefault.NewCommand(m.logger),\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"config-file\",\n\t\t\t\tAliases: []string{\"config\", \"c\"},\n\t\t\t\tUsage: \"Specify the config file to modify.\",\n\t\t\t\tValue: config.GetConfigFilePath(),\n\t\t\t\tDestination: &opts.Config,\n\t\t\t},\n\t\t\t&cli.StringSliceFlag{\n\t\t\t\tName: \"set\",\n\t\t\t\tUsage: \"Set a config value using the pattern 'key[=value]'. \" +\n\t\t\t\t\t\"Specifying only 'key' is equivalent to 'key=true' for boolean settings. \" +\n\t\t\t\t\t\"This flag can be specified multiple times, but only the last value for a specific \" +\n\t\t\t\t\t\"config option is applied. \" +\n\t\t\t\t\t\"If the setting represents a list, the elements are colon-separated.\",\n\t\t\t\tDestination: &opts.sets,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"set-list-separator\",\n\t\t\t\tUsage: \"Specify a separator for lists applied using the set command.\",\n\t\t\t\tHidden: true,\n\t\t\t\tValue: \":\",\n\t\t\t\tDestination: &opts.setListSeparator,\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"in-place\",\n\t\t\t\tAliases: []string{\"i\"},\n\t\t\t\tUsage: \"Modify the config file in-place\",\n\t\t\t\tDestination: &opts.InPlace,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"output\",\n\t\t\t\tAliases: []string{\"o\"},\n\t\t\t\tUsage: \"Specify the output file to write to; If not specified, the output is written to stdout\",\n\t\t\t\tDestination: &opts.Output,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(opts *options) error {\n\tif opts.setListSeparator == \"\" {\n\t\treturn fmt.Errorf(\"set-list-separator must be set\")\n\t}\n\treturn nil\n}\n\nfunc (m command) run(opts *options) error {\n\tcfgToml, err := config.New(\n\t\tconfig.WithConfigFile(opts.Config),\n\t)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to create config: %v\", err)\n\t}\n\n\tfor _, set := range opts.sets {\n\t\tkey, value, err := setFlagToKeyValue(set, opts.setListSeparator)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"invalid --set option %v: %w\", set, err)\n\t\t}\n\t\tif value == nil {\n\t\t\t_ = cfgToml.Delete(key)\n\t\t} else {\n\t\t\tcfgToml.Set(key, value)\n\t\t}\n\t}\n\n\tif err := opts.EnsureOutputFolder(); err != nil {\n\t\treturn fmt.Errorf(\"failed to create output directory: %v\", err)\n\t}\n\toutput, err := opts.CreateOutput()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to open output file: %v\", err)\n\t}\n\tdefer output.Close()\n\n\tif _, err := cfgToml.Save(output); err != nil {\n\t\treturn fmt.Errorf(\"failed to save config: %v\", err)\n\t}\n\n\treturn nil\n}\n\nvar errInvalidConfigOption = errors.New(\"invalid config option\")\nvar errUndefinedField = errors.New(\"undefined field\")\nvar errInvalidFormat = errors.New(\"invalid format\")\n\n// setFlagToKeyValue converts a --set flag to a key-value pair.\n// The set flag is of the form key[=value], with the value being optional if key refers to a\n// boolean config option.\nfunc setFlagToKeyValue(setFlag string, setListSeparator string) (string, interface{}, error) {\n\tsetParts := strings.SplitN(setFlag, \"=\", 2)\n\tkey := setParts[0]\n\n\tfield, err := getField(key)\n\tif err != nil {\n\t\treturn key, nil, fmt.Errorf(\"%w: %w\", errInvalidConfigOption, err)\n\t}\n\n\tkind := field.Kind()\n\tif len(setParts) != 2 {\n\t\tif kind == reflect.Bool || (kind == reflect.Pointer && field.Elem().Kind() == reflect.Bool) {\n\t\t\treturn key, true, nil\n\t\t}\n\t\treturn key, nil, fmt.Errorf(\"%w: expected key=value; got %v\", errInvalidFormat, setFlag)\n\t}\n\n\tvalue := setParts[1]\n\tif kind == reflect.Pointer && value != \"nil\" {\n\t\tkind = field.Elem().Kind()\n\t}\n\tswitch kind {\n\tcase reflect.Pointer:\n\t\treturn key, nil, nil\n\tcase reflect.Bool:\n\t\tb, err := strconv.ParseBool(value)\n\t\tif err != nil {\n\t\t\treturn key, value, fmt.Errorf(\"%w: %w\", errInvalidFormat, err)\n\t\t}\n\t\treturn key, b, nil\n\tcase reflect.String:\n\t\treturn key, value, nil\n\tcase reflect.Slice:\n\t\tvalueParts := []string{value}\n\t\tfor _, sep := range []string{setListSeparator, \",\"} {\n\t\t\tif !strings.Contains(value, sep) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tvalueParts = strings.Split(value, sep)\n\t\t\tbreak\n\t\t}\n\t\tswitch field.Elem().Kind() {\n\t\tcase reflect.String:\n\t\t\treturn key, valueParts, nil\n\t\tcase reflect.Int:\n\t\t\tvar output []int64\n\t\t\tfor _, v := range valueParts {\n\t\t\t\tvi, err := strconv.ParseInt(v, 10, 0)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn key, nil, fmt.Errorf(\"%w: %w\", errInvalidFormat, err)\n\t\t\t\t}\n\t\t\t\toutput = append(output, vi)\n\t\t\t}\n\t\t\treturn key, output, nil\n\t\t}\n\t}\n\treturn key, nil, fmt.Errorf(\"unsupported type for %v (%v)\", setParts, kind)\n}\n\nfunc getField(key string) (reflect.Type, error) {\n\ts, err := getStruct(reflect.TypeOf(config.Config{}), strings.Split(key, \".\")...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn s.Type, err\n}\n\nfunc getStruct(current reflect.Type, paths ...string) (reflect.StructField, error) {\n\tif len(paths) < 1 {\n\t\treturn reflect.StructField{}, fmt.Errorf(\"%w: no fields selected\", errUndefinedField)\n\t}\n\ttomlField := paths[0]\n\tfor i := 0; i < current.NumField(); i++ {\n\t\tf := current.Field(i)\n\t\tv, ok := f.Tag.Lookup(\"toml\")\n\t\tif !ok {\n\t\t\tcontinue\n\t\t}\n\t\tif strings.SplitN(v, \",\", 2)[0] != tomlField {\n\t\t\tcontinue\n\t\t}\n\t\tif len(paths) == 1 {\n\t\t\treturn f, nil\n\t\t}\n\t\treturn getStruct(f.Type, paths[1:]...)\n\t}\n\treturn reflect.StructField{}, fmt.Errorf(\"%w: %q\", errUndefinedField, tomlField)\n}\n"
},
{
"path": "cmd/nvidia-ctk/config/config_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestSetFlagToKeyValue(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tsetFlag string\n\t\tsetListSeparator string\n\t\texpectedKey string\n\t\texpectedValue interface{}\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"option not present returns an error\",\n\t\t\tsetFlag: \"undefined=new-value\",\n\t\t\texpectedKey: \"undefined\",\n\t\t\texpectedError: errInvalidConfigOption,\n\t\t},\n\t\t{\n\t\t\tdescription: \"undefined nexted option returns error\",\n\t\t\tsetFlag: \"nvidia-container-cli.undefined\",\n\t\t\texpectedKey: \"nvidia-container-cli.undefined\",\n\t\t\texpectedError: errInvalidConfigOption,\n\t\t},\n\t\t{\n\t\t\tdescription: \"boolean option assumes true\",\n\t\t\tsetFlag: \"disable-require\",\n\t\t\texpectedKey: \"disable-require\",\n\t\t\texpectedValue: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"boolean option returns true\",\n\t\t\tsetFlag: \"disable-require=true\",\n\t\t\texpectedKey: \"disable-require\",\n\t\t\texpectedValue: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"boolean option returns false\",\n\t\t\tsetFlag: \"disable-require=false\",\n\t\t\texpectedKey: \"disable-require\",\n\t\t\texpectedValue: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"invalid boolean option returns error\",\n\t\t\tsetFlag: \"disable-require=something\",\n\t\t\texpectedKey: \"disable-require\",\n\t\t\texpectedValue: \"something\",\n\t\t\texpectedError: errInvalidFormat,\n\t\t},\n\t\t{\n\t\t\tdescription: \"string option requires value\",\n\t\t\tsetFlag: \"swarm-resource\",\n\t\t\texpectedKey: \"swarm-resource\",\n\t\t\texpectedValue: nil,\n\t\t\texpectedError: errInvalidFormat,\n\t\t},\n\t\t{\n\t\t\tdescription: \"string option returns value\",\n\t\t\tsetFlag: \"swarm-resource=string-value\",\n\t\t\texpectedKey: \"swarm-resource\",\n\t\t\texpectedValue: \"string-value\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"string option returns value with equals\",\n\t\t\tsetFlag: \"swarm-resource=string-value=more\",\n\t\t\texpectedKey: \"swarm-resource\",\n\t\t\texpectedValue: \"string-value=more\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"string option treats bool value as string\",\n\t\t\tsetFlag: \"swarm-resource=true\",\n\t\t\texpectedKey: \"swarm-resource\",\n\t\t\texpectedValue: \"true\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"string option treats int value as string\",\n\t\t\tsetFlag: \"swarm-resource=5\",\n\t\t\texpectedKey: \"swarm-resource\",\n\t\t\texpectedValue: \"5\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"[]string option returns single value\",\n\t\t\tsetFlag: \"nvidia-container-cli.environment=string-value\",\n\t\t\texpectedKey: \"nvidia-container-cli.environment\",\n\t\t\texpectedValue: []string{\"string-value\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"[]string option returns multiple values\",\n\t\t\tsetFlag: \"nvidia-container-cli.environment=first,second\",\n\t\t\tsetListSeparator: \",\",\n\t\t\texpectedKey: \"nvidia-container-cli.environment\",\n\t\t\texpectedValue: []string{\"first\", \"second\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"[]string option returns values with equals\",\n\t\t\tsetFlag: \"nvidia-container-cli.environment=first=1,second=2\",\n\t\t\tsetListSeparator: \",\",\n\t\t\texpectedKey: \"nvidia-container-cli.environment\",\n\t\t\texpectedValue: []string{\"first=1\", \"second=2\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"[]string option returns multiple values semi-colon\",\n\t\t\tsetFlag: \"nvidia-container-cli.environment=first;second\",\n\t\t\tsetListSeparator: \";\",\n\t\t\texpectedKey: \"nvidia-container-cli.environment\",\n\t\t\texpectedValue: []string{\"first\", \"second\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tif tc.setListSeparator == \"\" {\n\t\t\t\ttc.setListSeparator = \",\"\n\t\t\t}\n\t\t\tk, v, err := setFlagToKeyValue(tc.setFlag, tc.setListSeparator)\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\trequire.EqualValues(t, tc.expectedKey, k)\n\t\t\trequire.EqualValues(t, tc.expectedValue, v)\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk/config/create-default/create-default.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage createdefault\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/config/flags\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\n// NewCommand constructs a default command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build\nfunc (m command) build() *cli.Command {\n\topts := flags.Options{}\n\n\t// Create the 'default' command\n\tc := cli.Command{\n\t\tName: \"default\",\n\t\tAliases: []string{\"create-default\", \"generate-default\"},\n\t\tUsage: \"Generate the default NVIDIA Container Toolkit configuration file\",\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(cmd, &opts)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(cmd, &opts)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"output\",\n\t\t\t\tAliases: []string{\"o\"},\n\t\t\t\tUsage: \"Specify the output file to write to; If not specified, the output is written to stdout\",\n\t\t\t\tDestination: &opts.Output,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(c *cli.Command, opts *flags.Options) error {\n\treturn nil\n}\n\nfunc (m command) run(c *cli.Command, opts *flags.Options) error {\n\tcfgToml, err := config.New()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create default config: %v\", err)\n\t}\n\n\toutput, err := opts.CreateOutput()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to open output file: %v\", err)\n\t}\n\tdefer output.Close()\n\n\tif _, err := cfgToml.Save(output); err != nil {\n\t\treturn fmt.Errorf(\"failed to save config: %v\", err)\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk/config/flags/options.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage flags\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n)\n\n// Options stores options for the config commands\ntype Options struct {\n\tConfig string\n\tOutput string\n\tInPlace bool\n}\n\n// Validate checks whether the options are valid.\nfunc (o Options) Validate() error {\n\tif o.InPlace && o.Output != \"\" {\n\t\treturn fmt.Errorf(\"cannot specify both --in-place and --output\")\n\t}\n\n\treturn nil\n}\n\n// GetOutput returns the effective output\nfunc (o Options) GetOutput() string {\n\tif o.InPlace {\n\t\treturn o.Config\n\t}\n\n\treturn o.Output\n}\n\n// EnsureOutputFolder creates the output folder if it does not exist.\n// If the output folder is not specified (i.e. output to STDOUT), it is ignored.\nfunc (o Options) EnsureOutputFolder() error {\n\toutput := o.GetOutput()\n\tif output == \"\" {\n\t\treturn nil\n\t}\n\tif dir := filepath.Dir(output); dir != \"\" {\n\t\treturn os.MkdirAll(dir, 0755)\n\t}\n\treturn nil\n}\n\n// CreateOutput creates the writer for the output.\nfunc (o Options) CreateOutput() (io.WriteCloser, error) {\n\toutput := o.GetOutput()\n\tif output == \"\" {\n\t\treturn nullCloser{os.Stdout}, nil\n\t}\n\n\treturn os.Create(output)\n}\n\n// nullCloser is a writer that does nothing on Close.\ntype nullCloser struct {\n\tio.Writer\n}\n\n// Close is a no-op for a nullCloser.\nfunc (d nullCloser) Close() error {\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk/hook/hook.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage hook\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/commands\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\n\t\"github.com/urfave/cli/v3\"\n)\n\ntype hookCommand struct {\n\tlogger logger.Interface\n}\n\n// NewCommand constructs CLI subcommand for handling CDI hooks.\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := hookCommand{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build\nfunc (m hookCommand) build() *cli.Command {\n\treturn commands.ConfigureCDIHookCommand(m.logger, &cli.Command{\n\t\tName: \"hook\",\n\t\tUsage: \"A collection of hooks that may be injected into an OCI spec\",\n\t})\n}\n"
},
{
"path": "cmd/nvidia-ctk/info/info.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage info\n\nimport (\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\n// NewCommand constructs an info command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build\nfunc (m command) build() *cli.Command {\n\t// Create the 'info' command\n\tinfo := cli.Command{\n\t\tName: \"info\",\n\t\tUsage: \"Provide information about the system\",\n\t}\n\n\treturn &info\n}\n"
},
{
"path": "cmd/nvidia-ctk/main.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\n\t\"github.com/sirupsen/logrus\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/cdi\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/config\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/hook\"\n\tinfoCLI \"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/runtime\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/system\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\n\tcli \"github.com/urfave/cli/v3\"\n)\n\n// options defines the options that can be set for the CLI through config files,\n// environment variables, or command line flags\ntype options struct {\n\t// Debug indicates whether the CLI is started in \"debug\" mode\n\tDebug bool\n\t// Quiet indicates whether the CLI is started in \"quiet\" mode\n\tQuiet bool\n\t// Config specifies the path to the config file\n\tConfig string\n}\n\nfunc main() {\n\tlogger := logrus.New()\n\n\t// Create a options struct to hold the parsed environment variables or command line flags\n\topts := options{}\n\n\t// Create the top-level CLI\n\tc := cli.Command{\n\t\tDisableSliceFlagSeparator: true,\n\t\tName: \"NVIDIA Container Toolkit CLI\",\n\t\tUseShortOptionHandling: true,\n\t\tEnableShellCompletion: true,\n\t\tUsage: \"Tools to configure the NVIDIA Container Toolkit\",\n\t\tVersion: info.GetVersionString(),\n\t\t// Set log-level for all subcommands\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\tlogLevel := logrus.InfoLevel\n\t\t\tif opts.Debug {\n\t\t\t\tlogLevel = logrus.DebugLevel\n\t\t\t}\n\t\t\tif opts.Quiet {\n\t\t\t\tlogLevel = logrus.ErrorLevel\n\t\t\t}\n\t\t\tlogger.SetLevel(logLevel)\n\n\t\t\treturn ctx, nil\n\t\t},\n\t\t// Define the subcommands\n\t\tCommands: getCommands(logger, &opts.Config),\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"debug\",\n\t\t\t\tAliases: []string{\"d\"},\n\t\t\t\tUsage: \"Enable debug-level logging\",\n\t\t\t\tDestination: &opts.Debug,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_DEBUG\"),\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"quiet\",\n\t\t\t\tUsage: \"Suppress all output except for errors; overrides --debug\",\n\t\t\t\tDestination: &opts.Quiet,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_QUIET\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"config\",\n\t\t\t\tUsage: \"Path to the config file\",\n\t\t\t\tDestination: &opts.Config,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_CTK_CONFIG\"),\n\t\t\t},\n\t\t},\n\t}\n\n\t// Run the CLI\n\terr := c.Run(context.Background(), os.Args)\n\tif err != nil {\n\t\tlogger.Errorf(\"%v\", err)\n\t\tos.Exit(1)\n\t}\n}\n\nfunc getCommands(logger logger.Interface, configFilePath *string) []*cli.Command {\n\treturn []*cli.Command{\n\t\thook.NewCommand(logger),\n\t\truntime.NewCommand(logger),\n\t\tinfoCLI.NewCommand(logger),\n\t\tcdi.NewCommand(logger, configFilePath),\n\t\tsystem.NewCommand(logger),\n\t\tconfig.NewCommand(logger),\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk/runtime/configure/configure.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage configure\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"path/filepath\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine/containerd\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine/crio\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine/docker\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/ocihook\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nconst (\n\tdefaultRuntime = \"docker\"\n\n\t// defaultNVIDIARuntimeName is the default name to use in configs for the NVIDIA Container Runtime\n\tdefaultNVIDIARuntimeName = \"nvidia\"\n\t// defaultNVIDIARuntimeExecutable is the default NVIDIA Container Runtime executable file name\n\tdefaultNVIDIARuntimeExecutable = \"nvidia-container-runtime\"\n\tdefaultNVIDIARuntimeExpecutablePath = \"/usr/bin/nvidia-container-runtime\"\n\tdefaultNVIDIARuntimeHookExpecutablePath = \"/usr/bin/nvidia-container-runtime-hook\"\n\n\tdefaultContainerdConfigFilePath = \"/etc/containerd/config.toml\"\n\tdefaultCrioConfigFilePath = \"/etc/crio/crio.conf\"\n\tdefaultDockerConfigFilePath = \"/etc/docker/daemon.json\"\n\n\tdefaultContainerdDropInConfigFilePath = \"/etc/containerd/conf.d/99-nvidia.toml\"\n\tdefaultCrioDropInConfigFilePath = \"/etc/crio/conf.d/99-nvidia.toml\"\n\n\tdefaultConfigSource = configSourceFile\n\tconfigSourceCommand = \"command\"\n\tconfigSourceFile = \"file\"\n\n\t// TODO: We may want to spend some time unifying the handling of config\n\t// files here with the Setup-Cleanup logic in nvidia-ctk-installer.\n\truntimeSpecificDefault = \"RUNTIME_SPECIFIC_DEFAULT\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\n// NewCommand constructs a configure command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// config defines the options that can be set for the CLI through config files,\n// environment variables, or command line config\ntype config struct {\n\tdryRun bool\n\truntime string\n\tconfigFilePath string\n\tdropInConfigPath string\n\texecutablePath string\n\tconfigSource string\n\tmode string\n\thookFilePath string\n\n\tnvidiaRuntime struct {\n\t\tname string\n\t\tpath string\n\t\thookPath string\n\t\tsetAsDefault bool\n\t}\n\n\t// cdi-specific options\n\tcdi struct {\n\t\tenabled bool\n\t}\n}\n\nfunc (m command) build() *cli.Command {\n\t// Create a config struct to hold the parsed environment variables or command line flags\n\tconfig := config{}\n\n\t// Create the 'configure' command\n\tconfigure := cli.Command{\n\t\tName: \"configure\",\n\t\tUsage: \"Add a runtime to the specified container engine\",\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(&config)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.configureWrapper(&config)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"dry-run\",\n\t\t\t\tUsage: \"update the runtime configuration as required but don't write changes to disk\",\n\t\t\t\tDestination: &config.dryRun,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"runtime\",\n\t\t\t\tUsage: \"the target runtime engine; one of [containerd, crio, docker]\",\n\t\t\t\tValue: defaultRuntime,\n\t\t\t\tDestination: &config.runtime,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"config\",\n\t\t\t\tUsage: \"path to the config file for the target runtime\",\n\t\t\t\tDestination: &config.configFilePath,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"drop-in-config\",\n\t\t\t\tUsage: \"path to the NVIDIA-specific config file to create. When specified, runtime configurations are saved to this file instead of modifying the main config file\",\n\t\t\t\tValue: runtimeSpecificDefault,\n\t\t\t\tDestination: &config.dropInConfigPath,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"executable-path\",\n\t\t\t\tUsage: \"The path to the runtime executable. This is used to extract the current config\",\n\t\t\t\tDestination: &config.executablePath,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"config-mode\",\n\t\t\t\tUsage: \"the config mode for runtimes that support multiple configuration mechanisms\",\n\t\t\t\tDestination: &config.mode,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"config-source\",\n\t\t\t\tUsage: \"the source to retrieve the container runtime configuration; one of [command, file]\\\"\",\n\t\t\t\tDestination: &config.configSource,\n\t\t\t\tValue: defaultConfigSource,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"oci-hook-path\",\n\t\t\t\tUsage: \"the path to the OCI runtime hook to create if --config-mode=oci-hook is specified. If no path is specified, the generated hook is output to STDOUT.\\n\\tNote: The use of OCI hooks is deprecated.\",\n\t\t\t\tDestination: &config.hookFilePath,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"nvidia-runtime-name\",\n\t\t\t\tUsage: \"specify the name of the NVIDIA runtime that will be added\",\n\t\t\t\tValue: defaultNVIDIARuntimeName,\n\t\t\t\tDestination: &config.nvidiaRuntime.name,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"nvidia-runtime-path\",\n\t\t\t\tAliases: []string{\"runtime-path\"},\n\t\t\t\tUsage: \"specify the path to the NVIDIA runtime executable\",\n\t\t\t\tValue: defaultNVIDIARuntimeExecutable,\n\t\t\t\tDestination: &config.nvidiaRuntime.path,\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"nvidia-runtime-hook-path\",\n\t\t\t\tUsage: \"specify the path to the NVIDIA Container Runtime hook executable\",\n\t\t\t\tValue: defaultNVIDIARuntimeHookExpecutablePath,\n\t\t\t\tDestination: &config.nvidiaRuntime.hookPath,\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"nvidia-set-as-default\",\n\t\t\t\tAliases: []string{\"set-as-default\"},\n\t\t\t\tUsage: \"set the NVIDIA runtime as the default runtime\",\n\t\t\t\tDestination: &config.nvidiaRuntime.setAsDefault,\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"cdi.enabled\",\n\t\t\t\tAliases: []string{\"cdi.enable\", \"enable-cdi\"},\n\t\t\t\tUsage: \"Enable CDI in the configured runtime\",\n\t\t\t\tDestination: &config.cdi.enabled,\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &configure\n}\n\nfunc (m command) validateFlags(config *config) error {\n\tif config.mode == \"oci-hook\" || config.mode == \"hook\" {\n\t\tm.logger.Warningf(\"The %q config-mode is deprecated\", config.mode)\n\t\tif !filepath.IsAbs(config.nvidiaRuntime.hookPath) {\n\t\t\treturn fmt.Errorf(\"the NVIDIA runtime hook path %q is not an absolute path\", config.nvidiaRuntime.hookPath)\n\t\t}\n\t\treturn nil\n\t}\n\tif config.mode != \"\" && config.mode != \"config-file\" && config.mode != \"config\" {\n\t\tm.logger.Warningf(\"Ignoring unsupported config mode for %v: %q\", config.runtime, config.mode)\n\t}\n\tconfig.mode = \"config-file\"\n\n\tswitch config.runtime {\n\tcase \"containerd\", \"crio\", \"docker\":\n\t\tbreak\n\tdefault:\n\t\treturn fmt.Errorf(\"unrecognized runtime '%v'\", config.runtime)\n\t}\n\n\tswitch config.runtime {\n\tcase \"containerd\", \"crio\":\n\t\tif config.nvidiaRuntime.path == defaultNVIDIARuntimeExecutable {\n\t\t\tconfig.nvidiaRuntime.path = defaultNVIDIARuntimeExpecutablePath\n\t\t}\n\t\tif !filepath.IsAbs(config.nvidiaRuntime.path) {\n\t\t\treturn fmt.Errorf(\"the NVIDIA runtime path %q is not an absolute path\", config.nvidiaRuntime.path)\n\t\t}\n\t}\n\n\tif config.runtime != \"containerd\" && config.runtime != \"docker\" {\n\t\tif config.cdi.enabled {\n\t\t\tm.logger.Warningf(\"Ignoring cdi.enabled flag for %v\", config.runtime)\n\t\t}\n\t\tconfig.cdi.enabled = false\n\t}\n\n\tif config.executablePath != \"\" && config.runtime == \"docker\" {\n\t\tm.logger.Warningf(\"Ignoring executable-path=%q flag for %v\", config.executablePath, config.runtime)\n\t\tconfig.executablePath = \"\"\n\t}\n\n\tswitch config.configSource {\n\tcase configSourceCommand:\n\t\tif config.runtime == \"docker\" {\n\t\t\tm.logger.Warningf(\"A %v Config Source is not supported for %v; using %v\", config.configSource, config.runtime, configSourceFile)\n\t\t\tconfig.configSource = configSourceFile\n\t\t}\n\tcase configSourceFile:\n\t\tbreak\n\tdefault:\n\t\treturn fmt.Errorf(\"unrecognized Config Source: %v\", config.configSource)\n\t}\n\n\tif config.configFilePath == \"\" {\n\t\tswitch config.runtime {\n\t\tcase \"containerd\":\n\t\t\tconfig.configFilePath = defaultContainerdConfigFilePath\n\t\tcase \"crio\":\n\t\t\tconfig.configFilePath = defaultCrioConfigFilePath\n\t\tcase \"docker\":\n\t\t\tconfig.configFilePath = defaultDockerConfigFilePath\n\t\t}\n\t}\n\n\tif config.dropInConfigPath == runtimeSpecificDefault {\n\t\tswitch config.runtime {\n\t\tcase \"containerd\":\n\t\t\tconfig.dropInConfigPath = defaultContainerdDropInConfigFilePath\n\t\tcase \"crio\":\n\t\t\tconfig.dropInConfigPath = defaultCrioDropInConfigFilePath\n\t\tcase \"docker\":\n\t\t\tconfig.dropInConfigPath = \"\"\n\t\t}\n\t}\n\n\tif config.dropInConfigPath != \"\" && config.runtime == \"docker\" {\n\t\treturn fmt.Errorf(\"runtime %v does not support drop-in configs\", config.runtime)\n\t}\n\n\tif config.dropInConfigPath != \"\" && !filepath.IsAbs(config.dropInConfigPath) {\n\t\treturn fmt.Errorf(\"the drop-in-config path %q is not an absolute path\", config.dropInConfigPath)\n\t}\n\n\treturn nil\n}\n\n// configureWrapper updates the specified container engine config to enable the NVIDIA runtime\nfunc (m command) configureWrapper(config *config) error {\n\tswitch config.mode {\n\tcase \"oci-hook\", \"hook\":\n\t\treturn m.configureOCIHook(config)\n\tcase \"config-file\", \"config\":\n\t\treturn m.configureConfigFile(config)\n\t}\n\treturn fmt.Errorf(\"unsupported config-mode: %v\", config.mode)\n}\n\n// configureConfigFile updates the specified container engine config file to enable the NVIDIA runtime.\nfunc (m command) configureConfigFile(config *config) error {\n\tconfigSource, err := config.resolveConfigSource()\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tvar cfg engine.Interface\n\tswitch config.runtime {\n\tcase \"containerd\":\n\t\tcfg, err = containerd.New(\n\t\t\tcontainerd.WithLogger(m.logger),\n\t\t\tcontainerd.WithTopLevelConfigPath(config.configFilePath),\n\t\t\tcontainerd.WithConfigSource(configSource),\n\t\t)\n\tcase \"crio\":\n\t\tcfg, err = crio.New(\n\t\t\tcrio.WithLogger(m.logger),\n\t\t\tcrio.WithTopLevelConfigPath(config.configFilePath),\n\t\t\tcrio.WithConfigSource(configSource),\n\t\t)\n\tcase \"docker\":\n\t\tcfg, err = docker.New(\n\t\t\tdocker.WithLogger(m.logger),\n\t\t\tdocker.WithPath(config.configFilePath),\n\t\t)\n\tdefault:\n\t\terr = fmt.Errorf(\"unrecognized runtime '%v'\", config.runtime)\n\t}\n\tif err != nil || cfg == nil {\n\t\treturn fmt.Errorf(\"unable to load config for runtime %v: %v\", config.runtime, err)\n\t}\n\n\terr = cfg.AddRuntime(\n\t\tconfig.nvidiaRuntime.name,\n\t\tconfig.nvidiaRuntime.path,\n\t\tconfig.nvidiaRuntime.setAsDefault,\n\t)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to update config: %v\", err)\n\t}\n\n\tif config.cdi.enabled {\n\t\tcfg.EnableCDI()\n\t}\n\n\toutputPath := config.getOutputConfigPath()\n\tn, err := cfg.Save(outputPath)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to flush config: %v\", err)\n\t}\n\n\tif outputPath != \"\" {\n\t\tif n == 0 {\n\t\t\tm.logger.Infof(\"Removed empty config from %v\", outputPath)\n\t\t} else {\n\t\t\tm.logger.Infof(\"Wrote updated config to %v\", outputPath)\n\t\t}\n\t\tm.logger.Infof(\"It is recommended that %v daemon be restarted.\", config.runtime)\n\t}\n\n\treturn nil\n}\n\n// resolveConfigSource returns the default config source or the user provided config source\nfunc (c *config) resolveConfigSource() (toml.Loader, error) {\n\tswitch c.configSource {\n\tcase configSourceCommand:\n\t\treturn c.getCommandConfigSource(), nil\n\tcase configSourceFile:\n\t\treturn toml.FromFile(c.configFilePath), nil\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"unrecognized config source: %s\", c.configSource)\n\t}\n}\n\n// getConfigSourceCommand returns the default cli command to fetch the current runtime config\nfunc (c *config) getCommandConfigSource() toml.Loader {\n\tswitch c.runtime {\n\tcase \"containerd\":\n\t\treturn containerd.CommandLineSource(\"\", c.executablePath)\n\tcase \"crio\":\n\t\treturn crio.CommandLineSource(\"\", c.executablePath)\n\t}\n\treturn toml.Empty\n}\n\n// getOutputConfigPath returns the configured config path or \"\" if dry-run is enabled\nfunc (c *config) getOutputConfigPath() string {\n\tif c.dryRun {\n\t\treturn engine.SaveToSTDOUT\n\t}\n\tif c.dropInConfigPath != \"\" {\n\t\treturn c.dropInConfigPath\n\t}\n\treturn c.configFilePath\n}\n\n// configureOCIHook creates and configures the OCI hook for the NVIDIA runtime\nfunc (m *command) configureOCIHook(config *config) error {\n\terr := ocihook.CreateHook(config.hookFilePath, config.nvidiaRuntime.hookPath)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error creating OCI hook: %v\", err)\n\t}\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk/runtime/configure/configure_test.go",
"content": "/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage configure\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n)\n\n// TestConfigureLifecycle tests the complete configure command lifecycle for all runtimes\nfunc TestConfigureLifecycle(t *testing.T) {\n\tdefer devices.SetAllForTest()()\n\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\targs []string\n\t\tprepareEnvironment func(*testing.T, string) error\n\t\texpectedError error\n\t\tassertConditions func(*testing.T, string) error\n\t}{\n\t\t// Containerd v2 test cases\n\t\t{\n\t\t\tdescription: \"containerd: config exists with imports\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"containerd\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/containerd/conf.d/99-nvidia.toml\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, testRoot string) error {\n\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/containerd/config.toml\")\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(configPath), 0755))\n\n\t\t\t\tinitialConfig := `version = 2\nimports = [\"/foo/bar/*.toml\"]\n`\n\t\t\t\treturn os.WriteFile(configPath, []byte(initialConfig), 0600)\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\tmainConfig := filepath.Join(testRoot, \"etc/containerd/config.toml\")\n\t\t\t\tcontent, err := os.ReadFile(mainConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedTemplate := `imports = [\"/foo/bar/*.toml\", \"{{ .testRoot }}/etc/containerd/conf.d/*.toml\"]\nversion = 2\n`\n\t\t\t\texpected := strings.ReplaceAll(expectedTemplate, \"{{ .testRoot }}\", testRoot)\n\n\t\t\t\trequire.Equal(t, expected, string(content))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"containerd: v2 config does not exist with drop-in\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"containerd\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/containerd/conf.d/99-nvidia.toml\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\t// Verify main config was created with imports\n\t\t\t\tmainConfig := filepath.Join(testRoot, \"etc/containerd/config.toml\")\n\t\t\t\trequire.FileExists(t, mainConfig)\n\n\t\t\t\tcontent, err := os.ReadFile(mainConfig)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(content), \"imports\")\n\t\t\t\trequire.Contains(t, string(content), \"version = 2\")\n\n\t\t\t\t// Verify drop-in was created\n\t\t\t\tdropIn := filepath.Join(testRoot, \"etc/containerd/conf.d/99-nvidia.toml\")\n\t\t\t\trequire.FileExists(t, dropIn)\n\n\t\t\t\tdropInContent, err := os.ReadFile(dropIn)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(dropInContent), \"[plugins.\\\"io.containerd.grpc.v1.cri\\\".containerd.runtimes.nvidia]\")\n\t\t\t\trequire.Contains(t, string(dropInContent), \"BinaryName = \\\"/usr/bin/nvidia-container-runtime\\\"\")\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"containerd: v2 existing config without nvidia runtime\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"containerd\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/containerd/conf.d/99-nvidia.toml\",\n\t\t\t\t\"--nvidia-set-as-default\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, testRoot string) error {\n\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/containerd/config.toml\")\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(configPath), 0755))\n\n\t\t\t\tinitialConfig := `version = 2\n\n[plugins]\n [plugins.\"io.containerd.grpc.v1.cri\"]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\treturn os.WriteFile(configPath, []byte(initialConfig), 0600)\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\t// Verify main config now has imports\n\t\t\t\tmainConfig := filepath.Join(testRoot, \"etc/containerd/config.toml\")\n\t\t\t\tcontent, err := os.ReadFile(mainConfig)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(content), \"imports\")\n\n\t\t\t\t// Verify drop-in was created with nvidia as default\n\t\t\t\tdropIn := filepath.Join(testRoot, \"etc/containerd/conf.d/99-nvidia.toml\")\n\t\t\t\trequire.FileExists(t, dropIn)\n\n\t\t\t\tdropInContent, err := os.ReadFile(dropIn)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(dropInContent), \"default_runtime_name = \\\"nvidia\\\"\")\n\t\t\t\trequire.Contains(t, string(dropInContent), \"[plugins.\\\"io.containerd.grpc.v1.cri\\\".containerd.runtimes.nvidia]\")\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t// TODO: v1 config behavior is complex and differs between nvidia-ctk and installer\n\t\t// The installer modifies v1 configs directly, while nvidia-ctk appears to only\n\t\t// create drop-ins. This test is commented out until the expected behavior is clarified.\n\t\t/*\n\t\t\t\t\t{\n\t\t\t\t\t\tdescription: \"containerd: v1 existing config\",\n\t\t\t\t\t\targs: []string{\n\t\t\t\t\t\t\t\"--runtime\", \"containerd\",\n\t\t\t\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/containerd/conf.d/99-nvidia.toml\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tprepareEnvironment: func(t *testing.T, testRoot string) error {\n\t\t\t\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/containerd/config.toml\")\n\t\t\t\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(configPath), 0755))\n\n\t\t\t\t\t\t\t// v1 config\n\t\t\t\t\t\t\tinitialConfig := `version = 1\n\n\t\t\t[plugins]\n\t\t\t [plugins.cri]\n\t\t\t [plugins.cri.containerd]\n\t\t\t default_runtime_name = \"runc\"\n\n\t\t\t [plugins.cri.containerd.runtimes]\n\t\t\t [plugins.cri.containerd.runtimes.runc]\n\t\t\t runtime_type = \"io.containerd.runtime.v1.linux\"\n\n\t\t\t [plugins.cri.containerd.runtimes.runc.options]\n\t\t\t Runtime = \"/usr/bin/runc\"\n\t\t\t`\n\t\t\t\t\t\t\treturn os.WriteFile(configPath, []byte(initialConfig), 0600)\n\t\t\t\t\t\t},\n\t\t\t\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\t\t\t\t// The behavior for v1 configs needs clarification\n\t\t\t\t\t\t\treturn nil\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t*/\n\t\t{\n\t\t\tdescription: \"containerd: enable CDI\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"containerd\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/containerd/conf.d/99-nvidia.toml\",\n\t\t\t\t\"--cdi.enabled\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\tdropIn := filepath.Join(testRoot, \"etc/containerd/conf.d/99-nvidia.toml\")\n\t\t\t\tcontent, err := os.ReadFile(dropIn)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(content), \"enable_cdi = true\")\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"containerd: custom runtime name and path\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"containerd\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/containerd/conf.d/99-nvidia.toml\",\n\t\t\t\t\"--nvidia-runtime-name\", \"gpu\",\n\t\t\t\t\"--nvidia-runtime-path\", \"/custom/path/nvidia-container-runtime\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\tdropIn := filepath.Join(testRoot, \"etc/containerd/conf.d/99-nvidia.toml\")\n\t\t\t\tcontent, err := os.ReadFile(dropIn)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(content), \"[plugins.\\\"io.containerd.grpc.v1.cri\\\".containerd.runtimes.gpu]\")\n\t\t\t\trequire.Contains(t, string(content), \"BinaryName = \\\"/custom/path/nvidia-container-runtime\\\"\")\n\t\t\t\t// Should NOT have legacy runtimes - only the single specified runtime is added\n\t\t\t\trequire.NotContains(t, string(content), \"gpu-cdi\")\n\t\t\t\trequire.NotContains(t, string(content), \"gpu-legacy\")\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\n\t\t// CRI-O test cases\n\t\t{\n\t\t\tdescription: \"crio: config does not exist with drop-in\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"crio\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/crio/crio.conf\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/crio/conf.d/99-nvidia.toml\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\t// Main config should not exist for crio when using drop-in\n\t\t\t\tmainConfig := filepath.Join(testRoot, \"etc/crio/crio.conf\")\n\t\t\t\trequire.NoFileExists(t, mainConfig)\n\n\t\t\t\t// Verify drop-in was created\n\t\t\t\tdropIn := filepath.Join(testRoot, \"etc/crio/conf.d/99-nvidia.toml\")\n\t\t\t\trequire.FileExists(t, dropIn)\n\n\t\t\t\tcontent, err := os.ReadFile(dropIn)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(content), \"[crio.runtime.runtimes.nvidia]\")\n\t\t\t\trequire.Contains(t, string(content), \"runtime_path = \\\"/usr/bin/nvidia-container-runtime\\\"\")\n\t\t\t\t// Should NOT have legacy runtimes - only the single specified runtime is added\n\t\t\t\trequire.NotContains(t, string(content), \"nvidia-cdi\")\n\t\t\t\trequire.NotContains(t, string(content), \"nvidia-legacy\")\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"crio: existing config with nvidia runtime\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"crio\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/crio/crio.conf\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/crio/conf.d/99-nvidia.toml\",\n\t\t\t\t\"--nvidia-set-as-default\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, testRoot string) error {\n\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/crio/crio.conf\")\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(configPath), 0755))\n\n\t\t\t\tconfigContent := `[crio]\n[crio.runtime]\ndefault_runtime = \"runc\"\n\n[crio.runtime.runtimes.runc]\nruntime_path = \"/usr/bin/runc\"\nruntime_type = \"oci\"\n\n[crio.runtime.runtimes.nvidia]\nruntime_path = \"/old/path/nvidia-container-runtime\"\nruntime_type = \"oci\"\n`\n\t\t\t\treturn os.WriteFile(configPath, []byte(configContent), 0600)\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\t// Original config should remain unchanged\n\t\t\t\tmainConfig := filepath.Join(testRoot, \"etc/crio/crio.conf\")\n\t\t\t\tcontent, err := os.ReadFile(mainConfig)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(content), \"/old/path/nvidia-container-runtime\")\n\n\t\t\t\t// Drop-in should override settings\n\t\t\t\tdropIn := filepath.Join(testRoot, \"etc/crio/conf.d/99-nvidia.toml\")\n\t\t\t\tdropInContent, err := os.ReadFile(dropIn)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Contains(t, string(dropInContent), \"default_runtime = \\\"nvidia\\\"\")\n\t\t\t\trequire.Contains(t, string(dropInContent), \"runtime_path = \\\"/usr/bin/nvidia-container-runtime\\\"\")\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\n\t\t// Docker test cases\n\t\t{\n\t\t\tdescription: \"docker: new JSON config\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"docker\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/docker/daemon.json\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/docker/daemon.json\")\n\t\t\t\trequire.FileExists(t, configPath)\n\n\t\t\t\tcontent, err := os.ReadFile(configPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\tvar dockerConfig map[string]interface{}\n\t\t\t\terr = json.Unmarshal(content, &dockerConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\truntimes := dockerConfig[\"runtimes\"].(map[string]interface{})\n\t\t\t\trequire.Contains(t, runtimes, \"nvidia\")\n\t\t\t\t// Should NOT have legacy runtimes - only the single specified runtime is added\n\t\t\t\trequire.NotContains(t, runtimes, \"nvidia-cdi\")\n\t\t\t\trequire.NotContains(t, runtimes, \"nvidia-legacy\")\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"docker: existing config with set as default\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"docker\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/docker/daemon.json\",\n\t\t\t\t\"--nvidia-set-as-default\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, testRoot string) error {\n\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/docker/daemon.json\")\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(configPath), 0755))\n\n\t\t\t\texistingConfig := map[string]interface{}{\n\t\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t\t},\n\t\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t\t}\n\n\t\t\t\tcontent, err := json.MarshalIndent(existingConfig, \"\", \" \")\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn os.WriteFile(configPath, content, 0600)\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/docker/daemon.json\")\n\t\t\t\tcontent, err := os.ReadFile(configPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\tvar dockerConfig map[string]interface{}\n\t\t\t\terr = json.Unmarshal(content, &dockerConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Verify existing settings preserved\n\t\t\t\trequire.Equal(t, \"json-file\", dockerConfig[\"log-driver\"])\n\t\t\t\trequire.Equal(t, \"overlay2\", dockerConfig[\"storage-driver\"])\n\n\t\t\t\t// Verify nvidia runtime added and set as default\n\t\t\t\trequire.Equal(t, \"nvidia\", dockerConfig[\"default-runtime\"])\n\t\t\t\truntimes := dockerConfig[\"runtimes\"].(map[string]interface{})\n\t\t\t\trequire.Contains(t, runtimes, \"nvidia\")\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"docker: enable CDI\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"docker\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/docker/daemon.json\",\n\t\t\t\t\"--cdi.enabled\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/docker/daemon.json\")\n\t\t\t\tcontent, err := os.ReadFile(configPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\tvar dockerConfig map[string]interface{}\n\t\t\t\terr = json.Unmarshal(content, &dockerConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\tfeatures := dockerConfig[\"features\"].(map[string]interface{})\n\t\t\t\trequire.Equal(t, true, features[\"cdi\"])\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\n\t\t// OCI Hook mode tests\n\t\t{\n\t\t\tdescription: \"oci-hook: create hook file\",\n\t\t\targs: []string{\n\t\t\t\t\"--config-mode\", \"oci-hook\",\n\t\t\t\t\"--oci-hook-path\", \"{{ .testRoot }}/etc/containers/oci/hooks.d/99-nvidia.json\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\thookPath := filepath.Join(testRoot, \"etc/containers/oci/hooks.d/99-nvidia.json\")\n\t\t\t\trequire.FileExists(t, hookPath)\n\n\t\t\t\tcontent, err := os.ReadFile(hookPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\tvar hook map[string]interface{}\n\t\t\t\terr = json.Unmarshal(content, &hook)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\trequire.Equal(t, \"1.0.0\", hook[\"version\"])\n\t\t\t\trequire.Contains(t, hook[\"stages\"], \"prestart\")\n\n\t\t\t\thookSpec := hook[\"hook\"].(map[string]interface{})\n\t\t\t\trequire.Equal(t, defaultNVIDIARuntimeHookExpecutablePath, hookSpec[\"path\"])\n\n\t\t\t\twhen := hook[\"when\"].(map[string]interface{})\n\t\t\t\trequire.Equal(t, true, when[\"always\"])\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\n\t\t// Dry-run test\n\t\t{\n\t\t\tdescription: \"dry-run: no files written\",\n\t\t\targs: []string{\n\t\t\t\t\"--dry-run\",\n\t\t\t\t\"--runtime\", \"containerd\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/containerd/conf.d/99-nvidia.toml\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\t// Verify no files were created\n\t\t\t\tmainConfig := filepath.Join(testRoot, \"etc/containerd/config.toml\")\n\t\t\t\trequire.NoFileExists(t, mainConfig)\n\n\t\t\t\tdropIn := filepath.Join(testRoot, \"etc/containerd/conf.d/99-nvidia.toml\")\n\t\t\t\trequire.NoFileExists(t, dropIn)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\n\t\t// Error cases\n\t\t{\n\t\t\tdescription: \"invalid runtime\",\n\t\t\targs: []string{\"--runtime\", \"invalid\"},\n\t\t\texpectedError: errUnrecognizedRuntime(\"invalid\"),\n\t\t},\n\t\t{\n\t\t\tdescription: \"invalid config-mode falls back to config-file\",\n\t\t\targs: []string{\n\t\t\t\t\"--config-mode\", \"invalid\",\n\t\t\t\t\"--runtime\", \"docker\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/docker/daemon.json\",\n\t\t\t},\n\t\t\tassertConditions: func(t *testing.T, testRoot string) error {\n\t\t\t\t// Invalid mode should be converted to config-file mode\n\t\t\t\tconfigPath := filepath.Join(testRoot, \"etc/docker/daemon.json\")\n\t\t\t\trequire.FileExists(t, configPath)\n\n\t\t\t\tcontent, err := os.ReadFile(configPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\tvar dockerConfig map[string]interface{}\n\t\t\t\terr = json.Unmarshal(content, &dockerConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Should have nvidia runtime added\n\t\t\t\truntimes := dockerConfig[\"runtimes\"].(map[string]interface{})\n\t\t\t\trequire.Contains(t, runtimes, \"nvidia\")\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\t// Create a temporary directory for the test\n\t\t\ttestRoot := t.TempDir()\n\n\t\t\t// Replace placeholders in args\n\t\t\targs := make([]string, len(tc.args))\n\t\t\tfor i, arg := range tc.args {\n\t\t\t\targs[i] = strings.ReplaceAll(arg, \"{{ .testRoot }}\", testRoot)\n\t\t\t}\n\n\t\t\t// Prepare the environment\n\t\t\tif tc.prepareEnvironment != nil {\n\t\t\t\trequire.NoError(t, tc.prepareEnvironment(t, testRoot))\n\t\t\t}\n\n\t\t\t// Create and run the command\n\t\t\tcmd := NewCommand(logger)\n\t\t\tapp := &cli.Command{\n\t\t\t\tName: \"test\",\n\t\t\t\tCommands: []*cli.Command{cmd},\n\t\t\t}\n\n\t\t\t// Prepend app name and command to args\n\t\t\tfullArgs := append([]string{\"test\", \"configure\"}, args...)\n\n\t\t\terr := app.Run(context.Background(), fullArgs)\n\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\trequire.Contains(t, err.Error(), tc.expectedError.Error())\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\tif tc.assertConditions != nil {\n\t\t\t\trequire.NoError(t, tc.assertConditions(t, testRoot))\n\t\t\t}\n\t\t})\n\t}\n}\n\n// TestConfigureCommandLineSource tests using command source for config\nfunc TestConfigureCommandLineSource(t *testing.T) {\n\tdefer devices.SetAllForTest()()\n\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\truntime string\n\t\targs []string\n\t\tprepareEnvironment func(*testing.T, string) error\n\t\texpectedError error\n\t\tassertConditions func(*testing.T, string) error\n\t}{\n\t\t{\n\t\t\tdescription: \"containerd: config from command\",\n\t\t\truntime: \"containerd\",\n\t\t\targs: []string{\n\t\t\t\t\"--runtime\", \"containerd\",\n\t\t\t\t\"--config-source\", \"command\",\n\t\t\t\t\"--executable-path\", \"{{ .testRoot }}/bin/containerd\",\n\t\t\t\t\"--config\", \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\t\"--drop-in-config\", \"{{ .testRoot }}/etc/containerd/conf.d/99-nvidia.toml\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, testRoot string) error {\n\t\t\t\t// Create a mock containerd executable that outputs config\n\t\t\t\tbinPath := filepath.Join(testRoot, \"bin/containerd\")\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(binPath), 0755)) //nolint:gosec\n\n\t\t\t\tmockScript := `#!/bin/sh\nif [ \"$1\" = \"config\" ] && [ \"$2\" = \"dump\" ]; then\ncat < %s\", linkPath, target)\n\t\tif m.dryRun {\n\t\t\tcontinue\n\t\t}\n\n\t\terr = os.Symlink(target, linkPath)\n\t\tif err != nil {\n\t\t\tm.logger.Warningf(\"Could not create symlink: %v\", err)\n\t\t}\n\t}\n\n\treturn nil\n}\n\ntype deviceNode struct {\n\tpath string\n\tmajor uint32\n\tminor uint32\n}\n\nfunc (d deviceNode) devCharName() string {\n\treturn fmt.Sprintf(\"%d:%d\", d.major, d.minor)\n}\n"
},
{
"path": "cmd/nvidia-ctk/system/create-dev-char-symlinks/existing.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage devchar\n\nimport (\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"golang.org/x/sys/unix\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\ntype nodeLister interface {\n\tDeviceNodes() ([]deviceNode, error)\n}\n\ntype existing struct {\n\tlogger logger.Interface\n\tdevRoot string\n}\n\n// DeviceNodes returns a list of NVIDIA device nodes in the specified root.\n// The nvidia-nvswitch* and nvidia-nvlink devices are excluded.\nfunc (m existing) DeviceNodes() ([]deviceNode, error) {\n\tlocator := lookup.AsOptional(\n\t\tlookup.NewCharDeviceLocator(\n\t\t\tlookup.WithLogger(m.logger),\n\t\t\tlookup.WithRoot(m.devRoot),\n\t\t),\n\t)\n\n\tdevices, err := locator.Locate(\"/dev/nvidia*\")\n\tif err != nil {\n\t\tm.logger.Warningf(\"Error while locating device: %v\", err)\n\t}\n\n\tcapDevices, err := locator.Locate(\"/dev/nvidia-caps/nvidia-*\")\n\tif err != nil {\n\t\tm.logger.Warningf(\"Error while locating caps device: %v\", err)\n\t}\n\n\tif len(devices) == 0 && len(capDevices) == 0 {\n\t\tm.logger.Infof(\"No NVIDIA devices found in %s\", m.devRoot)\n\t\treturn nil, nil\n\t}\n\n\tvar deviceNodes []deviceNode\n\tfor _, d := range append(devices, capDevices...) {\n\t\tif m.nodeIsBlocked(d) {\n\t\t\tcontinue\n\t\t}\n\t\tvar stat unix.Stat_t\n\t\terr := unix.Stat(d, &stat)\n\t\tif err != nil {\n\t\t\tm.logger.Warningf(\"Could not stat device: %v\", err)\n\t\t\tcontinue\n\t\t}\n\t\tdeviceNodes = append(deviceNodes, newDeviceNode(d, stat))\n\t}\n\n\treturn deviceNodes, nil\n}\n\n// nodeIsBlocked returns true if the specified device node should be ignored.\nfunc (m existing) nodeIsBlocked(path string) bool {\n\tblockedPrefixes := []string{\"nvidia-fs\", \"nvidia-nvswitch\", \"nvidia-nvlink\"}\n\tnodeName := filepath.Base(path)\n\tfor _, prefix := range blockedPrefixes {\n\t\tif strings.HasPrefix(nodeName, prefix) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n"
},
{
"path": "cmd/nvidia-ctk/system/create-dev-char-symlinks/existing_linux.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage devchar\n\nimport \"golang.org/x/sys/unix\"\n\nfunc newDeviceNode(d string, stat unix.Stat_t) deviceNode {\n\tdeviceNode := deviceNode{\n\t\tpath: d,\n\t\tmajor: unix.Major(stat.Rdev),\n\t\tminor: unix.Minor(stat.Rdev),\n\t}\n\treturn deviceNode\n}\n"
},
{
"path": "cmd/nvidia-ctk/system/create-dev-char-symlinks/existing_other.go",
"content": "//go:build !linux\n\n/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage devchar\n\nimport \"golang.org/x/sys/unix\"\n\nfunc newDeviceNode(d string, stat unix.Stat_t) deviceNode {\n\tdeviceNode := deviceNode{\n\t\tpath: d,\n\t\tmajor: unix.Major(uint64(stat.Rdev)),\n\t\tminor: unix.Minor(uint64(stat.Rdev)),\n\t}\n\treturn deviceNode\n}\n"
},
{
"path": "cmd/nvidia-ctk/system/create-device-nodes/create-device-nodes.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage createdevicenodes\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/system/nvdevices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/system/nvmodules\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\ntype options struct {\n\troot string\n\tdevRoot string\n\n\tdryRun bool\n\n\tcontrol bool\n\n\tloadKernelModules bool\n}\n\n// NewCommand constructs a command sub-command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\n// build\nfunc (m command) build() *cli.Command {\n\topts := options{}\n\n\tc := cli.Command{\n\t\tName: \"create-device-nodes\",\n\t\tUsage: \"A utility to create NVIDIA device nodes\",\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, m.validateFlags(&opts)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn m.run(&opts)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"root\",\n\t\t\t\t// TODO: Remove this alias\n\t\t\t\tAliases: []string{\"driver-root\"},\n\t\t\t\tUsage: \"the path to to the root to use to load the kernel modules. This root must be a chrootable path. \" +\n\t\t\t\t\t\"If device nodes to be created these will be created at `ROOT`/dev unless an alternative path is specified\",\n\t\t\t\tValue: \"/\",\n\t\t\t\tDestination: &opts.root,\n\t\t\t\t// TODO: Remove the NVIDIA_DRIVER_ROOT and DRIVER_ROOT envvars.\n\t\t\t\tSources: cli.EnvVars(\"ROOT\", \"NVIDIA_DRIVER_ROOT\", \"DRIVER_ROOT\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"dev-root\",\n\t\t\t\tUsage: \"specify the root where `/dev` is located. If this is not specified, the root is assumed.\",\n\t\t\t\tDestination: &opts.devRoot,\n\t\t\t\tSources: cli.EnvVars(\"NVIDIA_DEV_ROOT\", \"DEV_ROOT\"),\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"control-devices\",\n\t\t\t\tUsage: \"create all control device nodes: nvidiactl, nvidia-modeset, nvidia-uvm, nvidia-uvm-tools\",\n\t\t\t\tDestination: &opts.control,\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"load-kernel-modules\",\n\t\t\t\tUsage: \"load the NVIDIA Kernel Modules before creating devices nodes\",\n\t\t\t\tDestination: &opts.loadKernelModules,\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"dry-run\",\n\t\t\t\tUsage: \"if set, the command will not perform any operations\",\n\t\t\t\tValue: false,\n\t\t\t\tDestination: &opts.dryRun,\n\t\t\t\tSources: cli.EnvVars(\"DRY_RUN\"),\n\t\t\t},\n\t\t},\n\t}\n\n\treturn &c\n}\n\nfunc (m command) validateFlags(opts *options) error {\n\tif opts.devRoot == \"\" && opts.root != \"\" {\n\t\tm.logger.Infof(\"Using dev-root %q\", opts.root)\n\t\topts.devRoot = opts.root\n\t}\n\treturn nil\n}\n\nfunc (m command) run(opts *options) error {\n\tif opts.loadKernelModules {\n\t\tmodules := nvmodules.New(\n\t\t\tnvmodules.WithLogger(m.logger),\n\t\t\tnvmodules.WithDryRun(opts.dryRun),\n\t\t\tnvmodules.WithRoot(opts.root),\n\t\t)\n\t\tif err := modules.LoadAll(); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to load NVIDIA kernel modules: %v\", err)\n\t\t}\n\t}\n\n\tif opts.control {\n\t\tdevices, err := nvdevices.New(\n\t\t\tnvdevices.WithLogger(m.logger),\n\t\t\tnvdevices.WithDryRun(opts.dryRun),\n\t\t\tnvdevices.WithDevRoot(opts.devRoot),\n\t\t)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tm.logger.Infof(\"Creating control device nodes at %s\", opts.devRoot)\n\t\tif err := devices.CreateNVIDIAControlDevices(); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to create NVIDIA control device nodes: %v\", err)\n\t\t}\n\t}\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk/system/system.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage system\n\nimport (\n\t\"github.com/urfave/cli/v3\"\n\n\tdevchar \"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/system/create-dev-char-symlinks\"\n\tdevicenodes \"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk/system/create-device-nodes\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype command struct {\n\tlogger logger.Interface\n}\n\n// NewCommand constructs a runtime command with the specified logger\nfunc NewCommand(logger logger.Interface) *cli.Command {\n\tc := command{\n\t\tlogger: logger,\n\t}\n\treturn c.build()\n}\n\nfunc (m command) build() *cli.Command {\n\t// Create the 'system' command\n\tsystem := cli.Command{\n\t\tName: \"system\",\n\t\tUsage: \"A collection of system-related utilities for the NVIDIA Container Toolkit\",\n\t\tCommands: []*cli.Command{\n\t\t\tdevchar.NewCommand(m.logger),\n\t\t\tdevicenodes.NewCommand(m.logger),\n\t\t},\n\t}\n\n\treturn &system\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/README.md",
"content": "## Introduction\n\nThis repository contains tools that allow docker, containerd, or cri-o to be configured to use the NVIDIA Container Toolkit.\n\n*Note*: These were copied from the [`container-config` repository](https://gitlab.com/nvidia/container-toolkit/container-config/-/tree/383587f766a55177ede0e39e3810a974043e503e) are being migrated to commands installed with the NVIDIA Container Toolkit.\n\nThese will be migrated into an upcoming `nvidia-ctk` CLI as required.\n\n### Docker\n\nAfter building the `docker` binary, run:\n```bash\ndocker setup \\\n --runtime-name NAME \\\n /run/nvidia/toolkit\n```\n\nConfigure the `nvidia-container-runtime` as a docker runtime named `NAME`. If the `--runtime-name` flag is not specified, this runtime would be called `nvidia`.\n\nSince `--set-as-default` is enabled by default, the specified runtime name will also be set as the default docker runtime. This can be disabled by explicityly specifying `--set-as-default=false`.\n\nThe following table describes the behaviour for different `--runtime-name` and `--set-as-default` flag combinations.\n\n| Flags | Installed Runtimes | Default Runtime |\n|-------------------------------------------------------------|:--------------------------------|:----------------------|\n| **NONE SPECIFIED** | `nvidia` | `nvidia` |\n| `--runtime-name nvidia` | `nvidia` | `nvidia` |\n| `--runtime-name NAME` | `NAME` | `NAME` |\n| `--set-as-default` | `nvidia` | `nvidia` |\n| `--set-as-default --runtime-name nvidia` | `nvidia` | `nvidia` |\n| `--set-as-default --runtime-name NAME` | `NAME` | `NAME` |\n| `--set-as-default=false` | `nvidia` | **NOT SET** |\n| `--set-as-default=false --runtime-name NAME` | `NAME` | **NOT SET** |\n| `--set-as-default=false --runtime-name nvidia` | `nvidia` | **NOT SET** |\n\nThese combinations also hold for the environment variables that map to the command line flags: `DOCKER_RUNTIME_NAME`, `DOCKER_SET_AS_DEFAULT`.\n\n### Containerd\nAfter running the `containerd` binary, run:\n```bash\ncontainerd setup \\\n --runtime-class NAME \\\n /run/nvidia/toolkit\n```\n\nConfigure the `nvidia-container-runtime` as a runtime class named `NAME`. If the `--runtime-class` flag is not specified, this runtime would be called `nvidia`.\n\nAdding the `--set-as-default` flag as follows:\n```bash\ncontainerd setup \\\n --runtime-class NAME \\\n --set-as-default \\\n /run/nvidia/toolkit\n```\nwill set the runtime class `NAME` (or `nvidia` if not specified) as the default runtime class.\n\nThe following table describes the behaviour for different `--runtime-class` and `--set-as-default` flag combinations.\n\n| Flags | Installed Runtime Classes | Default Runtime Class |\n|--------------------------------------------------------|:--------------------------------|:----------------------|\n| **NONE SPECIFIED** | `nvidia` | **NOT SET** |\n| `--runtime-class NAME` | `NAME` | **NOT SET** |\n| `--runtime-class nvidia` | `nvidia` | **NOT SET** |\n| `--set-as-default` | `nvidia` | `nvidia` |\n| `--set-as-default --runtime-class NAME` | `NAME` | `NAME` |\n| `--set-as-default --runtime-class nvidia` | `nvidia` | `nvidia` |\n\nThese combinations also hold for the environment variables that map to the command line flags.\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/container.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage container\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"os\"\n\t\"os/exec\"\n\t\"strings\"\n\n\t\"github.com/sirupsen/logrus\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container/operator\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nconst (\n\trestartModeNone = \"none\"\n\trestartModeSignal = \"signal\"\n\trestartModeSystemd = \"systemd\"\n)\n\n// Options defines the shared options for the CLIs to configure containers runtimes.\ntype Options struct {\n\tDropInConfig string\n\tDropInConfigHostPath string\n\t// TopLevelConfigPath stores the path to the top-level config for the runtime.\n\tTopLevelConfigPath string\n\tSocket string\n\t// ExecutablePath specifies the path to the container runtime executable.\n\t// This is used to extract the current config, for example.\n\t// If a HostRootMount is specified, this path is relative to the host root\n\t// mount.\n\tExecutablePath string\n\t// EnabledCDI indicates whether CDI should be enabled.\n\tEnableCDI bool\n\tRuntimeName string\n\tRuntimeDir string\n\tSetAsDefault bool\n\tRestartMode string\n\tHostRootMount string\n\n\tConfigSources []string\n}\n\n// Configure applies the options to the specified config\nfunc (o Options) Configure(cfg engine.Interface) error {\n\terr := o.UpdateConfig(cfg)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to update config: %v\", err)\n\t}\n\treturn o.Flush(cfg)\n}\n\n// Unconfigure removes the options from the specified config\nfunc (o Options) Unconfigure(cfg engine.Interface) error {\n\terr := o.RevertConfig(cfg)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to update config: %v\", err)\n\t}\n\n\tif err := o.Flush(cfg); err != nil {\n\t\treturn err\n\t}\n\n\tif o.DropInConfig == \"\" {\n\t\treturn nil\n\t}\n\t// When a drop-in config is used, we remove the drop-in file explicitly.\n\t// This is require for cases where we may have to include other contents\n\t// in the drop-in file and as such it may not be empty when we flush it.\n\terr = os.Remove(o.DropInConfig)\n\tif err != nil && !errors.Is(err, os.ErrNotExist) {\n\t\treturn fmt.Errorf(\"failed to remove drop-in config file: %w\", err)\n\t}\n\n\treturn nil\n}\n\n// Flush flushes the specified config to disk\nfunc (o Options) Flush(cfg engine.Interface) error {\n\tfilepath := o.DropInConfig\n\tif filepath == \"\" {\n\t\tfilepath = o.TopLevelConfigPath\n\t}\n\tlogrus.Infof(\"Flushing config to %v\", filepath)\n\tn, err := cfg.Save(filepath)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to flush config: %v\", err)\n\t}\n\tif n == 0 {\n\t\tlogrus.Infof(\"Config file is empty, removed\")\n\t}\n\treturn nil\n}\n\n// UpdateConfig updates the specified config to include the nvidia runtimes\nfunc (o Options) UpdateConfig(cfg engine.Interface) error {\n\truntimes := operator.GetRuntimes(\n\t\toperator.WithNvidiaRuntimeName(o.RuntimeName),\n\t\toperator.WithSetAsDefault(o.SetAsDefault),\n\t\toperator.WithRoot(o.RuntimeDir),\n\t)\n\tfor name, runtime := range runtimes {\n\t\terr := cfg.AddRuntime(name, runtime.Path, runtime.SetAsDefault)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to update runtime %q: %v\", name, err)\n\t\t}\n\t}\n\n\tif o.EnableCDI {\n\t\tcfg.EnableCDI()\n\t}\n\n\treturn nil\n}\n\n// RevertConfig reverts the specified config to remove the nvidia runtimes\nfunc (o Options) RevertConfig(cfg engine.Interface) error {\n\truntimes := operator.GetRuntimes(\n\t\toperator.WithNvidiaRuntimeName(o.RuntimeName),\n\t\toperator.WithSetAsDefault(o.SetAsDefault),\n\t\toperator.WithRoot(o.RuntimeDir),\n\t)\n\tfor name := range runtimes {\n\t\terr := cfg.RemoveRuntime(name)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to remove runtime %q: %v\", name, err)\n\t\t}\n\t}\n\n\treturn nil\n}\n\n// Restart restarts the specified service\nfunc (o Options) Restart(service string, withSignal func(string) error) error {\n\tswitch o.RestartMode {\n\tcase restartModeNone:\n\t\tlogrus.Warningf(\"Skipping restart of %v due to --restart-mode=%v\", service, o.RestartMode)\n\t\treturn nil\n\tcase restartModeSignal:\n\t\treturn withSignal(o.Socket)\n\tcase restartModeSystemd:\n\t\treturn o.SystemdRestart(service)\n\t}\n\n\treturn fmt.Errorf(\"invalid restart mode specified: %v\", o.RestartMode)\n}\n\n// SystemdRestart restarts the specified service using systemd\nfunc (o Options) SystemdRestart(service string) error {\n\tvar args []string\n\tvar msg string\n\tif o.HostRootMount != \"\" {\n\t\tmsg = \" on host\"\n\t\targs = append(args, \"chroot\", o.HostRootMount)\n\t}\n\targs = append(args, \"systemctl\", \"restart\", service)\n\n\tlogrus.Infof(\"Restarting %v%v using systemd: %v\", service, msg, args)\n\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\tcmd := exec.Command(args[0], args[1:]...)\n\tcmd.Stdout = os.Stdout\n\tcmd.Stderr = os.Stderr\n\terr := cmd.Run()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error restarting %v using systemd: %v\", service, err)\n\t}\n\n\treturn nil\n}\n\n// GetConfigLoaders returns the loaders for the requested config sources.\n// Supported config sources can be specified as:\n//\n// * 'file[=path/to/file]': The specified file or the top-level config path is used.\n// * command: The runtime-specific function supplied as an argument is used.\nfunc (o Options) GetConfigLoaders(commandSourceFunc func(string, string) toml.Loader) ([]toml.Loader, error) {\n\tif len(o.ConfigSources) == 0 {\n\t\treturn []toml.Loader{toml.Empty}, nil\n\t}\n\tvar loaders []toml.Loader\n\tfor _, configSource := range o.ConfigSources {\n\t\tparts := strings.SplitN(configSource, \"=\", 2)\n\t\tsource := strings.TrimSpace(parts[0])\n\t\tswitch source {\n\t\tcase \"file\":\n\t\t\tfileSourcePath := o.TopLevelConfigPath\n\t\t\tif len(parts) > 1 {\n\t\t\t\tfileSourcePath = strings.TrimSpace(parts[1])\n\t\t\t}\n\t\t\tloaders = append(loaders, toml.FromFile(fileSourcePath))\n\t\tcase \"command\":\n\t\t\tif commandSourceFunc == nil {\n\t\t\t\tlogrus.Warnf(\"Ignoring command config source\")\n\t\t\t}\n\t\t\tif len(parts) > 1 {\n\t\t\t\tlogrus.Warnf(\"Ignoring additional command argument %q\", parts[1])\n\t\t\t}\n\t\t\tloaders = append(loaders, commandSourceFunc(o.HostRootMount, o.ExecutablePath))\n\t\tdefault:\n\t\t\treturn nil, fmt.Errorf(\"unsupported config source %q\", configSource)\n\t\t}\n\t}\n\treturn loaders, nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/operator/operator.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage operator\n\nimport \"path/filepath\"\n\nconst (\n\tdefaultRuntimeName = \"nvidia\"\n)\n\n// Runtime defines a runtime to be configured.\n// The path and whether the runtime is the default runtime can be specified\ntype Runtime struct {\n\tname string\n\tPath string\n\tSetAsDefault bool\n}\n\n// Runtimes defines a set of runtimes to be configured for use in the GPU Operator\ntype Runtimes map[string]Runtime\n\ntype config struct {\n\troot string\n\tnvidiaRuntimeName string\n\tsetAsDefault bool\n}\n\n// GetRuntimes returns the set of runtimes to be configured for use with the GPU Operator.\nfunc GetRuntimes(opts ...Option) Runtimes {\n\tc := &config{}\n\tfor _, opt := range opts {\n\t\topt(c)\n\t}\n\n\tif c.nvidiaRuntimeName == \"\" {\n\t\tc.nvidiaRuntimeName = defaultRuntimeName\n\t}\n\n\truntimes := make(Runtimes)\n\truntimes.add(c.nvidiaRuntime())\n\n\tmodes := []string{\"cdi\", \"legacy\"}\n\tfor _, mode := range modes {\n\t\truntimes.add(c.modeRuntime(mode))\n\t}\n\treturn runtimes\n}\n\n// DefaultRuntimeName returns the name of the default runtime.\nfunc (r Runtimes) DefaultRuntimeName() string {\n\tfor _, runtime := range r {\n\t\tif runtime.SetAsDefault {\n\t\t\treturn runtime.name\n\t\t}\n\t}\n\treturn \"\"\n}\n\n// Add a runtime to the set of runtimes.\nfunc (r Runtimes) add(runtime Runtime) {\n\tr[runtime.name] = runtime\n}\n\n// nvidiaRuntime creates a runtime that corresponds to the nvidia runtime.\n// If name is equal to one of the predefined runtimes, `nvidia` is used as the runtime name instead.\nfunc (c config) nvidiaRuntime() Runtime {\n\tpredefinedRuntimes := map[string]struct{}{\n\t\t\"nvidia-cdi\": {},\n\t\t\"nvidia-legacy\": {},\n\t}\n\tname := c.nvidiaRuntimeName\n\tif _, isPredefinedRuntime := predefinedRuntimes[name]; isPredefinedRuntime {\n\t\tname = defaultRuntimeName\n\t}\n\treturn c.newRuntime(name, \"nvidia-container-runtime\")\n}\n\n// modeRuntime creates a runtime for the specified mode.\nfunc (c config) modeRuntime(mode string) Runtime {\n\treturn c.newRuntime(\"nvidia-\"+mode, \"nvidia-container-runtime.\"+mode)\n}\n\n// newRuntime creates a runtime based on the configuration\nfunc (c config) newRuntime(name string, binary string) Runtime {\n\treturn Runtime{\n\t\tname: name,\n\t\tPath: filepath.Join(c.root, binary),\n\t\tSetAsDefault: c.setAsDefault && name == c.nvidiaRuntimeName,\n\t}\n}\n\n// Option is a functional option for configuring set of runtimes.\ntype Option func(*config)\n\n// WithRoot sets the root directory for the runtime binaries.\nfunc WithRoot(root string) Option {\n\treturn func(c *config) {\n\t\tc.root = root\n\t}\n}\n\n// WithNvidiaRuntimeName sets the name of the nvidia runtime.\nfunc WithNvidiaRuntimeName(name string) Option {\n\treturn func(c *config) {\n\t\tc.nvidiaRuntimeName = name\n\t}\n}\n\n// WithSetAsDefault sets the default runtime to the nvidia runtime.\nfunc WithSetAsDefault(set bool) Option {\n\treturn func(c *config) {\n\t\tc.setAsDefault = set\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/operator/operator_test.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage operator\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestOptions(t *testing.T) {\n\ttestCases := []struct {\n\t\tsetAsDefault bool\n\t\tnvidiaRuntimeName string\n\t\texpectedDefaultRuntime string\n\t\texpectedRuntimes Runtimes\n\t}{\n\t\t{\n\t\t\texpectedRuntimes: Runtimes{\n\t\t\t\t\"nvidia\": Runtime{\n\t\t\t\t\tname: \"nvidia\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime\",\n\t\t\t\t},\n\t\t\t\t\"nvidia-cdi\": Runtime{\n\t\t\t\t\tname: \"nvidia-cdi\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.cdi\",\n\t\t\t\t},\n\t\t\t\t\"nvidia-legacy\": Runtime{\n\t\t\t\t\tname: \"nvidia-legacy\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tsetAsDefault: true,\n\t\t\texpectedDefaultRuntime: \"nvidia\",\n\t\t\texpectedRuntimes: Runtimes{\n\t\t\t\t\"nvidia\": Runtime{\n\t\t\t\t\tname: \"nvidia\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime\",\n\t\t\t\t\tSetAsDefault: true,\n\t\t\t\t},\n\t\t\t\t\"nvidia-cdi\": Runtime{\n\t\t\t\t\tname: \"nvidia-cdi\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.cdi\",\n\t\t\t\t},\n\t\t\t\t\"nvidia-legacy\": Runtime{\n\t\t\t\t\tname: \"nvidia-legacy\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tsetAsDefault: true,\n\t\t\tnvidiaRuntimeName: \"nvidia\",\n\t\t\texpectedDefaultRuntime: \"nvidia\",\n\t\t\texpectedRuntimes: Runtimes{\n\t\t\t\t\"nvidia\": Runtime{\n\t\t\t\t\tname: \"nvidia\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime\",\n\t\t\t\t\tSetAsDefault: true,\n\t\t\t\t},\n\t\t\t\t\"nvidia-cdi\": Runtime{\n\t\t\t\t\tname: \"nvidia-cdi\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.cdi\",\n\t\t\t\t},\n\t\t\t\t\"nvidia-legacy\": Runtime{\n\t\t\t\t\tname: \"nvidia-legacy\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tsetAsDefault: true,\n\t\t\tnvidiaRuntimeName: \"NAME\",\n\t\t\texpectedDefaultRuntime: \"NAME\",\n\t\t\texpectedRuntimes: Runtimes{\n\t\t\t\t\"NAME\": Runtime{\n\t\t\t\t\tname: \"NAME\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime\",\n\t\t\t\t\tSetAsDefault: true,\n\t\t\t\t},\n\t\t\t\t\"nvidia-cdi\": Runtime{\n\t\t\t\t\tname: \"nvidia-cdi\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.cdi\",\n\t\t\t\t},\n\t\t\t\t\"nvidia-legacy\": Runtime{\n\t\t\t\t\tname: \"nvidia-legacy\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tsetAsDefault: false,\n\t\t\tnvidiaRuntimeName: \"NAME\",\n\t\t\texpectedRuntimes: Runtimes{\n\t\t\t\t\"NAME\": Runtime{\n\t\t\t\t\tname: \"NAME\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime\",\n\t\t\t\t},\n\t\t\t\t\"nvidia-cdi\": Runtime{\n\t\t\t\t\tname: \"nvidia-cdi\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.cdi\",\n\t\t\t\t},\n\t\t\t\t\"nvidia-legacy\": Runtime{\n\t\t\t\t\tname: \"nvidia-legacy\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-container-runtime.legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"%d\", i), func(t *testing.T) {\n\t\t\truntimes := GetRuntimes(\n\t\t\t\tWithNvidiaRuntimeName(tc.nvidiaRuntimeName),\n\t\t\t\tWithSetAsDefault(tc.setAsDefault),\n\t\t\t\tWithRoot(\"/usr/bin\"),\n\t\t\t)\n\n\t\t\trequire.EqualValues(t, tc.expectedRuntimes, runtimes)\n\t\t\trequire.Equal(t, tc.expectedDefaultRuntime, runtimes.DefaultRuntimeName())\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/containerd/config_test.go",
"content": "/*\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage containerd\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\tcli \"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container\"\n)\n\n// TestContainerdConfigLifecycle tests the complete Setup->Cleanup lifecycle for both v1 and v2 configs.\nfunc TestContainerdConfigLifecycle(t *testing.T) {\n\tc := &cli.Command{\n\t\tName: \"test\",\n\t}\n\n\t// TODO: Add test case for v1 and DropInConfig. This should fail.\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcontainerOptions container.Options\n\t\toptions Options\n\t\tprepareEnvironment func(*testing.T, *container.Options, *Options) error\n\t\texpectedSetupError error\n\t\tassertSetupPostConditions func(*testing.T, *container.Options, *Options) error\n\t\texpectedCleanupError error\n\t\tassertCleanupPostConditions func(*testing.T, *container.Options, *Options) error\n\t}{\n\t\t// V1 test cases\n\t\t// Note: We don't test \"v1: top-level config does not exist\" because new configs\n\t\t// are always created as v2 configs by the containerd package\n\t\t{\n\t\t\tdescription: \"v1: existing config without nvidia runtime\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tEnableCDI: true,\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write initial v1 config\n\t\t\t\tinitialConfig := `version = 1\n\n[plugins]\n [plugins.cri]\n [plugins.cri.containerd]\n default_runtime_name = \"runc\"\n\n [plugins.cri.containerd.runtimes]\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `version = 1\n\n[plugins]\n\n [plugins.cri]\n\n [plugins.cri.containerd]\n default_runtime_name = \"runc\"\n enable_cdi = true\n\n [plugins.cri.containerd.runtimes]\n\n [plugins.cri.containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n Runtime = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.cri.containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n Runtime = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.cri.containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n Runtime = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `version = 1\n\n[plugins]\n\n [plugins.cri]\n\n [plugins.cri.containerd]\n default_runtime_name = \"runc\"\n enable_cdi = true\n\n [plugins.cri.containerd.runtimes]\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v1: existing config with default_runtime_name and OPTIONS inheritance\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: true,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write initial v1 config without a default runtime set\n\t\t\t\t// This tests OPTIONS inheritance from an existing runtime\n\t\t\t\tinitialConfig := `version = 1\n\n[plugins]\n [plugins.cri]\n [plugins.cri.containerd]\n [plugins.cri.containerd.runtimes]\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n Root = \"/run/containerd/runc\"\n ShimDebug = true\n SystemdCgroup = true\n NoPivotRoot = false\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `version = 1\n\n[plugins]\n\n [plugins.cri]\n\n [plugins.cri.containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.cri.containerd.runtimes]\n\n [plugins.cri.containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n Runtime = \"/usr/bin/nvidia-container-runtime\"\n ShimDebug = true\n SystemdCgroup = true\n\n [plugins.cri.containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n Runtime = \"/usr/bin/nvidia-container-runtime.cdi\"\n ShimDebug = true\n SystemdCgroup = true\n\n [plugins.cri.containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n Runtime = \"/usr/bin/nvidia-container-runtime.legacy\"\n ShimDebug = true\n SystemdCgroup = true\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n Runtime = \"/usr/bin/runc\"\n ShimDebug = true\n SystemdCgroup = true\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `version = 1\n\n[plugins]\n\n [plugins.cri]\n\n [plugins.cri.containerd]\n\n [plugins.cri.containerd.runtimes]\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n Runtime = \"/usr/bin/runc\"\n ShimDebug = true\n SystemdCgroup = true\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v1: OPTIONS inheritance from default runtime specified by default_runtime_name\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false, // Don't change the default runtime\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Create config with default_runtime_name pointing to custom runtime\n\t\t\t\t// This tests that OPTIONS are inherited from the default runtime\n\t\t\t\tinitialConfig := `version = 1\n\n[plugins]\n [plugins.cri]\n [plugins.cri.containerd]\n default_runtime_name = \"custom\"\n\n [plugins.cri.containerd.runtimes]\n [plugins.cri.containerd.runtimes.custom]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.custom.options]\n Runtime = \"/usr/bin/custom-runtime\"\n Root = \"/custom/root\"\n ShimDebug = false\n SystemdCgroup = true\n NoPivotRoot = true\n CustomOption = \"custom-value\"\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Verify that nvidia runtimes inherit OPTIONS from the default runtime (custom)\n\t\t\t\texpected := `version = 1\n\n[plugins]\n\n [plugins.cri]\n\n [plugins.cri.containerd]\n default_runtime_name = \"custom\"\n\n [plugins.cri.containerd.runtimes]\n\n [plugins.cri.containerd.runtimes.custom]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.custom.options]\n CustomOption = \"custom-value\"\n NoPivotRoot = true\n Root = \"/custom/root\"\n Runtime = \"/usr/bin/custom-runtime\"\n ShimDebug = false\n SystemdCgroup = true\n\n [plugins.cri.containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n CustomOption = \"custom-value\"\n NoPivotRoot = true\n Root = \"/custom/root\"\n Runtime = \"/usr/bin/nvidia-container-runtime\"\n ShimDebug = false\n SystemdCgroup = true\n\n [plugins.cri.containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n CustomOption = \"custom-value\"\n NoPivotRoot = true\n Root = \"/custom/root\"\n Runtime = \"/usr/bin/nvidia-container-runtime.cdi\"\n ShimDebug = false\n SystemdCgroup = true\n\n [plugins.cri.containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n CustomOption = \"custom-value\"\n NoPivotRoot = true\n Root = \"/custom/root\"\n Runtime = \"/usr/bin/nvidia-container-runtime.legacy\"\n ShimDebug = false\n SystemdCgroup = true\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// After cleanup, should return to original state\n\t\t\t\texpected := `version = 1\n\n[plugins]\n\n [plugins.cri]\n\n [plugins.cri.containerd]\n default_runtime_name = \"custom\"\n\n [plugins.cri.containerd.runtimes]\n\n [plugins.cri.containerd.runtimes.custom]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.custom.options]\n CustomOption = \"custom-value\"\n NoPivotRoot = true\n Root = \"/custom/root\"\n Runtime = \"/usr/bin/custom-runtime\"\n ShimDebug = false\n SystemdCgroup = true\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v1: existing config with default_runtime_name set and restoration on cleanup\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: true,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write initial v1 config with default_runtime_name set to \"runc\"\n\t\t\t\tinitialConfig := `version = 1\n\n[plugins]\n [plugins.cri]\n [plugins.cri.containerd]\n default_runtime_name = \"runc\"\n\n [plugins.cri.containerd.runtimes]\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `version = 1\n\n[plugins]\n\n [plugins.cri]\n\n [plugins.cri.containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.cri.containerd.runtimes]\n\n [plugins.cri.containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n Runtime = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.cri.containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n Runtime = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.cri.containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n Runtime = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Current implementation limitation: default_runtime_name is deleted entirely\n\t\t\t\t// when the default runtime is removed, rather than being restored\n\t\t\t\texpected := `version = 1\n\n[plugins]\n\n [plugins.cri]\n\n [plugins.cri.containerd]\n\n [plugins.cri.containerd.runtimes]\n\n [plugins.cri.containerd.runtimes.runc]\n runtime_type = \"io.containerd.runtime.v1.linux\"\n\n [plugins.cri.containerd.runtimes.runc.options]\n Runtime = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t// V2 test cases\n\t\t{\n\t\t\tdescription: \"v2: top-level config does not exist\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoFileExists(t, co.TopLevelConfigPath)\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v2: top-level config does not exist with drop-in-config-host-path\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tDropInConfigHostPath: \"/some/host/path/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"/some/host/path/conf.d/*.toml\"]\nversion = 2\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfigHostPath)\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoFileExists(t, co.TopLevelConfigPath)\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v2: existing config without nvidia runtime and CDI enabled\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tEnableCDI: true,\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write initial config\n\t\t\t\tinitialConfig := `version = 2\n\n[plugins]\n [plugins.\"io.containerd.grpc.v1.cri\"]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\n\t\t\t\t// TODO (follow-up): Add a function to compare toml files by contents.\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n enable_cdi = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// TODO: What is the expectation here? Do we expect that the imports \\\n\t\t\t\t// are updated.\n\t\t\t\t// TODO: Add a test case, where the original config consists of only imports and version\n\t\t\t\t// with the imports referring to another location.\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v2: existing config with nvidia runtime using old path already present\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: true,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\tinitialConfig := `version = 2\n\n[plugins]\n [plugins.\"io.containerd.grpc.v1.cri\"]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/old/path/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/old/path/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\t// If file exists, verify nvidia runtimes were removed\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// TODO: Do we expect that the default_runtime = nvidia be removed?\n\t\t\t\t// TODO: Should the `nvidia` runtimes be removed from the top-level config?\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v2: complex config with multiple plugins and settings\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tEnableCDI: true,\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t\tContainerRuntimeModesCDIAnnotationPrefixes: []string{\"cdi.k8s.io\"},\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write initial complex config\n\t\t\t\tinitialConfig := `version = 2\nroot = \"/var/lib/containerd\"\nstate = \"/run/containerd\"\n\n[plugins]\n [plugins.\"io.containerd.grpc.v1.cri\"]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n snapshotter = \"overlayfs\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.custom]\n runtime_type = \"io.containerd.custom.v1\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.custom.options]\n TypeUrl = \"custom.runtime/options\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry]\n [plugins.\"io.containerd.grpc.v1.cri\".registry.mirrors]\n [plugins.\"io.containerd.grpc.v1.cri\".registry.mirrors.\"docker.io\"]\n endpoint = [\"https://registry-1.docker.io\"]\n\n [plugins.\"io.containerd.internal.v1.opt\"]\n path = \"/opt/containerd\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nroot = \"/var/lib/containerd\"\nstate = \"/run/containerd\"\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n snapshotter = \"overlayfs\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.custom]\n runtime_type = \"io.containerd.custom.v1\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.custom.options]\n TypeUrl = \"custom.runtime/options\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry]\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry.mirrors]\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry.mirrors.\"docker.io\"]\n endpoint = [\"https://registry-1.docker.io\"]\n\n [plugins.\"io.containerd.internal.v1.opt\"]\n path = \"/opt/containerd\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n enable_cdi = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n snapshotter = \"overlayfs\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.custom]\n runtime_type = \"io.containerd.custom.v1\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.custom.options]\n TypeUrl = \"custom.runtime/options\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n container_annotations = [\"cdi.k8s.io*\"]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n container_annotations = [\"cdi.k8s.io*\"]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n container_annotations = [\"cdi.k8s.io*\"]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry]\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry.mirrors]\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry.mirrors.\"docker.io\"]\n endpoint = [\"https://registry-1.docker.io\"]\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nroot = \"/var/lib/containerd\"\nstate = \"/run/containerd\"\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"runc\"\n snapshotter = \"overlayfs\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.custom]\n runtime_type = \"io.containerd.custom.v1\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.custom.options]\n TypeUrl = \"custom.runtime/options\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry]\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry.mirrors]\n\n [plugins.\"io.containerd.grpc.v1.cri\".registry.mirrors.\"docker.io\"]\n endpoint = [\"https://registry-1.docker.io\"]\n\n [plugins.\"io.containerd.internal.v1.opt\"]\n path = \"/opt/containerd\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v2: existing config without default runtime (SetAsDefault=false)\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write initial config without any default runtime\n\t\t\t\tinitialConfig := `version = 2\n\n[plugins]\n [plugins.\"io.containerd.grpc.v1.cri\"]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v2: existing config without default runtime (SetAsDefault=true)\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: true,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write initial config without any default runtime\n\t\t\t\tinitialConfig := `version = 2\n\n[plugins]\n [plugins.\"io.containerd.grpc.v1.cri\"]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// TODO: Add test where imports are already specified.\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t// V3 test cases\n\t\t{\n\t\t\tdescription: \"v3: minimal config without nvidia runtime\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write v3 config with runc runtime\n\t\t\t\tinitialConfig := `version = 3\n\n[plugins]\n [plugins.\"io.containerd.cri.v1.runtime\"]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Should return to original v3 config with just runc\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v3: existing config with runtime and OPTIONS inheritance\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: true,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write initial v3 config with a runtime that has custom OPTIONS\n\t\t\t\tinitialConfig := `version = 3\n\n[plugins]\n [plugins.\"io.containerd.cri.v1.runtime\"]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n default_runtime_name = \"runc\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n SystemdCgroup = true\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n default_runtime_name = \"runc\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n SystemdCgroup = true\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n SystemdCgroup = true\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n SystemdCgroup = true\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// After cleanup, should return to original state\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n default_runtime_name = \"runc\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n NoPivotRoot = false\n Root = \"/run/containerd/runc\"\n SystemdCgroup = true\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v3: minimal config using runtime config sources with extraneous spaces\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t\tConfigSources: []string{\" command\", \"file \"},\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write v3 config with runc runtime\n\t\t\t\tinitialConfig := `version = 3\n\n[plugins]\n [plugins.\"io.containerd.cri.v1.runtime\"]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Should return to original v3 config with just runc\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"v3: minimal config using runtime config sources with extraneous spaces in the config file name\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/containerd/config.toml\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t\tExecutablePath: \"not-containerd\",\n\t\t\t\tConfigSources: []string{\"command\", \"file= {{ .testRoot }}/etc/containerd/config.toml \"},\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\truntimeType: \"io.containerd.runc.v2\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\t// Write v3 config with runc runtime\n\t\t\t\tinitialConfig := `version = 3\n\n[plugins]\n [plugins.\"io.containerd.cri.v1.runtime\"]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `version = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-cdi]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-legacy]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"/usr/bin/nvidia-container-runtime.legacy\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Should return to original v3 config with just runc\n\t\t\t\texpected := `imports = [\"` + filepath.Dir(co.DropInConfig) + `/*.toml\"]\nversion = 3\n\n[plugins]\n\n [plugins.\"io.containerd.cri.v1.runtime\"]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.NoFileExists(t, co.DropInConfig)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\t// Set default options that would normally be set by the CLI.\n\t\tif tc.containerOptions.ConfigSources == nil {\n\t\t\ttc.containerOptions.ConfigSources = []string{\"command\", \"file\"}\n\t\t}\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\t// Create a temporary directory for the test\n\t\t\ttestRoot := t.TempDir()\n\n\t\t\t// Update paths\n\t\t\ttc.containerOptions.TopLevelConfigPath = strings.ReplaceAll(tc.containerOptions.TopLevelConfigPath, \"{{ .testRoot }}\", testRoot)\n\t\t\ttc.containerOptions.DropInConfig = strings.ReplaceAll(tc.containerOptions.DropInConfig, \"{{ .testRoot }}\", testRoot)\n\t\t\ttc.containerOptions.RuntimeDir = strings.ReplaceAll(tc.containerOptions.RuntimeDir, \"{{ .testRoot }}\", testRoot)\n\t\t\tvar testConfigSources []string\n\t\t\tfor _, configSource := range tc.containerOptions.ConfigSources {\n\t\t\t\ttestConfigSources = append(testConfigSources, strings.ReplaceAll(configSource, \"{{ .testRoot }}\", testRoot))\n\t\t\t}\n\t\t\ttc.containerOptions.ConfigSources = testConfigSources\n\n\t\t\t// Prepare the environment\n\t\t\tif tc.prepareEnvironment != nil {\n\t\t\t\trequire.NoError(t, tc.prepareEnvironment(t, &tc.containerOptions, &tc.options))\n\t\t\t}\n\n\t\t\terr := Setup(c, &tc.containerOptions, &tc.options)\n\t\t\trequire.EqualValues(t, tc.expectedSetupError, err)\n\n\t\t\tif tc.assertSetupPostConditions != nil {\n\t\t\t\trequire.NoError(t, tc.assertSetupPostConditions(t, &tc.containerOptions, &tc.options))\n\t\t\t}\n\n\t\t\terr = Cleanup(c, &tc.containerOptions, &tc.options)\n\t\t\trequire.EqualValues(t, tc.expectedCleanupError, err)\n\n\t\t\tif tc.assertCleanupPostConditions != nil {\n\t\t\t\trequire.NoError(t, tc.assertCleanupPostConditions(t, &tc.containerOptions, &tc.options))\n\t\t\t}\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/containerd/containerd.go",
"content": "/**\n# Copyright (c) 2020-2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage containerd\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"path/filepath\"\n\n\tlog \"github.com/sirupsen/logrus\"\n\tcli \"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine/containerd\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nconst (\n\tName = \"containerd\"\n\n\tDefaultConfig = \"/etc/containerd/config.toml\"\n\tDefaultDropInConfig = \"/etc/containerd/conf.d/99-nvidia.toml\"\n\n\tDefaultSocket = \"/run/containerd/containerd.sock\"\n\tDefaultRestartMode = \"signal\"\n\n\tdefaultRuntimeType = \"io.containerd.runc.v2\"\n)\n\n// Options stores the containerd-specific options\ntype Options struct {\n\tuseLegacyConfig bool\n\truntimeType string\n\n\tContainerRuntimeModesCDIAnnotationPrefixes []string\n\n\truntimeConfigOverrideJSON string\n}\n\nfunc Flags(opts *Options) []cli.Flag {\n\tflags := []cli.Flag{\n\t\t&cli.BoolFlag{\n\t\t\tName: \"use-legacy-config\",\n\t\t\tUsage: \"Specify whether a legacy (pre v1.3) config should be used. \" +\n\t\t\t\t\"This ensures that a version 1 container config is created by default and that the \" +\n\t\t\t\t\"containerd.runtimes.default_runtime config section is used to define the default \" +\n\t\t\t\t\"runtime instead of container.default_runtime_name.\",\n\t\t\tDestination: &opts.useLegacyConfig,\n\t\t\tSources: cli.EnvVars(\"CONTAINERD_USE_LEGACY_CONFIG\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"runtime-type\",\n\t\t\tUsage: \"The runtime_type to use for the configured runtime classes\",\n\t\t\tValue: defaultRuntimeType,\n\t\t\tDestination: &opts.runtimeType,\n\t\t\tSources: cli.EnvVars(\"CONTAINERD_RUNTIME_TYPE\"),\n\t\t},\n\t\t&cli.StringSliceFlag{\n\t\t\tName: \"nvidia-container-runtime-modes.cdi.annotation-prefixes\",\n\t\t\tDestination: &opts.ContainerRuntimeModesCDIAnnotationPrefixes,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"runtime-config-override\",\n\t\t\tDestination: &opts.runtimeConfigOverrideJSON,\n\t\t\tUsage: \"specify additional runtime options as a JSON string. The paths are relative to the runtime config.\",\n\t\t\tValue: \"{}\",\n\t\t\tSources: cli.EnvVars(\"RUNTIME_CONFIG_OVERRIDE\", \"CONTAINERD_RUNTIME_CONFIG_OVERRIDE\"),\n\t\t},\n\t}\n\n\treturn flags\n}\n\n// Setup updates a containerd configuration to include the nvidia-containerd-runtime and reloads it\nfunc Setup(c *cli.Command, o *container.Options, co *Options) error {\n\tlog.Infof(\"Starting 'setup' for %v\", c.Name)\n\n\tcfg, err := getRuntimeConfig(o, co)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to load config: %v\", err)\n\t}\n\n\terr = o.Configure(cfg)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to configure containerd: %v\", err)\n\t}\n\n\terr = RestartContainerd(o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to restart containerd: %v\", err)\n\t}\n\n\tlog.Infof(\"Completed 'setup' for %v\", c.Name)\n\n\treturn nil\n}\n\n// Cleanup reverts a containerd configuration to remove the nvidia-containerd-runtime and reloads it\nfunc Cleanup(c *cli.Command, o *container.Options, co *Options) error {\n\tlog.Infof(\"Starting 'cleanup' for %v\", c.Name)\n\n\tcfg, err := getRuntimeConfig(o, co)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to load config: %v\", err)\n\t}\n\n\terr = o.Unconfigure(cfg)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to unconfigure containerd: %v\", err)\n\t}\n\n\terr = RestartContainerd(o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to restart containerd: %v\", err)\n\t}\n\n\tlog.Infof(\"Completed 'cleanup' for %v\", c.Name)\n\n\treturn nil\n}\n\n// RestartContainerd restarts containerd depending on the value of restartModeFlag\nfunc RestartContainerd(o *container.Options) error {\n\treturn o.Restart(\"containerd\", SignalContainerd)\n}\n\n// containerAnnotationsFromCDIPrefixes returns the container annotations to set for the given CDI prefixes.\nfunc (o *Options) containerAnnotationsFromCDIPrefixes() []string {\n\tvar annotations []string\n\tfor _, prefix := range o.ContainerRuntimeModesCDIAnnotationPrefixes {\n\t\tannotations = append(annotations, prefix+\"*\")\n\t}\n\n\treturn annotations\n}\n\nfunc (o *Options) runtimeConfigOverride() (map[string]interface{}, error) {\n\tif o.runtimeConfigOverrideJSON == \"\" {\n\t\treturn nil, nil\n\t}\n\n\truntimeOptions := make(map[string]interface{})\n\tif err := json.Unmarshal([]byte(o.runtimeConfigOverrideJSON), &runtimeOptions); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to read %v as JSON: %w\", o.runtimeConfigOverrideJSON, err)\n\t}\n\n\treturn runtimeOptions, nil\n}\n\nfunc GetLowlevelRuntimePaths(o *container.Options, co *Options) ([]string, error) {\n\tcfg, err := getRuntimeConfig(o, co)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"unable to load containerd config: %w\", err)\n\t}\n\treturn engine.GetBinaryPathsForRuntimes(cfg), nil\n}\n\nfunc getRuntimeConfig(o *container.Options, co *Options) (engine.Interface, error) {\n\tloaders, err := o.GetConfigLoaders(containerd.CommandLineSource)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\toptions := []containerd.Option{\n\t\tcontainerd.WithTopLevelConfigPath(o.TopLevelConfigPath),\n\t\tcontainerd.WithConfigSource(\n\t\t\ttoml.LoadFirst(\n\t\t\t\tloaders...,\n\t\t\t),\n\t\t),\n\t\tcontainerd.WithRuntimeType(co.runtimeType),\n\t\tcontainerd.WithUseLegacyConfig(co.useLegacyConfig),\n\t\tcontainerd.WithContainerAnnotations(co.containerAnnotationsFromCDIPrefixes()...),\n\t}\n\tif o.DropInConfigHostPath != \"\" && o.DropInConfig != \"\" {\n\t\toptions = append(options,\n\t\t\tcontainerd.WithContainerPathAsHostPath(filepath.Dir(o.DropInConfig), filepath.Dir(o.DropInConfigHostPath)),\n\t\t)\n\t}\n\n\treturn containerd.New(options...)\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/containerd/containerd_linux.go",
"content": "/**\n# Copyright 2020-2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"fmt\"\n\t\"net\"\n\t\"syscall\"\n\t\"time\"\n\n\tlog \"github.com/sirupsen/logrus\"\n)\n\nconst (\n\treloadBackoff = 5 * time.Second\n\tmaxReloadAttempts = 6\n\n\tsocketMessageToGetPID = \"\"\n)\n\n// SignalContainerd sends a SIGHUP signal to the containerd daemon\nfunc SignalContainerd(socket string) error {\n\tlog.Infof(\"Sending SIGHUP signal to containerd\")\n\n\t// Wrap the logic to perform the SIGHUP in a function so we can retry it on failure\n\tretriable := func() error {\n\t\tconn, err := net.Dial(\"unix\", socket)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to dial: %v\", err)\n\t\t}\n\t\tdefer conn.Close()\n\n\t\tsconn, err := conn.(*net.UnixConn).SyscallConn()\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to get syscall connection: %v\", err)\n\t\t}\n\n\t\terr1 := sconn.Control(func(fd uintptr) {\n\t\t\terr = syscall.SetsockoptInt(int(fd), syscall.SOL_SOCKET, syscall.SO_PASSCRED, 1)\n\t\t})\n\t\tif err1 != nil {\n\t\t\treturn fmt.Errorf(\"unable to issue call on socket fd: %v\", err1)\n\t\t}\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to SetsockoptInt on socket fd: %v\", err)\n\t\t}\n\n\t\t_, _, err = conn.(*net.UnixConn).WriteMsgUnix([]byte(socketMessageToGetPID), nil, nil)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to WriteMsgUnix on socket fd: %v\", err)\n\t\t}\n\n\t\toob := make([]byte, 1024)\n\t\t_, oobn, _, _, err := conn.(*net.UnixConn).ReadMsgUnix(nil, oob)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to ReadMsgUnix on socket fd: %v\", err)\n\t\t}\n\n\t\toob = oob[:oobn]\n\t\tscm, err := syscall.ParseSocketControlMessage(oob)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to ParseSocketControlMessage from message received on socket fd: %v\", err)\n\t\t}\n\n\t\tucred, err := syscall.ParseUnixCredentials(&scm[0])\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to ParseUnixCredentials from message received on socket fd: %v\", err)\n\t\t}\n\n\t\terr = syscall.Kill(int(ucred.Pid), syscall.SIGHUP)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to send SIGHUP to 'containerd' process: %v\", err)\n\t\t}\n\n\t\treturn nil\n\t}\n\n\t// Try to send a SIGHUP up to maxReloadAttempts times\n\tvar err error\n\tfor i := 0; i < maxReloadAttempts; i++ {\n\t\terr = retriable()\n\t\tif err == nil {\n\t\t\tbreak\n\t\t}\n\t\tif i == maxReloadAttempts-1 {\n\t\t\tbreak\n\t\t}\n\t\tlog.Warningf(\"Error signaling containerd, attempt %v/%v: %v\", i+1, maxReloadAttempts, err)\n\t\ttime.Sleep(reloadBackoff)\n\t}\n\tif err != nil {\n\t\tlog.Warningf(\"Max retries reached %v/%v, aborting\", maxReloadAttempts, maxReloadAttempts)\n\t\treturn err\n\t}\n\n\tlog.Infof(\"Successfully signaled containerd\")\n\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/containerd/containerd_other.go",
"content": "//go:build !linux\n\n/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"errors\"\n)\n\n// SignalContainerd is unsupported on non-linux platforms.\nfunc SignalContainerd(socket string) error {\n\treturn errors.New(\"SignalContainerd is unsupported on non-linux platforms\")\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/containerd/containerd_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRuntimeOptions(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\toptions Options\n\t\texpected map[string]interface{}\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"empty is nil\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty json\",\n\t\t\toptions: Options{\n\t\t\t\truntimeConfigOverrideJSON: \"{}\",\n\t\t\t},\n\t\t\texpected: map[string]interface{}{},\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"SystemdCgroup is true\",\n\t\t\toptions: Options{\n\t\t\t\truntimeConfigOverrideJSON: \"{\\\"SystemdCgroup\\\": true}\",\n\t\t\t},\n\t\t\texpected: map[string]interface{}{\n\t\t\t\t\"SystemdCgroup\": true,\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"SystemdCgroup is false\",\n\t\t\toptions: Options{\n\t\t\t\truntimeConfigOverrideJSON: \"{\\\"SystemdCgroup\\\": false}\",\n\t\t\t},\n\t\t\texpected: map[string]interface{}{\n\t\t\t\t\"SystemdCgroup\": false,\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\truntimeOptions, err := tc.options.runtimeConfigOverride()\n\t\t\trequire.ErrorIs(t, tc.expectedError, err)\n\t\t\trequire.EqualValues(t, tc.expected, runtimeOptions)\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/crio/config_test.go",
"content": "/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage crio\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\tcli \"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container\"\n)\n\n// TestCrioConfigLifecycle tests the complete Setup->Cleanup lifecycle for both config and hook modes\nfunc TestCrioConfigLifecycle(t *testing.T) {\n\tc := &cli.Command{\n\t\tName: \"test\",\n\t}\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcontainerOptions container.Options\n\t\toptions Options\n\t\tprepareEnvironment func(*testing.T, *container.Options, *Options) error\n\t\texpectedSetupError error\n\t\tassertSetupPostConditions func(*testing.T, *container.Options, *Options) error\n\t\texpectedCleanupError error\n\t\tassertCleanupPostConditions func(*testing.T, *container.Options, *Options) error\n\t}{\n\t\t{\n\t\t\tdescription: \"config mode: top-level config does not exist\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/crio/crio.conf\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\tconfigMode: \"config\",\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, _ *Options) error {\n\t\t\t\trequire.NoFileExists(t, co.TopLevelConfigPath)\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactual, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `\n[crio]\n\n [crio.runtime]\n\n [crio.runtime.runtimes]\n\n [crio.runtime.runtimes.nvidia]\n runtime_path = \"/usr/bin/nvidia-container-runtime\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-cdi]\n runtime_path = \"/usr/bin/nvidia-container-runtime.cdi\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-legacy]\n runtime_path = \"/usr/bin/nvidia-container-runtime.legacy\"\n runtime_type = \"oci\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, _ *Options) error {\n\t\t\t\trequire.NoFileExists(t, co.TopLevelConfigPath)\n\t\t\t\t// drop-in file not removed on cleanup\n\t\t\t\tactual, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `\n[crio]\n\n [crio.runtime]\n\n [crio.runtime.runtimes]\n\n [crio.runtime.runtimes.nvidia]\n runtime_path = \"/usr/bin/nvidia-container-runtime\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-cdi]\n runtime_path = \"/usr/bin/nvidia-container-runtime.cdi\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-legacy]\n runtime_path = \"/usr/bin/nvidia-container-runtime.legacy\"\n runtime_type = \"oci\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"config mode: existing config without nvidia runtime\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/crio/crio.conf\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\tconfigMode: \"config\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, _ *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\tconfigContent := `[crio]\n[crio.runtime]\ndefault_runtime = \"crun\"\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\nruntime_root = \"/run/crun\"\nmonitor_path = \"/usr/libexec/crio/conmon\"\n\n[crio.image]\nsignature_policy = \"/etc/crio/policy.json\"\n`\n\t\t\t\terr := os.WriteFile(co.TopLevelConfigPath, []byte(configContent), 0600)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, _ *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactualTopLevel, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedTopLevel := `[crio]\n[crio.runtime]\ndefault_runtime = \"crun\"\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\nruntime_root = \"/run/crun\"\nmonitor_path = \"/usr/libexec/crio/conmon\"\n\n[crio.image]\nsignature_policy = \"/etc/crio/policy.json\"\n`\n\n\t\t\t\trequire.Equal(t, expectedTopLevel, string(actualTopLevel))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\t\t\t\tactual, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `\n[crio]\n\n [crio.runtime]\n\n [crio.runtime.runtimes]\n\n [crio.runtime.runtimes.nvidia]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-cdi]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime.cdi\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-legacy]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime.legacy\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactualTopLevel, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Leaves original config unchanged\n\t\t\t\texpectedTopLevel := `[crio]\n[crio.runtime]\ndefault_runtime = \"crun\"\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\nruntime_root = \"/run/crun\"\nmonitor_path = \"/usr/libexec/crio/conmon\"\n\n[crio.image]\nsignature_policy = \"/etc/crio/policy.json\"\n`\n\t\t\t\trequire.Equal(t, expectedTopLevel, string(actualTopLevel))\n\n\t\t\t\t// drop-in file not removed on cleanup\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\t\t\t\tactual, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `\n[crio]\n\n [crio.runtime]\n\n [crio.runtime.runtimes]\n\n [crio.runtime.runtimes.nvidia]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-cdi]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime.cdi\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-legacy]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime.legacy\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"config mode: existing config with nvidia runtime already present\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/crio/crio.conf\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: true,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\tconfigMode: \"config\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, _ *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\tconfigContent := `[crio]\n[crio.runtime]\ndefault_runtime = \"nvidia\"\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\n\n[crio.runtime.runtimes.nvidia]\nruntime_path = \"/old/path/nvidia-container-runtime\"\nruntime_type = \"oci\"\n`\n\t\t\t\terr := os.WriteFile(co.TopLevelConfigPath, []byte(configContent), 0600)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, _ *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactualTopLevel, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// TODO: Do we expect the top-level config to change? i.e. Should\n\t\t\t\t// we REMOVE the default_runtime = \"nvidia\" setting?\n\t\t\t\texpectedTopLevel := `[crio]\n[crio.runtime]\ndefault_runtime = \"nvidia\"\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\n\n[crio.runtime.runtimes.nvidia]\nruntime_path = \"/old/path/nvidia-container-runtime\"\nruntime_type = \"oci\"\n`\n\n\t\t\t\trequire.Equal(t, expectedTopLevel, string(actualTopLevel))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactual, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `\n[crio]\n\n [crio.runtime]\n default_runtime = \"nvidia\"\n\n [crio.runtime.runtimes]\n\n [crio.runtime.runtimes.nvidia]\n runtime_path = \"/usr/bin/nvidia-container-runtime\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-cdi]\n runtime_path = \"/usr/bin/nvidia-container-runtime.cdi\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-legacy]\n runtime_path = \"/usr/bin/nvidia-container-runtime.legacy\"\n runtime_type = \"oci\"\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactualTopLevel, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// TODO: Do we expect the top-level config to change? i.e. Should\n\t\t\t\t// we REMOVE the default_runtime = \"nvidia\" setting?\n\t\t\t\texpectedTopLevel := `[crio]\n[crio.runtime]\ndefault_runtime = \"nvidia\"\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\n\n[crio.runtime.runtimes.nvidia]\nruntime_path = \"/old/path/nvidia-container-runtime\"\nruntime_type = \"oci\"\n`\n\n\t\t\t\trequire.Equal(t, expectedTopLevel, string(actualTopLevel))\n\n\t\t\t\t// drop-in file not removed on cleanup\n\t\t\t\t// default_runtime setting removed from drop-in\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\t\t\t\tactual, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `\n[crio]\n\n [crio.runtime]\n\n [crio.runtime.runtimes]\n\n [crio.runtime.runtimes.nvidia]\n runtime_path = \"/usr/bin/nvidia-container-runtime\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-cdi]\n runtime_path = \"/usr/bin/nvidia-container-runtime.cdi\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-legacy]\n runtime_path = \"/usr/bin/nvidia-container-runtime.legacy\"\n runtime_type = \"oci\"\n`\n\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"config mode: complex config with multiple settings\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tTopLevelConfigPath: \"{{ .testRoot }}/etc/crio/crio.conf\",\n\t\t\t\tDropInConfig: \"{{ .testRoot }}/conf.d/99-nvidia.toml\",\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tSetAsDefault: false,\n\t\t\t\tRestartMode: \"none\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\tconfigMode: \"config\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, _ *Options) error {\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))\n\n\t\t\t\tconfigContent := `[crio]\n[crio.runtime]\ndefault_runtime = \"crun\"\nconmon = \"/usr/libexec/crio/conmon\"\nconmon_cgroup = \"pod\"\nselinux = true\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\nruntime_root = \"/run/crun\"\nmonitor_path = \"/usr/libexec/crio/conmon\"\n\n[crio.runtime.runtimes.runc]\nruntime_path = \"/usr/bin/runc\"\nruntime_type = \"oci\"\nruntime_root = \"/run/runc\"\n\n[crio.image]\nsignature_policy = \"/etc/crio/policy.json\"\ninsecure_registries = [\n \"localhost:5000\"\n]\n\n[crio.network]\nnetwork_dir = \"/etc/cni/net.d/\"\nplugin_dirs = [\n \"/opt/cni/bin\",\n \"/usr/libexec/cni\"\n]\n`\n\t\t\t\terr := os.WriteFile(co.TopLevelConfigPath, []byte(configContent), 0600)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, _ *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `[crio]\n[crio.runtime]\ndefault_runtime = \"crun\"\nconmon = \"/usr/libexec/crio/conmon\"\nconmon_cgroup = \"pod\"\nselinux = true\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\nruntime_root = \"/run/crun\"\nmonitor_path = \"/usr/libexec/crio/conmon\"\n\n[crio.runtime.runtimes.runc]\nruntime_path = \"/usr/bin/runc\"\nruntime_type = \"oci\"\nruntime_root = \"/run/runc\"\n\n[crio.image]\nsignature_policy = \"/etc/crio/policy.json\"\ninsecure_registries = [\n \"localhost:5000\"\n]\n\n[crio.network]\nnetwork_dir = \"/etc/cni/net.d/\"\nplugin_dirs = [\n \"/opt/cni/bin\",\n \"/usr/libexec/cni\"\n]\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `\n[crio]\n\n [crio.runtime]\n\n [crio.runtime.runtimes]\n\n [crio.runtime.runtimes.nvidia]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-cdi]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime.cdi\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-legacy]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime.legacy\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\trequire.FileExists(t, co.TopLevelConfigPath)\n\n\t\t\t\tactual, err := os.ReadFile(co.TopLevelConfigPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\t// Should restore to original complex config\n\t\t\t\texpected := `[crio]\n[crio.runtime]\ndefault_runtime = \"crun\"\nconmon = \"/usr/libexec/crio/conmon\"\nconmon_cgroup = \"pod\"\nselinux = true\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/bin/crun\"\nruntime_type = \"oci\"\nruntime_root = \"/run/crun\"\nmonitor_path = \"/usr/libexec/crio/conmon\"\n\n[crio.runtime.runtimes.runc]\nruntime_path = \"/usr/bin/runc\"\nruntime_type = \"oci\"\nruntime_root = \"/run/runc\"\n\n[crio.image]\nsignature_policy = \"/etc/crio/policy.json\"\ninsecure_registries = [\n \"localhost:5000\"\n]\n\n[crio.network]\nnetwork_dir = \"/etc/cni/net.d/\"\nplugin_dirs = [\n \"/opt/cni/bin\",\n \"/usr/libexec/cni\"\n]\n`\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\t// drop-in file not removed on cleanup\n\t\t\t\trequire.FileExists(t, co.DropInConfig)\n\t\t\t\tactualDropIn, err := os.ReadFile(co.DropInConfig)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpectedDropIn := `\n[crio]\n\n [crio.runtime]\n\n [crio.runtime.runtimes]\n\n [crio.runtime.runtimes.nvidia]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-cdi]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime.cdi\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n\n [crio.runtime.runtimes.nvidia-legacy]\n monitor_path = \"/usr/libexec/crio/conmon\"\n runtime_path = \"/usr/bin/nvidia-container-runtime.legacy\"\n runtime_root = \"/run/crun\"\n runtime_type = \"oci\"\n`\n\t\t\t\trequire.Equal(t, expectedDropIn, string(actualDropIn))\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t// Hook mode test cases\n\t\t{\n\t\t\tdescription: \"hook mode: no existing hook\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tRestartMode: \"none\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\tconfigMode: \"hook\",\n\t\t\t\thooksDir: \"{{ .testRoot }}/etc/crio/hooks.d\",\n\t\t\t\thookFilename: \"99-nvidia.json\",\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\thookPath := filepath.Join(o.hooksDir, o.hookFilename)\n\t\t\t\trequire.FileExists(t, hookPath)\n\n\t\t\t\tactual, err := os.ReadFile(hookPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `{\n \"version\": \"1.0.0\",\n \"hook\": {\n \"path\": \"/usr/bin/nvidia-container-runtime-hook\",\n \"args\": [\n \"nvidia-container-runtime-hook\",\n \"prestart\"\n ],\n \"env\": [\n \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\"\n ]\n },\n \"when\": {\n \"always\": true,\n \"commands\": [\n \".*\"\n ]\n },\n \"stages\": [\n \"prestart\"\n ]\n}\n`\n\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\thookPath := filepath.Join(o.hooksDir, o.hookFilename)\n\t\t\t\trequire.NoFileExists(t, hookPath)\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"hook mode: existing hook file\",\n\t\t\tcontainerOptions: container.Options{\n\t\t\t\tRuntimeName: \"nvidia\",\n\t\t\t\tRuntimeDir: \"/usr/bin\",\n\t\t\t\tRestartMode: \"none\",\n\t\t\t},\n\t\t\toptions: Options{\n\t\t\t\tconfigMode: \"hook\",\n\t\t\t\thooksDir: \"{{ .testRoot }}/etc/crio/hooks.d\",\n\t\t\t\thookFilename: \"99-nvidia.json\",\n\t\t\t},\n\t\t\tprepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\thookPath := filepath.Join(o.hooksDir, o.hookFilename)\n\t\t\t\trequire.NoError(t, os.MkdirAll(filepath.Dir(hookPath), 0755))\n\n\t\t\t\t// Create existing hook with old path\n\t\t\t\texistingHookJSON := `{\n \"version\": \"1.0.0\",\n \"hook\": {\n \"path\": \"/old/path/nvidia-container-runtime-hook\",\n \"args\": [\n \"nvidia-container-runtime-hook\",\n \"prestart\"\n ]\n },\n \"when\": {\n \"always\": true\n },\n \"stages\": [\n \"prestart\"\n ]\n}`\n\n\t\t\t\terr := os.WriteFile(hookPath, []byte(existingHookJSON), 0600)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\thookPath := filepath.Join(o.hooksDir, o.hookFilename)\n\t\t\t\trequire.FileExists(t, hookPath)\n\n\t\t\t\tactual, err := os.ReadFile(hookPath)\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\texpected := `{\n \"version\": \"1.0.0\",\n \"hook\": {\n \"path\": \"/usr/bin/nvidia-container-runtime-hook\",\n \"args\": [\n \"nvidia-container-runtime-hook\",\n \"prestart\"\n ],\n \"env\": [\n \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\"\n ]\n },\n \"when\": {\n \"always\": true,\n \"commands\": [\n \".*\"\n ]\n },\n \"stages\": [\n \"prestart\"\n ]\n}\n`\n\n\t\t\t\trequire.Equal(t, expected, string(actual))\n\n\t\t\t\treturn nil\n\t\t\t},\n\t\t\tassertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {\n\t\t\t\thookPath := filepath.Join(o.hooksDir, o.hookFilename)\n\t\t\t\trequire.NoFileExists(t, hookPath)\n\t\t\t\treturn nil\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\t// Set default options that would normally be set by the CLI.\n\t\tif tc.containerOptions.ConfigSources == nil {\n\t\t\ttc.containerOptions.ConfigSources = []string{\"command\", \"file\"}\n\t\t}\n\t\ttc.options.hookFilename = \"99-nvidia.json\"\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\t// Update any paths as required\n\t\t\ttestRoot := t.TempDir()\n\t\t\ttc.containerOptions.TopLevelConfigPath = strings.ReplaceAll(tc.containerOptions.TopLevelConfigPath, \"{{ .testRoot }}\", testRoot)\n\t\t\ttc.containerOptions.DropInConfig = strings.ReplaceAll(tc.containerOptions.DropInConfig, \"{{ .testRoot }}\", testRoot)\n\t\t\ttc.options.hooksDir = strings.ReplaceAll(tc.options.hooksDir, \"{{ .testRoot }}\", testRoot)\n\t\t\tvar testConfigSources []string\n\t\t\tfor _, configSource := range tc.containerOptions.ConfigSources {\n\t\t\t\ttestConfigSources = append(testConfigSources, strings.ReplaceAll(configSource, \"{{ .testRoot }}\", testRoot))\n\t\t\t}\n\t\t\ttc.containerOptions.ConfigSources = testConfigSources\n\n\t\t\t// Prepare the test environment\n\t\t\tif tc.prepareEnvironment != nil {\n\t\t\t\trequire.NoError(t, tc.prepareEnvironment(t, &tc.containerOptions, &tc.options))\n\t\t\t}\n\n\t\t\terr := Setup(c, &tc.containerOptions, &tc.options)\n\t\t\trequire.EqualValues(t, tc.expectedSetupError, err)\n\n\t\t\tif tc.assertSetupPostConditions != nil {\n\t\t\t\trequire.NoError(t, tc.assertSetupPostConditions(t, &tc.containerOptions, &tc.options))\n\t\t\t}\n\n\t\t\terr = Cleanup(c, &tc.containerOptions, &tc.options)\n\t\t\trequire.EqualValues(t, tc.expectedCleanupError, err)\n\n\t\t\tif tc.assertCleanupPostConditions != nil {\n\t\t\t\trequire.NoError(t, tc.assertCleanupPostConditions(t, &tc.containerOptions, &tc.options))\n\t\t\t}\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/crio/crio.go",
"content": "/**\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage crio\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\n\tlog \"github.com/sirupsen/logrus\"\n\tcli \"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine/crio\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/ocihook\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nconst (\n\tName = \"crio\"\n\n\tdefaultConfigMode = configModeConfig\n\n\tconfigModeConfig = \"config\"\n\tconfigModeHook = \"hook\"\n\n\t// Hook-based settings\n\tdefaultHooksDir = \"/usr/share/containers/oci/hooks.d\"\n\tdefaultHookFilename = \"oci-nvidia-hook.json\"\n\n\t// Config-based settings\n\tDefaultConfig = \"/etc/crio/crio.conf\"\n\tDefaultDropInConfig = \"/etc/crio/conf.d/99-nvidia.toml\"\n\n\tDefaultSocket = \"/var/run/crio/crio.sock\"\n\tDefaultRestartMode = \"systemd\"\n)\n\n// Options defines the cri-o specific options.\ntype Options struct {\n\tconfigMode string\n\n\t// hook-specific options\n\thooksDir string\n\thookFilename string\n}\n\nfunc Flags(opts *Options) []cli.Flag {\n\tflags := []cli.Flag{\n\t\t&cli.StringFlag{\n\t\t\tName: \"hooks-dir\",\n\t\t\tUsage: \"path to the cri-o hooks directory\",\n\t\t\tValue: defaultHooksDir,\n\t\t\tDestination: &opts.hooksDir,\n\t\t\tSources: cli.EnvVars(\"CRIO_HOOKS_DIR\"),\n\t\t\tDefaultText: defaultHooksDir,\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"hook-filename\",\n\t\t\tUsage: \"filename of the cri-o hook that will be created / removed in the hooks directory\",\n\t\t\tValue: defaultHookFilename,\n\t\t\tDestination: &opts.hookFilename,\n\t\t\tSources: cli.EnvVars(\"CRIO_HOOK_FILENAME\"),\n\t\t\tDefaultText: defaultHookFilename,\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"config-mode\",\n\t\t\tUsage: \"the configuration mode to use. One of [hook | config]\",\n\t\t\tValue: defaultConfigMode,\n\t\t\tDestination: &opts.configMode,\n\t\t\tSources: cli.EnvVars(\"CRIO_CONFIG_MODE\"),\n\t\t},\n\t}\n\n\treturn flags\n}\n\nfunc (opts *Options) Validate(logger logger.Interface, _ *cli.Command) error {\n\tif opts.configMode != configModeConfig && opts.configMode != configModeHook {\n\t\treturn fmt.Errorf(\"invalid cri-o config mode: %q\", opts.configMode)\n\t}\n\tif opts.configMode == configModeHook {\n\t\tlogger.Warningf(\"The %q config for cri-o is deprecated\", opts.configMode)\n\t}\n\treturn nil\n}\n\n// Setup installs the prestart hook required to launch GPU-enabled containers\nfunc Setup(c *cli.Command, o *container.Options, co *Options) error {\n\tlog.Infof(\"Starting 'setup' for %v\", c.Name)\n\n\tswitch co.configMode {\n\tcase \"hook\":\n\t\treturn setupHook(o, co)\n\tcase \"config\":\n\t\treturn setupConfig(o)\n\tdefault:\n\t\treturn fmt.Errorf(\"invalid config-mode '%v'\", co.configMode)\n\t}\n}\n\n// setupHook installs the prestart hook required to launch GPU-enabled containers\nfunc setupHook(o *container.Options, co *Options) error {\n\tlog.Infof(\"Installing prestart hook\")\n\n\thookPath := filepath.Join(co.hooksDir, co.hookFilename)\n\terr := ocihook.CreateHook(hookPath, filepath.Join(o.RuntimeDir, config.NVIDIAContainerRuntimeHookExecutable))\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error creating hook: %v\", err)\n\t}\n\n\treturn nil\n}\n\n// setupConfig updates the cri-o config for the NVIDIA container runtime\nfunc setupConfig(o *container.Options) error {\n\tlog.Infof(\"Updating config file\")\n\n\tcfg, err := getRuntimeConfig(o, false)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to load config: %v\", err)\n\t}\n\n\terr = o.Configure(cfg)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to configure cri-o: %v\", err)\n\t}\n\n\terr = RestartCrio(o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to restart crio: %v\", err)\n\t}\n\n\treturn nil\n}\n\n// Cleanup removes the specified prestart hook\nfunc Cleanup(c *cli.Command, o *container.Options, co *Options) error {\n\tlog.Infof(\"Starting 'cleanup' for %v\", c.Name)\n\n\tswitch co.configMode {\n\tcase \"hook\":\n\t\treturn cleanupHook(co)\n\tcase \"config\":\n\t\treturn cleanupConfig(o)\n\tdefault:\n\t\treturn fmt.Errorf(\"invalid config-mode '%v'\", co.configMode)\n\t}\n}\n\n// cleanupHook removes the prestart hook\nfunc cleanupHook(co *Options) error {\n\tlog.Infof(\"Removing prestart hook\")\n\n\thookPath := filepath.Join(co.hooksDir, co.hookFilename)\n\terr := os.Remove(hookPath)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error removing hook '%v': %v\", hookPath, err)\n\t}\n\n\treturn nil\n}\n\n// cleanupConfig removes the NVIDIA container runtime from the cri-o config\nfunc cleanupConfig(o *container.Options) error {\n\tif !o.SetAsDefault {\n\t\treturn nil\n\t}\n\n\tlog.Infof(\"Reverting config file modifications\")\n\n\tcfg, err := getRuntimeConfig(o, true)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to load config: %v\", err)\n\t}\n\n\terr = cfg.UpdateDefaultRuntime(o.RuntimeName, engine.UpdateActionUnset)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to unset %q as the default runtime: %w\", o.RuntimeName, err)\n\t}\n\n\tif err := o.Flush(cfg); err != nil {\n\t\treturn err\n\t}\n\n\terr = RestartCrio(o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to restart crio: %v\", err)\n\t}\n\n\treturn nil\n}\n\n// RestartCrio restarts crio depending on the value of restartModeFlag\nfunc RestartCrio(o *container.Options) error {\n\treturn o.Restart(\"crio\", func(string) error { return fmt.Errorf(\"supporting crio via signal is unsupported\") })\n}\n\nfunc GetLowlevelRuntimePaths(o *container.Options) ([]string, error) {\n\tcfg, err := getRuntimeConfig(o, false)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"unable to load crio config: %w\", err)\n\t}\n\treturn engine.GetBinaryPathsForRuntimes(cfg), nil\n}\n\nfunc getRuntimeConfig(o *container.Options, loadDestinationConfig bool) (engine.Interface, error) {\n\tloaders, err := o.GetConfigLoaders(crio.CommandLineSource)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\toptions := []crio.Option{\n\t\tcrio.WithTopLevelConfigPath(o.TopLevelConfigPath),\n\t\tcrio.WithConfigSource(\n\t\t\ttoml.LoadFirst(\n\t\t\t\tloaders...,\n\t\t\t),\n\t\t),\n\t}\n\n\tif loadDestinationConfig {\n\t\tdestinationConfigPath := o.TopLevelConfigPath\n\t\tif o.DropInConfig != \"\" {\n\t\t\tdestinationConfigPath = o.DropInConfig\n\t\t}\n\t\toptions = append(options, crio.WithConfigDestination(toml.FromFile(destinationConfigPath)))\n\t}\n\n\treturn crio.New(options...)\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/docker/docker.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage docker\n\nimport (\n\t\"fmt\"\n\n\tlog \"github.com/sirupsen/logrus\"\n\tcli \"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine/docker\"\n)\n\nconst (\n\tName = \"docker\"\n\n\tDefaultConfig = \"/etc/docker/daemon.json\"\n\tDefaultSocket = \"/var/run/docker.sock\"\n\tDefaultRestartMode = \"signal\"\n)\n\ntype Options struct{}\n\nfunc Flags(opts *Options) []cli.Flag {\n\treturn nil\n}\n\n// Setup updates docker configuration to include the nvidia runtime and reloads it\nfunc Setup(c *cli.Command, o *container.Options) error {\n\tlog.Infof(\"Starting 'setup' for %v\", c.Name)\n\n\tcfg, err := getRuntimeConfig(o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to load config: %v\", err)\n\t}\n\n\terr = o.Configure(cfg)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to configure docker: %v\", err)\n\t}\n\n\terr = RestartDocker(o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to restart docker: %v\", err)\n\t}\n\n\tlog.Infof(\"Completed 'setup' for %v\", c.Name)\n\n\treturn nil\n}\n\n// Cleanup reverts docker configuration to remove the nvidia runtime and reloads it\nfunc Cleanup(c *cli.Command, o *container.Options) error {\n\tlog.Infof(\"Starting 'cleanup' for %v\", c.Name)\n\n\tcfg, err := getRuntimeConfig(o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to load config: %v\", err)\n\t}\n\n\terr = o.Unconfigure(cfg)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to unconfigure docker: %v\", err)\n\t}\n\n\terr = RestartDocker(o)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to signal docker: %v\", err)\n\t}\n\n\tlog.Infof(\"Completed 'cleanup' for %v\", c.Name)\n\n\treturn nil\n}\n\n// RestartDocker restarts docker depending on the value of restartModeFlag\nfunc RestartDocker(o *container.Options) error {\n\treturn o.Restart(\"docker\", SignalDocker)\n}\n\nfunc GetLowlevelRuntimePaths(o *container.Options) ([]string, error) {\n\tcfg, err := docker.New(\n\t\tdocker.WithPath(o.TopLevelConfigPath),\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"unable to load docker config: %w\", err)\n\t}\n\treturn engine.GetBinaryPathsForRuntimes(cfg), nil\n}\n\nfunc getRuntimeConfig(o *container.Options) (engine.Interface, error) {\n\treturn docker.New(\n\t\tdocker.WithPath(o.TopLevelConfigPath),\n\t)\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/docker/docker_linux.go",
"content": "/**\n# Copyright 2021-2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage docker\n\nimport (\n\t\"fmt\"\n\t\"net\"\n\t\"syscall\"\n\t\"time\"\n\n\tlog \"github.com/sirupsen/logrus\"\n)\n\nconst (\n\treloadBackoff = 5 * time.Second\n\tmaxReloadAttempts = 6\n\n\tsocketMessageToGetPID = \"GET /info HTTP/1.0\\r\\n\\r\\n\"\n)\n\n// SignalDocker sends a SIGHUP signal to docker daemon\nfunc SignalDocker(socket string) error {\n\tlog.Infof(\"Sending SIGHUP signal to docker\")\n\n\t// Wrap the logic to perform the SIGHUP in a function so we can retry it on failure\n\tretriable := func() error {\n\t\tconn, err := net.Dial(\"unix\", socket)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to dial: %v\", err)\n\t\t}\n\t\tdefer conn.Close()\n\n\t\tsconn, err := conn.(*net.UnixConn).SyscallConn()\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to get syscall connection: %v\", err)\n\t\t}\n\n\t\terr1 := sconn.Control(func(fd uintptr) {\n\t\t\terr = syscall.SetsockoptInt(int(fd), syscall.SOL_SOCKET, syscall.SO_PASSCRED, 1)\n\t\t})\n\t\tif err1 != nil {\n\t\t\treturn fmt.Errorf(\"unable to issue call on socket fd: %v\", err1)\n\t\t}\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to SetsockoptInt on socket fd: %v\", err)\n\t\t}\n\n\t\t_, _, err = conn.(*net.UnixConn).WriteMsgUnix([]byte(socketMessageToGetPID), nil, nil)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to WriteMsgUnix on socket fd: %v\", err)\n\t\t}\n\n\t\toob := make([]byte, 1024)\n\t\t_, oobn, _, _, err := conn.(*net.UnixConn).ReadMsgUnix(nil, oob)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to ReadMsgUnix on socket fd: %v\", err)\n\t\t}\n\n\t\toob = oob[:oobn]\n\t\tscm, err := syscall.ParseSocketControlMessage(oob)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to ParseSocketControlMessage from message received on socket fd: %v\", err)\n\t\t}\n\n\t\tucred, err := syscall.ParseUnixCredentials(&scm[0])\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to ParseUnixCredentials from message received on socket fd: %v\", err)\n\t\t}\n\n\t\terr = syscall.Kill(int(ucred.Pid), syscall.SIGHUP)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to send SIGHUP to 'docker' process: %v\", err)\n\t\t}\n\n\t\treturn nil\n\t}\n\n\t// Try to send a SIGHUP up to maxReloadAttempts times\n\tvar err error\n\tfor i := 0; i < maxReloadAttempts; i++ {\n\t\terr = retriable()\n\t\tif err == nil {\n\t\t\tbreak\n\t\t}\n\t\tif i == maxReloadAttempts-1 {\n\t\t\tbreak\n\t\t}\n\t\tlog.Warningf(\"Error signaling docker, attempt %v/%v: %v\", i+1, maxReloadAttempts, err)\n\t\ttime.Sleep(reloadBackoff)\n\t}\n\tif err != nil {\n\t\tlog.Warningf(\"Max retries reached %v/%v, aborting\", maxReloadAttempts, maxReloadAttempts)\n\t\treturn err\n\t}\n\n\tlog.Infof(\"Successfully signaled docker\")\n\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/docker/docker_other.go",
"content": "//go:build !linux\n\n/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage docker\n\nimport (\n\t\"errors\"\n)\n\n// SignalDocker is unsupported on non-linux platforms.\nfunc SignalDocker(socket string) error {\n\treturn errors.New(\"SignalDocker is unsupported on non-linux platforms\")\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/docker/docker_test.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage docker\n\nimport (\n\t\"encoding/json\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine/docker\"\n)\n\nfunc TestUpdateConfigDefaultRuntime(t *testing.T) {\n\tconst runtimeDir = \"/test/runtime/dir\"\n\n\ttestCases := []struct {\n\t\tsetAsDefault bool\n\t\truntimeName string\n\t\texpectedDefaultRuntimeName interface{}\n\t}{\n\t\t{},\n\t\t{\n\t\t\tsetAsDefault: false,\n\t\t\texpectedDefaultRuntimeName: nil,\n\t\t},\n\t\t{\n\t\t\tsetAsDefault: true,\n\t\t\truntimeName: \"NAME\",\n\t\t\texpectedDefaultRuntimeName: \"NAME\",\n\t\t},\n\t\t{\n\t\t\tsetAsDefault: true,\n\t\t\truntimeName: \"nvidia\",\n\t\t\texpectedDefaultRuntimeName: \"nvidia\",\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\to := &container.Options{\n\t\t\tRuntimeName: tc.runtimeName,\n\t\t\tRuntimeDir: runtimeDir,\n\t\t\tSetAsDefault: tc.setAsDefault,\n\t\t}\n\n\t\tconfig := docker.Config(map[string]interface{}{})\n\n\t\terr := o.UpdateConfig(&config)\n\t\trequire.NoError(t, err, \"%d: %v\", i, tc)\n\n\t\tdefaultRuntimeName := config[\"default-runtime\"]\n\t\trequire.EqualValues(t, tc.expectedDefaultRuntimeName, defaultRuntimeName, \"%d: %v\", i, tc)\n\t}\n}\n\nfunc TestUpdateConfig(t *testing.T) {\n\tconst runtimeDir = \"/test/runtime/dir\"\n\n\ttestCases := []struct {\n\t\tconfig docker.Config\n\t\tsetAsDefault bool\n\t\truntimeName string\n\t\texpectedConfig map[string]interface{}\n\t}{\n\t\t{\n\t\t\tconfig: map[string]interface{}{},\n\t\t\tsetAsDefault: false,\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-cdi\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.cdi\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-legacy\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.legacy\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{},\n\t\t\tsetAsDefault: false,\n\t\t\truntimeName: \"NAME\",\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"NAME\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-cdi\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.cdi\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-legacy\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.legacy\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tsetAsDefault: false,\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-cdi\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.cdi\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-legacy\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.legacy\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"not-nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"some-other-path\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"not-nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"some-other-path\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-cdi\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.cdi\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-legacy\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.legacy\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"default-runtime\": \"runc\",\n\t\t\t},\n\t\t\tsetAsDefault: true,\n\t\t\truntimeName: \"nvidia\",\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"default-runtime\": \"nvidia\",\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-cdi\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.cdi\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-legacy\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.legacy\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"exec-opts\": []string{\"native.cgroupdriver=systemd\"},\n\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t},\n\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"exec-opts\": []string{\"native.cgroupdriver=systemd\"},\n\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t},\n\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-cdi\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.cdi\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-legacy\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.legacy\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\ttc := tc\n\n\t\to := &container.Options{\n\t\t\tRuntimeName: tc.runtimeName,\n\t\t\tRuntimeDir: runtimeDir,\n\t\t\tSetAsDefault: tc.setAsDefault,\n\t\t}\n\n\t\terr := o.UpdateConfig(&tc.config)\n\t\trequire.NoError(t, err, \"%d: %v\", i, tc)\n\n\t\tconfigContent, err := json.MarshalIndent(tc.config, \"\", \" \")\n\t\trequire.NoError(t, err)\n\n\t\texpectedContent, err := json.MarshalIndent(tc.expectedConfig, \"\", \" \")\n\t\trequire.NoError(t, err)\n\n\t\trequire.EqualValues(t, string(expectedContent), string(configContent), \"%d: %v\", i, tc)\n\t}\n}\n\nfunc TestRevertConfig(t *testing.T) {\n\ttestCases := []struct {\n\t\tconfig docker.Config\n\t\texpectedConfig map[string]interface{}\n\t}{\n\t\t{\n\t\t\tconfig: map[string]interface{}{},\n\t\t\texpectedConfig: map[string]interface{}{},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-cdi\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.cdi\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"nvidia-legacy\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime.legacy\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"default-runtime\": \"nvidia\",\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"default-runtime\": \"runc\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"default-runtime\": \"not-nvidia\",\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"default-runtime\": \"not-nvidia\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"exec-opts\": []string{\"native.cgroupdriver=systemd\"},\n\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t},\n\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/nvidia-container-runtime\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"exec-opts\": []string{\"native.cgroupdriver=systemd\"},\n\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t},\n\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\ttc := tc\n\t\to := &container.Options{}\n\t\terr := o.RevertConfig(&tc.config)\n\n\t\trequire.NoError(t, err, \"%d: %v\", i, tc)\n\n\t\tconfigContent, err := json.MarshalIndent(tc.config, \"\", \" \")\n\t\trequire.NoError(t, err)\n\n\t\texpectedContent, err := json.MarshalIndent(tc.expectedConfig, \"\", \" \")\n\t\trequire.NoError(t, err)\n\n\t\trequire.EqualValues(t, string(expectedContent), string(configContent), \"%d: %v\", i, tc)\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/nri/logger.go",
"content": "package nri\n\nimport (\n\t\"context\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype toNriLogger struct {\n\tlogger.Interface\n}\n\nfunc (l toNriLogger) Debugf(_ context.Context, fmt string, args ...interface{}) {\n\tl.Interface.Debugf(fmt, args...)\n}\n\nfunc (l toNriLogger) Errorf(_ context.Context, fmt string, args ...interface{}) {\n\tl.Interface.Errorf(fmt, args...)\n}\n\nfunc (l toNriLogger) Infof(_ context.Context, fmt string, args ...interface{}) {\n\tl.Interface.Infof(fmt, args...)\n}\n\nfunc (l toNriLogger) Warnf(_ context.Context, fmt string, args ...interface{}) {\n\tl.Warningf(fmt, args...)\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/nri/plugin.go",
"content": "/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nri\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"os\"\n\t\"strings\"\n\n\t\"github.com/containerd/nri/pkg/api\"\n\t\"github.com/containerd/nri/pkg/plugin\"\n\t\"github.com/containerd/nri/pkg/stub\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// Compile-time interface checks\nvar (\n\t_ stub.Plugin = (*Plugin)(nil)\n)\n\nconst (\n\t// nriCDIAnnotationDomain is the domain name used for CDI device annotations\n\tnriCDIAnnotationDomain = \"nvidia.cdi.k8s.io\"\n)\n\ntype Plugin struct {\n\tctx context.Context\n\tlogger logger.Interface\n\n\tnamespace string\n\tstub stub.Stub\n}\n\n// NewPlugin creates a new NRI plugin for injecting CDI devices\nfunc NewPlugin(ctx context.Context, logger logger.Interface, namespace string) *Plugin {\n\treturn &Plugin{\n\t\tctx: ctx,\n\t\tlogger: logger,\n\t\tnamespace: namespace,\n\t}\n}\n\n// CreateContainer handles container creation requests.\nfunc (p *Plugin) CreateContainer(_ context.Context, pod *api.PodSandbox, ctr *api.Container) (*api.ContainerAdjustment, []*api.ContainerUpdate, error) {\n\tadjust := &api.ContainerAdjustment{}\n\n\tif err := p.injectCDIDevices(pod, ctr, adjust); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\treturn adjust, nil, nil\n}\n\nfunc (p *Plugin) injectCDIDevices(pod *api.PodSandbox, ctr *api.Container, a *api.ContainerAdjustment) error {\n\tctx := p.ctx\n\tpluginLogger := p.stub.Logger()\n\n\tdevices := p.parseCDIDevices(pod, nriCDIAnnotationDomain, ctr.Name)\n\tif len(devices) == 0 {\n\t\tpluginLogger.Debugf(ctx, \"%s: no CDI devices annotated...\", containerName(pod, ctr))\n\t\treturn nil\n\t}\n\n\tpluginLogger.Infof(ctx, \"%s: injecting CDI devices %v...\", containerName(pod, ctr), devices)\n\tfor _, name := range devices {\n\t\ta.AddCDIDevice(\n\t\t\t&api.CDIDevice{\n\t\t\t\tName: name,\n\t\t\t},\n\t\t)\n\t}\n\n\treturn nil\n}\n\n// parseCDIDevices processes the podSpec and determines which containers which need CDI devices injected to them\nfunc (p *Plugin) parseCDIDevices(pod *api.PodSandbox, key, container string) []string {\n\tif p.namespace != pod.Namespace {\n\t\tp.logger.Debugf(\"pod %s/%s is not in the toolkit's namespace %s. Skipping CDI device injection...\", pod.Namespace, pod.Name, p.namespace)\n\t\treturn nil\n\t}\n\n\tcdiDeviceNames, ok := plugin.GetEffectiveAnnotation(pod, key, container)\n\tif !ok {\n\t\treturn nil\n\t}\n\n\tcdiDevices := strings.Split(cdiDeviceNames, \",\")\n\treturn cdiDevices\n}\n\n// Construct a container name for log messages.\nfunc containerName(pod *api.PodSandbox, container *api.Container) string {\n\tif pod != nil {\n\t\treturn pod.Name + \"/\" + container.Name\n\t}\n\treturn container.Name\n}\n\n// Start starts the NRI plugin\nfunc (p *Plugin) Start(ctx context.Context, nriSocketPath, nriPluginIdx string) error {\n\tpluginOpts := []stub.Option{\n\t\tstub.WithPluginIdx(nriPluginIdx),\n\t\tstub.WithLogger(toNriLogger{p.logger}),\n\t\tstub.WithOnClose(func() {\n\t\t\tp.logger.Infof(\"NRI ttrpc connection to %s is down. NRI plugin stopped.\", nriSocketPath)\n\t\t}),\n\t}\n\tif len(nriSocketPath) > 0 {\n\t\t_, err := os.Stat(nriSocketPath)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to find valid nri socket at %s: %w\", nriSocketPath, err)\n\t\t}\n\t\tpluginOpts = append(pluginOpts, stub.WithSocketPath(nriSocketPath))\n\t}\n\n\tvar err error\n\tif p.stub, err = stub.New(p, pluginOpts...); err != nil {\n\t\treturn fmt.Errorf(\"failed to initialise plugin at %s: %w\", nriSocketPath, err)\n\t}\n\terr = p.stub.Start(ctx)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"plugin exited with error: %w\", err)\n\t}\n\treturn nil\n}\n\n// Stop stops the NRI plugin\nfunc (p *Plugin) Stop() {\n\tif p == nil || p.stub == nil {\n\t\treturn\n\t}\n\tp.stub.Stop()\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/container/runtime/runtime.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage runtime\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container/runtime/containerd\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container/runtime/crio\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container/runtime/docker\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/toolkit\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\nconst (\n\tdefaultSetAsDefault = true\n\t// defaultRuntimeName specifies the NVIDIA runtime to be use as the default runtime if setting the default runtime is enabled\n\tdefaultRuntimeName = \"nvidia\"\n\tdefaultHostRootMount = \"/host\"\n\n\truntimeSpecificDefault = \"RUNTIME_SPECIFIC_DEFAULT\"\n)\n\ntype Options struct {\n\tcontainer.Options\n\n\tcontainerdOptions containerd.Options\n\tcrioOptions crio.Options\n}\n\nfunc Flags(opts *Options) []cli.Flag {\n\tflags := []cli.Flag{\n\t\t&cli.StringFlag{\n\t\t\tName: \"config\",\n\t\t\tUsage: \"Path to the runtime config file\",\n\t\t\tValue: runtimeSpecificDefault,\n\t\t\tDestination: &opts.TopLevelConfigPath,\n\t\t\tSources: cli.EnvVars(\"RUNTIME_CONFIG\", \"CONTAINERD_CONFIG\", \"DOCKER_CONFIG\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"drop-in-config\",\n\t\t\tUsage: \"Path to the NVIDIA-specific drop-in config file\",\n\t\t\tValue: runtimeSpecificDefault,\n\t\t\tDestination: &opts.DropInConfig,\n\t\t\tSources: cli.EnvVars(\"RUNTIME_DROP_IN_CONFIG\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"drop-in-config-host-path\",\n\t\t\tUsage: \"When running in a container, this is the path to the drop-in config (--drop-in-config) on the host. \" +\n\t\t\t\t\"This is required to correctly update the top-level config if required since paths there must be host-relative.\",\n\t\t\tDestination: &opts.DropInConfigHostPath,\n\t\t\tSources: cli.EnvVars(\"RUNTIME_DROP_IN_CONFIG_HOST_PATH\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"executable-path\",\n\t\t\tUsage: \"The path to the runtime executable. This is used to extract the current config\",\n\t\t\tDestination: &opts.ExecutablePath,\n\t\t\tSources: cli.EnvVars(\"RUNTIME_EXECUTABLE_PATH\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"socket\",\n\t\t\tUsage: \"Path to the runtime socket file\",\n\t\t\tValue: runtimeSpecificDefault,\n\t\t\tDestination: &opts.Socket,\n\t\t\tSources: cli.EnvVars(\"RUNTIME_SOCKET\", \"CONTAINERD_SOCKET\", \"DOCKER_SOCKET\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"restart-mode\",\n\t\t\tUsage: \"Specify how the runtime should be restarted; If 'none' is selected it will not be restarted [signal | systemd | none ]\",\n\t\t\tValue: runtimeSpecificDefault,\n\t\t\tDestination: &opts.RestartMode,\n\t\t\tSources: cli.EnvVars(\"RUNTIME_RESTART_MODE\"),\n\t\t},\n\t\t&cli.BoolFlag{\n\t\t\tName: \"enable-cdi-in-runtime\",\n\t\t\tUsage: \"Enable CDI in the configured runt\time\",\n\t\t\tDestination: &opts.EnableCDI,\n\t\t\tSources: cli.EnvVars(\"RUNTIME_ENABLE_CDI\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"host-root\",\n\t\t\tUsage: \"Specify the path to the host root to be used when restarting the runtime using systemd\",\n\t\t\tValue: defaultHostRootMount,\n\t\t\tDestination: &opts.HostRootMount,\n\t\t\tSources: cli.EnvVars(\"HOST_ROOT_MOUNT\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"runtime-name\",\n\t\t\tAliases: []string{\"nvidia-runtime-name\", \"runtime-class\"},\n\t\t\tUsage: \"Specify the name of the `nvidia` runtime. If set-as-default is selected, the runtime is used as the default runtime.\",\n\t\t\tValue: defaultRuntimeName,\n\t\t\tDestination: &opts.RuntimeName,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_RUNTIME_NAME\", \"CONTAINERD_RUNTIME_CLASS\", \"DOCKER_RUNTIME_NAME\"),\n\t\t},\n\t\t&cli.BoolFlag{\n\t\t\tName: \"set-as-default\",\n\t\t\tUsage: \"Set the `nvidia` runtime as the default runtime.\",\n\t\t\tValue: defaultSetAsDefault,\n\t\t\tDestination: &opts.SetAsDefault,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_RUNTIME_SET_AS_DEFAULT\", \"CONTAINERD_SET_AS_DEFAULT\", \"DOCKER_SET_AS_DEFAULT\"),\n\t\t\tHidden: true,\n\t\t},\n\t\t&cli.StringSliceFlag{\n\t\t\tName: \"config-source\",\n\t\t\tAliases: []string{\"config-sources\"},\n\t\t\tUsage: \"Specify the config sources for the container runtime. Any combination of \" +\n\t\t\t\t\"[command | file]. \" +\n\t\t\t\t\"When `file` is specified, the absolute path to the file to be used as a config source can \" +\n\t\t\t\t\"be specified as `file=/path/to/source/config.toml\",\n\t\t\tValue: []string{\"command\", \"file\"},\n\t\t\tDestination: &opts.ConfigSources,\n\t\t\tSources: cli.EnvVars(\"RUNTIME_CONFIG_SOURCES\", \"RUNTIME_CONFIG_SOURCE\"),\n\t\t},\n\t}\n\n\tflags = append(flags, containerd.Flags(&opts.containerdOptions)...)\n\tflags = append(flags, crio.Flags(&opts.crioOptions)...)\n\n\treturn flags\n}\n\n// Validate checks whether the specified options are valid\nfunc (opts *Options) Validate(logger logger.Interface, c *cli.Command, runtime string, toolkitRoot string, to *toolkit.Options) error {\n\t// Check that the specified runtime is supported.\n\tswitch runtime {\n\tcase containerd.Name:\n\tcase crio.Name:\n\tcase docker.Name:\n\tdefault:\n\t\treturn fmt.Errorf(\"invalid runtime %q; expected one of [containerd | crio | docker]\", runtime)\n\t}\n\n\t// We set this option here to ensure that it is available in future calls.\n\topts.RuntimeDir = toolkitRoot\n\n\tif !c.IsSet(\"enable-cdi-in-runtime\") {\n\t\topts.EnableCDI = to.CDI.Enabled\n\t}\n\n\tswitch runtime {\n\tcase docker.Name:\n\t\tif opts.ExecutablePath != \"\" {\n\t\t\tlogger.Warningf(\"Ignoring executable-path=%q flag for %v\", opts.ExecutablePath, opts.RuntimeName)\n\t\t\topts.ExecutablePath = \"\"\n\t\t}\n\t\tif opts.DropInConfig != \"\" && opts.DropInConfig != runtimeSpecificDefault {\n\t\t\tlogger.Warningf(\"Ignoring drop-in-config=%q flag for %v\", opts.DropInConfig, opts.RuntimeName)\n\t\t\topts.DropInConfig = \"\"\n\t\t}\n\t\topts.ConfigSources = []string{\"file\"}\n\tcase containerd.Name:\n\tcase crio.Name:\n\t\tif err := opts.crioOptions.Validate(logger, c); err != nil {\n\t\t\treturn fmt.Errorf(\"invalid cri-o config: %w\", err)\n\t\t}\n\t}\n\n\t// Apply the runtime-specific config changes.\n\tswitch runtime {\n\tcase containerd.Name:\n\t\tif opts.TopLevelConfigPath == runtimeSpecificDefault {\n\t\t\topts.TopLevelConfigPath = containerd.DefaultConfig\n\t\t}\n\t\tif opts.DropInConfig == runtimeSpecificDefault {\n\t\t\topts.DropInConfig = containerd.DefaultDropInConfig\n\t\t}\n\t\tif opts.Socket == runtimeSpecificDefault {\n\t\t\topts.Socket = containerd.DefaultSocket\n\t\t}\n\t\tif opts.RestartMode == runtimeSpecificDefault {\n\t\t\topts.RestartMode = containerd.DefaultRestartMode\n\t\t}\n\tcase crio.Name:\n\t\tif opts.TopLevelConfigPath == runtimeSpecificDefault {\n\t\t\topts.TopLevelConfigPath = crio.DefaultConfig\n\t\t}\n\t\tif opts.DropInConfig == runtimeSpecificDefault {\n\t\t\topts.DropInConfig = crio.DefaultDropInConfig\n\t\t}\n\t\tif opts.Socket == runtimeSpecificDefault {\n\t\t\topts.Socket = crio.DefaultSocket\n\t\t}\n\t\tif opts.RestartMode == runtimeSpecificDefault {\n\t\t\topts.RestartMode = crio.DefaultRestartMode\n\t\t}\n\tcase docker.Name:\n\t\tif opts.TopLevelConfigPath == runtimeSpecificDefault {\n\t\t\topts.TopLevelConfigPath = docker.DefaultConfig\n\t\t}\n\t\t// Docker does not support drop-in configs.\n\t\tif opts.DropInConfig == runtimeSpecificDefault {\n\t\t\topts.DropInConfig = \"\"\n\t\t}\n\t\tif opts.Socket == runtimeSpecificDefault {\n\t\t\topts.Socket = docker.DefaultSocket\n\t\t}\n\t\tif opts.RestartMode == runtimeSpecificDefault {\n\t\t\topts.RestartMode = docker.DefaultRestartMode\n\t\t}\n\tdefault:\n\t\treturn fmt.Errorf(\"undefined runtime %v\", runtime)\n\t}\n\n\treturn nil\n}\n\ntype Configurer interface {\n\tCleanup(*cli.Command, *Options) error\n\tGetLowlevelRuntimePaths(*Options) ([]string, error)\n\tSetup(*cli.Command, *Options) error\n}\n\ntype runtime string\ntype noopRuntimeConfigurer struct{}\n\n// NewConfigurer is a factory method for creating a runtime configurer.\nfunc NewConfigurer(name string, noConfigureRuntime bool, nriEnabled bool) Configurer {\n\tif noConfigureRuntime || nriEnabled {\n\t\treturn &noopRuntimeConfigurer{}\n\t}\n\treturn runtime(name)\n}\n\nfunc (r runtime) Setup(c *cli.Command, opts *Options) error {\n\tswitch string(r) {\n\tcase containerd.Name:\n\t\treturn containerd.Setup(c, &opts.Options, &opts.containerdOptions)\n\tcase crio.Name:\n\t\treturn crio.Setup(c, &opts.Options, &opts.crioOptions)\n\tcase docker.Name:\n\t\treturn docker.Setup(c, &opts.Options)\n\tdefault:\n\t\treturn fmt.Errorf(\"undefined runtime %v\", r)\n\t}\n}\n\nfunc (r runtime) Cleanup(c *cli.Command, opts *Options) error {\n\tswitch string(r) {\n\tcase containerd.Name:\n\t\treturn containerd.Cleanup(c, &opts.Options, &opts.containerdOptions)\n\tcase crio.Name:\n\t\treturn crio.Cleanup(c, &opts.Options, &opts.crioOptions)\n\tcase docker.Name:\n\t\treturn docker.Cleanup(c, &opts.Options)\n\tdefault:\n\t\treturn fmt.Errorf(\"undefined runtime %v\", r)\n\t}\n}\n\nfunc (r runtime) GetLowlevelRuntimePaths(opts *Options) ([]string, error) {\n\tswitch string(r) {\n\tcase containerd.Name:\n\t\treturn containerd.GetLowlevelRuntimePaths(&opts.Options, &opts.containerdOptions)\n\tcase crio.Name:\n\t\treturn crio.GetLowlevelRuntimePaths(&opts.Options)\n\tcase docker.Name:\n\t\treturn docker.GetLowlevelRuntimePaths(&opts.Options)\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"undefined runtime %v\", r)\n\t}\n}\n\nfunc (r noopRuntimeConfigurer) Cleanup(_ *cli.Command, _ *Options) error {\n\treturn nil\n}\n\nfunc (r noopRuntimeConfigurer) GetLowlevelRuntimePaths(_ *Options) ([]string, error) {\n\treturn nil, nil\n}\n\nfunc (r noopRuntimeConfigurer) Setup(_ *cli.Command, _ *Options) error {\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/main.go",
"content": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"os\"\n\t\"os/signal\"\n\t\"path/filepath\"\n\t\"syscall\"\n\t\"time\"\n\n\tnriapi \"github.com/containerd/nri/pkg/api\"\n\t\"github.com/sirupsen/logrus\"\n\t\"github.com/urfave/cli/v3\"\n\t\"golang.org/x/sys/unix\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container/runtime\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container/runtime/nri\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/toolkit\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nconst (\n\ttoolkitPidFilename = \"toolkit.pid\"\n\tdefaultPidFile = \"/run/nvidia/toolkit/\" + toolkitPidFilename\n\n\tdefaultToolkitInstallDir = \"/usr/local/nvidia\"\n\ttoolkitSubDir = \"toolkit\"\n\n\tdefaultRuntime = \"docker\"\n\n\tdefaultNRIPluginIdx uint = 10\n)\n\nvar (\n\tdefaultLowLevelRuntimes = []string{\"runc\", \"crun\"}\n\twaitingForSignal = make(chan bool, 1)\n\tsignalReceived = make(chan bool, 1)\n)\n\n// options stores the command line arguments\ntype options struct {\n\ttoolkitInstallDir string\n\n\tnoDaemon bool\n\tpidFile string\n\tsourceRoot string\n\tpackageType string\n\n\tenableNRIPlugin bool\n\tnriPluginIndex uint\n\tnriSocket string\n\tnriNamespace string\n\n\ttoolkitOptions toolkit.Options\n\n\tdebug bool\n\n\tnoRuntimeConfig bool\n\truntime string\n\truntimeOptions runtime.Options\n}\n\nfunc (o options) toolkitRoot() string {\n\treturn filepath.Join(o.toolkitInstallDir, toolkitSubDir)\n}\n\nfunc main() {\n\tlogger := logrus.New()\n\tc := NewApp(logger)\n\n\t// Run the CLI\n\tlogger.Infof(\"Starting %v\", c.Name)\n\tif err := c.Run(context.Background(), os.Args); err != nil {\n\t\tlogger.Errorf(\"error running %v: %v\", c.Name, err)\n\t\tos.Exit(1)\n\t}\n\n\tlogger.Infof(\"Completed %v\", c.Name)\n}\n\n// An app represents the nvidia-ctk-installer.\ntype app struct {\n\tlogger *logrus.Logger\n\n\ttoolkit *toolkit.Installer\n}\n\n// NewApp creates the CLI app from the specified options.\nfunc NewApp(logger *logrus.Logger) *cli.Command {\n\ta := app{\n\t\tlogger: logger,\n\t}\n\treturn a.build()\n}\n\nfunc (a app) build() *cli.Command {\n\toptions := options{\n\t\ttoolkitOptions: toolkit.Options{},\n\t}\n\t// Create the top-level CLI\n\tc := cli.Command{\n\t\tName: \"nvidia-ctk-installer\",\n\t\tUsage: \"Install the NVIDIA Container Toolkit and configure the specified runtime to use the `nvidia` runtime.\",\n\t\tVersion: info.GetVersionString(),\n\t\tBefore: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {\n\t\t\treturn ctx, a.Before(cmd, &options)\n\t\t},\n\t\tAction: func(ctx context.Context, cmd *cli.Command) error {\n\t\t\treturn a.Run(ctx, cmd, &options)\n\t\t},\n\t\tFlags: []cli.Flag{\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"no-daemon\",\n\t\t\t\tAliases: []string{\"n\"},\n\t\t\t\tUsage: \"terminate immediately after setting up the runtime. Note that no cleanup will be performed\",\n\t\t\t\tDestination: &options.noDaemon,\n\t\t\t\tSources: cli.EnvVars(\"NO_DAEMON\"),\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"no-runtime-config\",\n\t\t\t\tUsage: \"Disables the configuration of a container runtime. This is used in cases where the runtime has \" +\n\t\t\t\t\t\"already been configured for use with the toolkit, and the installer is only used to deploy the \" +\n\t\t\t\t\t\"components of the NVIDIA Container Toolkit.\",\n\t\t\t\tDestination: &options.noRuntimeConfig,\n\t\t\t\tSources: cli.EnvVars(\"NO_RUNTIME_CONFIG\"),\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"enable-nri-plugin\",\n\t\t\t\tAliases: []string{\"p\"},\n\t\t\t\tUsage: \"if set to true, the toolkit will stand up an NRI Plugin server used to inject CDI devices \" +\n\t\t\t\t\t\"to containers. Note that this option will be ignored if --no-daemon is set.\",\n\t\t\t\tDestination: &options.enableNRIPlugin,\n\t\t\t\tSources: cli.EnvVars(\"ENABLE_NRI_PLUGIN\"),\n\t\t\t},\n\t\t\t&cli.UintFlag{\n\t\t\t\tName: \"nri-plugin-index\",\n\t\t\t\tUsage: \"Specify the plugin index to register to NRI\",\n\t\t\t\tValue: defaultNRIPluginIdx,\n\t\t\t\tDestination: &options.nriPluginIndex,\n\t\t\t\tSources: cli.EnvVars(\"NRI_PLUGIN_INDEX\"),\n\t\t\t\tAction: func(ctx context.Context, c *cli.Command, u uint) error {\n\t\t\t\t\tif u > 99 {\n\t\t\t\t\t\treturn fmt.Errorf(\"nri-plugin-index must be in the range [0,99]\")\n\t\t\t\t\t}\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"nri-socket\",\n\t\t\t\tUsage: \"Specify the path to the NRI socket file to register the NRI plugin server\",\n\t\t\t\tValue: nriapi.DefaultSocketPath,\n\t\t\t\tDestination: &options.nriSocket,\n\t\t\t\tSources: cli.EnvVars(\"NRI_SOCKET\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"nri-namespace\",\n\t\t\t\tUsage: \"Specify the kubernetes namespace the toolkit's NRI plugin is running in.\",\n\t\t\t\tDestination: &options.nriNamespace,\n\t\t\t\tSources: cli.EnvVars(\"NRI_NAMESPACE\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"runtime\",\n\t\t\t\tAliases: []string{\"r\"},\n\t\t\t\tUsage: \"the runtime to setup on this node. One of {'docker', 'crio', 'containerd'}. \" +\n\t\t\t\t\t\"This setting is ignored if --no-runtime-config is specified.\",\n\t\t\t\tValue: defaultRuntime,\n\t\t\t\tDestination: &options.runtime,\n\t\t\t\tSources: cli.EnvVars(\"RUNTIME\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"toolkit-install-dir\",\n\t\t\t\tAliases: []string{\"root\"},\n\t\t\t\tUsage: \"The directory where the NVIDIA Container Toolkit is to be installed. \" +\n\t\t\t\t\t\"The components of the toolkit will be installed to `ROOT`/toolkit. \" +\n\t\t\t\t\t\"Note that in the case of a containerized installer, this is the path in the container and it is \" +\n\t\t\t\t\t\"recommended that this match the path on the host.\",\n\t\t\t\tValue: defaultToolkitInstallDir,\n\t\t\t\tDestination: &options.toolkitInstallDir,\n\t\t\t\tSources: cli.EnvVars(\"TOOLKIT_INSTALL_DIR\", \"ROOT\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"toolkit-source-root\",\n\t\t\t\tUsage: \"The folder where the required toolkit artifacts can be found. If this is not specified, the path /artifacts/{{ .ToolkitPackageType }} is used where ToolkitPackageType is the resolved package type\",\n\t\t\t\tDestination: &options.sourceRoot,\n\t\t\t\tSources: cli.EnvVars(\"TOOLKIT_SOURCE_ROOT\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"toolkit-package-type\",\n\t\t\t\tUsage: \"specify the package type to use for the toolkit. One of ['deb', 'rpm', 'auto', '']. If 'auto' or '' are used, the type is inferred automatically.\",\n\t\t\t\tValue: \"auto\",\n\t\t\t\tDestination: &options.packageType,\n\t\t\t\tSources: cli.EnvVars(\"TOOLKIT_PACKAGE_TYPE\"),\n\t\t\t},\n\t\t\t&cli.StringFlag{\n\t\t\t\tName: \"pid-file\",\n\t\t\t\tValue: defaultPidFile,\n\t\t\t\tUsage: \"the path to a toolkit.pid file to ensure that only a single configuration instance is running\",\n\t\t\t\tDestination: &options.pidFile,\n\t\t\t\tSources: cli.EnvVars(\"TOOLKIT_PID_FILE\", \"PID_FILE\"),\n\t\t\t},\n\t\t\t&cli.BoolFlag{\n\t\t\t\tName: \"debug\",\n\t\t\t\tValue: false,\n\t\t\t\tUsage: \"enable debug-level log in the toolkit installer\",\n\t\t\t\tDestination: &options.debug,\n\t\t\t\tSources: cli.EnvVars(\"TOOLKIT_DEBUG\"),\n\t\t\t},\n\t\t},\n\t}\n\n\t// Add the additional flags specific to the toolkit and runtime config.\n\tc.Flags = append(c.Flags, toolkit.Flags(&options.toolkitOptions)...)\n\tc.Flags = append(c.Flags, runtime.Flags(&options.runtimeOptions)...)\n\n\treturn &c\n}\n\nfunc (a *app) Before(c *cli.Command, o *options) error {\n\tif o.debug && a.logger != nil {\n\t\ta.logger.SetLevel(logrus.DebugLevel)\n\t}\n\tif o.sourceRoot == \"\" {\n\t\tsourceRoot, err := a.resolveSourceRoot(o.runtimeOptions.HostRootMount, o.packageType)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to resolve source root: %v\", err)\n\t\t}\n\t\ta.logger.Infof(\"Resolved source root to %v\", sourceRoot)\n\t\to.sourceRoot = sourceRoot\n\t}\n\n\ta.toolkit = toolkit.NewInstaller(\n\t\ttoolkit.WithLogger(a.logger),\n\t\ttoolkit.WithSourceRoot(o.sourceRoot),\n\t\ttoolkit.WithToolkitRoot(o.toolkitRoot()),\n\t)\n\treturn a.validateFlags(c, o)\n}\n\nfunc (a *app) validateFlags(c *cli.Command, o *options) error {\n\tif o.toolkitInstallDir == \"\" {\n\t\treturn fmt.Errorf(\"the install root must be specified\")\n\t}\n\tif filepath.Base(o.pidFile) != toolkitPidFilename {\n\t\treturn fmt.Errorf(\"invalid toolkit.pid path %v\", o.pidFile)\n\t}\n\n\tif o.enableNRIPlugin && len(o.nriNamespace) == 0 {\n\t\treturn fmt.Errorf(\"the NRI namespace must be specified when the NRI plugin is enabled\")\n\t}\n\n\tif err := a.toolkit.ValidateOptions(&o.toolkitOptions); err != nil {\n\t\treturn err\n\t}\n\n\tif err := o.runtimeOptions.Validate(a.logger, c, o.runtime, o.toolkitRoot(), &o.toolkitOptions); err != nil {\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// Run installs the NVIDIA Container Toolkit and updates the requested runtime.\n// If the application is run as a daemon, the application waits and unconfigures\n// the runtime on termination.\nfunc (a *app) Run(ctx context.Context, c *cli.Command, o *options) error {\n\terr := a.initialize(o.pidFile)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to initialize: %v\", err)\n\t}\n\tdefer a.shutdown(o.pidFile)\n\n\truntimeConfigurer := runtime.NewConfigurer(o.runtime, o.noRuntimeConfig, o.enableNRIPlugin)\n\n\tif len(o.toolkitOptions.ContainerRuntimeRuntimes) == 0 {\n\t\tlowlevelRuntimePaths, err := runtimeConfigurer.GetLowlevelRuntimePaths(&o.runtimeOptions)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to determine runtime options: %w\", err)\n\t\t}\n\t\tlowlevelRuntimePaths = append(lowlevelRuntimePaths, defaultLowLevelRuntimes...)\n\n\t\to.toolkitOptions.ContainerRuntimeRuntimes = lowlevelRuntimePaths\n\t}\n\n\terr = a.toolkit.Install(c, &o.toolkitOptions, o.runtime)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to install toolkit: %v\", err)\n\t}\n\n\terr = runtimeConfigurer.Setup(c, &o.runtimeOptions)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to setup runtime: %w\", err)\n\t}\n\n\tif o.noDaemon {\n\t\treturn nil\n\t}\n\n\tif o.enableNRIPlugin {\n\t\tnriPlugin, err := a.startNRIPluginServer(ctx, o)\n\t\tif err != nil {\n\t\t\ta.logger.Errorf(\"unable to start NRI plugin server: %v\", err)\n\t\t}\n\t\tdefer nriPlugin.Stop()\n\t}\n\n\terr = a.waitForSignal()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to wait for signal: %v\", err)\n\t}\n\n\terr = runtimeConfigurer.Cleanup(c, &o.runtimeOptions)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to cleanup runtime: %v\", err)\n\t}\n\n\treturn nil\n}\n\nfunc (a *app) initialize(pidFile string) error {\n\ta.logger.Infof(\"Initializing\")\n\n\tif dir := filepath.Dir(pidFile); dir != \"\" {\n\t\terr := os.MkdirAll(dir, 0755)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"unable to create folder for pidfile: %w\", err)\n\t\t}\n\t}\n\n\tf, err := os.Create(pidFile)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to create pidfile: %v\", err)\n\t}\n\n\terr = unix.Flock(int(f.Fd()), unix.LOCK_EX|unix.LOCK_NB)\n\tif err != nil {\n\t\ta.logger.Warningf(\"Unable to get exclusive lock on '%v'\", pidFile)\n\t\ta.logger.Warningf(\"This normally means an instance of the NVIDIA toolkit Container is already running, aborting\")\n\t\treturn fmt.Errorf(\"unable to get flock on pidfile: %v\", err)\n\t}\n\n\t_, err = fmt.Fprintf(f, \"%v\\n\", os.Getpid())\n\tif err != nil {\n\t\treturn fmt.Errorf(\"unable to write PID to pidfile: %v\", err)\n\t}\n\n\tsigs := make(chan os.Signal, 1)\n\tsignal.Notify(sigs, syscall.SIGHUP, syscall.SIGINT, syscall.SIGQUIT, syscall.SIGPIPE, syscall.SIGTERM)\n\tgo func() {\n\t\t<-sigs\n\t\tselect {\n\t\tcase <-waitingForSignal:\n\t\t\tsignalReceived <- true\n\t\tdefault:\n\t\t\ta.logger.Infof(\"Signal received, exiting early\")\n\t\t\ta.shutdown(pidFile)\n\t\t\tos.Exit(0)\n\t\t}\n\t}()\n\n\treturn nil\n}\n\nfunc (a *app) waitForSignal() error {\n\ta.logger.Infof(\"Waiting for signal\")\n\twaitingForSignal <- true\n\t<-signalReceived\n\treturn nil\n}\n\nfunc (a *app) startNRIPluginServer(ctx context.Context, opts *options) (*nri.Plugin, error) {\n\ta.logger.Infof(\"Starting the NRI Plugin server....\")\n\n\tconst (\n\t\tmaxRetryAttempts = 5\n\t\tretryBackoff = 2 * time.Second\n\t)\n\n\tplugin := nri.NewPlugin(ctx, a.logger, opts.nriNamespace)\n\tretriable := func() error {\n\t\treturn plugin.Start(ctx, opts.nriSocket, fmt.Sprintf(\"%02d\", opts.nriPluginIndex))\n\t}\n\tvar err error\n\tfor i := 0; i < maxRetryAttempts; i++ {\n\t\terr = retriable()\n\t\tif err == nil {\n\t\t\tbreak\n\t\t}\n\t\ta.logger.Warningf(\"Attempt %d - error starting the NRI plugin: %v\", i+1, err)\n\t\tif i == maxRetryAttempts-1 {\n\t\t\tbreak\n\t\t}\n\t\ttime.Sleep(retryBackoff)\n\t}\n\tif err != nil {\n\t\ta.logger.Errorf(\"Max retries reached %d/%d, aborting\", maxRetryAttempts, maxRetryAttempts)\n\t\treturn nil, err\n\t}\n\treturn plugin, nil\n}\n\nfunc (a *app) shutdown(pidFile string) {\n\ta.logger.Infof(\"Shutting Down\")\n\n\terr := os.Remove(pidFile)\n\tif err != nil {\n\t\ta.logger.Warningf(\"Unable to remove pidfile: %v\", err)\n\t}\n}\n\nfunc (a *app) resolveSourceRoot(hostRoot string, packageType string) (string, error) {\n\tresolvedPackageType, err := a.resolvePackageType(hostRoot, packageType)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tswitch resolvedPackageType {\n\tcase \"deb\":\n\t\treturn \"/artifacts/deb\", nil\n\tcase \"rpm\":\n\t\treturn \"/artifacts/rpm\", nil\n\tdefault:\n\t\treturn \"\", fmt.Errorf(\"invalid package type: %v\", resolvedPackageType)\n\t}\n}\n\nfunc (a *app) resolvePackageType(hostRoot string, packageType string) (rPackageTypes string, rerr error) {\n\tif packageType != \"\" && packageType != \"auto\" {\n\t\treturn packageType, nil\n\t}\n\n\tlocator := lookup.NewExecutableLocator(a.logger, hostRoot)\n\tif candidates, err := locator.Locate(\"/usr/bin/rpm\"); err == nil && len(candidates) > 0 {\n\t\treturn \"rpm\", nil\n\t}\n\n\tif candidates, err := locator.Locate(\"/usr/bin/dpkg\"); err == nil && len(candidates) > 0 {\n\t\treturn \"deb\", nil\n\t}\n\n\treturn \"deb\", nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/main_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage main\n\nimport (\n\t\"context\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestApp(t *testing.T) {\n\tdefer devices.SetAllForTest()()\n\n\tlogger, _ := testlog.NewNullLogger()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tartifactRoot := filepath.Join(moduleRoot, \"testdata\", \"installer\", \"artifacts\")\n\thostRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\", \"rootfs-1\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\targs []string\n\t\texpectedToolkitConfig string\n\t\texpectedRuntimeConfig string\n\t\texpectedDropInRuntimeConfig string\n\t}{\n\t\t{\n\t\t\tdescription: \"no args\",\n\t\t\texpectedToolkitConfig: `accept-nvidia-visible-devices-as-volume-mounts = false\naccept-nvidia-visible-devices-envvar-when-unprivileged = true\ndisable-require = false\nsupported-driver-capabilities = \"compat32,compute,display,graphics,ngx,utility,video\"\nswarm-resource = \"\"\n\n[nvidia-container-cli]\n debug = \"\"\n environment = []\n ldcache = \"\"\n ldconfig = \"@/run/nvidia/driver/sbin/ldconfig\"\n load-kmods = true\n no-cgroups = false\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-cli\"\n root = \"/run/nvidia/driver\"\n user = \"\"\n\n[nvidia-container-runtime]\n debug = \"/dev/null\"\n log-level = \"info\"\n mode = \"auto\"\n runtimes = [\"runc\", \"crun\"]\n\n [nvidia-container-runtime.modes]\n\n [nvidia-container-runtime.modes.cdi]\n annotation-prefixes = [\"cdi.k8s.io/\"]\n default-kind = \"nvidia.com/gpu\"\n spec-dirs = [\"/etc/cdi\", \"/var/run/cdi\"]\n\n [nvidia-container-runtime.modes.csv]\n mount-spec-path = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n\n [nvidia-container-runtime.modes.legacy]\n cuda-compat-mode = \"ldconfig\"\n\n[nvidia-container-runtime-hook]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime-hook\"\n skip-mode-detection = true\n\n[nvidia-ctk]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-ctk\"\n`,\n\t\t\texpectedRuntimeConfig: `{\n \"default-runtime\": \"nvidia\",\n \"runtimes\": {\n \"nvidia\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime\"\n },\n \"nvidia-cdi\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.cdi\"\n },\n \"nvidia-legacy\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.legacy\"\n }\n }\n}`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"CDI enabled enables CDI in docker\",\n\t\t\targs: []string{\"--cdi-enabled\", \"--create-device-nodes=none\"},\n\t\t\texpectedToolkitConfig: `accept-nvidia-visible-devices-as-volume-mounts = false\naccept-nvidia-visible-devices-envvar-when-unprivileged = true\ndisable-require = false\nsupported-driver-capabilities = \"compat32,compute,display,graphics,ngx,utility,video\"\nswarm-resource = \"\"\n\n[nvidia-container-cli]\n debug = \"\"\n environment = []\n ldcache = \"\"\n ldconfig = \"@/run/nvidia/driver/sbin/ldconfig\"\n load-kmods = true\n no-cgroups = false\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-cli\"\n root = \"/run/nvidia/driver\"\n user = \"\"\n\n[nvidia-container-runtime]\n debug = \"/dev/null\"\n log-level = \"info\"\n mode = \"auto\"\n runtimes = [\"runc\", \"crun\"]\n\n [nvidia-container-runtime.modes]\n\n [nvidia-container-runtime.modes.cdi]\n annotation-prefixes = [\"cdi.k8s.io/\"]\n default-kind = \"nvidia.com/gpu\"\n spec-dirs = [\"/etc/cdi\", \"/var/run/cdi\"]\n\n [nvidia-container-runtime.modes.csv]\n mount-spec-path = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n\n [nvidia-container-runtime.modes.legacy]\n cuda-compat-mode = \"ldconfig\"\n\n[nvidia-container-runtime-hook]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime-hook\"\n skip-mode-detection = true\n\n[nvidia-ctk]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-ctk\"\n`,\n\t\t\texpectedRuntimeConfig: `{\n \"default-runtime\": \"nvidia\",\n \"features\": {\n \"cdi\": true\n },\n \"runtimes\": {\n \"nvidia\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime\"\n },\n \"nvidia-cdi\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.cdi\"\n },\n \"nvidia-legacy\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.legacy\"\n }\n }\n}`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"--enable-cdi-in-runtime=false overrides --cdi-enabled in Docker\",\n\t\t\targs: []string{\"--cdi-enabled\", \"--create-device-nodes=none\", \"--enable-cdi-in-runtime=false\"},\n\t\t\texpectedToolkitConfig: `accept-nvidia-visible-devices-as-volume-mounts = false\naccept-nvidia-visible-devices-envvar-when-unprivileged = true\ndisable-require = false\nsupported-driver-capabilities = \"compat32,compute,display,graphics,ngx,utility,video\"\nswarm-resource = \"\"\n\n[nvidia-container-cli]\n debug = \"\"\n environment = []\n ldcache = \"\"\n ldconfig = \"@/run/nvidia/driver/sbin/ldconfig\"\n load-kmods = true\n no-cgroups = false\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-cli\"\n root = \"/run/nvidia/driver\"\n user = \"\"\n\n[nvidia-container-runtime]\n debug = \"/dev/null\"\n log-level = \"info\"\n mode = \"auto\"\n runtimes = [\"runc\", \"crun\"]\n\n [nvidia-container-runtime.modes]\n\n [nvidia-container-runtime.modes.cdi]\n annotation-prefixes = [\"cdi.k8s.io/\"]\n default-kind = \"nvidia.com/gpu\"\n spec-dirs = [\"/etc/cdi\", \"/var/run/cdi\"]\n\n [nvidia-container-runtime.modes.csv]\n mount-spec-path = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n\n [nvidia-container-runtime.modes.legacy]\n cuda-compat-mode = \"ldconfig\"\n\n[nvidia-container-runtime-hook]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime-hook\"\n skip-mode-detection = true\n\n[nvidia-ctk]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-ctk\"\n`,\n\t\t\texpectedRuntimeConfig: `{\n \"default-runtime\": \"nvidia\",\n \"runtimes\": {\n \"nvidia\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime\"\n },\n \"nvidia-cdi\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.cdi\"\n },\n \"nvidia-legacy\": {\n \"args\": [],\n \"path\": \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.legacy\"\n }\n }\n}`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"CDI enabled enables CDI in containerd\",\n\t\t\targs: []string{\"--cdi-enabled\", \"--runtime=containerd\"},\n\t\t\texpectedToolkitConfig: `accept-nvidia-visible-devices-as-volume-mounts = false\naccept-nvidia-visible-devices-envvar-when-unprivileged = true\ndisable-require = false\nsupported-driver-capabilities = \"compat32,compute,display,graphics,ngx,utility,video\"\nswarm-resource = \"\"\n\n[nvidia-container-cli]\n debug = \"\"\n environment = []\n ldcache = \"\"\n ldconfig = \"@/run/nvidia/driver/sbin/ldconfig\"\n load-kmods = true\n no-cgroups = false\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-cli\"\n root = \"/run/nvidia/driver\"\n user = \"\"\n\n[nvidia-container-runtime]\n debug = \"/dev/null\"\n log-level = \"info\"\n mode = \"auto\"\n runtimes = [\"runc\", \"crun\"]\n\n [nvidia-container-runtime.modes]\n\n [nvidia-container-runtime.modes.cdi]\n annotation-prefixes = [\"cdi.k8s.io/\"]\n default-kind = \"nvidia.com/gpu\"\n spec-dirs = [\"/etc/cdi\", \"/var/run/cdi\"]\n\n [nvidia-container-runtime.modes.csv]\n mount-spec-path = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n\n [nvidia-container-runtime.modes.legacy]\n cuda-compat-mode = \"ldconfig\"\n\n[nvidia-container-runtime-hook]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime-hook\"\n skip-mode-detection = true\n\n[nvidia-ctk]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-ctk\"\n`,\n\t\t\texpectedRuntimeConfig: `imports = [\"{{ .testRoot }}/conf.d/*.toml\"]\nversion = 2\n`,\n\t\t\texpectedDropInRuntimeConfig: `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n enable_cdi = true\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.legacy\"\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"--enable-cdi-in-runtime=false overrides --cdi-enabled in containerd\",\n\t\t\targs: []string{\"--cdi-enabled\", \"--create-device-nodes=none\", \"--enable-cdi-in-runtime=false\", \"--runtime=containerd\"},\n\t\t\texpectedToolkitConfig: `accept-nvidia-visible-devices-as-volume-mounts = false\naccept-nvidia-visible-devices-envvar-when-unprivileged = true\ndisable-require = false\nsupported-driver-capabilities = \"compat32,compute,display,graphics,ngx,utility,video\"\nswarm-resource = \"\"\n\n[nvidia-container-cli]\n debug = \"\"\n environment = []\n ldcache = \"\"\n ldconfig = \"@/run/nvidia/driver/sbin/ldconfig\"\n load-kmods = true\n no-cgroups = false\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-cli\"\n root = \"/run/nvidia/driver\"\n user = \"\"\n\n[nvidia-container-runtime]\n debug = \"/dev/null\"\n log-level = \"info\"\n mode = \"auto\"\n runtimes = [\"runc\", \"crun\"]\n\n [nvidia-container-runtime.modes]\n\n [nvidia-container-runtime.modes.cdi]\n annotation-prefixes = [\"cdi.k8s.io/\"]\n default-kind = \"nvidia.com/gpu\"\n spec-dirs = [\"/etc/cdi\", \"/var/run/cdi\"]\n\n [nvidia-container-runtime.modes.csv]\n mount-spec-path = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n\n [nvidia-container-runtime.modes.legacy]\n cuda-compat-mode = \"ldconfig\"\n\n[nvidia-container-runtime-hook]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime-hook\"\n skip-mode-detection = true\n\n[nvidia-ctk]\n path = \"{{ .toolkitRoot }}/toolkit/nvidia-ctk\"\n`,\n\t\t\texpectedRuntimeConfig: `imports = [\"{{ .testRoot }}/conf.d/*.toml\"]\nversion = 2\n`,\n\t\t\texpectedDropInRuntimeConfig: `version = 2\n\n[plugins]\n\n [plugins.\"io.containerd.grpc.v1.cri\"]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"nvidia\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia.options]\n BinaryName = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-cdi.options]\n BinaryName = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.cdi\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy]\n privileged_without_host_devices = false\n runtime_engine = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.nvidia-legacy.options]\n BinaryName = \"{{ .toolkitRoot }}/toolkit/nvidia-container-runtime.legacy\"\n`,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttestRoot := t.TempDir()\n\n\t\t\tcdiOutputDir := filepath.Join(testRoot, \"/var/run/cdi\")\n\t\t\truntimeConfigFile := filepath.Join(testRoot, \"config.file\")\n\t\t\truntimeDropInConfigFile := filepath.Join(testRoot, \"conf.d/config.toml\")\n\n\t\t\ttoolkitRoot := filepath.Join(testRoot, \"toolkit-test\")\n\t\t\ttoolkitConfigFile := filepath.Join(toolkitRoot, \"toolkit/.config/nvidia-container-runtime/config.toml\")\n\n\t\t\tapp := NewApp(logger)\n\n\t\t\ttestArgs := []string{\n\t\t\t\t\"nvidia-ctk-installer\",\n\t\t\t\t\"--toolkit-install-dir=\" + toolkitRoot,\n\t\t\t\t\"--no-daemon\",\n\t\t\t\t\"--enable-nri-plugin=false\",\n\t\t\t\t\"--cdi-output-dir=\" + cdiOutputDir,\n\t\t\t\t\"--config=\" + runtimeConfigFile,\n\t\t\t\t\"--drop-in-config=\" + runtimeDropInConfigFile,\n\t\t\t\t\"--create-device-nodes=none\",\n\t\t\t\t\"--driver-root-ctr-path=\" + hostRoot,\n\t\t\t\t\"--pid-file=\" + filepath.Join(testRoot, \"toolkit.pid\"),\n\t\t\t\t\"--restart-mode=none\",\n\t\t\t\t\"--toolkit-source-root=\" + filepath.Join(artifactRoot, \"deb\"),\n\t\t\t}\n\n\t\t\terr := app.Run(context.Background(), append(testArgs, tc.args...))\n\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.FileExists(t, toolkitConfigFile)\n\t\t\ttoolkitConfigFileContents, err := os.ReadFile(toolkitConfigFile)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, strings.ReplaceAll(tc.expectedToolkitConfig, \"{{ .toolkitRoot }}\", toolkitRoot), string(toolkitConfigFileContents))\n\n\t\t\tif len(tc.expectedRuntimeConfig) > 0 {\n\t\t\t\trequire.FileExists(t, runtimeConfigFile)\n\t\t\t\truntimeConfigFileContents, err := os.ReadFile(runtimeConfigFile)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\texpected := strings.ReplaceAll(tc.expectedRuntimeConfig, \"{{ .testRoot }}\", testRoot)\n\t\t\t\trequire.Equal(t, strings.ReplaceAll(expected, \"{{ .toolkitRoot }}\", toolkitRoot), string(runtimeConfigFileContents))\n\t\t\t} else {\n\t\t\t\trequire.NoFileExists(t, runtimeConfigFile)\n\t\t\t}\n\n\t\t\tif len(tc.expectedDropInRuntimeConfig) > 0 {\n\t\t\t\trequire.FileExists(t, runtimeDropInConfigFile)\n\t\t\t\truntimeDropInConfigFileContents, err := os.ReadFile(runtimeDropInConfigFile)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Equal(t, strings.ReplaceAll(tc.expectedDropInRuntimeConfig, \"{{ .toolkitRoot }}\", toolkitRoot), string(runtimeDropInConfigFileContents))\n\t\t\t} else {\n\t\t\t\trequire.NoFileExists(t, runtimeDropInConfigFile)\n\t\t\t}\n\t\t})\n\t}\n\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/artifact-root.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage installer\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// An artifactRoot is used as a source for installed artifacts.\n// It is refined by a directory path, a library locator, and an executable locator.\ntype artifactRoot struct {\n\tpath string\n\tlibraries lookup.Locator\n\texecutables lookup.Locator\n}\n\nfunc newArtifactRoot(logger logger.Interface, rootDirectoryPath string) (*artifactRoot, error) {\n\trelativeLibrarySearchPaths := []string{\n\t\t\"/usr/lib64\",\n\t\t\"/usr/lib/x86_64-linux-gnu\",\n\t\t\"/usr/lib/aarch64-linux-gnu\",\n\t}\n\tvar librarySearchPaths []string\n\tfor _, l := range relativeLibrarySearchPaths {\n\t\tlibrarySearchPaths = append(librarySearchPaths, filepath.Join(rootDirectoryPath, l))\n\t}\n\n\ta := artifactRoot{\n\t\tpath: rootDirectoryPath,\n\t\tlibraries: lookup.NewLibraryLocator(\n\t\t\tlookup.WithLogger(logger),\n\t\t\tlookup.WithCount(1),\n\t\t\tlookup.WithSearchPaths(librarySearchPaths...),\n\t\t),\n\t\texecutables: lookup.NewExecutableLocator(\n\t\t\tlogger,\n\t\t\trootDirectoryPath,\n\t\t),\n\t}\n\n\treturn &a, nil\n}\n\nfunc (r *artifactRoot) findLibrary(name string) (string, error) {\n\tcandidates, err := r.libraries.Locate(name)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error locating library: %w\", err)\n\t}\n\tif len(candidates) == 0 {\n\t\treturn \"\", fmt.Errorf(\"library %v not found\", name)\n\t}\n\n\treturn candidates[0], nil\n}\n\nfunc (r *artifactRoot) findExecutable(name string) (string, error) {\n\tcandidates, err := r.executables.Locate(name)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error locating executable: %w\", err)\n\t}\n\tif len(candidates) == 0 {\n\t\treturn \"\", fmt.Errorf(\"executable %v not found\", name)\n\t}\n\n\treturn candidates[0], nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/directory.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage installer\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype createDirectory struct {\n\tlogger logger.Interface\n}\n\nfunc (t *ToolkitInstaller) createDirectory() Installer {\n\treturn &createDirectory{\n\t\tlogger: t.logger,\n\t}\n}\n\nfunc (d *createDirectory) Install(dir string) error {\n\tif dir == \"\" {\n\t\treturn nil\n\t}\n\td.logger.Infof(\"Creating directory '%v'\", dir)\n\terr := os.MkdirAll(dir, 0755)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error creating directory: %v\", err)\n\t}\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/executables.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage installer\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"html/template\"\n\t\"io\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\tlog \"github.com/sirupsen/logrus\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container/operator\"\n)\n\ntype executable struct {\n\trequiresKernelModule bool\n\tpath string\n\tsymlink string\n\tenv map[string]string\n}\n\nfunc (t *ToolkitInstaller) collectExecutables(destDir string) ([]Installer, error) {\n\tconfigFilePath := t.ConfigFilePath(destDir)\n\n\texecutables := []executable{\n\t\t{\n\t\t\tpath: \"nvidia-ctk\",\n\t\t},\n\t\t{\n\t\t\tpath: \"nvidia-cdi-hook\",\n\t\t},\n\t}\n\tfor _, runtime := range operator.GetRuntimes() {\n\t\te := executable{\n\t\t\tpath: runtime.Path,\n\t\t\trequiresKernelModule: true,\n\t\t\tenv: map[string]string{\n\t\t\t\tconfig.FilePathOverrideEnvVar: configFilePath,\n\t\t\t},\n\t\t}\n\t\texecutables = append(executables, e)\n\t}\n\texecutables = append(executables,\n\t\texecutable{\n\t\t\tpath: \"nvidia-container-cli\",\n\t\t\tenv: map[string]string{\"LD_LIBRARY_PATH\": destDir + \":$LD_LIBRARY_PATH\"},\n\t\t},\n\t)\n\n\texecutables = append(executables,\n\t\texecutable{\n\t\t\tpath: \"nvidia-container-runtime-hook\",\n\t\t\tsymlink: \"nvidia-container-toolkit\",\n\t\t\tenv: map[string]string{\n\t\t\t\tconfig.FilePathOverrideEnvVar: configFilePath,\n\t\t\t},\n\t\t},\n\t)\n\n\tvar installers []Installer\n\tfor _, executable := range executables {\n\t\texecutablePath, err := t.artifactRoot.findExecutable(executable.path)\n\t\tif err != nil {\n\t\t\tif t.ignoreErrors {\n\t\t\t\tlog.Errorf(\"Ignoring error: %v\", err)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\treturn nil, err\n\t\t}\n\n\t\twrappedExecutableFilename := filepath.Base(executablePath)\n\t\tdotRealFilename := wrappedExecutableFilename + \".real\"\n\n\t\tw := &wrapper{\n\t\t\tSource: executablePath,\n\t\t\tWrappedExecutable: dotRealFilename,\n\t\t\tCheckModules: executable.requiresKernelModule,\n\t\t\tEnvvars: map[string]string{\n\t\t\t\t\"PATH\": strings.Join([]string{destDir, \"$PATH\"}, \":\"),\n\t\t\t},\n\t\t}\n\t\tfor k, v := range executable.env {\n\t\t\tw.Envvars[k] = v\n\t\t}\n\n\t\tif len(t.defaultRuntimeExecutablePath) > 0 {\n\t\t\tw.DefaultRuntimeExecutablePath = t.defaultRuntimeExecutablePath\n\t\t} else {\n\t\t\tw.DefaultRuntimeExecutablePath = \"runc\"\n\t\t}\n\n\t\tinstallers = append(installers, w)\n\n\t\tif executable.symlink == \"\" {\n\t\t\tcontinue\n\t\t}\n\t\tlink := symlink{\n\t\t\tlinkname: executable.symlink,\n\t\t\ttarget: filepath.Base(executablePath),\n\t\t}\n\t\tinstallers = append(installers, link)\n\t}\n\n\treturn installers, nil\n\n}\n\ntype wrapper struct {\n\tSource string\n\tEnvvars map[string]string\n\tWrappedExecutable string\n\tCheckModules bool\n\tDefaultRuntimeExecutablePath string\n}\n\ntype render struct {\n\t*wrapper\n\tDestDir string\n}\n\nfunc (w *wrapper) Install(destDir string) error {\n\t// Copy the executable with a .real extension.\n\tmode, err := installFile(w.Source, filepath.Join(destDir, w.WrappedExecutable))\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// Create a wrapper file.\n\tr := render{\n\t\twrapper: w,\n\t\tDestDir: destDir,\n\t}\n\tcontent, err := r.render()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to render wrapper: %w\", err)\n\t}\n\twrapperFile := filepath.Join(destDir, filepath.Base(w.Source))\n\treturn installContent(content, wrapperFile, mode|0111)\n}\n\nfunc (w *render) render() (io.Reader, error) {\n\twrapperTemplate := `#! /bin/sh\n{{- if (.CheckModules) }}\ncat /proc/modules | grep -e \"^nvidia \" >/dev/null 2>&1\nif [ \"${?}\" != \"0\" ]; then\n\techo \"nvidia driver modules are not yet loaded, invoking {{ .DefaultRuntimeExecutablePath }} directly\" >&2\n\texec {{ .DefaultRuntimeExecutablePath }} \"$@\"\nfi\n{{- end }}\n{{- range $key, $value := .Envvars }}\n{{$key}}={{$value}} \\\n{{- end }}\n\t{{ .DestDir }}/{{ .WrappedExecutable }} \\\n\t\t\"$@\"\n`\n\n\tvar content bytes.Buffer\n\ttmpl, err := template.New(\"wrapper\").Parse(wrapperTemplate)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif err := tmpl.Execute(&content, w); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn &content, nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/executables_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage installer\n\nimport (\n\t\"bytes\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestWrapperRender(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tw *wrapper\n\t\texpected string\n\t}{\n\t\t{\n\t\t\tdescription: \"executable is added\",\n\t\t\tw: &wrapper{\n\t\t\t\tWrappedExecutable: \"some-runtime\",\n\t\t\t\tDefaultRuntimeExecutablePath: \"runc\",\n\t\t\t},\n\t\t\texpected: `#! /bin/sh\n\t/dest-dir/some-runtime \\\n\t\t\"$@\"\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"module check is added\",\n\t\t\tw: &wrapper{\n\t\t\t\tWrappedExecutable: \"some-runtime\",\n\t\t\t\tCheckModules: true,\n\t\t\t\tDefaultRuntimeExecutablePath: \"runc\",\n\t\t\t},\n\t\t\texpected: `#! /bin/sh\ncat /proc/modules | grep -e \"^nvidia \" >/dev/null 2>&1\nif [ \"${?}\" != \"0\" ]; then\n\techo \"nvidia driver modules are not yet loaded, invoking runc directly\" >&2\n\texec runc \"$@\"\nfi\n\t/dest-dir/some-runtime \\\n\t\t\"$@\"\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"environment is added\",\n\t\t\tw: &wrapper{\n\t\t\t\tWrappedExecutable: \"some-runtime\",\n\t\t\t\tEnvvars: map[string]string{\n\t\t\t\t\t\"PATH\": \"/foo/bar/baz\",\n\t\t\t\t},\n\t\t\t\tDefaultRuntimeExecutablePath: \"runc\",\n\t\t\t},\n\t\t\texpected: `#! /bin/sh\nPATH=/foo/bar/baz \\\n\t/dest-dir/some-runtime \\\n\t\t\"$@\"\n`,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tr := render{\n\t\t\t\twrapper: tc.w,\n\t\t\t\tDestDir: \"/dest-dir\",\n\t\t\t}\n\t\t\treader, err := r.render()\n\t\t\trequire.NoError(t, err)\n\n\t\t\tvar content bytes.Buffer\n\t\t\t_, err = content.ReadFrom(reader)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.Equal(t, tc.expected, content.String())\n\t\t})\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/file-installer_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage installer\n\nimport (\n\t\"io\"\n\t\"os\"\n\t\"sync\"\n)\n\n// Ensure, that fileInstallerMock does implement fileInstaller.\n// If this is not the case, regenerate this file with moq.\nvar _ fileInstaller = &fileInstallerMock{}\n\n// fileInstallerMock is a mock implementation of fileInstaller.\n//\n//\tfunc TestSomethingThatUsesfileInstaller(t *testing.T) {\n//\n//\t\t// make and configure a mocked fileInstaller\n//\t\tmockedfileInstaller := &fileInstallerMock{\n//\t\t\tinstallContentFunc: func(reader io.Reader, s string, v os.FileMode) error {\n//\t\t\t\tpanic(\"mock out the installContent method\")\n//\t\t\t},\n//\t\t\tinstallFileFunc: func(s1 string, s2 string) (os.FileMode, error) {\n//\t\t\t\tpanic(\"mock out the installFile method\")\n//\t\t\t},\n//\t\t\tinstallSymlinkFunc: func(s1 string, s2 string) error {\n//\t\t\t\tpanic(\"mock out the installSymlink method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedfileInstaller in code that requires fileInstaller\n//\t\t// and then make assertions.\n//\n//\t}\ntype fileInstallerMock struct {\n\t// installContentFunc mocks the installContent method.\n\tinstallContentFunc func(reader io.Reader, s string, v os.FileMode) error\n\n\t// installFileFunc mocks the installFile method.\n\tinstallFileFunc func(s1 string, s2 string) (os.FileMode, error)\n\n\t// installSymlinkFunc mocks the installSymlink method.\n\tinstallSymlinkFunc func(s1 string, s2 string) error\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// installContent holds details about calls to the installContent method.\n\t\tinstallContent []struct {\n\t\t\t// Reader is the reader argument value.\n\t\t\tReader io.Reader\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t\t// V is the v argument value.\n\t\t\tV os.FileMode\n\t\t}\n\t\t// installFile holds details about calls to the installFile method.\n\t\tinstallFile []struct {\n\t\t\t// S1 is the s1 argument value.\n\t\t\tS1 string\n\t\t\t// S2 is the s2 argument value.\n\t\t\tS2 string\n\t\t}\n\t\t// installSymlink holds details about calls to the installSymlink method.\n\t\tinstallSymlink []struct {\n\t\t\t// S1 is the s1 argument value.\n\t\t\tS1 string\n\t\t\t// S2 is the s2 argument value.\n\t\t\tS2 string\n\t\t}\n\t}\n\tlockinstallContent sync.RWMutex\n\tlockinstallFile sync.RWMutex\n\tlockinstallSymlink sync.RWMutex\n}\n\n// installContent calls installContentFunc.\nfunc (mock *fileInstallerMock) installContent(reader io.Reader, s string, v os.FileMode) error {\n\tif mock.installContentFunc == nil {\n\t\tpanic(\"fileInstallerMock.installContentFunc: method is nil but fileInstaller.installContent was just called\")\n\t}\n\tcallInfo := struct {\n\t\tReader io.Reader\n\t\tS string\n\t\tV os.FileMode\n\t}{\n\t\tReader: reader,\n\t\tS: s,\n\t\tV: v,\n\t}\n\tmock.lockinstallContent.Lock()\n\tmock.calls.installContent = append(mock.calls.installContent, callInfo)\n\tmock.lockinstallContent.Unlock()\n\treturn mock.installContentFunc(reader, s, v)\n}\n\n// installContentCalls gets all the calls that were made to installContent.\n// Check the length with:\n//\n//\tlen(mockedfileInstaller.installContentCalls())\nfunc (mock *fileInstallerMock) installContentCalls() []struct {\n\tReader io.Reader\n\tS string\n\tV os.FileMode\n} {\n\tvar calls []struct {\n\t\tReader io.Reader\n\t\tS string\n\t\tV os.FileMode\n\t}\n\tmock.lockinstallContent.RLock()\n\tcalls = mock.calls.installContent\n\tmock.lockinstallContent.RUnlock()\n\treturn calls\n}\n\n// installFile calls installFileFunc.\nfunc (mock *fileInstallerMock) installFile(s1 string, s2 string) (os.FileMode, error) {\n\tif mock.installFileFunc == nil {\n\t\tpanic(\"fileInstallerMock.installFileFunc: method is nil but fileInstaller.installFile was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS1 string\n\t\tS2 string\n\t}{\n\t\tS1: s1,\n\t\tS2: s2,\n\t}\n\tmock.lockinstallFile.Lock()\n\tmock.calls.installFile = append(mock.calls.installFile, callInfo)\n\tmock.lockinstallFile.Unlock()\n\treturn mock.installFileFunc(s1, s2)\n}\n\n// installFileCalls gets all the calls that were made to installFile.\n// Check the length with:\n//\n//\tlen(mockedfileInstaller.installFileCalls())\nfunc (mock *fileInstallerMock) installFileCalls() []struct {\n\tS1 string\n\tS2 string\n} {\n\tvar calls []struct {\n\t\tS1 string\n\t\tS2 string\n\t}\n\tmock.lockinstallFile.RLock()\n\tcalls = mock.calls.installFile\n\tmock.lockinstallFile.RUnlock()\n\treturn calls\n}\n\n// installSymlink calls installSymlinkFunc.\nfunc (mock *fileInstallerMock) installSymlink(s1 string, s2 string) error {\n\tif mock.installSymlinkFunc == nil {\n\t\tpanic(\"fileInstallerMock.installSymlinkFunc: method is nil but fileInstaller.installSymlink was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS1 string\n\t\tS2 string\n\t}{\n\t\tS1: s1,\n\t\tS2: s2,\n\t}\n\tmock.lockinstallSymlink.Lock()\n\tmock.calls.installSymlink = append(mock.calls.installSymlink, callInfo)\n\tmock.lockinstallSymlink.Unlock()\n\treturn mock.installSymlinkFunc(s1, s2)\n}\n\n// installSymlinkCalls gets all the calls that were made to installSymlink.\n// Check the length with:\n//\n//\tlen(mockedfileInstaller.installSymlinkCalls())\nfunc (mock *fileInstallerMock) installSymlinkCalls() []struct {\n\tS1 string\n\tS2 string\n} {\n\tvar calls []struct {\n\t\tS1 string\n\t\tS2 string\n\t}\n\tmock.lockinstallSymlink.RLock()\n\tcalls = mock.calls.installSymlink\n\tmock.lockinstallSymlink.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/installer.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage installer\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"io/fs\"\n\t\"os\"\n\t\"path/filepath\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n//go:generate moq -rm -fmt=goimports -out installer_mock.go . Installer\ntype Installer interface {\n\tInstall(string) error\n}\n\ntype ToolkitInstaller struct {\n\tlogger logger.Interface\n\tignoreErrors bool\n\tsourceRoot string\n\n\tartifactRoot *artifactRoot\n\n\tensureTargetDirectory Installer\n\n\tdefaultRuntimeExecutablePath string\n}\n\nvar _ Installer = (*ToolkitInstaller)(nil)\n\n// New creates a toolkit installer with the specified options.\nfunc New(opts ...Option) (*ToolkitInstaller, error) {\n\tt := &ToolkitInstaller{\n\t\tsourceRoot: \"/\",\n\t}\n\tfor _, opt := range opts {\n\t\topt(t)\n\t}\n\n\tif t.logger == nil {\n\t\tt.logger = logger.New()\n\t}\n\tif t.artifactRoot == nil {\n\t\tartifactRoot, err := newArtifactRoot(t.logger, t.sourceRoot)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tt.artifactRoot = artifactRoot\n\t}\n\n\tif t.ensureTargetDirectory == nil {\n\t\tt.ensureTargetDirectory = t.createDirectory()\n\t}\n\n\treturn t, nil\n}\n\n// Install ensures that the required toolkit files are installed in the specified directory.\nfunc (t *ToolkitInstaller) Install(destDir string) error {\n\tvar installers []Installer\n\n\tinstallers = append(installers, t.ensureTargetDirectory)\n\n\tlibraries, err := t.collectLibraries()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to collect libraries: %w\", err)\n\t}\n\tinstallers = append(installers, libraries...)\n\n\texecutables, err := t.collectExecutables(destDir)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to collect executables: %w\", err)\n\t}\n\tinstallers = append(installers, executables...)\n\n\tvar errs error\n\tfor _, i := range installers {\n\t\terrs = errors.Join(errs, i.Install(destDir))\n\t}\n\n\treturn errs\n}\n\nfunc (t *ToolkitInstaller) ConfigFilePath(destDir string) string {\n\ttoolkitConfigDir := filepath.Join(destDir, \".config\", \"nvidia-container-runtime\")\n\treturn filepath.Join(toolkitConfigDir, \"config.toml\")\n}\n\ntype symlink struct {\n\tlinkname string\n\ttarget string\n}\n\nfunc (s symlink) Install(destDir string) error {\n\tsymlinkPath := filepath.Join(destDir, s.linkname)\n\treturn installSymlink(s.target, symlinkPath)\n}\n\n//go:generate moq -rm -fmt=goimports -out file-installer_mock.go . fileInstaller\ntype fileInstaller interface {\n\tinstallContent(io.Reader, string, os.FileMode) error\n\tinstallFile(string, string) (os.FileMode, error)\n\tinstallSymlink(string, string) error\n}\n\nvar installSymlink = installSymlinkStub\n\nfunc installSymlinkStub(target string, link string) error {\n\terr := os.Symlink(target, link)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error creating symlink '%v' => '%v': %v\", link, target, err)\n\t}\n\treturn nil\n}\n\nvar installFile = installFileStub\n\nfunc installFileStub(src string, dest string) (os.FileMode, error) {\n\tsourceInfo, err := os.Stat(src)\n\tif err != nil {\n\t\treturn 0, fmt.Errorf(\"error getting file info for '%v': %v\", src, err)\n\t}\n\n\tsource, err := os.Open(src)\n\tif err != nil {\n\t\treturn 0, fmt.Errorf(\"error opening source: %w\", err)\n\t}\n\tdefer source.Close()\n\n\tmode := sourceInfo.Mode()\n\tif err := installContent(source, dest, mode); err != nil {\n\t\treturn 0, err\n\t}\n\treturn mode, nil\n}\n\nvar installContent = installContentStub\n\nfunc installContentStub(content io.Reader, dest string, mode fs.FileMode) error {\n\tdestination, err := os.Create(dest)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error creating destination: %w\", err)\n\t}\n\tdefer destination.Close()\n\n\t_, err = io.Copy(destination, content)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error copying file: %w\", err)\n\t}\n\terr = os.Chmod(dest, mode)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error setting mode for '%v': %v\", dest, err)\n\t}\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/installer_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage installer\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that InstallerMock does implement Installer.\n// If this is not the case, regenerate this file with moq.\nvar _ Installer = &InstallerMock{}\n\n// InstallerMock is a mock implementation of Installer.\n//\n//\tfunc TestSomethingThatUsesInstaller(t *testing.T) {\n//\n//\t\t// make and configure a mocked Installer\n//\t\tmockedInstaller := &InstallerMock{\n//\t\t\tInstallFunc: func(s string) error {\n//\t\t\t\tpanic(\"mock out the Install method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedInstaller in code that requires Installer\n//\t\t// and then make assertions.\n//\n//\t}\ntype InstallerMock struct {\n\t// InstallFunc mocks the Install method.\n\tInstallFunc func(s string) error\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Install holds details about calls to the Install method.\n\t\tInstall []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t}\n\tlockInstall sync.RWMutex\n}\n\n// Install calls InstallFunc.\nfunc (mock *InstallerMock) Install(s string) error {\n\tif mock.InstallFunc == nil {\n\t\tpanic(\"InstallerMock.InstallFunc: method is nil but Installer.Install was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockInstall.Lock()\n\tmock.calls.Install = append(mock.calls.Install, callInfo)\n\tmock.lockInstall.Unlock()\n\treturn mock.InstallFunc(s)\n}\n\n// InstallCalls gets all the calls that were made to Install.\n// Check the length with:\n//\n//\tlen(mockedInstaller.InstallCalls())\nfunc (mock *InstallerMock) InstallCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockInstall.RLock()\n\tcalls = mock.calls.Install\n\tmock.lockInstall.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/installer_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage installer\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"io/fs\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nfunc TestToolkitInstaller(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttype contentCall struct {\n\t\twrapper string\n\t\tpath string\n\t\tmode fs.FileMode\n\t}\n\tvar contentCalls []contentCall\n\n\tinstaller := &fileInstallerMock{\n\t\tinstallFileFunc: func(s1, s2 string) (os.FileMode, error) {\n\t\t\treturn 0666, nil\n\t\t},\n\t\tinstallContentFunc: func(reader io.Reader, s string, fileMode fs.FileMode) error {\n\t\t\tvar b bytes.Buffer\n\t\t\tif _, err := b.ReadFrom(reader); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tcontents := contentCall{\n\t\t\t\twrapper: b.String(),\n\t\t\t\tpath: s,\n\t\t\t\tmode: fileMode,\n\t\t\t}\n\n\t\t\tcontentCalls = append(contentCalls, contents)\n\t\t\treturn nil\n\t\t},\n\t\tinstallSymlinkFunc: func(s1, s2 string) error {\n\t\t\treturn nil\n\t\t},\n\t}\n\tinstallFile = installer.installFile\n\tinstallContent = installer.installContent\n\tinstallSymlink = installer.installSymlink\n\n\troot := \"/artifacts/test\"\n\tlibraries := &lookup.LocatorMock{\n\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\tswitch s {\n\t\t\tcase \"libnvidia-container.so.1\":\n\t\t\t\treturn []string{filepath.Join(root, \"libnvidia-container.so.987.65.43\")}, nil\n\t\t\tcase \"libnvidia-container-go.so.1\":\n\t\t\t\treturn []string{filepath.Join(root, \"libnvidia-container-go.so.1.23.4\")}, nil\n\t\t\t}\n\t\t\treturn nil, fmt.Errorf(\"%v not found\", s)\n\t\t},\n\t}\n\texecutables := &lookup.LocatorMock{\n\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\tswitch s {\n\t\t\tcase \"nvidia-container-runtime.cdi\":\n\t\t\t\tfallthrough\n\t\t\tcase \"nvidia-container-runtime.legacy\":\n\t\t\t\tfallthrough\n\t\t\tcase \"nvidia-container-runtime\":\n\t\t\t\tfallthrough\n\t\t\tcase \"nvidia-ctk\":\n\t\t\t\tfallthrough\n\t\t\tcase \"nvidia-container-cli\":\n\t\t\t\tfallthrough\n\t\t\tcase \"nvidia-container-runtime-hook\":\n\t\t\t\tfallthrough\n\t\t\tcase \"nvidia-cdi-hook\":\n\t\t\t\treturn []string{filepath.Join(root, \"usr/bin\", s)}, nil\n\t\t\t}\n\t\t\treturn nil, fmt.Errorf(\"%v not found\", s)\n\t\t},\n\t}\n\n\tr := &artifactRoot{\n\t\tlibraries: libraries,\n\t\texecutables: executables,\n\t}\n\n\tcreateDirectory := &InstallerMock{\n\t\tInstallFunc: func(c string) error {\n\t\t\treturn nil\n\t\t},\n\t}\n\ti := ToolkitInstaller{\n\t\tlogger: logger,\n\t\tartifactRoot: r,\n\t\tensureTargetDirectory: createDirectory,\n\t\tdefaultRuntimeExecutablePath: \"runc\",\n\t}\n\n\terr := i.Install(\"/foo/bar/baz\")\n\trequire.NoError(t, err)\n\n\trequire.ElementsMatch(t,\n\t\t[]struct {\n\t\t\tS string\n\t\t}{\n\t\t\t{\"/foo/bar/baz\"},\n\t\t},\n\t\tcreateDirectory.InstallCalls(),\n\t)\n\n\trequire.ElementsMatch(t,\n\t\tinstaller.installFileCalls(),\n\t\t[]struct {\n\t\t\tS1 string\n\t\t\tS2 string\n\t\t}{\n\t\t\t{\"/artifacts/test/libnvidia-container-go.so.1.23.4\", \"/foo/bar/baz/libnvidia-container-go.so.1.23.4\"},\n\t\t\t{\"/artifacts/test/libnvidia-container.so.987.65.43\", \"/foo/bar/baz/libnvidia-container.so.987.65.43\"},\n\t\t\t{\"/artifacts/test/usr/bin/nvidia-container-runtime.cdi\", \"/foo/bar/baz/nvidia-container-runtime.cdi.real\"},\n\t\t\t{\"/artifacts/test/usr/bin/nvidia-container-runtime.legacy\", \"/foo/bar/baz/nvidia-container-runtime.legacy.real\"},\n\t\t\t{\"/artifacts/test/usr/bin/nvidia-container-runtime\", \"/foo/bar/baz/nvidia-container-runtime.real\"},\n\t\t\t{\"/artifacts/test/usr/bin/nvidia-ctk\", \"/foo/bar/baz/nvidia-ctk.real\"},\n\t\t\t{\"/artifacts/test/usr/bin/nvidia-cdi-hook\", \"/foo/bar/baz/nvidia-cdi-hook.real\"},\n\t\t\t{\"/artifacts/test/usr/bin/nvidia-container-cli\", \"/foo/bar/baz/nvidia-container-cli.real\"},\n\t\t\t{\"/artifacts/test/usr/bin/nvidia-container-runtime-hook\", \"/foo/bar/baz/nvidia-container-runtime-hook.real\"},\n\t\t},\n\t)\n\n\trequire.ElementsMatch(t,\n\t\tinstaller.installSymlinkCalls(),\n\t\t[]struct {\n\t\t\tS1 string\n\t\t\tS2 string\n\t\t}{\n\t\t\t{\"libnvidia-container-go.so.1.23.4\", \"/foo/bar/baz/libnvidia-container-go.so.1\"},\n\t\t\t{\"libnvidia-container.so.987.65.43\", \"/foo/bar/baz/libnvidia-container.so.1\"},\n\t\t\t{\"nvidia-container-runtime-hook\", \"/foo/bar/baz/nvidia-container-toolkit\"},\n\t\t},\n\t)\n\n\trequire.ElementsMatch(t,\n\t\tcontentCalls,\n\t\t[]contentCall{\n\t\t\t{\n\t\t\t\tpath: \"/foo/bar/baz/nvidia-container-runtime\",\n\t\t\t\tmode: 0777,\n\t\t\t\twrapper: `#! /bin/sh\ncat /proc/modules | grep -e \"^nvidia \" >/dev/null 2>&1\nif [ \"${?}\" != \"0\" ]; then\n\techo \"nvidia driver modules are not yet loaded, invoking runc directly\" >&2\n\texec runc \"$@\"\nfi\nNVIDIA_CTK_CONFIG_FILE_PATH=/foo/bar/baz/.config/nvidia-container-runtime/config.toml \\\nPATH=/foo/bar/baz:$PATH \\\n\t/foo/bar/baz/nvidia-container-runtime.real \\\n\t\t\"$@\"\n`,\n\t\t\t},\n\t\t\t{\n\t\t\t\tpath: \"/foo/bar/baz/nvidia-container-runtime.cdi\",\n\t\t\t\tmode: 0777,\n\t\t\t\twrapper: `#! /bin/sh\ncat /proc/modules | grep -e \"^nvidia \" >/dev/null 2>&1\nif [ \"${?}\" != \"0\" ]; then\n\techo \"nvidia driver modules are not yet loaded, invoking runc directly\" >&2\n\texec runc \"$@\"\nfi\nNVIDIA_CTK_CONFIG_FILE_PATH=/foo/bar/baz/.config/nvidia-container-runtime/config.toml \\\nPATH=/foo/bar/baz:$PATH \\\n\t/foo/bar/baz/nvidia-container-runtime.cdi.real \\\n\t\t\"$@\"\n`,\n\t\t\t},\n\t\t\t{\n\t\t\t\tpath: \"/foo/bar/baz/nvidia-container-runtime.legacy\",\n\t\t\t\tmode: 0777,\n\t\t\t\twrapper: `#! /bin/sh\ncat /proc/modules | grep -e \"^nvidia \" >/dev/null 2>&1\nif [ \"${?}\" != \"0\" ]; then\n\techo \"nvidia driver modules are not yet loaded, invoking runc directly\" >&2\n\texec runc \"$@\"\nfi\nNVIDIA_CTK_CONFIG_FILE_PATH=/foo/bar/baz/.config/nvidia-container-runtime/config.toml \\\nPATH=/foo/bar/baz:$PATH \\\n\t/foo/bar/baz/nvidia-container-runtime.legacy.real \\\n\t\t\"$@\"\n`,\n\t\t\t},\n\t\t\t{\n\t\t\t\tpath: \"/foo/bar/baz/nvidia-ctk\",\n\t\t\t\tmode: 0777,\n\t\t\t\twrapper: `#! /bin/sh\nPATH=/foo/bar/baz:$PATH \\\n\t/foo/bar/baz/nvidia-ctk.real \\\n\t\t\"$@\"\n`,\n\t\t\t},\n\t\t\t{\n\t\t\t\tpath: \"/foo/bar/baz/nvidia-cdi-hook\",\n\t\t\t\tmode: 0777,\n\t\t\t\twrapper: `#! /bin/sh\nPATH=/foo/bar/baz:$PATH \\\n\t/foo/bar/baz/nvidia-cdi-hook.real \\\n\t\t\"$@\"\n`,\n\t\t\t},\n\t\t\t{\n\t\t\t\tpath: \"/foo/bar/baz/nvidia-container-cli\",\n\t\t\t\tmode: 0777,\n\t\t\t\twrapper: `#! /bin/sh\nLD_LIBRARY_PATH=/foo/bar/baz:$LD_LIBRARY_PATH \\\nPATH=/foo/bar/baz:$PATH \\\n\t/foo/bar/baz/nvidia-container-cli.real \\\n\t\t\"$@\"\n`,\n\t\t\t},\n\t\t\t{\n\t\t\t\tpath: \"/foo/bar/baz/nvidia-container-runtime-hook\",\n\t\t\t\tmode: 0777,\n\t\t\t\twrapper: `#! /bin/sh\nNVIDIA_CTK_CONFIG_FILE_PATH=/foo/bar/baz/.config/nvidia-container-runtime/config.toml \\\nPATH=/foo/bar/baz:$PATH \\\n\t/foo/bar/baz/nvidia-container-runtime-hook.real \\\n\t\t\"$@\"\n`,\n\t\t\t},\n\t\t},\n\t)\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/libraries.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage installer\n\nimport (\n\t\"path/filepath\"\n\n\tlog \"github.com/sirupsen/logrus\"\n)\n\n// collectLibraries locates and installs the libraries that are part of\n// the nvidia-container-toolkit.\n// A predefined set of library candidates are considered, with the first one\n// resulting in success being installed to the toolkit folder. The install process\n// resolves the symlink for the library and copies the versioned library itself.\nfunc (t *ToolkitInstaller) collectLibraries() ([]Installer, error) {\n\trequiredLibraries := []string{\n\t\t\"libnvidia-container.so.1\",\n\t\t\"libnvidia-container-go.so.1\",\n\t}\n\n\tvar installers []Installer\n\tfor _, l := range requiredLibraries {\n\t\tlibraryPath, err := t.artifactRoot.findLibrary(l)\n\t\tif err != nil {\n\t\t\tif t.ignoreErrors {\n\t\t\t\tlog.Errorf(\"Ignoring error: %v\", err)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\treturn nil, err\n\t\t}\n\n\t\tinstallers = append(installers, library(libraryPath))\n\n\t\tif filepath.Base(libraryPath) == l {\n\t\t\tcontinue\n\t\t}\n\n\t\tlink := symlink{\n\t\t\tlinkname: l,\n\t\t\ttarget: filepath.Base(libraryPath),\n\t\t}\n\t\tinstallers = append(installers, link)\n\t}\n\n\treturn installers, nil\n}\n\ntype library string\n\n// Install copies the library l to the destination folder.\n// The same basename is used in the destination folder.\nfunc (l library) Install(destinationDir string) error {\n\tdest := filepath.Join(destinationDir, filepath.Base(string(l)))\n\n\t_, err := installFile(string(l), dest)\n\treturn err\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/installer/options.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage installer\n\nimport \"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\ntype Option func(*ToolkitInstaller)\n\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(ti *ToolkitInstaller) {\n\t\tti.logger = logger\n\t}\n}\n\nfunc WithArtifactRoot(artifactRoot *artifactRoot) Option {\n\treturn func(ti *ToolkitInstaller) {\n\t\tti.artifactRoot = artifactRoot\n\t}\n}\n\nfunc WithIgnoreErrors(ignoreErrors bool) Option {\n\treturn func(ti *ToolkitInstaller) {\n\t\tti.ignoreErrors = ignoreErrors\n\t}\n}\n\n// WithSourceRoot sets the root directory for locating artifacts to be installed.\nfunc WithSourceRoot(sourceRoot string) Option {\n\treturn func(ti *ToolkitInstaller) {\n\t\tti.sourceRoot = sourceRoot\n\t}\n}\n\nfunc WithDefaultRuntimeExecutablePath(path string) Option {\n\treturn func(ti *ToolkitInstaller) {\n\t\tti.defaultRuntimeExecutablePath = path\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/options.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toolkit\n\nimport \"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\n// An Option provides a mechanism to configure an Installer.\ntype Option func(*Installer)\n\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(i *Installer) {\n\t\ti.logger = logger\n\t}\n}\n\nfunc WithToolkitRoot(toolkitRoot string) Option {\n\treturn func(i *Installer) {\n\t\ti.toolkitRoot = toolkitRoot\n\t}\n}\n\nfunc WithSourceRoot(sourceRoot string) Option {\n\treturn func(i *Installer) {\n\t\ti.sourceRoot = sourceRoot\n\t}\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/toolkit.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage toolkit\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/urfave/cli/v3\"\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/pkg/parser\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container/runtime/crio\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/toolkit/installer\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi\"\n\ttransformroot \"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/system/nvdevices\"\n)\n\nconst (\n\t// DefaultNvidiaDriverRoot specifies the default NVIDIA driver run directory\n\tDefaultNvidiaDriverRoot = \"/run/nvidia/driver\"\n)\n\ntype cdiOptions struct {\n\tEnabled bool\n\toutputDir string\n\tkind string\n\tvendor string\n\tclass string\n}\n\ntype Options struct {\n\tDriverRoot string\n\tDevRoot string\n\tDriverRootCtrPath string\n\tDevRootCtrPath string\n\n\tContainerRuntimeMode string\n\tContainerRuntimeDebug string\n\tContainerRuntimeLogLevel string\n\n\tContainerRuntimeModesCdiDefaultKind string\n\tContainerRuntimeModesCDIAnnotationPrefixes []string\n\n\tContainerRuntimeRuntimes []string\n\n\tContainerRuntimeHookSkipModeDetection bool\n\n\tContainerCLIDebug string\n\n\t// CDI stores the CDI options for the toolkit.\n\tCDI cdiOptions\n\n\tcreateDeviceNodes []string\n\n\tacceptNVIDIAVisibleDevicesWhenUnprivileged bool\n\tacceptNVIDIAVisibleDevicesAsVolumeMounts bool\n\n\tignoreErrors bool\n\n\toptInFeatures []string\n}\n\nfunc Flags(opts *Options) []cli.Flag {\n\tflags := []cli.Flag{\n\t\t&cli.StringFlag{\n\t\t\tName: \"driver-root\",\n\t\t\tAliases: []string{\"nvidia-driver-root\"},\n\t\t\tValue: DefaultNvidiaDriverRoot,\n\t\t\tDestination: &opts.DriverRoot,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_DRIVER_ROOT\", \"DRIVER_ROOT\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"driver-root-ctr-path\",\n\t\t\tValue: DefaultNvidiaDriverRoot,\n\t\t\tDestination: &opts.DriverRootCtrPath,\n\t\t\tSources: cli.EnvVars(\"DRIVER_ROOT_CTR_PATH\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"dev-root\",\n\t\t\tUsage: \"Specify the root where `/dev` is located. If this is not specified, the driver-root is assumed.\",\n\t\t\tDestination: &opts.DevRoot,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_DEV_ROOT\", \"DEV_ROOT\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"dev-root-ctr-path\",\n\t\t\tUsage: \"Specify the root where `/dev` is located in the container. If this is not specified, the driver-root-ctr-path is assumed.\",\n\t\t\tDestination: &opts.DevRootCtrPath,\n\t\t\tSources: cli.EnvVars(\"DEV_ROOT_CTR_PATH\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"nvidia-container-runtime.debug\",\n\t\t\tAliases: []string{\"nvidia-container-runtime-debug\"},\n\t\t\tUsage: \"Specify the location of the debug log file for the NVIDIA Container Runtime\",\n\t\t\tDestination: &opts.ContainerRuntimeDebug,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_RUNTIME_DEBUG\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"nvidia-container-runtime.log-level\",\n\t\t\tAliases: []string{\"nvidia-container-runtime-debug-log-level\"},\n\t\t\tDestination: &opts.ContainerRuntimeLogLevel,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_RUNTIME_LOG_LEVEL\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"nvidia-container-runtime.mode\",\n\t\t\tAliases: []string{\"nvidia-container-runtime-mode\"},\n\t\t\tDestination: &opts.ContainerRuntimeMode,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_RUNTIME_MODE\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"nvidia-container-runtime.modes.cdi.default-kind\",\n\t\t\tDestination: &opts.ContainerRuntimeModesCdiDefaultKind,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_RUNTIME_MODES_CDI_DEFAULT_KIND\"),\n\t\t},\n\t\t&cli.StringSliceFlag{\n\t\t\tName: \"nvidia-container-runtime.modes.cdi.annotation-prefixes\",\n\t\t\tDestination: &opts.ContainerRuntimeModesCDIAnnotationPrefixes,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_RUNTIME_MODES_CDI_ANNOTATION_PREFIXES\"),\n\t\t},\n\t\t&cli.StringSliceFlag{\n\t\t\tName: \"nvidia-container-runtime.runtimes\",\n\t\t\tDestination: &opts.ContainerRuntimeRuntimes,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_RUNTIME_RUNTIMES\"),\n\t\t},\n\t\t&cli.BoolFlag{\n\t\t\tName: \"nvidia-container-runtime-hook.skip-mode-detection\",\n\t\t\tValue: true,\n\t\t\tDestination: &opts.ContainerRuntimeHookSkipModeDetection,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_RUNTIME_HOOK_SKIP_MODE_DETECTION\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"nvidia-container-cli.debug\",\n\t\t\tAliases: []string{\"nvidia-container-cli-debug\"},\n\t\t\tUsage: \"Specify the location of the debug log file for the NVIDIA Container CLI\",\n\t\t\tDestination: &opts.ContainerCLIDebug,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_CLI_DEBUG\"),\n\t\t},\n\t\t&cli.BoolFlag{\n\t\t\tName: \"accept-nvidia-visible-devices-envvar-when-unprivileged\",\n\t\t\tUsage: \"Set the accept-nvidia-visible-devices-envvar-when-unprivileged config option\",\n\t\t\tValue: true,\n\t\t\tDestination: &opts.acceptNVIDIAVisibleDevicesWhenUnprivileged,\n\t\t\tSources: cli.EnvVars(\"ACCEPT_NVIDIA_VISIBLE_DEVICES_ENVVAR_WHEN_UNPRIVILEGED\"),\n\t\t},\n\t\t&cli.BoolFlag{\n\t\t\tName: \"accept-nvidia-visible-devices-as-volume-mounts\",\n\t\t\tUsage: \"Set the accept-nvidia-visible-devices-as-volume-mounts config option\",\n\t\t\tDestination: &opts.acceptNVIDIAVisibleDevicesAsVolumeMounts,\n\t\t\tSources: cli.EnvVars(\"ACCEPT_NVIDIA_VISIBLE_DEVICES_AS_VOLUME_MOUNTS\"),\n\t\t},\n\t\t&cli.BoolFlag{\n\t\t\tName: \"cdi-enabled\",\n\t\t\tAliases: []string{\"enable-cdi\"},\n\t\t\tUsage: \"enable the generation of a CDI specification\",\n\t\t\tDestination: &opts.CDI.Enabled,\n\t\t\tSources: cli.EnvVars(\"CDI_ENABLED\", \"ENABLE_CDI\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"cdi-output-dir\",\n\t\t\tUsage: \"the directory where the CDI output files are to be written. If this is set to '', no CDI specification is generated.\",\n\t\t\tValue: \"/var/run/cdi\",\n\t\t\tDestination: &opts.CDI.outputDir,\n\t\t\tSources: cli.EnvVars(\"CDI_OUTPUT_DIR\"),\n\t\t},\n\t\t&cli.StringFlag{\n\t\t\tName: \"cdi-kind\",\n\t\t\tUsage: \"the vendor string to use for the generated CDI specification\",\n\t\t\tValue: \"management.nvidia.com/gpu\",\n\t\t\tDestination: &opts.CDI.kind,\n\t\t\tSources: cli.EnvVars(\"CDI_KIND\"),\n\t\t},\n\t\t&cli.BoolFlag{\n\t\t\tName: \"ignore-errors\",\n\t\t\tUsage: \"ignore errors when installing the NVIDIA Container toolkit. This is used for testing purposes only.\",\n\t\t\tHidden: true,\n\t\t\tDestination: &opts.ignoreErrors,\n\t\t},\n\t\t&cli.StringSliceFlag{\n\t\t\tName: \"create-device-nodes\",\n\t\t\tUsage: \"(Only applicable with --cdi-enabled) specifies which device nodes should be created. If any one of the options is set to '' or 'none', no device nodes will be created.\",\n\t\t\tValue: []string{\"control\"},\n\t\t\tDestination: &opts.createDeviceNodes,\n\t\t\tSources: cli.EnvVars(\"CREATE_DEVICE_NODES\"),\n\t\t},\n\t\t&cli.StringSliceFlag{\n\t\t\tName: \"opt-in-features\",\n\t\t\tHidden: true,\n\t\t\tDestination: &opts.optInFeatures,\n\t\t\tSources: cli.EnvVars(\"NVIDIA_CONTAINER_TOOLKIT_OPT_IN_FEATURES\"),\n\t\t},\n\t}\n\n\treturn flags\n}\n\n// An Installer is used to install the NVIDIA Container Toolkit from the toolkit container.\ntype Installer struct {\n\tlogger logger.Interface\n\n\tsourceRoot string\n\t// toolkitRoot specifies the destination path at which the toolkit is installed.\n\ttoolkitRoot string\n}\n\n// NewInstaller creates an installer for the NVIDIA Container Toolkit.\nfunc NewInstaller(opts ...Option) *Installer {\n\ti := &Installer{}\n\tfor _, opt := range opts {\n\t\topt(i)\n\t}\n\n\tif i.logger == nil {\n\t\ti.logger = logger.New()\n\t}\n\n\treturn i\n}\n\n// ValidateOptions checks whether the specified options are valid\nfunc (t *Installer) ValidateOptions(opts *Options) error {\n\tif t == nil {\n\t\treturn fmt.Errorf(\"toolkit installer is not initilized\")\n\t}\n\tif t.toolkitRoot == \"\" {\n\t\treturn fmt.Errorf(\"invalid --toolkit-root option: %v\", t.toolkitRoot)\n\t}\n\n\tvendor, class := parser.ParseQualifier(opts.CDI.kind)\n\tif err := parser.ValidateVendorName(vendor); err != nil {\n\t\treturn fmt.Errorf(\"invalid CDI vendor name: %v\", err)\n\t}\n\tif err := parser.ValidateClassName(class); err != nil {\n\t\treturn fmt.Errorf(\"invalid CDI class name: %v\", err)\n\t}\n\topts.CDI.vendor = vendor\n\topts.CDI.class = class\n\n\tif opts.CDI.Enabled && opts.CDI.outputDir == \"\" {\n\t\tt.logger.Warningf(\"Skipping CDI spec generation (no output directory specified)\")\n\t\topts.CDI.Enabled = false\n\t}\n\n\tisDisabled := false\n\tfor _, mode := range opts.createDeviceNodes {\n\t\tif mode != \"\" && mode != \"none\" && mode != \"control\" {\n\t\t\treturn fmt.Errorf(\"invalid --create-device-nodes value: %v\", mode)\n\t\t}\n\t\tif mode == \"\" || mode == \"none\" {\n\t\t\tisDisabled = true\n\t\t\tbreak\n\t\t}\n\t}\n\tif !opts.CDI.Enabled && !isDisabled {\n\t\tt.logger.Infof(\"disabling device node creation since --cdi-enabled=false\")\n\t\tisDisabled = true\n\t}\n\tif isDisabled {\n\t\topts.createDeviceNodes = []string{}\n\t}\n\n\treturn nil\n}\n\n// Install installs the components of the NVIDIA container toolkit.\n// Any existing installation is removed.\nfunc (t *Installer) Install(cli *cli.Command, opts *Options, runtime string) error {\n\tif t == nil {\n\t\treturn fmt.Errorf(\"toolkit installer is not initilized\")\n\t}\n\tt.logger.Infof(\"Installing NVIDIA container toolkit to '%v'\", t.toolkitRoot)\n\n\tt.logger.Infof(\"Removing existing NVIDIA container toolkit installation\")\n\terr := os.RemoveAll(t.toolkitRoot)\n\tif err != nil && !opts.ignoreErrors {\n\t\treturn fmt.Errorf(\"error removing toolkit directory: %v\", err)\n\t} else if err != nil {\n\t\tt.logger.Errorf(\"Ignoring error: %v\", fmt.Errorf(\"error removing toolkit directory: %v\", err))\n\t}\n\n\tvar defaultRuntimeExecutable string\n\tif len(opts.ContainerRuntimeRuntimes) > 0 {\n\t\tdefaultRuntimeExecutable = opts.ContainerRuntimeRuntimes[0]\n\t}\n\n\t// If opts.ContainerRuntimeRuntimes is empty (highly unlikely), we fall back to either runc or crun\n\t// depending on the runtime\n\tif len(defaultRuntimeExecutable) == 0 {\n\t\tif runtime == crio.Name {\n\t\t\tdefaultRuntimeExecutable = \"crun\"\n\t\t} else {\n\t\t\tdefaultRuntimeExecutable = \"runc\"\n\t\t}\n\t}\n\n\t// Create a toolkit installer to actually install the toolkit components.\n\ttoolkit, err := installer.New(\n\t\tinstaller.WithLogger(t.logger),\n\t\tinstaller.WithSourceRoot(t.sourceRoot),\n\t\tinstaller.WithIgnoreErrors(opts.ignoreErrors),\n\t\tinstaller.WithDefaultRuntimeExecutablePath(defaultRuntimeExecutable),\n\t)\n\tif err != nil {\n\t\tif !opts.ignoreErrors {\n\t\t\treturn fmt.Errorf(\"could not create toolkit installer: %w\", err)\n\t\t}\n\t\tt.logger.Errorf(\"Ignoring error: %v\", fmt.Errorf(\"could not create toolkit installer: %w\", err))\n\t}\n\n\tif err := toolkit.Install(t.toolkitRoot); err != nil {\n\t\tif !opts.ignoreErrors {\n\t\t\treturn fmt.Errorf(\"could not install toolkit components: %w\", err)\n\t\t}\n\t\tt.logger.Errorf(\"Ignoring error: %v\", fmt.Errorf(\"could not install toolkit components: %w\", err))\n\t}\n\n\terr = t.installToolkitConfig(cli, opts, toolkit.ConfigFilePath(t.toolkitRoot))\n\tif err != nil && !opts.ignoreErrors {\n\t\treturn fmt.Errorf(\"error installing NVIDIA container toolkit config: %v\", err)\n\t} else if err != nil {\n\t\tt.logger.Errorf(\"Ignoring error: %v\", fmt.Errorf(\"error installing NVIDIA container toolkit config: %v\", err))\n\t}\n\n\terr = t.createDeviceNodes(opts)\n\tif err != nil && !opts.ignoreErrors {\n\t\treturn fmt.Errorf(\"error creating device nodes: %v\", err)\n\t} else if err != nil {\n\t\tt.logger.Errorf(\"Ignoring error: %v\", fmt.Errorf(\"error creating device nodes: %v\", err))\n\t}\n\n\tnvidiaCDIHookPath := filepath.Join(t.toolkitRoot, \"nvidia-cdi-hook\")\n\terr = t.generateCDISpec(opts, nvidiaCDIHookPath)\n\tif err != nil && !opts.ignoreErrors {\n\t\treturn fmt.Errorf(\"error generating CDI specification: %v\", err)\n\t} else if err != nil {\n\t\tt.logger.Errorf(\"Ignoring error: %v\", fmt.Errorf(\"error generating CDI specification: %v\", err))\n\t}\n\n\treturn nil\n}\n\n// installToolkitConfig installs the config file for the NVIDIA container toolkit ensuring\n// that the settings are updated to match the desired install and nvidia driver directories.\nfunc (t *Installer) installToolkitConfig(c *cli.Command, opts *Options, toolkitConfigPath string) error {\n\n\tt.logger.Infof(\"Installing NVIDIA container toolkit config '%v'\", toolkitConfigPath)\n\n\terr := t.createDirectories(filepath.Dir(toolkitConfigPath))\n\tif err != nil && !opts.ignoreErrors {\n\t\treturn fmt.Errorf(\"could not create required directories: %v\", err)\n\t} else if err != nil {\n\t\tt.logger.Errorf(\"Ignoring error: %v\", fmt.Errorf(\"could not create required directories: %v\", err))\n\t}\n\tnvidiaContainerCliExecutablePath := filepath.Join(t.toolkitRoot, \"nvidia-container-cli\")\n\tnvidiaCTKPath := filepath.Join(t.toolkitRoot, \"nvidia-ctk\")\n\tnvidiaContainerRuntimeHookPath := filepath.Join(t.toolkitRoot, \"nvidia-container-runtime-hook\")\n\n\tcfg, err := config.New()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"could not open source config file: %v\", err)\n\t}\n\n\ttargetConfig, err := os.Create(toolkitConfigPath)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"could not create target config file: %v\", err)\n\t}\n\tdefer targetConfig.Close()\n\n\t// Read the ldconfig path from the config as this may differ per platform\n\t// On ubuntu-based systems this ends in `.real`\n\tldconfigPath := fmt.Sprintf(\"%s\", cfg.GetDefault(\"nvidia-container-cli.ldconfig\", \"/sbin/ldconfig\"))\n\t// Use the driver run root as the root:\n\tdriverLdconfigPath := config.NormalizeLDConfigPath(\"@\" + filepath.Join(opts.DriverRoot, strings.TrimPrefix(ldconfigPath, \"@/\")))\n\n\tconfigValues := map[string]interface{}{\n\t\t// Set the options in the root toml table\n\t\t\"accept-nvidia-visible-devices-envvar-when-unprivileged\": opts.acceptNVIDIAVisibleDevicesWhenUnprivileged,\n\t\t\"accept-nvidia-visible-devices-as-volume-mounts\": opts.acceptNVIDIAVisibleDevicesAsVolumeMounts,\n\t\t// Set the nvidia-container-cli options\n\t\t\"nvidia-container-cli.root\": opts.DriverRoot,\n\t\t\"nvidia-container-cli.path\": nvidiaContainerCliExecutablePath,\n\t\t\"nvidia-container-cli.ldconfig\": driverLdconfigPath,\n\t\t// Set nvidia-ctk options\n\t\t\"nvidia-ctk.path\": nvidiaCTKPath,\n\t\t// Set the nvidia-container-runtime-hook options\n\t\t\"nvidia-container-runtime-hook.path\": nvidiaContainerRuntimeHookPath,\n\t\t\"nvidia-container-runtime-hook.skip-mode-detection\": opts.ContainerRuntimeHookSkipModeDetection,\n\t}\n\n\ttoolkitRuntimeList := opts.ContainerRuntimeRuntimes\n\tif len(toolkitRuntimeList) > 0 {\n\t\tconfigValues[\"nvidia-container-runtime.runtimes\"] = toolkitRuntimeList\n\t}\n\n\tfor _, optInFeature := range opts.optInFeatures {\n\t\tconfigValues[\"features.\"+optInFeature] = true\n\t}\n\n\tfor key, value := range configValues {\n\t\tcfg.Set(key, value)\n\t}\n\n\t// Set the optional config options\n\toptionalConfigValues := map[string]interface{}{\n\t\t\"nvidia-container-runtime.debug\": opts.ContainerRuntimeDebug,\n\t\t\"nvidia-container-runtime.log-level\": opts.ContainerRuntimeLogLevel,\n\t\t\"nvidia-container-runtime.mode\": opts.ContainerRuntimeMode,\n\t\t\"nvidia-container-runtime.modes.cdi.annotation-prefixes\": opts.ContainerRuntimeModesCDIAnnotationPrefixes,\n\t\t\"nvidia-container-runtime.modes.cdi.default-kind\": opts.ContainerRuntimeModesCdiDefaultKind,\n\t\t\"nvidia-container-runtime.runtimes\": opts.ContainerRuntimeRuntimes,\n\t\t\"nvidia-container-cli.debug\": opts.ContainerCLIDebug,\n\t}\n\n\tfor key, value := range optionalConfigValues {\n\t\tif !c.IsSet(key) {\n\t\t\tt.logger.Infof(\"Skipping unset option: %v\", key)\n\t\t\tcontinue\n\t\t}\n\t\tif value == nil {\n\t\t\tt.logger.Infof(\"Skipping option with nil value: %v\", key)\n\t\t\tcontinue\n\t\t}\n\n\t\tswitch v := value.(type) {\n\t\tcase string:\n\t\t\tif v == \"\" {\n\t\t\t\tcontinue\n\t\t\t}\n\t\tcase cli.StringSlice:\n\t\t\tif len(v.Value()) == 0 {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tvalue = v.Value()\n\t\tdefault:\n\t\t\tt.logger.Warningf(\"Unexpected type for option %v=%v: %T\", key, value, v)\n\t\t}\n\n\t\tcfg.Set(key, value)\n\t}\n\n\tif _, err := cfg.WriteTo(targetConfig); err != nil {\n\t\treturn fmt.Errorf(\"error writing config: %v\", err)\n\t}\n\n\tos.Stdout.WriteString(\"Using config:\\n\")\n\tif _, err = cfg.WriteTo(os.Stdout); err != nil {\n\t\tt.logger.Warningf(\"Failed to output config to STDOUT: %v\", err)\n\t}\n\n\treturn nil\n}\n\nfunc (t *Installer) createDirectories(dir ...string) error {\n\tfor _, d := range dir {\n\t\tt.logger.Infof(\"Creating directory '%v'\", d)\n\t\terr := os.MkdirAll(d, 0755)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"error creating directory: %v\", err)\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc (t *Installer) createDeviceNodes(opts *Options) error {\n\tmodes := opts.createDeviceNodes\n\tif len(modes) == 0 {\n\t\treturn nil\n\t}\n\n\tdevices, err := nvdevices.New(\n\t\tnvdevices.WithDevRoot(opts.DevRootCtrPath),\n\t)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create library: %v\", err)\n\t}\n\n\tfor _, mode := range modes {\n\t\tt.logger.Infof(\"Creating %v device nodes at %v\", mode, opts.DevRootCtrPath)\n\t\tif mode != \"control\" {\n\t\t\tt.logger.Warningf(\"Unrecognised device mode: %v\", mode)\n\t\t\tcontinue\n\t\t}\n\t\tif err := devices.CreateNVIDIAControlDevices(); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to create control device nodes: %v\", err)\n\t\t}\n\t}\n\treturn nil\n}\n\n// generateCDISpec generates a CDI spec for use in management containers\nfunc (t *Installer) generateCDISpec(opts *Options, nvidiaCDIHookPath string) error {\n\tif !opts.CDI.Enabled {\n\t\treturn nil\n\t}\n\tt.logger.Infof(\"Generating CDI spec for management containers\")\n\tcdilib, err := nvcdi.New(\n\t\tnvcdi.WithLogger(t.logger),\n\t\tnvcdi.WithMode(nvcdi.ModeManagement),\n\t\tnvcdi.WithDriverRoot(opts.DriverRootCtrPath),\n\t\tnvcdi.WithDevRoot(opts.DevRootCtrPath),\n\t\tnvcdi.WithNVIDIACDIHookPath(nvidiaCDIHookPath),\n\t\tnvcdi.WithVendor(opts.CDI.vendor),\n\t\tnvcdi.WithClass(opts.CDI.class),\n\t)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create CDI library for management containers: %v\", err)\n\t}\n\n\tspec, err := cdilib.GetSpec()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to genereate CDI spec for management containers: %v\", err)\n\t}\n\n\ttransformer := transformroot.NewDriverTransformer(\n\t\ttransformroot.WithDriverRoot(opts.DriverRootCtrPath),\n\t\ttransformroot.WithTargetDriverRoot(opts.DriverRoot),\n\t\ttransformroot.WithDevRoot(opts.DevRootCtrPath),\n\t\ttransformroot.WithTargetDevRoot(opts.DevRoot),\n\t)\n\tif err := transformer.Transform(spec.Raw()); err != nil {\n\t\treturn fmt.Errorf(\"failed to transform driver root in CDI spec: %v\", err)\n\t}\n\n\tname, err := cdi.GenerateNameForSpec(spec.Raw())\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to generate CDI name for management containers: %v\", err)\n\t}\n\terr = spec.Save(filepath.Join(opts.CDI.outputDir, name))\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to save CDI spec for management containers: %v\", err)\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "cmd/nvidia-ctk-installer/toolkit/toolkit_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toolkit\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\t\"github.com/urfave/cli/v3\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup/symlinks\"\n)\n\nfunc TestInstall(t *testing.T) {\n\tdefer devices.SetAllForTest()()\n\tlogger, _ := testlog.NewNullLogger()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tartifactRoot := filepath.Join(moduleRoot, \"testdata\", \"installer\", \"artifacts\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\thostRoot string\n\t\tpackageType string\n\t\tcdiEnabled bool\n\t\texpectedError error\n\t\texpectedCdiSpec string\n\t}{\n\t\t{\n\t\t\thostRoot: \"rootfs-empty\",\n\t\t\tpackageType: \"deb\",\n\t\t},\n\t\t{\n\t\t\thostRoot: \"rootfs-empty\",\n\t\t\tpackageType: \"rpm\",\n\t\t},\n\t\t{\n\t\t\thostRoot: \"rootfs-empty\",\n\t\t\tpackageType: \"deb\",\n\t\t\tcdiEnabled: true,\n\t\t\texpectedError: fmt.Errorf(\"no NVIDIA device nodes found\"),\n\t\t},\n\t\t{\n\t\t\thostRoot: \"rootfs-1\",\n\t\t\tpackageType: \"deb\",\n\t\t\tcdiEnabled: true,\n\t\t\texpectedCdiSpec: `---\ncdiVersion: 0.5.0\nkind: example.com/class\ndevices:\n - name: all\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia0\n hostPath: /host/driver/root/dev/nvidia0\n - path: /dev/nvidiactl\n hostPath: /host/driver/root/dev/nvidiactl\n - path: /dev/nvidia-caps-imex-channels/channel0\n hostPath: /host/driver/root/dev/nvidia-caps-imex-channels/channel0\n - path: /dev/nvidia-caps-imex-channels/channel1\n hostPath: /host/driver/root/dev/nvidia-caps-imex-channels/channel1\n - path: /dev/nvidia-caps-imex-channels/channel2047\n hostPath: /host/driver/root/dev/nvidia-caps-imex-channels/channel2047\n - path: /dev/nvidia-caps/nvidia-cap1\n hostPath: /host/driver/root/dev/nvidia-caps/nvidia-cap1\ncontainerEdits:\n env:\n - NVIDIA_CTK_LIBCUDA_DIR=/lib/x86_64-linux-gnu\n - NVIDIA_VISIBLE_DEVICES=void\n hooks:\n - hookName: createContainer\n path: {{ .toolkitRoot }}/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - create-symlinks\n - --link\n - libcuda.so.1::/lib/x86_64-linux-gnu/libcuda.so\n env:\n - NVIDIA_CTK_DEBUG=false\n - hookName: createContainer\n path: {{ .toolkitRoot }}/nvidia-cdi-hook\n args:\n - nvidia-cdi-hook\n - update-ldcache\n - --folder\n - /lib/x86_64-linux-gnu\n - --folder\n - /lib/x86_64-linux-gnu/vdpau\n env:\n - NVIDIA_CTK_DEBUG=false\n mounts:\n - hostPath: /host/driver/root/lib/x86_64-linux-gnu/libcuda.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/libcuda.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n - hostPath: /host/driver/root/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n containerPath: /lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\n options:\n - ro\n - nosuid\n - nodev\n - rbind\n - rprivate\n`,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\t// hostRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\", tc.hostRoot)\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttestRoot := t.TempDir()\n\t\t\ttoolkitRoot := filepath.Join(testRoot, \"toolkit-test\")\n\t\t\tcdiOutputDir := filepath.Join(moduleRoot, \"toolkit-test\", \"/var/cdi\")\n\t\t\tsourceRoot := filepath.Join(artifactRoot, tc.packageType)\n\t\t\toptions := Options{\n\t\t\t\tDriverRoot: \"/host/driver/root\",\n\t\t\t\tDriverRootCtrPath: filepath.Join(moduleRoot, \"testdata\", \"lookup\", tc.hostRoot),\n\t\t\t\tCDI: cdiOptions{\n\t\t\t\t\tEnabled: tc.cdiEnabled,\n\t\t\t\t\toutputDir: cdiOutputDir,\n\t\t\t\t\tkind: \"example.com/class\",\n\t\t\t\t},\n\t\t\t}\n\n\t\t\tti := NewInstaller(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithToolkitRoot(toolkitRoot),\n\t\t\t\tWithSourceRoot(sourceRoot),\n\t\t\t)\n\t\t\trequire.NoError(t, ti.ValidateOptions(&options))\n\n\t\t\terr := ti.Install(&cli.Command{}, &options, \"containerd\")\n\t\t\tif tc.expectedError == nil {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t} else {\n\t\t\t\trequire.Contains(t, err.Error(), tc.expectedError.Error())\n\t\t\t}\n\n\t\t\trequire.DirExists(t, toolkitRoot)\n\t\t\trequireSymlink(t, toolkitRoot, \"libnvidia-container.so.1\", \"libnvidia-container.so.99.88.77\")\n\t\t\trequireSymlink(t, toolkitRoot, \"libnvidia-container-go.so.1\", \"libnvidia-container-go.so.99.88.77\")\n\n\t\t\trequireWrappedExecutable(t, toolkitRoot, \"nvidia-cdi-hook\")\n\t\t\trequireWrappedExecutable(t, toolkitRoot, \"nvidia-container-cli\")\n\t\t\trequireWrappedExecutable(t, toolkitRoot, \"nvidia-container-runtime\")\n\t\t\trequireWrappedExecutable(t, toolkitRoot, \"nvidia-container-runtime-hook\")\n\t\t\trequireWrappedExecutable(t, toolkitRoot, \"nvidia-container-runtime.cdi\")\n\t\t\trequireWrappedExecutable(t, toolkitRoot, \"nvidia-container-runtime.legacy\")\n\t\t\trequireWrappedExecutable(t, toolkitRoot, \"nvidia-ctk\")\n\n\t\t\trequireSymlink(t, toolkitRoot, \"nvidia-container-toolkit\", \"nvidia-container-runtime-hook\")\n\n\t\t\t// TODO: Add checks for wrapper contents\n\t\t\t// grep -q -E \"nvidia driver modules are not yet loaded, invoking runc directly\" \"${shared_dir}/usr/local/nvidia/toolkit/nvidia-container-runtime\"\n\t\t\t// grep -q -E \"exec runc \\\".@\\\"\" \"${shared_dir}/usr/local/nvidia/toolkit/nvidia-container-runtime\"\n\n\t\t\trequire.DirExists(t, filepath.Join(toolkitRoot, \".config\"))\n\t\t\trequire.DirExists(t, filepath.Join(toolkitRoot, \".config\", \"nvidia-container-runtime\"))\n\t\t\trequire.FileExists(t, filepath.Join(toolkitRoot, \".config\", \"nvidia-container-runtime\", \"config.toml\"))\n\n\t\t\tcfgToml, err := config.New(config.WithConfigFile(filepath.Join(toolkitRoot, \".config\", \"nvidia-container-runtime\", \"config.toml\")))\n\t\t\trequire.NoError(t, err)\n\n\t\t\tcfg, err := cfgToml.Config()\n\t\t\trequire.NoError(t, err)\n\n\t\t\t// Ensure that the config file has the required contents.\n\t\t\t// TODO: Add checks for additional config options.\n\t\t\trequire.Equal(t, \"/host/driver/root\", cfg.NVIDIAContainerCLIConfig.Root)\n\t\t\trequire.Equal(t, \"@/host/driver/root/sbin/ldconfig\", string(cfg.NVIDIAContainerCLIConfig.Ldconfig))\n\t\t\trequire.EqualValues(t, filepath.Join(toolkitRoot, \"nvidia-container-cli\"), cfg.NVIDIAContainerCLIConfig.Path)\n\t\t\trequire.EqualValues(t, filepath.Join(toolkitRoot, \"nvidia-ctk\"), cfg.NVIDIACTKConfig.Path)\n\n\t\t\tif len(tc.expectedCdiSpec) > 0 {\n\t\t\t\tcdiSpecFile := filepath.Join(cdiOutputDir, \"example.com-class.yaml\")\n\t\t\t\trequire.FileExists(t, cdiSpecFile)\n\t\t\t\tinfo, err := os.Stat(cdiSpecFile)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.NotZero(t, info.Mode()&0004)\n\t\t\t\tcontents, err := os.ReadFile(cdiSpecFile)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Equal(t, strings.ReplaceAll(tc.expectedCdiSpec, \"{{ .toolkitRoot }}\", toolkitRoot), string(contents))\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc requireWrappedExecutable(t *testing.T, toolkitRoot string, expectedExecutable string) {\n\trequireExecutable(t, toolkitRoot, expectedExecutable)\n\trequireExecutable(t, toolkitRoot, expectedExecutable+\".real\")\n}\n\nfunc requireExecutable(t *testing.T, toolkitRoot string, expectedExecutable string) {\n\texecutable := filepath.Join(toolkitRoot, expectedExecutable)\n\trequire.FileExists(t, executable)\n\tinfo, err := os.Lstat(executable)\n\trequire.NoError(t, err)\n\trequire.Zero(t, info.Mode()&os.ModeSymlink)\n\trequire.NotZero(t, info.Mode()&0111)\n}\n\nfunc requireSymlink(t *testing.T, toolkitRoot string, expectedLink string, expectedTarget string) {\n\tlink := filepath.Join(toolkitRoot, expectedLink)\n\trequire.FileExists(t, link)\n\ttarget, err := symlinks.Resolve(link)\n\trequire.NoError(t, err)\n\trequire.Equal(t, expectedTarget, target)\n}\n"
},
{
"path": "deployments/container/Dockerfile",
"content": "# SPDX-FileCopyrightText: Copyright (c) 2019 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nARG GOLANG_VERSION=x.x.x\nARG VERSION=\"N/A\"\n\nFROM nvcr.io/nvidia/cuda:12.9.1-base-ubi9 AS build\n\nRUN rm -f /etc/yum.repos.d/cuda.repo && rm -f /etc/ld.so.conf.d/nvidia.conf\n\nRUN dnf install -y \\\n wget make git gcc \\\n && \\\n rm -rf /var/cache/yum/*\n\nARG GOLANG_VERSION=x.x.x\nRUN set -eux; \\\n \\\n arch=\"$(uname -m)\"; \\\n case \"${arch##*-}\" in \\\n x86_64 | amd64) ARCH='amd64' ;; \\\n ppc64el | ppc64le) ARCH='ppc64le' ;; \\\n aarch64 | arm64) ARCH='arm64' ;; \\\n *) echo \"unsupported architecture\" ; exit 1 ;; \\\n esac; \\\n wget -nv -O - https://go.dev/dl/go${GOLANG_VERSION}.linux-${ARCH}.tar.gz \\\n | tar -C /usr/local -xz\n\n\nENV GOPATH=/go\nENV PATH=$GOPATH/bin:/usr/local/go/bin:$PATH\n\nARG GOPROXY=\"https://proxy.golang.org,direct\"\nENV GOPROXY=$GOPROXY\n\nWORKDIR /build\nCOPY . .\n\nRUN mkdir -p /artifacts/bin\nARG VERSION=\"N/A\"\nARG GIT_COMMIT=\"unknown\"\nRUN make PREFIX=/artifacts/bin cmd-nvidia-ctk-installer\n\n# The packaging stage collects the deb and rpm packages built for\n# supported architectures.\nFROM nvcr.io/nvidia/distroless/go:v4.0.2-dev AS packaging\n\nUSER 0:0\nSHELL [\"/busybox/sh\", \"-c\"]\nRUN ln -s /busybox/sh /bin/sh\n\nARG ARTIFACTS_ROOT\nCOPY ${ARTIFACTS_ROOT}/ubuntu18.04 /artifacts/packages/ubuntu18.04\nCOPY ${ARTIFACTS_ROOT}/centos7 /artifacts/packages/centos7\n\n# build-args are added to the manifest.txt file below.\nARG PACKAGE_VERSION\nARG GIT_BRANCH\nARG GIT_COMMIT\nARG GIT_COMMIT_SHORT\nARG SOURCE_DATE_EPOCH\nARG VERSION\n\n# Create a manifest.txt file with the absolute paths of all deb and rpm packages in the container\nRUN echo \"#IMAGE_EPOCH=$(date '+%s')\" > /artifacts/manifest.txt && \\\n env | sed 's/^/#/g' >> /artifacts/manifest.txt && \\\n find /artifacts/packages -iname '*.deb' -o -iname '*.rpm' >> /artifacts/manifest.txt\n\nLABEL name=\"NVIDIA Container Toolkit Packages\"\nLABEL vendor=\"NVIDIA\"\nLABEL version=\"${VERSION}\"\nLABEL release=\"N/A\"\nLABEL summary=\"deb and rpm packages for the NVIDIA Container Toolkit\"\nLABEL description=\"See summary\"\n\nCOPY LICENSE /licenses/\n\n# The debpackages stage is used to extract the contents of deb packages.\nFROM nvcr.io/nvidia/cuda:12.9.1-base-ubuntu20.04 AS debpackages\n\nRUN rm -f /etc/apt/sources.list.d/cuda.list\n\nARG TARGETARCH\nARG PACKAGE_DIST_DEB=ubuntu18.04\n\nCOPY --from=packaging /artifacts/packages/${PACKAGE_DIST_DEB} /deb-packages\n\nRUN mkdir -p /artifacts/deb\nRUN set -eux; \\\n \\\n case \"${TARGETARCH}\" in \\\n x86_64 | amd64) ARCH='amd64' ;; \\\n ppc64el | ppc64le) ARCH='ppc64le' ;; \\\n aarch64 | arm64) ARCH='arm64' ;; \\\n *) echo \"unsupported architecture\" ; exit 1 ;; \\\n esac; \\\n for p in $(ls /deb-packages/${ARCH}/*.deb); do dpkg-deb -xv $p /artifacts/deb/; done\n\n# The rpmpackages stage is used to extract the contents of the rpm packages.\nFROM nvcr.io/nvidia/cuda:12.9.1-base-ubi9 AS rpmpackages\n\nRUN rm -f /etc/yum.repos.d/cuda.repo && rm -f /etc/ld.so.conf.d/nvidia.conf\n\nRUN dnf install -y cpio\n\nARG TARGETARCH\nARG PACKAGE_DIST_RPM=centos7\n\nCOPY --from=packaging /artifacts/packages/${PACKAGE_DIST_RPM} /rpm-packages\n\nRUN mkdir -p /artifacts/rpm\nRUN set -eux; \\\n \\\n case \"${TARGETARCH}\" in \\\n x86_64 | amd64) ARCH='x86_64' ;; \\\n ppc64el | ppc64le) ARCH='ppc64le' ;; \\\n aarch64 | arm64) ARCH='aarch64' ;; \\\n *) echo \"unsupported architecture\" ; exit 1 ;; \\\n esac; \\\n for p in $(ls /rpm-packages/${ARCH}/*.rpm); do rpm2cpio $p | cpio -idmv -D /artifacts/rpm; done\n\n# The artifacts image serves as an intermediate stage to collect the artifacts\n# From the previous stages:\n# - The extracted deb packages\n# - The extracted rpm packages\n# - The nvidia-ctk-installer binary\nFROM scratch AS artifacts\n\nCOPY --from=rpmpackages /artifacts/rpm /artifacts/rpm\nCOPY --from=debpackages /artifacts/deb /artifacts/deb\nCOPY --from=build /artifacts/bin /artifacts/build\n\n# The application stage contains the application used as a GPU Operator\n# operand.\nFROM nvcr.io/nvidia/distroless/go:v4.0.2-dev AS application\n\nUSER 0:0\nSHELL [\"/busybox/sh\", \"-c\"]\nRUN ln -s /busybox/sh /bin/sh\n\nENV NVIDIA_DISABLE_REQUIRE=\"true\"\nENV NVIDIA_VISIBLE_DEVICES=void\nENV NVIDIA_DRIVER_CAPABILITIES=utility\n\nCOPY --from=artifacts /artifacts/rpm /artifacts/rpm\nCOPY --from=artifacts /artifacts/deb /artifacts/deb\nCOPY --from=artifacts /artifacts/build /work\n\nWORKDIR /work\nENV PATH=/work:$PATH\n\nARG VERSION\nLABEL io.k8s.display-name=\"NVIDIA Container Runtime Config\"\nLABEL name=\"NVIDIA Container Runtime Config\"\nLABEL vendor=\"NVIDIA\"\nLABEL version=\"${VERSION}\"\nLABEL release=\"N/A\"\nLABEL summary=\"Automatically Configure your Container Runtime for GPU support.\"\nLABEL description=\"See summary\"\n\nCOPY LICENSE /licenses/\n\nENTRYPOINT [\"/work/nvidia-ctk-installer\"]\n\n# The GPU Operator exec's nvidia-toolkit in its entrypoint.\n# We create a symlink here to ensure compatibility with older\n# GPU Operator versions.\nRUN ln -s /work/nvidia-ctk-installer /work/nvidia-toolkit\n"
},
{
"path": "deployments/container/Dockerfile.rpmrebuild",
"content": "# SPDX-FileCopyrightText: Copyright (c) NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nFROM nvcr.io/nvidia/cuda:13.0.1-base-ubi9\n\nRUN dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm \\\n && \\\n dnf install -y rpmrebuild\n\nARG arch\nENV arch=${arch}\nCMD for src_package in $(ls *.rpm); do \\\n rpmrebuild -pn --directory=/updated --define \"_build_id_links none\" ${src_package}; \\\n done; \\\n cp -f /updated/${arch}/*.rpm /dist/\n"
},
{
"path": "deployments/container/Makefile",
"content": "# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nBUILD_MULTI_ARCH_IMAGES ?= false\nDOCKER ?= docker\nREGCTL ?= regctl\n\nBUILDX =\nifeq ($(BUILD_MULTI_ARCH_IMAGES),true)\nBUILDX = buildx\nendif\n\nMKDIR ?= mkdir\nDIST_DIR ?= $(CURDIR)/dist\n\n##### Global variables #####\ninclude $(CURDIR)/versions.mk\n\nGOPROXY ?= https://proxy.golang.org,direct\n\nIMAGE_VERSION := $(VERSION)\n\nIMAGE_TAG ?= $(VERSION)\nIMAGE = $(IMAGE_NAME):$(IMAGE_TAG)\n\nOUT_IMAGE_NAME ?= $(IMAGE_NAME)\nOUT_IMAGE_VERSION ?= $(IMAGE_VERSION)\nOUT_IMAGE_TAG = $(OUT_IMAGE_VERSION)\nOUT_IMAGE = $(OUT_IMAGE_NAME):$(OUT_IMAGE_TAG)\n\n##### Public rules #####\nDEFAULT_PUSH_TARGET := application\nDISTRIBUTIONS := $(DEFAULT_PUSH_TARGET)\n\nMETA_TARGETS := packaging\n\nIMAGE_TARGETS := $(patsubst %,image-%,$(DISTRIBUTIONS) $(META_TARGETS))\nBUILD_TARGETS := $(patsubst %,build-%,$(DISTRIBUTIONS) $(META_TARGETS))\nPUSH_TARGETS := $(patsubst %,push-%,$(DISTRIBUTIONS) $(META_TARGETS))\nTEST_TARGETS := $(patsubst %,test-%,$(DISTRIBUTIONS))\n\n.PHONY: $(DISTRIBUTIONS) $(PUSH_TARGETS) $(BUILD_TARGETS) $(TEST_TARGETS)\n\nifneq ($(BUILD_MULTI_ARCH_IMAGES),true)\ninclude $(CURDIR)/deployments/container/native-only.mk\nelse\ninclude $(CURDIR)/deployments/container/multi-arch.mk\nendif\n\n# Define the push targets\n$(PUSH_TARGETS): push-%:\n\t$(CURDIR)/scripts/publish-image.sh $(IMAGE) $(OUT_IMAGE)\n\nDOCKERFILE = $(CURDIR)/deployments/container/Dockerfile\n\n# For packaging targets we set the output image tag to include the -packaging suffix.\n%-packaging: INTERMEDIATE_TARGET := --target=packaging\n%-packaging: IMAGE_TAG = $(IMAGE_VERSION)-packaging\n%-packaging: OUT_IMAGE_TAG = $(IMAGE_VERSION)-packaging\n\nARTIFACTS_ROOT ?= $(shell realpath --relative-to=$(CURDIR) $(DIST_DIR))\n\n# Use a generic build target to build the relevant images\n$(IMAGE_TARGETS): image-%: $(ARTIFACTS_ROOT)\n\tDOCKER_BUILDKIT=1 \\\n\t\t$(DOCKER) $(BUILDX) build --pull \\\n\t\t--provenance=false --sbom=false \\\n\t\t$(DOCKER_BUILD_OPTIONS) \\\n\t\t$(DOCKER_BUILD_PLATFORM_OPTIONS) \\\n\t\t$(INTERMEDIATE_TARGET) \\\n\t\t--tag $(IMAGE) \\\n\t\t--build-arg ARTIFACTS_ROOT=\"$(ARTIFACTS_ROOT)\" \\\n\t\t--build-arg GOLANG_VERSION=\"$(GOLANG_VERSION)\" \\\n\t\t--build-arg PACKAGE_DIST_DEB=\"$(PACKAGE_DIST_DEB)\" \\\n\t\t--build-arg PACKAGE_DIST_RPM=\"$(PACKAGE_DIST_RPM)\" \\\n\t\t--build-arg PACKAGE_VERSION=\"$(PACKAGE_VERSION)\" \\\n\t\t--build-arg VERSION=\"$(VERSION)\" \\\n\t\t--build-arg GIT_COMMIT=\"$(GIT_COMMIT)\" \\\n\t\t--build-arg GIT_COMMIT_SHORT=\"$(GIT_COMMIT_SHORT)\" \\\n\t\t--build-arg GIT_BRANCH=\"$(GIT_BRANCH)\" \\\n\t\t--build-arg SOURCE_DATE_EPOCH=\"$(SOURCE_DATE_EPOCH)\" \\\n\t\t--build-arg GOPROXY=\"$(GOPROXY)\" \\\n\t\t-f $(DOCKERFILE) \\\n\t\t$(CURDIR)\n\n\nPACKAGE_DIST_DEB = ubuntu18.04\n# TODO: This needs to be set to centos8 for ppc64le builds\nPACKAGE_DIST_RPM = centos7\n\n# Handle the default build target.\n.PHONY: build push\nbuild: build-$(DEFAULT_PUSH_TARGET)\npush: push-$(DEFAULT_PUSH_TARGET)\n\n# Test targets\nTEST_CASES ?= docker crio containerd\n$(TEST_TARGETS): test-%:\n\tTEST_CASES=\"$(TEST_CASES)\" bash -x $(CURDIR)/test/container/main.sh run \\\n\t\t$(CURDIR)/shared-$(*) \\\n\t\t$(IMAGE) \\\n\t\t\t--no-cleanup-on-error\n\n.PHONY: test-packaging\ntest-packaging: DIST = packaging\ntest-packaging:\n\t@echo \"Testing package image contents\"\n\t@$(DOCKER) run --rm $(IMAGE) test -d \"/artifacts/packages/centos7/aarch64\" || echo \"Missing centos7/aarch64\"\n\t@$(DOCKER) run --rm $(IMAGE) test -d \"/artifacts/packages/centos7/x86_64\" || echo \"Missing centos7/x86_64\"\n\t@$(DOCKER) run --rm $(IMAGE) test -d \"/artifacts/packages/ubuntu18.04/amd64\" || echo \"Missing ubuntu18.04/amd64\"\n\t@$(DOCKER) run --rm $(IMAGE) test -d \"/artifacts/packages/ubuntu18.04/arm64\" || echo \"Missing ubuntu18.04/arm64\"\n"
},
{
"path": "deployments/container/README.md",
"content": "# NVIDIA Container Toolkit Container\n\nThis folder contains make and docker files for building the NVIDIA Container Toolkit Container.\n\n"
},
{
"path": "deployments/container/multi-arch.mk",
"content": "# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nPUSH_ON_BUILD ?= false\nDOCKER_BUILD_OPTIONS = --output=type=image,push=$(PUSH_ON_BUILD)\nDOCKER_BUILD_PLATFORM_OPTIONS = --platform=linux/amd64,linux/arm64\n\n$(BUILD_TARGETS): build-%: image-%\n\n# We only generate a single image for packaging targets\nbuild-packaging: DOCKER_BUILD_PLATFORM_OPTIONS = --platform=linux/amd64\n"
},
{
"path": "deployments/container/native-only.mk",
"content": "# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nPUSH_ON_BUILD ?= false\nARCH ?= $(shell uname -m)\nDOCKER_BUILD_PLATFORM_OPTIONS = --platform=linux/$(ARCH)\n\nifeq ($(PUSH_ON_BUILD),true)\nDOCKER_BUILD_OPTIONS = --output=type=image,push=$(PUSH_ON_BUILD)\n$(BUILD_TARGETS): build-%: image-%\n\t$(DOCKER) push \"$(IMAGE)\"\nelse\n$(BUILD_TARGETS): build-%: image-%\nendif\n"
},
{
"path": "deployments/devel/Dockerfile",
"content": "# Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This Dockerfile is also used to define the golang version used in this project\n# This allows dependabot to manage this version in addition to other images.\nFROM golang:1.26.0\n\nWORKDIR /work\nCOPY * .\n\nRUN make install-tools\n\n# We need to set the /work directory as a safe directory.\n# This allows git commands to run in the container.\nRUN git config --file=/.gitconfig --add safe.directory /work\n\n"
},
{
"path": "deployments/devel/Makefile",
"content": "# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\ndownload:\n\t@echo Download go.mod dependencies\n\t@go mod download\n\ninstall-tools: download\n\t@echo Installing tools from tools.go\n\t@cat tools.go | grep _ | awk -F'\"' '{print $$2}' | xargs -tI % go install %\n\n\nDOCKER ?= docker\n-include $(CURDIR)/versions.mk\n\nDOCKERFILE_DEVEL = deployments/devel/Dockerfile\nDOCKERFILE_CONTEXT = deployments/devel\n\n.PHONY: .build-image\n.build-image:\n\t$(DOCKER) build \\\n\t\t--progress=plain \\\n\t\t--tag $(BUILDIMAGE) \\\n\t\t-f $(DOCKERFILE_DEVEL) \\\n\t\t$(DOCKERFILE_CONTEXT)\n\nmodules:\n\tgo mod tidy\n\tgo mod verify\n\ncheck-modules: modules\n\tgit diff --quiet HEAD -- go.mod go.sum\n"
},
{
"path": "deployments/devel/go.mod",
"content": "module github.com/NVIDIA/k8s-device-plugin/deployments/devel\n\ngo 1.25\n\nrequire github.com/matryer/moq v0.6.0\n\nrequire (\n\tgithub.com/google/go-cmp v0.7.0 // indirect\n\tgolang.org/x/mod v0.24.0 // indirect\n\tgolang.org/x/sync v0.12.0 // indirect\n\tgolang.org/x/tools v0.31.0 // indirect\n)\n"
},
{
"path": "deployments/devel/go.sum",
"content": "github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/matryer/moq v0.6.0 h1:FCccG09c3o4cg3gnrZ+7ty5Pa/sjmN24BMHp/0pwhjQ=\ngithub.com/matryer/moq v0.6.0/go.mod h1:iEVhY/XBwFG/nbRyEf0oV+SqnTHZJ5wectzx7yT+y98=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngolang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=\ngolang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=\ngolang.org/x/sync v0.12.0 h1:MHc5BpPuC30uJk597Ri8TV3CNZcTLu6B6z4lJy+g6Jw=\ngolang.org/x/sync v0.12.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=\ngolang.org/x/tools v0.31.0 h1:0EedkvKDbh+qistFTd0Bcwe/YLh4vHwWEkiI0toFIBU=\ngolang.org/x/tools v0.31.0/go.mod h1:naFTU+Cev749tSJRXJlna0T3WxKvb1kWEx15xA4SdmQ=\n"
},
{
"path": "deployments/devel/tools.go",
"content": "//go:build tools\n// +build tools\n\n/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage main\n\n// Define the tooling required to build the device plugin.\nimport (\n\t_ \"github.com/matryer/moq\"\n)\n"
},
{
"path": "deployments/systemd/nvidia-cdi-refresh.env",
"content": "# This file can be used to override the configuration of the\n# nvidia-ctk cdi generate\n# command invoked by the nvidia-cdi-refresh.service.\n#\n# This is done by specifying the name and value of the environment variables in\n# this file as follows:\n#\n# ENVVAR=value\n#\n# For a list of envvars that can be set set the output of:\n#\n# nvidia-ctk --help\n#\n# and\n#\n# nvidia-ctk cdi generate --help\n#\n# For example, to change the for the generated CDI specification update and\n# uncomment the following line:\n# NVIDIA_CTK_CDI_OUTPUT_FILE_PATH=/var/run/cdi/nvidia.yaml\n"
},
{
"path": "deployments/systemd/nvidia-cdi-refresh.path",
"content": "# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n[Unit]\nDescription=Trigger CDI refresh on NVIDIA driver or toolkit install / upgrade events\n\n[Path]\nPathChanged=/lib/modules/%v/modules.dep\nPathChanged=/lib/modules/%v/modules.dep.bin\nPathChanged=/usr/bin/nvidia-ctk\n\n[Install]\nWantedBy=multi-user.target\n"
},
{
"path": "deployments/systemd/nvidia-cdi-refresh.service",
"content": "# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n[Unit]\nDescription=Refresh NVIDIA CDI specification file\nConditionPathExists=|/usr/bin/nvidia-smi\nConditionPathExists=|/usr/sbin/nvidia-smi\nConditionPathExists=/usr/bin/nvidia-ctk\nAfter=multi-user.target\n\n[Service]\nType=oneshot\n# Values from Environment will be replaced if defined in EnvironmentFile\nEnvironment=NVIDIA_CTK_CDI_OUTPUT_FILE_PATH=/var/run/cdi/nvidia.yaml\nEnvironmentFile=-/etc/nvidia-container-toolkit/nvidia-cdi-refresh.env\nExecCondition=/usr/bin/grep -qE '/(nvidia|nvidia-current)\\\\.ko' /lib/modules/%v/modules.dep\nExecStart=/usr/bin/nvidia-ctk cdi generate\nCapabilityBoundingSet=CAP_SYS_MODULE CAP_SYS_ADMIN CAP_MKNOD\n\n[Install]\nWantedBy=multi-user.target\n"
},
{
"path": "docker/Dockerfile.debian",
"content": "ARG BASEIMAGE\nFROM ${BASEIMAGE}\n\nENV DEBIAN_FRONTEND=noninteractive\nRUN apt-get update && apt-get install -y --no-install-recommends \\\n wget \\\n ca-certificates \\\n git \\\n build-essential \\\n dh-make \\\n fakeroot \\\n devscripts \\\n lsb-release && \\\n rm -rf /var/lib/apt/lists/*\n\nRUN echo \"deb http://ftp.debian.org/debian $(lsb_release -cs)-backports main\" > /etc/apt/sources.list.d/backports.list\n\nARG GOLANG_VERSION=0.0.0\nRUN set -eux; \\\n \\\n arch=\"$(uname -m)\"; \\\n case \"${arch##*-}\" in \\\n x86_64 | amd64) ARCH='amd64' ;; \\\n ppc64el | ppc64le) ARCH='ppc64le' ;; \\\n aarch64 | arm64) ARCH='arm64' ;; \\\n *) echo \"unsupported architecture\" ; exit 1 ;; \\\n esac; \\\n wget -nv -O - https://go.dev/dl/go${GOLANG_VERSION}.linux-${ARCH}.tar.gz \\\n | tar -C /usr/local -xz\n\nENV GOPATH /go\nENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH\n\n# packaging\nARG PKG_NAME\nARG PKG_VERS\nARG PKG_REV\n\nENV DEBFULLNAME \"NVIDIA CORPORATION\"\nENV DEBEMAIL \"cudatools@nvidia.com\"\nENV REVISION \"$PKG_VERS-$PKG_REV\"\nENV SECTION \"\"\n\n# output directory\nENV DIST_DIR=/tmp/nvidia-container-toolkit-$PKG_VERS\nRUN mkdir -p $DIST_DIR /dist\n\n# nvidia-container-toolkit\nWORKDIR $GOPATH/src/nvidia-container-toolkit\nCOPY . .\n\nARG GIT_COMMIT\nENV GIT_COMMIT ${GIT_COMMIT}\nRUN make PREFIX=${DIST_DIR} cmds\n\nWORKDIR $DIST_DIR\nCOPY packaging/debian ./debian\nCOPY deployments/systemd/ .\n\nRUN dch --create --package=\"${PKG_NAME}\" \\\n --newversion \"${REVISION}\" \\\n \"See https://github.com/NVIDIA/nvidia-container-toolkit/blob/${GIT_COMMIT}/CHANGELOG.md for the changelog\" && \\\n dch --append \"Bump libnvidia-container dependency to ${LIBNVIDIA_CONTAINER1_VERSION}\" && \\\n dch -r \"\" && \\\n if [ \"$REVISION\" != \"$(dpkg-parsechangelog --show-field=Version)\" ]; then exit 1; fi\n\nCMD export DISTRIB=\"$(lsb_release -cs)\" && \\\n debuild -eDISTRIB -eSECTION -eVERSION=\"${REVISION}\" \\\n --dpkg-buildpackage-hook='sh debian/prepare' -i -us -uc -b && \\\n mv /tmp/*.deb /dist\n"
},
{
"path": "docker/Dockerfile.devel",
"content": "# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\nARG GOLANG_VERSION=x.x.x\nARG GOLANGCI_LINT_VERSION=v1.54.1\nFROM golang:${GOLANG_VERSION}\n\nRUN go install golang.org/x/lint/golint@6edffad5e6160f5949cdefc81710b2706fbcd4f6\nRUN go install github.com/matryer/moq@latest\nRUN go install github.com/gordonklaus/ineffassign@d2c82e48359b033cde9cf1307f6d5550b8d61321\nRUN go install github.com/client9/misspell/cmd/misspell@latest\nRUN go install github.com/google/go-licenses@latest\nRUN curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}\n\n# We need to set the /work directory as a safe directory.\n# This allows git commands to run in the container.\nRUN git config --file=/.gitconfig --add safe.directory /work\n"
},
{
"path": "docker/Dockerfile.opensuse-leap",
"content": "ARG BASEIMAGE\nFROM ${BASEIMAGE}\n\nRUN zypper install -y \\\n ca-certificates \\\n wget \\\n git \\\n rpm-build && \\\n rm -rf /var/cache/zypp/*\n\nARG GOLANG_VERSION=0.0.0\nRUN set -eux; \\\n \\\n arch=\"$(uname -m)\"; \\\n case \"${arch##*-}\" in \\\n x86_64 | amd64) ARCH='amd64' ;; \\\n ppc64el | ppc64le) ARCH='ppc64le' ;; \\\n aarch64 | arm64) ARCH='arm64' ;; \\\n *) echo \"unsupported architecture\"; exit 1 ;; \\\n esac; \\\n wget -nv -O - https://go.dev/dl/go${GOLANG_VERSION}.linux-${ARCH}.tar.gz \\\n | tar -C /usr/local -xz\n\nENV GOPATH /go\nENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH\n\n# packaging\nARG PKG_NAME\nARG PKG_VERS\nARG PKG_REV\nENV PKG_NAME ${PKG_NAME}\nENV PKG_VERS ${PKG_VERS}\nENV PKG_REV ${PKG_REV}\n\n# output directory\nENV DIST_DIR=/tmp/nvidia-container-toolkit-$PKG_VERS/SOURCES\nRUN mkdir -p $DIST_DIR /dist\n\n# nvidia-container-toolkit\nWORKDIR $GOPATH/src/nvidia-container-toolkit\nCOPY . .\n\nARG GIT_COMMIT\nENV GIT_COMMIT ${GIT_COMMIT}\nRUN make PREFIX=${DIST_DIR} cmds\n\nWORKDIR $DIST_DIR/..\nCOPY packaging/rpm .\nCOPY deployments/systemd/ .\n\nCMD arch=$(uname -m) && \\\n rpmbuild --clean --target=$arch -bb \\\n -D \"_topdir $PWD\" \\\n -D \"release_date $(date +'%a %b %d %Y')\" \\\n -D \"git_commit ${GIT_COMMIT}\" \\\n -D \"version ${PKG_VERS}\" \\\n -D \"release ${PKG_REV}\" \\\n SPECS/nvidia-container-toolkit.spec && \\\n mv RPMS/$arch/*.rpm /dist\n"
},
{
"path": "docker/Dockerfile.rpm-yum",
"content": "# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This is the dockerfile for building packages on yum-based RPM systems.\n\nARG BASEIMAGE\nFROM ${BASEIMAGE}\n\n# centos:stream8 is EOL.\n# We switch to the vault repositories for this base image.\nARG BASEIMAGE\nRUN sed -i -e \"s|mirrorlist=|#mirrorlist=|g\" \\\n -e \"s|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g\" \\\n /etc/yum.repos.d/CentOS-*\n\nRUN yum install -y \\\n ca-certificates \\\n gcc \\\n wget \\\n git \\\n make \\\n rpm-build && \\\n rm -rf /var/cache/yum/*\n\nARG GOLANG_VERSION=0.0.0\nRUN set -eux; \\\n \\\n arch=\"$(uname -m)\"; \\\n case \"${arch##*-}\" in \\\n x86_64 | amd64) ARCH='amd64' ;; \\\n ppc64el | ppc64le) ARCH='ppc64le' ;; \\\n aarch64 | arm64) ARCH='arm64' ;; \\\n *) echo \"unsupported architecture\"; exit 1 ;; \\\n esac; \\\n wget -nv -O - https://go.dev/dl/go${GOLANG_VERSION}.linux-${ARCH}.tar.gz \\\n | tar -C /usr/local -xz\n\nENV GOPATH /go\nENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH\n\n# packaging\nARG PKG_NAME\nARG PKG_VERS\nARG PKG_REV\nENV PKG_NAME ${PKG_NAME}\nENV PKG_VERS ${PKG_VERS}\nENV PKG_REV ${PKG_REV}\n\n# output directory\nENV DIST_DIR=/tmp/nvidia-container-toolkit-$PKG_VERS/SOURCES\nRUN mkdir -p $DIST_DIR /dist\n\n# nvidia-container-toolkit\nWORKDIR $GOPATH/src/nvidia-container-toolkit\nCOPY . .\n\nARG GIT_COMMIT\nENV GIT_COMMIT ${GIT_COMMIT}\nRUN make PREFIX=${DIST_DIR} cmds\n\nWORKDIR $DIST_DIR/..\nCOPY packaging/rpm .\nCOPY deployments/systemd/ ${DIST_DIR}/\n\nCMD arch=$(uname -m) && \\\n rpmbuild --clean --target=$arch -bb \\\n -D \"_topdir $PWD\" \\\n -D \"release_date $(date +'%a %b %d %Y')\" \\\n -D \"git_commit ${GIT_COMMIT}\" \\\n -D \"version ${PKG_VERS}\" \\\n -D \"release ${PKG_REV}\" \\\n SPECS/nvidia-container-toolkit.spec && \\\n mv RPMS/$arch/*.rpm /dist\n"
},
{
"path": "docker/Dockerfile.ubuntu",
"content": "ARG BASEIMAGE\nFROM ${BASEIMAGE}\n\nENV DEBIAN_FRONTEND=noninteractive\nRUN apt-get update && apt-get install -y --no-install-recommends \\\n wget \\\n ca-certificates \\\n git \\\n build-essential \\\n dh-make \\\n fakeroot \\\n devscripts \\\n lsb-release && \\\n rm -rf /var/lib/apt/lists/*\n\nARG GOLANG_VERSION=0.0.0\nRUN set -eux; \\\n \\\n arch=\"$(uname -m)\"; \\\n case \"${arch##*-}\" in \\\n x86_64 | amd64) ARCH='amd64' ;; \\\n ppc64el | ppc64le) ARCH='ppc64le' ;; \\\n aarch64 | arm64) ARCH='arm64' ;; \\\n *) echo \"unsupported architecture\" ; exit 1 ;; \\\n esac; \\\n wget -nv -O - https://go.dev/dl/go${GOLANG_VERSION}.linux-${ARCH}.tar.gz \\\n | tar -C /usr/local -xz\n\nENV GOPATH /go\nENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH\n\n# packaging\nARG PKG_NAME\nARG PKG_VERS\nARG PKG_REV\n\nENV DEBFULLNAME \"NVIDIA CORPORATION\"\nENV DEBEMAIL \"cudatools@nvidia.com\"\nENV REVISION \"$PKG_VERS-$PKG_REV\"\nENV SECTION \"\"\n\n# output directory\nENV DIST_DIR=/tmp/nvidia-container-toolkit-$PKG_VERS\nRUN mkdir -p $DIST_DIR /dist\n\n# nvidia-container-toolkit\nWORKDIR $GOPATH/src/nvidia-container-toolkit\nCOPY . .\n\nARG GIT_COMMIT\nENV GIT_COMMIT ${GIT_COMMIT}\nRUN make PREFIX=${DIST_DIR} cmds\n\nWORKDIR $DIST_DIR\nCOPY packaging/debian ./debian\nCOPY deployments/systemd/ .\n\nRUN dch --create --package=\"${PKG_NAME}\" \\\n --newversion \"${REVISION}\" \\\n \"See https://github.com/NVIDIA/nvidia-container-toolkit/blob/${GIT_COMMIT}/CHANGELOG.md for the changelog\" && \\\n dch --append \"Bump libnvidia-container dependency to ${REVISION}\" && \\\n dch -r \"\" && \\\n if [ \"$REVISION\" != \"$(dpkg-parsechangelog --show-field=Version)\" ]; then exit 1; fi\n\nCMD export DISTRIB=\"$(lsb_release -cs)\" && \\\n debuild -eDISTRIB -eSECTION -eVERSION=\"${REVISION}\" \\\n --dpkg-buildpackage-hook='sh debian/prepare' -i -us -uc -b && \\\n mv /tmp/*.deb /dist\n"
},
{
"path": "docker/docker.mk",
"content": "# Copyright (c) 2017-2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# Supported OSs by architecture\nAMD64_TARGETS := ubuntu22.04 ubuntu20.04 ubuntu18.04 ubuntu16.04 debian10 debian9\nX86_64_TARGETS := centos7 centos8 rhel7 rhel8 amazonlinux2 opensuse-leap15.1\nPPC64LE_TARGETS := ubuntu18.04 ubuntu16.04 centos7 centos8 rhel7 rhel8\nARM64_TARGETS := ubuntu22.04 ubuntu20.04 ubuntu18.04\nAARCH64_TARGETS := centos7 centos8 rhel8 amazonlinux2\n\n# Define top-level build targets\ndocker%: SHELL:=/bin/bash\n\n# Native targets\nPLATFORM ?= $(shell uname -m)\nifeq ($(PLATFORM),x86_64)\nNATIVE_TARGETS := $(AMD64_TARGETS) $(X86_64_TARGETS)\n$(AMD64_TARGETS): %: %-amd64\n$(X86_64_TARGETS): %: %-x86_64\nelse ifeq ($(PLATFORM),ppc64le)\nNATIVE_TARGETS := $(PPC64LE_TARGETS)\n$(PPC64LE_TARGETS): %: %-ppc64le\nelse ifeq ($(PLATFORM),aarch64)\nNATIVE_TARGETS := $(ARM64_TARGETS) $(AARCH64_TARGETS)\n$(ARM64_TARGETS): %: %-arm64\n$(AARCH64_TARGETS): %: %-aarch64\nendif\ndocker-native: $(NATIVE_TARGETS)\n\n# amd64 targets\nAMD64_TARGETS := $(patsubst %, %-amd64, $(AMD64_TARGETS))\n$(AMD64_TARGETS): ARCH := amd64\n$(AMD64_TARGETS): %: --%\ndocker-amd64: $(AMD64_TARGETS)\n\n# x86_64 targets\nX86_64_TARGETS := $(patsubst %, %-x86_64, $(X86_64_TARGETS))\n$(X86_64_TARGETS): ARCH := x86_64\n$(X86_64_TARGETS): %: --%\ndocker-x86_64: $(X86_64_TARGETS)\n\n# arm64 targets\nARM64_TARGETS := $(patsubst %, %-arm64, $(ARM64_TARGETS))\n$(ARM64_TARGETS): ARCH := arm64\n$(ARM64_TARGETS): %: --%\ndocker-arm64: $(ARM64_TARGETS)\n\n# aarch64 targets\nAARCH64_TARGETS := $(patsubst %, %-aarch64, $(AARCH64_TARGETS))\n$(AARCH64_TARGETS): ARCH := aarch64\n$(AARCH64_TARGETS): %: --%\ndocker-aarch64: $(AARCH64_TARGETS)\n\n# ppc64le targets\nPPC64LE_TARGETS := $(patsubst %, %-ppc64le, $(PPC64LE_TARGETS))\n$(PPC64LE_TARGETS): ARCH := ppc64le\n$(PPC64LE_TARGETS): WITH_LIBELF := yes\n$(PPC64LE_TARGETS): %: --%\ndocker-ppc64le: $(PPC64LE_TARGETS)\n\n# docker target to build for all os/arch combinations\ndocker-all: $(AMD64_TARGETS) $(X86_64_TARGETS) \\\n $(ARM64_TARGETS) $(AARCH64_TARGETS) \\\n $(PPC64LE_TARGETS)\n\n# Default variables for all private '--' targets below.\n# One private target is defined for each OS we support.\n--%: TARGET_PLATFORM = $(*)\n--%: VERSION = $(patsubst $(OS)%-$(ARCH),%,$(TARGET_PLATFORM))\n--%: BASEIMAGE = $(OS):$(VERSION)\n--%: BUILDIMAGE = nvidia/$(LIB_NAME)/$(OS)$(VERSION)-$(ARCH)\n--%: DOCKERFILE = $(CURDIR)/docker/Dockerfile.$(OS)\n--%: ARTIFACTS_DIR = $(DIST_DIR)/$(OS)$(VERSION)/$(ARCH)\n--%: docker-build-%\n\t@\n\n# private ubuntu target\n--ubuntu%: OS := ubuntu\n\n# private debian target\n--debian%: OS := debian\n\n# private centos target\n--centos%: OS := centos\n--centos%: DOCKERFILE = $(CURDIR)/docker/Dockerfile.rpm-yum\n--centos8%: BASEIMAGE = quay.io/centos/centos:stream8\n\n# private amazonlinux target\n--amazonlinux%: OS := amazonlinux\n--amazonlinux%: DOCKERFILE = $(CURDIR)/docker/Dockerfile.rpm-yum\n\n# private opensuse-leap target\n--opensuse-leap%: OS = opensuse-leap\n--opensuse-leap%: BASEIMAGE = opensuse/leap:$(VERSION)\n\n# private rhel target (actually built on centos)\n--rhel%: OS := centos\n--rhel%: VERSION = $(patsubst rhel%-$(ARCH),%,$(TARGET_PLATFORM))\n--rhel%: ARTIFACTS_DIR = $(DIST_DIR)/rhel$(VERSION)/$(ARCH)\n--rhel%: DOCKERFILE = $(CURDIR)/docker/Dockerfile.rpm-yum\n--rhel8%: BASEIMAGE = quay.io/centos/centos:stream8\n\n\ndocker-build-%:\n\t@echo \"Building for $(TARGET_PLATFORM)\"\n\tdocker pull --platform=linux/$(ARCH) $(BASEIMAGE)\n\tDOCKER_BUILDKIT=1 \\\n\t$(DOCKER) build \\\n\t --platform=linux/$(ARCH) \\\n\t --progress=plain \\\n\t --build-arg BASEIMAGE=\"$(BASEIMAGE)\" \\\n\t --build-arg GOLANG_VERSION=\"$(GOLANG_VERSION)\" \\\n\t --build-arg PKG_NAME=\"$(LIB_NAME)\" \\\n\t --build-arg PKG_VERS=\"$(PACKAGE_VERSION)\" \\\n\t --build-arg PKG_REV=\"$(PACKAGE_REVISION)\" \\\n\t --build-arg GIT_COMMIT=\"$(GIT_COMMIT)\" \\\n\t --tag $(BUILDIMAGE) \\\n\t --file $(DOCKERFILE) .\n\t$(DOCKER) run \\\n\t --platform=linux/$(ARCH) \\\n\t -e DISTRIB \\\n\t -e SECTION \\\n\t -v $(ARTIFACTS_DIR):/dist \\\n\t $(BUILDIMAGE)\n\ndocker-clean:\n\tIMAGES=$$(docker images \"nvidia/$(LIB_NAME)/*\" --format=\"{{.ID}}\"); \\\n\tif [ \"$${IMAGES}\" != \"\" ]; then \\\n\t docker rmi -f $${IMAGES}; \\\n\tfi\n\ndistclean:\n\trm -rf $(DIST_DIR)\n"
},
{
"path": "go.mod",
"content": "module github.com/NVIDIA/nvidia-container-toolkit\n\ngo 1.25.0\n\nrequire (\n\tgithub.com/NVIDIA/go-nvlib v0.9.1-0.20251202135446-d0f42ba016dd\n\tgithub.com/NVIDIA/go-nvml v0.13.0-1.0.20260212130905-92cf8c963449\n\tgithub.com/containerd/nri v0.11.0\n\tgithub.com/google/uuid v1.6.0\n\tgithub.com/moby/sys/mountinfo v0.7.2\n\tgithub.com/moby/sys/reexec v0.1.0\n\tgithub.com/moby/sys/symlink v0.3.0\n\tgithub.com/opencontainers/cgroups v0.0.6\n\tgithub.com/opencontainers/runc v1.4.0\n\tgithub.com/opencontainers/runtime-spec v1.3.0\n\tgithub.com/pelletier/go-toml v1.9.5\n\tgithub.com/prometheus/procfs v0.19.2\n\tgithub.com/sirupsen/logrus v1.9.4\n\tgithub.com/stretchr/testify v1.11.1\n\tgithub.com/urfave/cli-altsrc/v3 v3.1.0\n\tgithub.com/urfave/cli/v3 v3.6.2\n\tgolang.org/x/mod v0.33.0\n\tgolang.org/x/sys v0.41.0\n\ttags.cncf.io/container-device-interface v1.1.0\n\ttags.cncf.io/container-device-interface/specs-go v1.1.0\n)\n\nrequire (\n\tcyphar.com/go-pathrs v0.2.1 // indirect\n\tgithub.com/containerd/log v0.1.0 // indirect\n\tgithub.com/containerd/ttrpc v1.2.7 // indirect\n\tgithub.com/cyphar/filepath-securejoin v0.6.1 // indirect\n\tgithub.com/davecgh/go-spew v1.1.1 // indirect\n\tgithub.com/fsnotify/fsnotify v1.7.0 // indirect\n\tgithub.com/golang/protobuf v1.5.3 // indirect\n\tgithub.com/hashicorp/errwrap v1.1.0 // indirect\n\tgithub.com/knqyf263/go-plugin v0.9.0 // indirect\n\tgithub.com/kr/text v0.2.0 // indirect\n\tgithub.com/moby/sys/capability v0.4.0 // indirect\n\tgithub.com/opencontainers/runtime-tools v0.9.1-0.20251114084447-edf4cb3d2116 // indirect\n\tgithub.com/pmezard/go-difflib v1.0.0 // indirect\n\tgithub.com/rogpeppe/go-internal v1.11.0 // indirect\n\tgithub.com/tetratelabs/wazero v1.10.1 // indirect\n\tgithub.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect\n\tgoogle.golang.org/genproto/googleapis/rpc v0.0.0-20230731190214-cbb8c96f2d6d // indirect\n\tgoogle.golang.org/grpc v1.57.1 // indirect\n\tgoogle.golang.org/protobuf v1.36.8 // indirect\n\tgopkg.in/yaml.v3 v3.0.1 // indirect\n\tsigs.k8s.io/yaml v1.4.0 // indirect\n)\n"
},
{
"path": "go.sum",
"content": "cyphar.com/go-pathrs v0.2.1 h1:9nx1vOgwVvX1mNBWDu93+vaceedpbsDqo+XuBGL40b8=\ncyphar.com/go-pathrs v0.2.1/go.mod h1:y8f1EMG7r+hCuFf/rXsKqMJrJAUoADZGNh5/vZPKcGc=\ngithub.com/NVIDIA/go-nvlib v0.9.1-0.20251202135446-d0f42ba016dd h1:MC1w/VYuo9Zt0se4SSx9BVid4a46ai+voN3knRvVWjE=\ngithub.com/NVIDIA/go-nvlib v0.9.1-0.20251202135446-d0f42ba016dd/go.mod h1:7mzx9FSdO9fXWP9NKuZmWkCwhkEcSWQFe2tmFwtLb9c=\ngithub.com/NVIDIA/go-nvml v0.13.0-1.0.20260212130905-92cf8c963449 h1:UrArFAaPhj9av2yzEN35CvzWw68BeQjp2MaQFUIoJSU=\ngithub.com/NVIDIA/go-nvml v0.13.0-1.0.20260212130905-92cf8c963449/go.mod h1:ahi2psRYoa+wYUBIrZPRO+wJs9lcvMhxSSkjjvsJJNQ=\ngithub.com/blang/semver/v4 v4.0.0 h1:1PFHFE6yCCTv8C1TeyNNarDzntLi7wMI5i/pzqYIsAM=\ngithub.com/blang/semver/v4 v4.0.0/go.mod h1:IbckMUScFkM3pff0VJDNKRiT6TG/YpiHIM2yvyW5YoQ=\ngithub.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I=\ngithub.com/containerd/log v0.1.0/go.mod h1:VRRf09a7mHDIRezVKTRCrOq78v577GXq3bSa3EhrzVo=\ngithub.com/containerd/nri v0.11.0 h1:26mcQwNG58AZn0YkOrlJQ0yxQVmyZooflnVWJTqQrqQ=\ngithub.com/containerd/nri v0.11.0/go.mod h1:bjGTLdUA58WgghKHg8azFMGXr05n1wDHrt3NSVBHiGI=\ngithub.com/containerd/ttrpc v1.2.7 h1:qIrroQvuOL9HQ1X6KHe2ohc7p+HP/0VE6XPU7elJRqQ=\ngithub.com/containerd/ttrpc v1.2.7/go.mod h1:YCXHsb32f+Sq5/72xHubdiJRQY9inL4a4ZQrAbN1q9o=\ngithub.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=\ngithub.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE=\ngithub.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc=\ngithub.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=\ngithub.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM=\ngithub.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY=\ngithub.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI=\ngithub.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8=\ngithub.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=\ngithub.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg=\ngithub.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=\ngithub.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=\ngithub.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/pprof v0.0.0-20240424215950-a892ee059fd6 h1:k7nVchz72niMH6YLQNvHSdIE7iqsQxK1P41mySCvssg=\ngithub.com/google/pprof v0.0.0-20240424215950-a892ee059fd6/go.mod h1:kf6iHlnVGwgKolg33glAes7Yg/8iWP8ukqeldJSO7jw=\ngithub.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=\ngithub.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=\ngithub.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I=\ngithub.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=\ngithub.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo=\ngithub.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM=\ngithub.com/knqyf263/go-plugin v0.9.0 h1:CQs2+lOPIlkZVtcb835ZYDEoyyWJWLbSTWeCs0EwTwI=\ngithub.com/knqyf263/go-plugin v0.9.0/go.mod h1:2z5lCO1/pez6qGo8CvCxSlBFSEat4MEp1DrnA+f7w8Q=\ngithub.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=\ngithub.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=\ngithub.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=\ngithub.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=\ngithub.com/moby/sys/capability v0.4.0 h1:4D4mI6KlNtWMCM1Z/K0i7RV1FkX+DBDHKVJpCndZoHk=\ngithub.com/moby/sys/capability v0.4.0/go.mod h1:4g9IK291rVkms3LKCDOoYlnV8xKwoDTpIrNEE35Wq0I=\ngithub.com/moby/sys/mountinfo v0.7.2 h1:1shs6aH5s4o5H2zQLn796ADW1wMrIwHsyJ2v9KouLrg=\ngithub.com/moby/sys/mountinfo v0.7.2/go.mod h1:1YOa8w8Ih7uW0wALDUgT1dTTSBrZ+HiBLGws92L2RU4=\ngithub.com/moby/sys/reexec v0.1.0 h1:RrBi8e0EBTLEgfruBOFcxtElzRGTEUkeIFaVXgU7wok=\ngithub.com/moby/sys/reexec v0.1.0/go.mod h1:EqjBg8F3X7iZe5pU6nRZnYCMUTXoxsjiIfHup5wYIN8=\ngithub.com/moby/sys/symlink v0.3.0 h1:GZX89mEZ9u53f97npBy4Rc3vJKj7JBDj/PN2I22GrNU=\ngithub.com/moby/sys/symlink v0.3.0/go.mod h1:3eNdhduHmYPcgsJtZXW1W4XUJdZGBIkttZ8xKqPUJq0=\ngithub.com/onsi/ginkgo/v2 v2.19.1 h1:QXgq3Z8Crl5EL1WBAC98A5sEBHARrAJNzAmMxzLcRF0=\ngithub.com/onsi/ginkgo/v2 v2.19.1/go.mod h1:O3DtEWQkPa/F7fBMgmZQKKsluAy8pd3rEQdrjkPb9zA=\ngithub.com/onsi/gomega v1.34.0 h1:eSSPsPNp6ZpsG8X1OVmOTxig+CblTc4AxpPBykhe2Os=\ngithub.com/onsi/gomega v1.34.0/go.mod h1:MIKI8c+f+QLWk+hxbePD4i0LMJSExPaZOVfkoex4cAo=\ngithub.com/opencontainers/cgroups v0.0.6 h1:tfZFWTIIGaUUFImTyuTg+Mr5x8XRiSdZESgEBW7UxuI=\ngithub.com/opencontainers/cgroups v0.0.6/go.mod h1:oWVzJsKK0gG9SCRBfTpnn16WcGEqDI8PAcpMGbqWxcs=\ngithub.com/opencontainers/runc v1.4.0 h1:FG1Hw0GBYPsNki+mBz1QOrSzbwbAcerhrAD2r097QCc=\ngithub.com/opencontainers/runc v1.4.0/go.mod h1:sch3Bh3c1NlyAkALoAUz5Br9ubMLZzFcxuovZbnkErk=\ngithub.com/opencontainers/runtime-spec v1.3.0 h1:YZupQUdctfhpZy3TM39nN9Ika5CBWT5diQ8ibYCRkxg=\ngithub.com/opencontainers/runtime-spec v1.3.0/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0=\ngithub.com/opencontainers/runtime-tools v0.9.1-0.20251114084447-edf4cb3d2116 h1:tAKu3NkKWZYpqBSOJKwTxT1wIGueiF7gcmcNgr5pNTY=\ngithub.com/opencontainers/runtime-tools v0.9.1-0.20251114084447-edf4cb3d2116/go.mod h1:DKDEfzxvRkoQ6n9TGhxQgg2IM1lY4aM0eaQP4e3oElw=\ngithub.com/opencontainers/selinux v1.13.0 h1:Zza88GWezyT7RLql12URvoxsbLfjFx988+LGaWfbL84=\ngithub.com/opencontainers/selinux v1.13.0/go.mod h1:XxWTed+A/s5NNq4GmYScVy+9jzXhGBVEOAyucdRUY8s=\ngithub.com/pelletier/go-toml v1.9.5 h1:4yBQzkHv+7BHq2PQUZF3Mx0IYxG7LsP222s7Agd3ve8=\ngithub.com/pelletier/go-toml v1.9.5/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/prometheus/procfs v0.19.2 h1:zUMhqEW66Ex7OXIiDkll3tl9a1ZdilUOd/F6ZXw4Vws=\ngithub.com/prometheus/procfs v0.19.2/go.mod h1:M0aotyiemPhBCM0z5w87kL22CxfcH05ZpYlu+b4J7mw=\ngithub.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=\ngithub.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=\ngithub.com/sirupsen/logrus v1.9.4 h1:TsZE7l11zFCLZnZ+teH4Umoq5BhEIfIzfRDZ1Uzql2w=\ngithub.com/sirupsen/logrus v1.9.4/go.mod h1:ftWc9WdOfJ0a92nsE2jF5u5ZwH8Bv2zdeOC42RjbV2g=\ngithub.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=\ngithub.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=\ngithub.com/tetratelabs/wazero v1.10.1 h1:2DugeJf6VVk58KTPszlNfeeN8AhhpwcZqkJj2wwFuH8=\ngithub.com/tetratelabs/wazero v1.10.1/go.mod h1:DRm5twOQ5Gr1AoEdSi0CLjDQF1J9ZAuyqFIjl1KKfQU=\ngithub.com/urfave/cli-altsrc/v3 v3.1.0 h1:6E5+kXeAWmRxXlPgdEVf9VqVoTJ2MJci0UMpUi/w/bA=\ngithub.com/urfave/cli-altsrc/v3 v3.1.0/go.mod h1:VcWVTGXcL3nrXUDJZagHAeUX702La3PKeWav7KpISqA=\ngithub.com/urfave/cli/v3 v3.6.2 h1:lQuqiPrZ1cIz8hz+HcrG0TNZFxU70dPZ3Yl+pSrH9A8=\ngithub.com/urfave/cli/v3 v3.6.2/go.mod h1:ysVLtOEmg2tOy6PknnYVhDoouyC/6N42TMeoMzskhso=\ngithub.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb h1:zGWFAtiMcyryUHoUjUJX0/lt1H2+i2Ka2n+D3DImSNo=\ngithub.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU=\ngithub.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 h1:EzJWgHovont7NscjpAxXsDA8S8BMYve8Y5+7cuRE7R0=\ngithub.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415/go.mod h1:GwrjFmJcFw6At/Gs6z4yjiIwzuJ1/+UwLxMQDVQXShQ=\ngithub.com/xeipuuv/gojsonschema v1.2.0 h1:LhYJRs+L4fBtjZUfuSZIKGeVu0QRy8e5Xi7D17UxZ74=\ngithub.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y=\ngolang.org/x/mod v0.33.0 h1:tHFzIWbBifEmbwtGz65eaWyGiGZatSrT9prnU8DbVL8=\ngolang.org/x/mod v0.33.0/go.mod h1:swjeQEj+6r7fODbD2cqrnje9PnziFuw4bmLbBZFrQ5w=\ngolang.org/x/net v0.43.0 h1:lat02VYK2j4aLzMzecihNvTlJNQUq316m2Mr9rnM6YE=\ngolang.org/x/net v0.43.0/go.mod h1:vhO1fvI4dGsIjh73sWfUVjj3N7CA9WkKJNQm2svM6Jg=\ngolang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=\ngolang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=\ngolang.org/x/text v0.23.0 h1:D71I7dUrlY+VX0gQShAThNGHFxZ13dGLBHQLVl1mJlY=\ngolang.org/x/text v0.23.0/go.mod h1:/BLNzu4aZCJ1+kcD0DNRotWKage4q2rGVAg4o22unh4=\ngolang.org/x/tools v0.41.0 h1:a9b8iMweWG+S0OBnlU36rzLp20z1Rp10w+IY2czHTQc=\ngolang.org/x/tools v0.41.0/go.mod h1:XSY6eDqxVNiYgezAVqqCeihT4j1U2CCsqvH3WhQpnlg=\ngolang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=\ngoogle.golang.org/genproto/googleapis/rpc v0.0.0-20230731190214-cbb8c96f2d6d h1:pgIUhmqwKOUlnKna4r6amKdUngdL8DrkpFeV8+VBElY=\ngoogle.golang.org/genproto/googleapis/rpc v0.0.0-20230731190214-cbb8c96f2d6d/go.mod h1:TUfxEVdsvPg18p6AslUXFoLdpED4oBnGwyqk3dV1XzM=\ngoogle.golang.org/grpc v1.57.1 h1:upNTNqv0ES+2ZOOqACwVtS3Il8M12/+Hz41RCPzAjQg=\ngoogle.golang.org/grpc v1.57.1/go.mod h1:Sd+9RMTACXwmub0zcNY2c4arhtrbBYD1AUHI/dt16Mo=\ngoogle.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=\ngoogle.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=\ngoogle.golang.org/protobuf v1.36.8 h1:xHScyCOEuuwZEc6UtSOvPbAT4zRh0xcNRYekJwfqyMc=\ngoogle.golang.org/protobuf v1.36.8/go.mod h1:fuxRtAxBytpl4zzqUh6/eyUujkJdNiuEkXntxiD/uRU=\ngopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=\ngopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=\ngopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\nsigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E=\nsigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY=\ntags.cncf.io/container-device-interface v1.1.0 h1:RnxNhxF1JOu6CJUVpetTYvrXHdxw9j9jFYgZpI+anSY=\ntags.cncf.io/container-device-interface v1.1.0/go.mod h1:76Oj0Yqp9FwTx/pySDc8Bxjpg+VqXfDb50cKAXVJ34Q=\ntags.cncf.io/container-device-interface/specs-go v1.1.0 h1:QRZVeAceQM+zTZe12eyfuJuuzp524EKYwhmvLd+h+yQ=\ntags.cncf.io/container-device-interface/specs-go v1.1.0/go.mod h1:u86hoFWqnh3hWz3esofRFKbI261bUlvUfLKGrDhJkgQ=\n"
},
{
"path": "hack/create-release.sh",
"content": "# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nif [ -z \"$1\" ]; then\n VERSION=$(awk -F= '/^VERSION/ { print $2 }' versions.mk | tr -d '[:space:]')\nelse\n VERSION=$1\nfi\n\n\nPRERELEASE_FLAG=\"\"\nREPO=\"stable\"\nif [[ ${VERSION} == v*-rc.* ]]; then\n PRERELEASE_FLAG=\"--prerelease\"\n REPO=\"experimental\"\nfi\n\nREPOSITORY=NVIDIA/nvidia-container-toolkit\n\necho \"Creating draft release\"\ngh release create ${VERSION} \\\n --draft \\\n --title \"${VERSION}\" \\\n -R \"${REPOSITORY}\" \\\n --verify-tag \\\n --prerelease\n\necho \"Uploading release artifacts for ${VERSION}\"\n\nPACKAGE_ROOT=release-${VERSION}-${REPO}\n\ngh release upload ${VERSION} \\\n ${PACKAGE_ROOT}/nvidia-container-toolkit_${VERSION#v}_*.tar.gz \\\n ${PACKAGE_ROOT}/nvidia-container-toolkit_${VERSION#v}_checksums.txt \\\n --clobber \\\n -R ${REPOSITORY}\n"
},
{
"path": "hack/generate-changelog.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nset -o pipefail\nthis=`basename $0`\n\nusage () {\ncat << EOF\nGenerate a changelog for an NVIDIA Container Toolkit release\n\nUsage: $this [-h] --previous-version --version \n\nOptions:\n --previous-version specify the previous version\n --version specify the version for this release.\n --help/-h show this help and exit\n\nEOF\n}\n\nversion=\nprevious_version=\n# Parse command line options\nwhile [[ $# -gt 0 ]]; do\n key=\"$1\"\n case $key in\n --previous-version)\n previous_version=\"$2\"\n shift 2\n ;;\n --version)\n version=\"$2\"\n shift 2\n ;;\n --help/-h)\n usage\n exit 0\n ;;\n *) usage\n exit 1\n ;;\n esac\ndone\n\n# Check that the required args were provided.\nif [ -z ${version} ]; then\n echo -e \"ERROR: --version is required\"\n usage\n exit 1\nfi\n\nif [ -z ${previous_version} ]; then\n echo -e \"ERROR: --previous-version is required\"\n usage\n exit 1\nfi\n\n>&2 echo \"version=$version, previous_version=$previous_version\"\n\n# Fetch the latest tags from the remote\nremote=$( git remote -v | grep -E \"NVIDIA/nvidia-container-toolkit(\\.git)?\\s\" | grep -oE \"^[a-z]+\" | sort -u )\n>&2 echo \"Detected remote as '${remote}'\"\ngit fetch ${remote} --tags\n\nSHA=$(git rev-parse ${version})\nif [[ $? -ne 0 ]]; then\n SHA=\"HEAD\"\nfi\n\n>&2 echo \"Using ${previous_version} as previous version\"\n\n# Print the changelog\necho \"## What's Changed\"\necho \"\"\nif [[ ${version} != v*-rc.* && ${previous_version} == v*-rc.* ]]; then\necho \"- Promote ${previous_version} to $version\"\nfi\n\n# Iterate over the commit messages and ignore the ones that start with \"Merge\" or \"Bump\"\ngit log --pretty=format:\"%s\" ${previous_version}..$SHA -- ':!deployments/container' ':!tools' | grep -Ev \"(^Merge )|(^Bump)|(no-rel-?note)|(^---)\" | sed 's/^\\(.*\\)/- \\1/g'\n\necho \"\"\necho \"### Changes in the Toolkit Container\"\necho \"\"\ngit log --pretty=format:\"%s\" ${previous_version}..$SHA -- deployments/container tools | grep -Ev \"(^Merge )|(no-rel-?note)|(^---)\" | sed 's/^\\(.*\\)/- \\1/g'\n\nLIB_NVIDIA_CONTAINER_REFERENCE=$( git ls-tree ${previous_version} third_party/libnvidia-container --object-only )\nLIB_NVIDIA_CONTAINER_VERSION=$( git ls-tree $SHA third_party/libnvidia-container --object-only )\n\necho \"\"\nif [[ \"${LIB_NVIDIA_CONTAINER_REFERENCE}\" != \"${LIB_NVIDIA_CONTAINER_VERSION}\" ]] && [[ $(git -C third_party/libnvidia-container log --pretty=format:\"%s\" $LIB_NVIDIA_CONTAINER_REFERENCE..$LIB_NVIDIA_CONTAINER_VERSION | grep -Ev \"(^Merge )|(^Bump)|(no-rel-?note)|(^---)\" | sed 's/^\\(.*\\)/- \\1/g' | wc -l) -gt 0 ]]; then\necho \"### Changes in libnvidia-container\"\necho \"\"\ngit -C third_party/libnvidia-container log --pretty=format:\"%s\" $LIB_NVIDIA_CONTAINER_REFERENCE..$LIB_NVIDIA_CONTAINER_VERSION | grep -Ev \"(^Merge )|(^Bump)|(no-rel-?note)|(^---)\" | sed 's/^\\(.*\\)/- \\1/g'\necho \"\"\nfi\n\necho \"**Full Changelog**: https://github.com/NVIDIA/nvidia-container-toolkit/compare/${previous_version}...${version}\"\necho \"\"\n"
},
{
"path": "hack/golang-version.sh",
"content": "#!/bin/bash\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../hack && pwd )\"\n\nDOCKERFILE_ROOT=${SCRIPTS_DIR}/../deployments/devel\n\nGOLANG_VERSION=$(grep -E \"^FROM golang:.*$\" ${DOCKERFILE_ROOT}/Dockerfile | grep -oE \"[0-9\\.]+\")\n\necho $GOLANG_VERSION\n"
},
{
"path": "hack/prepare-artifacts.sh",
"content": "#!/bin/bash -e\n\n# Copyright (c) 2023, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nset -o pipefail\n\n# if arg1 is set, it will be used as the version number\nif [ -z \"$1\" ]; then\n VERSION=$(awk -F= '/^VERSION/ { print $2 }' versions.mk | tr -d '[:space:]')\nelse\n VERSION=$1\nfi\n\nif [[ -z ${VERSION} ]]; then\n echo \"VERSION must be specified\"\n exit 1\nfi\n\nSHA=$(git rev-parse --short=8 ${VERSION}^{commit})\n\nIMAGE_NAME=\"ghcr.io/nvidia/container-toolkit\"\nIMAGE_TAG=${SHA}-packaging\n\nREPO=\"experimental\"\nif [[ ${VERSION/rc./} == ${VERSION} ]]; then\n REPO=\"stable\"\nfi\n\nPACKAGE_ROOT=release-${VERSION}-${REPO}\n\n./hack/pull-packages.sh \\\n ${IMAGE_NAME}:${IMAGE_TAG} \\\n ${PACKAGE_ROOT}\n\nPACKAGE_VERSION=${VERSION/-/\\~}\nPACKAGE_VERSION=${PACKAGE_VERSION#v}\n\ntar -czvf ${PACKAGE_ROOT}/nvidia-container-toolkit_${VERSION#v}_deb_amd64.tar.gz ${PACKAGE_ROOT}/packages/ubuntu18.04/amd64/*_${PACKAGE_VERSION}-1_amd64.deb\ntar -czvf ${PACKAGE_ROOT}/nvidia-container-toolkit_${VERSION#v}_deb_arm64.tar.gz ${PACKAGE_ROOT}/packages/ubuntu18.04/arm64/*_${PACKAGE_VERSION}-1_arm64.deb\ntar -czvf ${PACKAGE_ROOT}/nvidia-container-toolkit_${VERSION#v}_rpm_aarch64.tar.gz ${PACKAGE_ROOT}/packages/centos7/aarch64/*-${PACKAGE_VERSION}-1.aarch64.rpm\ntar -czvf ${PACKAGE_ROOT}/nvidia-container-toolkit_${VERSION#v}_rpm_x86_64.tar.gz ${PACKAGE_ROOT}/packages/centos7/x86_64/*-${PACKAGE_VERSION}-1.x86_64.rpm\n\nis_command() (\n command -v \"$1\" >/dev/null\n)\n\nhash_sha256() (\n TARGET=${1:-/dev/stdin}\n if is_command gsha256sum; then\n hash=$(gsha256sum \"$TARGET\") || return 1\n echo \"$hash\" | cut -d ' ' -f 1\n elif is_command sha256sum; then\n hash=$(sha256sum \"$TARGET\") || return 1\n echo \"$hash\" | cut -d ' ' -f 1\n elif is_command shasum; then\n hash=$(shasum -a 256 \"$TARGET\" 2>/dev/null) || return 1\n echo \"$hash\" | cut -d ' ' -f 1\n elif is_command openssl; then\n hash=$(openssl -dst openssl dgst -sha256 \"$TARGET\") || return 1\n echo \"$hash\" | cut -d ' ' -f a\n else\n log_err \"hash_sha256 unable to find command to compute sha-256 hash\"\n return 1\n fi\n)\n\nfiles=$( ls ${PACKAGE_ROOT}/nvidia-container-toolkit_${VERSION#v}_*.tar.gz )\n\nCHECKSUM_FILE=${PACKAGE_ROOT}/nvidia-container-toolkit_${VERSION#v}_checksums.txt\nrm -f ${CHECKSUM_FILE}\n\nset -e\nfor f in ${files}; do\n hash_f=$(hash_sha256 $f)\n echo \"${hash_f} $f\" >> $CHECKSUM_FILE\ndone\n"
},
{
"path": "hack/prepare-release.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nset -o pipefail\n\nthis=`basename $0`\n\nusage () {\ncat << EOF\nPrepare for an NVIDIA Container Toolkit release\n\nUsage: $this [-h] --previous-version --version \n\nOptions:\n --previous-version specify the previous version\n --version specify the version for this release.\n --help/-h show this help and exit\n\nExample:\n\n $this --previous-version {{ PREVIOUS_VERSION}} --version {{ VERSION }}\n\nEOF\n}\n\n# Parse command line options\nprevious_version=\nversion=\nwhile [[ $# -gt 0 ]]; do\n key=\"$1\"\n case $key in\n --previous-version)\n previous_version=\"$2\"\n shift 2\n ;;\n --version)\n version=\"$2\"\n shift 2\n ;;\n --help/-h)\n usage\n exit 0\n ;;\n *) usage\n exit 1\n ;;\n esac\ndone\n\n# Check that the required args were provided.\nif [ -z ${version} ]; then\n echo -e \"ERROR: --version is required\"\n usage\n exit 1\nfi\n\nif [ -z ${previous_version} ]; then\n echo -e \"ERROR: --previous-version is required\"\n usage\n exit 1\nfi\n\n>&2 echo \"version=$version, previous_version=$previous_version\"\n\n#\n# Modify files in the repo to point to new release\n#\n# Darwin or Linux\nDOCKER=\"docker\"\nif [[ \"$(uname)\" == \"Darwin\" ]]; then\n SED=\"$DOCKER run -i --rm -v $(PWD):$(PWD) -w $(PWD) alpine:latest sed\"\nelse\n SED=\"sed\"\nfi\n\nif [[ \"$FORCE\" != \"yes\" ]]; then\n current_head=$(git rev-parse --abbrev-ref HEAD)\n if [[ \"${current_head}\" != \"main\" && \"${current_head}\" != release-* ]]; then\n echo \"Release scripts should be run on 'main' or on a 'release-*' branch\"\n exit 1\n fi\n git fetch\n git diff --quiet FETCH_HEAD\n if [[ $? -ne 0 ]]; then\n echo \"Local changes detected:\"\n git diff FETCH_HEAD | cat\n echo \"Exiting\"\n exit 1\n fi\nfi\n\n# Create a release issue.\necho \"Creating release tracking issue\"\ncat RELEASE.md | sed \"s/{{ .VERSION }}/${version}/g\" | \\\n gh issue create -F - \\\n -R NVIDIA/nvidia-container-toolkit \\\n --title \"Release nvidia-container-toolkit ${version}\" \\\n --label release \\\n --milestone ${version}\n\necho \"Creating a version bump branch: bump-release-${version}\"\ngit checkout -f -b bump-release-${version}\n\n# Patch versions.mk\nLIB_VERSION=${version%-*}\nLIB_VERSION=${LIB_VERSION#v}\nif [[ ${version} == v*-rc.* ]]; then\n LIB_TAG_STRING=\" ${version#*-}\"\nelse\n LIB_TAG_STRING=\nfi\n\necho Patching versions.mk to refer to ${version}\n$SED -i \"s/^LIB_VERSION.*$/LIB_VERSION := $LIB_VERSION/\" versions.mk\n$SED -i \"s/^LIB_TAG.*$/LIB_TAG :=$LIB_TAG_STRING/\" versions.mk\n\ngit add versions.mk\ngit commit -s -m \"Bump version for ${version} release\"\n\nif [[ ${version} != *-rc.* ]]; then\n # Patch README.md\n echo Patching README.md to refer to ${version}\n $SED -E -i -e \"s/([^[:space:]])$previous_version([^[:alnum:]]|$)/\\1${version}\\2/g\" README.md\n $SED -E -i -e \"s/$pre_semver/$semver/g\" README.md\n\n git add -u README.md\n git commit -s -m \"Bump version to ${version} in README\"\nelse\n echo \"Skipping README update for prerelease version\"\nfi\n\necho \"Please validated changes and create a pull request\"\n"
},
{
"path": "hack/pull-packages.sh",
"content": "#!/bin/bash\n\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfunction assert_usage() {\n echo \"Incorrect arguments: $*\"\n echo \"$(basename ${BASH_SOURCE[0]}) IMAGE DIST_DIR\"\n exit 1\n}\n\nset -e -x\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../scripts && pwd )\"\nPROJECT_ROOT=\"$( cd ${SCRIPTS_DIR}/.. && pwd )\"\n\nif [[ $# -ne 2 ]]; then\n assert_usage $*\nfi\n\nIMAGE=$1\nDIST_DIR=$2\n\nif [[ -z ${IMAGE} ]]; then\n echo \"ERROR: IMAGE must be non-empty\"\n exit 1\nfi\n\nif [[ -z ${DIST_DIR} ]]; then\n echo \"ERROR: DIST_DIR must be non-empty\"\n exit 1\nfi\n\nif [[ x\"${IGNORE_DIST_DIR}\" != x\"yes\" && -e ${DIST_DIR} ]]; then\n echo \"ERROR: The specified DIST_DIR ${DIST_DIR} exists.\"\n exit 1\nfi\n\necho \"Copying package files from ${IMAGE} to ${DIST_DIR}\"\nmkdir -p ${DIST_DIR}\ndocker run --rm \\\n -v $(pwd):$(pwd) \\\n -w $(pwd) \\\n -u $(id -u):$(id -g) \\\n --entrypoint=\"sh\" \\\n ${IMAGE} \\\n -c \"cp -p -R /artifacts/* ${DIST_DIR}\"\n"
},
{
"path": "internal/config/image/builder.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype builder struct {\n\tCUDA\n\n\tdisableRequire bool\n}\n\n// Option is a functional option for creating a CUDA image.\ntype Option func(*builder) error\n\n// New creates a new CUDA image from the input options.\nfunc New(opt ...Option) (CUDA, error) {\n\tb := &builder{\n\t\tCUDA: CUDA{\n\t\t\tacceptEnvvarUnprivileged: true,\n\t\t},\n\t}\n\tfor _, o := range opt {\n\t\tif err := o(b); err != nil {\n\t\t\treturn CUDA{}, err\n\t\t}\n\t}\n\n\tif b.logger == nil {\n\t\tb.logger = logger.New()\n\t}\n\tif b.env == nil {\n\t\tb.env = make(map[string]string)\n\t}\n\n\treturn b.build()\n}\n\n// build creates a CUDA image from the builder.\nfunc (b builder) build() (CUDA, error) {\n\tif b.disableRequire {\n\t\tb.env[EnvVarNvidiaDisableRequire] = \"true\"\n\t}\n\n\treturn b.CUDA, nil\n}\n\nfunc WithAcceptDeviceListAsVolumeMounts(acceptDeviceListAsVolumeMounts bool) Option {\n\treturn func(b *builder) error {\n\t\tb.acceptDeviceListAsVolumeMounts = acceptDeviceListAsVolumeMounts\n\t\treturn nil\n\t}\n}\n\nfunc WithAcceptEnvvarUnprivileged(acceptEnvvarUnprivileged bool) Option {\n\treturn func(b *builder) error {\n\t\tb.acceptEnvvarUnprivileged = acceptEnvvarUnprivileged\n\t\treturn nil\n\t}\n}\n\nfunc WithAnnotations(annotations map[string]string) Option {\n\treturn func(b *builder) error {\n\t\tb.annotations = annotations\n\t\treturn nil\n\t}\n}\n\nfunc WithAnnotationsPrefixes(annotationsPrefixes ...string) Option {\n\treturn func(b *builder) error {\n\t\tb.annotationsPrefixes = annotationsPrefixes\n\t\treturn nil\n\t}\n}\n\n// WithDisableRequire sets the disable require option.\nfunc WithDisableRequire(disableRequire bool) Option {\n\treturn func(b *builder) error {\n\t\tb.disableRequire = disableRequire\n\t\treturn nil\n\t}\n}\n\n// WithEnv sets the environment variables to use when creating the CUDA image.\n// Note that this also overwrites the values set with WithEnvMap.\nfunc WithEnv(env []string) Option {\n\treturn func(b *builder) error {\n\t\tenvmap := make(map[string]string)\n\t\tfor _, e := range env {\n\t\t\tparts := strings.SplitN(e, \"=\", 2)\n\t\t\tif len(parts) != 2 {\n\t\t\t\treturn fmt.Errorf(\"invalid environment variable: %v\", e)\n\t\t\t}\n\t\t\tenvmap[parts[0]] = parts[1]\n\t\t}\n\t\treturn WithEnvMap(envmap)(b)\n\t}\n}\n\n// WithEnvMap sets the environment variable map to use when creating the CUDA image.\n// Note that this also overwrites the values set with WithEnv.\nfunc WithEnvMap(env map[string]string) Option {\n\treturn func(b *builder) error {\n\t\tb.env = env\n\t\treturn nil\n\t}\n}\n\n// WithIgnoreImexChannelRequests sets whether per-container IMEX channel\n// requests are supported.\nfunc WithIgnoreImexChannelRequests(ignoreImexChannelRequests bool) Option {\n\treturn func(b *builder) error {\n\t\tb.ignoreImexChannelRequests = ignoreImexChannelRequests\n\t\treturn nil\n\t}\n}\n\n// WithLogger sets the logger to use when creating the CUDA image.\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(b *builder) error {\n\t\tb.logger = logger\n\t\treturn nil\n\t}\n}\n\n// WithMounts sets the mounts associated with the CUDA image.\nfunc WithMounts(mounts []specs.Mount) Option {\n\treturn func(b *builder) error {\n\t\tb.mounts = mounts\n\t\treturn nil\n\t}\n}\n\n// WithPreferredVisibleDevicesEnvVars sets the environment variables that\n// should take precedence over the default NVIDIA_VISIBLE_DEVICES.\nfunc WithPreferredVisibleDevicesEnvVars(preferredVisibleDeviceEnvVars ...string) Option {\n\treturn func(b *builder) error {\n\t\tvar normalized []string\n\t\tfor _, e := range preferredVisibleDeviceEnvVars {\n\t\t\tcandidates := strings.Split(e, \",\")\n\t\t\tfor _, c := range candidates {\n\t\t\t\ttrimmed := strings.TrimSpace(c)\n\t\t\t\tif len(trimmed) > 0 {\n\t\t\t\t\tnormalized = append(normalized, trimmed)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tb.preferredVisibleDeviceEnvVars = normalized\n\t\treturn nil\n\t}\n}\n\n// WithPrivileged sets whether an image is privileged or not.\nfunc WithPrivileged(isPrivileged bool) Option {\n\treturn func(b *builder) error {\n\t\tb.isPrivileged = isPrivileged\n\t\treturn nil\n\t}\n}\n"
},
{
"path": "internal/config/image/capabilities.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nimport (\n\t\"sort\"\n\t\"strings\"\n)\n\n// DriverCapability represents the possible values of NVIDIA_DRIVER_CAPABILITIES\ntype DriverCapability string\n\n// Constants for the supported driver capabilities\nconst (\n\tDriverCapabilityAll DriverCapability = \"all\"\n\tDriverCapabilityNone DriverCapability = \"none\"\n\tDriverCapabilityCompat32 DriverCapability = \"compat32\"\n\tDriverCapabilityCompute DriverCapability = \"compute\"\n\tDriverCapabilityDisplay DriverCapability = \"display\"\n\tDriverCapabilityGraphics DriverCapability = \"graphics\"\n\tDriverCapabilityNgx DriverCapability = \"ngx\"\n\tDriverCapabilityUtility DriverCapability = \"utility\"\n\tDriverCapabilityVideo DriverCapability = \"video\"\n)\n\nvar (\n\tdriverCapabilitiesNone = NewDriverCapabilities()\n\tdriverCapabilitiesAll = NewDriverCapabilities(\"all\")\n\n\t// DefaultDriverCapabilities sets the value for driver capabilities if no value is set.\n\tDefaultDriverCapabilities = NewDriverCapabilities(\"utility,compute\")\n\t// SupportedDriverCapabilities defines the set of all supported driver capabilities.\n\tSupportedDriverCapabilities = NewDriverCapabilities(\"compute,compat32,graphics,utility,video,display,ngx\")\n)\n\n// NewDriverCapabilities creates a set of driver capabilities from the specified capabilities\nfunc NewDriverCapabilities(capabilities ...string) DriverCapabilities {\n\tdc := make(DriverCapabilities)\n\tfor _, capability := range capabilities {\n\t\tfor _, c := range strings.Split(capability, \",\") {\n\t\t\ttrimmed := strings.TrimSpace(c)\n\t\t\tif trimmed == \"\" {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tdc[DriverCapability(trimmed)] = true\n\t\t}\n\t}\n\treturn dc\n}\n\n// DriverCapabilities represents the NVIDIA_DRIVER_CAPABILITIES set for the specified image.\ntype DriverCapabilities map[DriverCapability]bool\n\n// Has check whether the specified capability is selected.\nfunc (c DriverCapabilities) Has(capability DriverCapability) bool {\n\tif c.IsAll() {\n\t\treturn true\n\t}\n\treturn c[capability]\n}\n\n// Any checks whether any of the specified capabilities are set\nfunc (c DriverCapabilities) Any(capabilities ...DriverCapability) bool {\n\tif c.IsAll() {\n\t\treturn true\n\t}\n\tfor _, cap := range capabilities {\n\t\tif c.Has(cap) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\n// List returns the list of driver capabilities.\n// The list is sorted.\nfunc (c DriverCapabilities) List() []string {\n\tvar capabilities []string\n\tfor capability := range c {\n\t\tcapabilities = append(capabilities, string(capability))\n\t}\n\tsort.Strings(capabilities)\n\treturn capabilities\n}\n\n// String returns the string repesentation of the driver capabilities.\nfunc (c DriverCapabilities) String() string {\n\tif c.IsAll() {\n\t\treturn \"all\"\n\t}\n\treturn strings.Join(c.List(), \",\")\n}\n\n// IsAll indicates whether the set of capabilities is `all`\nfunc (c DriverCapabilities) IsAll() bool {\n\treturn c[DriverCapabilityAll]\n}\n\n// Intersection returns a new set which includes the item in BOTH d and s2.\n// For example: d = {a1, a2} s2 = {a2, a3} s1.Intersection(s2) = {a2}\nfunc (c DriverCapabilities) Intersection(s2 DriverCapabilities) DriverCapabilities {\n\tif s2.IsAll() {\n\t\treturn c\n\t}\n\tif c.IsAll() {\n\t\treturn s2\n\t}\n\n\tintersection := make(DriverCapabilities)\n\tfor capability := range s2 {\n\t\tif c[capability] {\n\t\t\tintersection[capability] = true\n\t\t}\n\t}\n\n\treturn intersection\n}\n\n// IsSuperset returns true if and only if d is a superset of s2.\nfunc (c DriverCapabilities) IsSuperset(s2 DriverCapabilities) bool {\n\tif c.IsAll() {\n\t\treturn true\n\t}\n\n\tfor capability := range s2 {\n\t\tif !c[capability] {\n\t\t\treturn false\n\t\t}\n\t}\n\n\treturn true\n}\n"
},
{
"path": "internal/config/image/capabilities_test.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestDriverCapabilitiesIntersection(t *testing.T) {\n\ttestCases := []struct {\n\t\tcapabilities DriverCapabilities\n\t\tsupportedCapabilities DriverCapabilities\n\t\texpectedIntersection DriverCapabilities\n\t}{\n\t\t{\n\t\t\tcapabilities: driverCapabilitiesNone,\n\t\t\tsupportedCapabilities: driverCapabilitiesNone,\n\t\t\texpectedIntersection: driverCapabilitiesNone,\n\t\t},\n\t\t{\n\t\t\tcapabilities: driverCapabilitiesAll,\n\t\t\tsupportedCapabilities: driverCapabilitiesNone,\n\t\t\texpectedIntersection: driverCapabilitiesNone,\n\t\t},\n\t\t{\n\t\t\tcapabilities: driverCapabilitiesAll,\n\t\t\tsupportedCapabilities: SupportedDriverCapabilities,\n\t\t\texpectedIntersection: SupportedDriverCapabilities,\n\t\t},\n\t\t{\n\t\t\tcapabilities: SupportedDriverCapabilities,\n\t\t\tsupportedCapabilities: driverCapabilitiesAll,\n\t\t\texpectedIntersection: SupportedDriverCapabilities,\n\t\t},\n\t\t{\n\t\t\tcapabilities: driverCapabilitiesNone,\n\t\t\tsupportedCapabilities: driverCapabilitiesAll,\n\t\t\texpectedIntersection: driverCapabilitiesNone,\n\t\t},\n\t\t{\n\t\t\tcapabilities: driverCapabilitiesNone,\n\t\t\tsupportedCapabilities: NewDriverCapabilities(\"cap1\"),\n\t\t\texpectedIntersection: driverCapabilitiesNone,\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\"cap0,cap1\"),\n\t\t\tsupportedCapabilities: NewDriverCapabilities(\"cap1,cap0\"),\n\t\t\texpectedIntersection: NewDriverCapabilities(\"cap0,cap1\"),\n\t\t},\n\t\t{\n\t\t\tcapabilities: DefaultDriverCapabilities,\n\t\t\tsupportedCapabilities: SupportedDriverCapabilities,\n\t\t\texpectedIntersection: DefaultDriverCapabilities,\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\"compute,compat32,graphics,utility,video,display\"),\n\t\t\tsupportedCapabilities: NewDriverCapabilities(\"compute,compat32,graphics,utility,video,display,ngx\"),\n\t\t\texpectedIntersection: NewDriverCapabilities(\"compute,compat32,graphics,utility,video,display\"),\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\"cap1\"),\n\t\t\tsupportedCapabilities: driverCapabilitiesNone,\n\t\t\texpectedIntersection: driverCapabilitiesNone,\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\"compute,compat32,graphics,utility,video,display,ngx\"),\n\t\t\tsupportedCapabilities: NewDriverCapabilities(\"compute,compat32,graphics,utility,video,display\"),\n\t\t\texpectedIntersection: NewDriverCapabilities(\"compute,compat32,graphics,utility,video,display\"),\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"test case %d\", i), func(t *testing.T) {\n\t\t\tintersection := tc.supportedCapabilities.Intersection(tc.capabilities)\n\t\t\trequire.EqualValues(t, tc.expectedIntersection, intersection)\n\t\t})\n\t}\n}\n\nfunc TestDriverCapabilitiesList(t *testing.T) {\n\ttestCases := []struct {\n\t\tcapabilities DriverCapabilities\n\t\texpected []string\n\t}{\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\"\"),\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\" \"),\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\",\"),\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\",cap\"),\n\t\t\texpected: []string{\"cap\"},\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\"cap,\"),\n\t\t\texpected: []string{\"cap\"},\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\"cap0,,cap1\"),\n\t\t\texpected: []string{\"cap0\", \"cap1\"},\n\t\t},\n\t\t{\n\t\t\tcapabilities: NewDriverCapabilities(\"cap1,cap0,cap3\"),\n\t\t\texpected: []string{\"cap0\", \"cap1\", \"cap3\"},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"test case %d\", i), func(t *testing.T) {\n\t\t\trequire.EqualValues(t, tc.expected, tc.capabilities.List())\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/config/image/cuda_image.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"slices\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\t\"golang.org/x/mod/semver\"\n\t\"tags.cncf.io/container-device-interface/pkg/parser\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\nconst (\n\tDeviceListAsVolumeMountsRoot = \"/var/run/nvidia-container-devices\"\n\n\tvolumeMountDevicePrefixCDI = \"cdi/\"\n\tvolumeMountDevicePrefixImex = \"imex/\"\n)\n\n// CUDA represents a CUDA image that can be used for GPU computing. This wraps\n// a map of environment variable to values that can be used to perform lookups\n// such as requirements.\ntype CUDA struct {\n\tlogger logger.Interface\n\n\tannotations map[string]string\n\tenv map[string]string\n\tisPrivileged bool\n\tmounts []specs.Mount\n\n\tannotationsPrefixes []string\n\tacceptDeviceListAsVolumeMounts bool\n\tacceptEnvvarUnprivileged bool\n\tignoreImexChannelRequests bool\n\tpreferredVisibleDeviceEnvVars []string\n}\n\n// NewCUDAImageFromSpec creates a CUDA image from the input OCI runtime spec.\n// The process environment is read (if present) to construc the CUDA Image.\nfunc NewCUDAImageFromSpec(spec *specs.Spec, opts ...Option) (CUDA, error) {\n\tif spec == nil {\n\t\treturn New(opts...)\n\t}\n\n\tvar env []string\n\tif spec.Process != nil {\n\t\tenv = spec.Process.Env\n\t}\n\n\tspecOpts := []Option{\n\t\tWithAnnotations(spec.Annotations),\n\t\tWithEnv(env),\n\t\tWithMounts(spec.Mounts),\n\t\tWithPrivileged(IsPrivileged((*OCISpec)(spec))),\n\t}\n\n\treturn New(append(opts, specOpts...)...)\n}\n\n// newCUDAImageFromEnv creates a CUDA image from the input environment. The environment\n// is a list of strings of the form ENVAR=VALUE.\nfunc newCUDAImageFromEnv(env []string) (CUDA, error) {\n\treturn New(WithEnv(env))\n}\n\n// Getenv returns the value of the specified environment variable.\n// If the environment variable is not specified, an empty string is returned.\nfunc (i CUDA) Getenv(key string) string {\n\treturn i.env[key]\n}\n\n// HasEnvvar checks whether the specified envvar is defined in the image.\nfunc (i CUDA) HasEnvvar(key string) bool {\n\t_, exists := i.env[key]\n\treturn exists\n}\n\n// IsLegacy returns whether the associated CUDA image is a \"legacy\" image. An\n// image is considered legacy if it has a CUDA_VERSION environment variable defined\n// and no NVIDIA_REQUIRE_CUDA environment variable defined.\nfunc (i CUDA) IsLegacy() bool {\n\tlegacyCudaVersion := i.env[EnvVarCudaVersion]\n\tcudaRequire := i.env[EnvVarNvidiaRequireCuda]\n\treturn len(legacyCudaVersion) > 0 && len(cudaRequire) == 0\n}\n\nfunc (i CUDA) IsPrivileged() bool {\n\treturn i.isPrivileged\n}\n\n// GetRequirements returns the requirements from all NVIDIA_REQUIRE_ environment\n// variables.\nfunc (i CUDA) GetRequirements() ([]string, error) {\n\tif i.HasDisableRequire() {\n\t\treturn nil, nil\n\t}\n\n\t// All variables with the \"NVIDIA_REQUIRE_\" prefix are passed to nvidia-container-cli\n\tvar requirements []string\n\tfor name, value := range i.env {\n\t\tif strings.HasPrefix(name, NvidiaRequirePrefix) && !strings.HasPrefix(name, EnvVarNvidiaRequireJetpack) {\n\t\t\trequirements = append(requirements, value)\n\t\t}\n\t}\n\tif i.IsLegacy() {\n\t\tv, err := i.legacyVersion()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to get version: %v\", err)\n\t\t}\n\t\tcudaRequire := fmt.Sprintf(\"cuda>=%s\", v)\n\t\trequirements = append(requirements, cudaRequire)\n\t}\n\treturn requirements, nil\n}\n\n// HasDisableRequire checks for the value of the NVIDIA_DISABLE_REQUIRE. If set\n// to a valid (true) boolean value this can be used to disable the requirement checks\nfunc (i CUDA) HasDisableRequire() bool {\n\tif disable, exists := i.env[EnvVarNvidiaDisableRequire]; exists {\n\t\t// i.logger.Debugf(\"NVIDIA_DISABLE_REQUIRE=%v; skipping requirement checks\", disable)\n\t\td, _ := strconv.ParseBool(disable)\n\t\treturn d\n\t}\n\n\treturn false\n}\n\n// devicesFromEnvvars returns the devices requested by the image through environment variables\nfunc (i CUDA) devicesFromEnvvars(envVars ...string) []string {\n\t// We concantenate all the devices from the specified env.\n\tvar isSet bool\n\tvar devices []string\n\trequested := make(map[string]bool)\n\tfor _, envVar := range envVars {\n\t\tif devs, ok := i.env[envVar]; ok {\n\t\t\tisSet = true\n\t\t\tfor _, d := range strings.Split(devs, \",\") {\n\t\t\t\ttrimmed := strings.TrimSpace(d)\n\t\t\t\tif len(trimmed) == 0 {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tdevices = append(devices, trimmed)\n\t\t\t\trequested[trimmed] = true\n\t\t\t}\n\t\t}\n\t}\n\n\t// Environment variable unset with legacy image: default to \"all\".\n\tif !isSet && len(devices) == 0 && i.IsLegacy() {\n\t\tdevices = []string{\"all\"}\n\t}\n\n\t// Environment variable unset or empty or \"void\": return nil\n\tif len(devices) == 0 || requested[\"void\"] {\n\t\tdevices = []string{\"void\"}\n\t}\n\n\treturn NewVisibleDevices(devices...).List()\n}\n\n// GetDriverCapabilities returns the requested driver capabilities.\nfunc (i CUDA) GetDriverCapabilities() DriverCapabilities {\n\tenv := i.env[EnvVarNvidiaDriverCapabilities]\n\n\tcapabilities := make(DriverCapabilities)\n\tfor _, c := range strings.Split(env, \",\") {\n\t\tcapabilities[DriverCapability(c)] = true\n\t}\n\n\treturn capabilities\n}\n\nfunc (i CUDA) legacyVersion() (string, error) {\n\tcudaVersion := i.env[EnvVarCudaVersion]\n\tmajorMinor, err := parseMajorMinorVersion(cudaVersion)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"invalid CUDA version %v: %v\", cudaVersion, err)\n\t}\n\n\treturn majorMinor, nil\n}\n\nfunc parseMajorMinorVersion(version string) (string, error) {\n\tvVersion := \"v\" + strings.TrimPrefix(version, \"v\")\n\n\tif !semver.IsValid(vVersion) {\n\t\treturn \"\", fmt.Errorf(\"invalid version string\")\n\t}\n\n\tmajorMinor := strings.TrimPrefix(semver.MajorMinor(vVersion), \"v\")\n\tparts := strings.Split(majorMinor, \".\")\n\n\tvar err error\n\t_, err = strconv.ParseUint(parts[0], 10, 32)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"invalid major version\")\n\t}\n\t_, err = strconv.ParseUint(parts[1], 10, 32)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"invalid minor version\")\n\t}\n\treturn majorMinor, nil\n}\n\n// OnlyFullyQualifiedCDIDevices returns true if all devices requested in the image are requested as CDI devices/\nfunc (i CUDA) OnlyFullyQualifiedCDIDevices() bool {\n\tvar hasCDIdevice bool\n\tfor _, device := range i.VisibleDevices() {\n\t\tif !parser.IsQualifiedName(device) {\n\t\t\treturn false\n\t\t}\n\t\thasCDIdevice = true\n\t}\n\treturn hasCDIdevice\n}\n\n// visibleEnvVars returns the environment variables that are used to determine device visibility.\n// It returns the preferred environment variables that are set, or NVIDIA_VISIBLE_DEVICES if none are set.\nfunc (i CUDA) visibleEnvVars() []string {\n\tvar envVars []string\n\tfor _, envVar := range i.preferredVisibleDeviceEnvVars {\n\t\tif !i.HasEnvvar(envVar) {\n\t\t\tcontinue\n\t\t}\n\t\tenvVars = append(envVars, envVar)\n\t}\n\tif len(envVars) > 0 {\n\t\treturn envVars\n\t}\n\treturn []string{EnvVarNvidiaVisibleDevices}\n}\n\n// VisibleDevices returns a list of devices requested in the container image.\n// If volume mount requests are enabled these are returned if requested,\n// otherwise device requests through environment variables are considered.\n// In cases where environment variable requests required privileged containers,\n// such devices requests are ignored.\nfunc (i CUDA) VisibleDevices() []string {\n\t// If annotation device requests are present, these are preferred.\n\tannotationDeviceRequests := i.cdiDeviceRequestsFromAnnotations()\n\tif len(annotationDeviceRequests) > 0 {\n\t\treturn annotationDeviceRequests\n\t}\n\n\t// If enabled, try and get the device list from volume mounts first\n\tif i.acceptDeviceListAsVolumeMounts {\n\t\tvolumeMountDeviceRequests := i.visibleDevicesFromMounts()\n\t\tif len(volumeMountDeviceRequests) > 0 {\n\t\t\treturn volumeMountDeviceRequests\n\t\t}\n\t}\n\n\t// Get the Fallback to reading from the environment variable if privileges are correct\n\tenvVarDeviceRequests := i.visibleDevicesFromEnvVar()\n\tif len(envVarDeviceRequests) == 0 {\n\t\treturn nil\n\t}\n\n\t// If the container is privileged, or environment variable requests are\n\t// allowed for unprivileged containers, these devices are returned.\n\tif i.isPrivileged || i.acceptEnvvarUnprivileged {\n\t\treturn envVarDeviceRequests\n\t}\n\n\t// We log a warning if we are ignoring the environment variable requests.\n\tenvVars := i.visibleEnvVars()\n\tif len(envVars) > 0 {\n\t\ti.logger.Warningf(\"Ignoring devices requested by environment variable(s) in unprivileged container: %v\", envVars)\n\t}\n\n\treturn nil\n}\n\n// cdiDeviceRequestsFromAnnotations returns a list of devices specified in the\n// annotations.\n// Keys starting with the specified prefixes are considered and expected to\n// contain a comma-separated list of fully-qualified CDI devices names.\n// The format of the requested devices is not checked and the list is not\n// deduplicated.\nfunc (i CUDA) cdiDeviceRequestsFromAnnotations() []string {\n\tif len(i.annotationsPrefixes) == 0 || len(i.annotations) == 0 {\n\t\treturn nil\n\t}\n\n\tvar annotationKeys []string\n\tfor key := range i.annotations {\n\t\tfor _, prefix := range i.annotationsPrefixes {\n\t\t\tif strings.HasPrefix(key, prefix) {\n\t\t\t\tannotationKeys = append(annotationKeys, key)\n\t\t\t\t// There is no need to check additional prefixes since we\n\t\t\t\t// typically deduplicate devices in any case.\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\t// We sort the annotationKeys for consistent results.\n\tslices.Sort(annotationKeys)\n\n\tvar devices []string\n\tfor _, key := range annotationKeys {\n\t\tdevices = append(devices, strings.Split(i.annotations[key], \",\")...)\n\t}\n\treturn devices\n}\n\n// visibleDevicesFromEnvVar returns the set of visible devices requested through environment variables.\n// If any of the preferredVisibleDeviceEnvVars are present in the image, they\n// are used to determine the visible devices. If this is not the case, the\n// NVIDIA_VISIBLE_DEVICES environment variable is used.\nfunc (i CUDA) visibleDevicesFromEnvVar() []string {\n\tenvVars := i.visibleEnvVars()\n\treturn i.devicesFromEnvvars(envVars...)\n}\n\n// visibleDevicesFromMounts returns the set of visible devices requested as mounts.\nfunc (i CUDA) visibleDevicesFromMounts() []string {\n\tvar devices []string\n\tfor _, device := range i.requestsFromMounts() {\n\t\tswitch {\n\t\tcase strings.HasPrefix(device, volumeMountDevicePrefixImex):\n\t\t\tcontinue\n\t\tcase strings.HasPrefix(device, volumeMountDevicePrefixCDI):\n\t\t\tname, err := cdiDeviceMountRequest(device).qualifiedName()\n\t\t\tif err != nil {\n\t\t\t\ti.logger.Warningf(\"Ignoring invalid mount request for CDI device %v: %v\", device, err)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tdevices = append(devices, name)\n\t\tdefault:\n\t\t\tdevices = append(devices, device)\n\t\t}\n\n\t}\n\treturn devices\n}\n\n// requestsFromMounts returns a list of device specified as mounts.\nfunc (i CUDA) requestsFromMounts() []string {\n\troot := filepath.Clean(DeviceListAsVolumeMountsRoot)\n\tseen := make(map[string]bool)\n\tvar devices []string\n\tfor _, m := range i.mounts {\n\t\tsource := filepath.Clean(m.Source)\n\t\t// Only consider mounts who's host volume is /dev/null\n\t\tif source != \"/dev/null\" {\n\t\t\tcontinue\n\t\t}\n\n\t\tdestination := filepath.Clean(m.Destination)\n\t\tif seen[destination] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[destination] = true\n\n\t\t// Only consider container mount points that begin with 'root'\n\t\tif !strings.HasPrefix(destination, root) {\n\t\t\tcontinue\n\t\t}\n\n\t\t// Grab the full path beyond 'root' and add it to the list of devices\n\t\tdevice := strings.Trim(strings.TrimPrefix(destination, root), \"/\")\n\t\tif len(device) == 0 {\n\t\t\tcontinue\n\t\t}\n\t\tdevices = append(devices, device)\n\t}\n\treturn devices\n}\n\n// a cdiDeviceMountRequest represents a CDI device requests as a mount.\n// Here the host path /dev/null is mounted to a particular path in the container.\n// The container path has the form:\n// /var/run/nvidia-container-devices/cdi///\n// or\n// /var/run/nvidia-container-devices/cdi//=\ntype cdiDeviceMountRequest string\n\n// qualifiedName returns the fully-qualified name of the CDI device.\nfunc (m cdiDeviceMountRequest) qualifiedName() (string, error) {\n\tif !strings.HasPrefix(string(m), volumeMountDevicePrefixCDI) {\n\t\treturn \"\", fmt.Errorf(\"invalid mount CDI device request: %s\", m)\n\t}\n\n\trequestedDevice := strings.TrimPrefix(string(m), volumeMountDevicePrefixCDI)\n\tif parser.IsQualifiedName(requestedDevice) {\n\t\treturn requestedDevice, nil\n\t}\n\n\tparts := strings.SplitN(requestedDevice, \"/\", 3)\n\tif len(parts) != 3 {\n\t\treturn \"\", fmt.Errorf(\"invalid mount CDI device request: %s\", m)\n\t}\n\treturn fmt.Sprintf(\"%s/%s=%s\", parts[0], parts[1], parts[2]), nil\n}\n\nfunc (i CUDA) ImexChannelRequests() []string {\n\tif i.ignoreImexChannelRequests {\n\t\treturn nil\n\t}\n\n\t// If enabled, try and get the device list from volume mounts first\n\tif i.acceptDeviceListAsVolumeMounts {\n\t\tvolumeMountDeviceRequests := i.imexChannelsFromMounts()\n\t\tif len(volumeMountDeviceRequests) > 0 {\n\t\t\treturn volumeMountDeviceRequests\n\t\t}\n\t}\n\n\t// Get the Fallback to reading from the environment variable if privileges are correct\n\tenvVarDeviceRequests := i.imexChannelsFromEnvVar()\n\tif len(envVarDeviceRequests) == 0 {\n\t\treturn nil\n\t}\n\n\t// If the container is privileged, or environment variable requests are\n\t// allowed for unprivileged containers, these devices are returned.\n\tif i.isPrivileged || i.acceptEnvvarUnprivileged {\n\t\treturn envVarDeviceRequests\n\t}\n\n\t// We log a warning if we are ignoring the environment variable requests.\n\tenvVars := []string{EnvVarNvidiaImexChannels}\n\tif len(envVars) > 0 {\n\t\ti.logger.Warningf(\"Ignoring request by environment variable(s) in unprivileged container: %v\", envVars)\n\t}\n\n\treturn nil\n}\n\n// imexChannelsFromEnvVar returns the list of IMEX channels requested for the image.\nfunc (i CUDA) imexChannelsFromEnvVar() []string {\n\timexChannels := i.devicesFromEnvvars(EnvVarNvidiaImexChannels)\n\tif len(imexChannels) == 1 && imexChannels[0] == \"all\" {\n\t\treturn nil\n\t}\n\treturn imexChannels\n}\n\n// imexChannelsFromMounts returns the list of IMEX channels requested for the image.\nfunc (i CUDA) imexChannelsFromMounts() []string {\n\tvar channels []string\n\tfor _, mountDevice := range i.requestsFromMounts() {\n\t\tif !strings.HasPrefix(mountDevice, volumeMountDevicePrefixImex) {\n\t\t\tcontinue\n\t\t}\n\t\tchannels = append(channels, strings.TrimPrefix(mountDevice, volumeMountDevicePrefixImex))\n\t}\n\treturn channels\n}\n"
},
{
"path": "internal/config/image/cuda_image_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNewCUDAImageFromSpec(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tspec *specs.Spec\n\t\toptions []Option\n\t\texpected CUDA\n\t}{\n\t\t{\n\t\t\tdescription: \"no env vars\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: CUDA{\n\t\t\t\tlogger: logger,\n\t\t\t\tenv: map[string]string{},\n\t\t\t\tacceptEnvvarUnprivileged: true,\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_VISIBLE_DEVICES=all\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=all\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: CUDA{\n\t\t\t\tlogger: logger,\n\t\t\t\tenv: map[string]string{\"NVIDIA_VISIBLE_DEVICES\": \"all\"},\n\t\t\t\tacceptEnvvarUnprivileged: true,\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Spec overrides options\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=all\"},\n\t\t\t\t},\n\t\t\t\tMounts: []specs.Mount{\n\t\t\t\t\t{\n\t\t\t\t\t\tSource: \"/spec-source\",\n\t\t\t\t\t\tDestination: \"/spec-destination\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\toptions: []Option{\n\t\t\t\tWithEnvMap(map[string]string{\"OTHER\": \"value\"}),\n\t\t\t\tWithMounts([]specs.Mount{\n\t\t\t\t\t{\n\t\t\t\t\t\tSource: \"/option-source\",\n\t\t\t\t\t\tDestination: \"/option-destination\",\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t},\n\t\t\texpected: CUDA{\n\t\t\t\tlogger: logger,\n\t\t\t\tenv: map[string]string{\"NVIDIA_VISIBLE_DEVICES\": \"all\"},\n\t\t\t\tmounts: []specs.Mount{\n\t\t\t\t\t{\n\t\t\t\t\t\tSource: \"/spec-source\",\n\t\t\t\t\t\tDestination: \"/spec-destination\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tacceptEnvvarUnprivileged: true,\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\toptions := append([]Option{WithLogger(logger)}, tc.options...)\n\t\t\timage, err := NewCUDAImageFromSpec(tc.spec, options...)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expected, image)\n\t\t})\n\t}\n}\n\nfunc TestParseMajorMinorVersionValid(t *testing.T) {\n\tvar tests = []struct {\n\t\tversion string\n\t\texpected string\n\t}{\n\t\t{\"0\", \"0.0\"},\n\t\t{\"8\", \"8.0\"},\n\t\t{\"7.5\", \"7.5\"},\n\t\t{\"9.0.116\", \"9.0\"},\n\t\t{\"4294967295.4294967295.4294967295\", \"4294967295.4294967295\"},\n\t\t{\"v11.6\", \"11.6\"},\n\t}\n\tfor _, c := range tests {\n\t\tt.Run(c.version, func(t *testing.T) {\n\t\t\tversion, err := parseMajorMinorVersion(c.version)\n\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, c.expected, version)\n\t\t})\n\t}\n}\n\nfunc TestParseMajorMinorVersionInvalid(t *testing.T) {\n\tvar tests = []string{\n\t\t\"foo\",\n\t\t\"foo.5.10\",\n\t\t\"9.0.116.50\",\n\t\t\"9.0.116foo\",\n\t\t\"7.foo\",\n\t\t\"9.0.bar\",\n\t\t\"9.4294967296\",\n\t\t\"9.0.116.\",\n\t\t\"9..0\",\n\t\t\"9.\",\n\t\t\".5.10\",\n\t\t\"-9\",\n\t\t\"+9\",\n\t\t\"-9.1.116\",\n\t\t\"-9.-1.-116\",\n\t}\n\tfor _, c := range tests {\n\t\tt.Run(c, func(t *testing.T) {\n\t\t\t_, err := parseMajorMinorVersion(c)\n\t\t\trequire.Error(t, err)\n\t\t})\n\t}\n}\n\nfunc TestGetRequirements(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tenv []string\n\t\trequirements []string\n\t}{\n\t\t{\n\t\t\tdescription: \"NVIDIA_REQUIRE_JETPACK is ignored\",\n\t\t\tenv: []string{\"NVIDIA_REQUIRE_JETPACK=csv-mounts=all\"},\n\t\t\trequirements: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_REQUIRE_JETPACK_HOST_MOUNTS is ignored\",\n\t\t\tenv: []string{\"NVIDIA_REQUIRE_JETPACK_HOST_MOUNTS=base-only\"},\n\t\t\trequirements: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"single requirement set\",\n\t\t\tenv: []string{\"NVIDIA_REQUIRE_CUDA=cuda>=11.6\"},\n\t\t\trequirements: []string{\"cuda>=11.6\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"requirements are concatenated requirement set\",\n\t\t\tenv: []string{\"NVIDIA_REQUIRE_CUDA=cuda>=11.6\", \"NVIDIA_REQUIRE_BRAND=brand=tesla\"},\n\t\t\trequirements: []string{\"cuda>=11.6\", \"brand=tesla\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"legacy image\",\n\t\t\tenv: []string{\"CUDA_VERSION=11.6\"},\n\t\t\trequirements: []string{\"cuda>=11.6\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"legacy image with additional requirement\",\n\t\t\tenv: []string{\"CUDA_VERSION=11.6\", \"NVIDIA_REQUIRE_BRAND=brand=tesla\"},\n\t\t\trequirements: []string{\"cuda>=11.6\", \"brand=tesla\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_DISABLE_REQUIRE ignores requirements\",\n\t\t\tenv: []string{\"NVIDIA_REQUIRE_CUDA=cuda>=11.6\", \"NVIDIA_REQUIRE_BRAND=brand=tesla\", \"NVIDIA_DISABLE_REQUIRE=true\"},\n\t\t\trequirements: []string{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_DISABLE_REQUIRE ignores legacy image requirements\",\n\t\t\tenv: []string{\"CUDA_VERSION=11.6\", \"NVIDIA_REQUIRE_BRAND=brand=tesla\", \"NVIDIA_DISABLE_REQUIRE=true\"},\n\t\t\trequirements: []string{},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\timage, err := newCUDAImageFromEnv(tc.env)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequirements, err := image.GetRequirements()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.ElementsMatch(t, tc.requirements, requirements)\n\t\t})\n\n\t}\n}\n\nfunc TestGetDevicesFromEnvvar(t *testing.T) {\n\tenvDockerResourceGPUs := \"DOCKER_RESOURCE_GPUS\"\n\tgpuID := \"GPU-12345\"\n\tanotherGPUID := \"GPU-67890\"\n\tthirdGPUID := \"MIG-12345\"\n\n\tvar tests = []struct {\n\t\tdescription string\n\t\tpreferredVisibleDeviceEnvVars []string\n\t\tenv map[string]string\n\t\texpectedDevices []string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty env returns nil for non-legacy image\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"blank NVIDIA_VISIBLE_DEVICES returns nil for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: \"\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"'void' NVIDIA_VISIBLE_DEVICES returns nil for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: \"void\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"'none' NVIDIA_VISIBLE_DEVICES returns empty for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: \"none\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_VISIBLE_DEVICES set returns value for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: gpuID,\n\t\t\t},\n\t\t\texpectedDevices: []string{gpuID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_VISIBLE_DEVICES set returns value for legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: gpuID,\n\t\t\t\tEnvVarCudaVersion: \"legacy\",\n\t\t\t},\n\t\t\texpectedDevices: []string{gpuID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty env returns all for legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarCudaVersion: \"legacy\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"all\"},\n\t\t},\n\t\t// Add the `DOCKER_RESOURCE_GPUS` envvar and ensure that this is ignored when\n\t\t// not enabled\n\t\t{\n\t\t\tdescription: \"missing NVIDIA_VISIBLE_DEVICES returns nil for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"blank NVIDIA_VISIBLE_DEVICES returns nil for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: \"\",\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"'void' NVIDIA_VISIBLE_DEVICES returns nil for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: \"void\",\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"'none' NVIDIA_VISIBLE_DEVICES returns empty for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: \"none\",\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t},\n\t\t\texpectedDevices: []string{\"\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_VISIBLE_DEVICES set returns value for non-legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: gpuID,\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t},\n\t\t\texpectedDevices: []string{gpuID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_VISIBLE_DEVICES set returns value for legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: gpuID,\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t\tEnvVarCudaVersion: \"legacy\",\n\t\t\t},\n\t\t\texpectedDevices: []string{gpuID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty env returns all for legacy image\",\n\t\t\tenv: map[string]string{\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t\tEnvVarCudaVersion: \"legacy\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"all\"},\n\t\t},\n\t\t// Add the `DOCKER_RESOURCE_GPUS` envvar and ensure that this is selected when\n\t\t// enabled\n\t\t{\n\t\t\tdescription: \"empty env returns nil for non-legacy image\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{envDockerResourceGPUs},\n\t\t},\n\t\t{\n\t\t\tdescription: \"blank DOCKER_RESOURCE_GPUS returns nil for non-legacy image\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{envDockerResourceGPUs},\n\t\t\tenv: map[string]string{\n\t\t\t\tenvDockerResourceGPUs: \"\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"'void' DOCKER_RESOURCE_GPUS returns nil for non-legacy image\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{envDockerResourceGPUs},\n\t\t\tenv: map[string]string{\n\t\t\t\tenvDockerResourceGPUs: \"void\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"'none' DOCKER_RESOURCE_GPUS returns empty for non-legacy image\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{envDockerResourceGPUs},\n\t\t\tenv: map[string]string{\n\t\t\t\tenvDockerResourceGPUs: \"none\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"DOCKER_RESOURCE_GPUS set returns value for non-legacy image\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{envDockerResourceGPUs},\n\t\t\tenv: map[string]string{\n\t\t\t\tenvDockerResourceGPUs: gpuID,\n\t\t\t},\n\t\t\texpectedDevices: []string{gpuID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"DOCKER_RESOURCE_GPUS set returns value for legacy image\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{envDockerResourceGPUs},\n\t\t\tenv: map[string]string{\n\t\t\t\tenvDockerResourceGPUs: gpuID,\n\t\t\t\tEnvVarCudaVersion: \"legacy\",\n\t\t\t},\n\t\t\texpectedDevices: []string{gpuID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"DOCKER_RESOURCE_GPUS is selected if present\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{envDockerResourceGPUs},\n\t\t\tenv: map[string]string{\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t},\n\t\t\texpectedDevices: []string{anotherGPUID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"DOCKER_RESOURCE_GPUS overrides NVIDIA_VISIBLE_DEVICES if present\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{envDockerResourceGPUs},\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: gpuID,\n\t\t\t\tenvDockerResourceGPUs: anotherGPUID,\n\t\t\t},\n\t\t\texpectedDevices: []string{anotherGPUID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"DOCKER_RESOURCE_GPUS_ADDITIONAL overrides NVIDIA_VISIBLE_DEVICES if present\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{\"DOCKER_RESOURCE_GPUS_ADDITIONAL\"},\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: gpuID,\n\t\t\t\t\"DOCKER_RESOURCE_GPUS_ADDITIONAL\": anotherGPUID,\n\t\t\t},\n\t\t\texpectedDevices: []string{anotherGPUID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"All available swarm resource envvars are selected and override NVIDIA_VISIBLE_DEVICES if present\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{\"DOCKER_RESOURCE_GPUS\", \"DOCKER_RESOURCE_GPUS_ADDITIONAL\"},\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: gpuID,\n\t\t\t\t\"DOCKER_RESOURCE_GPUS\": thirdGPUID,\n\t\t\t\t\"DOCKER_RESOURCE_GPUS_ADDITIONAL\": anotherGPUID,\n\t\t\t},\n\t\t\texpectedDevices: []string{thirdGPUID, anotherGPUID},\n\t\t},\n\t\t{\n\t\t\tdescription: \"DOCKER_RESOURCE_GPUS_ADDITIONAL or DOCKER_RESOURCE_GPUS override NVIDIA_VISIBLE_DEVICES if present\",\n\t\t\tpreferredVisibleDeviceEnvVars: []string{\"DOCKER_RESOURCE_GPUS\", \"DOCKER_RESOURCE_GPUS_ADDITIONAL\"},\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: gpuID,\n\t\t\t\t\"DOCKER_RESOURCE_GPUS_ADDITIONAL\": anotherGPUID,\n\t\t\t},\n\t\t\texpectedDevices: []string{anotherGPUID},\n\t\t},\n\t}\n\n\tfor _, tc := range tests {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\timage, err := New(\n\t\t\t\tWithEnvMap(tc.env),\n\t\t\t\tWithPrivileged(true),\n\t\t\t\tWithAcceptDeviceListAsVolumeMounts(false),\n\t\t\t\tWithAcceptEnvvarUnprivileged(false),\n\t\t\t\tWithPreferredVisibleDevicesEnvVars(tc.preferredVisibleDeviceEnvVars...),\n\t\t\t)\n\n\t\t\trequire.NoError(t, err)\n\t\t\tdevices := image.visibleDevicesFromEnvVar()\n\t\t\trequire.EqualValues(t, tc.expectedDevices, devices)\n\t\t})\n\t}\n}\n\nfunc TestGetVisibleDevicesFromMounts(t *testing.T) {\n\tvar tests = []struct {\n\t\tdescription string\n\t\tmounts []specs.Mount\n\t\texpectedDevices []string\n\t}{\n\t\t{\n\t\t\tdescription: \"No mounts\",\n\t\t\tmounts: nil,\n\t\t\texpectedDevices: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Host path is not /dev/null\",\n\t\t\tmounts: []specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tSource: \"/not/dev/null\",\n\t\t\t\t\tDestination: filepath.Join(DeviceListAsVolumeMountsRoot, \"GPU0\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Container path is not prefixed by 'root'\",\n\t\t\tmounts: []specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: filepath.Join(\"/other/prefix\", \"GPU0\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Container path is only 'root'\",\n\t\t\tmounts: []specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: DeviceListAsVolumeMountsRoot,\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Discover 2 devices\",\n\t\t\tmounts: makeTestMounts(\"GPU0\", \"GPU1\"),\n\t\t\texpectedDevices: []string{\"GPU0\", \"GPU1\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Discover 2 devices with slashes in the name\",\n\t\t\tmounts: makeTestMounts(\"GPU0-MIG0/0/1\", \"GPU1-MIG0/0/1\"),\n\t\t\texpectedDevices: []string{\"GPU0-MIG0/0/1\", \"GPU1-MIG0/0/1\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi devices are included\",\n\t\t\tmounts: makeTestMounts(\"GPU0\", \"nvidia.com/gpu=all\", \"GPU1\"),\n\t\t\texpectedDevices: []string{\"GPU0\", \"nvidia.com/gpu=all\", \"GPU1\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"imex devices are ignored\",\n\t\t\tmounts: makeTestMounts(\"GPU0\", \"imex/0\", \"GPU1\"),\n\t\t\texpectedDevices: []string{\"GPU0\", \"GPU1\"},\n\t\t},\n\t}\n\tfor _, tc := range tests {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\timage, err := New(WithMounts(tc.mounts))\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, tc.expectedDevices, image.visibleDevicesFromMounts())\n\t\t})\n\t}\n}\n\nfunc TestVisibleDevices(t *testing.T) {\n\tvar tests = []struct {\n\t\tdescription string\n\t\tmountDevices []specs.Mount\n\t\tenvvarDevices string\n\t\tprivileged bool\n\t\tacceptUnprivileged bool\n\t\tacceptMounts bool\n\t\tpreferredVisibleDeviceEnvVars []string\n\t\tenv map[string]string\n\t\texpectedDevices []string\n\t}{\n\t\t{\n\t\t\tdescription: \"Mount devices, unprivileged, no accept unprivileged\",\n\t\t\tmountDevices: []specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: filepath.Join(DeviceListAsVolumeMountsRoot, \"GPU0\"),\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: filepath.Join(DeviceListAsVolumeMountsRoot, \"GPU1\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tenvvarDevices: \"GPU2,GPU3\",\n\t\t\tprivileged: false,\n\t\t\tacceptUnprivileged: false,\n\t\t\tacceptMounts: true,\n\t\t\texpectedDevices: []string{\"GPU0\", \"GPU1\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"No mount devices, unprivileged, no accept unprivileged\",\n\t\t\tmountDevices: nil,\n\t\t\tenvvarDevices: \"GPU0,GPU1\",\n\t\t\tprivileged: false,\n\t\t\tacceptUnprivileged: false,\n\t\t\tacceptMounts: true,\n\t\t\texpectedDevices: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"No mount devices, privileged, no accept unprivileged\",\n\t\t\tmountDevices: nil,\n\t\t\tenvvarDevices: \"GPU0,GPU1\",\n\t\t\tprivileged: true,\n\t\t\tacceptUnprivileged: false,\n\t\t\tacceptMounts: true,\n\t\t\texpectedDevices: []string{\"GPU0\", \"GPU1\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"No mount devices, unprivileged, accept unprivileged\",\n\t\t\tmountDevices: nil,\n\t\t\tenvvarDevices: \"GPU0,GPU1\",\n\t\t\tprivileged: false,\n\t\t\tacceptUnprivileged: true,\n\t\t\tacceptMounts: true,\n\t\t\texpectedDevices: []string{\"GPU0\", \"GPU1\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Mount devices, unprivileged, accept unprivileged, no accept mounts\",\n\t\t\tmountDevices: []specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: filepath.Join(DeviceListAsVolumeMountsRoot, \"GPU0\"),\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: filepath.Join(DeviceListAsVolumeMountsRoot, \"GPU1\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tenvvarDevices: \"GPU2,GPU3\",\n\t\t\tprivileged: false,\n\t\t\tacceptUnprivileged: true,\n\t\t\tacceptMounts: false,\n\t\t\texpectedDevices: []string{\"GPU2\", \"GPU3\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"Mount devices, unprivileged, no accept unprivileged, no accept mounts\",\n\t\t\tmountDevices: []specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: filepath.Join(DeviceListAsVolumeMountsRoot, \"GPU0\"),\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: filepath.Join(DeviceListAsVolumeMountsRoot, \"GPU1\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tenvvarDevices: \"GPU2,GPU3\",\n\t\t\tprivileged: false,\n\t\t\tacceptUnprivileged: false,\n\t\t\tacceptMounts: false,\n\t\t\texpectedDevices: nil,\n\t\t},\n\t\t// New test cases for visibleEnvVars functionality\n\t\t{\n\t\t\tdescription: \"preferred env var set and present in env, privileged\",\n\t\t\tmountDevices: nil,\n\t\t\tenvvarDevices: \"\",\n\t\t\tprivileged: true,\n\t\t\tacceptUnprivileged: false,\n\t\t\tacceptMounts: true,\n\t\t\tpreferredVisibleDeviceEnvVars: []string{\"DOCKER_RESOURCE_GPUS\"},\n\t\t\tenv: map[string]string{\n\t\t\t\t\"DOCKER_RESOURCE_GPUS\": \"GPU-12345\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"GPU-12345\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"preferred env var set and present in env, unprivileged but accepted\",\n\t\t\tmountDevices: nil,\n\t\t\tenvvarDevices: \"\",\n\t\t\tprivileged: false,\n\t\t\tacceptUnprivileged: true,\n\t\t\tacceptMounts: true,\n\t\t\tpreferredVisibleDeviceEnvVars: []string{\"DOCKER_RESOURCE_GPUS\"},\n\t\t\tenv: map[string]string{\n\t\t\t\t\"DOCKER_RESOURCE_GPUS\": \"GPU-12345\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"GPU-12345\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"preferred env var set and present in env, unprivileged and not accepted\",\n\t\t\tmountDevices: nil,\n\t\t\tenvvarDevices: \"\",\n\t\t\tprivileged: false,\n\t\t\tacceptUnprivileged: false,\n\t\t\tacceptMounts: true,\n\t\t\tpreferredVisibleDeviceEnvVars: []string{\"DOCKER_RESOURCE_GPUS\"},\n\t\t\tenv: map[string]string{\n\t\t\t\t\"DOCKER_RESOURCE_GPUS\": \"GPU-12345\",\n\t\t\t},\n\t\t\texpectedDevices: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple preferred env vars, both present, privileged\",\n\t\t\tmountDevices: nil,\n\t\t\tenvvarDevices: \"\",\n\t\t\tprivileged: true,\n\t\t\tacceptUnprivileged: false,\n\t\t\tacceptMounts: true,\n\t\t\tpreferredVisibleDeviceEnvVars: []string{\"DOCKER_RESOURCE_GPUS\", \"DOCKER_RESOURCE_GPUS_ADDITIONAL\"},\n\t\t\tenv: map[string]string{\n\t\t\t\t\"DOCKER_RESOURCE_GPUS\": \"GPU-12345\",\n\t\t\t\t\"DOCKER_RESOURCE_GPUS_ADDITIONAL\": \"GPU-67890\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"GPU-12345\", \"GPU-67890\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"preferred env var not present, fallback to NVIDIA_VISIBLE_DEVICES, privileged\",\n\t\t\tmountDevices: nil,\n\t\t\tenvvarDevices: \"GPU-12345\",\n\t\t\tprivileged: true,\n\t\t\tacceptUnprivileged: false,\n\t\t\tacceptMounts: true,\n\t\t\tpreferredVisibleDeviceEnvVars: []string{\"DOCKER_RESOURCE_GPUS\"},\n\t\t\tenv: map[string]string{\n\t\t\t\tEnvVarNvidiaVisibleDevices: \"GPU-12345\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"GPU-12345\"},\n\t\t},\n\t}\n\tfor _, tc := range tests {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\t// Create env map with both NVIDIA_VISIBLE_DEVICES and any additional env vars\n\t\t\tenv := make(map[string]string)\n\t\t\tif tc.envvarDevices != \"\" {\n\t\t\t\tenv[EnvVarNvidiaVisibleDevices] = tc.envvarDevices\n\t\t\t}\n\t\t\tfor k, v := range tc.env {\n\t\t\t\tenv[k] = v\n\t\t\t}\n\n\t\t\timage, err := New(\n\t\t\t\tWithEnvMap(env),\n\t\t\t\tWithMounts(tc.mountDevices),\n\t\t\t\tWithPrivileged(tc.privileged),\n\t\t\t\tWithAcceptDeviceListAsVolumeMounts(tc.acceptMounts),\n\t\t\t\tWithAcceptEnvvarUnprivileged(tc.acceptUnprivileged),\n\t\t\t\tWithPreferredVisibleDevicesEnvVars(tc.preferredVisibleDeviceEnvVars...),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, tc.expectedDevices, image.VisibleDevices())\n\t\t})\n\t}\n}\n\nfunc TestImexChannelsFromEnvVar(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tenv []string\n\t\texpected []string\n\t}{\n\t\t{\n\t\t\tdescription: \"no imex channels specified\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"imex channel specified\",\n\t\t\tenv: []string{\n\t\t\t\t\"NVIDIA_IMEX_CHANNELS=3,4\",\n\t\t\t},\n\t\t\texpected: []string{\"3\", \"4\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tfor id, baseEnvvars := range map[string][]string{\"\": nil, \"legacy\": {\"CUDA_VERSION=1.2.3\"}} {\n\t\t\tt.Run(tc.description+id, func(t *testing.T) {\n\t\t\t\ti, err := newCUDAImageFromEnv(append(baseEnvvars, tc.env...))\n\t\t\t\trequire.NoError(t, err)\n\n\t\t\t\tchannels := i.imexChannelsFromEnvVar()\n\t\t\t\trequire.EqualValues(t, tc.expected, channels)\n\t\t\t})\n\t\t}\n\t}\n}\n\nfunc TestCDIDeviceRequestsFromAnnotations(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tprefixes []string\n\t\tannotations map[string]string\n\t\texpectedDevices []string\n\t}{\n\t\t{\n\t\t\tdescription: \"no annotations\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"no matching annotations\",\n\t\t\tprefixes: []string{\"not-prefix/\"},\n\t\t\tannotations: map[string]string{\n\t\t\t\t\"prefix/foo\": \"example.com/device=bar\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"single matching annotation\",\n\t\t\tprefixes: []string{\"prefix/\"},\n\t\t\tannotations: map[string]string{\n\t\t\t\t\"prefix/foo\": \"example.com/device=bar\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"example.com/device=bar\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple matching annotations\",\n\t\t\tprefixes: []string{\"prefix/\", \"another-prefix/\"},\n\t\t\tannotations: map[string]string{\n\t\t\t\t\"prefix/foo\": \"example.com/device=bar\",\n\t\t\t\t\"another-prefix/bar\": \"example.com/device=baz\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"example.com/device=bar\", \"example.com/device=baz\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple matching annotations with duplicate devices\",\n\t\t\tprefixes: []string{\"prefix/\", \"another-prefix/\"},\n\t\t\tannotations: map[string]string{\n\t\t\t\t\"prefix/foo\": \"example.com/device=bar\",\n\t\t\t\t\"another-prefix/bar\": \"example.com/device=bar\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"example.com/device=bar\", \"example.com/device=bar\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"invalid devices are returned as is\",\n\t\t\tprefixes: []string{\"prefix/\"},\n\t\t\tannotations: map[string]string{\n\t\t\t\t\"prefix/foo\": \"example.com/device\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"example.com/device\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\timage, err := New(\n\t\t\t\tWithAnnotationsPrefixes(tc.prefixes...),\n\t\t\t\tWithAnnotations(tc.annotations),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevices := image.cdiDeviceRequestsFromAnnotations()\n\t\t\trequire.ElementsMatch(t, tc.expectedDevices, devices)\n\t\t})\n\t}\n}\n\nfunc makeTestMounts(paths ...string) []specs.Mount {\n\tvar mounts []specs.Mount\n\tfor _, path := range paths {\n\t\tmount := specs.Mount{\n\t\t\tSource: \"/dev/null\",\n\t\t\tDestination: filepath.Join(DeviceListAsVolumeMountsRoot, path),\n\t\t}\n\t\tmounts = append(mounts, mount)\n\t}\n\treturn mounts\n}\n"
},
{
"path": "internal/config/image/devices.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nimport (\n\t\"strings\"\n)\n\n// VisibleDevices represents the devices selected in a container image\n// through the NVIDIA_VISIBLE_DEVICES or other environment variables\ntype VisibleDevices interface {\n\tList() []string\n\tHas(string) bool\n}\n\nvar _ VisibleDevices = (*all)(nil)\nvar _ VisibleDevices = (*none)(nil)\nvar _ VisibleDevices = (*void)(nil)\nvar _ VisibleDevices = (*devices)(nil)\n\n// NewVisibleDevices creates a VisibleDevices based on the value of the specified envvar.\nfunc NewVisibleDevices(envvars ...string) VisibleDevices {\n\tfor _, envvar := range envvars {\n\t\tif envvar == \"all\" {\n\t\t\treturn all{}\n\t\t}\n\t\tif envvar == \"none\" {\n\t\t\treturn none{}\n\t\t}\n\t\tif envvar == \"\" || envvar == \"void\" {\n\t\t\treturn void{}\n\t\t}\n\t}\n\n\treturn newDevices(envvars...)\n}\n\ntype all struct{}\n\n// List returns [\"all\"] for all devices\nfunc (a all) List() []string {\n\treturn []string{\"all\"}\n}\n\n// Has for all devices is true for any id except the empty ID\nfunc (a all) Has(id string) bool {\n\treturn id != \"\"\n}\n\ntype none struct{}\n\n// List returns [\"\"] for the none devices\nfunc (n none) List() []string {\n\treturn []string{\"\"}\n}\n\n// Has for none devices is false for any id\nfunc (n none) Has(id string) bool {\n\treturn false\n}\n\ntype void struct {\n\tnone\n}\n\n// List returns nil for the void devices\nfunc (v void) List() []string {\n\treturn nil\n}\n\ntype devices struct {\n\tlen int\n\tlookup map[string]int\n}\n\nfunc newDevices(idOrCommaSeparated ...string) devices {\n\tlookup := make(map[string]int)\n\n\ti := 0\n\tfor _, commaSeparated := range idOrCommaSeparated {\n\t\tfor _, id := range strings.Split(commaSeparated, \",\") {\n\t\t\tlookup[id] = i\n\t\t\ti++\n\t\t}\n\t}\n\n\td := devices{\n\t\tlen: i,\n\t\tlookup: lookup,\n\t}\n\treturn d\n}\n\n// List returns the list of requested devices\nfunc (d devices) List() []string {\n\tlist := make([]string, d.len)\n\n\tfor id, i := range d.lookup {\n\t\tlist[i] = id\n\t}\n\n\treturn list\n}\n\n// Has checks whether the specified ID is in the set of requested devices\nfunc (d devices) Has(id string) bool {\n\tif id == \"\" {\n\t\treturn false\n\t}\n\n\t_, exist := d.lookup[id]\n\treturn exist\n}\n"
},
{
"path": "internal/config/image/envvars.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nconst (\n\tEnvVarCudaVersion = \"CUDA_VERSION\"\n\tEnvVarNvidiaDisableRequire = \"NVIDIA_DISABLE_REQUIRE\"\n\tEnvVarNvidiaDriverCapabilities = \"NVIDIA_DRIVER_CAPABILITIES\"\n\tEnvVarNvidiaImexChannels = \"NVIDIA_IMEX_CHANNELS\"\n\tEnvVarNvidiaMigConfigDevices = \"NVIDIA_MIG_CONFIG_DEVICES\"\n\tEnvVarNvidiaMigMonitorDevices = \"NVIDIA_MIG_MONITOR_DEVICES\"\n\tEnvVarNvidiaRequireCuda = NvidiaRequirePrefix + \"CUDA\"\n\tEnvVarNvidiaRequireJetpack = NvidiaRequirePrefix + \"JETPACK\"\n\tEnvVarNvidiaVisibleDevices = \"NVIDIA_VISIBLE_DEVICES\"\n\n\tNvidiaRequirePrefix = \"NVIDIA_REQUIRE_\"\n)\n"
},
{
"path": "internal/config/image/privileged.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nimport (\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n)\n\nconst (\n\tcapSysAdmin = \"CAP_SYS_ADMIN\"\n)\n\ntype CapabilitiesGetter interface {\n\tGetCapabilities() []string\n}\n\ntype OCISpec specs.Spec\n\ntype OCISpecCapabilities specs.LinuxCapabilities\n\n// IsPrivileged returns true if the container is a privileged container.\nfunc IsPrivileged(s CapabilitiesGetter) bool {\n\tif s == nil {\n\t\treturn false\n\t}\n\tfor _, c := range s.GetCapabilities() {\n\t\tif c == capSysAdmin {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n\nfunc (s OCISpec) GetCapabilities() []string {\n\tif s.Process == nil || s.Process.Capabilities == nil {\n\t\treturn nil\n\t}\n\treturn (*OCISpecCapabilities)(s.Process.Capabilities).GetCapabilities()\n}\n\nfunc (c OCISpecCapabilities) GetCapabilities() []string {\n\t// We only make sure that the bounding capability set has\n\t// CAP_SYS_ADMIN. This allows us to make sure that the container was\n\t// actually started as '--privileged', but also allow non-root users to\n\t// access the privileged NVIDIA capabilities.\n\treturn c.Bounding\n}\n"
},
{
"path": "internal/config/image/privileged_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage image\n\nimport (\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestIsPrivileged(t *testing.T) {\n\tvar tests = []struct {\n\t\tspec specs.Spec\n\t\texpected bool\n\t}{\n\t\t{\n\t\t\tspecs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tCapabilities: &specs.LinuxCapabilities{\n\t\t\t\t\t\tBounding: []string{\"CAP_SYS_ADMIN\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\ttrue,\n\t\t},\n\t\t{\n\t\t\tspecs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tCapabilities: &specs.LinuxCapabilities{\n\t\t\t\t\t\tBounding: []string{\"CAP_SYS_FOO\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tfalse,\n\t\t},\n\t}\n\tfor i, tc := range tests {\n\t\tprivileged := IsPrivileged((*OCISpec)(&tc.spec))\n\n\t\trequire.Equal(t, tc.expected, privileged, \"%d: %v\", i, tc)\n\t}\n}\n"
},
{
"path": "internal/cuda/cuda.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cuda\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/dl\"\n)\n\n/*\n#cgo linux LDFLAGS: -Wl,--export-dynamic -Wl,--unresolved-symbols=ignore-in-object-files\n#cgo darwin LDFLAGS: -Wl,-undefined,dynamic_lookup\n\n#ifdef _WIN32\n#define CUDAAPI __stdcall\n#else\n#define CUDAAPI\n#endif\n\ntypedef int CUdevice;\n\ntypedef enum CUdevice_attribute_enum {\n CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MAJOR = 75,\n CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MINOR = 76\n} CUdevice_attribute;\n\ntypedef enum cudaError_enum {\n\tCUDA_SUCCESS = 0\n} CUresult;\n\nCUresult CUDAAPI cuInit(unsigned int Flags);\nCUresult CUDAAPI cuDriverGetVersion(int *driverVersion);\nCUresult CUDAAPI cuDeviceGet(CUdevice *device, int ordinal);\nCUresult CUDAAPI cuDeviceGetAttribute(int *pi, CUdevice_attribute attrib, CUdevice dev);\n*/\nimport \"C\"\n\nconst (\n\tlibraryName = \"libcuda.so.1\"\n\tlibraryLoadFlags = dl.RTLD_LAZY | dl.RTLD_GLOBAL\n)\n\n// cuda stores a reference the cuda dynamic library\nvar lib *dl.DynamicLibrary\n\n// Version returns the CUDA version of the driver as a string or an error if this\n// cannot be determined.\nfunc Version() (string, error) {\n\tlib, err := load()\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tdefer lib.Close()\n\n\tif err := lib.Lookup(\"cuDriverGetVersion\"); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to lookup symbol: %v\", err)\n\t}\n\n\tvar version C.int\n\tif result := C.cuDriverGetVersion(&version); result != C.CUDA_SUCCESS {\n\t\treturn \"\", fmt.Errorf(\"failed to get CUDA version: result=%v\", result)\n\t}\n\n\tmajor := version / 1000\n\tminor := version % 100 / 10\n\n\treturn fmt.Sprintf(\"%d.%d\", major, minor), nil\n}\n\n// ComputeCapability returns the CUDA compute capability of a device with the specified index as a string\n// or an error if this cannot be determined.\nfunc ComputeCapability(index int) (string, error) {\n\tlib, err := load()\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tdefer lib.Close()\n\n\tif err := lib.Lookup(\"cuInit\"); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to lookup symbol: %v\", err)\n\t}\n\tif err := lib.Lookup(\"cuDeviceGet\"); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to lookup symbol: %v\", err)\n\t}\n\tif err := lib.Lookup(\"cuDeviceGetAttribute\"); err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to lookup symbol: %v\", err)\n\t}\n\n\tif result := C.cuInit(C.uint(0)); result != C.CUDA_SUCCESS {\n\t\treturn \"\", fmt.Errorf(\"failed to initialize CUDA: result=%v\", result)\n\t}\n\n\tvar device C.CUdevice\n\t// NOTE: We only query the first device\n\tif result := C.cuDeviceGet(&device, C.int(index)); result != C.CUDA_SUCCESS {\n\t\treturn \"\", fmt.Errorf(\"failed to get CUDA device %v: result=%v\", 0, result)\n\t}\n\n\tvar major C.int\n\tif result := C.cuDeviceGetAttribute(&major, C.CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MAJOR, device); result != C.CUDA_SUCCESS {\n\t\treturn \"\", fmt.Errorf(\"failed to get CUDA compute capability major for device %v : result=%v\", 0, result)\n\t}\n\n\tvar minor C.int\n\tif result := C.cuDeviceGetAttribute(&minor, C.CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MINOR, device); result != C.CUDA_SUCCESS {\n\t\treturn \"\", fmt.Errorf(\"failed to get CUDA compute capability minor for device %v: result=%v\", 0, result)\n\t}\n\n\treturn fmt.Sprintf(\"%d.%d\", major, minor), nil\n}\n\nfunc load() (*dl.DynamicLibrary, error) {\n\tlib := dl.New(libraryName, libraryLoadFlags)\n\tif lib == nil {\n\t\treturn nil, fmt.Errorf(\"error instantiating DynamicLibrary for CUDA\")\n\t}\n\terr := lib.Open()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error opening DynamicLibrary for CUDA: %v\", err)\n\t}\n\n\treturn lib, nil\n}\n"
},
{
"path": "internal/devices/devices.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage devices\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\n\t\"github.com/opencontainers/cgroups/devices/config\"\n\t\"github.com/opencontainers/runc/libcontainer/devices\"\n)\n\ntype Device config.Device\n\n// DeviceFromPath is a wrapper for libcontainer/devices.DeviceFromPath.\n// It allows for overriding functionality during tests.\nfunc DeviceFromPath(path string, permissions string) (*Device, error) {\n\treturn deviceFromPathStub(path, permissions)\n}\n\nvar deviceFromPathStub = func(path string, permissions string) (*Device, error) {\n\td, err := devices.DeviceFromPath(path, permissions)\n\treturn (*Device)(d), err\n}\n\n// AssertCharDevice checks whether the specified path is a char device and returns an error if this is not the case.\nfunc AssertCharDevice(path string) error {\n\treturn assertCharDeviceStub(path)\n}\n\nvar assertCharDeviceStub = func(path string) error {\n\tinfo, err := os.Lstat(path)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error getting info: %v\", err)\n\t}\n\tif info.Mode()&os.ModeCharDevice == 0 {\n\t\treturn fmt.Errorf(\"%v is not a char device\", path)\n\t}\n\treturn nil\n}\n\nfunc IsOverrideApplied() bool {\n\treturn isOverrideAppliedStub()\n}\n\nvar isOverrideAppliedStub = func() bool {\n\treturn false\n}\n"
},
{
"path": "internal/devices/devices_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage devices\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that InterfaceMock does implement Interface.\n// If this is not the case, regenerate this file with moq.\nvar _ Interface = &InterfaceMock{}\n\n// InterfaceMock is a mock implementation of Interface.\n//\n//\tfunc TestSomethingThatUsesInterface(t *testing.T) {\n//\n//\t\t// make and configure a mocked Interface\n//\t\tmockedInterface := &InterfaceMock{\n//\t\t\tAssertCharDeviceFunc: func(s string) error {\n//\t\t\t\tpanic(\"mock out the AssertCharDevice method\")\n//\t\t\t},\n//\t\t\tDeviceFromPathFunc: func(s1 string, s2 string) (*Device, error) {\n//\t\t\t\tpanic(\"mock out the DeviceFromPath method\")\n//\t\t\t},\n//\t\t\tIsOverrideAppliedFunc: func() bool {\n//\t\t\t\tpanic(\"mock out the IsOverrideApplied method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedInterface in code that requires Interface\n//\t\t// and then make assertions.\n//\n//\t}\ntype InterfaceMock struct {\n\t// AssertCharDeviceFunc mocks the AssertCharDevice method.\n\tAssertCharDeviceFunc func(s string) error\n\n\t// DeviceFromPathFunc mocks the DeviceFromPath method.\n\tDeviceFromPathFunc func(s1 string, s2 string) (*Device, error)\n\n\t// IsOverrideAppliedFunc mocks the IsOverrideApplied method.\n\tIsOverrideAppliedFunc func() bool\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// AssertCharDevice holds details about calls to the AssertCharDevice method.\n\t\tAssertCharDevice []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// DeviceFromPath holds details about calls to the DeviceFromPath method.\n\t\tDeviceFromPath []struct {\n\t\t\t// S1 is the s1 argument value.\n\t\t\tS1 string\n\t\t\t// S2 is the s2 argument value.\n\t\t\tS2 string\n\t\t}\n\t\t// IsOverrideApplied holds details about calls to the IsOverrideApplied method.\n\t\tIsOverrideApplied []struct {\n\t\t}\n\t}\n\tlockAssertCharDevice sync.RWMutex\n\tlockDeviceFromPath sync.RWMutex\n\tlockIsOverrideApplied sync.RWMutex\n}\n\n// AssertCharDevice calls AssertCharDeviceFunc.\nfunc (mock *InterfaceMock) AssertCharDevice(s string) error {\n\tif mock.AssertCharDeviceFunc == nil {\n\t\tpanic(\"InterfaceMock.AssertCharDeviceFunc: method is nil but Interface.AssertCharDevice was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockAssertCharDevice.Lock()\n\tmock.calls.AssertCharDevice = append(mock.calls.AssertCharDevice, callInfo)\n\tmock.lockAssertCharDevice.Unlock()\n\treturn mock.AssertCharDeviceFunc(s)\n}\n\n// AssertCharDeviceCalls gets all the calls that were made to AssertCharDevice.\n// Check the length with:\n//\n//\tlen(mockedInterface.AssertCharDeviceCalls())\nfunc (mock *InterfaceMock) AssertCharDeviceCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockAssertCharDevice.RLock()\n\tcalls = mock.calls.AssertCharDevice\n\tmock.lockAssertCharDevice.RUnlock()\n\treturn calls\n}\n\n// DeviceFromPath calls DeviceFromPathFunc.\nfunc (mock *InterfaceMock) DeviceFromPath(s1 string, s2 string) (*Device, error) {\n\tif mock.DeviceFromPathFunc == nil {\n\t\tpanic(\"InterfaceMock.DeviceFromPathFunc: method is nil but Interface.DeviceFromPath was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS1 string\n\t\tS2 string\n\t}{\n\t\tS1: s1,\n\t\tS2: s2,\n\t}\n\tmock.lockDeviceFromPath.Lock()\n\tmock.calls.DeviceFromPath = append(mock.calls.DeviceFromPath, callInfo)\n\tmock.lockDeviceFromPath.Unlock()\n\treturn mock.DeviceFromPathFunc(s1, s2)\n}\n\n// DeviceFromPathCalls gets all the calls that were made to DeviceFromPath.\n// Check the length with:\n//\n//\tlen(mockedInterface.DeviceFromPathCalls())\nfunc (mock *InterfaceMock) DeviceFromPathCalls() []struct {\n\tS1 string\n\tS2 string\n} {\n\tvar calls []struct {\n\t\tS1 string\n\t\tS2 string\n\t}\n\tmock.lockDeviceFromPath.RLock()\n\tcalls = mock.calls.DeviceFromPath\n\tmock.lockDeviceFromPath.RUnlock()\n\treturn calls\n}\n\n// IsOverrideApplied calls IsOverrideAppliedFunc.\nfunc (mock *InterfaceMock) IsOverrideApplied() bool {\n\tif mock.IsOverrideAppliedFunc == nil {\n\t\tpanic(\"InterfaceMock.IsOverrideAppliedFunc: method is nil but Interface.IsOverrideApplied was just called\")\n\t}\n\tcallInfo := struct {\n\t}{}\n\tmock.lockIsOverrideApplied.Lock()\n\tmock.calls.IsOverrideApplied = append(mock.calls.IsOverrideApplied, callInfo)\n\tmock.lockIsOverrideApplied.Unlock()\n\treturn mock.IsOverrideAppliedFunc()\n}\n\n// IsOverrideAppliedCalls gets all the calls that were made to IsOverrideApplied.\n// Check the length with:\n//\n//\tlen(mockedInterface.IsOverrideAppliedCalls())\nfunc (mock *InterfaceMock) IsOverrideAppliedCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockIsOverrideApplied.RLock()\n\tcalls = mock.calls.IsOverrideApplied\n\tmock.lockIsOverrideApplied.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/devices/devices_tests.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage devices\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\n\t\"github.com/opencontainers/cgroups/devices/config\"\n)\n\n//go:generate moq -rm -fmt=goimports -out devices_mock.go . Interface\ntype Interface interface {\n\tDeviceFromPath(string, string) (*Device, error)\n\tAssertCharDevice(string) error\n\tIsOverrideApplied() bool\n}\n\ntype testDefaults struct{}\n\nvar _ Interface = (*testDefaults)(nil)\n\nfunc SetAllForTest() func() {\n\td := &testDefaults{}\n\treturn SetInterfaceForTests(d)\n}\n\nfunc SetInterfaceForTests(m Interface) func() {\n\tif m == nil {\n\t\treturn SetAllForTest()\n\t}\n\tfuncs := []func(){\n\t\tSetDeviceFromPathForTest(m.DeviceFromPath),\n\t\tSetAssertCharDeviceForTest(m.AssertCharDevice),\n\t\tSetIsOverrideAppliedForTest(m.IsOverrideApplied),\n\t}\n\treturn func() {\n\t\tfor _, f := range funcs {\n\t\t\tf()\n\t\t}\n\t}\n}\n\nfunc SetDeviceFromPathForTest(testFunc func(string, string) (*Device, error)) func() {\n\tcurrent := deviceFromPathStub\n\tdeviceFromPathStub = testFunc\n\treturn func() {\n\t\tdeviceFromPathStub = current\n\t}\n}\n\nfunc SetAssertCharDeviceForTest(testFunc func(string) error) func() {\n\tcurrent := assertCharDeviceStub\n\tassertCharDeviceStub = testFunc\n\treturn func() {\n\t\tassertCharDeviceStub = current\n\t}\n}\n\nfunc SetIsOverrideAppliedForTest(testFunc func() bool) func() {\n\tcurrent := isOverrideAppliedStub\n\tisOverrideAppliedStub = testFunc\n\treturn func() {\n\t\tisOverrideAppliedStub = current\n\t}\n}\n\ntype testDevice struct {\n\tDevice\n}\n\nfunc (t *testDevice) load() error {\n\tdeviceFile, err := os.Open(t.Path)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer deviceFile.Close()\n\n\tdecoder := json.NewDecoder(deviceFile)\n\treturn decoder.Decode(&t)\n}\n\nfunc (t *testDefaults) DeviceFromPath(path string, permissions string) (*Device, error) {\n\tdevice := testDevice{\n\t\tDevice: Device{\n\t\t\tPath: path,\n\t\t\tRule: config.Rule{\n\t\t\t\tPermissions: config.Permissions(permissions),\n\t\t\t},\n\t\t},\n\t}\n\n\tif err := device.load(); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn &device.Device, nil\n}\n\nfunc (t *testDefaults) AssertCharDevice(path string) error {\n\tinfo, err := os.Stat(path)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error getting info for %v: %v\", path, err)\n\t}\n\n\tif info.IsDir() {\n\t\treturn fmt.Errorf(\"specified path '%v' is a directory\", path)\n\t}\n\n\treturn nil\n}\n\nfunc (t *testDefaults) IsOverrideApplied() bool {\n\treturn true\n}\n"
},
{
"path": "internal/discover/cache.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport \"sync\"\n\ntype cache struct {\n\td Discover\n\n\tsync.Mutex\n\tdevices []Device\n\tenvVars []EnvVar\n\thooks []Hook\n\tmounts []Mount\n}\n\nvar _ Discover = (*cache)(nil)\n\n// WithCache decorates the specified disoverer with a cache.\nfunc WithCache(d Discover) Discover {\n\tif d == nil {\n\t\treturn None{}\n\t}\n\treturn &cache{d: d}\n}\n\nfunc (c *cache) Devices() ([]Device, error) {\n\tc.Lock()\n\tdefer c.Unlock()\n\n\tif c.devices == nil {\n\t\tdevices, err := c.d.Devices()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tc.devices = devices\n\t}\n\treturn c.devices, nil\n}\n\nfunc (c *cache) EnvVars() ([]EnvVar, error) {\n\tc.Lock()\n\tdefer c.Unlock()\n\n\tif c.envVars == nil {\n\t\tenvVars, err := c.d.EnvVars()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tc.envVars = envVars\n\t}\n\treturn c.envVars, nil\n}\n\nfunc (c *cache) Hooks() ([]Hook, error) {\n\tc.Lock()\n\tdefer c.Unlock()\n\n\tif c.hooks == nil {\n\t\thooks, err := c.d.Hooks()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tc.hooks = hooks\n\t}\n\treturn c.hooks, nil\n}\n\nfunc (c *cache) Mounts() ([]Mount, error) {\n\tc.Lock()\n\tdefer c.Unlock()\n\n\tif c.mounts == nil {\n\t\tmounts, err := c.d.Mounts()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tc.mounts = mounts\n\t}\n\treturn c.mounts, nil\n}\n"
},
{
"path": "internal/discover/char_devices.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// charDevices is a discover for a list of character devices\ntype charDevices mounts\n\nvar _ Discover = (*charDevices)(nil)\n\n// NewCharDeviceDiscoverer creates a discoverer which locates the specified set of device nodes.\nfunc NewCharDeviceDiscoverer(logger logger.Interface, devRoot string, devices []string) Discover {\n\tlocator := lookup.NewCharDeviceLocator(\n\t\tlookup.WithLogger(logger),\n\t\tlookup.WithRoot(devRoot),\n\t)\n\n\treturn (*charDevices)(newMounts(logger, locator, devRoot, devices))\n}\n\n// Mounts returns the discovered mounts for the charDevices.\n// Since this explicitly specifies a device list, the mounts are nil.\nfunc (d *charDevices) Mounts() ([]Mount, error) {\n\treturn nil, nil\n}\n\n// Devices returns the discovered devices for the charDevices.\n// Here the device nodes are first discovered as mounts and these are converted to devices.\nfunc (d *charDevices) Devices() ([]Device, error) {\n\tdevicesAsMounts, err := (*mounts)(d).Mounts()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar devices []Device\n\tfor _, mount := range devicesAsMounts {\n\t\tdevice := Device{\n\t\t\tHostPath: mount.HostPath,\n\t\t\tPath: mount.Path,\n\t\t}\n\t\tdevices = append(devices, device)\n\t}\n\n\treturn devices, nil\n}\n"
},
{
"path": "internal/discover/char_devices_test.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nfunc TestCharDevices(t *testing.T) {\n\tlogger, logHook := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tinput *charDevices\n\t\texpectedMounts []Mount\n\t\texpectedMountsError error\n\t\texpectedDevicesError error\n\t\texpectedDevices []Device\n\t}{\n\t\t{\n\t\t\tdescription: \"dev mounts are empty\",\n\t\t\tinput: (*charDevices)(\n\t\t\t\t&mounts{\n\t\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\t\tLocateFunc: func(string) ([]string, error) {\n\t\t\t\t\t\t\treturn []string{\"located\"}, nil\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\trequired: []string{\"required\"},\n\t\t\t\t},\n\t\t\t),\n\t\t\texpectedDevices: []Device{{Path: \"located\", HostPath: \"located\"}},\n\t\t},\n\t\t{\n\t\t\tdescription: \"dev devices returns error for nil lookup\",\n\t\t\tinput: &charDevices{},\n\t\t\texpectedDevicesError: fmt.Errorf(\"no lookup defined\"),\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tlogHook.Reset()\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttc.input.logger = logger\n\n\t\t\tmounts, err := tc.input.Mounts()\n\t\t\tif tc.expectedMountsError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\t\t\trequire.ElementsMatch(t, tc.expectedMounts, mounts)\n\n\t\t\tdevices, err := tc.input.Devices()\n\t\t\tif tc.expectedDevicesError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\t\t\trequire.ElementsMatch(t, tc.expectedDevices, devices)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/compat_libs.go",
"content": "package discover\n\nimport (\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// EnableCUDACompatHookOptions defines the options that can be specified\n// when creating the enable-cuda-compat hook.\ntype EnableCUDACompatHookOptions struct {\n\tHostDriverVersion string\n\tHostCUDAVersion string\n\tCUDACompatContainerRoot string\n}\n\n// NewCUDACompatHookDiscoverer creates a discoverer for a enable-cuda-compat hook.\n// This hook is responsible for setting up CUDA compatibility in the container and depends on the host driver version.\nfunc NewCUDACompatHookDiscoverer(logger logger.Interface, hookCreator HookCreator, o *EnableCUDACompatHookOptions) Discover {\n\treturn hookCreator.Create(EnableCudaCompatHook, o.args()...)\n}\n\nfunc (o *EnableCUDACompatHookOptions) args() []string {\n\tif o == nil {\n\t\treturn nil\n\t}\n\tvar args []string\n\tif o.HostDriverVersion != \"\" && !strings.Contains(o.HostDriverVersion, \"*\") {\n\t\targs = append(args, \"--host-driver-version=\"+o.HostDriverVersion)\n\t}\n\tif o.HostCUDAVersion != \"\" {\n\t\targs = append(args, \"--host-cuda-version=\"+o.HostCUDAVersion)\n\t}\n\tif o.CUDACompatContainerRoot != \"\" {\n\t\targs = append(args, \"--cuda-compat-container-root=\"+o.CUDACompatContainerRoot)\n\t}\n\treturn args\n}\n"
},
{
"path": "internal/discover/discover.go",
"content": "/*\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage discover\n\n// Device represents a discovered character device.\ntype Device struct {\n\tHostPath string\n\tPath string\n}\n\n// EnvVar represents a discovered environment variable.\ntype EnvVar struct {\n\tName string\n\tValue string\n}\n\n// Mount represents a discovered mount.\ntype Mount struct {\n\tHostPath string\n\tPath string\n\tOptions []string\n}\n\n// Hook represents a discovered hook.\ntype Hook struct {\n\tLifecycle string\n\tPath string\n\tArgs []string\n\tEnv []string\n}\n\n// Discover defines an interface for discovering the devices, mounts, and hooks available on a system\n//\n//go:generate moq -rm -fmt=goimports -stub -out discover_mock.go . Discover\ntype Discover interface {\n\tDevices() ([]Device, error)\n\tEnvVars() ([]EnvVar, error)\n\tMounts() ([]Mount, error)\n\tHooks() ([]Hook, error)\n}\n"
},
{
"path": "internal/discover/discover_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage discover\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that DiscoverMock does implement Discover.\n// If this is not the case, regenerate this file with moq.\nvar _ Discover = &DiscoverMock{}\n\n// DiscoverMock is a mock implementation of Discover.\n//\n//\tfunc TestSomethingThatUsesDiscover(t *testing.T) {\n//\n//\t\t// make and configure a mocked Discover\n//\t\tmockedDiscover := &DiscoverMock{\n//\t\t\tDevicesFunc: func() ([]Device, error) {\n//\t\t\t\tpanic(\"mock out the Devices method\")\n//\t\t\t},\n//\t\t\tEnvVarsFunc: func() ([]EnvVar, error) {\n//\t\t\t\tpanic(\"mock out the EnvVars method\")\n//\t\t\t},\n//\t\t\tHooksFunc: func() ([]Hook, error) {\n//\t\t\t\tpanic(\"mock out the Hooks method\")\n//\t\t\t},\n//\t\t\tMountsFunc: func() ([]Mount, error) {\n//\t\t\t\tpanic(\"mock out the Mounts method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedDiscover in code that requires Discover\n//\t\t// and then make assertions.\n//\n//\t}\ntype DiscoverMock struct {\n\t// DevicesFunc mocks the Devices method.\n\tDevicesFunc func() ([]Device, error)\n\n\t// EnvVarsFunc mocks the EnvVars method.\n\tEnvVarsFunc func() ([]EnvVar, error)\n\n\t// HooksFunc mocks the Hooks method.\n\tHooksFunc func() ([]Hook, error)\n\n\t// MountsFunc mocks the Mounts method.\n\tMountsFunc func() ([]Mount, error)\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Devices holds details about calls to the Devices method.\n\t\tDevices []struct {\n\t\t}\n\t\t// EnvVars holds details about calls to the EnvVars method.\n\t\tEnvVars []struct {\n\t\t}\n\t\t// Hooks holds details about calls to the Hooks method.\n\t\tHooks []struct {\n\t\t}\n\t\t// Mounts holds details about calls to the Mounts method.\n\t\tMounts []struct {\n\t\t}\n\t}\n\tlockDevices sync.RWMutex\n\tlockEnvVars sync.RWMutex\n\tlockHooks sync.RWMutex\n\tlockMounts sync.RWMutex\n}\n\n// Devices calls DevicesFunc.\nfunc (mock *DiscoverMock) Devices() ([]Device, error) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockDevices.Lock()\n\tmock.calls.Devices = append(mock.calls.Devices, callInfo)\n\tmock.lockDevices.Unlock()\n\tif mock.DevicesFunc == nil {\n\t\tvar (\n\t\t\tdevicesOut []Device\n\t\t\terrOut error\n\t\t)\n\t\treturn devicesOut, errOut\n\t}\n\treturn mock.DevicesFunc()\n}\n\n// DevicesCalls gets all the calls that were made to Devices.\n// Check the length with:\n//\n//\tlen(mockedDiscover.DevicesCalls())\nfunc (mock *DiscoverMock) DevicesCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockDevices.RLock()\n\tcalls = mock.calls.Devices\n\tmock.lockDevices.RUnlock()\n\treturn calls\n}\n\n// EnvVars calls EnvVarsFunc.\nfunc (mock *DiscoverMock) EnvVars() ([]EnvVar, error) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockEnvVars.Lock()\n\tmock.calls.EnvVars = append(mock.calls.EnvVars, callInfo)\n\tmock.lockEnvVars.Unlock()\n\tif mock.EnvVarsFunc == nil {\n\t\tvar (\n\t\t\tenvVarsOut []EnvVar\n\t\t\terrOut error\n\t\t)\n\t\treturn envVarsOut, errOut\n\t}\n\treturn mock.EnvVarsFunc()\n}\n\n// EnvVarsCalls gets all the calls that were made to EnvVars.\n// Check the length with:\n//\n//\tlen(mockedDiscover.EnvVarsCalls())\nfunc (mock *DiscoverMock) EnvVarsCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockEnvVars.RLock()\n\tcalls = mock.calls.EnvVars\n\tmock.lockEnvVars.RUnlock()\n\treturn calls\n}\n\n// Hooks calls HooksFunc.\nfunc (mock *DiscoverMock) Hooks() ([]Hook, error) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockHooks.Lock()\n\tmock.calls.Hooks = append(mock.calls.Hooks, callInfo)\n\tmock.lockHooks.Unlock()\n\tif mock.HooksFunc == nil {\n\t\tvar (\n\t\t\thooksOut []Hook\n\t\t\terrOut error\n\t\t)\n\t\treturn hooksOut, errOut\n\t}\n\treturn mock.HooksFunc()\n}\n\n// HooksCalls gets all the calls that were made to Hooks.\n// Check the length with:\n//\n//\tlen(mockedDiscover.HooksCalls())\nfunc (mock *DiscoverMock) HooksCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockHooks.RLock()\n\tcalls = mock.calls.Hooks\n\tmock.lockHooks.RUnlock()\n\treturn calls\n}\n\n// Mounts calls MountsFunc.\nfunc (mock *DiscoverMock) Mounts() ([]Mount, error) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockMounts.Lock()\n\tmock.calls.Mounts = append(mock.calls.Mounts, callInfo)\n\tmock.lockMounts.Unlock()\n\tif mock.MountsFunc == nil {\n\t\tvar (\n\t\t\tmountsOut []Mount\n\t\t\terrOut error\n\t\t)\n\t\treturn mountsOut, errOut\n\t}\n\treturn mock.MountsFunc()\n}\n\n// MountsCalls gets all the calls that were made to Mounts.\n// Check the length with:\n//\n//\tlen(mockedDiscover.MountsCalls())\nfunc (mock *DiscoverMock) MountsCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockMounts.RLock()\n\tcalls = mock.calls.Mounts\n\tmock.lockMounts.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/discover/envvar.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nvar _ Discover = (*EnvVar)(nil)\n\n// Devices returns an empty list of devices for a EnvVar discoverer.\nfunc (e EnvVar) Devices() ([]Device, error) {\n\treturn nil, nil\n}\n\n// EnvVars returns an empty list of envs for a EnvVar discoverer.\nfunc (e EnvVar) EnvVars() ([]EnvVar, error) {\n\treturn []EnvVar{e}, nil\n}\n\n// Mounts returns an empty list of mounts for a EnvVar discoverer.\nfunc (e EnvVar) Mounts() ([]Mount, error) {\n\treturn nil, nil\n}\n\n// Hooks allows the Hook type to also implement the Discoverer interface.\n// It returns a single hook\nfunc (e EnvVar) Hooks() ([]Hook, error) {\n\treturn nil, nil\n}\n"
},
{
"path": "internal/discover/filter.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport \"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\n// Filter defines an interface for filtering discovered entities\ntype Filter interface {\n\tDeviceIsSelected(device Device) bool\n}\n\n// filtered represents a filtered discoverer\ntype filtered struct {\n\tDiscover\n\tlogger logger.Interface\n\tfilter Filter\n}\n\n// newFilteredDiscoverer creates a discoverer that applies the specified filter to the returned entities of the discoverer\nfunc newFilteredDiscoverer(logger logger.Interface, applyTo Discover, filter Filter) Discover {\n\treturn filtered{\n\t\tDiscover: applyTo,\n\t\tlogger: logger,\n\t\tfilter: filter,\n\t}\n}\n\n// Devices returns a filtered list of devices based on the specified filter.\nfunc (d filtered) Devices() ([]Device, error) {\n\tdevices, err := d.Discover.Devices()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif d.filter == nil {\n\t\treturn devices, nil\n\t}\n\n\tvar selected []Device\n\tfor _, device := range devices {\n\t\tif d.filter.DeviceIsSelected(device) {\n\t\t\tselected = append(selected, device)\n\t\t}\n\t\td.logger.Debugf(\"skipping device %v\", device)\n\t}\n\n\treturn selected, nil\n}\n"
},
{
"path": "internal/discover/first-valid.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport \"errors\"\n\ntype firstOf []Discover\n\n// FirstValid returns a discoverer that returns the first non-error result from a list of discoverers.\nfunc FirstValid(discoverers ...Discover) Discover {\n\tvar f firstOf\n\tfor _, d := range discoverers {\n\t\tif d == nil {\n\t\t\tcontinue\n\t\t}\n\t\tf = append(f, d)\n\t}\n\treturn f\n}\n\nfunc (f firstOf) Devices() ([]Device, error) {\n\tvar errs error\n\tfor _, d := range f {\n\t\tdevices, err := d.Devices()\n\t\tif err != nil {\n\t\t\terrs = errors.Join(errs, err)\n\t\t\tcontinue\n\t\t}\n\t\treturn devices, nil\n\t}\n\treturn nil, errs\n}\n\nfunc (f firstOf) EnvVars() ([]EnvVar, error) {\n\tvar errs error\n\tfor _, d := range f {\n\t\tenvs, err := d.EnvVars()\n\t\tif err != nil {\n\t\t\terrs = errors.Join(errs, err)\n\t\t\tcontinue\n\t\t}\n\t\treturn envs, nil\n\t}\n\treturn nil, errs\n}\n\nfunc (f firstOf) Hooks() ([]Hook, error) {\n\tvar errs error\n\tfor _, d := range f {\n\t\thooks, err := d.Hooks()\n\t\tif err != nil {\n\t\t\terrs = errors.Join(errs, err)\n\t\t\tcontinue\n\t\t}\n\t\treturn hooks, nil\n\t}\n\treturn nil, errs\n}\n\nfunc (f firstOf) Mounts() ([]Mount, error) {\n\tvar errs error\n\tfor _, d := range f {\n\t\tmounts, err := d.Mounts()\n\t\tif err != nil {\n\t\t\terrs = errors.Join(errs, err)\n\t\t\tcontinue\n\t\t}\n\t\treturn mounts, nil\n\t}\n\treturn nil, nil\n}\n"
},
{
"path": "internal/discover/gdrcopy.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n)\n\nfunc NewGDRCopyDiscoverer(logger logger.Interface, driver *root.Driver) (Discover, error) {\n\treturn NewCharDeviceDiscoverer(\n\t\tlogger,\n\t\tdriver.DevRoot,\n\t\t[]string{\"/dev/gdrdrv\"},\n\t), nil\n}\n"
},
{
"path": "internal/discover/gdrcopy_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover_test\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestNewGDRCopyDiscoverer(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\trootfs string\n\t\texpectedDevices []discover.Device\n\t}{\n\t\t{\n\t\t\tdescription: \"empty rootfs returns no devices\",\n\t\t\trootfs: \"rootfs-empty\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"rootfs with device nodes returns device\",\n\t\t\trootfs: \"rootfs-1\",\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{Path: \"/dev/gdrdrv\", HostPath: \"/dev/gdrdrv\"},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdevRoot := filepath.Join(lookupRoot, tc.rootfs)\n\t\t\tdriver := root.New(root.WithDevRoot(devRoot))\n\t\t\td, err := discover.NewGDRCopyDiscoverer(logger, driver)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedDevices, test.StripRoot(devices, devRoot))\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, mounts)\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, hooks)\n\n\t\t\tenvVars, err := d.EnvVars()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, envVars)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/gds.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\ntype gdsDeviceDiscoverer struct {\n\tNone\n\tlogger logger.Interface\n\tdevices Discover\n\tmounts Discover\n}\n\n// NewGDSDiscoverer creates a discoverer for GPUDirect Storage devices and mounts.\nfunc NewGDSDiscoverer(logger logger.Interface, driver *root.Driver) (Discover, error) {\n\tdevices := NewCharDeviceDiscoverer(\n\t\tlogger,\n\t\tdriver.DevRoot,\n\t\t[]string{\"/dev/nvidia-fs*\"},\n\t)\n\n\tudev := NewMounts(\n\t\tlogger,\n\t\tlookup.NewDirectoryLocator(lookup.WithLogger(logger), lookup.WithRoot(driver.Root)),\n\t\tdriver.Root,\n\t\t[]string{\"/run/udev\"},\n\t)\n\n\tcufile := NewMounts(\n\t\tlogger,\n\t\tlookup.NewFileLocator(\n\t\t\tlookup.WithLogger(logger),\n\t\t\tlookup.WithRoot(driver.Root),\n\t\t),\n\t\tdriver.Root,\n\t\t[]string{\"/etc/cufile.json\"},\n\t)\n\n\td := gdsDeviceDiscoverer{\n\t\tlogger: logger,\n\t\tdevices: devices,\n\t\tmounts: Merge(udev, cufile),\n\t}\n\n\treturn &d, nil\n}\n\n// Devices discovers the nvidia-fs device nodes for use with GPUDirect Storage\nfunc (d *gdsDeviceDiscoverer) Devices() ([]Device, error) {\n\treturn d.devices.Devices()\n}\n\n// Mounts discovers the required mounts for GPUDirect Storage.\n// If no devices are discovered the discovered mounts are empty\nfunc (d *gdsDeviceDiscoverer) Mounts() ([]Mount, error) {\n\tdevices, err := d.Devices()\n\tif err != nil || len(devices) == 0 {\n\t\td.logger.Debugf(\"No nvidia-fs devices detected; skipping detection of mounts\")\n\t\treturn nil, nil\n\t}\n\n\treturn d.mounts.Mounts()\n}\n"
},
{
"path": "internal/discover/gds_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover_test\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestNewGDSDiscoverer(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdriverRootfs string\n\t\tdevRootfs string\n\t\texpectedDevices []discover.Device\n\t\texpectedMounts []discover.Mount\n\t}{\n\t\t{\n\t\t\tdescription: \"empty rootfs returns no devices\",\n\t\t\tdriverRootfs: \"rootfs-empty\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"single rootfs\",\n\t\t\tdriverRootfs: \"rootfs-1\",\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{Path: \"/dev/nvidia-fs0\", HostPath: \"/dev/nvidia-fs0\"},\n\t\t\t},\n\t\t\texpectedMounts: []discover.Mount{\n\t\t\t\t{Path: \"/run/udev\", HostPath: \"/run/udev\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t{Path: \"/etc/cufile.json\", HostPath: \"/etc/cufile.json\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"split rootfs\",\n\t\t\tdriverRootfs: \"rootfs-split/driver-root\",\n\t\t\tdevRootfs: \"rootfs-split/dev-root\",\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{Path: \"/dev/nvidia-fs0\", HostPath: \"/dev/nvidia-fs0\"},\n\t\t\t},\n\t\t\texpectedMounts: []discover.Mount{\n\t\t\t\t{Path: \"/run/udev\", HostPath: \"/run/udev\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t{Path: \"/etc/cufile.json\", HostPath: \"/etc/cufile.json\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tif tc.devRootfs == \"\" {\n\t\t\ttc.devRootfs = tc.driverRootfs\n\t\t}\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdriverRoot := filepath.Join(lookupRoot, tc.driverRootfs)\n\t\t\tdevRoot := filepath.Join(lookupRoot, tc.devRootfs)\n\t\t\tdriver := root.New(root.WithDriverRoot(driverRoot), root.WithDevRoot(devRoot))\n\t\t\td, err := discover.NewGDSDiscoverer(logger, driver)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedDevices, test.StripRoot(devices, devRoot))\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedMounts, test.StripRoot(mounts, driverRoot))\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, hooks)\n\n\t\t\tenvVars, err := d.EnvVars()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, envVars)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/graphics.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info/drm\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info/proc\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// NewDRMNodesDiscoverer returns a discoverer for the DRM device nodes associated with the specified visible devices.\n//\n// TODO: The logic for creating DRM devices should be consolidated between this\n// and the logic for generating CDI specs for a single device. This is only used\n// when applying OCI spec modifications to an incoming spec in \"legacy\" mode.\nfunc NewDRMNodesDiscoverer(logger logger.Interface, devices image.VisibleDevices, devRoot string, hookCreator HookCreator) (Discover, error) {\n\tdrmDeviceNodes, err := newDRMDeviceDiscoverer(logger, devices, devRoot)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create DRM device discoverer: %v\", err)\n\t}\n\n\tdrmByPathSymlinks := newCreateDRMByPathSymlinks(logger, drmDeviceNodes, devRoot, hookCreator)\n\n\tdiscover := Merge(drmDeviceNodes, drmByPathSymlinks)\n\treturn discover, nil\n}\n\n// NewGraphicsMountsDiscoverer creates a discoverer for the mounts required by graphics tools such as vulkan.\nfunc NewGraphicsMountsDiscoverer(logger logger.Interface, driver *root.Driver, hookCreator HookCreator) (Discover, error) {\n\tlibraries, err := newGraphicsLibrariesDiscoverer(logger, driver, hookCreator)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to construct discoverer for graphics libraries: %w\", err)\n\t}\n\n\tconfigs := NewMounts(\n\t\tlogger,\n\t\tdriver.Configs(),\n\t\tdriver.Root,\n\t\t[]string{\n\t\t\t\"glvnd/egl_vendor.d/10_nvidia.json\",\n\t\t\t\"egl/egl_external_platform.d/15_nvidia_gbm.json\",\n\t\t\t\"egl/egl_external_platform.d/10_nvidia_wayland.json\",\n\t\t\t\"nvidia/nvoptix.bin\",\n\t\t\t\"X11/xorg.conf.d/10-nvidia.conf\",\n\t\t\t\"X11/xorg.conf.d/nvidia-drm-outputclass.conf\",\n\t\t},\n\t)\n\n\tdiscover := Merge(\n\t\tlibraries,\n\t\tconfigs,\n\t\tnewVulkanConfigsDiscover(logger, driver),\n\t)\n\n\treturn discover, nil\n}\n\n// newVulkanConfigsDiscover creates a discoverer for vulkan ICD files.\n// For these files we search the standard driver config paths as well as the\n// driver root itself. This allows us to support GKE installations where the\n// vulkan ICD files are at {{ .driverRoot }}/vulkan instead of in /etc/vulkan.\nfunc newVulkanConfigsDiscover(logger logger.Interface, driver *root.Driver) Discover {\n\tlocator := lookup.First(driver.Configs(), driver.Files())\n\n\trequired := []string{\n\t\t\"vulkan/icd.d/nvidia_icd.json\",\n\t\t\"vulkan/icd.d/nvidia_layers.json\",\n\t\t\"vulkan/implicit_layer.d/nvidia_layers.json\",\n\t}\n\t// For some RPM-based driver packages, the vulkan ICD files are installed to\n\t// /usr/share/vulkan/icd.d/nvidia_icd.%{_target_cpu}.json\n\t// We also include this in the list of candidates for the ICD file.\n\tswitch runtime.GOARCH {\n\tcase \"amd64\":\n\t\trequired = append(required, \"vulkan/icd.d/nvidia_icd.x86_64.json\")\n\tcase \"arm64\":\n\t\trequired = append(required, \"vulkan/icd.d/nvidia_icd.aarch64.json\")\n\t}\n\treturn &mountsToContainerPath{\n\t\tlogger: logger,\n\t\tlocator: locator,\n\t\trequired: required,\n\t\tcontainerRoot: \"/etc\",\n\t}\n}\n\ntype graphicsDriverLibraries struct {\n\tDiscover\n\tlogger logger.Interface\n\thookCreator HookCreator\n}\n\nvar _ Discover = (*graphicsDriverLibraries)(nil)\n\nfunc newGraphicsLibrariesDiscoverer(logger logger.Interface, driver *root.Driver, hookCreator HookCreator) (Discover, error) {\n\tcudaVersionPattern, err := driver.Version()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get driver version: %w\", err)\n\t}\n\tcudaLibRoot, err := driver.GetDriverLibDirectory()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get libcuda.so parent directory: %w\", err)\n\t}\n\n\tlibraries := NewMounts(\n\t\tlogger,\n\t\tdriver.Libraries(),\n\t\tdriver.Root,\n\t\t[]string{\n\t\t\t// The libnvidia-egl-gbm and libnvidia-egl-wayland libraries do not\n\t\t\t// have the RM version. Use the *.* pattern to match X.Y.Z versions.\n\t\t\t\"libnvidia-egl-gbm.so.*.*\",\n\t\t\t\"libnvidia-egl-wayland.so.*.*\",\n\t\t\t// We include the following libraries to have them available for\n\t\t\t// symlink creation below:\n\t\t\t// If CDI injection is used, these should already be detected as:\n\t\t\t// * libnvidia-allocator.so.RM_VERSION\n\t\t\t// * libnvidia-vulkan-producer.so.RM_VERSION\n\t\t\t// but need to be handled for the legacy case too.\n\t\t\t\"libnvidia-allocator.so.\" + cudaVersionPattern,\n\t\t\t\"libnvidia-vulkan-producer.so.\" + cudaVersionPattern,\n\t\t},\n\t)\n\n\txorgLibraries := NewMounts(\n\t\tlogger,\n\t\tlookup.NewFileLocator(\n\t\t\tlookup.WithLogger(logger),\n\t\t\tlookup.WithRoot(driver.Root),\n\t\t\tlookup.WithSearchPaths(buildXOrgSearchPaths(cudaLibRoot)...),\n\t\t\tlookup.WithCount(1),\n\t\t),\n\t\tdriver.Root,\n\t\t[]string{\n\t\t\t\"nvidia_drv.so\",\n\t\t\t\"libglxserver_nvidia.so.\" + cudaVersionPattern,\n\t\t},\n\t)\n\n\treturn &graphicsDriverLibraries{\n\t\tDiscover: Merge(libraries, xorgLibraries),\n\t\tlogger: logger,\n\t\thookCreator: hookCreator,\n\t}, nil\n}\n\n// Mounts discovers the required libraries and filters out libnvidia-allocator.so.\n// The library libnvidia-allocator.so is already handled by either the *.RM_VERSION\n// injection or by libnvidia-container. We therefore filter it out here as a\n// workaround for the case where libnvidia-container will re-mount this in the\n// container, which causes issues with shared mount propagation.\nfunc (d graphicsDriverLibraries) Mounts() ([]Mount, error) {\n\tmounts, err := d.Discover.Mounts()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get library mounts: %v\", err)\n\t}\n\n\tvar filtered []Mount\n\tfor _, mount := range mounts {\n\t\tif d.isDriverLibrary(filepath.Base(mount.Path), \"libnvidia-allocator.so\") {\n\t\t\tcontinue\n\t\t}\n\t\tfiltered = append(filtered, mount)\n\t}\n\treturn filtered, nil\n}\n\n// Create necessary library symlinks for graphics drivers\nfunc (d graphicsDriverLibraries) Hooks() ([]Hook, error) {\n\tmounts, err := d.Discover.Mounts()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get library mounts: %v\", err)\n\t}\n\n\tvar links []string\n\tfor _, mount := range mounts {\n\t\tdir, filename := filepath.Split(mount.Path)\n\t\tswitch {\n\t\tcase d.isDriverLibrary(filename, \"libnvidia-allocator.so\"):\n\t\t\t// gbm/nvidia-drm_gbm.so is a symlink to ../libnvidia-allocator.so.1 which\n\t\t\t// in turn symlinks to libnvidia-allocator.so.RM_VERSION.\n\t\t\t// The libnvidia-allocator.so.1 -> libnvidia-allocator.so.RM_VERSION symlink\n\t\t\t// is created when ldconfig is run against the container and there\n\t\t\t// is no explicit need to create it.\n\t\t\t// create gbm/nvidia-drm_gbm.so -> ../libnvidia-allocate.so.1 symlink\n\t\t\tlinkPath := filepath.Join(dir, \"gbm\", \"nvidia-drm_gbm.so\")\n\t\t\tlinks = append(links, fmt.Sprintf(\"%s::%s\", \"../libnvidia-allocator.so.1\", linkPath))\n\t\tcase d.isDriverLibrary(filename, \"libnvidia-vulkan-producer.so\"):\n\t\t\t// libnvidia-vulkan-producer.so is a drirect symlink to libnvidia-vulkan-producer.so.RM_VERSION\n\t\t\t// create libnvidia-vulkan-producer.so -> libnvidia-vulkan-producer.so.RM_VERSION symlink\n\t\t\tlinkPath := filepath.Join(dir, \"libnvidia-vulkan-producer.so\")\n\t\t\tlinks = append(links, fmt.Sprintf(\"%s::%s\", filename, linkPath))\n\t\tcase d.isDriverLibrary(filename, \"libglxserver_nvidia.so\"):\n\t\t\t// libglxserver_nvidia.so is a directl symlink to libglxserver_nvidia.so.RM_VERSION\n\t\t\t// create libglxserver_nvidia.so -> libglxserver_nvidia.so.RM_VERSION symlink\n\t\t\tlinkPath := filepath.Join(dir, \"libglxserver_nvidia.so\")\n\t\t\tlinks = append(links, fmt.Sprintf(\"%s::%s\", filename, linkPath))\n\t\t}\n\t}\n\tif len(links) == 0 {\n\t\treturn nil, nil\n\t}\n\n\thook := d.hookCreator.Create(\"create-symlinks\", links...)\n\n\treturn hook.Hooks()\n}\n\n// isDriverLibrary checks whether the specified filename is a specific driver library.\nfunc (d graphicsDriverLibraries) isDriverLibrary(filename string, libraryName string) bool {\n\t// TODO: Instead of `.*.*` we could use the driver version.\n\tpattern := strings.TrimSuffix(libraryName, \".\") + \".*.*\"\n\tmatch, _ := filepath.Match(pattern, filename)\n\treturn match\n}\n\n// buildXOrgSearchPaths returns the ordered list of search paths for XOrg files.\nfunc buildXOrgSearchPaths(libRoot string) []string {\n\tvar paths []string\n\tif libRoot != \"\" {\n\t\tpaths = append(paths,\n\t\t\tfilepath.Join(libRoot, \"nvidia/xorg\"),\n\t\t\tfilepath.Join(libRoot, \"xorg\", \"modules\", \"drivers\"),\n\t\t\tfilepath.Join(libRoot, \"xorg\", \"modules\", \"extensions\"),\n\t\t\tfilepath.Join(libRoot, \"xorg\", \"modules/updates\", \"drivers\"),\n\t\t\tfilepath.Join(libRoot, \"xorg\", \"modules/updates\", \"extensions\"),\n\t\t)\n\t}\n\n\treturn append(paths,\n\t\tfilepath.Join(\"/usr/lib/xorg\", \"modules\", \"drivers\"),\n\t\tfilepath.Join(\"/usr/lib/xorg\", \"modules\", \"extensions\"),\n\t\tfilepath.Join(\"/usr/lib/xorg\", \"modules/updates\", \"drivers\"),\n\t\tfilepath.Join(\"/usr/lib/xorg\", \"modules/updates\", \"extensions\"),\n\t\tfilepath.Join(\"/usr/lib64/xorg\", \"modules\", \"drivers\"),\n\t\tfilepath.Join(\"/usr/lib64/xorg\", \"modules\", \"extensions\"),\n\t\tfilepath.Join(\"/usr/lib64/xorg\", \"modules/updates\", \"drivers\"),\n\t\tfilepath.Join(\"/usr/lib64/xorg\", \"modules/updates\", \"extensions\"),\n\t\tfilepath.Join(\"/usr/X11R6/lib\", \"modules\", \"drivers\"),\n\t\tfilepath.Join(\"/usr/X11R6/lib\", \"modules\", \"extensions\"),\n\t\tfilepath.Join(\"/usr/X11R6/lib\", \"modules/updates\", \"drivers\"),\n\t\tfilepath.Join(\"/usr/X11R6/lib\", \"modules/updates\", \"extensions\"),\n\t\tfilepath.Join(\"/usr/X11R6/lib64\", \"modules\", \"drivers\"),\n\t\tfilepath.Join(\"/usr/X11R6/lib64\", \"modules\", \"extensions\"),\n\t\tfilepath.Join(\"/usr/X11R6/lib64\", \"modules/updates\", \"drivers\"),\n\t\tfilepath.Join(\"/usr/X11R6/lib64\", \"modules/updates\", \"extensions\"),\n\t)\n}\n\ntype drmDevicesByPath struct {\n\tNone\n\tlogger logger.Interface\n\thookCreator HookCreator\n\tdevRoot string\n\tdevicesFrom Discover\n}\n\n// newCreateDRMByPathSymlinks creates a discoverer for a hook to create the by-path symlinks for DRM devices discovered by the specified devices discoverer\nfunc newCreateDRMByPathSymlinks(logger logger.Interface, devices Discover, devRoot string, hookCreator HookCreator) Discover {\n\td := drmDevicesByPath{\n\t\tlogger: logger,\n\t\thookCreator: hookCreator,\n\t\tdevRoot: devRoot,\n\t\tdevicesFrom: devices,\n\t}\n\n\treturn &d\n}\n\n// Hooks returns a hook to create the symlinks from the required CSV files\nfunc (d drmDevicesByPath) Hooks() ([]Hook, error) {\n\tdevices, err := d.devicesFrom.Devices()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover devices for by-path symlinks: %v\", err)\n\t}\n\tif len(devices) == 0 {\n\t\treturn nil, nil\n\t}\n\tlinks, err := d.getSpecificLinkArgs(devices)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to determine specific links: %v\", err)\n\t}\n\tif len(links) == 0 {\n\t\treturn nil, nil\n\t}\n\n\thook := d.hookCreator.Create(\"create-symlinks\", links...)\n\n\treturn hook.Hooks()\n}\n\n// getSpecificLinkArgs returns the required specific links that need to be created\nfunc (d drmDevicesByPath) getSpecificLinkArgs(devices []Device) ([]string, error) {\n\tselectedDevices := make(map[string]bool)\n\tfor _, d := range devices {\n\t\tselectedDevices[filepath.Base(d.HostPath)] = true\n\t}\n\n\tlinkLocator := lookup.NewFileLocator(\n\t\tlookup.WithLogger(d.logger),\n\t\tlookup.WithRoot(d.devRoot),\n\t)\n\tcandidates, err := linkLocator.Locate(\"/dev/dri/by-path/pci-*-*\")\n\tif err != nil {\n\t\td.logger.Warningf(\"Failed to locate by-path links: %v; ignoring\", err)\n\t\treturn nil, nil\n\t}\n\n\tvar links []string\n\tfor _, c := range candidates {\n\t\tdevice, err := os.Readlink(c)\n\t\tif err != nil {\n\t\t\td.logger.Warningf(\"Failed to evaluate symlink %v; ignoring\", c)\n\t\t\tcontinue\n\t\t}\n\n\t\tif selectedDevices[filepath.Base(device)] {\n\t\t\td.logger.Debugf(\"adding device symlink %v -> %v\", c, device)\n\t\t\tlinks = append(links, fmt.Sprintf(\"%v::%v\", device, c))\n\t\t}\n\t}\n\n\treturn links, nil\n}\n\n// newDRMDeviceDiscoverer creates a discoverer for the DRM devices associated with the requested devices.\nfunc newDRMDeviceDiscoverer(logger logger.Interface, devices image.VisibleDevices, devRoot string) (Discover, error) {\n\tallDevices := NewCharDeviceDiscoverer(\n\t\tlogger,\n\t\tdevRoot,\n\t\t[]string{\n\t\t\t\"/dev/dri/card*\",\n\t\t\t\"/dev/dri/renderD*\",\n\t\t},\n\t)\n\n\tfilter, err := newDRMDeviceFilter(devices, devRoot)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to construct DRM device filter: %v\", err)\n\t}\n\n\t// We return a discoverer that applies the DRM device filter created above to all discovered DRM device nodes.\n\td := newFilteredDiscoverer(\n\t\tlogger,\n\t\tallDevices,\n\t\tfilter,\n\t)\n\n\treturn d, err\n}\n\n// newDRMDeviceFilter creates a filter that matches DRM devices nodes for the visible devices.\nfunc newDRMDeviceFilter(devices image.VisibleDevices, devRoot string) (Filter, error) {\n\tgpuInformationPaths, err := proc.GetInformationFilePaths(devRoot)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to read GPU information: %v\", err)\n\t}\n\n\tvar selectedBusIds []string\n\tfor _, f := range gpuInformationPaths {\n\t\tinfo, err := proc.ParseGPUInformationFile(f)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to parse %v: %v\", f, err)\n\t\t}\n\t\tuuid := info[proc.GPUInfoGPUUUID]\n\t\tbusID := info[proc.GPUInfoBusLocation]\n\t\tminor := info[proc.GPUInfoDeviceMinor]\n\n\t\tif devices.Has(minor) || devices.Has(uuid) || devices.Has(busID) {\n\t\t\tselectedBusIds = append(selectedBusIds, busID)\n\t\t}\n\t}\n\n\tfilter := make(selectDeviceByPath)\n\tfor _, busID := range selectedBusIds {\n\t\tdrmDeviceNodes, err := drm.GetDeviceNodesByBusID(busID)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to determine DRM devices for %v: %v\", busID, err)\n\t\t}\n\t\tfor _, drmDeviceNode := range drmDeviceNodes {\n\t\t\tfilter[drmDeviceNode] = true\n\t\t}\n\t}\n\n\treturn filter, nil\n}\n\n// selectDeviceByPath is a filter that allows devices to be selected by the path\ntype selectDeviceByPath map[string]bool\n\nvar _ Filter = (*selectDeviceByPath)(nil)\n\n// DeviceIsSelected determines whether the device's path has been selected\nfunc (s selectDeviceByPath) DeviceIsSelected(device Device) bool {\n\treturn s[device.Path]\n}\n\n// MountIsSelected is always true\nfunc (s selectDeviceByPath) MountIsSelected(Mount) bool {\n\treturn true\n}\n\n// HookIsSelected is always true\nfunc (s selectDeviceByPath) HookIsSelected(Hook) bool {\n\treturn true\n}\n"
},
{
"path": "internal/discover/graphics_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestGraphicsLibrariesDiscoverer(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\thookCreator := NewHookCreator()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tlibraries *DiscoverMock\n\t\texpectedMounts []Mount\n\t\texpectedHooks []Hook\n\t}{\n\t\t{\n\t\t\tdescription: \"none discovered\",\n\t\t\tlibraries: &DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib64/libnvidia-egl-gbm.so.123.45.67\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib64/libnvidia-egl-gbm.so.123.45.67\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"libnvidia-allocator discovered\",\n\t\t\tlibraries: &DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib64/libnvidia-allocator.so.123.45.67\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: nil,\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\",\n\t\t\t\t\t\t\"--link\", \"../libnvidia-allocator.so.1::/usr/lib64/gbm/nvidia-drm_gbm.so\",\n\t\t\t\t\t},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"libnvidia-vulkan-producer discovered\",\n\t\t\tlibraries: &DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib64/libnvidia-vulkan-producer.so.123.45.67\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib64/libnvidia-vulkan-producer.so.123.45.67\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\",\n\t\t\t\t\t\t\"--link\", \"libnvidia-vulkan-producer.so.123.45.67::/usr/lib64/libnvidia-vulkan-producer.so\",\n\t\t\t\t\t},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"libnvidia-allocator and libnvidia-vulkan-producer discovered\",\n\t\t\tlibraries: &DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib64/libnvidia-allocator.so.123.45.67\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib64/libnvidia-vulkan-producer.so.123.45.67\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib64/libnvidia-vulkan-producer.so.123.45.67\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\",\n\t\t\t\t\t\t\"--link\", \"../libnvidia-allocator.so.1::/usr/lib64/gbm/nvidia-drm_gbm.so\",\n\t\t\t\t\t\t\"--link\", \"libnvidia-vulkan-producer.so.123.45.67::/usr/lib64/libnvidia-vulkan-producer.so\",\n\t\t\t\t\t},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\td := &graphicsDriverLibraries{\n\t\t\t\tDiscover: tc.libraries,\n\t\t\t\tlogger: logger,\n\t\t\t\thookCreator: hookCreator,\n\t\t\t}\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, devices)\n\t\t\trequire.Len(t, tc.libraries.calls.Devices, 1)\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedMounts, mounts)\n\t\t\trequire.Len(t, tc.libraries.calls.Mounts, 1)\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedHooks, hooks)\n\t\t\trequire.Len(t, tc.libraries.calls.Mounts, 2)\n\t\t\trequire.Len(t, tc.libraries.calls.Hooks, 0)\n\t\t})\n\t}\n}\n\nfunc TestDrmDevicesByPath(t *testing.T) {\n\tdefer devices.SetAllForTest()()\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\tdevRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\", \"rootfs-drm\")\n\n\tlogger, _ := testlog.NewNullLogger()\n\thookCreator := NewHookCreator()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdevices Discover\n\t\tdevRoot string\n\t\texpectedError error\n\t\texpectedHooks []Hook\n\t}{\n\t\t{\n\t\t\tdescription: \"no devices\",\n\t\t\tdevices: &DiscoverMock{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"single device\",\n\t\t\tdevices: &DiscoverMock{\n\t\t\t\tDevicesFunc: func() ([]Device, error) {\n\t\t\t\t\tdevices := []Device{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/dev/dri/card0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/dev/dri/renderD128\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn devices, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\"nvidia-cdi-hook\", \"create-symlinks\",\n\t\t\t\t\t\t\"--link\", \"../card0::{{ .DevRoot }}/dev/dri/by-path/pci-0000:07:00.0-card\",\n\t\t\t\t\t\t\"--link\", \"../renderD128::{{ .DevRoot }}/dev/dri/by-path/pci-0000:07:00.0-render\",\n\t\t\t\t\t},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\n\t\tfor _, h := range tc.expectedHooks {\n\t\t\tfor i := range h.Args {\n\t\t\t\th.Args[i] = strings.ReplaceAll(h.Args[i], \"{{ .DevRoot }}\", devRoot)\n\t\t\t}\n\t\t}\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\td := newCreateDRMByPathSymlinks(logger, tc.devices, devRoot, hookCreator)\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, devices)\n\n\t\t\tenvVars, err := d.EnvVars()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, envVars)\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, mounts)\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.EqualValues(t, tc.expectedError, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedHooks, hooks)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/hooks.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n)\n\n// A HookName represents a supported CDI hooks.\ntype HookName string\n\nconst (\n\t// AllHooks is a special hook name that allows all hooks to be matched.\n\tAllHooks = HookName(\"all\")\n\n\t// A ChmodHook is used to set the file mode of the specified paths.\n\t//\n\t// Deprecated: The chmod hook is deprecated and will be removed in a future release.\n\tChmodHook = HookName(\"chmod\")\n\t// A CreateSymlinksHook is used to create symlinks in the container.\n\tCreateSymlinksHook = HookName(\"create-symlinks\")\n\t// DisableDeviceNodeModificationHook refers to the hook used to ensure that\n\t// device nodes are not created by libnvidia-ml.so or nvidia-smi in a\n\t// container.\n\t// Added in v1.17.8\n\tDisableDeviceNodeModificationHook = HookName(\"disable-device-node-modification\")\n\t// An EnableCudaCompatHook is used to enabled CUDA Forward Compatibility.\n\t// Added in v1.17.5\n\tEnableCudaCompatHook = HookName(\"enable-cuda-compat\")\n\t// An UpdateLDCacheHook is the hook used to update the ldcache in the\n\t// container. This allows injected libraries to be discoverable.\n\tUpdateLDCacheHook = HookName(\"update-ldcache\")\n\n\tdefaultNvidiaCDIHookPath = \"/usr/bin/nvidia-cdi-hook\"\n)\n\n// defaultDisabledHooks defines hooks that are disabled by default.\n// These hooks can be explicitly enabled using the WithEnabledHooks option.\nvar defaultDisabledHooks = []HookName{\n\t// ChmodHook is disabled by default as it was a workaround for older\n\t// versions of crun that has since been fixed.\n\tChmodHook,\n}\n\nvar _ Discover = (*Hook)(nil)\n\n// Devices returns an empty list of devices for a Hook discoverer.\nfunc (h *Hook) Devices() ([]Device, error) {\n\treturn nil, nil\n}\n\n// EnvVars returns an empty list of envs for a Hook discoverer.\nfunc (h *Hook) EnvVars() ([]EnvVar, error) {\n\treturn nil, nil\n}\n\n// Mounts returns an empty list of mounts for a Hook discoverer.\nfunc (h *Hook) Mounts() ([]Mount, error) {\n\treturn nil, nil\n}\n\n// Hooks allows the Hook type to also implement the Discoverer interface.\n// It returns a single hook\nfunc (h *Hook) Hooks() ([]Hook, error) {\n\tif h == nil {\n\t\treturn nil, nil\n\t}\n\n\treturn []Hook{*h}, nil\n}\n\ntype hookCreatorOptions struct {\n\tnvidiaCDIHookPath string\n\tldconfigPath string\n\tdisabledHooks []HookName\n\tenabledHooks []HookName\n\tdebugLogging bool\n}\n\ntype Option func(*hookCreatorOptions)\n\ntype cdiHookCreator struct {\n\tnvidiaCDIHookPath string\n\tldconfigPath string\n\tdisabledHooks map[HookName]bool\n\n\tfixedArgs []string\n\tdebugLogging bool\n}\n\n// An allDisabledHookCreator is a HookCreator that does not create any hooks.\ntype allDisabledHookCreator struct{}\n\n// Create returns nil for all hooks for an allDisabledHookCreator.\nfunc (a *allDisabledHookCreator) Create(name HookName, args ...string) *Hook {\n\treturn nil\n}\n\n// A HookCreator defines an interface for creating discover hooks.\ntype HookCreator interface {\n\tCreate(HookName, ...string) *Hook\n}\n\nfunc WithDebugLogging(debugLogging bool) Option {\n\treturn func(hco *hookCreatorOptions) {\n\t\thco.debugLogging = debugLogging\n\t}\n}\n\n// WithDisabledHooks explicitly disables the specified hooks.\n// This can be specified multiple times.\nfunc WithDisabledHooks(hooks ...HookName) Option {\n\treturn func(c *hookCreatorOptions) {\n\t\tc.disabledHooks = append(c.disabledHooks, hooks...)\n\t}\n}\n\n// WithEnabledHooks explicitly enables the specified hooks.\n// This is useful for enabling hooks that are disabled by default.\nfunc WithEnabledHooks(hooks ...HookName) Option {\n\treturn func(c *hookCreatorOptions) {\n\t\tc.enabledHooks = append(c.enabledHooks, hooks...)\n\t}\n}\n\nfunc WithLdconfigPath(ldconfigPath string) Option {\n\treturn func(c *hookCreatorOptions) {\n\t\tc.ldconfigPath = ldconfigPath\n\t}\n}\n\n// WithNVIDIACDIHookPath sets the path to the nvidia-cdi-hook binary.\nfunc WithNVIDIACDIHookPath(nvidiaCDIHookPath string) Option {\n\treturn func(c *hookCreatorOptions) {\n\t\tc.nvidiaCDIHookPath = nvidiaCDIHookPath\n\t}\n}\n\nfunc NewHookCreator(opts ...Option) HookCreator {\n\to := &hookCreatorOptions{\n\t\tnvidiaCDIHookPath: defaultNvidiaCDIHookPath,\n\t}\n\tfor _, opt := range opts {\n\t\topt(o)\n\t}\n\n\to.disabledHooks = append(o.disabledHooks, defaultDisabledHooks...)\n\n\tdisabledHooks := make(map[HookName]bool)\n\tfor _, h := range o.disabledHooks {\n\t\tdisabledHooks[h] = true\n\t}\n\n\tif disabledHooks[AllHooks] && len(o.enabledHooks) == 0 {\n\t\treturn &allDisabledHookCreator{}\n\t}\n\n\tfor _, h := range o.enabledHooks {\n\t\tdisabledHooks[h] = false\n\t}\n\n\tc := &cdiHookCreator{\n\t\tnvidiaCDIHookPath: o.nvidiaCDIHookPath,\n\t\tldconfigPath: o.ldconfigPath,\n\t\tdisabledHooks: disabledHooks,\n\t\tfixedArgs: getFixedArgsForCDIHookCLI(o.nvidiaCDIHookPath),\n\t\tdebugLogging: o.debugLogging,\n\t}\n\n\treturn c\n}\n\n// Create creates a new hook with the given name and arguments.\n// If a hook is disabled, a nil hook is returned.\nfunc (c cdiHookCreator) Create(name HookName, args ...string) *Hook {\n\tif c.isDisabled(name, args...) {\n\t\treturn nil\n\t}\n\n\treturn &Hook{\n\t\tLifecycle: cdi.CreateContainerHook,\n\t\tPath: c.nvidiaCDIHookPath,\n\t\tArgs: append(c.requiredArgs(name), c.transformArgs(name, args...)...),\n\t\tEnv: []string{fmt.Sprintf(\"NVIDIA_CTK_DEBUG=%v\", c.debugLogging)},\n\t}\n}\n\nfunc (c cdiHookCreator) isDisabled(name HookName, args ...string) bool {\n\tdisabled, ok := c.disabledHooks[name]\n\tif ok {\n\t\treturn disabled\n\t}\n\tif c.disabledHooks[AllHooks] {\n\t\treturn true\n\t}\n\n\t// still reject hooks that require args if none were provided\n\tswitch name {\n\tcase CreateSymlinksHook, ChmodHook:\n\t\treturn len(args) == 0\n\t}\n\treturn false\n}\n\nfunc (c cdiHookCreator) requiredArgs(name HookName) []string {\n\treturn append(c.fixedArgs, string(name))\n}\n\nfunc (c cdiHookCreator) transformArgs(name HookName, args ...string) []string {\n\tvar transformedArgs []string\n\tswitch name {\n\tcase CreateSymlinksHook:\n\t\tfor _, arg := range args {\n\t\t\ttransformedArgs = append(transformedArgs, \"--link\", arg)\n\t\t}\n\tcase ChmodHook:\n\t\ttransformedArgs = append(transformedArgs, \"--mode\", \"755\")\n\t\tfor _, arg := range args {\n\t\t\ttransformedArgs = append(transformedArgs, \"--path\", arg)\n\t\t}\n\tcase UpdateLDCacheHook:\n\t\tif c.ldconfigPath != \"\" {\n\t\t\ttransformedArgs = append(transformedArgs, \"--ldconfig-path\", c.ldconfigPath)\n\t\t}\n\t\tfor _, arg := range args {\n\t\t\ttransformedArgs = append(transformedArgs, \"--folder\", arg)\n\t\t}\n\tdefault:\n\t\treturn args\n\t}\n\treturn transformedArgs\n}\n\n// getFixedArgsForCDIHookCLI returns the fixed arguments for the hook CLI.\n// If the nvidia-ctk binary is used, hooks are implemented under the hook\n// subcommand.\n// For the nvidia-cdi-hook binary, the hooks are implemented as subcommands of\n// the top-level CLI.\nfunc getFixedArgsForCDIHookCLI(nvidiaCDIHookPath string) []string {\n\tbase := filepath.Base(nvidiaCDIHookPath)\n\tif base == \"nvidia-ctk\" {\n\t\treturn []string{base, \"hook\"}\n\t}\n\treturn []string{base}\n}\n"
},
{
"path": "internal/discover/hooks_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNewHookCreator(t *testing.T) {\n\ttestCases := []struct {\n\t\tname string\n\t\topts []Option\n\t\texpected HookCreator\n\t}{\n\t\t{\n\t\t\tname: \"default creates cdiHookCreator with default path\",\n\t\t\topts: nil,\n\t\t\texpected: &cdiHookCreator{\n\t\t\t\tnvidiaCDIHookPath: defaultNvidiaCDIHookPath,\n\t\t\t\tfixedArgs: []string{\"nvidia-cdi-hook\"},\n\t\t\t\tdisabledHooks: map[HookName]bool{\n\t\t\t\t\tChmodHook: true, // ChmodHook is disabled by default\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"custom nvidia-cdi-hook path\",\n\t\t\topts: []Option{\n\t\t\t\tWithNVIDIACDIHookPath(\"/custom/path/nvidia-cdi-hook\"),\n\t\t\t},\n\t\t\texpected: &cdiHookCreator{\n\t\t\t\tnvidiaCDIHookPath: \"/custom/path/nvidia-cdi-hook\",\n\t\t\t\tfixedArgs: []string{\"nvidia-cdi-hook\"},\n\t\t\t\tdisabledHooks: map[HookName]bool{\n\t\t\t\t\tChmodHook: true,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"AllHooks disabled returns allDisabledHookCreator\",\n\t\t\topts: []Option{\n\t\t\t\tWithDisabledHooks(AllHooks),\n\t\t\t},\n\t\t\texpected: &allDisabledHookCreator{},\n\t\t},\n\t\t{\n\t\t\tname: \"AllHooks disabled but UpdateLDCacheHook enabled\",\n\t\t\topts: []Option{\n\t\t\t\tWithDisabledHooks(AllHooks),\n\t\t\t\tWithEnabledHooks(UpdateLDCacheHook),\n\t\t\t},\n\t\t\texpected: &cdiHookCreator{\n\t\t\t\tnvidiaCDIHookPath: defaultNvidiaCDIHookPath,\n\t\t\t\tfixedArgs: []string{\"nvidia-cdi-hook\"},\n\t\t\t\tdisabledHooks: map[HookName]bool{\n\t\t\t\t\tAllHooks: true,\n\t\t\t\t\tUpdateLDCacheHook: false,\n\t\t\t\t\tChmodHook: true,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"multiple hooks disabled and enabled\",\n\t\t\topts: []Option{\n\t\t\t\tWithDisabledHooks(UpdateLDCacheHook, CreateSymlinksHook, EnableCudaCompatHook, DisableDeviceNodeModificationHook),\n\t\t\t\tWithEnabledHooks(ChmodHook, UpdateLDCacheHook),\n\t\t\t},\n\t\t\texpected: &cdiHookCreator{\n\t\t\t\tnvidiaCDIHookPath: defaultNvidiaCDIHookPath,\n\t\t\t\tfixedArgs: []string{\"nvidia-cdi-hook\"},\n\t\t\t\tdisabledHooks: map[HookName]bool{\n\t\t\t\t\tUpdateLDCacheHook: false,\n\t\t\t\t\tCreateSymlinksHook: true,\n\t\t\t\t\tEnableCudaCompatHook: true,\n\t\t\t\t\tChmodHook: false,\n\t\t\t\t\tDisableDeviceNodeModificationHook: true,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"WithDisabledHooks can be called multiple times\",\n\t\t\topts: []Option{\n\t\t\t\tWithDisabledHooks(UpdateLDCacheHook),\n\t\t\t\tWithDisabledHooks(CreateSymlinksHook),\n\t\t\t\tWithDisabledHooks(EnableCudaCompatHook),\n\t\t\t},\n\t\t\texpected: &cdiHookCreator{\n\t\t\t\tnvidiaCDIHookPath: defaultNvidiaCDIHookPath,\n\t\t\t\tfixedArgs: []string{\"nvidia-cdi-hook\"},\n\t\t\t\tdisabledHooks: map[HookName]bool{\n\t\t\t\t\tUpdateLDCacheHook: true,\n\t\t\t\t\tCreateSymlinksHook: true,\n\t\t\t\t\tEnableCudaCompatHook: true,\n\t\t\t\t\tChmodHook: true, // Default disabled\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"WithEnabledHooks overrides defaultDisabledHooks\",\n\t\t\topts: []Option{\n\t\t\t\tWithEnabledHooks(ChmodHook),\n\t\t\t},\n\t\t\texpected: &cdiHookCreator{\n\t\t\t\tnvidiaCDIHookPath: defaultNvidiaCDIHookPath,\n\t\t\t\tfixedArgs: []string{\"nvidia-cdi-hook\"},\n\t\t\t\tdisabledHooks: map[HookName]bool{\n\t\t\t\t\tChmodHook: false, // ChmodHook is enabled\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"nvidia-ctk binary path affects fixed args\",\n\t\t\topts: []Option{\n\t\t\t\tWithNVIDIACDIHookPath(\"/usr/bin/nvidia-ctk\"),\n\t\t\t},\n\t\t\texpected: &cdiHookCreator{\n\t\t\t\tnvidiaCDIHookPath: \"/usr/bin/nvidia-ctk\",\n\t\t\t\tfixedArgs: []string{\"nvidia-ctk\", \"hook\"},\n\t\t\t\tdisabledHooks: map[HookName]bool{\n\t\t\t\t\tChmodHook: true,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"nvidia-ctk in custom NVIDIA toolkit path\",\n\t\t\topts: []Option{\n\t\t\t\tWithNVIDIACDIHookPath(\"/usr/local/nvidia/toolkit/nvidia-ctk\"),\n\t\t\t},\n\t\t\texpected: &cdiHookCreator{\n\t\t\t\tnvidiaCDIHookPath: \"/usr/local/nvidia/toolkit/nvidia-ctk\",\n\t\t\t\tfixedArgs: []string{\"nvidia-ctk\", \"hook\"},\n\t\t\t\tdisabledHooks: map[HookName]bool{\n\t\t\t\t\tChmodHook: true,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.name, func(t *testing.T) {\n\t\t\thookCreator := NewHookCreator(tc.opts...)\n\n\t\t\trequire.EqualValues(t, tc.expected, hookCreator)\n\t\t})\n\t}\n}\nfunc TestCDIHookCreator_Create(t *testing.T) {\n\ttestCases := []struct {\n\t\tname string\n\t\thookCreator HookCreator\n\t\thookName HookName\n\t\targs []string\n\t\texpectedHook *Hook\n\t}{\n\t\t{\n\t\t\tname: \"CreateSymlinksHook with args\",\n\t\t\thookCreator: NewHookCreator(WithNVIDIACDIHookPath(defaultNvidiaCDIHookPath)),\n\t\t\thookName: CreateSymlinksHook,\n\t\t\targs: []string{\"/source::/target\", \"/source2::/target2\"},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"/source::/target\", \"--link\", \"/source2::/target2\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"CreateSymlinksHook without args returns nil\",\n\t\t\thookCreator: NewHookCreator(WithNVIDIACDIHookPath(defaultNvidiaCDIHookPath)),\n\t\t\thookName: CreateSymlinksHook,\n\t\t\targs: []string{},\n\t\t\texpectedHook: nil,\n\t\t},\n\t\t{\n\t\t\tname: \"ChmodHook with args (when enabled)\",\n\t\t\thookCreator: NewHookCreator(\n\t\t\t\tWithNVIDIACDIHookPath(defaultNvidiaCDIHookPath),\n\t\t\t\tWithEnabledHooks(ChmodHook),\n\t\t\t),\n\t\t\thookName: ChmodHook,\n\t\t\targs: []string{\"/path/to/file1\", \"/path/to/file2\"},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: defaultNvidiaCDIHookPath,\n\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/path/to/file1\", \"--path\", \"/path/to/file2\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"ChmodHook disabled by default returns nil\",\n\t\t\thookCreator: NewHookCreator(WithNVIDIACDIHookPath(defaultNvidiaCDIHookPath)),\n\t\t\thookName: ChmodHook,\n\t\t\targs: []string{\"/path/to/file\"},\n\t\t\texpectedHook: nil, // ChmodHook is disabled by default\n\t\t},\n\t\t{\n\t\t\tname: \"UpdateLDCacheHook with no args\",\n\t\t\thookCreator: NewHookCreator(WithNVIDIACDIHookPath(defaultNvidiaCDIHookPath)),\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: defaultNvidiaCDIHookPath,\n\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"UpdateLDCacheHook with args\",\n\t\t\thookCreator: NewHookCreator(WithNVIDIACDIHookPath(defaultNvidiaCDIHookPath)),\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{\"/usr/lib64\"},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: defaultNvidiaCDIHookPath,\n\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/usr/lib64\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"EnableCudaCompatHook\",\n\t\t\thookCreator: NewHookCreator(),\n\t\t\thookName: EnableCudaCompatHook,\n\t\t\targs: []string{\"--root\", \"/some/root\"},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: defaultNvidiaCDIHookPath,\n\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"enable-cuda-compat\", \"--root\", \"/some/root\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"DisableDeviceNodeModificationHook\",\n\t\t\thookCreator: NewHookCreator(WithNVIDIACDIHookPath(defaultNvidiaCDIHookPath)),\n\t\t\thookName: DisableDeviceNodeModificationHook,\n\t\t\targs: []string{},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: defaultNvidiaCDIHookPath,\n\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"disable-device-node-modification\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"nvidia-ctk binary uses different args format\",\n\t\t\thookCreator: NewHookCreator(WithNVIDIACDIHookPath(\"/usr/bin/nvidia-ctk\")),\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: \"/usr/bin/nvidia-ctk\",\n\t\t\t\tArgs: []string{\"nvidia-ctk\", \"hook\", \"update-ldcache\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"nvidia-ctk in custom NVIDIA toolkit path\",\n\t\t\thookCreator: NewHookCreator(\n\t\t\t\tWithNVIDIACDIHookPath(\"/usr/local/nvidia/toolkit/nvidia-ctk\"),\n\t\t\t),\n\t\t\thookName: EnableCudaCompatHook,\n\t\t\targs: []string{\"--root\", \"/some/root\"},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: \"/usr/local/nvidia/toolkit/nvidia-ctk\",\n\t\t\t\tArgs: []string{\"nvidia-ctk\", \"hook\", \"enable-cuda-compat\", \"--root\", \"/some/root\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tname: \"hook disabled when in disabledHooks list\",\n\t\t\thookCreator: NewHookCreator(WithDisabledHooks(UpdateLDCacheHook)),\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{},\n\t\t\texpectedHook: nil,\n\t\t},\n\t\t{\n\t\t\tname: \"allDisabled with unknown hook\",\n\t\t\thookCreator: &allDisabledHookCreator{},\n\t\t\thookName: HookName(\"unknown-hook\"),\n\t\t\targs: []string{},\n\t\t\texpectedHook: nil,\n\t\t},\n\t\t{\n\t\t\tname: \"allDisabled with defined hook\",\n\t\t\thookCreator: &allDisabledHookCreator{},\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{},\n\t\t\texpectedHook: nil,\n\t\t},\n\t\t{\n\t\t\tname: \"debug logging enabled\",\n\t\t\thookCreator: NewHookCreator(WithDebugLogging(true)),\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{},\n\t\t\texpectedHook: &Hook{\n\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\tPath: defaultNvidiaCDIHookPath,\n\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\"},\n\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=true\"},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.name, func(t *testing.T) {\n\t\t\thookCreator := tc.hookCreator\n\n\t\t\thook := hookCreator.Create(tc.hookName, tc.args...)\n\t\t\trequire.Equal(t, tc.expectedHook, hook)\n\t\t})\n\t}\n}\n\nfunc TestCDIHookCreator_isDisabled(t *testing.T) {\n\ttests := []struct {\n\t\tname string\n\t\tdisabledHooks []HookName\n\t\tenabledHooks []HookName\n\t\thookName HookName\n\t\targs []string\n\t\texpectedResult bool\n\t}{\n\t\t{\n\t\t\tname: \"hook explicitly disabled\",\n\t\t\tdisabledHooks: []HookName{ChmodHook},\n\t\t\thookName: ChmodHook,\n\t\t\targs: []string{\"/path/to/file\"},\n\t\t\texpectedResult: true, // ChmodHook is disabled by default and explicitly disabled\n\t\t},\n\t\t{\n\t\t\tname: \"hook explicitly enabled overrides disabled\",\n\t\t\tdisabledHooks: []HookName{ChmodHook},\n\t\t\tenabledHooks: []HookName{ChmodHook},\n\t\t\thookName: ChmodHook,\n\t\t\targs: []string{\"/path/to/file\"},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"hook not in disabled map and not AllHooks disabled\",\n\t\t\tdisabledHooks: []HookName{ChmodHook},\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"CreateSymlinksHook requires args - no args provided\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: CreateSymlinksHook,\n\t\t\targs: []string{},\n\t\t\texpectedResult: true,\n\t\t},\n\t\t{\n\t\t\tname: \"CreateSymlinksHook requires args - args provided\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: CreateSymlinksHook,\n\t\t\targs: []string{\"/path/to/symlink\"},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"ChmodHook requires args - no args provided\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: ChmodHook,\n\t\t\targs: []string{},\n\t\t\texpectedResult: true,\n\t\t},\n\t\t{\n\t\t\tname: \"ChmodHook requires args - args provided\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\tenabledHooks: []HookName{ChmodHook}, // Enable ChmodHook since it's disabled by default\n\t\t\thookName: ChmodHook,\n\t\t\targs: []string{\"/path/to/file\"},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"UpdateLDCacheHook doesn't require args - no args provided\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"UpdateLDCacheHook doesn't require args - args provided\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{\"arg1\", \"arg2\"},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"EnableCudaCompatHook doesn't require args - no args provided\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: EnableCudaCompatHook,\n\t\t\targs: []string{},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"DisableDeviceNodeModificationHook doesn't require args - no args provided\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: DisableDeviceNodeModificationHook,\n\t\t\targs: []string{},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t// Edge cases\n\t\t{\n\t\t\tname: \"nil disabled hooks map\",\n\t\t\tdisabledHooks: nil,\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"unknown hook name\",\n\t\t\tdisabledHooks: []HookName{ChmodHook},\n\t\t\thookName: HookName(\"unknown-hook\"),\n\t\t\targs: []string{},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t// Multiple args tests\n\t\t{\n\t\t\tname: \"CreateSymlinksHook with multiple args\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: CreateSymlinksHook,\n\t\t\targs: []string{\"/path1\", \"/path2\", \"/path3\"},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"ChmodHook with multiple args\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\tenabledHooks: []HookName{ChmodHook}, // Enable ChmodHook since it's disabled by default\n\t\t\thookName: ChmodHook,\n\t\t\targs: []string{\"/path1\", \"/path2\"},\n\t\t\texpectedResult: false,\n\t\t},\n\t\t{\n\t\t\tname: \"UpdateLDCacheHook with multiple args\",\n\t\t\tdisabledHooks: []HookName{},\n\t\t\thookName: UpdateLDCacheHook,\n\t\t\targs: []string{\"arg1\", \"arg2\", \"arg3\"},\n\t\t\texpectedResult: false,\n\t\t},\n\t}\n\n\tfor _, tt := range tests {\n\t\tt.Run(tt.name, func(t *testing.T) {\n\t\t\ttestCreator := NewHookCreator(\n\t\t\t\tWithDisabledHooks(tt.disabledHooks...),\n\t\t\t\tWithEnabledHooks(tt.enabledHooks...),\n\t\t\t)\n\n\t\t\trequire.Equal(t, testCreator.(*cdiHookCreator).isDisabled(tt.hookName, tt.args...), tt.expectedResult)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/ipc.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// ipcMountOptions defines the mount options for IPC sockets.\nvar ipcMountOptions = []string{\n\t\"nosuid\",\n\t\"nodev\",\n\t\"rbind\",\n\t\"rprivate\",\n\t\"noexec\",\n}\n\ntype ipcMounts mounts\n\n// NewIPCDiscoverer creats a discoverer for NVIDIA IPC sockets.\nfunc NewIPCDiscoverer(logger logger.Interface, driverRoot string) (Discover, error) {\n\tsockets := newMounts(\n\t\tlogger,\n\t\tlookup.NewFileLocator(\n\t\t\tlookup.WithLogger(logger),\n\t\t\tlookup.WithRoot(driverRoot),\n\t\t\tlookup.WithSearchPaths(\"/run\", \"/var/run\"),\n\t\t\tlookup.WithCount(1),\n\t\t),\n\t\tdriverRoot,\n\t\t[]string{\n\t\t\t\"/nvidia-persistenced/socket\",\n\t\t\t\"/nvidia-fabricmanager/socket\",\n\t\t},\n\t)\n\n\tmps := newMounts(\n\t\tlogger,\n\t\tlookup.NewFileLocator(\n\t\t\tlookup.WithLogger(logger),\n\t\t\tlookup.WithRoot(driverRoot),\n\t\t\tlookup.WithCount(1),\n\t\t),\n\t\tdriverRoot,\n\t\t[]string{\n\t\t\t\"/tmp/nvidia-mps\",\n\t\t},\n\t)\n\n\td := Merge(\n\t\t(*ipcMounts)(sockets),\n\t\t(*ipcMounts)(mps),\n\t)\n\treturn d, nil\n}\n\n// Mounts returns the discovered mounts with IPC-specific mount options.\nfunc (d *ipcMounts) Mounts() ([]Mount, error) {\n\tmounts, err := (*mounts)(d).Mounts()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar modifiedMounts []Mount\n\tfor _, m := range mounts {\n\t\tmount := m\n\t\tmount.Options = ipcMountOptions\n\t\tmodifiedMounts = append(modifiedMounts, mount)\n\t}\n\n\treturn modifiedMounts, nil\n}\n"
},
{
"path": "internal/discover/ipc_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nfunc TestIPCMounts(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\tl := ipcMounts(\n\t\tmounts{\n\t\t\tlogger: logger,\n\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(path string) ([]string, error) {\n\t\t\t\t\treturn []string{\"/host/path\"}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\trequired: []string{\"target\"},\n\t\t},\n\t)\n\n\tmounts, err := l.Mounts()\n\trequire.NoError(t, err)\n\n\trequire.EqualValues(\n\t\tt,\n\t\t[]Mount{\n\t\t\t{\n\t\t\t\tHostPath: \"/host/path\",\n\t\t\t\tPath: \"/host/path\",\n\t\t\t\tOptions: []string{\n\t\t\t\t\t\"nosuid\",\n\t\t\t\t\t\"nodev\",\n\t\t\t\t\t\"rbind\",\n\t\t\t\t\t\"rprivate\",\n\t\t\t\t\t\"noexec\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\tmounts,\n\t)\n}\n"
},
{
"path": "internal/discover/ldconfig.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// NewLDCacheUpdateHook creates a discoverer that updates the ldcache for the specified mounts. A logger can also be specified\nfunc NewLDCacheUpdateHook(logger logger.Interface, mounts Discover, hookCreator HookCreator) (Discover, error) {\n\td := ldconfig{\n\t\tlogger: logger,\n\t\thookCreator: hookCreator,\n\t\tmountsFrom: mounts,\n\t}\n\n\treturn &d, nil\n}\n\ntype ldconfig struct {\n\tNone\n\tlogger logger.Interface\n\thookCreator HookCreator\n\tmountsFrom Discover\n}\n\n// Hooks checks the required mounts for libraries and returns a hook to update the LDcache for the discovered paths.\nfunc (d ldconfig) Hooks() ([]Hook, error) {\n\tmounts, err := d.mountsFrom.Mounts()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover mounts for ldcache update: %v\", err)\n\t}\n\n\tlibraryFolders := uniqueFolders(getLibraryPaths(mounts))\n\n\treturn d.hookCreator.Create(UpdateLDCacheHook, libraryFolders...).Hooks()\n}\n\n// getLibraryPaths extracts the library dirs from the specified mounts\nfunc getLibraryPaths(mounts []Mount) []string {\n\tvar paths []string\n\tfor _, m := range mounts {\n\t\tif !isLibName(m.Path) {\n\t\t\tcontinue\n\t\t}\n\t\tpaths = append(paths, m.Path)\n\t}\n\treturn paths\n}\n\n// isLibName checks if the specified filename is a library (i.e. ends in `.so*`)\nfunc isLibName(filename string) bool {\n\tbase := filepath.Base(filename)\n\n\tisLib, err := filepath.Match(\"lib?*.so*\", base)\n\tif !isLib || err != nil {\n\t\treturn false\n\t}\n\n\tparts := strings.Split(base, \".so\")\n\tif len(parts) == 1 {\n\t\treturn true\n\t}\n\n\treturn parts[len(parts)-1] == \"\" || strings.HasPrefix(parts[len(parts)-1], \".\")\n}\n\n// uniqueFolders returns the unique set of folders for the specified files\nfunc uniqueFolders(libraries []string) []string {\n\tvar paths []string\n\tchecked := make(map[string]bool)\n\n\tfor _, l := range libraries {\n\t\tdir := filepath.Dir(l)\n\t\tif dir == \"\" {\n\t\t\tcontinue\n\t\t}\n\t\tif checked[dir] {\n\t\t\tcontinue\n\t\t}\n\t\tchecked[dir] = true\n\t\tpaths = append(paths, dir)\n\t}\n\treturn paths\n}\n"
},
{
"path": "internal/discover/ldconfig_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nconst (\n\ttestNvidiaCDIHookPath = \"/foo/bar/nvidia-cdi-hook\"\n\ttestLdconfigPath = \"/bar/baz/ldconfig\"\n)\n\nfunc TestLDCacheUpdateHook(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tldconfigPath string\n\t\tmounts []Mount\n\t\tmountError error\n\t\texpectedError error\n\t\texpectedHooks []Hook\n\t}{\n\t\t{\n\t\t\tdescription: \"empty mounts\",\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: testNvidiaCDIHookPath,\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mount error\",\n\t\t\tmountError: fmt.Errorf(\"mountError\"),\n\t\t\texpectedError: fmt.Errorf(\"mountError\"),\n\t\t},\n\t\t{\n\t\t\tdescription: \"library folders are added to args\",\n\t\t\tmounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/local/lib/libfoo.so\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/bin/notlib\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/local/libother/libfoo.so\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/local/lib/libbar.so\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: testNvidiaCDIHookPath,\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/usr/local/lib\", \"--folder\", \"/usr/local/libother\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"host paths are ignored\",\n\t\t\tmounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tHostPath: \"/usr/local/other/libfoo.so\",\n\t\t\t\t\tPath: \"/usr/local/lib/libfoo.so\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: testNvidiaCDIHookPath,\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/usr/local/lib\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"explicit ldconfig path is passed\",\n\t\t\tldconfigPath: testLdconfigPath,\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: testNvidiaCDIHookPath,\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--ldconfig-path\", testLdconfigPath},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\thookCreator := NewHookCreator(\n\t\t\t\tWithNVIDIACDIHookPath(testNvidiaCDIHookPath),\n\t\t\t\tWithLdconfigPath(tc.ldconfigPath),\n\t\t\t)\n\t\t\tmountMock := &DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\treturn tc.mounts, tc.mountError\n\t\t\t\t},\n\t\t\t}\n\t\t\td, err := NewLDCacheUpdateHook(logger, mountMock, hookCreator)\n\t\t\trequire.NoError(t, err)\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.Len(t, mountMock.MountsCalls(), 1)\n\t\t\trequire.Len(t, mountMock.DevicesCalls(), 0)\n\t\t\trequire.Len(t, mountMock.HooksCalls(), 0)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedHooks, hooks)\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, devices)\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, mounts)\n\t\t})\n\t}\n}\n\nfunc TestIsLibName(t *testing.T) {\n\ttestCases := []struct {\n\t\tname string\n\t\tisLib bool\n\t}{\n\t\t{\n\t\t\tname: \"\",\n\t\t\tisLib: false,\n\t\t},\n\t\t{\n\t\t\tname: \"lib/not/.so\",\n\t\t\tisLib: false,\n\t\t},\n\t\t{\n\t\t\tname: \"lib.so\",\n\t\t\tisLib: false,\n\t\t},\n\t\t{\n\t\t\tname: \"notlibcuda.so\",\n\t\t\tisLib: false,\n\t\t},\n\t\t{\n\t\t\tname: \"libcuda.so\",\n\t\t\tisLib: true,\n\t\t},\n\t\t{\n\t\t\tname: \"libcuda.so.1\",\n\t\t\tisLib: true,\n\t\t},\n\t\t{\n\t\t\tname: \"libcuda.soNOT\",\n\t\t\tisLib: false,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.name, func(t *testing.T) {\n\t\t\trequire.Equal(t, tc.isLib, isLibName(tc.name))\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/list.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage discover\n\nimport \"fmt\"\n\n// list is a discoverer that contains a list of Discoverers. The output of the\n// Mounts functions is the concatenation of the output for each of the\n// elements in the list.\ntype list []Discover\n\nvar _ Discover = (*list)(nil)\n\n// Merge creates a discoverer that is the composite of a list of discoverers.\nfunc Merge(discoverers ...Discover) Discover {\n\tvar l list\n\tfor _, d := range discoverers {\n\t\tif d == nil {\n\t\t\tcontinue\n\t\t}\n\t\tl = append(l, d)\n\t}\n\n\treturn l\n}\n\n// Devices returns all devices from the included discoverers\nfunc (d list) Devices() ([]Device, error) {\n\tvar allDevices []Device\n\n\tfor i, di := range d {\n\t\tdevices, err := di.Devices()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error discovering devices for discoverer %v: %v\", i, err)\n\t\t}\n\t\tallDevices = append(allDevices, devices...)\n\t}\n\n\treturn allDevices, nil\n}\n\n// EnvVars returns all environment variables from the included discoverers.\nfunc (d list) EnvVars() ([]EnvVar, error) {\n\tvar allEnvs []EnvVar\n\n\tfor i, di := range d {\n\t\tenvs, err := di.EnvVars()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error discovering envs for discoverer %v: %w\", i, err)\n\t\t}\n\t\tallEnvs = append(allEnvs, envs...)\n\t}\n\n\treturn allEnvs, nil\n}\n\n// Mounts returns all mounts from the included discoverers\nfunc (d list) Mounts() ([]Mount, error) {\n\tvar allMounts []Mount\n\n\tfor i, di := range d {\n\t\tmounts, err := di.Mounts()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error discovering mounts for discoverer %v: %v\", i, err)\n\t\t}\n\t\tallMounts = append(allMounts, mounts...)\n\t}\n\n\treturn allMounts, nil\n}\n\n// Hooks returns all Hooks from the included discoverers\nfunc (d list) Hooks() ([]Hook, error) {\n\tvar allHooks []Hook\n\n\tfor i, di := range d {\n\t\thooks, err := di.Hooks()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error discovering hooks for discoverer %v: %v\", i, err)\n\t\t}\n\t\tallHooks = append(allHooks, hooks...)\n\t}\n\n\treturn allHooks, nil\n}\n"
},
{
"path": "internal/discover/mofed.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n)\n\n// NewMOFEDDiscoverer creates a discoverer for MOFED devices.\nfunc NewMOFEDDiscoverer(logger logger.Interface, driver *root.Driver) (Discover, error) {\n\tdevices := NewCharDeviceDiscoverer(\n\t\tlogger,\n\t\tdriver.DevRoot,\n\t\t[]string{\n\t\t\t\"/dev/infiniband/uverbs*\",\n\t\t\t\"/dev/infiniband/rdma_cm\",\n\t\t},\n\t)\n\n\treturn devices, nil\n}\n"
},
{
"path": "internal/discover/mofed_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover_test\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestNewMOFEDDiscoverer(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\trootfs string\n\t\texpectedDevices []discover.Device\n\t}{\n\t\t{\n\t\t\tdescription: \"empty rootfs returns no devices\",\n\t\t\trootfs: \"rootfs-empty\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"rootfs with device nodes returns devices\",\n\t\t\trootfs: \"rootfs-1\",\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{Path: \"/dev/infiniband/uverbs0\", HostPath: \"/dev/infiniband/uverbs0\"},\n\t\t\t\t{Path: \"/dev/infiniband/rdma_cm\", HostPath: \"/dev/infiniband/rdma_cm\"},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdevRoot := filepath.Join(lookupRoot, tc.rootfs)\n\t\t\tdriver := root.New(root.WithDevRoot(devRoot))\n\t\t\td, err := discover.NewMOFEDDiscoverer(logger, driver)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedDevices, test.StripRoot(devices, devRoot))\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, mounts)\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, hooks)\n\n\t\t\tenvVars, err := d.EnvVars()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, envVars)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/mounts-to-container-path.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// mountsToContainerPath defines a Discoverer for a required set of mounts.\n// When these are discovered by a locator the specified container root is used\n// to construct the container path for the mount returned.\ntype mountsToContainerPath struct {\n\tNone\n\tlogger logger.Interface\n\tlocator lookup.Locator\n\trequired []string\n\tcontainerRoot string\n}\n\nfunc (d *mountsToContainerPath) Mounts() ([]Mount, error) {\n\tseen := make(map[string]bool)\n\tvar mounts []Mount\n\tfor _, target := range d.required {\n\t\tif strings.Contains(target, \"*\") {\n\t\t\t// TODO: We could relax this condition.\n\t\t\treturn nil, fmt.Errorf(\"wildcard patterns are not supported: %s\", target)\n\t\t}\n\t\tcandidates, err := d.locator.Locate(target)\n\t\tif err != nil {\n\t\t\td.logger.Warningf(\"Could not locate %v: %v\", target, err)\n\t\t\tcontinue\n\t\t}\n\t\tif len(candidates) == 0 {\n\t\t\td.logger.Warningf(\"Missing %v\", target)\n\t\t\tcontinue\n\t\t}\n\t\thostPath := candidates[0]\n\t\tif seen[hostPath] {\n\t\t\td.logger.Debugf(\"Skipping duplicate mount %v\", hostPath)\n\t\t\tcontinue\n\t\t}\n\t\tseen[hostPath] = true\n\t\td.logger.Debugf(\"Located %v as %v\", target, hostPath)\n\n\t\tcontainerPath := filepath.Join(d.containerRoot, target)\n\t\td.logger.Infof(\"Selecting %v as %v\", hostPath, containerPath)\n\n\t\tmount := Mount{\n\t\t\tHostPath: hostPath,\n\t\t\tPath: containerPath,\n\t\t\tOptions: []string{\n\t\t\t\t\"ro\",\n\t\t\t\t\"nosuid\",\n\t\t\t\t\"nodev\",\n\t\t\t\t\"rbind\",\n\t\t\t\t\"rprivate\",\n\t\t\t},\n\t\t}\n\t\tmounts = append(mounts, mount)\n\t}\n\n\treturn mounts, nil\n}\n"
},
{
"path": "internal/discover/mounts-to-container-path_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nfunc TestMountsToContainerPath(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\tmountOptions := []string{\n\t\t\"ro\",\n\t\t\"nosuid\",\n\t\t\"nodev\",\n\t\t\"rbind\",\n\t\t\"rprivate\",\n\t}\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\trequired []string\n\t\tlocator lookup.Locator\n\t\tcontainerRoot string\n\t\texpectedMounts []Mount\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"containerRoot is prepended\",\n\t\t\trequired: []string{\"a/path/exists.txt\", \"another/path/exists.txt\"},\n\t\t\tlocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\treturn []string{\"/located/root/\" + s}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tcontainerRoot: \"/container\",\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tHostPath: \"/located/root/a/path/exists.txt\",\n\t\t\t\t\tPath: \"/container/a/path/exists.txt\",\n\t\t\t\t\tOptions: mountOptions,\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tHostPath: \"/located/root/another/path/exists.txt\",\n\t\t\t\t\tPath: \"/container/another/path/exists.txt\",\n\t\t\t\t\tOptions: mountOptions,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicate mounts are skipped\",\n\t\t\trequired: []string{\"a/path/exists.txt\", \"another/path/exists.txt\"},\n\t\t\tlocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\treturn []string{\"/located/root/single.txt\"}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tcontainerRoot: \"/container\",\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tHostPath: \"/located/root/single.txt\",\n\t\t\t\t\tPath: \"/container/a/path/exists.txt\",\n\t\t\t\t\tOptions: mountOptions,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"locator errors are ignored\",\n\t\t\trequired: []string{\"a/path/exists.txt\"},\n\t\t\tlocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\treturn nil, errors.New(\"not found\")\n\t\t\t\t},\n\t\t\t},\n\t\t\tcontainerRoot: \"/container\",\n\t\t\texpectedMounts: []Mount{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"not located are ignored\",\n\t\t\trequired: []string{\"a/path/exists.txt\"},\n\t\t\tlocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tcontainerRoot: \"/container\",\n\t\t\texpectedMounts: []Mount{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"second candidate is ignored\",\n\t\t\trequired: []string{\"a/path/exists.txt\"},\n\t\t\tlocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\treturn []string{\"/located/root/\" + s, \"/located2/root/\" + s}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tcontainerRoot: \"/container\",\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tHostPath: \"/located/root/a/path/exists.txt\",\n\t\t\t\t\tPath: \"/container/a/path/exists.txt\",\n\t\t\t\t\tOptions: mountOptions,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\td := mountsToContainerPath{\n\t\t\t\tlogger: logger,\n\t\t\t\tlocator: tc.locator,\n\t\t\t\trequired: tc.required,\n\t\t\t\tcontainerRoot: tc.containerRoot,\n\t\t\t}\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, devices)\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, hooks)\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\trequire.ElementsMatch(t, tc.expectedMounts, mounts)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/mounts.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage discover\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// mounts is a generic discoverer for Mounts. It is customized by specifying the\n// required entities as a list and a Locator that is used to find the target mounts\n// based on the entry in the list.\ntype mounts struct {\n\tNone\n\tlogger logger.Interface\n\tlookup lookup.Locator\n\troot string\n\trequired []string\n}\n\nvar _ Discover = (*mounts)(nil)\n\n// NewMounts creates a discoverer for the required mounts using the specified locator.\nfunc NewMounts(logger logger.Interface, lookup lookup.Locator, root string, required []string) Discover {\n\treturn WithCache(newMounts(logger, lookup, root, required))\n}\n\n// newMounts creates a discoverer for the required mounts using the specified locator.\nfunc newMounts(logger logger.Interface, lookup lookup.Locator, root string, required []string) *mounts {\n\treturn &mounts{\n\t\tlogger: logger,\n\t\tlookup: lookup,\n\t\troot: filepath.Join(\"/\", root),\n\t\trequired: required,\n\t}\n}\n\nfunc (d *mounts) Mounts() ([]Mount, error) {\n\tif d.lookup == nil {\n\t\treturn nil, fmt.Errorf(\"no lookup defined\")\n\t}\n\n\tvar mounts []Mount\n\tseen := make(map[string]bool)\n\tfor _, candidate := range d.required {\n\t\td.logger.Debugf(\"Locating %v\", candidate)\n\t\tlocated, err := d.lookup.Locate(candidate)\n\t\tif err != nil {\n\t\t\td.logger.Warningf(\"Could not locate %v: %v\", candidate, err)\n\t\t\tcontinue\n\t\t}\n\t\tif len(located) == 0 {\n\t\t\td.logger.Warningf(\"Missing %v\", candidate)\n\t\t\tcontinue\n\t\t}\n\t\td.logger.Debugf(\"Located %v as %v\", candidate, located)\n\t\tfor _, p := range located {\n\t\t\tif seen[p] {\n\t\t\t\td.logger.Debugf(\"Skipping duplicate mount %v\", p)\n\t\t\t\tcontinue\n\t\t\t}\n\n\t\t\tr := d.relativeTo(p)\n\t\t\tif r == \"\" {\n\t\t\t\tr = p\n\t\t\t}\n\n\t\t\td.logger.Infof(\"Selecting %v as %v\", p, r)\n\t\t\tmount := Mount{\n\t\t\t\tHostPath: p,\n\t\t\t\tPath: r,\n\t\t\t\tOptions: []string{\n\t\t\t\t\t\"ro\",\n\t\t\t\t\t\"nosuid\",\n\t\t\t\t\t\"nodev\",\n\t\t\t\t\t\"rbind\",\n\t\t\t\t\t\"rprivate\",\n\t\t\t\t},\n\t\t\t}\n\t\t\tmounts = append(mounts, mount)\n\t\t\tseen[p] = true\n\t\t}\n\t}\n\n\treturn mounts, nil\n}\n\n// relativeTo returns the path relative to the root for the file locator\nfunc (d *mounts) relativeTo(path string) string {\n\tif d.root == \"/\" {\n\t\treturn path\n\t}\n\n\treturn strings.TrimPrefix(path, d.root)\n}\n"
},
{
"path": "internal/discover/mounts_test.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage discover\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n)\n\nfunc TestMountsReturnsEmptyDevices(t *testing.T) {\n\td := mounts{}\n\tdevices, err := d.Devices()\n\n\trequire.NoError(t, err)\n\trequire.Empty(t, devices)\n}\n\nfunc TestMounts(t *testing.T) {\n\n\tmountOptions := []string{\n\t\t\"ro\",\n\t\t\"nosuid\",\n\t\t\"nodev\",\n\t\t\"rbind\",\n\t\t\"rprivate\",\n\t}\n\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\texpectedError error\n\t\texpectedMounts []Mount\n\t\tinput *mounts\n\t\trepeat int\n\t}{\n\t\t{\n\t\t\tdescription: \"nill lookup returns error\",\n\t\t\texpectedError: fmt.Errorf(\"no lookup defined\"),\n\t\t\tinput: &mounts{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty required returns no mounts\",\n\t\t\texpectedError: nil,\n\t\t\tinput: &mounts{\n\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\tLocateFunc: func(string) ([]string, error) {\n\t\t\t\t\t\treturn []string{\"located\"}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"required returns located\",\n\t\t\texpectedError: nil,\n\t\t\tinput: &mounts{\n\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\tLocateFunc: func(string) ([]string, error) {\n\t\t\t\t\t\treturn []string{\"located\"}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\trequired: []string{\"required\"},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{{Path: \"located\", HostPath: \"located\", Options: mountOptions}},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mounts removes located duplicates\",\n\t\t\texpectedError: nil,\n\t\t\tinput: &mounts{\n\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\tLocateFunc: func(string) ([]string, error) {\n\t\t\t\t\t\treturn []string{\"located\"}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\trequired: []string{\"required0\", \"required1\"},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{{Path: \"located\", HostPath: \"located\", Options: mountOptions}},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mounts skips located errors\",\n\t\t\tinput: &mounts{\n\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\t\tif s == \"error\" {\n\t\t\t\t\t\t\treturn nil, fmt.Errorf(\"error\")\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn []string{s}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\trequired: []string{\"required0\", \"error\", \"required1\"},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{{Path: \"required0\", HostPath: \"required0\", Options: mountOptions}, {Path: \"required1\", HostPath: \"required1\", Options: mountOptions}},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mounts skips unlocated\",\n\t\t\tinput: &mounts{\n\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\t\tif s == \"empty\" {\n\t\t\t\t\t\t\treturn nil, nil\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn []string{s}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\trequired: []string{\"required0\", \"empty\", \"required1\"},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{{Path: \"required0\", HostPath: \"required0\", Options: mountOptions}, {Path: \"required1\", HostPath: \"required1\", Options: mountOptions}},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mounts adds multiple\",\n\t\t\tinput: &mounts{\n\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\t\tif s == \"multiple\" {\n\t\t\t\t\t\t\treturn []string{\"multiple0\", \"multiple1\"}, nil\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn []string{s}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\trequired: []string{\"required0\", \"multiple\", \"required1\"},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{Path: \"required0\", HostPath: \"required0\", Options: mountOptions},\n\t\t\t\t{Path: \"multiple0\", HostPath: \"multiple0\", Options: mountOptions},\n\t\t\t\t{Path: \"multiple1\", HostPath: \"multiple1\", Options: mountOptions},\n\t\t\t\t{Path: \"required1\", HostPath: \"required1\", Options: mountOptions},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mounts uses relative path\",\n\t\t\tinput: &mounts{\n\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\t\treturn []string{\"/some/root/located\"}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\troot: \"/some/root\",\n\t\t\t\trequired: []string{\"required0\", \"multiple\", \"required1\"},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{Path: \"/located\", HostPath: \"/some/root/located\", Options: mountOptions},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple mounts ordering\",\n\t\t\tinput: &mounts{\n\t\t\t\tlookup: &lookup.LocatorMock{\n\t\t\t\t\tLocateFunc: func(s string) ([]string, error) {\n\t\t\t\t\t\treturn []string{\n\t\t\t\t\t\t\t\"first\",\n\t\t\t\t\t\t\t\"second\",\n\t\t\t\t\t\t\t\"third\",\n\t\t\t\t\t\t\t\"fourth\",\n\t\t\t\t\t\t\t\"second\",\n\t\t\t\t\t\t\t\"second\",\n\t\t\t\t\t\t\t\"second\",\n\t\t\t\t\t\t\t\"fifth\",\n\t\t\t\t\t\t\t\"sixth\"}, nil\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\trequired: []string{\"\"},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{Path: \"first\", HostPath: \"first\", Options: mountOptions},\n\t\t\t\t{Path: \"second\", HostPath: \"second\", Options: mountOptions},\n\t\t\t\t{Path: \"third\", HostPath: \"third\", Options: mountOptions},\n\t\t\t\t{Path: \"fourth\", HostPath: \"fourth\", Options: mountOptions},\n\t\t\t\t{Path: \"fifth\", HostPath: \"fifth\", Options: mountOptions},\n\t\t\t\t{Path: \"sixth\", HostPath: \"sixth\", Options: mountOptions},\n\t\t\t},\n\t\t\trepeat: 10,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tfor i := 1; ; i++ {\n\t\t\ttest_name := tc.description\n\t\t\tif tc.repeat > 1 {\n\t\t\t\ttest_name += fmt.Sprintf(\"/%d\", i)\n\t\t\t}\n\t\t\tsuccess := t.Run(test_name, func(t *testing.T) {\n\t\t\t\ttc.input.logger = logger\n\t\t\t\tmounts, err := tc.input.Mounts()\n\n\t\t\t\tif tc.expectedError != nil {\n\t\t\t\t\trequire.Error(t, err)\n\t\t\t\t} else {\n\t\t\t\t\trequire.NoError(t, err)\n\t\t\t\t}\n\t\t\t\trequire.EqualValues(t, tc.expectedMounts, mounts)\n\n\t\t\t\t// We check that the mock is called for each element of required\n\t\t\t\tif i == 1 && tc.input.lookup != nil {\n\t\t\t\t\tmock := tc.input.lookup.(*lookup.LocatorMock)\n\t\t\t\t\trequire.Len(t, mock.LocateCalls(), len(tc.input.required))\n\t\t\t\t\tvar args []string\n\t\t\t\t\tfor _, c := range mock.LocateCalls() {\n\t\t\t\t\t\targs = append(args, c.S)\n\t\t\t\t\t}\n\t\t\t\t\trequire.EqualValues(t, args, tc.input.required)\n\t\t\t\t}\n\t\t\t})\n\t\t\tif !success || i >= tc.repeat {\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n}\n"
},
{
"path": "internal/discover/none.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage discover\n\n// None is a null discoverer that returns an empty list of devices and\n// mounts.\ntype None struct{}\n\nvar _ Discover = (*None)(nil)\n\n// Devices returns an empty list of devices\nfunc (e None) Devices() ([]Device, error) {\n\treturn nil, nil\n}\n\n// EnvVars returns an empty list of devices\nfunc (e None) EnvVars() ([]EnvVar, error) {\n\treturn nil, nil\n}\n\n// Mounts returns an empty list of mounts\nfunc (e None) Mounts() ([]Mount, error) {\n\treturn nil, nil\n}\n\n// Hooks returns an empty list of hooks\nfunc (e None) Hooks() ([]Hook, error) {\n\treturn nil, nil\n}\n"
},
{
"path": "internal/discover/none_test.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage discover\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNone(t *testing.T) {\n\td := None{}\n\n\tmounts, err := d.Mounts()\n\trequire.NoError(t, err)\n\trequire.Empty(t, mounts)\n}\n"
},
{
"path": "internal/discover/nvswitch.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n)\n\n// NewNvSwitchDiscoverer creates a discoverer for NVSWITCH devices.\nfunc NewNvSwitchDiscoverer(logger logger.Interface, driver *root.Driver) (Discover, error) {\n\tdevices := NewCharDeviceDiscoverer(\n\t\tlogger,\n\t\tdriver.DevRoot,\n\t\t[]string{\n\t\t\t\"/dev/nvidia-nvswitchctl\",\n\t\t\t\"/dev/nvidia-nvswitch*\",\n\t\t},\n\t)\n\n\treturn devices, nil\n}\n"
},
{
"path": "internal/discover/nvswitch_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover_test\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestNewNvSwitchDiscoverer(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\trootfs string\n\t\texpectedDevices []discover.Device\n\t}{\n\t\t{\n\t\t\tdescription: \"empty rootfs returns no devices\",\n\t\t\trootfs: \"rootfs-empty\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"rootfs with device nodes returns devices\",\n\t\t\trootfs: \"rootfs-1\",\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{Path: \"/dev/nvidia-nvswitchctl\", HostPath: \"/dev/nvidia-nvswitchctl\"},\n\t\t\t\t{Path: \"/dev/nvidia-nvswitch0\", HostPath: \"/dev/nvidia-nvswitch0\"},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdevRoot := filepath.Join(lookupRoot, tc.rootfs)\n\t\t\tdriver := root.New(root.WithDevRoot(devRoot))\n\t\t\td, err := discover.NewNvSwitchDiscoverer(logger, driver)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedDevices, test.StripRoot(devices, devRoot))\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, mounts)\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, hooks)\n\n\t\t\tenvVars, err := d.EnvVars()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, envVars)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/discover/symlinks.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"debug/elf\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype Symlink struct {\n\ttarget string\n\tlink string\n}\n\nfunc (s *Symlink) String() string {\n\treturn fmt.Sprintf(\"%s::%s\", s.target, s.link)\n}\n\ntype additionalSymlinks struct {\n\tlogger logger.Interface\n\tDiscover\n\tversion string\n\thookCreator HookCreator\n}\n\n// WithDriverDotSoSymlinks decorates the provided discoverer.\n// A hook is added that checks for specific driver symlinks that need to be created.\nfunc WithDriverDotSoSymlinks(logger logger.Interface, mounts Discover, version string, hookCreator HookCreator) Discover {\n\tif version == \"\" {\n\t\tversion = \"*.*\"\n\t}\n\treturn &additionalSymlinks{\n\t\tlogger: logger,\n\t\tDiscover: mounts,\n\t\thookCreator: hookCreator,\n\t\tversion: version,\n\t}\n}\n\n// Hooks returns a hook to create the additional symlinks based on the mounts.\nfunc (d *additionalSymlinks) Hooks() ([]Hook, error) {\n\tmounts, err := d.Mounts()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get library mounts: %v\", err)\n\t}\n\thooks, err := d.Discover.Hooks()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get hooks: %v\", err)\n\t}\n\n\tvar links []string\n\tprocessedPaths := make(map[string]bool)\n\tprocessedLinks := make(map[string]bool)\n\tfor _, mount := range mounts {\n\t\tif processedPaths[mount.Path] {\n\t\t\tcontinue\n\t\t}\n\t\tprocessedPaths[mount.Path] = true\n\n\t\tlinksForMount := d.getLinksForMount(mount.Path)\n\t\tsoSymlinks, err := d.getDotSoSymlinks(mount.HostPath, mount.Path)\n\t\tif err != nil {\n\t\t\td.logger.Warningf(\"Failed to get soname symlinks for %+v: %v\", mount, err)\n\t\t}\n\t\tlinksForMount = append(linksForMount, soSymlinks...)\n\n\t\tfor _, link := range linksForMount {\n\t\t\tif processedLinks[link] {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tprocessedLinks[link] = true\n\t\t\tlinks = append(links, link)\n\t\t}\n\t}\n\n\tif len(links) == 0 {\n\t\treturn hooks, nil\n\t}\n\n\tcreateSymlinkHooks, err := d.hookCreator.Create(\"create-symlinks\", links...).Hooks()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create symlink hook: %v\", err)\n\t}\n\n\treturn append(hooks, createSymlinkHooks...), nil\n}\n\n// getLinksForMount maps the path to created links if any.\nfunc (d additionalSymlinks) getLinksForMount(path string) []string {\n\tdir, filename := filepath.Split(path)\n\tswitch {\n\tcase d.isDriverLibrary(\"libcuda.so\", filename):\n\t\t// XXX Many applications wrongly assume that libcuda.so exists (e.g. with dlopen).\n\t\t// create libcuda.so -> libcuda.so.1 symlink\n\t\tlink := fmt.Sprintf(\"%s::%s\", \"libcuda.so.1\", filepath.Join(dir, \"libcuda.so\"))\n\t\treturn []string{link}\n\tcase d.isDriverLibrary(\"libGLX_nvidia.so\", filename):\n\t\t// XXX GLVND requires this symlink for indirect GLX support.\n\t\t// create libGLX_indirect.so.0 -> libGLX_nvidia.so.VERSION symlink\n\t\tlink := fmt.Sprintf(\"%s::%s\", filename, filepath.Join(dir, \"libGLX_indirect.so.0\"))\n\t\treturn []string{link}\n\tcase d.isDriverLibrary(\"libnvidia-opticalflow.so\", filename):\n\t\t// XXX Fix missing symlink for libnvidia-opticalflow.so.\n\t\t// create libnvidia-opticalflow.so -> libnvidia-opticalflow.so.1 symlink\n\t\tlink := fmt.Sprintf(\"%s::%s\", \"libnvidia-opticalflow.so.1\", filepath.Join(dir, \"libnvidia-opticalflow.so\"))\n\t\treturn []string{link}\n\t}\n\treturn nil\n}\n\n// isDriverLibrary checks whether the specified filename is a specific driver library.\nfunc (d additionalSymlinks) isDriverLibrary(libraryName string, filename string) bool {\n\tpattern := libraryName + \".\" + d.version\n\tmatch, _ := filepath.Match(pattern, filename)\n\treturn match\n}\n\nfunc (d *additionalSymlinks) getDotSoSymlinks(hostLibraryPath string, libraryContainerPath string) ([]string, error) {\n\thostLibraryDir := filepath.Dir(hostLibraryPath)\n\tcontainerLibraryDir, libraryName := filepath.Split(libraryContainerPath)\n\tif !d.isDriverLibrary(\"*\", libraryName) {\n\t\treturn nil, nil\n\t}\n\n\tsoname, err := getSoname(hostLibraryPath)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar soSymlinks []string\n\t// Create the SONAME -> libraryName symlink.\n\t// If the soname matches the library path, or the expected SONAME link does\n\t// not exist on the host, we do not create it in the container.\n\tif soname != libraryName && d.linkExistsInDir(hostLibraryDir, soname) {\n\t\ts := Symlink{\n\t\t\ttarget: libraryName,\n\t\t\tlink: filepath.Join(containerLibraryDir, soname),\n\t\t}\n\t\tsoSymlinks = append(soSymlinks, s.String())\n\t}\n\n\tsoTarget := soname\n\tif soTarget == \"\" {\n\t\tsoTarget = libraryName\n\t}\n\t// Create the .so -> SONAME symlink.\n\t// If the .so link name matches the SONAME link, or the expected .so link\n\t// does not exist on the host, we do not create it in the container.\n\tif soLink := getSoLink(soTarget); soLink != soTarget && d.linkExistsInDir(hostLibraryDir, soLink) {\n\t\ts := Symlink{\n\t\t\ttarget: soTarget,\n\t\t\tlink: filepath.Join(containerLibraryDir, soLink),\n\t\t}\n\t\tsoSymlinks = append(soSymlinks, s.String())\n\t}\n\treturn soSymlinks, nil\n}\n\nfunc (d *additionalSymlinks) linkExistsInDir(dir string, link string) bool {\n\tif link == \"\" {\n\t\treturn false\n\t}\n\tlinkPath := filepath.Join(dir, link)\n\texists, err := linkExists(linkPath)\n\tif err != nil {\n\t\td.logger.Warningf(\"Failed to check symlink %q: %v\", linkPath, err)\n\t\treturn false\n\t}\n\treturn exists\n}\n\n// linkExists returns true if the specified symlink exists.\n// We use a function variable here to allow this to be overridden for testing.\nvar linkExists = func(linkPath string) (bool, error) {\n\tinfo, err := os.Lstat(linkPath)\n\tif os.IsNotExist(err) {\n\t\treturn false, nil\n\t}\n\tif err != nil {\n\t\treturn false, err\n\t}\n\t// The linkPath is a symlink.\n\tif info.Mode()&os.ModeSymlink != 0 {\n\t\treturn true, nil\n\t}\n\n\treturn false, nil\n}\n\n// getSoname returns the soname for the specified library path.\n// We use a function variable here to allow this to be overridden for testing.\nvar getSoname = func(libraryPath string) (string, error) {\n\tlib, err := elf.Open(libraryPath)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tdefer lib.Close()\n\n\tsonames, err := lib.DynString(elf.DT_SONAME)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tif len(sonames) > 1 {\n\t\treturn \"\", fmt.Errorf(\"multiple SONAMEs detected for %v: %v\", libraryPath, sonames)\n\t}\n\tif len(sonames) == 0 {\n\t\treturn filepath.Base(libraryPath), nil\n\t}\n\treturn sonames[0], nil\n}\n\n// getSoLink returns the filename for the .so symlink that should point to the\n// soname symlink for the specified library.\n// If the soname / library name does not end in a `.so[.*]` then an empty string\n// is returned.\nfunc getSoLink(soname string) string {\n\text := filepath.Ext(soname)\n\tif ext == \"\" {\n\t\treturn \"\"\n\t}\n\tif ext == \".so\" {\n\t\treturn soname\n\t}\n\treturn getSoLink(strings.TrimSuffix(soname, ext))\n}\n"
},
{
"path": "internal/discover/symlinks_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage discover\n\nimport (\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestWithWithDriverDotSoSymlinks(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdiscover Discover\n\t\tversion string\n\t\texpectedDevices []Device\n\t\texpectedDevicesError error\n\t\texpectedHooks []Hook\n\t\texpectedHooksError error\n\t\texpectedMounts []Mount\n\t\texpectedMountsError error\n\t}{\n\t\t{\n\t\t\tdescription: \"empty discoverer remains empty\",\n\t\t\tdiscover: None{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-matching discoverer remains unchanged\",\n\t\t\tdiscover: &DiscoverMock{\n\t\t\t\tDevicesFunc: func() ([]Device, error) {\n\t\t\t\t\tdevices := []Device{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/dev1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn devices, nil\n\t\t\t\t},\n\t\t\t\tHooksFunc: func() ([]Hook, error) {\n\t\t\t\t\thooks := []Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tLifecycle: \"prestart\",\n\t\t\t\t\t\t\tPath: \"/path/to/a/hook\",\n\t\t\t\t\t\t\tArgs: []string{\"hook\", \"arg1\", \"arg2\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn hooks, nil\n\t\t\t\t},\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libnotcuda.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []Device{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/dev1\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"prestart\",\n\t\t\t\t\tPath: \"/path/to/a/hook\",\n\t\t\t\t\tArgs: []string{\"hook\", \"arg1\", \"arg2\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libnotcuda.so.1.2.3\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"libcuda.so.RM_VERSION is matched\",\n\t\t\tdiscover: &DiscoverMock{\n\t\t\t\tDevicesFunc: func() ([]Device, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tHooksFunc: func() ([]Hook, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tversion: \"1.2.3\",\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/libcuda.so\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"libcuda.so.RM_VERSION is matched by pattern\",\n\t\t\tdiscover: &DiscoverMock{\n\t\t\t\tDevicesFunc: func() ([]Device, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tHooksFunc: func() ([]Hook, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tversion: \"\",\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/libcuda.so\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"beta libcuda.so.RM_VERSION is matched\",\n\t\t\tdiscover: &DiscoverMock{\n\t\t\t\tDevicesFunc: func() ([]Device, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tHooksFunc: func() ([]Hook, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/libcuda.so\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-matching libcuda.so.RM_VERSION is ignored\",\n\t\t\tdiscover: &DiscoverMock{\n\t\t\t\tDevicesFunc: func() ([]Device, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tHooksFunc: func() ([]Hook, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tversion: \"4.5.6\",\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"hooks are extended\",\n\t\t\tdiscover: &DiscoverMock{\n\t\t\t\tDevicesFunc: func() ([]Device, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tHooksFunc: func() ([]Hook, error) {\n\t\t\t\t\thooks := []Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tLifecycle: \"prestart\",\n\t\t\t\t\t\t\tPath: \"/path/to/a/hook\",\n\t\t\t\t\t\t\tArgs: []string{\"hook\", \"arg1\", \"arg2\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn hooks, nil\n\t\t\t\t},\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tversion: \"1.2.3\",\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"prestart\",\n\t\t\t\t\tPath: \"/path/to/a/hook\",\n\t\t\t\t\tArgs: []string{\"hook\", \"arg1\", \"arg2\"},\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/libcuda.so\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"all driver so symlinks are matched\",\n\t\t\tdiscover: &DiscoverMock{\n\t\t\t\tDevicesFunc: func() ([]Device, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tHooksFunc: func() ([]Hook, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t\tMountsFunc: func() ([]Mount, error) {\n\t\t\t\t\tmounts := []Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libGLX_nvidia.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libnvidia-opticalflow.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/lib/libanother.so.1.2.3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libcuda.so.1.2.3\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libGLX_nvidia.so.1.2.3\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libnvidia-opticalflow.so.1.2.3\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/libanother.so.1.2.3\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\"nvidia-cdi-hook\", \"create-symlinks\",\n\t\t\t\t\t\t\"--link\", \"libcuda.so.1::/usr/lib/libcuda.so\",\n\t\t\t\t\t\t\"--link\", \"libGLX_nvidia.so.1.2.3::/usr/lib/libGLX_indirect.so.0\",\n\t\t\t\t\t\t\"--link\", \"libnvidia-opticalflow.so.1::/usr/lib/libnvidia-opticalflow.so\",\n\t\t\t\t\t},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\thookCreator := NewHookCreator()\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\td := WithDriverDotSoSymlinks(\n\t\t\t\tlogger,\n\t\t\t\ttc.discover,\n\t\t\t\ttc.version,\n\t\t\t\thookCreator,\n\t\t\t)\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.ErrorIs(t, err, tc.expectedDevicesError)\n\t\t\trequire.EqualValues(t, tc.expectedDevices, devices)\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.ErrorIs(t, err, tc.expectedHooksError)\n\t\t\trequire.EqualValues(t, tc.expectedHooks, hooks)\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.ErrorIs(t, err, tc.expectedMountsError)\n\t\t\trequire.EqualValues(t, tc.expectedMounts, mounts)\n\t\t})\n\t}\n}\n\nfunc TestGetDotSoSymlinks(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\thostLibraryPath string\n\t\tcontainerLibraryPath string\n\t\tgetSonameFunc func(string) (string, error)\n\t\tlinkExistsFunc func(string) (bool, error)\n\t\texpectedError error\n\t\texpectedSymlinks []string\n\t}{\n\t\t{\n\t\t\tdescription: \"libcuda.soname links\",\n\t\t\thostLibraryPath: \"/usr/lib/libcuda.so.999.88.77\",\n\t\t\tgetSonameFunc: func(s string) (string, error) {\n\t\t\t\treturn \"libcuda.so.1\", nil\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\texpectedSymlinks: []string{\n\t\t\t\t\"libcuda.so.999.88.77::/usr/lib/libcuda.so.1\",\n\t\t\t\t\"libcuda.so.1::/usr/lib/libcuda.so\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"libcuda.soname links uses container path\",\n\t\t\thostLibraryPath: \"/usr/lib/libcuda.so.999.88.77\",\n\t\t\tcontainerLibraryPath: \"/some/container/path/libcuda.so.999.88.77\",\n\t\t\tgetSonameFunc: func(s string) (string, error) {\n\t\t\t\treturn \"libcuda.so.1\", nil\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\texpectedSymlinks: []string{\n\t\t\t\t\"libcuda.so.999.88.77::/some/container/path/libcuda.so.1\",\n\t\t\t\t\"libcuda.so.1::/some/container/path/libcuda.so\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"equal soname uses library path\",\n\t\t\thostLibraryPath: \"/usr/lib/libcuda.so.999.88.77\",\n\t\t\tgetSonameFunc: func(s string) (string, error) {\n\t\t\t\treturn \"libcuda.so.999.88.77\", nil\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\texpectedSymlinks: []string{\n\t\t\t\t\"libcuda.so.999.88.77::/usr/lib/libcuda.so\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"nonexistent symlink is ignored\",\n\t\t\thostLibraryPath: \"/usr/lib/libcuda.so.999.88.77\",\n\t\t\tgetSonameFunc: func(s string) (string, error) {\n\t\t\t\treturn \"libcuda.so.1\", nil\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\tlinkExistsFunc: func(s string) (bool, error) {\n\t\t\t\treturn strings.HasSuffix(s, \"libcuda.so.1\"), nil\n\t\t\t},\n\t\t\texpectedSymlinks: []string{\n\t\t\t\t\"libcuda.so.999.88.77::/usr/lib/libcuda.so.1\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"soname is skipped\",\n\t\t\thostLibraryPath: \"/usr/lib/libcuda.so.999.88.77\",\n\t\t\tgetSonameFunc: func(s string) (string, error) {\n\t\t\t\treturn \"\", nil\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\tlinkExistsFunc: func(s string) (bool, error) {\n\t\t\t\treturn strings.HasSuffix(s, \"libcuda.so\"), nil\n\t\t\t},\n\t\t\texpectedSymlinks: []string{\n\t\t\t\t\"libcuda.so.999.88.77::/usr/lib/libcuda.so\",\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tif tc.containerLibraryPath == \"\" {\n\t\t\ttc.containerLibraryPath = tc.hostLibraryPath\n\t\t}\n\t\tif tc.linkExistsFunc == nil {\n\t\t\ttc.linkExistsFunc = func(string) (bool, error) {\n\t\t\t\treturn true, nil\n\t\t\t}\n\t\t}\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdefer setGetSoname(tc.getSonameFunc)()\n\t\t\tdefer setLinkExists(tc.linkExistsFunc)()\n\n\t\t\tsut := &additionalSymlinks{version: \"*.*\"}\n\t\t\tsymlinks, err := sut.getDotSoSymlinks(tc.hostLibraryPath, tc.containerLibraryPath)\n\n\t\t\tif tc.expectedError == nil {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t} else {\n\t\t\t\trequire.EqualError(t, err, tc.expectedError.Error())\n\t\t\t}\n\n\t\t\trequire.EqualValues(t, tc.expectedSymlinks, symlinks)\n\t\t})\n\t}\n}\n\nfunc TestGetSoLink(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tinput string\n\t\texpectedSoLink string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty string\",\n\t\t\tinput: \"\",\n\t\t\texpectedSoLink: \"\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"cuda driver library\",\n\t\t\tinput: \"libcuda.so.999.88.77\",\n\t\t\texpectedSoLink: \"libcuda.so\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"beta cuda driver library\",\n\t\t\tinput: \"libcuda.so.999.88\",\n\t\t\texpectedSoLink: \"libcuda.so\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"no .so in libname\",\n\t\t\tinput: \"foo.bar.baz\",\n\t\t\texpectedSoLink: \"\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple .so in libname\",\n\t\t\tinput: \"foo.so.so.566\",\n\t\t\texpectedSoLink: \"foo.so.so\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"no suffix after so\",\n\t\t\tinput: \"foo.so\",\n\t\t\texpectedSoLink: \"foo.so\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\n\t\t\tsoLink := getSoLink(tc.input)\n\n\t\t\trequire.Equal(t, tc.expectedSoLink, soLink)\n\t\t})\n\t}\n}\n\nfunc setGetSoname(override func(string) (string, error)) func() {\n\toriginal := getSoname\n\tgetSoname = override\n\n\treturn func() {\n\t\tgetSoname = original\n\t}\n}\n\nfunc setLinkExists(override func(string) (bool, error)) func() {\n\toriginal := linkExists\n\tlinkExists = override\n\n\treturn func() {\n\t\tlinkExists = original\n\t}\n}\n"
},
{
"path": "internal/dxcore/api.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dxcore\n\n// dxcore stores a reference the dxcore dynamic library\nvar dxcore *context\n\n// Init initializes the dxcore dynamic library\nfunc Init() error {\n\tc, err := initContext()\n\tif err != nil {\n\t\treturn err\n\t}\n\tdxcore = c\n\treturn nil\n}\n\n// Shutdown closes the dxcore dynamic library\nfunc Shutdown() error {\n\tif dxcore != nil && dxcore.initialized != 0 {\n\t\tdxcore.deinitContext()\n\t}\n\treturn nil\n}\n\n// GetDriverStorePaths returns the list of driver store paths\nfunc GetDriverStorePaths() []string {\n\tvar paths []string\n\tselected := make(map[string]bool)\n\n\tfor i := 0; i < dxcore.getAdapterCount(); i++ {\n\t\tpath := dxcore.getAdapter(i).getDriverStorePath()\n\t\tif selected[path] {\n\t\t\tcontinue\n\t\t}\n\t\tselected[path] = true\n\t\tpaths = append(paths, path)\n\t}\n\n\treturn paths\n}\n"
},
{
"path": "internal/dxcore/dxcore.c",
"content": "/*\n * Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.\n */\n\n#include \n#include \n\n#include \"dxcore.h\"\n\n// We define log_write as an empty macro to allow dxcore to remain unchanged.\n#define log_write(...)\n\n// We define the following macros to allow dxcore to remain largely unchanged.\n#define log_info(msg) log_write('I', __FILE__, __LINE__, msg)\n#define log_warn(msg) log_write('W', __FILE__, __LINE__, msg)\n#define log_err(msg) log_write('E', __FILE__, __LINE__, msg)\n#define log_infof(fmt, ...) log_write('I', __FILE__, __LINE__, fmt, __VA_ARGS__)\n#define log_warnf(fmt, ...) log_write('W', __FILE__, __LINE__, fmt, __VA_ARGS__)\n#define log_errf(fmt, ...) log_write('E', __FILE__, __LINE__, fmt, __VA_ARGS__)\n\n\n#define DXCORE_MAX_PATH 260\n\n/*\n * List of components we expect to find in the driver store that we need to mount\n */\nstatic const char * const dxcore_nvidia_driver_store_components[] = {\n \"libcuda.so.1.1\", /* Core library for cuda support */\n \"libcuda_loader.so\", /* Core library for cuda support on WSL */\n \"libnvidia-ptxjitcompiler.so.1\", /* Core library for PTX Jit support */\n \"libnvidia-ml.so.1\", /* Core library for nvml */\n \"libnvidia-ml_loader.so\", /* Core library for nvml on WSL */\n \"nvidia-smi\", /* nvidia-smi binary*/\n \"nvcubins.bin\", /* Binary containing GPU code for cuda */\n};\n\n\n/*\n * List of functions and structures we need to communicate with libdxcore.\n * Documentation on these functions can be found on docs.microsoft.com in d3dkmthk.\n */\n\nstruct dxcore_enumAdapters2;\nstruct dxcore_enumAdapters3;\nstruct dxcore_queryAdapterInfo;\n\ntypedef int(*pfnDxcoreEnumAdapters2)(struct dxcore_enumAdapters2* pParams);\ntypedef int(*pfnDxcoreEnumAdapters3)(struct dxcore_enumAdapters3* pParams);\ntypedef int(*pfnDxcoreQueryAdapterInfo)(struct dxcore_queryAdapterInfo* pParams);\n\nstruct dxcore_lib {\n void* hDxcoreLib;\n pfnDxcoreEnumAdapters2 pDxcoreEnumAdapters2;\n pfnDxcoreEnumAdapters3 pDxcoreEnumAdapters3;\n pfnDxcoreQueryAdapterInfo pDxcoreQueryAdapterInfo;\n};\n\nstruct dxcore_adapterInfo\n{\n unsigned int hAdapter;\n struct dxcore_luid AdapterLuid;\n unsigned int NumOfSources;\n unsigned int bPresentMoveRegionsPreferred;\n};\n\nstruct dxcore_enumAdapters2\n{\n unsigned int NumAdapters;\n struct dxcore_adapterInfo *pAdapters;\n};\n\n#define ENUMADAPTER3_FILTER_COMPUTE_ONLY (0x0000000000000001)\n\nstruct dxcore_enumAdapters3\n{\n unsigned long long Filter;\n unsigned int NumAdapters;\n struct dxcore_adapterInfo *pAdapters;\n};\n\nenum dxcore_kmtqueryAdapterInfoType\n{\n DXCORE_QUERYDRIVERVERSION = 13,\n DXCORE_QUERYREGISTRY = 48,\n};\n\nenum dxcore_queryregistry_type {\n DXCORE_QUERYREGISTRY_DRIVERSTOREPATH = 2,\n DXCORE_QUERYREGISTRY_DRIVERIMAGEPATH = 3,\n};\n\nenum dxcore_queryregistry_status {\n DXCORE_QUERYREGISTRY_STATUS_SUCCESS = 0,\n DXCORE_QUERYREGISTRY_STATUS_BUFFER_OVERFLOW = 1,\n DXCORE_QUERYREGISTRY_STATUS_FAIL = 2,\n};\n\nstruct dxcore_queryregistry_info {\n enum dxcore_queryregistry_type QueryType;\n unsigned int QueryFlags;\n wchar_t ValueName[DXCORE_MAX_PATH];\n unsigned int ValueType;\n unsigned int PhysicalAdapterIndex;\n unsigned int OutputValueSize;\n enum dxcore_queryregistry_status Status;\n union {\n unsigned long long OutputQword;\n wchar_t Output;\n };\n};\n\nstruct dxcore_queryAdapterInfo\n{\n unsigned int hAdapter;\n enum dxcore_kmtqueryAdapterInfoType Type;\n void *pPrivateDriverData;\n unsigned int PrivateDriverDataSize;\n};\n\nstatic int dxcore_query_adapter_info_helper(struct dxcore_lib* pLib,\n unsigned int hAdapter,\n enum dxcore_kmtqueryAdapterInfoType type,\n void* pPrivateDriverDate,\n unsigned int privateDriverDataSize)\n{\n struct dxcore_queryAdapterInfo queryAdapterInfo = { 0 };\n\n queryAdapterInfo.hAdapter = hAdapter;\n queryAdapterInfo.Type = type;\n queryAdapterInfo.pPrivateDriverData = pPrivateDriverDate;\n queryAdapterInfo.PrivateDriverDataSize = privateDriverDataSize;\n\n return pLib->pDxcoreQueryAdapterInfo(&queryAdapterInfo);\n}\n\nstatic int dxcore_query_adapter_wddm_version(struct dxcore_lib* pLib, unsigned int hAdapter, unsigned int* version)\n{\n return dxcore_query_adapter_info_helper(pLib,\n hAdapter,\n DXCORE_QUERYDRIVERVERSION,\n (void*)version,\n sizeof(*version));\n}\n\nstatic int dxcore_query_adapter_driverstore(struct dxcore_lib* pLib, unsigned int hAdapter, char** ppDriverStorePath)\n{\n struct dxcore_queryregistry_info params = {0};\n struct dxcore_queryregistry_info* pValue = NULL;\n wchar_t* pOutput;\n size_t outputSizeInBytes;\n size_t outputSize;\n\n params.QueryType = DXCORE_QUERYREGISTRY_DRIVERSTOREPATH;\n\n if (dxcore_query_adapter_info_helper(pLib,\n hAdapter,\n DXCORE_QUERYREGISTRY,\n (void*)¶ms,\n sizeof(params)))\n {\n log_err(\"Failed to query driver store path size for the WDDM Adapter\");\n return (-1);\n }\n\n if (params.OutputValueSize > DXCORE_MAX_PATH * sizeof(wchar_t)) {\n log_err(\"The driver store path size returned by dxcore is not valid\");\n return (-1);\n }\n\n outputSizeInBytes = (size_t)params.OutputValueSize;\n outputSize = outputSizeInBytes / sizeof(wchar_t);\n\n pValue = calloc(sizeof(struct dxcore_queryregistry_info) + outputSizeInBytes + sizeof(wchar_t), 1);\n if (!pValue) {\n log_err(\"Out of memory while allocating temp buffer to query adapter info\");\n return (-1);\n }\n\n pValue->QueryType = DXCORE_QUERYREGISTRY_DRIVERSTOREPATH;\n pValue->OutputValueSize = (unsigned int)outputSizeInBytes;\n\n if (dxcore_query_adapter_info_helper(pLib,\n hAdapter,\n DXCORE_QUERYREGISTRY,\n (void*)pValue,\n (unsigned int)(sizeof(struct dxcore_queryregistry_info) + outputSizeInBytes)))\n {\n log_err(\"Failed to query driver store path data for the WDDM Adapter\");\n free(pValue);\n return (-1);\n }\n pOutput = (wchar_t*)(&pValue->Output);\n\n // Make sure no matter what happened the wchar_t string is null terminated\n pOutput[outputSize] = L'\\0';\n\n // Convert the output into a regular c string\n *ppDriverStorePath = (char*)calloc(outputSize + 1, sizeof(char));\n if (!*ppDriverStorePath) {\n log_err(\"Out of memory while allocating the buffer for the driver store path\");\n free(pValue);\n return (-1);\n }\n wcstombs(*ppDriverStorePath, pOutput, outputSize);\n\n free(pValue);\n\n return 0;\n}\n\nstatic void dxcore_add_adapter(struct dxcore_context* pCtx, struct dxcore_lib* pLib, struct dxcore_adapterInfo *pAdapterInfo)\n{\n unsigned int wddmVersion = 0;\n char* driverStorePath = NULL;\n\n log_infof(\"Creating a new WDDM Adapter for hAdapter:%x luid:%llx\", pAdapterInfo->hAdapter, *((unsigned long long*)&pAdapterInfo->AdapterLuid));\n\n if (dxcore_query_adapter_wddm_version(pLib, pAdapterInfo->hAdapter, &wddmVersion)) {\n log_err(\"Failed to query the WDDM version for the specified adapter. Skipping it.\");\n return;\n }\n\n if (wddmVersion < 2700) {\n log_err(\"Found a WDDM adapter running a driver with pre-WDDM 2.7 . Skipping it.\");\n return;\n }\n\n if (dxcore_query_adapter_driverstore(pLib, pAdapterInfo->hAdapter, &driverStorePath)) {\n log_err(\"Failed to query driver store path for the WDDM Adapter . Skipping it.\");\n return;\n }\n\n // We got all the info we needed. Adding it to the tracking structure.\n {\n struct dxcore_adapter* newList;\n newList = realloc(pCtx->adapterList, sizeof(struct dxcore_adapter) * (pCtx->adapterCount + 1));\n if (!newList) {\n log_err(\"Out of memory when trying to add a new WDDM Adapter to the list of valid adapters\");\n free(driverStorePath);\n return;\n }\n\n pCtx->adapterList = newList;\n\n pCtx->adapterList[pCtx->adapterCount].hAdapter = pAdapterInfo->hAdapter;\n pCtx->adapterList[pCtx->adapterCount].pDriverStorePath = driverStorePath;\n pCtx->adapterList[pCtx->adapterCount].wddmVersion = wddmVersion;\n pCtx->adapterCount++;\n }\n\n log_infof(\"Adding new adapter via dxcore hAdapter:%x luid:%llx wddm version:%d\", pAdapterInfo->hAdapter, *((unsigned long long*)&pAdapterInfo->AdapterLuid), wddmVersion);\n}\n\nstatic int dxcore_enum_adapters3(struct dxcore_context* pCtx, struct dxcore_lib* pLib)\n{\n struct dxcore_enumAdapters3 params = {0};\n unsigned int adapterIndex = 0;\n\n // Include compute-only in addition to display+compute adapters\n params.Filter = ENUMADAPTER3_FILTER_COMPUTE_ONLY;\n params.NumAdapters = 0;\n params.pAdapters = NULL;\n\n if (pLib->pDxcoreEnumAdapters3(¶ms)) {\n log_err(\"Failed to enumerate adapters via enumAdapers3\");\n return 1;\n }\n\n params.pAdapters = malloc(sizeof(struct dxcore_adapterInfo) * params.NumAdapters);\n if (pLib->pDxcoreEnumAdapters3(¶ms)) {\n free(params.pAdapters);\n log_err(\"Failed to enumerate adapters via enumAdapers3\");\n return 1;\n }\n\n for (adapterIndex = 0; adapterIndex < params.NumAdapters; adapterIndex++) {\n dxcore_add_adapter(pCtx, pLib, ¶ms.pAdapters[adapterIndex]);\n }\n\n free(params.pAdapters);\n return 0;\n}\n\nstatic int dxcore_enum_adapters2(struct dxcore_context* pCtx, struct dxcore_lib* pLib)\n{\n struct dxcore_enumAdapters2 params = {0};\n unsigned int adapterIndex = 0;\n\n params.NumAdapters = 0;\n params.pAdapters = NULL;\n\n if (pLib->pDxcoreEnumAdapters2(¶ms)) {\n log_err(\"Failed to enumerate adapters via enumAdapters2\");\n return 1;\n }\n\n params.pAdapters = malloc(sizeof(struct dxcore_adapterInfo) * params.NumAdapters);\n if (pLib->pDxcoreEnumAdapters2(¶ms)) {\n free(params.pAdapters);\n log_err(\"Failed to enumerate adapters via enumAdapters2\");\n return 1;\n }\n\n for (adapterIndex = 0; adapterIndex < params.NumAdapters; adapterIndex++) {\n dxcore_add_adapter(pCtx, pLib, ¶ms.pAdapters[adapterIndex]);\n }\n\n free(params.pAdapters);\n return 0;\n}\n\nstatic void dxcore_enum_adapters(struct dxcore_context* pCtx, struct dxcore_lib* pLib)\n{\n int status;\n if (pLib->pDxcoreEnumAdapters3) {\n status = dxcore_enum_adapters3(pCtx, pLib);\n if (status == 0) {\n return;\n }\n }\n\n // Fall back to EnumAdapters2 if the OS doesn't support EnumAdapters3\n if (pLib->pDxcoreEnumAdapters2) {\n status = dxcore_enum_adapters2(pCtx, pLib);\n if (status == 0) {\n return;\n }\n }\n log_err(\"Failed to enumerate adapters via dxcore\");\n}\n\nint dxcore_init_context(struct dxcore_context* pCtx)\n{\n struct dxcore_lib lib = {0};\n\n pCtx->initialized = 0;\n pCtx->adapterCount = 0;\n pCtx->adapterList = NULL;\n\n lib.hDxcoreLib = dlopen(\"libdxcore.so\", RTLD_LAZY);\n if (!lib.hDxcoreLib) {\n goto error;\n }\n\n lib.pDxcoreEnumAdapters2 = (pfnDxcoreEnumAdapters2)dlsym(lib.hDxcoreLib, \"D3DKMTEnumAdapters2\");\n lib.pDxcoreEnumAdapters3 = (pfnDxcoreEnumAdapters3)dlsym(lib.hDxcoreLib, \"D3DKMTEnumAdapters3\");\n if (!lib.pDxcoreEnumAdapters2 && !lib.pDxcoreEnumAdapters3) {\n log_err(\"dxcore library is present but the symbols D3DKMTEnumAdapters2 and D3DKMTEnumAdapters3 are missing\");\n goto error;\n }\n\n lib.pDxcoreQueryAdapterInfo = (pfnDxcoreQueryAdapterInfo)dlsym(lib.hDxcoreLib, \"D3DKMTQueryAdapterInfo\");\n if (!lib.pDxcoreQueryAdapterInfo) {\n log_err(\"dxcore library is present but the symbol D3DKMTQueryAdapterInfo is missing\");\n goto error;\n }\n\n dxcore_enum_adapters(pCtx, &lib);\n\n log_info(\"dxcore layer initialized successfully\");\n pCtx->initialized = 1;\n\n dlclose(lib.hDxcoreLib);\n\n return 0;\n\nerror:\n dxcore_deinit_context(pCtx);\n\n if (lib.hDxcoreLib)\n dlclose(lib.hDxcoreLib);\n\n return (-1);\n}\n\nstatic void dxcore_deinit_adapter(struct dxcore_adapter* pAdapter)\n{\n if (!pAdapter)\n return;\n\n free(pAdapter->pDriverStorePath);\n}\n\nvoid dxcore_deinit_context(struct dxcore_context* pCtx)\n{\n unsigned int adapterIndex = 0;\n\n if (!pCtx)\n return;\n\n for (adapterIndex = 0; adapterIndex < pCtx->adapterCount; adapterIndex++) {\n dxcore_deinit_adapter(&pCtx->adapterList[adapterIndex]);\n }\n\n free(pCtx->adapterList);\n\n pCtx->initialized = 0;\n}\n"
},
{
"path": "internal/dxcore/dxcore.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dxcore\n\n/*\n#cgo linux LDFLAGS: -Wl,--export-dynamic -Wl,--unresolved-symbols=ignore-in-object-files\n#cgo darwin LDFLAGS: -Wl,-undefined,dynamic_lookup\n\n#include \n*/\nimport \"C\"\nimport (\n\t\"fmt\"\n\t\"unsafe\"\n)\n\ntype context C.struct_dxcore_context\ntype adapter C.struct_dxcore_adapter\n\n// initContext initializes the dxcore context and populates the list of adapters.\nfunc initContext() (*context, error) {\n\tcContext := C.struct_dxcore_context{}\n\tif C.dxcore_init_context(&cContext) != 0 {\n\t\treturn nil, fmt.Errorf(\"failed to initialize dxcore context\")\n\t}\n\tc := (*context)(&cContext)\n\treturn c, nil\n}\n\n// deinitContext deinitializes the dxcore context and frees the list of adapters.\nfunc (c context) deinitContext() {\n\tcContext := C.struct_dxcore_context(c)\n\tC.dxcore_deinit_context(&cContext)\n}\n\nfunc (c context) getAdapterCount() int {\n\treturn int(c.adapterCount)\n}\n\nfunc (c context) getAdapter(index int) adapter {\n\tarrayPointer := (*[1 << 30]C.struct_dxcore_adapter)(unsafe.Pointer(c.adapterList))\n\treturn adapter(arrayPointer[index])\n}\n\nfunc (a adapter) getDriverStorePath() string {\n\treturn C.GoString(a.pDriverStorePath)\n}\n"
},
{
"path": "internal/dxcore/dxcore.h",
"content": "/*\n * Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.\n */\n\n#ifndef HEADER_DXCORE_H_\n#define HEADER_DXCORE_H_\n\n#define MAX_DXCORE_DRIVERSTORE_LIBRAIRIES (16)\n\nstruct dxcore_luid\n{\n unsigned int lowPart;\n int highPart;\n};\n\nstruct dxcore_adapter\n{\n unsigned int hAdapter;\n unsigned int wddmVersion;\n char* pDriverStorePath;\n unsigned int driverStoreComponentCount;\n const char* pDriverStoreComponents[MAX_DXCORE_DRIVERSTORE_LIBRAIRIES];\n struct dxcore_context *pContext;\n};\n\nstruct dxcore_context\n{\n unsigned int adapterCount;\n struct dxcore_adapter *adapterList;\n\n int initialized;\n};\n\n\n\nint dxcore_init_context(struct dxcore_context* pDxcore_context);\nvoid dxcore_deinit_context(struct dxcore_context* pDxcore_context);\n\n#endif // HEADER_DXCORE_H_\n"
},
{
"path": "internal/edits/device.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage edits\n\nimport (\n\t\"io/fs\"\n\t\"os\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\ntype device struct {\n\tdiscover.Device\n\tnoAdditionalGIDs bool\n}\n\n// toEdits converts a discovered device to CDI Container Edits.\nfunc (d device) toEdits() (*cdi.ContainerEdits, error) {\n\tdeviceNode, err := d.toSpec()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\te := cdi.ContainerEdits{\n\t\tContainerEdits: &specs.ContainerEdits{\n\t\t\tDeviceNodes: []*specs.DeviceNode{deviceNode},\n\t\t\tAdditionalGIDs: d.getAdditionalGIDs(deviceNode),\n\t\t},\n\t}\n\treturn &e, nil\n}\n\n// toSpec converts a discovered Device to a CDI Spec Device. Note\n// that missing info is filled in when edits are applied by querying the Device node.\nfunc (d device) toSpec() (*specs.DeviceNode, error) {\n\ts := d.fromPathOrDefault()\n\t// The HostPath field was added in the v0.5.0 CDI specification.\n\t// The cdi package uses strict unmarshalling when loading specs from file causing failures for\n\t// unexpected fields.\n\t// Since the behaviour for HostPath == \"\" and HostPath == Path are equivalent, we clear HostPath\n\t// if it is equal to Path to ensure compatibility with the widest range of specs.\n\tif s.HostPath == d.Path {\n\t\ts.HostPath = \"\"\n\t}\n\n\treturn s, nil\n}\n\n// fromPathOrDefault attempts to return the returns the information about the\n// CDI device from the specified host path.\n// If this fails a minimal device is returned so that this information can be\n// queried by the container runtime such as containerd.\nfunc (d device) fromPathOrDefault() *specs.DeviceNode {\n\tpath := d.HostPath\n\tif path == \"\" {\n\t\tpath = d.Path\n\t}\n\tdn, err := devices.DeviceFromPath(path, \"rwm\")\n\tif err != nil {\n\t\treturn &specs.DeviceNode{\n\t\t\tHostPath: d.HostPath,\n\t\t\tPath: d.Path,\n\t\t}\n\t}\n\n\t// We construct a CDI spec DeviceNode with the information retrieved.\n\t// Note that in addition to the fields that we specify here the following\n\t// are not taken from the extracted information:\n\t//\n\t// * dn.Rule.Allow: This has no equivalent in the CDI spec and is used for\n\t//\t\t\t\t\tspecifying cgroup rules in a container.\n\t// * dn.Rule.Type: This could be translated to the DeviceNode.Type, but is\n\t//\t\t\t\t\tnot done. In the toolkit we only consider char devices\n\t//\t\t\t\t\t(Type = 'c') and these are the default for device nodes\n\t//\t\t\t\t\tin OCI compliant runtimes.\n\t// * dn.UID:\t\tThis is ignored so as to allow the UID of the container\n\t//\t\t\t\t\tuser to be applied when making modifications to the OCI\n\t//\t\t\t\t\truntime specification. Note that for most NVIDIA devices\n\t//\t\t\t\t\tthis would be 0 and as such the target UID pointer will\n\t//\t\t\t\t\tremain `nil`.\n\t//\t\t\t\t\tSee: https://github.com/cncf-tags/container-device-interface/blob/e2632194760242fc74a30c3803107f9c1ba5718b/pkg/cdi/container-edits.go#L96-L100\n\treturn &specs.DeviceNode{\n\t\tHostPath: d.HostPath,\n\t\tPath: d.Path,\n\t\tMajor: dn.Major,\n\t\tMinor: dn.Minor,\n\t\tFileMode: ptrIfNonZero(dn.FileMode),\n\t\tPermissions: string(dn.Permissions),\n\t\tGID: ptrIfNonZero(dn.Gid),\n\t}\n}\n\nfunc ptrIfNonZero[T uint32 | os.FileMode](id T) *T {\n\tvar zero T\n\tif id == zero {\n\t\treturn nil\n\t}\n\treturn &id\n}\n\n// getAdditionalGIDs returns the group id of the device if the device is not world read/writable.\n// If the information cannot be extracted or an error occurs, 0 is returned.\nfunc (d *device) getAdditionalGIDs(dn *specs.DeviceNode) []uint32 {\n\tif d.noAdditionalGIDs {\n\t\treturn nil\n\t}\n\t// Handle the underdefined cases where we do not have enough information to\n\t// extract the GID for the device OR whether the additional GID is required.\n\tif dn == nil || dn.GID == nil || *dn.GID == 0 {\n\t\treturn nil\n\t}\n\tif dn.FileMode == nil {\n\t\treturn nil\n\t}\n\tif dn.FileMode.Type()&os.ModeCharDevice == 0 {\n\t\treturn nil\n\t}\n\tif permission := dn.FileMode.Perm(); isWorldReadable(permission) && isWorldWriteable(permission) {\n\t\treturn nil\n\t}\n\treturn []uint32{*dn.GID}\n}\n\nfunc isWorldReadable(m fs.FileMode) bool {\n\treturn m&04 != 0\n}\n\nfunc isWorldWriteable(m fs.FileMode) bool {\n\treturn m&02 != 0\n}\n"
},
{
"path": "internal/edits/device_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage edits\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/cgroups/devices/config\"\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test/to\"\n)\n\nfunc TestDeviceToSpec(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdevice discover.Device\n\t\tdeviceslib devices.Interface\n\t\texpected *specs.DeviceNode\n\t}{\n\t\t{\n\t\t\tdevice: discover.Device{\n\t\t\t\tPath: \"/foo\",\n\t\t\t},\n\t\t\texpected: &specs.DeviceNode{\n\t\t\t\tPath: \"/foo\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdevice: discover.Device{\n\t\t\t\tPath: \"/foo\",\n\t\t\t\tHostPath: \"/foo\",\n\t\t\t},\n\t\t\texpected: &specs.DeviceNode{\n\t\t\t\tPath: \"/foo\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdevice: discover.Device{\n\t\t\t\tPath: \"/foo\",\n\t\t\t\tHostPath: \"/not/foo\",\n\t\t\t},\n\t\t\texpected: &specs.DeviceNode{\n\t\t\t\tPath: \"/foo\",\n\t\t\t\tHostPath: \"/not/foo\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device with device properties\",\n\t\t\tdevice: discover.Device{\n\t\t\t\tPath: \"/foo\",\n\t\t\t},\n\t\t\tdeviceslib: &devices.InterfaceMock{\n\t\t\t\tDeviceFromPathFunc: func(path, permissions string) (*devices.Device, error) {\n\t\t\t\t\tif path != \"/foo\" {\n\t\t\t\t\t\treturn nil, fmt.Errorf(\"not found %v\", path)\n\t\t\t\t\t}\n\t\t\t\t\tcd := &config.Device{\n\t\t\t\t\t\tRule: config.Rule{\n\t\t\t\t\t\t\tMajor: 100,\n\t\t\t\t\t\t\tMinor: 200,\n\t\t\t\t\t\t\tPermissions: config.Permissions(\"w\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t\tUid: 11,\n\t\t\t\t\t\tGid: 44,\n\t\t\t\t\t}\n\n\t\t\t\t\treturn (*devices.Device)(cd), nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: &specs.DeviceNode{\n\t\t\t\tPath: \"/foo\",\n\t\t\t\tHostPath: \"\",\n\t\t\t\tPermissions: \"w\",\n\t\t\t\tMajor: 100,\n\t\t\t\tMinor: 200,\n\t\t\t\tGID: ptrIfNonZero[uint32](44),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device with additional GIDs\",\n\t\t\tdevice: discover.Device{\n\t\t\t\tPath: \"/foo\",\n\t\t\t},\n\t\t\tdeviceslib: &devices.InterfaceMock{\n\t\t\t\tDeviceFromPathFunc: func(path, permissions string) (*devices.Device, error) {\n\t\t\t\t\tif path != \"/foo\" {\n\t\t\t\t\t\treturn nil, fmt.Errorf(\"not found %v\", path)\n\t\t\t\t\t}\n\t\t\t\t\tcd := &config.Device{\n\t\t\t\t\t\tRule: config.Rule{\n\t\t\t\t\t\t\tMajor: 100,\n\t\t\t\t\t\t\tMinor: 200,\n\t\t\t\t\t\t\tPermissions: config.Permissions(\"w\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t\tFileMode: 0660 | os.ModeCharDevice,\n\t\t\t\t\t\tUid: 11,\n\t\t\t\t\t\tGid: 44,\n\t\t\t\t\t}\n\n\t\t\t\t\treturn (*devices.Device)(cd), nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: &specs.DeviceNode{\n\t\t\t\tPath: \"/foo\",\n\t\t\t\tHostPath: \"\",\n\t\t\t\tPermissions: \"w\",\n\t\t\t\tMajor: 100,\n\t\t\t\tMinor: 200,\n\t\t\t\tFileMode: to.Ptr(0660 | os.ModeCharDevice),\n\t\t\t\tGID: ptrIfNonZero[uint32](44),\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tf := factory{}\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdefer devices.SetInterfaceForTests(tc.deviceslib)()\n\t\t\tspec, err := f.device(tc.device).toSpec()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expected, spec)\n\t\t})\n\t}\n}\n\nfunc TestGetAdditionalGIDs(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdevice *device\n\t\tdeviceNode *specs.DeviceNode\n\t\texpectedAdditionalGIDs []uint32\n\t}{\n\t\t{\n\t\t\tdescription: \"feature disabled\",\n\t\t\tdevice: &device{noAdditionalGIDs: true},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device node has no GID\",\n\t\t\tdevice: &device{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device node has zero GID\",\n\t\t\tdevice: &device{},\n\t\t\tdeviceNode: &specs.DeviceNode{\n\t\t\t\tGID: to.Ptr[uint32](0),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"filemode not specified\",\n\t\t\tdevice: &device{},\n\t\t\tdeviceNode: &specs.DeviceNode{\n\t\t\t\tGID: to.Ptr[uint32](1),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device node is not a character device\",\n\t\t\tdevice: &device{},\n\t\t\tdeviceNode: &specs.DeviceNode{\n\t\t\t\tGID: to.Ptr[uint32](1),\n\t\t\t\tFileMode: to.Ptr(0666 | os.ModeSymlink),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"character device is world read-writeable\",\n\t\t\tdevice: &device{},\n\t\t\tdeviceNode: &specs.DeviceNode{\n\t\t\t\tGID: to.Ptr[uint32](1),\n\t\t\t\tFileMode: to.Ptr(0666 | os.ModeCharDevice),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"character device is only world readable\",\n\t\t\tdevice: &device{},\n\t\t\tdeviceNode: &specs.DeviceNode{\n\t\t\t\tGID: to.Ptr[uint32](1),\n\t\t\t\tFileMode: to.Ptr(0664 | os.ModeCharDevice),\n\t\t\t},\n\t\t\texpectedAdditionalGIDs: []uint32{1},\n\t\t},\n\t\t{\n\t\t\tdescription: \"character device is only world writeable\",\n\t\t\tdevice: &device{},\n\t\t\tdeviceNode: &specs.DeviceNode{\n\t\t\t\tGID: to.Ptr[uint32](1),\n\t\t\t\tFileMode: to.Ptr(0662 | os.ModeCharDevice),\n\t\t\t},\n\t\t\texpectedAdditionalGIDs: []uint32{1},\n\t\t},\n\t\t{\n\t\t\tdescription: \"character device is not world read-writeable\",\n\t\t\tdevice: &device{},\n\t\t\tdeviceNode: &specs.DeviceNode{\n\t\t\t\tGID: to.Ptr[uint32](1),\n\t\t\t\tFileMode: to.Ptr(0660 | os.ModeCharDevice),\n\t\t\t},\n\t\t\texpectedAdditionalGIDs: []uint32{1},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tadditionalGIDs := tc.device.getAdditionalGIDs(tc.deviceNode)\n\n\t\t\trequire.EqualValues(t, tc.expectedAdditionalGIDs, additionalGIDs)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/edits/edits.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage edits\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\nconst (\n\t// An EmptyFactory is an edits factory that always returns empty CDI\n\t// container edits.\n\tEmptyFactory = empty(\"empty\")\n)\n\ntype Factory interface {\n\tNew() *cdi.ContainerEdits\n\tFromDiscoverer(discover.Discover) (*cdi.ContainerEdits, error)\n}\n\ntype empty string\n\ntype factory struct {\n\tlogger logger.Interface\n\tnoAdditionalGIDsForDeviceNodes bool\n}\n\nvar _ Factory = (*empty)(nil)\nvar _ Factory = (*factory)(nil)\n\ntype Option func(*factory)\n\nfunc NewFactory(opts ...Option) Factory {\n\tf := &factory{\n\t\tlogger: &logger.NullLogger{},\n\t}\n\tfor _, opt := range opts {\n\t\topt(f)\n\t}\n\treturn f\n}\n\nfunc (f *factory) New() *cdi.ContainerEdits {\n\treturn EmptyFactory.New()\n}\n\nfunc (f *factory) FromDiscoverer(d discover.Discover) (*cdi.ContainerEdits, error) {\n\tdevices, err := d.Devices()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover devices: %v\", err)\n\t}\n\n\tenvs, err := d.EnvVars()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover environment variables: %w\", err)\n\t}\n\n\tmounts, err := d.Mounts()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover mounts: %v\", err)\n\t}\n\n\thooks, err := d.Hooks()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover hooks: %v\", err)\n\t}\n\n\tc := EmptyFactory.New()\n\tfor _, d := range devices {\n\t\tedits, err := f.device(d).toEdits()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to created container edits for device: %v\", err)\n\t\t}\n\t\tc.Append(edits)\n\t}\n\n\tfor _, e := range envs {\n\t\tc.Append(envvar(e).toEdits())\n\t}\n\n\tfor _, m := range mounts {\n\t\tc.Append(mount(m).toEdits())\n\t}\n\n\tfor _, h := range hooks {\n\t\tc.Append(hook(h).toEdits())\n\t}\n\n\treturn c, nil\n}\n\nfunc (f *factory) device(d discover.Device) *device {\n\treturn &device{\n\t\tDevice: d,\n\t\tnoAdditionalGIDs: f.noAdditionalGIDsForDeviceNodes,\n\t}\n}\n\n// New creates a set of empty CDI container edits for an empty factory.\nfunc (e empty) New() *cdi.ContainerEdits {\n\tc := cdi.ContainerEdits{\n\t\tContainerEdits: &specs.ContainerEdits{},\n\t}\n\treturn &c\n}\n\n// FromDiscoverer creates a set of empty CDI container edits for ANY discoverer.\nfunc (e empty) FromDiscoverer(_ discover.Discover) (*cdi.ContainerEdits, error) {\n\treturn e.New(), nil\n}\n\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(f *factory) {\n\t\tf.logger = logger\n\t}\n}\n\nfunc WithNoAdditionalGIDsForDeviceNodes(noAdditionalGIDsForDeviceNodes bool) Option {\n\treturn func(f *factory) {\n\t\tf.noAdditionalGIDsForDeviceNodes = noAdditionalGIDsForDeviceNodes\n\t}\n}\n"
},
{
"path": "internal/edits/edits_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage edits\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\n// TODO: This test doesn't actually do anything.\nfunc TestFromDiscovererAllowsMountsToIterate(t *testing.T) {\n\tt.Skip(\"This test does not test anything significant\")\n\tedits, err := NewFactory().FromDiscoverer(discover.None{})\n\trequire.NoError(t, err)\n\n\trequire.Empty(t, edits.Mounts)\n}\n"
},
{
"path": "internal/edits/envvar.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage edits\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\ntype envvar discover.EnvVar\n\n// toEdits converts a discovered envvar to CDI Container Edits.\nfunc (d envvar) toEdits() *cdi.ContainerEdits {\n\te := cdi.ContainerEdits{\n\t\tContainerEdits: &specs.ContainerEdits{\n\t\t\tEnv: []string{fmt.Sprintf(\"%s=%s\", d.Name, d.Value)},\n\t\t},\n\t}\n\treturn &e\n}\n"
},
{
"path": "internal/edits/hook.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage edits\n\nimport (\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\ntype hook discover.Hook\n\n// toEdits converts a discovered hook to CDI Container Edits.\nfunc (d hook) toEdits() *cdi.ContainerEdits {\n\te := cdi.ContainerEdits{\n\t\tContainerEdits: &specs.ContainerEdits{\n\t\t\tHooks: []*specs.Hook{d.toSpec()},\n\t\t},\n\t}\n\treturn &e\n}\n\n// toSpec converts a discovered Hook to a CDI Spec Hook. Note\n// that missing info is filled in when edits are applied by querying the Hook node.\nfunc (d hook) toSpec() *specs.Hook {\n\ts := specs.Hook{\n\t\tHookName: d.Lifecycle,\n\t\tPath: d.Path,\n\t\tArgs: d.Args,\n\t\tEnv: d.Env,\n\t}\n\n\treturn &s\n}\n"
},
{
"path": "internal/edits/mount.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage edits\n\nimport (\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\ntype mount discover.Mount\n\n// toEdits converts a discovered mount to CDI Container Edits.\nfunc (d mount) toEdits() *cdi.ContainerEdits {\n\te := cdi.ContainerEdits{\n\t\tContainerEdits: &specs.ContainerEdits{\n\t\t\tMounts: []*specs.Mount{d.toSpec()},\n\t\t},\n\t}\n\treturn &e\n}\n\n// toSpec converts a discovered Mount to a CDI Spec Mount. Note\n// that missing info is filled in when edits are applied by querying the Mount node.\nfunc (d mount) toSpec() *specs.Mount {\n\ts := specs.Mount{\n\t\tHostPath: d.HostPath,\n\t\tContainerPath: d.Path,\n\t\tOptions: d.Options,\n\t}\n\n\treturn &s\n}\n"
},
{
"path": "internal/info/additional_info.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage info\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/info\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n)\n\n// additionalInfo allows for the info.Interface to be extened to implement the infoInterface.\ntype additionalInfo struct {\n\tinfo.Interface\n\tnvmllib nvml.Interface\n\tdevicelib device.Interface\n}\n\n// UsesNVGPUModule checks whether the nvgpu module is used.\n// We use the device name to signal this, since devices that use the nvgpu module have their device\n// names as:\n//\n//\tGPU 0: Orin (nvgpu) (UUID: 54d0709b-558d-5a59-9c65-0c5fc14a21a4)\n//\n// This function returns true if ALL devices use the nvgpu module.\nfunc (i additionalInfo) UsesNVGPUModule() (uses bool, reason string) {\n\t// We ensure that this function never panics\n\tdefer func() {\n\t\tif err := recover(); err != nil {\n\t\t\tuses = false\n\t\t\treason = fmt.Sprintf(\"panic: %v\", err)\n\t\t}\n\t}()\n\n\tret := i.nvmllib.Init()\n\tif ret != nvml.SUCCESS {\n\t\treturn false, fmt.Sprintf(\"failed to initialize nvml: %v\", ret)\n\t}\n\tdefer func() {\n\t\t_ = i.nvmllib.Shutdown()\n\t}()\n\n\tvar names []string\n\n\terr := i.devicelib.VisitDevices(func(i int, d device.Device) error {\n\t\tname, ret := d.GetName()\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn fmt.Errorf(\"device %v: %v\", i, ret)\n\t\t}\n\t\tnames = append(names, name)\n\t\treturn nil\n\t})\n\tif err != nil {\n\t\treturn false, fmt.Sprintf(\"failed to get device names: %v\", err)\n\t}\n\n\tif len(names) == 0 {\n\t\treturn false, \"no devices found\"\n\t}\n\n\tfor _, name := range names {\n\t\tif !strings.Contains(name, \"(nvgpu)\") {\n\t\t\treturn false, fmt.Sprintf(\"device %q does not use nvgpu module\", name)\n\t\t}\n\t}\n\treturn true, \"all devices use nvgpu module\"\n}\n"
},
{
"path": "internal/info/additional_info_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage info\n\nimport (\n\t\"testing\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml/mock\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestUsesNVGPUModule(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tnvmllib nvml.Interface\n\t\texpected bool\n\t}{\n\t\t{\n\t\t\tdescription: \"init failure returns false\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.ERROR_LIBRARY_NOT_FOUND\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"no devices returns false\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 0, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"DeviceGetCount error returns false\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 0, nvml.ERROR_UNKNOWN\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Failure to get device name returns false\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 1, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetHandleByIndexFunc: func(index int) (nvml.Device, nvml.Return) {\n\t\t\t\t\tdevice := &mock.Device{\n\t\t\t\t\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\t\t\t\t\treturn \"\", nvml.ERROR_UNKNOWN\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn device, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"nested panic returns false\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 1, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetHandleByIndexFunc: func(index int) (nvml.Device, nvml.Return) {\n\t\t\t\t\tdevice := &mock.Device{\n\t\t\t\t\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\t\t\t\t\tpanic(\"deep panic\")\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn device, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Single device name with no nvgpu\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 1, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetHandleByIndexFunc: func(index int) (nvml.Device, nvml.Return) {\n\t\t\t\t\tdevice := &mock.Device{\n\t\t\t\t\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\t\t\t\t\treturn \"NVIDIA A100-SXM4-40GB\", nvml.SUCCESS\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn device, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Single device name with nvgpu\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 1, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetHandleByIndexFunc: func(index int) (nvml.Device, nvml.Return) {\n\t\t\t\t\tdevice := &mock.Device{\n\t\t\t\t\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\t\t\t\t\treturn \"Orin (nvgpu)\", nvml.SUCCESS\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn device, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Multiple device names with no nvgpu\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 2, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetHandleByIndexFunc: func(index int) (nvml.Device, nvml.Return) {\n\t\t\t\t\tdevice := &mock.Device{\n\t\t\t\t\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\t\t\t\t\treturn \"NVIDIA A100-SXM4-40GB\", nvml.SUCCESS\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn device, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Multiple device names with nvgpu\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 2, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetHandleByIndexFunc: func(index int) (nvml.Device, nvml.Return) {\n\t\t\t\t\tdevice := &mock.Device{\n\t\t\t\t\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\t\t\t\t\treturn \"Orin (nvgpu)\", nvml.SUCCESS\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn device, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"Mixed device names\",\n\t\t\tnvmllib: &mock.Interface{\n\t\t\t\tInitFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tShutdownFunc: func() nvml.Return {\n\t\t\t\t\treturn nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 2, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tDeviceGetHandleByIndexFunc: func(index int) (nvml.Device, nvml.Return) {\n\t\t\t\t\tvar deviceName string\n\t\t\t\t\tif index == 0 {\n\t\t\t\t\t\tdeviceName = \"NVIDIA A100-SXM4-40GB\"\n\t\t\t\t\t} else {\n\t\t\t\t\t\tdeviceName = \"Orin (nvgpu)\"\n\t\t\t\t\t}\n\t\t\t\t\tdevice := &mock.Device{\n\t\t\t\t\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\t\t\t\t\treturn deviceName, nvml.SUCCESS\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn device, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tsut := additionalInfo{\n\t\t\t\tnvmllib: tc.nvmllib,\n\t\t\t\tdevicelib: device.New(tc.nvmllib),\n\t\t\t}\n\n\t\t\tflag, _ := sut.UsesNVGPUModule()\n\t\t\trequire.Equal(t, tc.expected, flag)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/info/auto.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage info\n\nimport (\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/info\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// A RuntimeMode is used to select a specific mode of operation for the NVIDIA Container Runtime.\ntype RuntimeMode string\n\nconst (\n\t// In LegacyRuntimeMode the nvidia-container-runtime injects the\n\t// nvidia-container-runtime-hook as a prestart hook into the incoming\n\t// container config. This hook invokes the nvidia-container-cli to perform\n\t// the required modifications to the container.\n\tLegacyRuntimeMode = RuntimeMode(\"legacy\")\n\t// In CSVRuntimeMode the nvidia-container-runtime processes a set of CSV\n\t// files to determine which container modification are required. The\n\t// contents of these CSV files are used to generate an in-memory CDI\n\t// specification which is used to modify the container config.\n\tCSVRuntimeMode = RuntimeMode(\"csv\")\n\t// In CDIRuntimeMode the nvidia-container-runtime applies the modifications\n\t// to the container config required for the requested CDI devices in the\n\t// same way that other CDI clients would.\n\tCDIRuntimeMode = RuntimeMode(\"cdi\")\n\t// In JitCDIRuntimeMode the nvidia-container-runtime generates in-memory CDI\n\t// specifications for requested NVIDIA devices.\n\tJitCDIRuntimeMode = RuntimeMode(\"jit-cdi\")\n)\n\ntype RuntimeModeResolver interface {\n\tResolveRuntimeMode(string) RuntimeMode\n}\n\ntype modeResolver struct {\n\tlogger logger.Interface\n\t// TODO: This only needs to consider the requested devices.\n\timage *image.CUDA\n\tpropertyExtractor info.PropertyExtractor\n\tdefaultMode RuntimeMode\n}\n\ntype Option func(*modeResolver)\n\nfunc WithDefaultMode(defaultMode RuntimeMode) Option {\n\treturn func(mr *modeResolver) {\n\t\tmr.defaultMode = defaultMode\n\t}\n}\n\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(mr *modeResolver) {\n\t\tmr.logger = logger\n\t}\n}\n\nfunc WithImage(image *image.CUDA) Option {\n\treturn func(mr *modeResolver) {\n\t\tmr.image = image\n\t}\n}\n\nfunc WithPropertyExtractor(propertyExtractor info.PropertyExtractor) Option {\n\treturn func(mr *modeResolver) {\n\t\tmr.propertyExtractor = propertyExtractor\n\t}\n}\n\nfunc NewRuntimeModeResolver(opts ...Option) RuntimeModeResolver {\n\tr := &modeResolver{\n\t\tdefaultMode: JitCDIRuntimeMode,\n\t}\n\tfor _, opt := range opts {\n\t\topt(r)\n\t}\n\tif r.logger == nil {\n\t\tr.logger = &logger.NullLogger{}\n\t}\n\n\treturn r\n}\n\n// ResolveAutoMode determines the correct mode for the platform if set to \"auto\"\nfunc ResolveAutoMode(logger logger.Interface, mode string, image image.CUDA) (rmode RuntimeMode) {\n\tr := modeResolver{\n\t\tlogger: logger,\n\t\timage: &image,\n\t\tpropertyExtractor: nil,\n\t}\n\treturn r.ResolveRuntimeMode(mode)\n}\n\nfunc (m *modeResolver) ResolveRuntimeMode(mode string) (rmode RuntimeMode) {\n\tif mode != \"auto\" {\n\t\tm.logger.Infof(\"Using requested mode '%s'\", mode)\n\t\treturn RuntimeMode(mode)\n\t}\n\tdefer func() {\n\t\tm.logger.Infof(\"Auto-detected mode as '%v'\", rmode)\n\t}()\n\n\tif m.image.OnlyFullyQualifiedCDIDevices() {\n\t\treturn CDIRuntimeMode\n\t}\n\n\tnvinfo := info.New(\n\t\tinfo.WithLogger(m.logger),\n\t\tinfo.WithPropertyExtractor(m.propertyExtractor),\n\t)\n\n\tswitch nvinfo.ResolvePlatform() {\n\tcase info.PlatformNVML, info.PlatformWSL:\n\t\treturn m.defaultMode\n\tcase info.PlatformTegra:\n\t\treturn CSVRuntimeMode\n\t}\n\treturn m.defaultMode\n}\n"
},
{
"path": "internal/info/auto_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage info\n\nimport (\n\t\"testing\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/info\"\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n)\n\nfunc TestResolveAutoMode(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tmode string\n\t\texpectedMode string\n\t\tinfo map[string]bool\n\t\tenvmap map[string]string\n\t\tmounts []string\n\t}{\n\t\t{\n\t\t\tdescription: \"non-auto resolves to input\",\n\t\t\tmode: \"not-auto\",\n\t\t\texpectedMode: \"not-auto\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"legacy resolves to legacy\",\n\t\t\tmode: \"legacy\",\n\t\t\texpectedMode: \"legacy\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"no info defaults to legacy\",\n\t\t\tmode: \"auto\",\n\t\t\tinfo: map[string]bool{},\n\t\t\texpectedMode: \"jit-cdi\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-nvml, non-tegra, nvgpu resolves to csv\",\n\t\t\tmode: \"auto\",\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": false,\n\t\t\t\t\"tegra\": false,\n\t\t\t\t\"nvgpu\": true,\n\t\t\t},\n\t\t\texpectedMode: \"csv\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-nvml, tegra, non-nvgpu resolves to csv\",\n\t\t\tmode: \"auto\",\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": false,\n\t\t\t\t\"tegra\": true,\n\t\t\t\t\"nvgpu\": false,\n\t\t\t},\n\t\t\texpectedMode: \"csv\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-nvml, tegra, nvgpu resolves to csv\",\n\t\t\tmode: \"auto\",\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": false,\n\t\t\t\t\"tegra\": true,\n\t\t\t\t\"nvgpu\": true,\n\t\t\t},\n\t\t\texpectedMode: \"csv\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"nvml, non-tegra, non-nvgpu resolves to jit-cdi\",\n\t\t\tmode: \"auto\",\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": true,\n\t\t\t\t\"tegra\": false,\n\t\t\t\t\"nvgpu\": false,\n\t\t\t},\n\t\t\texpectedMode: \"jit-cdi\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"nvml, non-tegra, nvgpu resolves to csv\",\n\t\t\tmode: \"auto\",\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": true,\n\t\t\t\t\"tegra\": false,\n\t\t\t\t\"nvgpu\": true,\n\t\t\t},\n\t\t\texpectedMode: \"csv\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"nvml, tegra, non-nvgpu resolves to jit-cdi\",\n\t\t\tmode: \"auto\",\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": true,\n\t\t\t\t\"tegra\": true,\n\t\t\t\t\"nvgpu\": false,\n\t\t\t},\n\t\t\texpectedMode: \"jit-cdi\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"nvml, tegra, nvgpu resolves to csv\",\n\t\t\tmode: \"auto\",\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": true,\n\t\t\t\t\"tegra\": true,\n\t\t\t\t\"nvgpu\": true,\n\t\t\t},\n\t\t\texpectedMode: \"csv\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi devices resolves to cdi\",\n\t\t\tmode: \"auto\",\n\t\t\texpectedMode: \"cdi\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"nvidia.com/gpu=all\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple cdi devices resolves to cdi\",\n\t\t\tmode: \"auto\",\n\t\t\texpectedMode: \"cdi\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"nvidia.com/gpu=0,nvidia.com/gpu=1\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"at least one non-cdi device resolves to jit-cdi\",\n\t\t\tmode: \"auto\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"nvidia.com/gpu=0,0\",\n\t\t\t},\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": true,\n\t\t\t\t\"tegra\": false,\n\t\t\t\t\"nvgpu\": false,\n\t\t\t},\n\t\t\texpectedMode: \"jit-cdi\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"at least one non-cdi device resolves to csv\",\n\t\t\tmode: \"auto\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"nvidia.com/gpu=0,0\",\n\t\t\t},\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": false,\n\t\t\t\t\"tegra\": true,\n\t\t\t\t\"nvgpu\": false,\n\t\t\t},\n\t\t\texpectedMode: \"csv\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi mount devices resolves to CDI\",\n\t\t\tmode: \"auto\",\n\t\t\tmounts: []string{\n\t\t\t\t\"/var/run/nvidia-container-devices/cdi/nvidia.com/gpu/0\",\n\t\t\t},\n\t\t\texpectedMode: \"cdi\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi mount and non-CDI devices resolves to jit-cdi\",\n\t\t\tmode: \"auto\",\n\t\t\tmounts: []string{\n\t\t\t\t\"/var/run/nvidia-container-devices/cdi/nvidia.com/gpu/0\",\n\t\t\t\t\"/var/run/nvidia-container-devices/all\",\n\t\t\t},\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": true,\n\t\t\t\t\"tegra\": false,\n\t\t\t\t\"nvgpu\": false,\n\t\t\t},\n\t\t\texpectedMode: \"jit-cdi\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi mount and non-CDI envvar resolves to cdi\",\n\t\t\tmode: \"auto\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"0\",\n\t\t\t},\n\t\t\tmounts: []string{\n\t\t\t\t\"/var/run/nvidia-container-devices/cdi/nvidia.com/gpu/0\",\n\t\t\t},\n\t\t\tinfo: map[string]bool{\n\t\t\t\t\"nvml\": true,\n\t\t\t\t\"tegra\": false,\n\t\t\t\t\"nvgpu\": false,\n\t\t\t},\n\t\t\texpectedMode: \"cdi\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tproperties := &info.PropertyExtractorMock{\n\t\t\t\tHasNvmlFunc: func() (bool, string) {\n\t\t\t\t\treturn tc.info[\"nvml\"], \"nvml\"\n\t\t\t\t},\n\t\t\t\tHasDXCoreFunc: func() (bool, string) {\n\t\t\t\t\treturn tc.info[\"dxcore\"], \"dxcore\"\n\t\t\t\t},\n\t\t\t\tHasTegraFilesFunc: func() (bool, string) {\n\t\t\t\t\treturn tc.info[\"tegra\"], \"tegra\"\n\t\t\t\t},\n\t\t\t\tHasAnIntegratedGPUFunc: func() (bool, string) {\n\t\t\t\t\treturn tc.info[\"nvgpu\"], \"nvgpu\"\n\t\t\t\t},\n\t\t\t}\n\n\t\t\tvar mounts []specs.Mount\n\t\t\tfor _, d := range tc.mounts {\n\t\t\t\tmount := specs.Mount{\n\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\tDestination: d,\n\t\t\t\t}\n\t\t\t\tmounts = append(mounts, mount)\n\t\t\t}\n\t\t\timage, _ := image.New(\n\t\t\t\timage.WithEnvMap(tc.envmap),\n\t\t\t\timage.WithMounts(mounts),\n\t\t\t\timage.WithAcceptDeviceListAsVolumeMounts(true),\n\t\t\t\timage.WithAcceptEnvvarUnprivileged(true),\n\t\t\t)\n\t\t\tmr := NewRuntimeModeResolver(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithImage(&image),\n\t\t\t\tWithPropertyExtractor(properties),\n\t\t\t)\n\t\t\tmode := mr.ResolveRuntimeMode(tc.mode)\n\t\t\trequire.EqualValues(t, tc.expectedMode, mode)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/info/drm/drm_devices.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage drm\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n)\n\n// GetDeviceNodesByBusID returns the DRM devices associated with the specified PCI bus ID\nfunc GetDeviceNodesByBusID(busID string) ([]string, error) {\n\tdrmRoot := filepath.Join(\"/sys/bus/pci/devices\", busID, \"drm\")\n\tmatches, err := filepath.Glob(fmt.Sprintf(\"%s/*\", drmRoot))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar drmDeviceNodes []string\n\tfor _, m := range matches {\n\t\tdrmDeviceNode := filepath.Join(\"/dev/dri\", filepath.Base(m))\n\t\tdrmDeviceNodes = append(drmDeviceNodes, drmDeviceNode)\n\t}\n\n\treturn drmDeviceNodes, nil\n}\n"
},
{
"path": "internal/info/proc/devices/builder.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage devices\n\ntype builder struct {\n\tasMap devices\n\tfilter func(string) bool\n}\n\n// New creates a new devices struct with the specified options.\nfunc New(opts ...Option) Devices {\n\tb := &builder{}\n\tfor _, opt := range opts {\n\t\topt(b)\n\t}\n\n\tif b.filter == nil {\n\t\tb.filter = func(string) bool { return false }\n\t}\n\n\tdevices := make(devices)\n\tfor k, v := range b.asMap {\n\t\tif b.filter(string(k)) {\n\t\t\tcontinue\n\t\t}\n\t\tdevices[k] = v\n\t}\n\treturn devices\n}\n\ntype Option func(*builder)\n\n// WithDeviceToMajor specifies an explicit device name to major number map.\nfunc WithDeviceToMajor(deviceToMajor map[string]int) Option {\n\treturn func(b *builder) {\n\t\tb.asMap = make(devices)\n\t\tfor name, major := range deviceToMajor {\n\t\t\tb.asMap[Name(name)] = Major(major)\n\t\t}\n\t}\n}\n\n// WithFilter specifies a filter to exclude devices.\nfunc WithFilter(filter func(string) bool) Option {\n\treturn func(b *builder) {\n\t\tb.filter = filter\n\t}\n}\n"
},
{
"path": "internal/info/proc/devices/devices.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage devices\n\nimport (\n\t\"bufio\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"strings\"\n)\n\n// Device major numbers and device names for NVIDIA devices\nconst (\n\tNVIDIAUVMMinor = 0\n\tNVIDIAUVMToolsMinor = 1\n\tNVIDIACTLMinor = 255\n\tNVIDIAModesetMinor = 254\n\n\tNVIDIAFrontend = Name(\"nvidia-frontend\")\n\tNVIDIAGPU = Name(\"nvidia\")\n\tNVIDIACaps = Name(\"nvidia-caps\")\n\tNVIDIAUVM = Name(\"nvidia-uvm\")\n\n\tprocDevicesPath = \"/proc/devices\"\n\tnvidiaDevicePrefix = \"nvidia\"\n)\n\n// Name represents the name of a device as specified under /proc/devices\ntype Name string\n\n// Major represents a device major as specified under /proc/devices\ntype Major int\n\n// Devices represents the set of devices under /proc/devices\n//\n//go:generate moq -rm -fmt=goimports -stub -out devices_mock.go . Devices\ntype Devices interface {\n\tExists(Name) bool\n\tGet(Name) (Major, bool)\n\tCount() int\n}\n\ntype devices map[Name]Major\n\nvar _ Devices = devices(nil)\n\n// Count returns the number of devices defined.\nfunc (d devices) Count() int {\n\treturn len(d)\n}\n\n// Exists checks if a Device with a given name exists or not\nfunc (d devices) Exists(name Name) bool {\n\t_, exists := d.Get(name)\n\treturn exists\n}\n\n// Get a Device from Devices. It also has fallback logic to ensure device name changes in /proc/devices are handled\n// For e.g:- For GPU drivers 550.40.x or greater, the gpu device has been renamed from \"nvidia-frontend\" to \"nvidia\".\nfunc (d devices) Get(name Name) (Major, bool) {\n\tfor _, n := range name.getWithFallback() {\n\t\tdevice, exists := d[n]\n\t\tif exists {\n\t\t\treturn device, true\n\t\t}\n\t}\n\treturn 0, false\n}\n\n// getWithFallback returns a prioritised list of device names for a specific name.\n// This allows multiple names to be associated with a single name to support various driver versions.\nfunc (n Name) getWithFallback() []Name {\n\tif n == NVIDIAGPU || n == NVIDIAFrontend {\n\t\treturn []Name{NVIDIAGPU, NVIDIAFrontend}\n\t}\n\treturn []Name{n}\n}\n\n// GetNVIDIADevices returns the set of NVIDIA Devices on the machine\nfunc GetNVIDIADevices() (Devices, error) {\n\treturn nvidiaDevices(procDevicesPath)\n}\n\n// nvidiaDevices returns the set of NVIDIA Devices from the specified devices file.\n// This is useful for testing since we may be testing on a system where `/proc/devices` does\n// contain a reference to NVIDIA devices.\nfunc nvidiaDevices(devicesPath string) (Devices, error) {\n\tdevicesFile, err := os.Open(devicesPath)\n\tif os.IsNotExist(err) {\n\t\treturn nil, nil\n\t}\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error opening devices file: %v\", err)\n\t}\n\tdefer devicesFile.Close()\n\n\treturn nvidiaDeviceFrom(devicesFile)\n}\n\nvar errNoNvidiaDevices = errors.New(\"no NVIDIA devices found\")\n\nfunc nvidiaDeviceFrom(reader io.Reader) (Devices, error) {\n\tallDevices := devicesFrom(reader)\n\n\tnvidiaDevices := New(\n\t\tWithDeviceToMajor(allDevices),\n\t\tWithFilter(func(n string) bool {\n\t\t\treturn !strings.HasPrefix(n, nvidiaDevicePrefix)\n\t\t}),\n\t)\n\tif nvidiaDevices.Count() == 0 {\n\t\treturn nil, errNoNvidiaDevices\n\t}\n\treturn nvidiaDevices, nil\n}\n\nfunc devicesFrom(reader io.Reader) map[string]int {\n\tallDevices := make(map[string]int)\n\tscanner := bufio.NewScanner(reader)\n\tfor scanner.Scan() {\n\t\tdevice, major, err := processProcDeviceLine(scanner.Text())\n\t\tif err != nil {\n\t\t\tcontinue\n\t\t}\n\t\tallDevices[device] = major\n\t}\n\treturn allDevices\n}\n\nfunc processProcDeviceLine(line string) (string, int, error) {\n\ttrimmed := strings.TrimSpace(line)\n\n\tvar name string\n\tvar major int\n\n\tn, _ := fmt.Sscanf(trimmed, \"%d %s\", &major, &name)\n\tif n == 2 {\n\t\treturn name, major, nil\n\t}\n\n\treturn \"\", 0, fmt.Errorf(\"unparsable line: %v\", line)\n}\n"
},
{
"path": "internal/info/proc/devices/devices_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage devices\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that DevicesMock does implement Devices.\n// If this is not the case, regenerate this file with moq.\nvar _ Devices = &DevicesMock{}\n\n// DevicesMock is a mock implementation of Devices.\n//\n//\tfunc TestSomethingThatUsesDevices(t *testing.T) {\n//\n//\t\t// make and configure a mocked Devices\n//\t\tmockedDevices := &DevicesMock{\n//\t\t\tCountFunc: func() int {\n//\t\t\t\tpanic(\"mock out the Count method\")\n//\t\t\t},\n//\t\t\tExistsFunc: func(name Name) bool {\n//\t\t\t\tpanic(\"mock out the Exists method\")\n//\t\t\t},\n//\t\t\tGetFunc: func(name Name) (Major, bool) {\n//\t\t\t\tpanic(\"mock out the Get method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedDevices in code that requires Devices\n//\t\t// and then make assertions.\n//\n//\t}\ntype DevicesMock struct {\n\t// CountFunc mocks the Count method.\n\tCountFunc func() int\n\n\t// ExistsFunc mocks the Exists method.\n\tExistsFunc func(name Name) bool\n\n\t// GetFunc mocks the Get method.\n\tGetFunc func(name Name) (Major, bool)\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Count holds details about calls to the Count method.\n\t\tCount []struct {\n\t\t}\n\t\t// Exists holds details about calls to the Exists method.\n\t\tExists []struct {\n\t\t\t// Name is the name argument value.\n\t\t\tName Name\n\t\t}\n\t\t// Get holds details about calls to the Get method.\n\t\tGet []struct {\n\t\t\t// Name is the name argument value.\n\t\t\tName Name\n\t\t}\n\t}\n\tlockCount sync.RWMutex\n\tlockExists sync.RWMutex\n\tlockGet sync.RWMutex\n}\n\n// Count calls CountFunc.\nfunc (mock *DevicesMock) Count() int {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockCount.Lock()\n\tmock.calls.Count = append(mock.calls.Count, callInfo)\n\tmock.lockCount.Unlock()\n\tif mock.CountFunc == nil {\n\t\tvar (\n\t\t\tnOut int\n\t\t)\n\t\treturn nOut\n\t}\n\treturn mock.CountFunc()\n}\n\n// CountCalls gets all the calls that were made to Count.\n// Check the length with:\n//\n//\tlen(mockedDevices.CountCalls())\nfunc (mock *DevicesMock) CountCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockCount.RLock()\n\tcalls = mock.calls.Count\n\tmock.lockCount.RUnlock()\n\treturn calls\n}\n\n// Exists calls ExistsFunc.\nfunc (mock *DevicesMock) Exists(name Name) bool {\n\tcallInfo := struct {\n\t\tName Name\n\t}{\n\t\tName: name,\n\t}\n\tmock.lockExists.Lock()\n\tmock.calls.Exists = append(mock.calls.Exists, callInfo)\n\tmock.lockExists.Unlock()\n\tif mock.ExistsFunc == nil {\n\t\tvar (\n\t\t\tbOut bool\n\t\t)\n\t\treturn bOut\n\t}\n\treturn mock.ExistsFunc(name)\n}\n\n// ExistsCalls gets all the calls that were made to Exists.\n// Check the length with:\n//\n//\tlen(mockedDevices.ExistsCalls())\nfunc (mock *DevicesMock) ExistsCalls() []struct {\n\tName Name\n} {\n\tvar calls []struct {\n\t\tName Name\n\t}\n\tmock.lockExists.RLock()\n\tcalls = mock.calls.Exists\n\tmock.lockExists.RUnlock()\n\treturn calls\n}\n\n// Get calls GetFunc.\nfunc (mock *DevicesMock) Get(name Name) (Major, bool) {\n\tcallInfo := struct {\n\t\tName Name\n\t}{\n\t\tName: name,\n\t}\n\tmock.lockGet.Lock()\n\tmock.calls.Get = append(mock.calls.Get, callInfo)\n\tmock.lockGet.Unlock()\n\tif mock.GetFunc == nil {\n\t\tvar (\n\t\t\tmajorOut Major\n\t\t\tbOut bool\n\t\t)\n\t\treturn majorOut, bOut\n\t}\n\treturn mock.GetFunc(name)\n}\n\n// GetCalls gets all the calls that were made to Get.\n// Check the length with:\n//\n//\tlen(mockedDevices.GetCalls())\nfunc (mock *DevicesMock) GetCalls() []struct {\n\tName Name\n} {\n\tvar calls []struct {\n\t\tName Name\n\t}\n\tmock.lockGet.RLock()\n\tcalls = mock.calls.Get\n\tmock.lockGet.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/info/proc/devices/devices_test.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage devices\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNvidiaDevices(t *testing.T) {\n\tperDriverDeviceMaps := map[string]map[string]int{\n\t\t\"pre550\": {\n\t\t\t\"nvidia-frontend\": 195,\n\t\t\t\"nvidia-nvlink\": 234,\n\t\t\t\"nvidia-caps\": 235,\n\t\t\t\"nvidia-uvm\": 510,\n\t\t\t\"nvidia-nvswitch\": 511,\n\t\t},\n\t\t\"post550\": {\n\t\t\t\"nvidia\": 195,\n\t\t\t\"nvidia-nvlink\": 234,\n\t\t\t\"nvidia-caps\": 235,\n\t\t\t\"nvidia-uvm\": 510,\n\t\t\t\"nvidia-nvswitch\": 511,\n\t\t},\n\t}\n\n\tfor k, devices := range perDriverDeviceMaps {\n\t\tnvidiaDevices := New(WithDeviceToMajor(devices))\n\t\tt.Run(k, func(t *testing.T) {\n\t\t\t// Each of the expected devices needs to exist.\n\t\t\tfor name, major := range devices {\n\t\t\t\tdevice, exists := nvidiaDevices.Get(Name(name))\n\t\t\t\trequire.True(t, exists)\n\t\t\t\trequire.Equal(t, device, Major(major))\n\t\t\t}\n\t\t\t// An unexpected device cannot exist\n\t\t\t_, exists := nvidiaDevices.Get(\"bogus\")\n\t\t\trequire.False(t, exists)\n\n\t\t\t// Regardles of the driver version, the nvidia and nvidia-frontend\n\t\t\t// names are supported and have the same value.\n\t\t\tnvidia, exists := nvidiaDevices.Get(NVIDIAGPU)\n\t\t\trequire.True(t, exists)\n\t\t\tnvidiaFrontend, exists := nvidiaDevices.Get(NVIDIAFrontend)\n\t\t\trequire.True(t, exists)\n\t\t\trequire.Equal(t, nvidia, nvidiaFrontend)\n\t\t})\n\n\t}\n}\n\nfunc TestProcessDeviceFile(t *testing.T) {\n\ttestCases := []struct {\n\t\tlines []string\n\t\texpected devices\n\t\texpectedError error\n\t}{\n\t\t{lines: []string{}, expectedError: errNoNvidiaDevices},\n\t\t{lines: []string{\"Not a valid line:\"}, expectedError: errNoNvidiaDevices},\n\t\t{lines: []string{\"195 nvidia-frontend\"}, expected: devices{\"nvidia-frontend\": 195}},\n\t\t{lines: []string{\"195 nvidia\"}, expected: devices{\"nvidia\": 195}},\n\t\t{lines: []string{\"195 nvidia-frontend\", \"235 nvidia-caps\"}, expected: devices{\"nvidia-frontend\": 195, \"nvidia-caps\": 235}},\n\t\t{lines: []string{\" 195 nvidia-frontend\"}, expected: devices{\"nvidia-frontend\": 195}},\n\t\t{lines: []string{\"Not a valid line:\", \"\", \"195 nvidia-frontend\"}, expected: devices{\"nvidia-frontend\": 195}},\n\t\t{lines: []string{\"195 not-nvidia-frontend\"}, expectedError: errNoNvidiaDevices},\n\t}\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"testcase %d\", i), func(t *testing.T) {\n\t\t\tcontents := strings.NewReader(strings.Join(tc.lines, \"\\n\"))\n\t\t\td, err := nvidiaDeviceFrom(contents)\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\n\t\t\tif tc.expectedError == nil {\n\t\t\t\trequire.EqualValues(t, tc.expected, d.(devices))\n\t\t\t}\n\n\t\t})\n\t}\n}\n\nfunc TestProcessDeviceFileLine(t *testing.T) {\n\ttestCases := []struct {\n\t\tline string\n\t\tname string\n\t\tmajor int\n\t\terr bool\n\t}{\n\t\t{\"\", \"\", 0, true},\n\t\t{\"0\", \"\", 0, true},\n\t\t{\"notint nvidia-frontend\", \"\", 0, true},\n\t\t{\"195 nvidia-frontend\", \"nvidia-frontend\", 195, false},\n\t\t{\" 195 nvidia-frontend\", \"nvidia-frontend\", 195, false},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"testcase %d\", i), func(t *testing.T) {\n\t\t\tname, major, err := processProcDeviceLine(tc.line)\n\n\t\t\trequire.Equal(t, tc.name, name)\n\t\t\trequire.Equal(t, tc.major, major)\n\t\t\tif tc.err {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/info/proc/information_files.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage proc\n\nimport (\n\t\"bufio\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n)\n\n// GPUInfoField represents the field name for information specified in a GPU's information file\ntype GPUInfoField string\n\n// The following constants define the fields of interest from the GPU information file\nconst (\n\tGPUInfoModel = GPUInfoField(\"Model\")\n\tGPUInfoGPUUUID = GPUInfoField(\"GPU UUID\")\n\tGPUInfoBusLocation = GPUInfoField(\"Bus Location\")\n\tGPUInfoDeviceMinor = GPUInfoField(\"Device Minor\")\n)\n\n// GPUInfo stores the information for a GPU as determined from its associated information file\ntype GPUInfo map[GPUInfoField]string\n\n// GetInformationFilePaths returns the list of information files associated with NVIDIA GPUs.\nfunc GetInformationFilePaths(root string) ([]string, error) {\n\treturn filepath.Glob(filepath.Join(root, \"/proc/driver/nvidia/gpus/*/information\"))\n}\n\n// ParseGPUInformationFile parses the specified GPU information file and constructs a GPUInfo structure\nfunc ParseGPUInformationFile(path string) (GPUInfo, error) {\n\tinfoFile, err := os.Open(path)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to open %v: %v\", path, err)\n\t}\n\tdefer infoFile.Close()\n\n\treturn gpuInfoFrom(infoFile), nil\n}\n\n// gpuInfoFrom parses a GPUInfo struct from the specified reader\n// An information file has the following structure:\n// $ cat /proc/driver/nvidia/gpus/0000\\:06\\:00.0/information\n// Model: Tesla V100-SXM2-16GB\n// IRQ: 408\n// GPU UUID: GPU-edfee158-11c1-52b8-0517-92f30e7fac88\n// Video BIOS: 88.00.41.00.01\n// Bus Type: PCIe\n// DMA Size: 47 bits\n// DMA Mask: 0x7fffffffffff\n// Bus Location: 0000:06:00.0\n// Device Minor: 0\n// GPU Excluded: No\nfunc gpuInfoFrom(reader io.Reader) GPUInfo {\n\tinfo := make(GPUInfo)\n\tscanner := bufio.NewScanner(reader)\n\tfor scanner.Scan() {\n\t\tline := scanner.Text()\n\n\t\tparts := strings.SplitN(line, \":\", 2)\n\t\tif len(parts) != 2 {\n\t\t\tcontinue\n\t\t}\n\n\t\tfield := GPUInfoField(parts[0])\n\t\tvalue := strings.TrimSpace(parts[1])\n\n\t\tinfo[field] = value\n\t}\n\n\treturn info\n}\n"
},
{
"path": "internal/info/version.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage info\n\nimport \"strings\"\n\n// version must be set by go build's -X main.version= option in the Makefile.\nvar version = \"unknown\"\n\n// gitCommit will be the hash that the binary was built from\n// and will be populated by the Makefile\nvar gitCommit = \"\"\n\n// GetVersionParts returns the different version components\nfunc GetVersionParts() []string {\n\tv := []string{version}\n\n\tif gitCommit != \"\" {\n\t\tv = append(v, \"commit: \"+gitCommit)\n\t}\n\n\treturn v\n}\n\n// GetVersionString returns the string representation of the version\nfunc GetVersionString(more ...string) string {\n\tv := append(GetVersionParts(), more...)\n\treturn strings.Join(v, \"\\n\")\n}\n"
},
{
"path": "internal/ldcache/ldcache.go",
"content": "/*\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\n// Adapted from https://github.com/rai-project/ldcache\n\npackage ldcache\n\nimport (\n\t\"bytes\"\n\t\"encoding/binary\"\n\t\"errors\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"syscall\"\n\t\"unsafe\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\nconst ldcachePath = \"/etc/ld.so.cache\"\n\nconst (\n\tmagicString1 = \"ld.so-1.7.0\"\n\tmagicString2 = \"glibc-ld.so.cache\"\n\tmagicVersion = \"1.1\"\n)\n\nconst (\n\tflagTypeMask = 0x00ff\n\tflagTypeELF = 0x0001\n\n\tflagArchMask = 0xff00\n\tflagArchI386 = 0x0000\n\tflagArchX8664 = 0x0300\n\tflagArchX32 = 0x0800\n\tflagArchPpc64le = 0x0500\n\n\t// flagArch_ARM_LIBHF is the flag value for 32-bit ARM libs using hard-float.\n\tflagArch_ARM_LIBHF = 0x0900\n\t// flagArch_AARCH64_LIB64 is the flag value for 64-bit ARM libs.\n\tflagArch_AARCH64_LIB64 = 0x0a00\n)\n\nvar errInvalidCache = errors.New(\"invalid ld.so.cache file\")\n\ntype header1 struct {\n\tMagic [len(magicString1) + 1]byte // include null delimiter\n\tNLibs uint32\n}\n\ntype entry1 struct {\n\tFlags int32\n\tKey, Value uint32\n}\n\ntype header2 struct {\n\tMagic [len(magicString2)]byte\n\tVersion [len(magicVersion)]byte\n\tNLibs uint32\n\tTableSize uint32\n\t_ [3]uint32 // unused\n\t_ uint64 // force 8 byte alignment\n}\n\ntype entry2 struct {\n\tFlags int32\n\tKey, Value uint32\n\tOSVersion uint32\n\tHWCap uint64\n}\n\n// LDCache represents the interface for performing lookups into the LDCache\n//\n//go:generate moq -rm -fmt=goimports -out ldcache_mock.go . LDCache\ntype LDCache interface {\n\tList() ([]string, []string)\n}\n\ntype ldcache struct {\n\t*bytes.Reader\n\n\tdata, libs []byte\n\theader header2\n\tentries []entry2\n\n\troot string\n\tlogger logger.Interface\n}\n\n// New creates a new LDCache with the specified logger and root.\nfunc New(logger logger.Interface, root string) (LDCache, error) {\n\tpath := filepath.Join(root, ldcachePath)\n\n\tlogger.Debugf(\"Opening ld.conf at %v\", path)\n\tf, err := os.Open(path)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer f.Close()\n\n\tfi, err := f.Stat()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\td, err := syscall.Mmap(int(f.Fd()), 0, int(fi.Size()),\n\t\tsyscall.PROT_READ, syscall.MAP_PRIVATE)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tcache := &ldcache{\n\t\tdata: d,\n\t\tReader: bytes.NewReader(d),\n\t\troot: root,\n\t\tlogger: logger,\n\t}\n\treturn cache, cache.parse()\n}\n\nfunc (c *ldcache) Close() error {\n\treturn syscall.Munmap(c.data)\n}\n\nfunc (c *ldcache) Magic() string {\n\treturn string(c.header.Magic[:])\n}\n\nfunc (c *ldcache) Version() string {\n\treturn string(c.header.Version[:])\n}\n\nfunc strn(b []byte, n int) string {\n\treturn string(b[:n])\n}\n\nfunc (c *ldcache) parse() error {\n\tvar header header1\n\n\t// Check for the old format (< glibc-2.2)\n\tif c.Len() <= int(unsafe.Sizeof(header)) {\n\t\treturn errInvalidCache\n\t}\n\tif strn(c.data, len(magicString1)) == magicString1 {\n\t\tif err := binary.Read(c, binary.LittleEndian, &header); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tn := int64(header.NLibs) * int64(unsafe.Sizeof(entry1{}))\n\t\toffset, err := c.Seek(n, 1) // skip old entries\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tn = (-offset) & int64(unsafe.Alignof(c.header)-1)\n\t\t_, err = c.Seek(n, 1) // skip padding\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\tc.libs = c.data[c.Size()-int64(c.Len()):] // kv offsets start here\n\tif err := binary.Read(c, binary.LittleEndian, &c.header); err != nil {\n\t\treturn err\n\t}\n\tif c.Magic() != magicString2 || c.Version() != magicVersion {\n\t\treturn errInvalidCache\n\t}\n\tc.entries = make([]entry2, c.header.NLibs)\n\tif err := binary.Read(c, binary.LittleEndian, &c.entries); err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\ntype entry struct {\n\tlibname string\n\tbits int\n\tvalue string\n}\n\n// getEntries returns the entires of the ldcache in a go-friendly struct.\nfunc (c *ldcache) getEntries() []entry {\n\tvar entries []entry\n\tfor _, e := range c.entries {\n\t\tbits := 0\n\t\tif ((e.Flags & flagTypeMask) & flagTypeELF) == 0 {\n\t\t\tcontinue\n\t\t}\n\t\tswitch e.Flags & flagArchMask {\n\t\tcase flagArchX8664:\n\t\t\tfallthrough\n\t\tcase flagArch_AARCH64_LIB64:\n\t\t\tfallthrough\n\t\tcase flagArchPpc64le:\n\t\t\tbits = 64\n\t\tcase flagArchX32:\n\t\t\tfallthrough\n\t\tcase flagArch_ARM_LIBHF:\n\t\t\tfallthrough\n\t\tcase flagArchI386:\n\t\t\tbits = 32\n\t\tdefault:\n\t\t\tcontinue\n\t\t}\n\t\tif e.Key > uint32(len(c.libs)) || e.Value > uint32(len(c.libs)) {\n\t\t\tcontinue\n\t\t}\n\t\tlib := bytesToString(c.libs[e.Key:])\n\t\tif lib == \"\" {\n\t\t\tc.logger.Debugf(\"Skipping invalid lib\")\n\t\t\tcontinue\n\t\t}\n\t\tvalue := bytesToString(c.libs[e.Value:])\n\t\tif value == \"\" {\n\t\t\tc.logger.Debugf(\"Skipping invalid value for lib %v\", lib)\n\t\t\tcontinue\n\t\t}\n\t\te := entry{\n\t\t\tlibname: lib,\n\t\t\tbits: bits,\n\t\t\tvalue: value,\n\t\t}\n\t\tentries = append(entries, e)\n\t}\n\treturn entries\n}\n\n// List creates a list of libraries in the ldcache.\n// The 32-bit and 64-bit libraries are returned separately.\nfunc (c *ldcache) List() ([]string, []string) {\n\tpaths := make(map[int][]string)\n\tprocessed := make(map[string]bool)\n\n\tfor _, e := range c.getEntries() {\n\t\tpath := filepath.Join(c.root, e.value)\n\t\tif processed[path] {\n\t\t\tcontinue\n\t\t}\n\t\tpaths[e.bits] = append(paths[e.bits], path)\n\t\tprocessed[path] = true\n\t}\n\n\treturn paths[32], paths[64]\n}\n\n// bytesToString converts a byte slice to a string.\n// This assumes that the byte slice is null-terminated\nfunc bytesToString(value []byte) string {\n\tn := bytes.IndexByte(value, 0)\n\tif n < 0 {\n\t\treturn \"\"\n\t}\n\n\treturn strn(value, n)\n}\n"
},
{
"path": "internal/ldcache/ldcache_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage ldcache\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that LDCacheMock does implement LDCache.\n// If this is not the case, regenerate this file with moq.\nvar _ LDCache = &LDCacheMock{}\n\n// LDCacheMock is a mock implementation of LDCache.\n//\n//\tfunc TestSomethingThatUsesLDCache(t *testing.T) {\n//\n//\t\t// make and configure a mocked LDCache\n//\t\tmockedLDCache := &LDCacheMock{\n//\t\t\tListFunc: func() ([]string, []string) {\n//\t\t\t\tpanic(\"mock out the List method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedLDCache in code that requires LDCache\n//\t\t// and then make assertions.\n//\n//\t}\ntype LDCacheMock struct {\n\t// ListFunc mocks the List method.\n\tListFunc func() ([]string, []string)\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// List holds details about calls to the List method.\n\t\tList []struct {\n\t\t}\n\t}\n\tlockList sync.RWMutex\n}\n\n// List calls ListFunc.\nfunc (mock *LDCacheMock) List() ([]string, []string) {\n\tif mock.ListFunc == nil {\n\t\tpanic(\"LDCacheMock.ListFunc: method is nil but LDCache.List was just called\")\n\t}\n\tcallInfo := struct {\n\t}{}\n\tmock.lockList.Lock()\n\tmock.calls.List = append(mock.calls.List, callInfo)\n\tmock.lockList.Unlock()\n\treturn mock.ListFunc()\n}\n\n// ListCalls gets all the calls that were made to List.\n// Check the length with:\n//\n//\tlen(mockedLDCache.ListCalls())\nfunc (mock *LDCacheMock) ListCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockList.RLock()\n\tcalls = mock.calls.List\n\tmock.lockList.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/ldconfig/ldconfig.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ldconfig\n\nimport (\n\t\"bufio\"\n\t\"flag\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strings\"\n\n\t\"github.com/prometheus/procfs\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n)\n\nconst (\n\t// ldsoconfdFilenamePattern specifies the pattern for the filename\n\t// in ld.so.conf.d that includes references to the specified directories.\n\t// The 00-nvcr prefix is chosen to ensure that these libraries have a\n\t// higher precedence than other libraries on the system, but lower than\n\t// the 00-cuda-compat that is included in some containers.\n\tldsoconfdFilenamePattern = \"00-nvcr-*.conf\"\n\t// ldsoconfdSystemDirsFilenamePattern specifies the filename pattern for the drop-in conf file\n\t// that includes the expected system directories for the container.\n\t// This is chosen to have a high likelihood of being lexicographically last in\n\t// in the list of config files, since system search paths should be\n\t// considered last.\n\tldsoconfdSystemDirsFilenamePattern = \"zz-nvcr-*.conf\"\n\t// defaultTopLevelLdsoconfFilePath is the standard location of the top-level ld.so.conf file.\n\t// Most container images based on a distro will have this file, but distroless container images\n\t// may not.\n\tdefaultTopLevelLdsoconfFilePath = \"/etc/ld.so.conf\"\n\t// defaultLdsoconfdDir is the standard location for the ld.so.conf.d drop-in directory. Most\n\t// container images based on a distro will have this directory included by the top-level\n\t// ld.so.conf file, but some may not. And some container images may not have a top-level\n\t// ld.so.conf file at all.\n\tdefaultLdsoconfdDir = \"/etc/ld.so.conf.d\"\n)\n\ntype Ldconfig struct {\n\tldconfigPath string\n\tinRoot string\n\tisDebianLikeHost bool\n\tisDebianLikeContainer bool\n\tnoPivotRoot bool\n\tdirectories []string\n}\n\n// NewRunner creates an exec.Cmd that can be used to run ldconfig.\nfunc NewRunner(id string, ldconfigPath string, containerRoot string, additionalargs ...string) (*exec.Cmd, error) {\n\targs := []string{\n\t\tid,\n\t\t\"--ldconfig-path\", strings.TrimPrefix(config.NormalizeLDConfigPath(\"@\"+ldconfigPath), \"@\"),\n\t\t\"--container-root\", containerRoot,\n\t}\n\tif isDebianLike() {\n\t\targs = append(args, \"--is-debian-like-host\")\n\t}\n\n\tif noPivotRoot() {\n\t\targs = append(args, \"--no-pivot\")\n\t}\n\n\targs = append(args, additionalargs...)\n\n\treturn createReexecCommand(args)\n}\n\n// NewFromArgs creates an Ldconfig struct from the args passed to the Cmd\n// above.\n// This struct is used to perform operations on the ldcache and libraries in a\n// particular root (e.g. a container).\n//\n// args[0] is the reexec initializer function name and is required.\n//\n// The following flags are required:\n//\n//\t--ldconfig-path=LDCONFIG_PATH\tthe path to ldconfig on the host\n//\t--container-root=CONTAINER_ROOT\tthe path in which ldconfig must be run\n//\n// The following flags are optional:\n//\n//\t--is-debian-like-host\tIndicates that the host system is debian-like (e.g. Debian, Ubuntu)\n//\t \tas opposed to non-Debian-like (e.g. RHEL, Fedora)\n//\t \tSee https://github.com/NVIDIA/nvidia-container-toolkit/pull/1444\n//\t--no-pivot \tpivot_root should not be used to provide process isolation.\n//\n// The remaining args are folders where soname symlinks need to be created.\nfunc NewFromArgs(args ...string) (*Ldconfig, error) {\n\tif len(args) < 1 {\n\t\treturn nil, fmt.Errorf(\"incorrect arguments: %v\", args)\n\t}\n\tfs := flag.NewFlagSet(\"ldconfig-options\", flag.ExitOnError)\n\tldconfigPath := fs.String(\"ldconfig-path\", \"\", \"the path to ldconfig on the host\")\n\tcontainerRoot := fs.String(\"container-root\", \"\", \"the path in which ldconfig must be run\")\n\tisDebianLikeHost := fs.Bool(\"is-debian-like-host\", false, `indicates that the host system is debian-based.\nThis allows us to handle the case where there are differences in behavior\nbetween the ldconfig from the host (as executed from an update-ldcache hook) and\nldconfig in the container. Such differences include system search paths.`)\n\tnoPivot := fs.Bool(\"no-pivot\", false, \"don't use pivot_root to perform isolation\")\n\tif err := fs.Parse(args[1:]); err != nil {\n\t\treturn nil, err\n\t}\n\n\tif *ldconfigPath == \"\" {\n\t\treturn nil, fmt.Errorf(\"an ldconfig path must be specified\")\n\t}\n\tif *containerRoot == \"\" || *containerRoot == \"/\" {\n\t\treturn nil, fmt.Errorf(\"ldconfig must be run in the non-system root\")\n\t}\n\n\tl := &Ldconfig{\n\t\tldconfigPath: *ldconfigPath,\n\t\tinRoot: *containerRoot,\n\t\tisDebianLikeHost: *isDebianLikeHost,\n\t\tnoPivotRoot: *noPivot,\n\t\tdirectories: fs.Args(),\n\t}\n\treturn l, nil\n}\n\nfunc (l *Ldconfig) UpdateLDCache() error {\n\tldconfigPath, err := l.prepareRoot()\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// `prepareRoot` pivots to the container root, so can now set the container \"debian-ness\".\n\tl.isDebianLikeContainer = isDebianLike()\n\n\t// Ensure that the top-level config file used specifies includes the\n\t// defaultLdsoconfDir drop-in config folder.\n\tif err := ensureLdsoconfFile(defaultTopLevelLdsoconfFilePath, defaultLdsoconfdDir); err != nil {\n\t\treturn fmt.Errorf(\"failed to ensure ld.so.conf file: %w\", err)\n\t}\n\n\tfilteredDirectories, err := l.filterDirectories(defaultTopLevelLdsoconfFilePath, l.directories...)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\targs := []string{\n\t\tfilepath.Base(ldconfigPath),\n\t\t\"-f\", defaultTopLevelLdsoconfFilePath,\n\t\t\"-C\", \"/etc/ld.so.cache\",\n\t}\n\n\tif err := createLdsoconfdFile(defaultLdsoconfdDir, ldsoconfdFilenamePattern, filteredDirectories...); err != nil {\n\t\treturn fmt.Errorf(\"failed to write %s drop-in: %w\", ldsoconfdFilenamePattern, err)\n\t}\n\n\tsystemSearchPaths := l.getSystemSearchPaths()\n\t// In most cases, the hook will be executing a host ldconfig that may be configured widely\n\t// differently from what the container image expects.\n\t// The common case is Debian-like (e.g. Debian, Ubuntu) vs non-Debian-like (e.g. RHEL, Fedora).\n\t// But there are also hosts that configure ldconfig to search in a glibc prefix\n\t// (e.g. /usr/lib/glibc). To avoid all these cases, write the container's expected system search\n\t// paths to a drop-in conf file that is likely to be last in lexicographic order. Entries in the\n\t// top-level ld.so.conf file may be processed after this drop-in, but this hook does not modify\n\t// the top-level file if it exists.\n\tif err := createLdsoconfdFile(defaultLdsoconfdDir, ldsoconfdSystemDirsFilenamePattern, systemSearchPaths...); err != nil {\n\t\treturn fmt.Errorf(\"failed to write %s drop-in: %w\", ldsoconfdSystemDirsFilenamePattern, err)\n\t}\n\n\t// Also output the folders to the alpine .path file as required.\n\tif err := createMuslPathFileIfRequired(append(filteredDirectories, systemSearchPaths...)...); err != nil {\n\t\treturn fmt.Errorf(\"failed to update .path file for musl: %w\", err)\n\t}\n\n\treturn SafeExec(ldconfigPath, args, nil)\n}\n\nfunc (l *Ldconfig) prepareRoot() (string, error) {\n\troot, err := os.OpenRoot(l.inRoot)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to open root: %w\", err)\n\t}\n\tdefer root.Close()\n\n\t// To prevent leaking the parent proc filesystem, we create a new proc mount\n\t// in the specified root.\n\tif err := mountProc(root); err != nil {\n\t\treturn \"\", fmt.Errorf(\"error mounting /proc: %w\", err)\n\t}\n\n\t// We mount the host ldconfig before we pivot root since host paths are not\n\t// visible after the pivot root operation.\n\tldconfigPath, err := mountLdConfig(l.ldconfigPath, root)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error mounting host ldconfig: %w\", err)\n\t}\n\n\t// We pivot to the container root for the new process, this further limits\n\t// access to the host.\n\tif err := l.pivotRoot(root); err != nil {\n\t\treturn \"\", fmt.Errorf(\"error running pivot_root: %w\", err)\n\t}\n\n\treturn ldconfigPath, nil\n}\n\nfunc (l *Ldconfig) filterDirectories(configFilePath string, directories ...string) ([]string, error) {\n\tldconfigDirs, err := l.getLdsoconfDirectories(configFilePath)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar filtered []string\n\tfor _, d := range directories {\n\t\tif _, ok := ldconfigDirs[d]; ok {\n\t\t\tcontinue\n\t\t}\n\t\tfiltered = append(filtered, d)\n\t\tldconfigDirs[d] = struct{}{}\n\t}\n\treturn filtered, nil\n}\n\n// createLdsoconfdFile creates a ld.so.conf.d drop-in file with the specified directories on each\n// line. The file is created at `ldsoconfdDir`/{{ .pattern }} using `CreateTemp`.\nfunc createLdsoconfdFile(ldsoconfdDir, pattern string, dirs ...string) error {\n\tif len(dirs) == 0 {\n\t\treturn nil\n\t}\n\tif err := os.MkdirAll(ldsoconfdDir, 0755); err != nil {\n\t\treturn fmt.Errorf(\"failed to create ld.so.conf.d: %w\", err)\n\t}\n\tconfigFile, err := os.CreateTemp(ldsoconfdDir, pattern)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create config file: %w\", err)\n\t}\n\tdefer func() {\n\t\t_ = configFile.Close()\n\t}()\n\n\tif err := outputListToFile(configFile, dirs...); err != nil {\n\t\treturn err\n\t}\n\n\t// The created file needs to be world readable for the cases where the container is run as a non-root user.\n\tif err := configFile.Chmod(0644); err != nil {\n\t\treturn fmt.Errorf(\"failed to chmod config file: %w\", err)\n\t}\n\n\treturn nil\n}\n\nfunc outputListToFile(w io.Writer, dirs ...string) error {\n\tadded := make(map[string]bool)\n\tfor _, dir := range dirs {\n\t\tif added[dir] {\n\t\t\tcontinue\n\t\t}\n\t\t_, err := fmt.Fprintf(w, \"%s\\n\", dir)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to update config file: %w\", err)\n\t\t}\n\t\tadded[dir] = true\n\t}\n\treturn nil\n}\n\n// ensureLdsoconfFile creates a \"standard\" top-level ld.so.conf file if none exists.\n//\n// The created file will contain a single include statement for \"`ldsoconfdDir`/*.conf\".\nfunc ensureLdsoconfFile(topLevelLdsoconfFilePath, ldsoconfdDir string) error {\n\tconfigFile, err := os.OpenFile(topLevelLdsoconfFilePath, os.O_RDWR|os.O_CREATE|os.O_EXCL, 0644)\n\tif err != nil {\n\t\tif os.IsExist(err) {\n\t\t\treturn nil\n\t\t}\n\t\treturn fmt.Errorf(\"failed to create top-level ld.so.conf file: %w\", err)\n\t}\n\tdefer configFile.Close()\n\t_, err = configFile.WriteString(\"include \" + ldsoconfdDir + \"/*.conf\\n\")\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to write to top-level ld.so.conf file: %w\", err)\n\t}\n\treturn nil\n}\n\n// getLdsoconfDirectories returns a map of ldsoconf directories to the conf\n// files that refer to the directory.\nfunc (l *Ldconfig) getLdsoconfDirectories(configFilePath string) (map[string]struct{}, error) {\n\tldconfigDirs := make(map[string]struct{})\n\tfor _, d := range l.getSystemSearchPaths() {\n\t\tldconfigDirs[d] = struct{}{}\n\t}\n\n\tprocessedConfFiles := make(map[string]bool)\n\tldsoconfFilenames := []string{configFilePath}\n\tfor len(ldsoconfFilenames) > 0 {\n\t\tldsoconfFilename := ldsoconfFilenames[0]\n\t\tldsoconfFilenames = ldsoconfFilenames[1:]\n\t\tif processedConfFiles[ldsoconfFilename] {\n\t\t\tcontinue\n\t\t}\n\t\tprocessedConfFiles[ldsoconfFilename] = true\n\n\t\tif len(ldsoconfFilename) == 0 {\n\t\t\tcontinue\n\t\t}\n\t\tdirectories, includedFilenames, err := processLdsoconfFile(ldsoconfFilename)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tldsoconfFilenames = append(ldsoconfFilenames, includedFilenames...)\n\t\tfor _, d := range directories {\n\t\t\tldconfigDirs[d] = struct{}{}\n\t\t}\n\t}\n\treturn ldconfigDirs, nil\n}\n\nfunc (l *Ldconfig) getSystemSearchPaths() []string {\n\tif l.isDebianLikeContainer {\n\t\treturn debianSystemSearchPaths()\n\t}\n\treturn nonDebianSystemSearchPaths()\n}\n\n// processLdsoconfFile extracts the list of directories and included configs\n// from the specified file.\nfunc processLdsoconfFile(ldsoconfFilename string) ([]string, []string, error) {\n\tldsoconf, err := os.Open(ldsoconfFilename)\n\tif os.IsNotExist(err) {\n\t\treturn nil, nil, nil\n\t}\n\tif err != nil {\n\t\treturn nil, nil, err\n\t}\n\tdefer ldsoconf.Close()\n\n\tvar directories []string\n\tvar includedFilenames []string\n\tscanner := bufio.NewScanner(ldsoconf)\n\tfor scanner.Scan() {\n\t\tline := strings.TrimSpace(scanner.Text())\n\t\tswitch {\n\t\tcase strings.HasPrefix(line, \"#\") || len(line) == 0:\n\t\t\tcontinue\n\t\tcase strings.HasPrefix(line, \"include \"):\n\t\t\tinclude, err := filepath.Glob(strings.TrimPrefix(line, \"include \"))\n\t\t\tif err != nil {\n\t\t\t\t// We ignore invalid includes.\n\t\t\t\t// TODO: How does ldconfig handle this?\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tincludedFilenames = append(includedFilenames, include...)\n\t\tdefault:\n\t\t\tdirectories = append(directories, line)\n\t\t}\n\t}\n\treturn directories, includedFilenames, nil\n}\n\n// createMuslPathFileIfRequired creates a musl .path file that allows libraries\n// from the specified directories to be discovered on the system.\n// This is required because systems that use musl do not rely on the ldcache to\n// discover libraries.\nfunc createMuslPathFileIfRequired(dirs ...string) error {\n\tif len(dirs) == 0 || !isMusl() {\n\t\treturn nil\n\t}\n\n\tvar pathFileName string\n\tswitch runtime.GOARCH {\n\tcase \"amd64\":\n\t\tpathFileName = \"/etc/ld-musl-x86_64.path\"\n\tcase \"arm64\":\n\t\tpathFileName = \"/etc/ld-musl-aarch64.path\"\n\t}\n\n\tpathFile, err := os.OpenFile(pathFileName, os.O_CREATE|os.O_APPEND|os.O_RDWR, 0644)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"could not open .path file: %w\", err)\n\t}\n\tdefer func() {\n\t\t_ = pathFile.Close()\n\t}()\n\n\treturn outputListToFile(pathFile, dirs...)\n}\n\n// isMusl checks whether the container is running musl instead of glibc.\n// Note that for the time being we only check whether `/etc/alpine-release` is\n// present in the container.\nfunc isMusl() bool {\n\tinfo, err := os.Stat(\"/etc/alpine-release\")\n\tif err != nil {\n\t\treturn false\n\t}\n\treturn !info.IsDir()\n}\n\n// isDebianLike returns true if a Debian-like distribution is detected.\n// Debian-like distributions include Debian and Ubuntu, whereas non-Debian-like\n// distributions include RHEL and Fedora.\nfunc isDebianLike() bool {\n\tinfo, err := os.Stat(\"/etc/debian_version\")\n\tif err != nil {\n\t\treturn false\n\t}\n\treturn !info.IsDir()\n}\n\n// nonDebianSystemSearchPaths returns the system search paths for non-Debian-like systems.\n// (note that Debian-like systems include Ubuntu systems)\n//\n// glibc ldconfig's calls `add_system_dir` with `SLIBDIR` and `LIBDIR` (if they are not equal). On\n// aarch64 and x86_64, `add_system_dir` is a macro that scans the provided path. If the path ends\n// with \"/lib64\" (or \"/libx32\", x86_64 only), it strips those suffixes. Then it registers the\n// resulting path. Then if the path ends with \"/lib\", it registers \"path\"+\"64\" (and \"path\"+\"x32\",\n// x86_64 only).\n//\n// By default, \"LIBDIR\" is \"/usr/lib\" and \"SLIBDIR\" is \"/lib\". Note that on modern distributions,\n// \"/lib\" is usually a symlink to \"/usr/lib\" and \"/lib64\" to \"/usr/lib64\". ldconfig resolves\n// symlinks and skips duplicate directory entries.\n//\n// To get the list of system paths, you can invoke the dynamic linker with `--list-diagnostics` and\n// look for \"path.system_dirs\". For example\n//\n// $ docker run --rm -ti fedora bash -c \"uname -m;\\$(find . | grep /ld-linux) --list-diagnostics | grep path.system_dirs\"\n// x86_64\n// path.system_dirs[0x0]=\"/lib64/\"\n// path.system_dirs[0x1]=\"/usr/lib64/\"\n//\n// $ docker run --rm -ti redhat/ubi9 bash -c \"uname -m;\\$(find . | grep /ld-linux) --list-diagnostics | grep path.system_dirs\"\n// x86_64\n// path.system_dirs[0x0]=\"/lib64/\"\n// path.system_dirs[0x1]=\"/usr/lib64/\"\n//\n// On most distributions, including Fedora and derivatives, this yields the following\n// ldconfig system search paths.\n//\n// TODO: Add other architectures that have custom `add_system_dir` macros (e.g. riscv)\n// TODO: Replace with executing the container's dynamlic linker with `--list-diagnostics`?\nfunc nonDebianSystemSearchPaths() []string {\n\tvar paths []string\n\tpaths = append(paths, \"/lib\", \"/usr/lib\")\n\tswitch runtime.GOARCH {\n\tcase \"amd64\":\n\t\tpaths = append(paths,\n\t\t\t\"/lib64\",\n\t\t\t\"/usr/lib64\",\n\t\t\t\"/libx32\",\n\t\t\t\"/usr/libx32\",\n\t\t)\n\tcase \"arm64\":\n\t\tpaths = append(paths,\n\t\t\t\"/lib64\",\n\t\t\t\"/usr/lib64\",\n\t\t)\n\t}\n\treturn paths\n}\n\n// debianSystemSearchPaths returns the system search paths for Debian-like systems.\n// (note that Debian-like systems include Ubuntu systems)\n//\n// Debian (and derivatives) apply their multi-arch patch to glibc, which modifies ldconfig to\n// use the same set of system paths as the dynamic linker. These paths are going to include the\n// multi-arch directory _and_ by default \"/lib\" and \"/usr/lib\" for compatibility.\n//\n// To get the list of system paths, you can invoke the dynamic linker with `--list-diagnostics` and\n// look for \"path.system_dirs\". For example\n//\n// $ docker run --rm -ti ubuntu bash -c \"uname -m;\\$(find . | grep /ld-linux | head -1) --list-diagnostics | grep path.system_dirs\"\n// x86_64\n// path.system_dirs[0x0]=\"/lib/x86_64-linux-gnu/\"\n// path.system_dirs[0x1]=\"/usr/lib/x86_64-linux-gnu/\"\n// path.system_dirs[0x2]=\"/lib/\"\n// path.system_dirs[0x3]=\"/usr/lib/\"\n//\n// $ docker run --rm -ti debian bash -c \"uname -m;\\$(find . | grep /ld-linux | head -1) --list-diagnostics | grep path.system_dirs\"\n// x86_64\n// path.system_dirs[0x0]=\"/lib/x86_64-linux-gnu/\"\n// path.system_dirs[0x1]=\"/usr/lib/x86_64-linux-gnu/\"\n// path.system_dirs[0x2]=\"/lib/\"\n// path.system_dirs[0x3]=\"/usr/lib/\"\n//\n// This yields the following ldconfig system search paths.\n//\n// TODO: Add other architectures that have custom `add_system_dir` macros (e.g. riscv)\n// TODO: Replace with executing the container's dynamlic linker with `--list-diagnostics`?\nfunc debianSystemSearchPaths() []string {\n\tvar paths []string\n\tswitch runtime.GOARCH {\n\tcase \"amd64\":\n\t\tpaths = append(paths,\n\t\t\t\"/lib/x86_64-linux-gnu\",\n\t\t\t\"/usr/lib/x86_64-linux-gnu\",\n\t\t)\n\tcase \"arm64\":\n\t\tpaths = append(paths,\n\t\t\t\"/lib/aarch64-linux-gnu\",\n\t\t\t\"/usr/lib/aarch64-linux-gnu\",\n\t\t)\n\t}\n\tpaths = append(paths, \"/lib\", \"/usr/lib\")\n\treturn paths\n}\n\nfunc (l *Ldconfig) pivotRoot(root *os.Root) error {\n\trootDir := root.Name()\n\t// We select the function to pivot the root based on whether pivot_root is\n\t// supported.\n\t// See https://github.com/opencontainers/runc/blob/c3d127f6e8d9f6c06d78b8329cafa8dd39f6236e/libcontainer/rootfs_linux.go#L207-L216\n\tif l.noPivotRoot {\n\t\treturn msMoveRoot(rootDir)\n\t}\n\treturn pivotRoot(rootDir)\n}\n\n// noPivotRoot checks whether the current root filesystem supports a pivot_root.\n// See https://github.com/opencontainers/runc/blob/main/libcontainer/SPEC.md#filesystem\n// for a discussion on when this is not the case.\n// If we fail to detect whether pivot-root is supported, we assume that it is supported.\n// The logic to check for support is adapted from kata-containers:\n//\n//\thttps://github.com/kata-containers/kata-containers/blob/e7b9eddcede4bbe2edeb9c3af7b2358dc65da76f/src/agent/src/sandbox.rs#L150\n//\n// and checks whether \"/\" is mounted as a rootfs.\nfunc noPivotRoot() bool {\n\trootFsType, err := getRootfsType(\"/\")\n\tif err != nil {\n\t\treturn false\n\t}\n\treturn rootFsType == \"rootfs\"\n}\n\nfunc getRootfsType(path string) (string, error) {\n\tprocSelf, err := procfs.Self()\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tmountStats, err := procSelf.MountStats()\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tfor _, mountStat := range mountStats {\n\t\tif mountStat.Mount == path {\n\t\t\treturn mountStat.Type, nil\n\t\t}\n\t}\n\treturn \"\", fmt.Errorf(\"mount stats for %q not found\", path)\n}\n"
},
{
"path": "internal/ldconfig/ldconfig_linux.go",
"content": "//go:build linux\n\n/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ldconfig\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n\t\"syscall\"\n\n\t\"github.com/google/uuid\"\n\t\"github.com/moby/sys/mountinfo\"\n\t\"github.com/moby/sys/reexec\"\n\n\t\"github.com/opencontainers/runc/libcontainer/utils\"\n\t\"golang.org/x/sys/unix\"\n)\n\n// pivotRoot will call pivot_root such that rootfs becomes the new root\n// filesystem, and everything else is cleaned up.\n// This is adapted from the implementation here:\n//\n//\thttps://github.com/opencontainers/runc/blob/e89a29929c775025419ab0d218a43588b4c12b9a/libcontainer/rootfs_linux.go#L1056-L1113\n//\n// With the `mount` and `unmount` calls changed to direct unix.Mount and unix.Unmount calls.\nfunc pivotRoot(rootfs string) error {\n\t// While the documentation may claim otherwise, pivot_root(\".\", \".\") is\n\t// actually valid. What this results in is / being the new root but\n\t// /proc/self/cwd being the old root. Since we can play around with the cwd\n\t// with pivot_root this allows us to pivot without creating directories in\n\t// the rootfs. Shout-outs to the LXC developers for giving us this idea.\n\n\toldroot, err := unix.Open(\"/\", unix.O_DIRECTORY|unix.O_RDONLY, 0)\n\tif err != nil {\n\t\treturn &os.PathError{Op: \"open\", Path: \"/\", Err: err}\n\t}\n\tdefer unix.Close(oldroot) //nolint: errcheck\n\n\tnewroot, err := unix.Open(rootfs, unix.O_DIRECTORY|unix.O_RDONLY, 0)\n\tif err != nil {\n\t\treturn &os.PathError{Op: \"open\", Path: rootfs, Err: err}\n\t}\n\tdefer unix.Close(newroot) //nolint: errcheck\n\n\t// Change to the new root so that the pivot_root actually acts on it.\n\tif err := unix.Fchdir(newroot); err != nil {\n\t\treturn &os.PathError{Op: \"fchdir\", Path: \"fd \" + strconv.Itoa(newroot), Err: err}\n\t}\n\n\tif err := unix.PivotRoot(\".\", \".\"); err != nil {\n\t\treturn &os.PathError{Op: \"pivot_root\", Path: \".\", Err: err}\n\t}\n\n\t// Currently our \".\" is oldroot (according to the current kernel code).\n\t// However, purely for safety, we will fchdir(oldroot) since there isn't\n\t// really any guarantee from the kernel what /proc/self/cwd will be after a\n\t// pivot_root(2).\n\n\tif err := unix.Fchdir(oldroot); err != nil {\n\t\treturn &os.PathError{Op: \"fchdir\", Path: \"fd \" + strconv.Itoa(oldroot), Err: err}\n\t}\n\n\t// Make oldroot rslave to make sure our unmounts don't propagate to the\n\t// host (and thus bork the machine). We don't use rprivate because this is\n\t// known to cause issues due to races where we still have a reference to a\n\t// mount while a process in the host namespace are trying to operate on\n\t// something they think has no mounts (devicemapper in particular).\n\tif err := unix.Mount(\"\", \".\", \"\", unix.MS_SLAVE|unix.MS_REC, \"\"); err != nil {\n\t\treturn err\n\t}\n\t// Perform the unmount. MNT_DETACH allows us to unmount /proc/self/cwd.\n\tif err := unix.Unmount(\".\", unix.MNT_DETACH); err != nil {\n\t\treturn err\n\t}\n\n\t// Switch back to our shiny new root.\n\tif err := unix.Chdir(\"/\"); err != nil {\n\t\treturn &os.PathError{Op: \"chdir\", Path: \"/\", Err: err}\n\t}\n\treturn nil\n}\n\n// msMoveRoot is used in cases where pivot root is not supported.\n// This includes initramfs filesystems where the root is read-only.\n// This is adapted from the implementation here:\n//\n//\thttps://github.com/opencontainers/runc/blob/e89a29929c775025419ab0d218a43588b4c12b9a/libcontainer/rootfs_linux.go#L1115\n//\n// With the `mount` and `unmount` calls changed to direct unix.Mount and unix.Unmount calls.\nfunc msMoveRoot(rootfs string) error {\n\t// Before we move the root and chroot we have to mask all \"full\" sysfs and\n\t// procfs mounts which exist on the host. This is because while the kernel\n\t// has protections against mounting procfs if it has masks, when using\n\t// chroot(2) the *host* procfs mount is still reachable in the mount\n\t// namespace and the kernel permits procfs mounts inside --no-pivot\n\t// containers.\n\t//\n\t// Users shouldn't be using --no-pivot except in exceptional circumstances,\n\t// but to avoid such a trivial security flaw we apply a best-effort\n\t// protection here. The kernel only allows a mount of a pseudo-filesystem\n\t// like procfs or sysfs if there is a *full* mount (the root of the\n\t// filesystem is mounted) without any other locked mount points covering a\n\t// subtree of the mount.\n\t//\n\t// So we try to unmount (or mount tmpfs on top of) any mountpoint which is\n\t// a full mount of either sysfs or procfs (since those are the most\n\t// concerning filesystems to us).\n\tmountinfos, err := mountinfo.GetMounts(func(info *mountinfo.Info) (skip, stop bool) {\n\t\t// Collect every sysfs and procfs filesystem, except for those which\n\t\t// are non-full mounts or are inside the rootfs of the container.\n\t\tif info.Root != \"/\" ||\n\t\t\t(info.FSType != \"proc\" && info.FSType != \"sysfs\") ||\n\t\t\tstrings.HasPrefix(info.Mountpoint, rootfs) {\n\t\t\tskip = true\n\t\t}\n\t\treturn\n\t})\n\tif err != nil {\n\t\treturn err\n\t}\n\tfor _, info := range mountinfos {\n\t\tp := info.Mountpoint\n\t\t// Be sure umount events are not propagated to the host.\n\t\tif err := unix.Mount(\"\", p, \"\", unix.MS_SLAVE|unix.MS_REC, \"\"); err != nil {\n\t\t\tif errors.Is(err, unix.ENOENT) {\n\t\t\t\t// If the mountpoint doesn't exist that means that we've\n\t\t\t\t// already blasted away some parent directory of the mountpoint\n\t\t\t\t// and so we don't care about this error.\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\treturn err\n\t\t}\n\t\tif err := unix.Unmount(p, unix.MNT_DETACH); err != nil {\n\t\t\tif !errors.Is(err, unix.EINVAL) && !errors.Is(err, unix.EPERM) {\n\t\t\t\treturn err\n\t\t\t} else {\n\t\t\t\t// If we have not privileges for umounting (e.g. rootless), then\n\t\t\t\t// cover the path.\n\t\t\t\tif err := unix.Mount(\"tmpfs\", p, \"tmpfs\", 0, \"\"); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Move the rootfs on top of \"/\" in our mount namespace.\n\tif err := unix.Mount(rootfs, \"/\", \"\", unix.MS_MOVE, \"\"); err != nil {\n\t\treturn err\n\t}\n\treturn chroot()\n}\n\nfunc chroot() error {\n\tif err := unix.Chroot(\".\"); err != nil {\n\t\treturn &os.PathError{Op: \"chroot\", Path: \".\", Err: err}\n\t}\n\tif err := unix.Chdir(\"/\"); err != nil {\n\t\treturn &os.PathError{Op: \"chdir\", Path: \"/\", Err: err}\n\t}\n\treturn nil\n}\n\n// mountLdConfig mounts the host ldconfig to the mount namespace of the hook.\n// We use WithProcfd to perform the mount operations to ensure that the changes\n// are persisted across the pivot root.\nfunc mountLdConfig(hostLdconfigPath string, containerRoot *os.Root) (string, error) {\n\tcontainerRootDirPath := containerRoot.Name()\n\n\thostLdconfigInfo, err := os.Stat(hostLdconfigPath)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error reading host ldconfig: %w\", err)\n\t}\n\n\thookScratchDirPath := \"/run/nvidia-ctk-hook/\" + uuid.NewString()\n\tldconfigPath := filepath.Join(hookScratchDirPath, \"ldconfig\")\n\tif err := containerRoot.MkdirAll(hookScratchDirPath[1:], 0755); err != nil {\n\t\treturn \"\", fmt.Errorf(\"error creating hook scratch folder: %w\", err)\n\t}\n\n\t//nolint:staticcheck // TODO (ArangoGutierrez): Remove the nolint:staticcheck and properly fix the deprecation warning.\n\terr = utils.WithProcfd(containerRootDirPath, hookScratchDirPath, func(hookScratchDirFdPath string) error {\n\t\treturn createTmpFs(hookScratchDirFdPath, int(hostLdconfigInfo.Size()))\n\t})\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error creating tmpfs: %w\", err)\n\t}\n\n\tif _, err := containerRoot.OpenFile(ldconfigPath[1:], os.O_CREATE|os.O_RDWR|os.O_TRUNC, hostLdconfigInfo.Mode()); err != nil {\n\t\treturn \"\", fmt.Errorf(\"error creating ldconfig: %w\", err)\n\t}\n\n\t//nolint:staticcheck // TODO (ArangoGutierrez): Remove the nolint:staticcheck and properly fix the deprecation warning.\n\terr = utils.WithProcfd(containerRootDirPath, ldconfigPath, func(ldconfigFdPath string) error {\n\t\treturn unix.Mount(hostLdconfigPath, ldconfigFdPath, \"\", unix.MS_BIND|unix.MS_RDONLY|unix.MS_NODEV|unix.MS_PRIVATE|unix.MS_NOSYMFOLLOW, \"\")\n\t})\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error bind mounting host ldconfig: %w\", err)\n\t}\n\n\treturn ldconfigPath, nil\n}\n\n// mountProc mounts a clean proc filesystem in the new root.\nfunc mountProc(newroot *os.Root) error {\n\tif err := newroot.MkdirAll(\"proc\", 0755); err != nil {\n\t\treturn err\n\t}\n\n\ttarget := filepath.Join(newroot.Name(), \"proc\")\n\treturn unix.Mount(\"proc\", target, \"proc\", 0, \"\")\n}\n\n// createTmpFs creates a tmpfs at the specified location with the specified size.\nfunc createTmpFs(target string, size int) error {\n\treturn unix.Mount(\"tmpfs\", target, \"tmpfs\", 0, fmt.Sprintf(\"size=%d\", size))\n}\n\n// createReexecCommand creates a command that can be used to trigger the reexec\n// initializer.\n// On linux this command runs in new namespaces.\nfunc createReexecCommand(args []string) (*exec.Cmd, error) {\n\tcmd := reexec.Command(args...)\n\tcmd.Stdin = os.Stdin\n\tcmd.Stdout = os.Stdout\n\tcmd.Stderr = os.Stderr\n\n\tcmd.SysProcAttr = &syscall.SysProcAttr{\n\t\tCloneflags: syscall.CLONE_NEWNS |\n\t\t\tsyscall.CLONE_NEWUTS |\n\t\t\tsyscall.CLONE_NEWIPC |\n\t\t\tsyscall.CLONE_NEWPID |\n\t\t\tsyscall.CLONE_NEWNET,\n\t}\n\n\treturn cmd, nil\n}\n"
},
{
"path": "internal/ldconfig/ldconfig_other.go",
"content": "//go:build !linux\n\n/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ldconfig\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"os/exec\"\n)\n\nfunc pivotRoot(newroot string) error {\n\treturn fmt.Errorf(\"not supported\")\n}\n\nfunc msMoveRoot(rootfs string) error {\n\treturn fmt.Errorf(\"not supported\")\n}\n\nfunc mountLdConfig(hostLdconfigPath string, containerRoot *os.Root) (string, error) {\n\treturn \"\", fmt.Errorf(\"not supported\")\n}\n\nfunc mountProc(newroot *os.Root) error {\n\treturn fmt.Errorf(\"not supported\")\n}\n\nfunc createReexecCommand(args []string) (*exec.Cmd, error) {\n\treturn nil, fmt.Errorf(\"not supported\")\n}\n"
},
{
"path": "internal/ldconfig/ldconfig_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ldconfig\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestFilterDirectories(t *testing.T) {\n\tconst topLevelConf = \"TOPLEVEL.conf\"\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconfs map[string]string // map[filename]content, must have topLevelConf key\n\t\tinput []string\n\t\texpected []string\n\t}{\n\t\t{\n\t\t\tdescription: \"all filtered\",\n\t\t\tconfs: map[string]string{\n\t\t\t\ttopLevelConf: `\n# some comment\n/tmp/libdir1\n/tmp/libdir2\n`,\n\t\t\t},\n\t\t\tinput: []string{\"/tmp/libdir1\", \"/tmp/libdir2\"},\n\t\t\texpected: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"partially filtered\",\n\t\t\tconfs: map[string]string{\n\t\t\t\ttopLevelConf: `\n/tmp/libdir1\n`,\n\t\t\t},\n\t\t\tinput: []string{\"/tmp/libdir1\", \"/tmp/libdir2\"},\n\t\t\texpected: []string{\"/tmp/libdir2\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"none filtered\",\n\t\t\tconfs: map[string]string{\n\t\t\t\ttopLevelConf: `\n# empty config\n`,\n\t\t\t},\n\t\t\tinput: []string{\"/tmp/libdir1\", \"/tmp/libdir2\"},\n\t\t\texpected: []string{\"/tmp/libdir1\", \"/tmp/libdir2\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"filter with include and comments\",\n\t\t\tconfs: map[string]string{\n\t\t\t\ttopLevelConf: `\n# comment\n/tmp/libdir1\ninclude /nonexistent/pattern*\n`,\n\t\t\t},\n\t\t\tinput: []string{\"/tmp/libdir1\", \"/tmp/libdir2\"},\n\t\t\texpected: []string{\"/tmp/libdir2\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"include directive picks up more dirs to filter\",\n\t\t\tconfs: map[string]string{\n\t\t\t\ttopLevelConf: `\n# top-level\ninclude INCLUDED_PATTERN*\n/tmp/libdir3\n`,\n\t\t\t\t\"INCLUDED_PATTERN0.conf\": `\n/tmp/libdir2\n# another comment\n/tmp/libdir4\n`,\n\t\t\t\t\"INCLUDED_PATTERN1.conf\": `\n/tmp/libdir1\n`,\n\t\t\t},\n\t\t\tinput: []string{\"/tmp/libdir1\", \"/tmp/libdir2\", \"/tmp/libdir3\", \"/tmp/libdir4\", \"/tmp/libdir5\"},\n\t\t\texpected: []string{\"/tmp/libdir5\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttmpDir := t.TempDir()\n\n\t\t\t// Prepare file contents, adjusting include globs to be absolute and unique within tmpDir\n\t\t\tfor name, content := range tc.confs {\n\t\t\t\tif name == topLevelConf && len(tc.confs) > 1 {\n\t\t\t\t\tcontent = strings.ReplaceAll(content, \"include INCLUDED_PATTERN*\", \"include \"+tmpDir+\"/INCLUDED_PATTERN*\")\n\t\t\t\t}\n\t\t\t\terr := os.WriteFile(tmpDir+\"/\"+name, []byte(content), 0600)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\ttopLevelConfPath := tmpDir + \"/\" + topLevelConf\n\t\t\tl := &Ldconfig{\n\t\t\t\tisDebianLikeContainer: true,\n\t\t\t}\n\t\t\tfiltered, err := l.filterDirectories(topLevelConfPath, tc.input...)\n\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, tc.expected, filtered)\n\t\t})\n\t}\n}\n\nfunc TestCreateLdsoconfdFile(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tpattern string\n\t\tdirs []string\n\t\texpectedContent []string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty directories\",\n\t\t\tpattern: \"test-*.conf\",\n\t\t\tdirs: []string{},\n\t\t\texpectedContent: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"single directory\",\n\t\t\tpattern: \"test-*.conf\",\n\t\t\tdirs: []string{\"/usr/local/lib\"},\n\t\t\texpectedContent: []string{\n\t\t\t\t\"/usr/local/lib\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple directories\",\n\t\t\tpattern: \"test-*.conf\",\n\t\t\tdirs: []string{\"/usr/local/lib\", \"/opt/lib\", \"/usr/lib64\"},\n\t\t\texpectedContent: []string{\n\t\t\t\t\"/usr/local/lib\",\n\t\t\t\t\"/opt/lib\",\n\t\t\t\t\"/usr/lib64\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicate directories\",\n\t\t\tpattern: \"test-*.conf\",\n\t\t\tdirs: []string{\"/usr/local/lib\", \"/opt/lib\", \"/usr/local/lib\"},\n\t\t\texpectedContent: []string{\n\t\t\t\t\"/usr/local/lib\",\n\t\t\t\t\"/opt/lib\",\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttmpDir := t.TempDir()\n\n\t\t\terr := createLdsoconfdFile(tmpDir, tc.pattern, tc.dirs...)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tif len(tc.expectedContent) == 0 {\n\t\t\t\tentries, err := os.ReadDir(tmpDir)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t\trequire.Empty(t, entries)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\tentries, err := os.ReadDir(tmpDir)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Len(t, entries, 1)\n\t\t\tcreatedFile := filepath.Join(tmpDir, entries[0].Name())\n\n\t\t\tinfo, err := os.Stat(createdFile)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, os.FileMode(0644), info.Mode().Perm())\n\n\t\t\tcontent, err := os.ReadFile(createdFile)\n\t\t\trequire.NoError(t, err)\n\t\t\tlines := strings.Split(strings.TrimSpace(string(content)), \"\\n\")\n\t\t\trequire.Equal(t, tc.expectedContent, lines)\n\t\t})\n\t}\n}\n\nfunc TestEnsureLdsoconfFile(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\texistingContent string\n\t\tldsoconfdDir string\n\t\texpectCreation bool\n\t\texpectedContent string\n\t}{\n\t\t{\n\t\t\tdescription: \"creates file when none exists\",\n\t\t\texistingContent: \"\",\n\t\t\tldsoconfdDir: \"/custom/ld.so.conf.d\",\n\t\t\texpectCreation: true,\n\t\t\texpectedContent: \"include /custom/ld.so.conf.d/*.conf\\n\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"does not modify existing file\",\n\t\t\texistingContent: \"# custom config\\n/usr/local/lib\\n\",\n\t\t\tldsoconfdDir: \"/etc/ld.so.conf.d\",\n\t\t\texpectCreation: false,\n\t\t\texpectedContent: \"# custom config\\n/usr/local/lib\\n\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttmpDir := t.TempDir()\n\t\t\tconfFilePath := filepath.Join(tmpDir, \"ld.so.conf\")\n\n\t\t\tif tc.existingContent != \"\" {\n\t\t\t\terr := os.WriteFile(confFilePath, []byte(tc.existingContent), 0644) //nolint:gosec\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\terr := ensureLdsoconfFile(confFilePath, tc.ldsoconfdDir)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tinfo, err := os.Stat(confFilePath)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, os.FileMode(0644), info.Mode().Perm())\n\n\t\t\tcontent, err := os.ReadFile(confFilePath)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, tc.expectedContent, string(content))\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/ldconfig/safe-exec_linux.go",
"content": "//go:build linux\n\n/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ldconfig\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"strconv\"\n\t\"syscall\"\n\n\t\"github.com/opencontainers/runc/libcontainer/exeseal\"\n)\n\n// SafeExec attempts to clone the specified binary (as an memfd, for example) before executing it.\nfunc SafeExec(path string, args []string, envv []string) error {\n\tsafeExe, err := cloneBinary(path)\n\tif err != nil {\n\t\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\t\treturn syscall.Exec(path, args, envv)\n\t}\n\tdefer safeExe.Close()\n\n\texePath := \"/proc/self/fd/\" + strconv.Itoa(int(safeExe.Fd()))\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\treturn syscall.Exec(exePath, args, envv)\n}\n\nfunc cloneBinary(path string) (*os.File, error) {\n\texe, err := os.Open(path)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"opening current binary: %w\", err)\n\t}\n\tdefer exe.Close()\n\n\tstat, err := exe.Stat()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"checking %v size: %w\", path, err)\n\t}\n\tsize := stat.Size()\n\n\treturn exeseal.CloneBinary(exe, size, path, os.TempDir())\n}\n"
},
{
"path": "internal/ldconfig/safe-exec_other.go",
"content": "//go:build !linux\n\n/**\n# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ldconfig\n\nimport \"syscall\"\n\n// SafeExec is not implemented on non-linux systems and forwards directly to the\n// Exec syscall.\nfunc SafeExec(path string, args []string, envv []string) error {\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\treturn syscall.Exec(path, args, envv)\n}\n"
},
{
"path": "internal/logger/api.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage logger\n\n// Interface defines the API for the logger package\ntype Interface interface {\n\tDebugf(string, ...interface{})\n\tErrorf(string, ...interface{})\n\tInfof(string, ...interface{})\n\tWarningf(string, ...interface{})\n\tTracef(string, ...interface{})\n}\n"
},
{
"path": "internal/logger/lib.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage logger\n\nimport \"github.com/sirupsen/logrus\"\n\n// New returns a new logger\nfunc New() Interface {\n\treturn logrus.StandardLogger()\n}\n\n// NullLogger is a logger that does nothing\ntype NullLogger struct{}\n\nvar _ Interface = (*NullLogger)(nil)\n\n// Debugf is a no-op for the null logger\nfunc (l *NullLogger) Debugf(string, ...interface{}) {}\n\n// Errorf is a no-op for the null logger\nfunc (l *NullLogger) Errorf(string, ...interface{}) {}\n\n// Infof is a no-op for the null logger\nfunc (l *NullLogger) Infof(string, ...interface{}) {}\n\n// Warningf is a no-op for the null logger\nfunc (l *NullLogger) Warningf(string, ...interface{}) {}\n\n// Tracef is a no-op for the null logger\nfunc (l *NullLogger) Tracef(string, ...interface{}) {}\n"
},
{
"path": "internal/lookup/root/cuda_test.go",
"content": "/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nfunc TestLocate(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tlibcudaPath string\n\t\texpected string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"no libcuda does not resolve library\",\n\t\t\tlibcudaPath: \"\",\n\t\t\texpected: \"\",\n\t\t\texpectedError: lookup.ErrNotFound,\n\t\t},\n\t\t{\n\t\t\tdescription: \"no-ldcache searches /usr/lib64\",\n\t\t\tlibcudaPath: \"/usr/lib64/libcuda.so.123.34\",\n\t\t\texpected: \"/usr/lib64\",\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"no-ldcache searches /usr/lib64 for libnvidia-ml.so.\",\n\t\t\tlibcudaPath: \"/usr/lib64/libnvidia-ml.so.123.34\",\n\t\t\texpected: \"/usr/lib64\",\n\t\t\texpectedError: nil,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdriverRoot, err := setupDriverRoot(t, tc.libcudaPath)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tl := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithDriverRoot(driverRoot),\n\t\t\t)\n\n\t\t\tdriverLibraryPath, err := l.GetDriverLibDirectory()\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\n\t\t\t// NOTE: We need to strip `/private` on MacOs due to symlink resolution\n\t\t\tstripped := strings.TrimPrefix(driverLibraryPath, \"/private\")\n\n\t\t\trequire.Equal(t, tc.expected, stripped)\n\t\t})\n\t}\n}\n\n// setupDriverRoot creates a folder that can be used to represent a driver root.\n// The path to libcuda can be specified and an empty file is created at this location in the driver root.\nfunc setupDriverRoot(t *testing.T, libCudaPath string) (string, error) {\n\tdriverRoot := t.TempDir()\n\n\tif libCudaPath == \"\" {\n\t\treturn driverRoot, nil\n\t}\n\n\tif err := os.MkdirAll(filepath.Join(driverRoot, filepath.Dir(libCudaPath)), 0755); err != nil {\n\t\treturn \"\", fmt.Errorf(\"falied to create required driver root folder: %w\", err)\n\t}\n\n\tlibCuda, err := os.Create(filepath.Join(driverRoot, libCudaPath))\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to create dummy libcuda.so: %w\", err)\n\t}\n\tdefer libCuda.Close()\n\n\treturn filepath.EvalSymlinks(driverRoot)\n}\n"
},
{
"path": "internal/lookup/root/options.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport \"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\ntype options struct {\n\tlogger logger.Interface\n\t// Root represents the root from the perspective of the driver libraries and binaries.\n\tRoot string\n\t// DevRoot represents the root for device nodes for the driver.\n\tDevRoot string\n\t// librarySearchPaths specifies explicit search paths for discovering libraries.\n\tlibrarySearchPaths []string\n\t// configSearchPaths specified explicit search paths for discovering driver config files.\n\tconfigSearchPaths []string\n\tversioner Versioner\n}\n\ntype Option func(*options)\n\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(o *options) {\n\t\to.logger = logger\n\t}\n}\n\nfunc WithDevRoot(devRoot string) Option {\n\treturn func(o *options) {\n\t\to.DevRoot = devRoot\n\t}\n}\n\nfunc WithDriverRoot(root string) Option {\n\treturn func(o *options) {\n\t\to.Root = root\n\t}\n}\n\nfunc WithLibrarySearchPaths(paths ...string) Option {\n\treturn func(o *options) {\n\t\to.librarySearchPaths = paths\n\t}\n}\n\nfunc WithConfigSearchPaths(paths ...string) Option {\n\treturn func(o *options) {\n\t\to.configSearchPaths = paths\n\t}\n}\n\nfunc WithVersioner(versioner Versioner) Option {\n\treturn func(o *options) {\n\t\to.versioner = versioner\n\t}\n}\n"
},
{
"path": "internal/lookup/root/root.go",
"content": "/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"sync\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// Driver represents a filesystem in which a set of drivers or devices is defined.\ntype Driver struct {\n\tsync.Mutex\n\tlogger logger.Interface\n\t// Root represents the root from the perspective of the driver libraries and binaries.\n\tRoot string\n\t// DevRoot represents the root for device nodes for the driver.\n\tDevRoot string\n\t// librarySearchPaths specifies explicit search paths for discovering libraries.\n\tlibrarySearchPaths []string\n\t// configSearchPaths specified explicit search paths for discovering driver config files.\n\tconfigSearchPaths []string\n\n\t// version caches the driver version.\n\tversion string\n\t// driverLibDirectory caches the path to parent of the driver libraries\n\tdriverLibDirectory string\n}\n\n// New creates a new Driver root using the specified options.\nfunc New(opts ...Option) *Driver {\n\to := &options{}\n\tfor _, opt := range opts {\n\t\topt(o)\n\t}\n\tif o.logger == nil {\n\t\to.logger = logger.New()\n\t}\n\tif o.DevRoot == \"\" {\n\t\to.DevRoot = o.Root\n\t}\n\n\tvar driverVersion string\n\tif o.versioner != nil {\n\t\tversion, err := o.versioner.Version()\n\t\tif err != nil {\n\t\t\to.logger.Warningf(\"Could not determine driver version: %v\", err)\n\t\t}\n\t\tdriverVersion = version\n\t}\n\n\td := &Driver{\n\t\tlogger: o.logger,\n\t\tRoot: o.Root,\n\t\tDevRoot: o.DevRoot,\n\t\tlibrarySearchPaths: o.librarySearchPaths,\n\t\tconfigSearchPaths: o.configSearchPaths,\n\t\tversion: driverVersion,\n\t\tdriverLibDirectory: \"\",\n\t}\n\n\treturn d\n}\n\n// Version returns the cached driver version if possible.\n// If this has not yet been initialised, the version is first updated and then returned.\nfunc (r *Driver) Version() (string, error) {\n\tr.Lock()\n\tdefer r.Unlock()\n\n\tif r.version == \"\" {\n\t\tif err := r.updateInfo(); err != nil {\n\t\t\treturn \"\", err\n\t\t}\n\t}\n\n\treturn r.version, nil\n}\n\n// GetDriverLibDirectory returns the cached directory where the driver libs are\n// found if possible.\n// If this has not yet been initialized, the path is first detected and then returned.\nfunc (r *Driver) GetDriverLibDirectory() (string, error) {\n\tr.Lock()\n\tdefer r.Unlock()\n\n\tif r.driverLibDirectory == \"\" {\n\t\tif err := r.updateInfo(); err != nil {\n\t\t\treturn \"\", err\n\t\t}\n\t}\n\n\treturn r.driverLibDirectory, nil\n}\n\nfunc (r *Driver) DriverLibraryLocator(additionalDirs ...string) (lookup.Locator, error) {\n\tlibcudasoParentDirPath, err := r.GetDriverLibDirectory()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get libcuda.so parent directory: %w\", err)\n\t}\n\n\tsearchPaths := []string{libcudasoParentDirPath}\n\tfor _, dir := range additionalDirs {\n\t\tif strings.HasPrefix(dir, \"/\") {\n\t\t\tsearchPaths = append(searchPaths, dir)\n\t\t} else {\n\t\t\tsearchPaths = append(searchPaths, filepath.Join(libcudasoParentDirPath, dir))\n\t\t}\n\t}\n\n\tl := lookup.AsOptional(\n\t\tlookup.NewSymlinkLocator(\n\t\t\tlookup.WithRoot(r.Root),\n\t\t\tlookup.WithLogger(r.logger),\n\t\t\tlookup.WithSearchPaths(\n\t\t\t\tsearchPaths...,\n\t\t\t),\n\t\t),\n\t)\n\treturn l, nil\n}\n\nfunc (r *Driver) updateInfo() error {\n\tdriverLibPath, version, err := r.inferVersion()\n\tif err != nil {\n\t\treturn err\n\t}\n\tif r.version != \"\" && r.version != version {\n\t\treturn fmt.Errorf(\"unexpected version detected: %v != %v\", r.version, version)\n\t}\n\n\tr.version = version\n\tr.driverLibDirectory = r.RelativeToRoot(filepath.Dir(driverLibPath))\n\n\treturn nil\n}\n\n// inferVersion attempts to infer the driver version from the libcuda.so or\n// libnvidia-ml.so driver library suffixes.\nfunc (r *Driver) inferVersion() (string, string, error) {\n\tversionSuffix := r.version\n\tif versionSuffix == \"\" {\n\t\tversionSuffix = \"*.*\"\n\t}\n\n\tvar errs error\n\tfor _, driverLib := range []string{\"libcuda.so.\", \"libnvidia-ml.so.\"} {\n\t\tdriverLibPaths, err := r.Libraries().Locate(driverLib + versionSuffix)\n\t\tif err != nil {\n\t\t\terrs = errors.Join(errs, fmt.Errorf(\"failed to locate libcuda.so: %w\", err))\n\t\t\tcontinue\n\t\t}\n\t\tdriverLibPath := driverLibPaths[0]\n\t\tversion := strings.TrimPrefix(filepath.Base(driverLibPath), driverLib)\n\t\tif version == \"\" {\n\t\t\terrs = errors.Join(errs, fmt.Errorf(\"failed to extract version from path %v\", driverLibPath))\n\t\t\tcontinue\n\t\t}\n\t\treturn driverLibPath, version, nil\n\t}\n\n\treturn \"\", \"\", errs\n}\n\n// RelativeToRoot returns the specified path relative to the driver root.\nfunc (r *Driver) RelativeToRoot(path string) string {\n\tif r.Root == \"\" || r.Root == \"/\" {\n\t\treturn path\n\t}\n\tif !filepath.IsAbs(path) {\n\t\treturn path\n\t}\n\n\treturn strings.TrimPrefix(path, r.Root)\n}\n\n// Files returns a Locator for arbitrary driver files.\nfunc (r *Driver) Files(opts ...lookup.Option) lookup.Locator {\n\treturn lookup.NewFileLocator(\n\t\tappend(opts,\n\t\t\tlookup.WithLogger(r.logger),\n\t\t\tlookup.WithRoot(r.Root),\n\t\t)...,\n\t)\n}\n\n// Libraries returns a Locator for driver libraries.\nfunc (r *Driver) Libraries() lookup.Locator {\n\treturn lookup.NewLibraryLocator(\n\t\tlookup.WithLogger(r.logger),\n\t\tlookup.WithRoot(r.Root),\n\t\tlookup.WithSearchPaths(r.librarySearchPaths...),\n\t)\n}\n\n// Configs returns a locator for driver configs.\n// If configSearchPaths is specified, these paths are used as absolute paths,\n// otherwise, /etc and /usr/share are searched.\nfunc (r *Driver) Configs() lookup.Locator {\n\treturn lookup.NewFileLocator(r.configSearchOptions()...)\n}\n\nfunc (r *Driver) configSearchOptions() []lookup.Option {\n\tif len(r.configSearchPaths) > 0 {\n\t\treturn []lookup.Option{\n\t\t\tlookup.WithLogger(r.logger),\n\t\t\tlookup.WithRoot(\"/\"),\n\t\t\tlookup.WithSearchPaths(r.configSearchPaths...),\n\t\t}\n\t}\n\tsearchPaths := []string{\"/etc\"}\n\tsearchPaths = append(searchPaths, xdgDataDirs()...)\n\treturn []lookup.Option{\n\t\tlookup.WithLogger(r.logger),\n\t\tlookup.WithRoot(r.Root),\n\t\tlookup.WithSearchPaths(searchPaths...),\n\t}\n}\n\n// xdgDataDirs finds the paths as specified in the environment variable XDG_DATA_DIRS.\n// See https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html.\nfunc xdgDataDirs() []string {\n\tif dirs, exists := os.LookupEnv(\"XDG_DATA_DIRS\"); exists && dirs != \"\" {\n\t\treturn lookup.NormalizePaths(dirs)\n\t}\n\n\treturn []string{\"/usr/local/share\", \"/usr/share\"}\n}\n"
},
{
"path": "internal/lookup/root/root_test.go",
"content": "/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nfunc TestDriverLibrariesLocate(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\ttestCases := []struct {\n\t\trootFs string\n\t\tinputs []string\n\t\texpected string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\trootFs: \"rootfs-empty\",\n\t\t\tinputs: []string{\"libcuda.so.1\", \"libcuda.so.*\", \"libcuda.so.*.*\", \"libcuda.so.999.88.77\"},\n\t\t\texpectedError: lookup.ErrNotFound,\n\t\t},\n\t\t{\n\t\t\trootFs: \"rootfs-no-cache-lib64\",\n\t\t\tinputs: []string{\"libcuda.so.1\", \"libcuda.so.*\", \"libcuda.so.*.*\", \"libcuda.so.999.88.77\"},\n\t\t\texpected: \"/usr/lib64/libcuda.so.999.88.77\",\n\t\t},\n\t\t{\n\t\t\trootFs: \"rootfs-1\",\n\t\t\tinputs: []string{\"libcuda.so.1\", \"libcuda.so.*\", \"libcuda.so.*.*\", \"libcuda.so.999.88.77\"},\n\t\t\texpected: \"/lib/x86_64-linux-gnu/libcuda.so.999.88.77\",\n\t\t},\n\t\t{\n\t\t\trootFs: \"rootfs-2\",\n\t\t\tinputs: []string{\"libcuda.so.1\", \"libcuda.so.*\", \"libcuda.so.*.*\", \"libcuda.so.999.88.77\"},\n\t\t\texpected: \"/var/lib/nvidia/lib64/libcuda.so.999.88.77\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tfor _, input := range tc.inputs {\n\t\t\tt.Run(tc.rootFs+input, func(t *testing.T) {\n\t\t\t\trootfs := filepath.Join(moduleRoot, \"testdata\", \"lookup\", tc.rootFs)\n\t\t\t\tdriver := New(\n\t\t\t\t\tWithLogger(logger),\n\t\t\t\t\tWithDriverRoot(rootfs),\n\t\t\t\t)\n\n\t\t\t\tcandidates, err := driver.Libraries().Locate(input)\n\t\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\t\tif tc.expectedError == nil {\n\t\t\t\t\trequire.Equal(t, []string{filepath.Join(rootfs, tc.expected)}, candidates)\n\t\t\t\t}\n\t\t\t})\n\t\t}\n\t}\n}\n"
},
{
"path": "internal/lookup/root/version.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport \"errors\"\n\ntype Versioner interface {\n\tVersion() (string, error)\n}\n\nfunc FirstOf(v ...Versioner) Versioner {\n\treturn firstVersion(v)\n}\n\ntype firstVersion []Versioner\n\nvar _ Versioner = (firstVersion)(nil)\n\nfunc (f firstVersion) Version() (string, error) {\n\tvar errs error\n\tfor _, v := range f {\n\t\tif v == nil {\n\t\t\tcontinue\n\t\t}\n\t\tversion, err := v.Version()\n\t\tif err == nil {\n\t\t\treturn version, nil\n\t\t}\n\n\t\terrs = errors.Join(errs, err)\n\t}\n\n\treturn \"\", errs\n}\n"
},
{
"path": "internal/modifier/cdi/builder.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cdi\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\ntype builder struct {\n\tlogger logger.Interface\n\tspecDirs []string\n\tdevices []string\n\tcdiSpec *specs.Spec\n}\n\n// Option represents a functional option for creating a CDI mofifier.\ntype Option func(*builder)\n\n// New creates a new CDI modifier.\nfunc New(opts ...Option) (oci.SpecModifier, error) {\n\tb := &builder{}\n\tfor _, opt := range opts {\n\t\topt(b)\n\t}\n\tif b.logger == nil {\n\t\tb.logger = logger.New()\n\t}\n\treturn b.build()\n}\n\n// build uses the applied options and constructs a CDI modifier using the builder.\nfunc (m builder) build() (oci.SpecModifier, error) {\n\tif len(m.devices) == 0 && m.cdiSpec == nil {\n\t\treturn nil, nil\n\t}\n\n\tif m.cdiSpec != nil {\n\t\tmodifier := fromCDISpec{\n\t\t\tcdiSpec: &cdi.Spec{Spec: m.cdiSpec},\n\t\t}\n\t\treturn modifier, nil\n\t}\n\n\tregistry, err := cdi.NewCache(\n\t\tcdi.WithAutoRefresh(false),\n\t\tcdi.WithSpecDirs(m.specDirs...),\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create CDI registry: %v\", err)\n\t}\n\n\tmodifier := fromRegistry{\n\t\tlogger: m.logger,\n\t\tregistry: registry,\n\t\tdevices: m.devices,\n\t}\n\n\treturn modifier, nil\n}\n\n// WithLogger sets the logger for the CDI modifier builder.\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(b *builder) {\n\t\tb.logger = logger\n\t}\n}\n\n// WithSpecDirs sets the spec directories for the CDI modifier builder.\nfunc WithSpecDirs(specDirs ...string) Option {\n\treturn func(b *builder) {\n\t\tb.specDirs = specDirs\n\t}\n}\n\n// WithDevices sets the devices for the CDI modifier builder.\nfunc WithDevices(devices ...string) Option {\n\treturn func(b *builder) {\n\t\tb.devices = devices\n\t}\n}\n\n// WithSpec sets the spec for the CDI modifier builder.\nfunc WithSpec(spec *specs.Spec) Option {\n\treturn func(b *builder) {\n\t\tb.cdiSpec = spec\n\t}\n}\n"
},
{
"path": "internal/modifier/cdi/registry.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cdi\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// fromRegistry represents the modifications performed using a CDI registry.\ntype fromRegistry struct {\n\tlogger logger.Interface\n\tregistry *cdi.Cache\n\tdevices []string\n}\n\nvar _ oci.SpecModifier = (*fromRegistry)(nil)\n\n// Modify applies the modifications defined by the CDI registry to the incoming OCI spec.\nfunc (m fromRegistry) Modify(spec *specs.Spec) error {\n\tif err := m.registry.Refresh(); err != nil {\n\t\tm.logger.Debugf(\"The following error was triggered when refreshing the CDI registry: %v\", err)\n\t}\n\n\tm.logger.Debugf(\"Injecting devices using CDI: %v\", m.devices)\n\tunresolvedDevices, err := m.registry.InjectDevices(spec, m.devices...)\n\tif unresolvedDevices != nil {\n\t\tm.logger.Warningf(\"could not resolve CDI devices: %v\", unresolvedDevices)\n\t}\n\tif err != nil {\n\t\tvar refreshErrors []error\n\t\tfor _, rerrs := range m.registry.GetErrors() {\n\t\t\trefreshErrors = append(refreshErrors, rerrs...)\n\t\t}\n\t\tif rerr := errors.Join(refreshErrors...); rerr != nil {\n\t\t\t// We log the errors that may have been generated while refreshing the CDI registry.\n\t\t\t// These may be due to malformed specifications or device name conflicts that could be\n\t\t\t// the cause of an injection failure.\n\t\t\tm.logger.Warningf(\"Refreshing the CDI registry generated errors: %v\", rerr)\n\t\t}\n\n\t\treturn fmt.Errorf(\"failed to inject CDI devices: %v\", err)\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "internal/modifier/cdi/spec.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage cdi\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\tcdiapi \"tags.cncf.io/container-device-interface/pkg/cdi\"\n\tcdi \"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// fromCDISpec represents the modifications performed from a raw CDI spec.\ntype fromCDISpec struct {\n\tcdiSpec *cdiapi.Spec\n}\n\nvar _ oci.SpecModifier = (*fromCDISpec)(nil)\n\n// Modify applies the mofiications defined by the raw CDI spec to the incomming OCI spec.\nfunc (m fromCDISpec) Modify(spec *specs.Spec) error {\n\tfor _, device := range m.cdiSpec.Devices {\n\t\tdevice := m.enrichDevice(device)\n\t\tcdiDevice := cdiapi.Device{\n\t\t\tDevice: &device,\n\t\t}\n\t\tif err := cdiDevice.ApplyEdits(spec); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to apply edits for device %q: %v\", m.cdiSpec.Kind+\"=\"+device.Name, err)\n\t\t}\n\t}\n\n\treturn m.cdiSpec.ApplyEdits(spec)\n}\n\nfunc (m fromCDISpec) enrichDevice(device cdi.Device) cdi.Device {\n\tif !devices.IsOverrideApplied() {\n\t\treturn device\n\t}\n\t// For testing we need to override the device node information to ensure\n\t// that we don't trigger the CDI modification that requires the device node\n\t// to exist and be a character device.\n\t// The following condition is used to determine whether a failure to get\n\t// the info is fatal:\n\t// hasMinimalSpecification := d.Type != \"\" && (d.Major != 0 || d.Type == fifoDevice)\n\tfor i, dn := range device.ContainerEdits.DeviceNodes {\n\t\tdn.Type = \"c\"\n\t\tif dn.Major == 0 {\n\t\t\tdn.Major = 99\n\t\t}\n\t\tdevice.ContainerEdits.DeviceNodes[i] = dn\n\t}\n\treturn device\n}\n"
},
{
"path": "internal/modifier/cdi.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/parser\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/modifier/cdi\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra/csv\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi\"\n)\n\nconst (\n\tautomaticDeviceVendor = \"runtime.nvidia.com\"\n\tautomaticDeviceClass = \"gpu\"\n\tautomaticDeviceKind = automaticDeviceVendor + \"/\" + automaticDeviceClass\n\tautomaticDevicePrefix = automaticDeviceKind + \"=\"\n)\n\n// newCDIModifier creates an OCI spec modifier that determines the modifications to make based on the\n// CDI specifications available on the system. The NVIDIA_VISIBLE_DEVICES environment variable is\n// used to select the devices to include.\nfunc (f *Factory) newCDIModifier(isJitCDI bool) (oci.SpecModifier, error) {\n\tdefaultKind := f.cfg.NVIDIAContainerRuntimeConfig.Modes.CDI.DefaultKind\n\tif isJitCDI {\n\t\tdefaultKind = automaticDeviceKind\n\t}\n\tdeviceRequestor := newCDIDeviceRequestor(\n\t\tf.logger,\n\t\tf.image,\n\t\tdefaultKind,\n\t)\n\tdevices := deviceRequestor.DeviceRequests()\n\tif len(devices) == 0 {\n\t\tf.logger.Debugf(\"No devices requested; no modification required.\")\n\t\treturn nil, nil\n\t}\n\n\tautomaticDevices := filterAutomaticDevices(devices)\n\tif len(automaticDevices) != len(devices) && len(automaticDevices) > 0 {\n\t\treturn nil, fmt.Errorf(\"requesting a CDI device with vendor 'runtime.nvidia.com' is not supported when requesting other CDI devices\")\n\t}\n\tif len(automaticDevices) > 0 {\n\t\tf.logger.Debugf(\"Using automatic CDI modfier for devices %v\", automaticDevices)\n\t\tmodifier, err := f.newJitCDIModifier(automaticDevices)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to create the automatic CDI modifier: %w\", err)\n\t\t}\n\t\treturn modifier, nil\n\t}\n\n\tf.logger.Debugf(\"Creating CDI modifier for devices: %v\", devices)\n\treturn cdi.New(\n\t\tcdi.WithLogger(f.logger),\n\t\tcdi.WithDevices(devices...),\n\t\tcdi.WithSpecDirs(f.cfg.NVIDIAContainerRuntimeConfig.Modes.CDI.SpecDirs...),\n\t)\n}\n\n// newJitCDIModifier creates a modifier that for a generated in-memory CDI spec for the specified CDI devices.\nfunc (f *Factory) newJitCDIModifier(automaticDevices []string) (oci.SpecModifier, error) {\n\tif f.image != nil {\n\t\tautomaticDevices = append(automaticDevices, withUniqueDevices(gatedDevices(*f.image)).DeviceRequests()...)\n\t\tautomaticDevices = append(automaticDevices, withUniqueDevices(imexDevices(*f.image)).DeviceRequests()...)\n\t}\n\treturn f.newAutomaticCDISpecModifier(automaticDevices)\n}\n\ntype deviceRequestor interface {\n\tDeviceRequests() []string\n}\n\ntype cdiDeviceRequestor struct {\n\tlogger logger.Interface\n\timage *image.CUDA\n\tdefaultKind string\n}\n\nfunc newCDIDeviceRequestor(logger logger.Interface, image *image.CUDA, defaultKind string) deviceRequestor {\n\tc := &cdiDeviceRequestor{\n\t\tlogger: logger,\n\t\timage: image,\n\t\tdefaultKind: defaultKind,\n\t}\n\treturn withUniqueDevices(c)\n}\n\nfunc (c *cdiDeviceRequestor) DeviceRequests() []string {\n\tif c == nil {\n\t\treturn nil\n\t}\n\tvar devices []string\n\tfor _, name := range c.image.VisibleDevices() {\n\t\tif name == \"\" {\n\t\t\tname = \"none\"\n\t\t}\n\t\tif !parser.IsQualifiedName(name) {\n\t\t\tname = fmt.Sprintf(\"%s=%s\", c.defaultKind, name)\n\t\t}\n\t\tdevices = append(devices, name)\n\t}\n\n\treturn devices\n}\n\ntype gatedDevices image.CUDA\n\n// DeviceRequests returns a list of devices that are required for gated devices.\nfunc (g gatedDevices) DeviceRequests() []string {\n\ti := (image.CUDA)(g)\n\n\tvar devices []string\n\tif i.Getenv(\"NVIDIA_GDS\") == \"enabled\" {\n\t\tdevices = append(devices, \"mode=gds\")\n\t}\n\tif i.Getenv(\"NVIDIA_MOFED\") == \"enabled\" {\n\t\tdevices = append(devices, \"mode=mofed\")\n\t}\n\tif i.Getenv(\"NVIDIA_GDRCOPY\") == \"enabled\" {\n\t\tdevices = append(devices, \"mode=gdrcopy\")\n\t}\n\tif i.Getenv(\"NVIDIA_NVSWITCH\") == \"enabled\" {\n\t\tdevices = append(devices, \"mode=nvswitch\")\n\t}\n\n\treturn devices\n}\n\ntype imexDevices image.CUDA\n\nfunc (d imexDevices) DeviceRequests() []string {\n\tvar devices []string\n\ti := (image.CUDA)(d)\n\tfor _, channelID := range i.ImexChannelRequests() {\n\t\tdevices = append(devices, \"mode=imex,id=\"+channelID)\n\t}\n\treturn devices\n}\n\n// filterAutomaticDevices searches for \"automatic\" device names in the input slice.\n// \"Automatic\" devices are a well-defined list of CDI device names which, when requested,\n// trigger the generation of a CDI spec at runtime. This removes the need to generate a\n// CDI spec on the system a-priori as well as keep it up-to-date.\nfunc filterAutomaticDevices(devices []string) []string {\n\tvar automatic []string\n\tfor _, device := range devices {\n\t\tif !strings.HasPrefix(device, automaticDevicePrefix) {\n\t\t\tcontinue\n\t\t}\n\t\tautomatic = append(automatic, device)\n\t}\n\treturn automatic\n}\n\nfunc (f *Factory) newAutomaticCDISpecModifier(devices []string) (oci.SpecModifier, error) {\n\tf.logger.Debugf(\"Generating in-memory CDI specs for devices %v\", devices)\n\n\tcsvFiles, err := csv.GetFileList(f.cfg.NVIDIAContainerRuntimeConfig.Modes.CSV.MountSpecPath)\n\tif err != nil {\n\t\tf.logger.Warningf(\"Failed to get the list of CSV files: %v\", err)\n\t}\n\tif f.image.Getenv(image.EnvVarNvidiaRequireJetpack) != \"csv-mounts=all\" {\n\t\tcsvFiles = csv.BaseFilesOnly(csvFiles)\n\t}\n\n\tcdiModeIdentifiers := cdiModeIdentfiersFromDevices(devices...)\n\tf.logger.Debugf(\"Per-mode identifiers: %v\", cdiModeIdentifiers)\n\tvar modifiers oci.SpecModifiers\n\tfor _, mode := range cdiModeIdentifiers.modes {\n\t\tcdilib, err := nvcdi.New(\n\t\t\tnvcdi.WithLogger(f.logger),\n\t\t\tnvcdi.WithNVIDIACDIHookPath(f.cfg.NVIDIACTKConfig.Path),\n\t\t\tnvcdi.WithDriverRoot(f.driver.Root),\n\t\t\tnvcdi.WithDevRoot(f.driver.DevRoot),\n\t\t\tnvcdi.WithEditsFactory(f.editsFactory),\n\t\t\tnvcdi.WithVendor(automaticDeviceVendor),\n\t\t\tnvcdi.WithClass(cdiModeIdentifiers.deviceClassByMode[mode]),\n\t\t\tnvcdi.WithMode(mode),\n\t\t\tnvcdi.WithFeatureFlags(f.cfg.NVIDIAContainerRuntimeConfig.Modes.JitCDI.NVCDIFeatureFlags...),\n\t\t\tnvcdi.WithCSVCompatContainerRoot(f.cfg.NVIDIAContainerRuntimeConfig.Modes.CSV.CompatContainerRoot),\n\t\t\tnvcdi.WithCSVFiles(csvFiles),\n\t\t)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to construct CDI library for mode %q: %w\", mode, err)\n\t\t}\n\n\t\tspec, err := cdilib.GetSpec(cdiModeIdentifiers.idsByMode[mode]...)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to generate CDI spec for mode %q: %w\", mode, err)\n\t\t}\n\n\t\tcdiDeviceRequestor, err := cdi.New(\n\t\t\tcdi.WithLogger(f.logger),\n\t\t\tcdi.WithSpec(spec.Raw()),\n\t\t)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to construct CDI modifier for mode %q: %w\", mode, err)\n\t\t}\n\n\t\tmodifiers = append(modifiers, cdiDeviceRequestor)\n\t}\n\n\treturn modifiers, nil\n}\n\ntype cdiModeIdentifiers struct {\n\tmodes []string\n\tidsByMode map[string][]string\n\tdeviceClassByMode map[string]string\n}\n\nfunc cdiModeIdentfiersFromDevices(devices ...string) *cdiModeIdentifiers {\n\tperModeIdentifiers := make(map[string][]string)\n\tperModeDeviceClass := map[string]string{\"auto\": automaticDeviceClass}\n\tvar uniqueModes []string\n\tseen := make(map[string]bool)\n\tfor _, device := range devices {\n\t\tmode, id := getModeIdentifier(device)\n\t\tif !seen[mode] {\n\t\t\tuniqueModes = append(uniqueModes, mode)\n\t\t\tseen[mode] = true\n\t\t}\n\t\tif id != \"\" {\n\t\t\tperModeIdentifiers[mode] = append(perModeIdentifiers[mode], id)\n\t\t}\n\t}\n\n\treturn &cdiModeIdentifiers{\n\t\tmodes: uniqueModes,\n\t\tidsByMode: perModeIdentifiers,\n\t\tdeviceClassByMode: perModeDeviceClass,\n\t}\n}\n\nfunc getModeIdentifier(device string) (string, string) {\n\tif !strings.HasPrefix(device, \"mode=\") {\n\t\treturn \"auto\", strings.TrimPrefix(device, automaticDevicePrefix)\n\t}\n\tparts := strings.SplitN(device, \",\", 2)\n\tmode := strings.TrimPrefix(parts[0], \"mode=\")\n\tif len(parts) == 2 {\n\t\treturn mode, strings.TrimPrefix(parts[1], \"id=\")\n\t}\n\treturn mode, \"\"\n}\n\ntype deduplicatedDeviceRequestor struct {\n\tdeviceRequestor\n}\n\nfunc withUniqueDevices(deviceRequestor deviceRequestor) deviceRequestor {\n\treturn &deduplicatedDeviceRequestor{deviceRequestor: deviceRequestor}\n}\n\nfunc (d *deduplicatedDeviceRequestor) DeviceRequests() []string {\n\tif d == nil {\n\t\treturn nil\n\t}\n\tseen := make(map[string]bool)\n\tvar devices []string\n\tfor _, device := range d.deviceRequestor.DeviceRequests() {\n\t\tif seen[device] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[device] = true\n\t\tdevices = append(devices, device)\n\t}\n\treturn devices\n}\n"
},
{
"path": "internal/modifier/cdi_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n)\n\nfunc TestDeviceRequests(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tinput cdiDeviceRequestor\n\t\tspec *specs.Spec\n\t\timageOptions []image.Option\n\t\texpectedDevices []string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty spec yields no devices\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi devices from mounts\",\n\t\t\tinput: cdiDeviceRequestor{\n\t\t\t\tdefaultKind: \"nvidia.com/gpu\",\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tMounts: []specs.Mount{\n\t\t\t\t\t{\n\t\t\t\t\t\tDestination: \"/var/run/nvidia-container-devices/cdi/nvidia.com/gpu/0\",\n\t\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tDestination: \"/var/run/nvidia-container-devices/cdi/nvidia.com/gpu/1\",\n\t\t\t\t\t\tSource: \"/dev/null\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"nvidia.com/gpu=0\", \"nvidia.com/gpu=1\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi devices from envvar\",\n\t\t\tinput: cdiDeviceRequestor{\n\t\t\t\tdefaultKind: \"nvidia.com/gpu\",\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=0,example.com/class=device\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"nvidia.com/gpu=0\", \"example.com/class=device\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi devices from envvar with default kind\",\n\t\t\tinput: cdiDeviceRequestor{\n\t\t\t\tdefaultKind: \"runtime.nvidia.com/gpu\",\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=all\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"runtime.nvidia.com/gpu=all\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"no matching annotations\",\n\t\t\timageOptions: []image.Option{\n\t\t\t\timage.WithAnnotationsPrefixes(\"not-prefix/\"),\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\"prefix/foo\": \"example.com/device=bar\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"single matching annotation\",\n\t\t\timageOptions: []image.Option{\n\t\t\t\timage.WithAnnotationsPrefixes(\"prefix/\"),\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\"prefix/foo\": \"example.com/device=bar\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"example.com/device=bar\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple matching annotations\",\n\t\t\timageOptions: []image.Option{\n\t\t\t\timage.WithAnnotationsPrefixes(\"prefix/\", \"another-prefix/\"),\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\"prefix/foo\": \"example.com/device=bar\",\n\t\t\t\t\t\"another-prefix/bar\": \"example.com/device=baz\",\n\t\t\t\t},\n\t\t\t},\n\n\t\t\texpectedDevices: []string{\"example.com/device=baz\", \"example.com/device=bar\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple matching annotations with duplicate devices\",\n\t\t\timageOptions: []image.Option{\n\t\t\t\timage.WithAnnotationsPrefixes(\"prefix/\", \"another-prefix/\"),\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\"prefix/foo\": \"example.com/device=bar\",\n\t\t\t\t\t\"another-prefix/bar\": \"example.com/device=bar\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"example.com/device=bar\", \"example.com/device=bar\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"devices in annotations are expanded\",\n\t\t\tinput: cdiDeviceRequestor{\n\t\t\t\tdefaultKind: \"nvidia.com/gpu\",\n\t\t\t},\n\t\t\timageOptions: []image.Option{\n\t\t\t\timage.WithAnnotationsPrefixes(\"prefix/\"),\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\"prefix/foo\": \"device\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"nvidia.com/gpu=device\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"invalid devices in annotations are treated as strings\",\n\t\t\tinput: cdiDeviceRequestor{\n\t\t\t\tdefaultKind: \"nvidia.com/gpu\",\n\t\t\t},\n\t\t\timageOptions: []image.Option{\n\t\t\t\timage.WithAnnotationsPrefixes(\"prefix/\"),\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tAnnotations: map[string]string{\n\t\t\t\t\t\"prefix/foo\": \"example.com/device\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"nvidia.com/gpu=example.com/device\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_VISIBLE_DEVICES=none\",\n\t\t\tinput: cdiDeviceRequestor{\n\t\t\t\tdefaultKind: \"runtime.nvidia.com/gpu\",\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=none\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"runtime.nvidia.com/gpu=none\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"SWARM_RESOURCE envvar is used over NVIDIA_VISIBLE_DEVICES\",\n\t\t\tinput: cdiDeviceRequestor{\n\t\t\t\tdefaultKind: \"runtime.nvidia.com/gpu\",\n\t\t\t},\n\t\t\timageOptions: []image.Option{\n\t\t\t\timage.WithPreferredVisibleDevicesEnvVars(\"SWARM_RESOURCE\"),\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=all\", \"SWARM_RESOURCE=GPU1\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []string{\"runtime.nvidia.com/gpu=GPU1\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\ttc.input.logger = logger\n\n\t\timage, err := image.NewCUDAImageFromSpec(\n\t\t\ttc.spec,\n\t\t\tappend(\n\t\t\t\t[]image.Option{\n\t\t\t\t\t// TODO: We should pull these into the testcase options.\n\t\t\t\t\timage.WithAcceptDeviceListAsVolumeMounts(true),\n\t\t\t\t\timage.WithAcceptEnvvarUnprivileged(true),\n\t\t\t\t},\n\t\t\t\ttc.imageOptions...)...,\n\t\t)\n\t\trequire.NoError(t, err)\n\t\ttc.input.image = &image\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdevices := tc.input.DeviceRequests()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedDevices, devices)\n\t\t})\n\t}\n}\n\nfunc Test_cdiModeIdentfiersFromDevices(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdevices []string\n\t\texpected *cdiModeIdentifiers\n\t}{\n\t\t{\n\t\t\tdescription: \"empty device list\",\n\t\t\tdevices: []string{},\n\t\t\texpected: &cdiModeIdentifiers{\n\t\t\t\tmodes: nil,\n\t\t\t\tidsByMode: map[string][]string{},\n\t\t\t\tdeviceClassByMode: map[string]string{\"auto\": \"gpu\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"single automatic device\",\n\t\t\tdevices: []string{\"0\"},\n\t\t\texpected: &cdiModeIdentifiers{\n\t\t\t\tmodes: []string{\"auto\"},\n\t\t\t\tidsByMode: map[string][]string{\"auto\": {\"0\"}},\n\t\t\t\tdeviceClassByMode: map[string]string{\"auto\": \"gpu\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple automatic devices\",\n\t\t\tdevices: []string{\"0\", \"1\"},\n\t\t\texpected: &cdiModeIdentifiers{\n\t\t\t\tmodes: []string{\"auto\"},\n\t\t\t\tidsByMode: map[string][]string{\"auto\": {\"0\", \"1\"}},\n\t\t\t\tdeviceClassByMode: map[string]string{\"auto\": \"gpu\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device with explicit mode\",\n\t\t\tdevices: []string{\"mode=gds,id=foo\"},\n\t\t\texpected: &cdiModeIdentifiers{\n\t\t\t\tmodes: []string{\"gds\"},\n\t\t\t\tidsByMode: map[string][]string{\"gds\": {\"foo\"}},\n\t\t\t\tdeviceClassByMode: map[string]string{\"auto\": \"gpu\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mixed auto and explicit\",\n\t\t\tdevices: []string{\"0\", \"mode=gds,id=foo\", \"mode=gdrcopy,id=bar\"},\n\t\t\texpected: &cdiModeIdentifiers{\n\t\t\t\tmodes: []string{\"auto\", \"gds\", \"gdrcopy\"},\n\t\t\t\tidsByMode: map[string][]string{\n\t\t\t\t\t\"auto\": {\"0\"},\n\t\t\t\t\t\"gds\": {\"foo\"},\n\t\t\t\t\t\"gdrcopy\": {\"bar\"},\n\t\t\t\t},\n\t\t\t\tdeviceClassByMode: map[string]string{\"auto\": \"gpu\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device with only mode, no id\",\n\t\t\tdevices: []string{\"mode=nvswitch\"},\n\t\t\texpected: &cdiModeIdentifiers{\n\t\t\t\tmodes: []string{\"nvswitch\"},\n\t\t\t\tidsByMode: map[string][]string{},\n\t\t\t\tdeviceClassByMode: map[string]string{\"auto\": \"gpu\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicate modes\",\n\t\t\tdevices: []string{\"mode=gds,id=x\", \"mode=gds,id=y\", \"mode=gds\"},\n\t\t\texpected: &cdiModeIdentifiers{\n\t\t\t\tmodes: []string{\"gds\"},\n\t\t\t\tidsByMode: map[string][]string{\"gds\": {\"x\", \"y\"}},\n\t\t\t\tdeviceClassByMode: map[string]string{\"auto\": \"gpu\"},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"NVIDIA_VISIBLE_DEVICES=none\",\n\t\t\tdevices: []string{\"none\"},\n\t\t\texpected: &cdiModeIdentifiers{\n\t\t\t\tmodes: []string{\"auto\"},\n\t\t\t\tidsByMode: map[string][]string{\"auto\": {\"none\"}},\n\t\t\t\tdeviceClassByMode: map[string]string{\"auto\": \"gpu\"},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tresult := cdiModeIdentfiersFromDevices(tc.devices...)\n\t\t\trequire.EqualValues(t, tc.expected, result)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/modifier/csv.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/cuda\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/requirements\"\n)\n\n// newCSVModifier creates a modifier that applies modications to an OCI spec if required by the runtime wrapper.\n// The modifications are defined by CSV MountSpecs.\nfunc (f *Factory) newCSVModifier() (oci.SpecModifier, error) {\n\tdevices := withUniqueDevices(csvDevices(*f.image)).DeviceRequests()\n\tif len(devices) == 0 {\n\t\tf.logger.Infof(\"No modification required; no devices requested\")\n\t\treturn nil, nil\n\t}\n\tf.logger.Infof(\"Constructing modifier from config: %+v\", *f.cfg)\n\n\tif err := checkRequirements(f.logger, f.image); err != nil {\n\t\treturn nil, fmt.Errorf(\"requirements not met: %v\", err)\n\t}\n\n\treturn f.newAutomaticCDISpecModifier(devices)\n}\n\nfunc checkRequirements(logger logger.Interface, image *image.CUDA) error {\n\tif image == nil || image.HasDisableRequire() {\n\t\t// TODO: We could print the real value here instead\n\t\tlogger.Debugf(\"NVIDIA_DISABLE_REQUIRE=%v; skipping requirement checks\", true)\n\t\treturn nil\n\t}\n\n\timageRequirements, err := image.GetRequirements()\n\tif err != nil {\n\t\t// TODO: Should we treat this as a failure, or just issue a warning?\n\t\treturn fmt.Errorf(\"failed to get image requirements: %v\", err)\n\t}\n\n\tr := requirements.New(logger, imageRequirements)\n\n\tcudaVersion, err := cuda.Version()\n\tif err != nil {\n\t\tlogger.Warningf(\"Failed to get CUDA version: %v\", err)\n\t} else {\n\t\tr.AddVersionProperty(requirements.CUDA, cudaVersion)\n\t}\n\n\tcompteCapability, err := cuda.ComputeCapability(0)\n\tif err != nil {\n\t\tlogger.Warningf(\"Failed to get CUDA Compute Capability: %v\", err)\n\t} else {\n\t\tr.AddVersionProperty(requirements.ARCH, compteCapability)\n\t}\n\n\treturn r.Assert()\n}\n\ntype csvDevices image.CUDA\n\nfunc (d csvDevices) DeviceRequests() []string {\n\tvar devices []string\n\ti := (image.CUDA)(d)\n\tfor _, deviceID := range i.VisibleDevices() {\n\t\tdevices = append(devices, \"mode=csv,id=\"+deviceID)\n\t}\n\treturn devices\n}\n"
},
{
"path": "internal/modifier/csv_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test/to\"\n)\n\nfunc TestNewCSVModifier(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcfg config.Config\n\t\tenvmap map[string]string\n\t\tdriverRootfs string\n\t\tdevRootfs string\n\t\texpectedErrorString string\n\t\texpectedSpec specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"visible devices not set returns nil\",\n\t\t\tenvmap: map[string]string{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"visible devices empty returns nil\",\n\t\t\tenvmap: map[string]string{\"NVIDIA_VISIBLE_DEVICES\": \"\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"visible devices 'void' returns nil\",\n\t\t\tenvmap: map[string]string{\"NVIDIA_VISIBLE_DEVICES\": \"void\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"visible devices all\",\n\t\t\tenvmap: map[string]string{\"NVIDIA_VISIBLE_DEVICES\": \"all\"},\n\t\t\tdriverRootfs: \"rootfs-orin\",\n\t\t\texpectedSpec: specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=void\"},\n\t\t\t\t},\n\t\t\t\tMounts: []specs.Mount{\n\t\t\t\t\t{Source: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", Destination: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t{Source: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", Destination: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t},\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tCreateContainer: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/usr/lib/aarch64-linux-gnu/nvidia\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinux: &specs.Linux{\n\t\t\t\t\tDevices: []specs.LinuxDevice{\n\t\t\t\t\t\t{Path: \"/dev/nvidia0\", Type: \"c\", Major: 99},\n\t\t\t\t\t},\n\t\t\t\t\tResources: &specs.LinuxResources{\n\t\t\t\t\t\tDevices: []specs.LinuxDeviceCgroup{\n\t\t\t\t\t\t\t{Allow: true, Type: \"c\", Major: to.Ptr[int64](99), Minor: to.Ptr[int64](0), Access: \"rwm\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\timage, _ := image.New(\n\t\t\t\timage.WithEnvMap(tc.envmap),\n\t\t\t)\n\t\t\tdriverRoot := tc.driverRootfs\n\t\t\tif driverRoot != \"\" {\n\t\t\t\tdriverRoot = filepath.Join(lookupRoot, tc.driverRootfs)\n\t\t\t}\n\t\t\tdevRoot := tc.devRootfs\n\t\t\tif devRoot != \"\" {\n\t\t\t\tdevRoot = filepath.Join(lookupRoot, tc.devRootfs)\n\t\t\t}\n\t\t\tdriver := root.New(root.WithDriverRoot(driverRoot), root.WithDevRoot(devRoot))\n\t\t\t// Override the CSV file search path for this root.\n\t\t\ttc.cfg.NVIDIAContainerRuntimeConfig.Modes.CSV.MountSpecPath = filepath.Join(driverRoot, \"/etc/nvidia-container-runtime/host-files-for-container.d\")\n\t\t\ttc.cfg.NVIDIACTKConfig.Path = \"/usr/bin/nvidia-cdi-hook\"\n\n\t\t\tf := createFactory(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithDriver(driver),\n\t\t\t\tWithConfig(&tc.cfg),\n\t\t\t\tWithImage(&image),\n\t\t\t)\n\t\t\tm, err := f.newCSVModifier()\n\t\t\tif tc.expectedErrorString == \"\" {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t} else {\n\t\t\t\trequire.EqualError(t, err, tc.expectedErrorString)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\ts := specs.Spec{}\n\t\t\terr = list{m}.Modify(&s)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, test.StripRoot(s, driverRoot))\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/modifier/discover.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"fmt\"\n\n\tocispecs \"github.com/opencontainers/runtime-spec/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/edits\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\ntype discoverModifier struct {\n\tlogger logger.Interface\n\teditsFactory edits.Factory\n\tdiscoverer discover.Discover\n}\n\n// newModifierFromDiscoverer creates a modifier that applies the discovered\n// modifications to an OCI spec if required by the runtime wrapper.\nfunc (f *Factory) newModifierFromDiscoverer(d discover.Discover) (oci.SpecModifier, error) {\n\tm := discoverModifier{\n\t\tlogger: f.logger,\n\t\teditsFactory: f.editsFactory,\n\t\tdiscoverer: d,\n\t}\n\treturn &m, nil\n}\n\n// Modify applies the modifications required by discoverer to the incomming OCI spec.\n// These modifications are applied in-place.\nfunc (m discoverModifier) Modify(spec *ocispecs.Spec) error {\n\tspecEdits, err := m.editsFactory.FromDiscoverer(m.discoverer)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to get required container edits: %v\", err)\n\t}\n\n\tm.logger.Infof(\"Mounts:\")\n\tfor _, mount := range specEdits.Mounts {\n\t\tm.logger.Infof(\"Mounting %v at %v\", mount.HostPath, mount.ContainerPath)\n\t}\n\tm.logger.Infof(\"Devices:\")\n\tfor _, device := range specEdits.DeviceNodes {\n\t\tm.logger.Infof(\"Injecting %v\", device.Path)\n\t}\n\tm.logger.Infof(\"Hooks:\")\n\tfor _, hook := range specEdits.Hooks {\n\t\tm.logger.Infof(\"Injecting %v %v\", hook.Path, hook.Args)\n\t}\n\n\treturn specEdits.Apply(spec)\n}\n"
},
{
"path": "internal/modifier/discover_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\nfunc TestDiscoverModifier(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdiscover *discover.DiscoverMock\n\t\tspec *specs.Spec\n\t\texpectedError error\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"empty discoverer does not modify spec\",\n\t\t\tspec: &specs.Spec{},\n\t\t\tdiscover: &discover.DiscoverMock{},\n\t\t\texpectedSpec: &specs.Spec{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"failed hooks discoverer returns error\",\n\t\t\tdiscover: &discover.DiscoverMock{\n\t\t\t\tHooksFunc: func() ([]discover.Hook, error) {\n\t\t\t\t\treturn nil, fmt.Errorf(\"discover.Hooks error\")\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: fmt.Errorf(\"discover.Hooks error\"),\n\t\t},\n\t\t{\n\t\t\tdescription: \"discovered hooks are injected into spec\",\n\t\t\tspec: &specs.Spec{},\n\t\t\tdiscover: &discover.DiscoverMock{\n\t\t\t\tHooksFunc: func() ([]discover.Hook, error) {\n\t\t\t\t\thooks := []discover.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tLifecycle: \"prestart\",\n\t\t\t\t\t\t\tPath: \"/hook/a\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/a\", \"arga\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/hook/b\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/b\", \"argb\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn hooks, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/hook/a\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/a\", \"arga\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tCreateContainer: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/hook/b\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/b\", \"argb\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"existing hooks are maintained\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/hook/a\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/a\", \"arga\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tdiscover: &discover.DiscoverMock{\n\t\t\t\tHooksFunc: func() ([]discover.Hook, error) {\n\t\t\t\t\thooks := []discover.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tLifecycle: \"prestart\",\n\t\t\t\t\t\t\tPath: \"/hook/b\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/b\", \"argb\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn hooks, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/hook/a\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/a\", \"arga\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/hook/b\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/b\", \"argb\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfactory := createFactory(\n\t\tWithLogger(logger),\n\t\tWithConfig(&config.Config{}),\n\t)\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tm, err := factory.newModifierFromDiscoverer(tc.discover)\n\t\t\trequire.NoError(t, err)\n\n\t\t\terr = m.Modify(tc.spec)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, tc.spec)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/modifier/factory.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/edits\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// factoryOptions define the set of options that must be set when constructing\n// a modifier factory.\ntype factoryOptions struct {\n\tlogger logger.Interface\n\tcfg *config.Config\n\tdriver *root.Driver\n\thookCreator discover.HookCreator\n\timage *image.CUDA\n\truntimeMode info.RuntimeMode\n}\n\ntype Factory struct {\n\tfactoryOptions\n\t// An editsFactory is created at construction.\n\teditsFactory edits.Factory\n}\n\n// A Factory also implements the oci.SpecModifier interface.\nvar _ oci.SpecModifier = (*Factory)(nil)\n\n// New is a factory method for creating a modifier Factory.\nfunc New(opts ...Option) (oci.SpecModifier, error) {\n\tf := createFactory(opts...)\n\tif err := f.validate(); err != nil {\n\t\treturn nil, err\n\t}\n\treturn f, nil\n}\n\n// createFactory is an internal constructor to allow validation to be bypassed\n// for internal tests.\nfunc createFactory(opts ...Option) *Factory {\n\tf := &Factory{}\n\tfor _, opt := range opts {\n\t\topt(&f.factoryOptions)\n\t}\n\n\tf.editsFactory = edits.NewFactory(\n\t\tedits.WithLogger(f.logger),\n\t\tedits.WithNoAdditionalGIDsForDeviceNodes(f.cfg.Features.NoAdditionalGIDsForDeviceNodes.IsEnabled()),\n\t)\n\n\treturn f\n}\n\nfunc (f *Factory) validate() error {\n\tif f.driver == nil {\n\t\treturn fmt.Errorf(\"a driver must be specified\")\n\t}\n\tswitch string(f.runtimeMode) {\n\tcase \"\":\n\t\treturn fmt.Errorf(\"a mode must be specified\")\n\tcase \"legacy\", \"csv\", \"jit-cdi\", \"cdi\":\n\t\treturn nil\n\tdefault:\n\t\treturn fmt.Errorf(\"invalid mode %q\", f.runtimeMode)\n\t}\n}\n\n// Modify creates the configured modifier and applies it to the supplied OCI\n// specification.\nfunc (f *Factory) Modify(s *specs.Spec) error {\n\tm, err := f.create()\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn m.Modify(s)\n}\n\n// create a modifier based on the modifier factory configuration.\nfunc (f *Factory) create() (oci.SpecModifier, error) {\n\tvar modifiers list\n\tfor _, modifierType := range supportedModifierTypes(f.runtimeMode) {\n\t\tswitch modifierType {\n\t\tcase \"mode\":\n\t\t\tmodeModifier, err := f.newModeModifier()\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tmodifiers = append(modifiers, modeModifier)\n\t\tcase \"nvidia-hook-remover\":\n\t\t\tmodifiers = append(modifiers, f.newNvidiaContainerRuntimeHookRemover())\n\t\tcase \"graphics\":\n\t\t\tgraphicsModifier, err := f.newGraphicsModifier()\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tmodifiers = append(modifiers, graphicsModifier)\n\t\tcase \"feature-gated\":\n\t\t\tfeatureGatedModifier, err := f.newFeatureGatedModifier()\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tmodifiers = append(modifiers, featureGatedModifier)\n\t\tdefault:\n\t\t\tf.logger.Debugf(\"Ignoring unknown modifier type %q\", modifierType)\n\t\t}\n\t}\n\treturn modifiers, nil\n}\n\ntype Option func(*factoryOptions)\n\nfunc WithConfig(cfg *config.Config) Option {\n\treturn func(f *factoryOptions) {\n\t\tf.cfg = cfg\n\t}\n}\n\nfunc WithDriver(driver *root.Driver) Option {\n\treturn func(f *factoryOptions) {\n\t\tf.driver = driver\n\t}\n}\nfunc WithHookCreator(hookCreator discover.HookCreator) Option {\n\treturn func(f *factoryOptions) {\n\t\tf.hookCreator = hookCreator\n\t}\n}\n\nfunc WithImage(image *image.CUDA) Option {\n\treturn func(f *factoryOptions) {\n\t\tf.image = image\n\t}\n}\n\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(f *factoryOptions) {\n\t\tf.logger = logger\n\t}\n}\n\nfunc WithRuntimeMode(runtimeMode info.RuntimeMode) Option {\n\treturn func(f *factoryOptions) {\n\t\tf.runtimeMode = runtimeMode\n\t}\n}\n"
},
{
"path": "internal/modifier/gated.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// newFeatureGatedModifier creates the modifiers for optional features.\n// These include:\n//\n//\tNVIDIA_GDS=enabled\n//\tNVIDIA_MOFED=enabled\n//\tNVIDIA_NVSWITCH=enabled\n//\tNVIDIA_GDRCOPY=enabled\n//\n// If not devices are selected, no changes are made.\nfunc (f *Factory) newFeatureGatedModifier() (oci.SpecModifier, error) {\n\tif devices := f.image.VisibleDevices(); len(devices) == 0 {\n\t\tf.logger.Infof(\"No modification required; no devices requested\")\n\t\treturn nil, nil\n\t}\n\n\tvar modifers list\n\tif gatedDeviceRequests := withUniqueDevices(gatedDevices(*f.image)).DeviceRequests(); len(gatedDeviceRequests) != 0 {\n\t\tfeatureGatedModifier, err := f.newAutomaticCDISpecModifier(gatedDeviceRequests)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tmodifers = append(modifers, featureGatedModifier)\n\t}\n\n\t// If the feature flag has explicitly been toggled, we don't make any modification.\n\tif !f.cfg.Features.DisableCUDACompatLibHook.IsEnabled() {\n\t\tcudaCompatModifer, err := f.getCudaCompatModeModifier()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to construct CUDA Compat discoverer: %w\", err)\n\t\t}\n\t\tmodifers = append(modifers, cudaCompatModifer)\n\t}\n\n\treturn modifers, nil\n}\n\nfunc (f *Factory) getCudaCompatModeModifier() (oci.SpecModifier, error) {\n\t// We don't support the enable-cuda-compat hook in CSV mode.\n\tif f.cfg.NVIDIAContainerRuntimeConfig.Mode == \"csv\" {\n\t\treturn nil, nil\n\t}\n\n\t// For legacy mode, we only include the enable-cuda-compat hook if cuda-compat-mode is set to hook.\n\tif f.cfg.NVIDIAContainerRuntimeConfig.Mode == \"legacy\" && f.cfg.NVIDIAContainerRuntimeConfig.Modes.Legacy.CUDACompatMode != config.CUDACompatModeHook {\n\t\treturn nil, nil\n\t}\n\n\tversion, err := f.driver.Version()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get driver version: %w\", err)\n\t}\n\n\tcompatLibHookDiscoverer := discover.NewCUDACompatHookDiscoverer(f.logger, f.hookCreator, &discover.EnableCUDACompatHookOptions{HostDriverVersion: version})\n\t// For non-legacy modes we return the hook as is. These modes *should* already include the update-ldcache hook.\n\tif f.cfg.NVIDIAContainerRuntimeConfig.Mode != \"legacy\" {\n\t\treturn f.newModifierFromDiscoverer(compatLibHookDiscoverer)\n\t}\n\n\t// For legacy mode, we also need to inject a hook to update the LDCache\n\t// after we have modifed the configuration.\n\tldcacheUpdateHookDiscoverer, err := discover.NewLDCacheUpdateHook(\n\t\tf.logger,\n\t\tdiscover.None{},\n\t\tf.hookCreator,\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to construct ldcache update discoverer: %w\", err)\n\t}\n\n\treturn f.newModifierFromDiscoverer(discover.Merge(compatLibHookDiscoverer, ldcacheUpdateHookDiscoverer))\n}\n"
},
{
"path": "internal/modifier/graphics.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// newGraphicsModifier constructs a modifier that injects graphics-related modifications into an OCI runtime specification.\n// The value of the NVIDIA_DRIVER_CAPABILITIES environment variable is checked to determine if this modification should be made.\nfunc (f *Factory) newGraphicsModifier() (oci.SpecModifier, error) {\n\tdevices, reason := requiresGraphicsModifier(*f.image)\n\tif len(devices) == 0 {\n\t\tf.logger.Infof(\"No graphics modifier required; %v\", reason)\n\t\treturn nil, nil\n\t}\n\n\tmounts, err := discover.NewGraphicsMountsDiscoverer(\n\t\tf.logger,\n\t\tf.driver,\n\t\tf.hookCreator,\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create mounts discoverer: %v\", err)\n\t}\n\n\t// In standard usage, the devRoot is the same as the driver.Root.\n\tdevRoot := f.driver.Root\n\tdrmNodes, err := discover.NewDRMNodesDiscoverer(\n\t\tf.logger,\n\t\timage.NewVisibleDevices(devices...),\n\t\tdevRoot,\n\t\tf.hookCreator,\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to construct discoverer: %v\", err)\n\t}\n\n\td := discover.Merge(\n\t\tdrmNodes,\n\t\tmounts,\n\t)\n\treturn f.newModifierFromDiscoverer(d)\n}\n\n// requiresGraphicsModifier determines whether a graphics modifier is required.\nfunc requiresGraphicsModifier(cudaImage image.CUDA) ([]string, string) {\n\tdevices := cudaImage.VisibleDevices()\n\tif len(devices) == 0 {\n\t\treturn nil, \"no devices requested\"\n\t}\n\n\tif !cudaImage.GetDriverCapabilities().Any(image.DriverCapabilityGraphics, image.DriverCapabilityDisplay) {\n\t\treturn nil, \"no required capabilities requested\"\n\t}\n\n\treturn devices, \"\"\n}\n"
},
{
"path": "internal/modifier/graphics_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n)\n\nfunc TestGraphicsModifier(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tenvmap map[string]string\n\t\texpectedDevices []string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty image does not create modifier\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"devices with no capabilities does not create modifier\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"all\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"devices with no non-graphics does not create modifier\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"all\",\n\t\t\t\t\"NVIDIA_DRIVER_CAPABILITIES\": \"compute\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"devices with all capabilities creates modifier\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"all\",\n\t\t\t\t\"NVIDIA_DRIVER_CAPABILITIES\": \"all\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"all\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"devices with graphics capability creates modifier\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"all\",\n\t\t\t\t\"NVIDIA_DRIVER_CAPABILITIES\": \"graphics\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"all\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"devices with compute,graphics capability creates modifier\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"all\",\n\t\t\t\t\"NVIDIA_DRIVER_CAPABILITIES\": \"compute,graphics\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"all\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"devices with display capability creates modifier\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"all\",\n\t\t\t\t\"NVIDIA_DRIVER_CAPABILITIES\": \"display\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"all\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"devices with display,graphics capability creates modifier\",\n\t\t\tenvmap: map[string]string{\n\t\t\t\t\"NVIDIA_VISIBLE_DEVICES\": \"all\",\n\t\t\t\t\"NVIDIA_DRIVER_CAPABILITIES\": \"display,graphics\",\n\t\t\t},\n\t\t\texpectedDevices: []string{\"all\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\timage, _ := image.New(\n\t\t\t\timage.WithEnvMap(tc.envmap),\n\t\t\t)\n\t\t\trequired, _ := requiresGraphicsModifier(image)\n\t\t\trequire.EqualValues(t, tc.expectedDevices, required)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/modifier/hook_remover.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"path/filepath\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// nvidiaContainerRuntimeHookRemover is a spec modifer that detects and removes inserted nvidia-container-runtime hooks\ntype nvidiaContainerRuntimeHookRemover struct {\n\tlogger logger.Interface\n}\n\nvar _ oci.SpecModifier = (*nvidiaContainerRuntimeHookRemover)(nil)\n\n// newNvidiaContainerRuntimeHookRemover creates a modifier that removes any NVIDIA Container Runtime hooks from the provided spec.\nfunc (f *Factory) newNvidiaContainerRuntimeHookRemover() oci.SpecModifier {\n\treturn nvidiaContainerRuntimeHookRemover{\n\t\tlogger: f.logger,\n\t}\n}\n\n// Modify removes any NVIDIA Container Runtime hooks from the provided spec\nfunc (m nvidiaContainerRuntimeHookRemover) Modify(spec *specs.Spec) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\n\tif spec.Hooks == nil {\n\t\treturn nil\n\t}\n\n\tif len(spec.Hooks.Prestart) == 0 {\n\t\treturn nil\n\t}\n\n\tvar newPrestart []specs.Hook\n\n\tfor _, hook := range spec.Hooks.Prestart {\n\t\thook := hook\n\t\tif isNVIDIAContainerRuntimeHook(&hook) {\n\t\t\tm.logger.Debugf(\"Removing hook %v\", hook)\n\t\t\tcontinue\n\t\t}\n\t\tnewPrestart = append(newPrestart, hook)\n\t}\n\n\tif len(newPrestart) != len(spec.Hooks.Prestart) {\n\t\tm.logger.Debugf(\"Updating 'prestart' hooks to %v\", newPrestart)\n\t\tspec.Hooks.Prestart = newPrestart\n\t}\n\n\treturn nil\n}\n\n// isNVIDIAContainerRuntimeHook checks if the provided hook is an nvidia-container-runtime-hook\n// or nvidia-container-toolkit hook. These are included, for example, by the non-experimental\n// nvidia-container-runtime or docker when specifying the --gpus flag.\nfunc isNVIDIAContainerRuntimeHook(hook *specs.Hook) bool {\n\tbins := map[string]struct{}{\n\t\tconfig.NVIDIAContainerRuntimeHookExecutable: {},\n\t\tconfig.NVIDIAContainerToolkitExecutable: {},\n\t}\n\n\t_, exists := bins[filepath.Base(hook.Path)]\n\n\treturn exists\n}\n"
},
{
"path": "internal/modifier/hook_remover_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestHookRemover(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tspec *specs.Spec\n\t\texpectedError error\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"existing hooks are maintained\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/hook/a\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/a\", \"arga\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/hook/a\",\n\t\t\t\t\t\t\tArgs: []string{\"/hook/a\", \"arga\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"modification removes existing nvidia-container-runtime-hook\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-runtime-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-runtime-hook\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: nil,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"modification removes existing nvidia-container-toolkit\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-toolkit\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-toolkit\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: nil,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tm := nvidiaContainerRuntimeHookRemover{logger: logger}\n\n\t\t\terr := m.Modify(tc.spec)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, tc.spec)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/modifier/list.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage modifier\n\nimport (\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\ntype list []oci.SpecModifier\n\n// Modify applies a list of modifiers in sequence and returns on any errors encountered.\nfunc (m list) Modify(spec *specs.Spec) error {\n\tfor _, mm := range m {\n\t\tif mm == nil {\n\t\t\tcontinue\n\t\t}\n\t\terr := mm.Modify(spec)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n"
},
{
"path": "internal/modifier/mode.go",
"content": "package modifier\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// newModeModifier creates a modifier for the configure runtime mode.\nfunc (f *Factory) newModeModifier() (oci.SpecModifier, error) {\n\tswitch f.runtimeMode {\n\tcase info.LegacyRuntimeMode:\n\t\treturn f.newStableRuntimeModifier(), nil\n\tcase info.CSVRuntimeMode:\n\t\treturn f.newCSVModifier()\n\tcase info.CDIRuntimeMode, info.JitCDIRuntimeMode:\n\t\treturn f.newCDIModifier(f.runtimeMode == info.JitCDIRuntimeMode)\n\t}\n\treturn nil, fmt.Errorf(\"invalid runtime mode: %v\", f.runtimeMode)\n}\n\n// supportedModifierTypes returns the modifiers supported for a specific runtime mode.\nfunc supportedModifierTypes(mode info.RuntimeMode) []string {\n\tswitch mode {\n\tcase info.CDIRuntimeMode, info.JitCDIRuntimeMode:\n\t\t// For CDI mode we make no additional modifications.\n\t\treturn []string{\"nvidia-hook-remover\", \"mode\"}\n\tcase info.CSVRuntimeMode:\n\t\t// For CSV mode we support mode and feature-gated modification.\n\t\treturn []string{\"nvidia-hook-remover\", \"feature-gated\", \"mode\"}\n\tdefault:\n\t\treturn []string{\"feature-gated\", \"graphics\", \"mode\"}\n\t}\n}\n"
},
{
"path": "internal/modifier/stable.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage modifier\n\nimport (\n\t\"path/filepath\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// newStableRuntimeModifier creates an OCI spec modifier that inserts the NVIDIA Container Runtime Hook into an OCI\n// spec. The specified logger is used to capture log output.\nfunc (f *Factory) newStableRuntimeModifier() oci.SpecModifier {\n\tm := stableRuntimeModifier{\n\t\tlogger: f.logger,\n\t\tnvidiaContainerRuntimeHookPath: f.cfg.NVIDIAContainerRuntimeHookConfig.Path,\n\t}\n\n\treturn &m\n}\n\n// stableRuntimeModifier modifies an OCI spec inplace, inserting the nvidia-container-runtime-hook as a\n// prestart hook. If the hook is already present, no modification is made.\ntype stableRuntimeModifier struct {\n\tlogger logger.Interface\n\tnvidiaContainerRuntimeHookPath string\n}\n\n// Modify applies the required modification to the incoming OCI spec, inserting the nvidia-container-runtime-hook\n// as a prestart hook.\nfunc (m stableRuntimeModifier) Modify(spec *specs.Spec) error {\n\t// If an NVIDIA Container Runtime Hook already exists, we don't make any modifications to the spec.\n\tif spec.Hooks != nil {\n\t\tfor _, hook := range spec.Hooks.Prestart {\n\t\t\thook := hook\n\t\t\tif isNVIDIAContainerRuntimeHook(&hook) {\n\t\t\t\tm.logger.Infof(\"Existing nvidia prestart hook (%v) found in OCI spec\", hook.Path)\n\t\t\t\treturn nil\n\t\t\t}\n\t\t}\n\t}\n\n\tpath := m.nvidiaContainerRuntimeHookPath\n\tm.logger.Infof(\"Using prestart hook path: %v\", path)\n\targs := []string{filepath.Base(path)}\n\tif spec.Hooks == nil {\n\t\tspec.Hooks = &specs.Hooks{}\n\t}\n\tspec.Hooks.Prestart = append(spec.Hooks.Prestart, specs.Hook{\n\t\tPath: path,\n\t\tArgs: append(args, \"prestart\"),\n\t})\n\n\treturn nil\n}\n"
},
{
"path": "internal/modifier/stable_test.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage modifier\n\nimport (\n\t\"log\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\ntype testConfig struct {\n\troot string\n\tbinPath string\n}\n\nvar cfg *testConfig\n\nfunc TestMain(m *testing.M) {\n\t// TEST SETUP\n\t// Determine the module root and the test binary path\n\tvar err error\n\tmoduleRoot, err := test.GetModuleRoot()\n\tif err != nil {\n\t\tlog.Fatalf(\"error in test setup: could not get module root: %v\", err)\n\t}\n\ttestBinPath := filepath.Join(moduleRoot, \"test\", \"bin\")\n\n\t// Set the environment variables for the test\n\tos.Setenv(\"PATH\", test.PrependToPath(testBinPath, moduleRoot))\n\n\t// Store the root and binary paths in the test Config\n\tcfg = &testConfig{\n\t\troot: moduleRoot,\n\t\tbinPath: testBinPath,\n\t}\n\n\t// RUN TESTS\n\texitCode := m.Run()\n\n\tos.Exit(exitCode)\n}\n\nfunc TestAddHookModifier(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestHookPath := filepath.Join(cfg.binPath, \"nvidia-container-runtime-hook\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tspec specs.Spec\n\t\texpectedError error\n\t\texpectedSpec specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"empty spec adds hook\",\n\t\t\tspec: specs.Spec{},\n\t\t\texpectedSpec: specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: testHookPath,\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-container-runtime-hook\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"spec with empty hooks adds hook\",\n\t\t\tspec: specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{},\n\t\t\t},\n\t\t\texpectedSpec: specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: testHookPath,\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-container-runtime-hook\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"hook is not replaced\",\n\t\t\tspec: specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"nvidia-container-runtime-hook\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"nvidia-container-runtime-hook\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"other hooks are not replaced\",\n\t\t\tspec: specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"some-hook\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"some-hook\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: testHookPath,\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-container-runtime-hook\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tcfg := &config.Config{}\n\tcfg.NVIDIAContainerRuntimeHookConfig.Path = testHookPath\n\tfactory := createFactory(\n\t\tWithLogger(logger),\n\t\tWithConfig(cfg),\n\t)\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tm := factory.newStableRuntimeModifier()\n\n\t\t\terr := m.Modify(&tc.spec)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, tc.spec)\n\t\t})\n\t}\n\n}\n"
},
{
"path": "internal/nvcaps/nvcaps.go",
"content": "/*\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage nvcaps\n\nimport (\n\t\"bufio\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n)\n\nconst (\n\tnvidiaProcDriverPath = \"/proc/driver/nvidia\"\n\tnvidiaCapabilitiesPath = nvidiaProcDriverPath + \"/capabilities\"\n\n\tnvcapsProcDriverPath = \"/proc/driver/nvidia-caps\"\n\tnvcapsMigMinorsPath = nvcapsProcDriverPath + \"/mig-minors\"\n\tnvcapsDevicePath = \"/dev/nvidia-caps\"\n)\n\n// MigMinor represents the minor number of a MIG device\ntype MigMinor int\n\n// MigCap represents the path to a MIG cap file\ntype MigCap string\n\n// MigCaps stores a map of MIG cap file paths to MIG minors\ntype MigCaps map[MigCap]MigMinor\n\n// NewGPUInstanceCap creates a MigCap for the specified MIG GPU instance.\n// A GPU instance is uniquely defined by the GPU minor number and GI instance ID.\nfunc NewGPUInstanceCap(gpu, gi int) MigCap {\n\treturn MigCap(fmt.Sprintf(\"gpu%d/gi%d/access\", gpu, gi))\n}\n\n// NewComputeInstanceCap creates a MigCap for the specified MIG Compute instance.\n// A GPU instance is uniquely defined by the GPU minor number, GI instance ID, and CI instance ID.\nfunc NewComputeInstanceCap(gpu, gi, ci int) MigCap {\n\treturn MigCap(fmt.Sprintf(\"gpu%d/gi%d/ci%d/access\", gpu, gi, ci))\n}\n\n// GetCapDevicePath returns the path to the cap device for the specified cap.\n// An error is returned if the cap is invalid.\nfunc (m MigCaps) GetCapDevicePath(cap MigCap) (string, error) {\n\tminor, exists := m[cap]\n\tif !exists {\n\t\treturn \"\", fmt.Errorf(\"invalid MIG capability path %v\", cap)\n\t}\n\treturn minor.DevicePath(), nil\n}\n\n// NewMigCaps creates a MigCaps structure based on the contents of the MIG minors file.\nfunc NewMigCaps() (MigCaps, error) {\n\t// Open nvcapsMigMinorsPath for walking.\n\t// If the nvcapsMigMinorsPath does not exist, then we are not on a MIG\n\t// capable machine, so there is nothing to do.\n\t// The format of this file is discussed in:\n\t// https://docs.nvidia.com/datacenter/tesla/mig-user-guide/index.html#unique_1576522674\n\tminorsFile, err := os.Open(nvcapsMigMinorsPath)\n\tif os.IsNotExist(err) {\n\t\treturn nil, nil\n\t}\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error opening MIG minors file: %v\", err)\n\t}\n\tdefer minorsFile.Close()\n\n\treturn processMinorsFile(minorsFile), nil\n}\n\nfunc processMinorsFile(minorsFile io.Reader) MigCaps {\n\t// Walk each line of nvcapsMigMinorsPath and construct a mapping of nvidia\n\t// capabilities path to device minor for that capability\n\tmigCaps := make(MigCaps)\n\tscanner := bufio.NewScanner(minorsFile)\n\tfor scanner.Scan() {\n\t\tcap, minor, err := processMigMinorsLine(scanner.Text())\n\t\tif err != nil {\n\t\t\tlog.Printf(\"Skipping line in MIG minors file: %v\", err)\n\t\t\tcontinue\n\t\t}\n\t\tmigCaps[cap] = minor\n\t}\n\treturn migCaps\n}\n\nfunc processMigMinorsLine(line string) (MigCap, MigMinor, error) {\n\tparts := strings.Split(line, \" \")\n\tif len(parts) != 2 {\n\t\treturn \"\", 0, fmt.Errorf(\"error processing line: %v\", line)\n\t}\n\n\tmigCap := MigCap(parts[0])\n\tif !migCap.isValid() {\n\t\treturn \"\", 0, fmt.Errorf(\"invalid MIG minors line: '%v'\", line)\n\t}\n\n\tminor, err := strconv.Atoi(parts[1])\n\tif err != nil {\n\t\treturn \"\", 0, fmt.Errorf(\"error reading MIG minor from '%v': %v\", line, err)\n\t}\n\n\treturn migCap, MigMinor(minor), nil\n}\n\nfunc (m MigCap) isValid() bool {\n\tcap := string(m)\n\tswitch cap {\n\tcase \"config\", \"monitor\":\n\t\treturn true\n\tdefault:\n\t\tvar gpu int\n\t\tvar gi int\n\t\tvar ci int\n\t\t// Look for a CI access file\n\t\tn, _ := fmt.Sscanf(cap, \"gpu%d/gi%d/ci%d/access\", &gpu, &gi, &ci)\n\t\tif n == 3 {\n\t\t\treturn true\n\t\t}\n\t\t// Look for a GI access file\n\t\tn, _ = fmt.Sscanf(cap, \"gpu%d/gi%d/access %d\", &gpu, &gi)\n\t\tif n == 2 {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\n// ProcPath returns the proc path associated with the MIG capability\nfunc (m MigCap) ProcPath() string {\n\tid := string(m)\n\n\tvar path string\n\tswitch id {\n\tcase \"config\", \"monitor\":\n\t\tpath = \"mig/\" + id\n\tdefault:\n\t\tparts := strings.SplitN(id, \"/\", 2)\n\t\tpath = strings.Join([]string{parts[0], \"mig\", parts[1]}, \"/\")\n\t}\n\treturn filepath.Join(nvidiaCapabilitiesPath, path)\n}\n\n// DevicePath returns the path for the nvidia-caps device with the specified\n// minor number\nfunc (m MigMinor) DevicePath() string {\n\treturn fmt.Sprintf(nvcapsDevicePath+\"/nvidia-cap%d\", m)\n}\n"
},
{
"path": "internal/nvcaps/nvcaps_test.go",
"content": "/*\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage nvcaps\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestProcessMinorsFile(t *testing.T) {\n\ttestCases := []struct {\n\t\tlines []string\n\t\texpected MigCaps\n\t}{\n\t\t{[]string{}, MigCaps{}},\n\t\t{[]string{\"invalidLine\"}, MigCaps{}},\n\t\t{[]string{\"config 1\"}, MigCaps{\"config\": 1}},\n\t\t{[]string{\"gpu0/gi0/ci0/access 4\"}, MigCaps{\"gpu0/gi0/ci0/access\": 4}},\n\t\t{[]string{\"config 1\", \"invalidLine\"}, MigCaps{\"config\": 1}},\n\t\t{[]string{\"config 1\", \"gpu0/gi0/ci0/access 4\"}, MigCaps{\"config\": 1, \"gpu0/gi0/ci0/access\": 4}},\n\t}\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"testcase %d\", i), func(t *testing.T) {\n\t\t\tcontents := strings.NewReader(strings.Join(tc.lines, \"\\n\"))\n\t\t\td := processMinorsFile(contents)\n\t\t\trequire.Equal(t, tc.expected, d)\n\t\t})\n\t}\n}\n\nfunc TestProcessMigMinorsLine(t *testing.T) {\n\ttestCases := []struct {\n\t\tline string\n\t\tcap MigCap\n\t\tminor MigMinor\n\t\terr bool\n\t}{\n\t\t{\"config 1\", \"config\", 1, false},\n\t\t{\"monitor 2\", \"monitor\", 2, false},\n\t\t{\"gpu0/gi0/access 3\", \"gpu0/gi0/access\", 3, false},\n\t\t{\"gpu0/gi0/ci0/access 4\", \"gpu0/gi0/ci0/access\", 4, false},\n\t\t{\"notconfig 99\", \"\", 0, true},\n\t\t{\"config notanint\", \"\", 0, true},\n\t\t{\"\", \"\", 0, true},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"testcase %d\", i), func(t *testing.T) {\n\t\t\tcap, minor, err := processMigMinorsLine(tc.line)\n\n\t\t\trequire.Equal(t, tc.cap, cap)\n\t\t\trequire.Equal(t, tc.minor, minor)\n\t\t\tif tc.err {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestMigCapProcPaths(t *testing.T) {\n\ttestCases := []struct {\n\t\tinput string\n\t\texpected string\n\t}{\n\t\t{\"config\", \"/proc/driver/nvidia/capabilities/mig/config\"},\n\t\t{\"monitor\", \"/proc/driver/nvidia/capabilities/mig/monitor\"},\n\t\t{\"gpu0/gi0/access\", \"/proc/driver/nvidia/capabilities/gpu0/mig/gi0/access\"},\n\t\t{\"gpu0/gi0/ci0/access\", \"/proc/driver/nvidia/capabilities/gpu0/mig/gi0/ci0/access\"},\n\t}\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"testcase %d\", i), func(t *testing.T) {\n\t\t\tm := MigCap(tc.input)\n\t\t\trequire.Equal(t, tc.expected, m.ProcPath())\n\t\t})\n\t}\n}\n\nfunc TestMigMinorDevicePath(t *testing.T) {\n\tm := MigMinor(0)\n\trequire.Equal(t, \"/dev/nvidia-caps/nvidia-cap0\", m.DevicePath())\n}\n"
},
{
"path": "internal/nvsandboxutils/api.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\n// libraryOptions hold the parameters than can be set by a LibraryOption\ntype libraryOptions struct {\n\tpath string\n\tflags int\n}\n\n// LibraryOption represents a functional option to configure the underlying nvsandboxutils library\ntype LibraryOption func(*libraryOptions)\n\n// WithLibraryPath provides an option to set the library name to be used by the nvsandboxutils library.\nfunc WithLibraryPath(path string) LibraryOption {\n\treturn func(o *libraryOptions) {\n\t\to.path = path\n\t}\n}\n\n// SetLibraryOptions applies the specified options to the nvsandboxutils library.\n// If this is called when a library is already loaded, an error is raised.\nfunc SetLibraryOptions(opts ...LibraryOption) error {\n\tlibnvsandboxutils.Lock()\n\tdefer libnvsandboxutils.Unlock()\n\tif libnvsandboxutils.refcount != 0 {\n\t\treturn errLibraryAlreadyLoaded\n\t}\n\tlibnvsandboxutils.init(opts...)\n\treturn nil\n}\n"
},
{
"path": "internal/nvsandboxutils/cgo_helpers.h",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\n// WARNING: THIS FILE WAS AUTOMATICALLY GENERATED.\n// Code generated by https://git.io/c-for-go. DO NOT EDIT.\n\n#include \"nvsandboxutils.h\"\n#include \n#pragma once\n\n#define __CGOGEN 1\n\n"
},
{
"path": "internal/nvsandboxutils/cgo_helpers_static.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\nvar cgoAllocsUnknown = new(struct{})\n\nfunc clen(n []byte) int {\n\tfor i := 0; i < len(n); i++ {\n\t\tif n[i] == 0 {\n\t\t\treturn i\n\t\t}\n\t}\n\treturn len(n)\n}\n\n// Creates an int8 array of fixed input length to store the Go string.\n// TODO: Add error check if input string has a length greater than INPUT_LENGTH\nfunc convertStringToFixedArray(str string) [INPUT_LENGTH]int8 {\n\tvar output [INPUT_LENGTH]int8\n\tfor i, s := range str {\n\t\toutput[i] = int8(s)\n\t}\n\treturn output\n}\n"
},
{
"path": "internal/nvsandboxutils/const.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\n// WARNING: THIS FILE WAS AUTOMATICALLY GENERATED.\n// Code generated by https://git.io/c-for-go. DO NOT EDIT.\n\npackage nvsandboxutils\n\n/*\n#cgo linux LDFLAGS: -Wl,--export-dynamic -Wl,--unresolved-symbols=ignore-in-object-files\n#cgo darwin LDFLAGS: -Wl,-undefined,dynamic_lookup\n#include \"nvsandboxutils.h\"\n#include \n#include \"cgo_helpers.h\"\n*/\nimport \"C\"\n\nconst (\n\t// INPUT_LENGTH as defined in nvsandboxutils/nvsandboxutils.h\n\tINPUT_LENGTH = 256\n\t// MAX_FILE_PATH as defined in nvsandboxutils/nvsandboxutils.h\n\tMAX_FILE_PATH = 256\n\t// MAX_NAME_LENGTH as defined in nvsandboxutils/nvsandboxutils.h\n\tMAX_NAME_LENGTH = 256\n)\n\n// Ret as declared in nvsandboxutils/nvsandboxutils.h\ntype Ret int32\n\n// Ret enumeration from nvsandboxutils/nvsandboxutils.h\nconst (\n\tSUCCESS Ret = iota\n\tERROR_UNINITIALIZED Ret = 1\n\tERROR_NOT_SUPPORTED Ret = 2\n\tERROR_INVALID_ARG Ret = 3\n\tERROR_INSUFFICIENT_SIZE Ret = 4\n\tERROR_VERSION_NOT_SUPPORTED Ret = 5\n\tERROR_LIBRARY_LOAD Ret = 6\n\tERROR_FUNCTION_NOT_FOUND Ret = 7\n\tERROR_DEVICE_NOT_FOUND Ret = 8\n\tERROR_NVML_LIB_CALL Ret = 9\n\tERROR_OUT_OF_MEMORY Ret = 10\n\tERROR_FILEPATH_NOT_FOUND Ret = 11\n\tERROR_UNKNOWN Ret = 65535\n)\n\n// LogLevel as declared in nvsandboxutils/nvsandboxutils.h\ntype LogLevel int32\n\n// LogLevel enumeration from nvsandboxutils/nvsandboxutils.h\nconst (\n\tLOG_LEVEL_FATAL LogLevel = iota\n\tLOG_LEVEL_ERROR LogLevel = 1\n\tLOG_LEVEL_WARN LogLevel = 2\n\tLOG_LEVEL_DEBUG LogLevel = 3\n\tLOG_LEVEL_INFO LogLevel = 4\n\tLOG_LEVEL_NONE LogLevel = 65535\n)\n\n// RootfsInputType as declared in nvsandboxutils/nvsandboxutils.h\ntype RootfsInputType int32\n\n// RootfsInputType enumeration from nvsandboxutils/nvsandboxutils.h\nconst (\n\tNV_ROOTFS_DEFAULT RootfsInputType = iota\n\tNV_ROOTFS_PATH RootfsInputType = 1\n\tNV_ROOTFS_PID RootfsInputType = 2\n)\n\n// FileType as declared in nvsandboxutils/nvsandboxutils.h\ntype FileType int32\n\n// FileType enumeration from nvsandboxutils/nvsandboxutils.h\nconst (\n\tNV_DEV FileType = iota\n\tNV_PROC FileType = 1\n\tNV_SYS FileType = 2\n)\n\n// FileSystemSubType as declared in nvsandboxutils/nvsandboxutils.h\ntype FileSystemSubType int32\n\n// FileSystemSubType enumeration from nvsandboxutils/nvsandboxutils.h\nconst (\n\tNV_DEV_NVIDIA FileSystemSubType = iota\n\tNV_DEV_DRI_CARD FileSystemSubType = 1\n\tNV_DEV_DRI_RENDERD FileSystemSubType = 2\n\tNV_DEV_DRI_CARD_SYMLINK FileSystemSubType = 3\n\tNV_DEV_DRI_RENDERD_SYMLINK FileSystemSubType = 4\n\tNV_DEV_NVIDIA_UVM FileSystemSubType = 5\n\tNV_DEV_NVIDIA_UVM_TOOLS FileSystemSubType = 6\n\tNV_DEV_NVIDIA_MODESET FileSystemSubType = 7\n\tNV_DEV_NVIDIA_CTL FileSystemSubType = 8\n\tNV_DEV_GDRDRV FileSystemSubType = 9\n\tNV_DEV_NVIDIA_CAPS_NVIDIA_CAP FileSystemSubType = 10\n\tNV_PROC_DRIVER_NVIDIA_GPUS_PCIBUSID FileSystemSubType = 11\n\tNV_PROC_DRIVER_NVIDIA_GPUS FileSystemSubType = 12\n\tNV_PROC_NVIDIA_PARAMS FileSystemSubType = 13\n\tNV_PROC_NVIDIA_CAPS_MIG_MINORS FileSystemSubType = 14\n\tNV_PROC_DRIVER_NVIDIA_CAPABILITIES_GPU FileSystemSubType = 15\n\tNV_PROC_DRIVER_NVIDIA_CAPABILITIES FileSystemSubType = 16\n\tNV_PROC_DRIVER_NVIDIA_CAPABILITIIES_GPU_MIG_CI_ACCESS FileSystemSubType = 17\n\tNV_SYS_MODULE_NVIDIA_DRIVER_PCIBUSID FileSystemSubType = 18\n\tNV_SYS_MODULE_NVIDIA_DRIVER FileSystemSubType = 19\n\tNV_NUM_SUBTYPE FileSystemSubType = 20\n)\n\n// FileModule as declared in nvsandboxutils/nvsandboxutils.h\ntype FileModule int32\n\n// FileModule enumeration from nvsandboxutils/nvsandboxutils.h\nconst (\n\tNV_GPU FileModule = iota\n\tNV_MIG FileModule = 1\n\tNV_DRIVER_NVIDIA FileModule = 2\n\tNV_DRIVER_NVIDIA_UVM FileModule = 3\n\tNV_DRIVER_NVIDIA_MODESET FileModule = 4\n\tNV_DRIVER_GDRDRV FileModule = 5\n\tNV_SYSTEM FileModule = 6\n)\n\n// FileFlag as declared in nvsandboxutils/nvsandboxutils.h\ntype FileFlag int32\n\n// FileFlag enumeration from nvsandboxutils/nvsandboxutils.h\nconst (\n\tNV_FILE_FLAG_HINT FileFlag = 1\n\tNV_FILE_FLAG_MASKOUT FileFlag = 2\n\tNV_FILE_FLAG_CONTENT FileFlag = 4\n\tNV_FILE_FLAG_DEPRECTATED FileFlag = 8\n\tNV_FILE_FLAG_CANDIDATES FileFlag = 16\n)\n\n// GpuInputType as declared in nvsandboxutils/nvsandboxutils.h\ntype GpuInputType int32\n\n// GpuInputType enumeration from nvsandboxutils/nvsandboxutils.h\nconst (\n\tNV_GPU_INPUT_GPU_UUID GpuInputType = iota\n\tNV_GPU_INPUT_MIG_UUID GpuInputType = 1\n\tNV_GPU_INPUT_PCI_ID GpuInputType = 2\n\tNV_GPU_INPUT_PCI_INDEX GpuInputType = 3\n)\n"
},
{
"path": "internal/nvsandboxutils/doc.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\n// WARNING: THIS FILE WAS AUTOMATICALLY GENERATED.\n// Code generated by https://git.io/c-for-go. DO NOT EDIT.\n\n/*\nPackage NVSANDBOXUTILS bindings\n*/\npackage nvsandboxutils\n"
},
{
"path": "internal/nvsandboxutils/dynamicLibrary_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage nvsandboxutils\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that dynamicLibraryMock does implement dynamicLibrary.\n// If this is not the case, regenerate this file with moq.\nvar _ dynamicLibrary = &dynamicLibraryMock{}\n\n// dynamicLibraryMock is a mock implementation of dynamicLibrary.\n//\n//\tfunc TestSomethingThatUsesdynamicLibrary(t *testing.T) {\n//\n//\t\t// make and configure a mocked dynamicLibrary\n//\t\tmockeddynamicLibrary := &dynamicLibraryMock{\n//\t\t\tCloseFunc: func() error {\n//\t\t\t\tpanic(\"mock out the Close method\")\n//\t\t\t},\n//\t\t\tLookupFunc: func(s string) error {\n//\t\t\t\tpanic(\"mock out the Lookup method\")\n//\t\t\t},\n//\t\t\tOpenFunc: func() error {\n//\t\t\t\tpanic(\"mock out the Open method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockeddynamicLibrary in code that requires dynamicLibrary\n//\t\t// and then make assertions.\n//\n//\t}\ntype dynamicLibraryMock struct {\n\t// CloseFunc mocks the Close method.\n\tCloseFunc func() error\n\n\t// LookupFunc mocks the Lookup method.\n\tLookupFunc func(s string) error\n\n\t// OpenFunc mocks the Open method.\n\tOpenFunc func() error\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Close holds details about calls to the Close method.\n\t\tClose []struct {\n\t\t}\n\t\t// Lookup holds details about calls to the Lookup method.\n\t\tLookup []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// Open holds details about calls to the Open method.\n\t\tOpen []struct {\n\t\t}\n\t}\n\tlockClose sync.RWMutex\n\tlockLookup sync.RWMutex\n\tlockOpen sync.RWMutex\n}\n\n// Close calls CloseFunc.\nfunc (mock *dynamicLibraryMock) Close() error {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockClose.Lock()\n\tmock.calls.Close = append(mock.calls.Close, callInfo)\n\tmock.lockClose.Unlock()\n\tif mock.CloseFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.CloseFunc()\n}\n\n// CloseCalls gets all the calls that were made to Close.\n// Check the length with:\n//\n//\tlen(mockeddynamicLibrary.CloseCalls())\nfunc (mock *dynamicLibraryMock) CloseCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockClose.RLock()\n\tcalls = mock.calls.Close\n\tmock.lockClose.RUnlock()\n\treturn calls\n}\n\n// Lookup calls LookupFunc.\nfunc (mock *dynamicLibraryMock) Lookup(s string) error {\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockLookup.Lock()\n\tmock.calls.Lookup = append(mock.calls.Lookup, callInfo)\n\tmock.lockLookup.Unlock()\n\tif mock.LookupFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.LookupFunc(s)\n}\n\n// LookupCalls gets all the calls that were made to Lookup.\n// Check the length with:\n//\n//\tlen(mockeddynamicLibrary.LookupCalls())\nfunc (mock *dynamicLibraryMock) LookupCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockLookup.RLock()\n\tcalls = mock.calls.Lookup\n\tmock.lockLookup.RUnlock()\n\treturn calls\n}\n\n// Open calls OpenFunc.\nfunc (mock *dynamicLibraryMock) Open() error {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockOpen.Lock()\n\tmock.calls.Open = append(mock.calls.Open, callInfo)\n\tmock.lockOpen.Unlock()\n\tif mock.OpenFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.OpenFunc()\n}\n\n// OpenCalls gets all the calls that were made to Open.\n// Check the length with:\n//\n//\tlen(mockeddynamicLibrary.OpenCalls())\nfunc (mock *dynamicLibraryMock) OpenCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockOpen.RLock()\n\tcalls = mock.calls.Open\n\tmock.lockOpen.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/nvsandboxutils/gen/generate-bindings.sh",
"content": "#!/bin/bash\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This file generates bindings for nvsandboxutils by calling c-for-go.\n\nset -x -e\n\nPWD=$(pwd)\nGEN_DIR=\"$PWD/gen\"\nPKG_DIR=\"$PWD\"\nGEN_BINDINGS_DIR=\"$GEN_DIR/nvsandboxutils\"\nPKG_BINDINGS_DIR=\"$PKG_DIR\"\n\nSOURCES=$(find \"$GEN_BINDINGS_DIR\" -type f)\n\nmkdir -p \"$PKG_BINDINGS_DIR\"\n\ncp \"$GEN_BINDINGS_DIR/nvsandboxutils.h\" \"$PKG_BINDINGS_DIR/nvsandboxutils.h\"\nspatch --in-place --very-quiet --sp-file \"$GEN_BINDINGS_DIR/anonymous_structs.cocci\" \"$PKG_BINDINGS_DIR/nvsandboxutils.h\" > /dev/null\n\necho \"Generating the bindings...\"\nc-for-go -out \"$PKG_DIR/..\" \"$GEN_BINDINGS_DIR/nvsandboxutils.yml\"\ncd \"$PKG_BINDINGS_DIR\"\ngo tool cgo -godefs types.go > types_gen.go\ngo fmt types_gen.go\ncd - > /dev/null\nrm -rf \"$PKG_BINDINGS_DIR/cgo_helpers.go\" \"$PKG_BINDINGS_DIR/types.go\" \"$PKG_BINDINGS_DIR/_obj\"\ngo run \"$GEN_BINDINGS_DIR/generateapi.go\" --sourceDir \"$PKG_BINDINGS_DIR\" --output \"$PKG_BINDINGS_DIR/zz_generated.api.go\"\n# go fmt \"$PKG_BINDINGS_DIR\"\n\nSED_SEARCH_STRING='// WARNING: This file has automatically been generated on'\nSED_REPLACE_STRING='// WARNING: THIS FILE WAS AUTOMATICALLY GENERATED.'\ngrep -l -R \"$SED_SEARCH_STRING\" \"$PKG_DIR\" | grep -v \"/gen/\" | xargs sed -i -E \"s#$SED_SEARCH_STRING.*\\$#$SED_REPLACE_STRING#g\"\n\nSED_SEARCH_STRING='// (.*) nvsandboxutils/nvsandboxutils.h:[0-9]+'\nSED_REPLACE_STRING='// \\1 nvsandboxutils/nvsandboxutils.h'\ngrep -l -RE \"$SED_SEARCH_STRING\" \"$PKG_DIR\" | grep -v \"/gen/\" | xargs sed -i -E \"s#$SED_SEARCH_STRING\\$#$SED_REPLACE_STRING#g\"\n\n"
},
{
"path": "internal/nvsandboxutils/gen/nvsandboxutils/anonymous_structs.cocci",
"content": "@patch@\ntype WRAPPER_TYPE;\nfield list FIELDS;\nidentifier V;\nexpression E;\nfresh identifier ST = \"nvSandboxUtilsGenerated_struct___\";\nfresh identifier TEMP_VAR = \"nvSandboxUtilsGenerated_variable___\" ## V;\n@@\n\n++ struct ST {\n++ WRAPPER_TYPE TEMP_VAR;\n++ FIELDS\n++ };\n+\n\nWRAPPER_TYPE\n{\n ...\n(\n- struct {\n- FIELDS\n- } V[E];\n+ struct ST V[E];\n\n|\n\n- struct {\n- FIELDS\n- } V;\n+ struct ST V;\n)\n ...\n};\n\n@capture@\ntype WRAPPER_TYPE;\nidentifier TEMP_VAR;\nidentifier ST =~ \"^nvSandboxUtilsGenerated_struct___\";\n@@\n\nstruct ST {\n WRAPPER_TYPE TEMP_VAR;\n ...\n};\n\n@script:python concat@\nWRAPPER_TYPE << capture.WRAPPER_TYPE;\nTEMP_VAR << capture.TEMP_VAR;\nST << capture.ST;\nT;\n@@\n\ndef removePrefix(string, prefix):\n if string.startswith(prefix):\n return string[len(prefix):]\n return string\n\ndef removeSuffix(string, suffix):\n if string.endswith(suffix):\n return string[:-len(suffix)]\n return string\n\nWRAPPER_TYPE = removeSuffix(WRAPPER_TYPE, \"_t\")\nTEMP_VAR = removePrefix(TEMP_VAR, \"nvSandboxUtilsGenerated_variable___\")\ncoccinelle.T = cocci.make_type(WRAPPER_TYPE + TEMP_VAR[0].upper() + TEMP_VAR[1:] + \"_t\")\n\n@add_typedef@\nidentifier capture.ST;\ntype concat.T;\ntype WRAPPER_TYPE;\nidentifier TEMP_VAR;\n@@\n\n- struct ST {\n+ typedef struct {\n- WRAPPER_TYPE TEMP_VAR;\n ...\n- };\n+ } T;\n\n@update@\nidentifier capture.ST;\ntype concat.T;\nidentifier V;\nexpression E;\ntype WRAPPER_TYPE;\n@@\n\nWRAPPER_TYPE\n{\n ...\n(\n- struct ST V[E];\n+ T V[E];\n|\n- struct ST V;\n+ T V;\n)\n ...\n};\n"
},
{
"path": "internal/nvsandboxutils/gen/nvsandboxutils/generateapi.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage main\n\nimport (\n\t\"flag\"\n\t\"fmt\"\n\t\"go/ast\"\n\t\"go/parser\"\n\t\"go/token\"\n\t\"io\"\n\t\"io/fs\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"slices\"\n\t\"sort\"\n\t\"strings\"\n\t\"unicode\"\n)\n\ntype GeneratableInterfacePoperties struct {\n\tType string\n\tInterface string\n\tExclude []string\n\tPackageMethodsAliasedFrom string\n}\n\nvar GeneratableInterfaces = []GeneratableInterfacePoperties{\n\t{\n\t\tType: \"library\",\n\t\tInterface: \"Interface\",\n\t\tPackageMethodsAliasedFrom: \"libnvsandboxutils\",\n\t},\n}\n\nfunc main() {\n\tsourceDir := flag.String(\"sourceDir\", \"\", \"Path to the source directory for all go files\")\n\toutput := flag.String(\"output\", \"\", \"Path to the output file (default: stdout)\")\n\tflag.Parse()\n\n\t// Check if required flags are provided\n\tif *sourceDir == \"\" {\n\t\tflag.Usage()\n\t\treturn\n\t}\n\n\twriter, closer, err := getWriter(*output)\n\tif err != nil {\n\t\tfmt.Printf(\"Error: %v\", err)\n\t\treturn\n\t}\n\tdefer func() {\n\t\t_ = closer()\n\t}()\n\n\theader, err := generateHeader()\n\tif err != nil {\n\t\tfmt.Printf(\"Error: %v\", err)\n\t\treturn\n\t}\n\tfmt.Fprint(writer, header)\n\n\tfor i, p := range GeneratableInterfaces {\n\t\tif p.PackageMethodsAliasedFrom != \"\" {\n\t\t\tcomment, err := generatePackageMethodsComment(p)\n\t\t\tif err != nil {\n\t\t\t\tfmt.Printf(\"Error: %v\", err)\n\t\t\t\treturn\n\t\t\t}\n\t\t\tfmt.Fprint(writer, comment)\n\n\t\t\toutput, err := generatePackageMethods(*sourceDir, p)\n\t\t\tif err != nil {\n\t\t\t\tfmt.Printf(\"Error: %v\", err)\n\t\t\t\treturn\n\t\t\t}\n\t\t\tfmt.Fprintf(writer, \"%s\\n\", output)\n\t\t}\n\n\t\tcomment, err := generateInterfaceComment(p)\n\t\tif err != nil {\n\t\t\tfmt.Printf(\"Error: %v\", err)\n\t\t\treturn\n\t\t}\n\t\tfmt.Fprint(writer, comment)\n\n\t\toutput, err := generateInterface(*sourceDir, p)\n\t\tif err != nil {\n\t\t\tfmt.Printf(\"Error: %v\", err)\n\t\t\treturn\n\t\t}\n\t\tfmt.Fprint(writer, output)\n\n\t\tif i < (len(GeneratableInterfaces) - 1) {\n\t\t\tfmt.Fprint(writer, \"\\n\")\n\t\t}\n\t}\n}\n\nfunc getWriter(outputFile string) (io.Writer, func() error, error) {\n\tif outputFile == \"\" {\n\t\treturn os.Stdout, func() error { return nil }, nil\n\t}\n\n\tfile, err := os.Create(outputFile)\n\tif err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\treturn file, file.Close, nil\n}\n\nfunc generateHeader() (string, error) {\n\tlines := []string{\n\t\t\"/**\",\n\t\t\"# Copyright 2024 NVIDIA CORPORATION\",\n\t\t\"#\",\n\t\t\"# Licensed under the Apache License, Version 2.0 (the \\\"License\\\");\",\n\t\t\"# you may not use this file except in compliance with the License.\",\n\t\t\"# You may obtain a copy of the License at\",\n\t\t\"#\",\n\t\t\"# http://www.apache.org/licenses/LICENSE-2.0\",\n\t\t\"#\",\n\t\t\"# Unless required by applicable law or agreed to in writing, software\",\n\t\t\"# distributed under the License is distributed on an \\\"AS IS\\\" BASIS,\",\n\t\t\"# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\",\n\t\t\"# See the License for the specific language governing permissions and\",\n\t\t\"# limitations under the License.\",\n\t\t\"**/\",\n\t\t\"\",\n\t\t\"// Generated Code; DO NOT EDIT.\",\n\t\t\"\",\n\t\t\"package nvsandboxutils\",\n\t\t\"\",\n\t\t\"\",\n\t}\n\treturn strings.Join(lines, \"\\n\"), nil\n}\n\nfunc generatePackageMethodsComment(input GeneratableInterfacePoperties) (string, error) {\n\tcommentFmt := []string{\n\t\t\"// The variables below represent package level methods from the %s type.\",\n\t}\n\n\tsignature := &strings.Builder{}\n\tcomment := strings.Join(commentFmt, \"\\n\")\n\tcomment = fmt.Sprintf(comment, input.Type)\n\tfmt.Fprintf(signature, \"%s\\n\", comment)\n\treturn signature.String(), nil\n}\n\nfunc generateInterfaceComment(input GeneratableInterfacePoperties) (string, error) {\n\tcommentFmt := []string{\n\t\t\"// %s represents the interface for the %s type.\",\n\t\t\"//\",\n\t\t\"//go:generate moq -rm -fmt=goimports -out mock/%s.go -pkg mock . %s:%s\",\n\t}\n\n\tsignature := &strings.Builder{}\n\tcomment := strings.Join(commentFmt, \"\\n\")\n\tcomment = fmt.Sprintf(comment, input.Interface, input.Type, strings.ToLower(input.Interface), input.Interface, input.Interface)\n\tfmt.Fprintf(signature, \"%s\\n\", comment)\n\treturn signature.String(), nil\n}\n\nfunc generatePackageMethods(sourceDir string, input GeneratableInterfacePoperties) (string, error) {\n\tsignature := &strings.Builder{}\n\n\tfmt.Fprintf(signature, \"var (\\n\")\n\n\tmethods, err := extractMethodsFromPackage(sourceDir, input)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tfor _, method := range methods {\n\t\tname := method.Name.Name\n\t\tfmt.Fprintf(signature, \"\\t%s = %s.%s\\n\", name, input.PackageMethodsAliasedFrom, name)\n\t}\n\n\tfmt.Fprintf(signature, \")\\n\")\n\n\treturn signature.String(), nil\n}\n\nfunc generateInterface(sourceDir string, input GeneratableInterfacePoperties) (string, error) {\n\tsignature := &strings.Builder{}\n\n\tfmt.Fprintf(signature, \"type %s interface {\\n\", input.Interface)\n\n\tmethods, err := extractMethodsFromPackage(sourceDir, input)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tfor _, method := range methods {\n\t\tfmt.Fprintf(signature, \"\\t%s\\n\", formatMethodSignature(method))\n\t}\n\n\tfmt.Fprintf(signature, \"}\\n\")\n\n\treturn signature.String(), nil\n}\n\nfunc getGoFiles(sourceDir string) (map[string][]byte, error) {\n\tgofiles := make(map[string][]byte)\n\n\terr := filepath.WalkDir(sourceDir, func(path string, d fs.DirEntry, err error) error {\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif d.IsDir() || filepath.Ext(path) != \".go\" {\n\t\t\treturn nil\n\t\t}\n\n\t\t//nolint:gosec // Since we are only using this during code generation\n\t\t// we are not concerned with possible TOUTOC race conditions.\n\t\tcontent, err := os.ReadFile(path)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\n\t\tgofiles[path] = content\n\n\t\treturn nil\n\t})\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"walking %s: %w\", sourceDir, err)\n\t}\n\n\treturn gofiles, nil\n}\n\nfunc extractMethodsFromPackage(sourceDir string, input GeneratableInterfacePoperties) ([]*ast.FuncDecl, error) {\n\tgofiles, err := getGoFiles(sourceDir)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar methods []*ast.FuncDecl\n\tfor file, content := range gofiles {\n\t\tm, err := extractMethods(file, content, input)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tmethods = append(methods, m...)\n\t}\n\n\tsort.Slice(methods, func(i, j int) bool {\n\t\treturn methods[i].Name.Name < methods[j].Name.Name\n\t})\n\n\treturn methods, nil\n}\n\nfunc extractMethods(sourceFile string, sourceContent []byte, input GeneratableInterfacePoperties) ([]*ast.FuncDecl, error) {\n\t// Parse source file\n\tfset := token.NewFileSet()\n\tnode, err := parser.ParseFile(fset, sourceFile, sourceContent, parser.ParseComments)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Traverse AST to find type declarations and associated methods\n\tvar methods []*ast.FuncDecl\n\tfor _, decl := range node.Decls {\n\t\tfuncDecl, ok := decl.(*ast.FuncDecl)\n\t\tif !ok {\n\t\t\tcontinue\n\t\t}\n\n\t\t// Check if the function is a method associated with the specified type\n\t\tif receiverType := funcDecl.Recv; receiverType != nil {\n\t\t\tvar ident *ast.Ident\n\n\t\t\tfor _, field := range receiverType.List {\n\t\t\t\tswitch fieldType := field.Type.(type) {\n\t\t\t\tcase *ast.Ident:\n\t\t\t\t\tident = fieldType\n\t\t\t\tcase *ast.StarExpr:\n\t\t\t\t\t// Update ident if it's a *ast.StarExpr\n\t\t\t\t\tif newIdent, ok := fieldType.X.(*ast.Ident); ok {\n\t\t\t\t\t\t// If the inner type is an *ast.Ident, update ident\n\t\t\t\t\t\tident = newIdent\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// No identifier found\n\t\t\t\tif ident == nil {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\n\t\t\t\t// Identifier is not the one we are looking for\n\t\t\t\tif ident.Name != input.Type {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\n\t\t\t\t// Ignore non-public methods\n\t\t\t\tif !isPublic(funcDecl.Name.Name) {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\n\t\t\t\t// Ignore method in the exclude list\n\t\t\t\tif slices.Contains(input.Exclude, funcDecl.Name.Name) {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\n\t\t\t\tmethods = append(methods, funcDecl)\n\t\t\t}\n\t\t}\n\t}\n\n\treturn methods, nil\n}\n\nfunc formatMethodSignature(decl *ast.FuncDecl) string {\n\tsignature := &strings.Builder{}\n\n\t// Write method name\n\tfmt.Fprint(signature, decl.Name.Name)\n\tfmt.Fprintf(signature, \"(\")\n\n\t// Write parameters\n\tif decl.Type.Params != nil {\n\t\tfor i, param := range decl.Type.Params.List {\n\t\t\tif i > 0 {\n\t\t\t\tfmt.Fprintf(signature, \", \")\n\t\t\t}\n\t\t\tfmt.Fprint(signature, formatFieldList(param))\n\t\t}\n\t}\n\n\tfmt.Fprintf(signature, \")\")\n\n\t// Write return types\n\tif decl.Type.Results != nil {\n\t\tfmt.Fprintf(signature, \" \")\n\t\tif len(decl.Type.Results.List) > 1 {\n\t\t\tfmt.Fprintf(signature, \"(\")\n\t\t}\n\t\tfor i, result := range decl.Type.Results.List {\n\t\t\tif i > 0 {\n\t\t\t\tfmt.Fprintf(signature, \", \")\n\t\t\t}\n\t\t\tfmt.Fprint(signature, formatFieldList(result))\n\t\t}\n\t\tif len(decl.Type.Results.List) > 1 {\n\t\t\tfmt.Fprintf(signature, \")\")\n\t\t}\n\t}\n\n\treturn signature.String()\n}\n\nfunc formatFieldList(field *ast.Field) string {\n\tbuilder := &strings.Builder{}\n\tswitch fieldType := field.Type.(type) {\n\tcase *ast.Ident:\n\t\tfmt.Fprint(builder, fieldType.Name)\n\tcase *ast.ArrayType:\n\t\tfmt.Fprintf(builder, \"[]\")\n\t\tfmt.Fprint(builder, formatFieldList(&ast.Field{Type: fieldType.Elt}))\n\tcase *ast.StarExpr:\n\t\tfmt.Fprintf(builder, \"*\")\n\t\tfmt.Fprint(builder, formatFieldList(&ast.Field{Type: fieldType.X}))\n\t}\n\treturn builder.String()\n}\n\nfunc isPublic(name string) bool {\n\tif len(name) == 0 {\n\t\treturn false\n\t}\n\treturn unicode.IsUpper([]rune(name)[0])\n}\n"
},
{
"path": "internal/nvsandboxutils/gen/nvsandboxutils/nvsandboxutils.h",
"content": "/*\n * SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n * SPDX-License-Identifier: Apache-2.0\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n#ifndef __NVSANDBOXUTILS_H__\n#define __NVSANDBOXUTILS_H__\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n#define INPUT_LENGTH 256\n#define MAX_FILE_PATH 256\n#define MAX_NAME_LENGTH 256\n\n/***************************************************************************************************/\n/** @defgroup enums Enumerations\n * @{\n */\n/***************************************************************************************************/\n\n/**\n * Return types\n */\ntypedef enum\n{\n NVSANDBOXUTILS_SUCCESS = 0, //!< The operation was successful\n NVSANDBOXUTILS_ERROR_UNINITIALIZED = 1, //!< The library wasn't successfully initialized\n NVSANDBOXUTILS_ERROR_NOT_SUPPORTED = 2, //!< The requested operation is not supported on target device\n NVSANDBOXUTILS_ERROR_INVALID_ARG = 3, //!< A supplied argument is invalid\n NVSANDBOXUTILS_ERROR_INSUFFICIENT_SIZE = 4, //!< A supplied argument is not large enough\n NVSANDBOXUTILS_ERROR_VERSION_NOT_SUPPORTED = 5, //!< Requested library version is not supported\n NVSANDBOXUTILS_ERROR_LIBRARY_LOAD = 6, //!< The library load failed\n NVSANDBOXUTILS_ERROR_FUNCTION_NOT_FOUND = 7, //!< Called function was not found\n NVSANDBOXUTILS_ERROR_DEVICE_NOT_FOUND = 8, //!< Target device was not found\n NVSANDBOXUTILS_ERROR_NVML_LIB_CALL = 9, //!< NVML library call failed\n NVSANDBOXUTILS_ERROR_OUT_OF_MEMORY = 10, //!< There is insufficient memory\n NVSANDBOXUTILS_ERROR_FILEPATH_NOT_FOUND = 11, //!< A supplied file path was not found\n NVSANDBOXUTILS_ERROR_UNKNOWN = 0xFFFF, //!< Unknown error occurred\n} nvSandboxUtilsRet_t;\n\n/**\n * Return if there is an error \n */\n#define RETURN_ON_SANDBOX_ERROR(result) \\\n if ((result) != NVSANDBOXUTILS_SUCCESS) { \\\n NVSANDBOXUTILS_ERROR_MSG(\"%s %d result=%d\", __func__, __LINE__, result); \\\n return result; \\\n }\n\n/**\n * Log levels\n */\ntypedef enum\n{\n NVSANDBOXUTILS_LOG_LEVEL_FATAL = 0, //!< Log fatal errors\n NVSANDBOXUTILS_LOG_LEVEL_ERROR = 1, //!< Log all errors\n NVSANDBOXUTILS_LOG_LEVEL_WARN = 2, //!< Log all warnings\n NVSANDBOXUTILS_LOG_LEVEL_DEBUG = 3, //!< Log all debug messages\n NVSANDBOXUTILS_LOG_LEVEL_INFO = 4, //!< Log all info messages\n NVSANDBOXUTILS_LOG_LEVEL_NONE = 0xFFFF, //!< Log none\n} nvSandboxUtilsLogLevel_t;\n\n/**\n * Input rootfs to help access files inside the driver container\n */ \ntypedef enum\n{\n NV_ROOTFS_DEFAULT, //!< Default no rootfs \n NV_ROOTFS_PATH, //!< /run/nvidia/driver\n NV_ROOTFS_PID, //!< /proc/PID/mountinfo\n} nvSandboxUtilsRootfsInputType_t;\n\n/**\n * File type\n */\ntypedef enum\n{\n NV_DEV, //!< /dev file system\n NV_PROC, //!< /proc file system\n NV_SYS, //!< /sys file system\n} nvSandboxUtilsFileType_t;\n\n/**\n * File subtype \n */\ntypedef enum\n{\n NV_DEV_NVIDIA, //!< /dev/nvidia0\n NV_DEV_DRI_CARD, //!< /dev/dri/card1\n NV_DEV_DRI_RENDERD, //!< /dev/dri/renderD128\n NV_DEV_DRI_CARD_SYMLINK, //!< /dev/dri/by-path/pci-0000:41:00.0-card\n NV_DEV_DRI_RENDERD_SYMLINK, //!< /dev/dri/by-path/pci-0000:41:00.0-render\n NV_DEV_NVIDIA_UVM, //!< /dev/nvidia-uvm\n NV_DEV_NVIDIA_UVM_TOOLS, //!< /dev/nvidia-uvm-tools\n NV_DEV_NVIDIA_MODESET, //!< /dev/nvidia-uvm-modeset\n NV_DEV_NVIDIA_CTL, //!< /dev/nvidiactl\n NV_DEV_GDRDRV, //!< /dev/gdrdrv\n NV_DEV_NVIDIA_CAPS_NVIDIA_CAP, //!< /dev/nvidia-caps/nvidia-cap22\n NV_PROC_DRIVER_NVIDIA_GPUS_PCIBUSID, //!< /proc/driver/nvidia/gpus/0000:2d:00.0\n NV_PROC_DRIVER_NVIDIA_GPUS, //!< /proc/driver/nvidia/gpus (for mask out)\n NV_PROC_NVIDIA_PARAMS, //!< /proc/driver/nvidia/params\n NV_PROC_NVIDIA_CAPS_MIG_MINORS, //!< /proc/driver/nvidia-caps/mig-minors\n NV_PROC_DRIVER_NVIDIA_CAPABILITIES_GPU, //!< /proc/driver/nvidia/capabilities/gpu0\n NV_PROC_DRIVER_NVIDIA_CAPABILITIES, //!< /proc/driver/nvidia/capabilities (for mask out)\n NV_PROC_DRIVER_NVIDIA_CAPABILITIIES_GPU_MIG_CI_ACCESS, //!< proc/driver/nvidia/capabilities/gpu0/mig/gi2/ci0/access\n NV_SYS_MODULE_NVIDIA_DRIVER_PCIBUSID, //!< /sys/module/nvidia/drivers/pci:nvidia/0000:2d:00.0\n NV_SYS_MODULE_NVIDIA_DRIVER, //!< /sys/module/nvidia/drivers/pci:nvidia (for mask out)\n NV_NUM_SUBTYPE, // always at the end.\n} nvSandboxUtilsFileSystemSubType_t;\n\n/**\n * File module\n */\ntypedef enum\n{\n NV_GPU, //!< Target device\n NV_MIG, //!< Target device- MIG\n NV_DRIVER_NVIDIA, //!< NVIDIA kernel driver\n NV_DRIVER_NVIDIA_UVM, //!< NVIDIA kernel driver-UVM\n NV_DRIVER_NVIDIA_MODESET, //!< NVIDIA kernel driver-modeset\n NV_DRIVER_GDRDRV, //!< GDRDRV driver\n NV_SYSTEM, //!< System module\n} nvSandboxUtilsFileModule_t;\n\n/**\n * Flag to provide additional details about the file\n */\ntypedef enum\n{\n NV_FILE_FLAG_HINT = (1 << 0), //!< Default no hint\n NV_FILE_FLAG_MASKOUT = (1 << 1), //!< For /proc/driver/nvidia/gpus\n NV_FILE_FLAG_CONTENT = (1 << 2), //!< For /proc/driver/nvidia/params\n //!< For SYMLINK\n //!< Use \\p nvSandboxUtilsGetFileContent to get name of the linked file\n NV_FILE_FLAG_DEPRECTATED = (1 << 3), //!< For all the FIRMWARE GSP file\n NV_FILE_FLAG_CANDIDATES = (1 << 4), //!< For libcuda.so\n} nvSandboxUtilsFileFlag_t;\n\n/**\n * Input type of the target device\n */\ntypedef enum\n{\n NV_GPU_INPUT_GPU_UUID, //!< GPU UUID\n NV_GPU_INPUT_MIG_UUID, //!< MIG UUID\n NV_GPU_INPUT_PCI_ID, //!< PCIe DBDF ID\n NV_GPU_INPUT_PCI_INDEX, //!< PCIe bus order (0 points to the GPU that has lowest PCIe BDF)\n} nvSandboxUtilsGpuInputType_t;\n\n/** @} */\n\n/***************************************************************************************************/\n/** @defgroup dataTypes Structures and Unions\n * @{\n */\n/***************************************************************************************************/\n\n/**\n * Initalization input v1\n */\ntypedef struct\n{\n unsigned int version; //!< Version for the structure\n nvSandboxUtilsRootfsInputType_t type; //!< One of \\p nvSandboxUtilsRootfsInputType_t\n char value[INPUT_LENGTH]; //!< String representation of input\n} nvSandboxUtilsInitInput_v1_t;\n\ntypedef nvSandboxUtilsInitInput_v1_t nvSandboxUtilsInitInput_t;\n\n/**\n * File system information \n */\ntypedef struct nvSandboxUtilsGpuFileInfo_v1_t\n{\n struct nvSandboxUtilsGpuFileInfo_v1_t *next; //!< Pointer to the next node in the linked list\n nvSandboxUtilsFileType_t fileType; //!< One of \\p nvSandboxUtilsFileType_t\n nvSandboxUtilsFileSystemSubType_t fileSubType; //!< One of \\p nvSandboxUtilsFileSystemSubType_t\n nvSandboxUtilsFileModule_t module; //!< One of \\p nvSandboxUtilsFileModule_t\n nvSandboxUtilsFileFlag_t flags; //!< One of \\p nvSandboxUtilsFileFlag_t\n char *filePath; //!< Relative file path to rootfs\n}nvSandboxUtilsGpuFileInfo_v1_t;\n\n/**\n * GPU resource request v1\n */\ntypedef struct\n{\n unsigned int version; //!< Version for the structure\n nvSandboxUtilsGpuInputType_t inputType; //!< One of \\p nvSandboxUtilsGpuInputType_t\n char input[INPUT_LENGTH]; //!< String representation of input\n nvSandboxUtilsGpuFileInfo_v1_t *files; //!< Linked list of \\ref nvSandboxUtilsGpuFileInfo_v1_t\n} nvSandboxUtilsGpuRes_v1_t;\n\ntypedef nvSandboxUtilsGpuRes_v1_t nvSandboxUtilsGpuRes_t;\n\n/** @} */\n\n/***************************************************************************************************/\n/** @defgroup funcs Functions\n * @{\n */\n/***************************************************************************************************/\n\n/* *************************************************\n * Initialize library\n * *************************************************\n */\n/**\n * Prepare library resources before library API can be used.\n * This initialization will not fail if one of the initialization prerequisites fails.\n * @param input Reference to the called-supplied input struct that has initialization fields \n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n * @returns @ref NVSANDBOXUTILS_ERROR_INVALID_ARG if \\p input->value isn't a valid rootfs path\n * @returns @ref NVSANDBOXUTILS_ERROR_VERSION_NOT_SUPPORTED if \\p input->version isn't supported by the library\n * @returns @ref NVSANDBOXUTILS_ERROR_FILEPATH_NOT_FOUND if any of the required file paths are not found during initialization\n * @returns @ref NVSANDBOXUTILS_ERROR_OUT_OF_MEMORY if there is insufficient system memory during initialization\n * @returns @ref NVSANDBOXUTILS_ERROR_LIBRARY_LOAD on any error during loading the library\n */\nnvSandboxUtilsRet_t nvSandboxUtilsInit(nvSandboxUtilsInitInput_t *input);\n\n/* *************************************************\n * Shutdown library\n * *************************************************\n */\n/**\n * Clean up library resources created by init call\n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n */\nnvSandboxUtilsRet_t nvSandboxUtilsShutdown(void);\n\n/* *************************************************\n * Get NVIDIA RM driver version\n * *************************************************\n */\n/**\n * Get NVIDIA RM driver version\n * @param version Reference to caller-supplied buffer to return driver version string\n * @param length The maximum allowed length of the string returned in \\p version\n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n * @returns @ref NVSANDBOXUTILS_ERROR_INVALID_ARG if \\p version is NULL\n * @returns @ref NVSANDBOXUTILS_ERROR_NVML_LIB_CALL on any error during driver version query from NVML\n */\nnvSandboxUtilsRet_t nvSandboxUtilsGetDriverVersion(char *version, unsigned int length);\n\n/* *************************************************\n * Get /dev, /proc, /sys file system information\n * *************************************************\n */\n/**\n * Get /dev, /proc, /sys file system information\n * @param request Reference to caller-supplied request struct to return the file system information \n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n * @returns @ref NVSANDBOXUTILS_ERROR_INVALID_ARG if \\p request->input doesn't match any device\n * @returns @ref NVSANDBOXUTILS_ERROR_VERSION_NOT_SUPPORTED if \\p request->version isn't supported by the library\n */\nnvSandboxUtilsRet_t nvSandboxUtilsGetGpuResource(nvSandboxUtilsGpuRes_t *request);\n\n/* *************************************************\n * Get content of given file path\n * *************************************************\n */\n/**\n * Get file content of input file path\n * @param filePath Reference to the file path\n * @param content Reference to the caller-supplied buffer to return the file content\n * @param contentSize Reference to the maximum allowed size of content. It is updated to the actual size of the content on return\n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n * @returns @ref NVSANDBOXUTILS_ERROR_INVALID_ARG if \\p filePath or \\p content is NULL\n * @returns @ref NVSANDBOXUTILS_ERROR_INSUFFICIENT_SIZE if \\p contentSize is too small\n * @returns @ref NVSANDBOXUTILS_ERROR_FILEPATH_NOT_FOUND on an error while obtaining the content for the file path\n */\nnvSandboxUtilsRet_t nvSandboxUtilsGetFileContent(char *filePath, char *content, unsigned int *contentSize);\n\n/** @} */\n\n#ifdef __cplusplus\n}\n#endif\n#endif // __NVSANDBOXUTILS_H__\n"
},
{
"path": "internal/nvsandboxutils/gen/nvsandboxutils/nvsandboxutils.yml",
"content": "# Copyright (c) 2024, NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n---\nGENERATOR:\n PackageName: nvsandboxutils\n PackageDescription: \"Package NVSANDBOXUTILS bindings\"\n PackageLicense: |-\n Copyright (c) 2024, NVIDIA CORPORATION\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n Includes: [\"nvsandboxutils.h\"]\n FlagGroups:\n - {name: \"LDFLAGS\", traits: [\"linux\"], flags: [\"-Wl,--export-dynamic\",\"-Wl,--unresolved-symbols=ignore-in-object-files\"]}\n - {name: \"LDFLAGS\", traits: [\"darwin\"], flags: [\"-Wl,-undefined,dynamic_lookup\"]}\nPARSER:\n SourcesPaths: [\"nvsandboxutils.h\"]\nTRANSLATOR:\n ConstRules:\n defines: eval\n enum: eval\n PtrTips:\n function:\n - {target: \"^nvSandboxUtils\", default: \"sref\"}\n MemTips:\n - {target: \"^nvSandboxUtils\", default: \"raw\"}\n Rules:\n const:\n - {action: accept, from: \"^NVSANDBOXUTILS_\"}\n - {action: accept, from: \"^nvSandboxUtils\"}\n - {action: replace, from: \"^NVSANDBOXUTILS_\"}\n - {action: replace, from: \"^nvSandboxUtils\"}\n - {action: accept, from: \"^NV\"}\n - {action: accept, from: \"^MAX\"}\n - {action: accept, from: \"^INPUT\"}\n - {action: replace, from: \"_t$\"}\n - {transform: export}\n type:\n - {action: accept, from: \"^nvSandboxUtils\"}\n - {action: replace, from: \"^nvSandboxUtils\"}\n - {action: replace, from: \"_t$\"}\n - {transform: export}\n function:\n - {action: accept, from: \"^nvSandboxUtils\"}\n - {transform: unexport}\n"
},
{
"path": "internal/nvsandboxutils/gen/update-bindings.sh",
"content": "#!/bin/bash\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This file allows for the nvsandboxutils bindings to be updated using the tooling\n# implemented in https://github.com/NVIDIA/go-nvml.\n# To run this:\n# cd internal/nvsandboxutils\n# ./update-bindings.sh\n\nset -e\n\nBUILDIMAGE=bindings\n\ndocker build \\\n --build-arg GOLANG_VERSION=1.22.1 \\\n --build-arg C_FOR_GO_TAG=8eeee8c3b71f9c3c90c4a73db54ed08b0bba971d \\\n -t ${BUILDIMAGE} \\\n -f docker/Dockerfile.devel \\\n https://github.com/NVIDIA/go-nvml.git\n\n\ndocker run --rm -ti \\\n\t\t-e GOCACHE=/tmp/.cache/go \\\n\t\t-e GOMODCACHE=/tmp/.cache/gomod \\\n -v $(pwd):/nvsandboxutils \\\n -w /nvsandboxutils \\\n -u $(id -u):$(id -g) \\\n ${BUILDIMAGE} \\\n ./gen/generate-bindings.sh\n"
},
{
"path": "internal/nvsandboxutils/gpu-resources.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\nimport (\n\t\"strings\"\n\t\"unsafe\"\n)\n\nimport \"C\"\n\ntype GpuResource struct {\n\tVersion uint32\n}\n\ntype GpuFileInfo struct {\n\tPath string\n\tType FileType\n\tSubType FileSystemSubType\n\tModule FileModule\n\tFlags FileFlag\n}\n\nfunc (l *library) GetGpuResource(uuid string) ([]GpuFileInfo, Ret) {\n\tdeviceType := NV_GPU_INPUT_GPU_UUID\n\tif strings.HasPrefix(uuid, \"MIG-\") {\n\t\tdeviceType = NV_GPU_INPUT_MIG_UUID\n\t}\n\n\trequest := GpuRes{\n\t\tVersion: 1,\n\t\tInputType: uint32(deviceType),\n\t\tInput: convertStringToFixedArray(uuid),\n\t}\n\n\tret := nvSandboxUtilsGetGpuResource(&request)\n\tif ret != SUCCESS {\n\t\treturn nil, ret\n\t}\n\n\tvar fileInfos []GpuFileInfo\n\tfor fileInfo := request.Files; fileInfo != nil; fileInfo = fileInfo.Next {\n\t\tfi := GpuFileInfo{\n\t\t\tPath: C.GoString((*C.char)(unsafe.Pointer(fileInfo.FilePath))),\n\t\t\tType: FileType(fileInfo.FileType),\n\t\t\tSubType: FileSystemSubType(fileInfo.FileSubType),\n\t\t\tModule: FileModule(fileInfo.Module),\n\t\t\tFlags: FileFlag(fileInfo.Flags),\n\t\t}\n\t\tfileInfos = append(fileInfos, fi)\n\t}\n\treturn fileInfos, SUCCESS\n}\n"
},
{
"path": "internal/nvsandboxutils/impl.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\nimport \"C\"\n\nfunc (l *library) Init(path string) Ret {\n\tif err := l.load(); err != nil {\n\t\treturn ERROR_LIBRARY_LOAD\n\t}\n\n\tinput := InitInput{\n\t\tVersion: 1,\n\t\tType: uint32(NV_ROOTFS_PATH),\n\t\tValue: convertStringToFixedArray(path),\n\t}\n\n\treturn nvSandboxUtilsInit(&input)\n}\n\nfunc (l *library) Shutdown() Ret {\n\tret := nvSandboxUtilsShutdown()\n\tif ret != SUCCESS {\n\t\treturn ret\n\t}\n\n\terr := l.close()\n\tif err != nil {\n\t\treturn ERROR_UNKNOWN\n\t}\n\n\treturn ret\n}\n\n// TODO: Is this length specified in the header file?\nconst VERSION_LENGTH = 100\n\nfunc (l *library) GetDriverVersion() (string, Ret) {\n\tVersion := make([]byte, VERSION_LENGTH)\n\tret := nvSandboxUtilsGetDriverVersion(&Version[0], VERSION_LENGTH)\n\treturn string(Version[:clen(Version)]), ret\n}\n\nfunc (l *library) GetFileContent(path string) (string, Ret) {\n\tContent := make([]byte, MAX_FILE_PATH)\n\tFilePath := []byte(path + string(byte(0)))\n\tSize := uint32(MAX_FILE_PATH)\n\tret := nvSandboxUtilsGetFileContent(&FilePath[0], &Content[0], &Size)\n\treturn string(Content[:clen(Content)]), ret\n}\n"
},
{
"path": "internal/nvsandboxutils/lib.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"sync\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/dl\"\n)\n\nconst (\n\tdefaultNvSandboxUtilsLibraryName = \"libnvidia-sandboxutils.so.1\"\n\tdefaultNvSandboxUtilsLibraryLoadFlags = dl.RTLD_LAZY | dl.RTLD_GLOBAL\n)\n\nvar errLibraryNotLoaded = errors.New(\"library not loaded\")\nvar errLibraryAlreadyLoaded = errors.New(\"library already loaded\")\n\n// dynamicLibrary is an interface for abstacting the underlying library.\n// This also allows for mocking and testing.\n\n//go:generate moq -rm -fmt=goimports -stub -out dynamicLibrary_mock.go . dynamicLibrary\ntype dynamicLibrary interface {\n\tLookup(string) error\n\tOpen() error\n\tClose() error\n}\n\n// library represents an nvsandboxutils library.\n// This includes a reference to the underlying DynamicLibrary\ntype library struct {\n\tsync.Mutex\n\tpath string\n\trefcount refcount\n\tdl dynamicLibrary\n}\n\n// libnvsandboxutils is a global instance of the nvsandboxutils library.\nvar libnvsandboxutils = newLibrary()\n\nfunc New(opts ...LibraryOption) Interface {\n\treturn newLibrary(opts...)\n}\n\nfunc newLibrary(opts ...LibraryOption) *library {\n\tl := &library{}\n\tl.init(opts...)\n\treturn l\n}\n\nfunc (l *library) init(opts ...LibraryOption) {\n\to := libraryOptions{}\n\tfor _, opt := range opts {\n\t\topt(&o)\n\t}\n\n\tif o.path == \"\" {\n\t\to.path = defaultNvSandboxUtilsLibraryName\n\t}\n\tif o.flags == 0 {\n\t\to.flags = defaultNvSandboxUtilsLibraryLoadFlags\n\t}\n\n\tl.path = o.path\n\tl.dl = dl.New(o.path, o.flags)\n}\n\n// LookupSymbol checks whether the specified library symbol exists in the library.\n// Note that this requires that the library be loaded.\nfunc (l *library) LookupSymbol(name string) error {\n\tif l == nil || l.refcount == 0 {\n\t\treturn fmt.Errorf(\"error looking up %s: %w\", name, errLibraryNotLoaded)\n\t}\n\treturn l.dl.Lookup(name)\n}\n\n// load initializes the library and updates the versioned symbols.\n// Multiple calls to an already loaded library will return without error.\nfunc (l *library) load() (rerr error) {\n\tl.Lock()\n\tdefer l.Unlock()\n\n\tdefer func() { l.refcount.IncOnNoError(rerr) }()\n\tif l.refcount > 0 {\n\t\treturn nil\n\t}\n\n\tif err := l.dl.Open(); err != nil {\n\t\treturn fmt.Errorf(\"error opening %s: %w\", l.path, err)\n\t}\n\n\t// Update the errorStringFunc to point to nvsandboxutils.ErrorString\n\terrorStringFunc = nvsanboxutilsErrorString\n\n\t// Update all versioned symbols\n\tl.updateVersionedSymbols()\n\n\treturn nil\n}\n\n// close the underlying library and ensure that the global pointer to the\n// library is set to nil to ensure that subsequent calls to open will reinitialize it.\n// Multiple calls to an already closed nvsandboxutils library will return without error.\nfunc (l *library) close() (rerr error) {\n\tl.Lock()\n\tdefer l.Unlock()\n\n\tdefer func() { l.refcount.DecOnNoError(rerr) }()\n\tif l.refcount != 1 {\n\t\treturn nil\n\t}\n\n\tif err := l.dl.Close(); err != nil {\n\t\treturn fmt.Errorf(\"error closing %s: %w\", l.path, err)\n\t}\n\n\t// Update the errorStringFunc to point to defaultErrorStringFunc\n\terrorStringFunc = defaultErrorStringFunc\n\n\treturn nil\n}\n\n// Default all versioned APIs to v1 (to infer the types)\nvar (\n// Insert default versions for APIs here.\n// Example:\n// nvsandboxUtilsFunction = nvsandboxUtilsFunction_v1\n)\n\n// updateVersionedSymbols checks for versioned symbols in the loaded dynamic library.\n// If newer versioned symbols exist, these replace the default `v1` symbols initialized above.\n// When new versioned symbols are added, these would have to be initialized above and have\n// corresponding checks and subsequent assignments added below.\nfunc (l *library) updateVersionedSymbols() {\n\t// Example:\n\t// err := l.dl.Lookup(\"nvsandboxUtilsFunction_v2\")\n\t// if err == nil {\n\t// \tnvsandboxUtilsFunction = nvsandboxUtilsFunction_v2\n\t// }\n}\n"
},
{
"path": "internal/nvsandboxutils/lib_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc newTestLibrary(dl dynamicLibrary) *library {\n\treturn &library{dl: dl}\n}\n\nfunc TestLookupFromDefault(t *testing.T) {\n\terrClose := errors.New(\"close error\")\n\terrOpen := errors.New(\"open error\")\n\terrLookup := errors.New(\"lookup error\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdl dynamicLibrary\n\t\tskipLoadLibrary bool\n\t\texpectedLoadError error\n\t\texpectedLookupErrror error\n\t\texpectedCloseError error\n\t}{\n\t\t{\n\t\t\tdescription: \"library not loaded yields error\",\n\t\t\tdl: &dynamicLibraryMock{},\n\t\t\tskipLoadLibrary: true,\n\t\t\texpectedLookupErrror: errLibraryNotLoaded,\n\t\t},\n\t\t{\n\t\t\tdescription: \"open error is returned\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn errOpen\n\t\t\t\t},\n\t\t\t},\n\n\t\t\texpectedLoadError: errOpen,\n\t\t\texpectedLookupErrror: errLibraryNotLoaded,\n\t\t},\n\t\t{\n\t\t\tdescription: \"lookup error is returned\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tLookupFunc: func(s string) error {\n\t\t\t\t\treturn fmt.Errorf(\"%w: %s\", errLookup, s)\n\t\t\t\t},\n\t\t\t\tCloseFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\n\t\t\texpectedLookupErrror: errLookup,\n\t\t},\n\t\t{\n\t\t\tdescription: \"lookup succeeds\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tLookupFunc: func(s string) error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tCloseFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"lookup succeeds\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tLookupFunc: func(s string) error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tCloseFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"close error is returned\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tLookupFunc: func(s string) error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tCloseFunc: func() error {\n\t\t\t\t\treturn errClose\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedCloseError: errClose,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tl := newTestLibrary(tc.dl)\n\t\t\tif !tc.skipLoadLibrary {\n\t\t\t\trequire.ErrorIs(t, l.load(), tc.expectedLoadError)\n\t\t\t}\n\t\t\trequire.ErrorIs(t, l.LookupSymbol(\"symbol\"), tc.expectedLookupErrror)\n\t\t\trequire.ErrorIs(t, l.close(), tc.expectedCloseError)\n\t\t\tif tc.expectedCloseError == nil {\n\t\t\t\trequire.Equal(t, 0, int(l.refcount))\n\t\t\t} else {\n\t\t\t\trequire.Equal(t, 1, int(l.refcount))\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestLoadAndCloseNesting(t *testing.T) {\n\tdl := &dynamicLibraryMock{\n\t\tOpenFunc: func() error {\n\t\t\treturn nil\n\t\t},\n\t\tCloseFunc: func() error {\n\t\t\treturn nil\n\t\t},\n\t}\n\n\tl := newTestLibrary(dl)\n\n\t// When calling close before opening the library nothing happens.\n\trequire.Equal(t, 0, len(dl.calls.Close))\n\trequire.Nil(t, l.close())\n\trequire.Equal(t, 0, len(dl.calls.Close))\n\n\t// When calling load twice, the library was only opened once\n\trequire.Equal(t, 0, len(dl.calls.Open))\n\trequire.Nil(t, l.load())\n\trequire.Equal(t, 1, len(dl.calls.Open))\n\trequire.Nil(t, l.load())\n\trequire.Equal(t, 1, len(dl.calls.Open))\n\n\t// Only after calling close twice, was the library closed\n\trequire.Equal(t, 0, len(dl.calls.Close))\n\trequire.Nil(t, l.close())\n\trequire.Equal(t, 0, len(dl.calls.Close))\n\trequire.Nil(t, l.close())\n\trequire.Equal(t, 1, len(dl.calls.Close))\n\n\t// Calling close again doesn't attempt to close the library again\n\trequire.Nil(t, l.close())\n\trequire.Equal(t, 1, len(dl.calls.Close))\n}\n\nfunc TestLoadAndCloseWithErrors(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdl dynamicLibrary\n\t\texpectedLoadRefcount refcount\n\t\texpectedCloseRefcount refcount\n\t}{\n\t\t{\n\t\t\tdescription: \"regular flow\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tCloseFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedLoadRefcount: 1,\n\t\t\texpectedCloseRefcount: 0,\n\t\t},\n\t\t{\n\t\t\tdescription: \"open error\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn errors.New(\"\")\n\t\t\t\t},\n\t\t\t\tCloseFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedLoadRefcount: 0,\n\t\t\texpectedCloseRefcount: 0,\n\t\t},\n\t\t{\n\t\t\tdescription: \"close error\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t\tCloseFunc: func() error {\n\t\t\t\t\treturn errors.New(\"\")\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedLoadRefcount: 1,\n\t\t\texpectedCloseRefcount: 1,\n\t\t},\n\t\t{\n\t\t\tdescription: \"open and close error\",\n\t\t\tdl: &dynamicLibraryMock{\n\t\t\t\tOpenFunc: func() error {\n\t\t\t\t\treturn errors.New(\"\")\n\t\t\t\t},\n\t\t\t\tCloseFunc: func() error {\n\t\t\t\t\treturn errors.New(\"\")\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedLoadRefcount: 0,\n\t\t\texpectedCloseRefcount: 0,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tl := newTestLibrary(tc.dl)\n\t\t\t_ = l.load()\n\t\t\trequire.Equal(t, tc.expectedLoadRefcount, l.refcount)\n\t\t\t_ = l.close()\n\t\t\trequire.Equal(t, tc.expectedCloseRefcount, l.refcount)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/nvsandboxutils/mock/interface.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage mock\n\nimport (\n\t\"sync\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils\"\n)\n\n// Ensure, that Interface does implement nvsandboxutils.Interface.\n// If this is not the case, regenerate this file with moq.\nvar _ nvsandboxutils.Interface = &Interface{}\n\n// Interface is a mock implementation of nvsandboxutils.Interface.\n//\n//\tfunc TestSomethingThatUsesInterface(t *testing.T) {\n//\n//\t\t// make and configure a mocked nvsandboxutils.Interface\n//\t\tmockedInterface := &Interface{\n//\t\t\tErrorStringFunc: func(ret nvsandboxutils.Ret) string {\n//\t\t\t\tpanic(\"mock out the ErrorString method\")\n//\t\t\t},\n//\t\t\tGetDriverVersionFunc: func() (string, nvsandboxutils.Ret) {\n//\t\t\t\tpanic(\"mock out the GetDriverVersion method\")\n//\t\t\t},\n//\t\t\tGetFileContentFunc: func(s string) (string, nvsandboxutils.Ret) {\n//\t\t\t\tpanic(\"mock out the GetFileContent method\")\n//\t\t\t},\n//\t\t\tGetGpuResourceFunc: func(s string) ([]nvsandboxutils.GpuFileInfo, nvsandboxutils.Ret) {\n//\t\t\t\tpanic(\"mock out the GetGpuResource method\")\n//\t\t\t},\n//\t\t\tInitFunc: func(s string) nvsandboxutils.Ret {\n//\t\t\t\tpanic(\"mock out the Init method\")\n//\t\t\t},\n//\t\t\tLookupSymbolFunc: func(s string) error {\n//\t\t\t\tpanic(\"mock out the LookupSymbol method\")\n//\t\t\t},\n//\t\t\tShutdownFunc: func() nvsandboxutils.Ret {\n//\t\t\t\tpanic(\"mock out the Shutdown method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedInterface in code that requires nvsandboxutils.Interface\n//\t\t// and then make assertions.\n//\n//\t}\ntype Interface struct {\n\t// ErrorStringFunc mocks the ErrorString method.\n\tErrorStringFunc func(ret nvsandboxutils.Ret) string\n\n\t// GetDriverVersionFunc mocks the GetDriverVersion method.\n\tGetDriverVersionFunc func() (string, nvsandboxutils.Ret)\n\n\t// GetFileContentFunc mocks the GetFileContent method.\n\tGetFileContentFunc func(s string) (string, nvsandboxutils.Ret)\n\n\t// GetGpuResourceFunc mocks the GetGpuResource method.\n\tGetGpuResourceFunc func(s string) ([]nvsandboxutils.GpuFileInfo, nvsandboxutils.Ret)\n\n\t// InitFunc mocks the Init method.\n\tInitFunc func(s string) nvsandboxutils.Ret\n\n\t// LookupSymbolFunc mocks the LookupSymbol method.\n\tLookupSymbolFunc func(s string) error\n\n\t// ShutdownFunc mocks the Shutdown method.\n\tShutdownFunc func() nvsandboxutils.Ret\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// ErrorString holds details about calls to the ErrorString method.\n\t\tErrorString []struct {\n\t\t\t// Ret is the ret argument value.\n\t\t\tRet nvsandboxutils.Ret\n\t\t}\n\t\t// GetDriverVersion holds details about calls to the GetDriverVersion method.\n\t\tGetDriverVersion []struct {\n\t\t}\n\t\t// GetFileContent holds details about calls to the GetFileContent method.\n\t\tGetFileContent []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// GetGpuResource holds details about calls to the GetGpuResource method.\n\t\tGetGpuResource []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// Init holds details about calls to the Init method.\n\t\tInit []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// LookupSymbol holds details about calls to the LookupSymbol method.\n\t\tLookupSymbol []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// Shutdown holds details about calls to the Shutdown method.\n\t\tShutdown []struct {\n\t\t}\n\t}\n\tlockErrorString sync.RWMutex\n\tlockGetDriverVersion sync.RWMutex\n\tlockGetFileContent sync.RWMutex\n\tlockGetGpuResource sync.RWMutex\n\tlockInit sync.RWMutex\n\tlockLookupSymbol sync.RWMutex\n\tlockShutdown sync.RWMutex\n}\n\n// ErrorString calls ErrorStringFunc.\nfunc (mock *Interface) ErrorString(ret nvsandboxutils.Ret) string {\n\tif mock.ErrorStringFunc == nil {\n\t\tpanic(\"Interface.ErrorStringFunc: method is nil but Interface.ErrorString was just called\")\n\t}\n\tcallInfo := struct {\n\t\tRet nvsandboxutils.Ret\n\t}{\n\t\tRet: ret,\n\t}\n\tmock.lockErrorString.Lock()\n\tmock.calls.ErrorString = append(mock.calls.ErrorString, callInfo)\n\tmock.lockErrorString.Unlock()\n\treturn mock.ErrorStringFunc(ret)\n}\n\n// ErrorStringCalls gets all the calls that were made to ErrorString.\n// Check the length with:\n//\n//\tlen(mockedInterface.ErrorStringCalls())\nfunc (mock *Interface) ErrorStringCalls() []struct {\n\tRet nvsandboxutils.Ret\n} {\n\tvar calls []struct {\n\t\tRet nvsandboxutils.Ret\n\t}\n\tmock.lockErrorString.RLock()\n\tcalls = mock.calls.ErrorString\n\tmock.lockErrorString.RUnlock()\n\treturn calls\n}\n\n// GetDriverVersion calls GetDriverVersionFunc.\nfunc (mock *Interface) GetDriverVersion() (string, nvsandboxutils.Ret) {\n\tif mock.GetDriverVersionFunc == nil {\n\t\tpanic(\"Interface.GetDriverVersionFunc: method is nil but Interface.GetDriverVersion was just called\")\n\t}\n\tcallInfo := struct {\n\t}{}\n\tmock.lockGetDriverVersion.Lock()\n\tmock.calls.GetDriverVersion = append(mock.calls.GetDriverVersion, callInfo)\n\tmock.lockGetDriverVersion.Unlock()\n\treturn mock.GetDriverVersionFunc()\n}\n\n// GetDriverVersionCalls gets all the calls that were made to GetDriverVersion.\n// Check the length with:\n//\n//\tlen(mockedInterface.GetDriverVersionCalls())\nfunc (mock *Interface) GetDriverVersionCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockGetDriverVersion.RLock()\n\tcalls = mock.calls.GetDriverVersion\n\tmock.lockGetDriverVersion.RUnlock()\n\treturn calls\n}\n\n// GetFileContent calls GetFileContentFunc.\nfunc (mock *Interface) GetFileContent(s string) (string, nvsandboxutils.Ret) {\n\tif mock.GetFileContentFunc == nil {\n\t\tpanic(\"Interface.GetFileContentFunc: method is nil but Interface.GetFileContent was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockGetFileContent.Lock()\n\tmock.calls.GetFileContent = append(mock.calls.GetFileContent, callInfo)\n\tmock.lockGetFileContent.Unlock()\n\treturn mock.GetFileContentFunc(s)\n}\n\n// GetFileContentCalls gets all the calls that were made to GetFileContent.\n// Check the length with:\n//\n//\tlen(mockedInterface.GetFileContentCalls())\nfunc (mock *Interface) GetFileContentCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockGetFileContent.RLock()\n\tcalls = mock.calls.GetFileContent\n\tmock.lockGetFileContent.RUnlock()\n\treturn calls\n}\n\n// GetGpuResource calls GetGpuResourceFunc.\nfunc (mock *Interface) GetGpuResource(s string) ([]nvsandboxutils.GpuFileInfo, nvsandboxutils.Ret) {\n\tif mock.GetGpuResourceFunc == nil {\n\t\tpanic(\"Interface.GetGpuResourceFunc: method is nil but Interface.GetGpuResource was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockGetGpuResource.Lock()\n\tmock.calls.GetGpuResource = append(mock.calls.GetGpuResource, callInfo)\n\tmock.lockGetGpuResource.Unlock()\n\treturn mock.GetGpuResourceFunc(s)\n}\n\n// GetGpuResourceCalls gets all the calls that were made to GetGpuResource.\n// Check the length with:\n//\n//\tlen(mockedInterface.GetGpuResourceCalls())\nfunc (mock *Interface) GetGpuResourceCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockGetGpuResource.RLock()\n\tcalls = mock.calls.GetGpuResource\n\tmock.lockGetGpuResource.RUnlock()\n\treturn calls\n}\n\n// Init calls InitFunc.\nfunc (mock *Interface) Init(s string) nvsandboxutils.Ret {\n\tif mock.InitFunc == nil {\n\t\tpanic(\"Interface.InitFunc: method is nil but Interface.Init was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockInit.Lock()\n\tmock.calls.Init = append(mock.calls.Init, callInfo)\n\tmock.lockInit.Unlock()\n\treturn mock.InitFunc(s)\n}\n\n// InitCalls gets all the calls that were made to Init.\n// Check the length with:\n//\n//\tlen(mockedInterface.InitCalls())\nfunc (mock *Interface) InitCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockInit.RLock()\n\tcalls = mock.calls.Init\n\tmock.lockInit.RUnlock()\n\treturn calls\n}\n\n// LookupSymbol calls LookupSymbolFunc.\nfunc (mock *Interface) LookupSymbol(s string) error {\n\tif mock.LookupSymbolFunc == nil {\n\t\tpanic(\"Interface.LookupSymbolFunc: method is nil but Interface.LookupSymbol was just called\")\n\t}\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockLookupSymbol.Lock()\n\tmock.calls.LookupSymbol = append(mock.calls.LookupSymbol, callInfo)\n\tmock.lockLookupSymbol.Unlock()\n\treturn mock.LookupSymbolFunc(s)\n}\n\n// LookupSymbolCalls gets all the calls that were made to LookupSymbol.\n// Check the length with:\n//\n//\tlen(mockedInterface.LookupSymbolCalls())\nfunc (mock *Interface) LookupSymbolCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockLookupSymbol.RLock()\n\tcalls = mock.calls.LookupSymbol\n\tmock.lockLookupSymbol.RUnlock()\n\treturn calls\n}\n\n// Shutdown calls ShutdownFunc.\nfunc (mock *Interface) Shutdown() nvsandboxutils.Ret {\n\tif mock.ShutdownFunc == nil {\n\t\tpanic(\"Interface.ShutdownFunc: method is nil but Interface.Shutdown was just called\")\n\t}\n\tcallInfo := struct {\n\t}{}\n\tmock.lockShutdown.Lock()\n\tmock.calls.Shutdown = append(mock.calls.Shutdown, callInfo)\n\tmock.lockShutdown.Unlock()\n\treturn mock.ShutdownFunc()\n}\n\n// ShutdownCalls gets all the calls that were made to Shutdown.\n// Check the length with:\n//\n//\tlen(mockedInterface.ShutdownCalls())\nfunc (mock *Interface) ShutdownCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockShutdown.RLock()\n\tcalls = mock.calls.Shutdown\n\tmock.lockShutdown.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/nvsandboxutils/nvsandboxutils.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\n// WARNING: THIS FILE WAS AUTOMATICALLY GENERATED.\n// Code generated by https://git.io/c-for-go. DO NOT EDIT.\n\npackage nvsandboxutils\n\n/*\n#cgo linux LDFLAGS: -Wl,--export-dynamic -Wl,--unresolved-symbols=ignore-in-object-files\n#cgo darwin LDFLAGS: -Wl,-undefined,dynamic_lookup\n#include \"nvsandboxutils.h\"\n#include \n#include \"cgo_helpers.h\"\n*/\nimport \"C\"\nimport \"unsafe\"\n\n// nvSandboxUtilsInit function as declared in nvsandboxutils/nvsandboxutils.h\nfunc nvSandboxUtilsInit(Input *InitInput) Ret {\n\tcInput, _ := (*C.nvSandboxUtilsInitInput_t)(unsafe.Pointer(Input)), cgoAllocsUnknown\n\t__ret := C.nvSandboxUtilsInit(cInput)\n\t__v := (Ret)(__ret)\n\treturn __v\n}\n\n// nvSandboxUtilsShutdown function as declared in nvsandboxutils/nvsandboxutils.h\nfunc nvSandboxUtilsShutdown() Ret {\n\t__ret := C.nvSandboxUtilsShutdown()\n\t__v := (Ret)(__ret)\n\treturn __v\n}\n\n// nvSandboxUtilsGetDriverVersion function as declared in nvsandboxutils/nvsandboxutils.h\nfunc nvSandboxUtilsGetDriverVersion(Version *byte, Length uint32) Ret {\n\tcVersion, _ := (*C.char)(unsafe.Pointer(Version)), cgoAllocsUnknown\n\tcLength, _ := (C.uint)(Length), cgoAllocsUnknown\n\t__ret := C.nvSandboxUtilsGetDriverVersion(cVersion, cLength)\n\t__v := (Ret)(__ret)\n\treturn __v\n}\n\n// nvSandboxUtilsGetGpuResource function as declared in nvsandboxutils/nvsandboxutils.h\nfunc nvSandboxUtilsGetGpuResource(Request *GpuRes) Ret {\n\tcRequest, _ := (*C.nvSandboxUtilsGpuRes_t)(unsafe.Pointer(Request)), cgoAllocsUnknown\n\t__ret := C.nvSandboxUtilsGetGpuResource(cRequest)\n\t__v := (Ret)(__ret)\n\treturn __v\n}\n\n// nvSandboxUtilsGetFileContent function as declared in nvsandboxutils/nvsandboxutils.h\nfunc nvSandboxUtilsGetFileContent(FilePath *byte, Content *byte, ContentSize *uint32) Ret {\n\tcFilePath, _ := (*C.char)(unsafe.Pointer(FilePath)), cgoAllocsUnknown\n\tcContent, _ := (*C.char)(unsafe.Pointer(Content)), cgoAllocsUnknown\n\tcContentSize, _ := (*C.uint)(unsafe.Pointer(ContentSize)), cgoAllocsUnknown\n\t__ret := C.nvSandboxUtilsGetFileContent(cFilePath, cContent, cContentSize)\n\t__v := (Ret)(__ret)\n\treturn __v\n}\n"
},
{
"path": "internal/nvsandboxutils/nvsandboxutils.h",
"content": "/*\n * SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n * SPDX-License-Identifier: Apache-2.0\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n#ifndef __NVSANDBOXUTILS_H__\n#define __NVSANDBOXUTILS_H__\n\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n#define INPUT_LENGTH 256\n#define MAX_FILE_PATH 256\n#define MAX_NAME_LENGTH 256\n\n/***************************************************************************************************/\n/** @defgroup enums Enumerations\n * @{\n */\n/***************************************************************************************************/\n\n/**\n * Return types\n */\ntypedef enum\n{\n NVSANDBOXUTILS_SUCCESS = 0, //!< The operation was successful\n NVSANDBOXUTILS_ERROR_UNINITIALIZED = 1, //!< The library wasn't successfully initialized\n NVSANDBOXUTILS_ERROR_NOT_SUPPORTED = 2, //!< The requested operation is not supported on target device\n NVSANDBOXUTILS_ERROR_INVALID_ARG = 3, //!< A supplied argument is invalid\n NVSANDBOXUTILS_ERROR_INSUFFICIENT_SIZE = 4, //!< A supplied argument is not large enough\n NVSANDBOXUTILS_ERROR_VERSION_NOT_SUPPORTED = 5, //!< Requested library version is not supported\n NVSANDBOXUTILS_ERROR_LIBRARY_LOAD = 6, //!< The library load failed\n NVSANDBOXUTILS_ERROR_FUNCTION_NOT_FOUND = 7, //!< Called function was not found\n NVSANDBOXUTILS_ERROR_DEVICE_NOT_FOUND = 8, //!< Target device was not found\n NVSANDBOXUTILS_ERROR_NVML_LIB_CALL = 9, //!< NVML library call failed\n NVSANDBOXUTILS_ERROR_OUT_OF_MEMORY = 10, //!< There is insufficient memory\n NVSANDBOXUTILS_ERROR_FILEPATH_NOT_FOUND = 11, //!< A supplied file path was not found\n NVSANDBOXUTILS_ERROR_UNKNOWN = 0xFFFF, //!< Unknown error occurred\n} nvSandboxUtilsRet_t;\n\n/**\n * Return if there is an error\n */\n#define RETURN_ON_SANDBOX_ERROR(result) \\\n if ((result) != NVSANDBOXUTILS_SUCCESS) { \\\n NVSANDBOXUTILS_ERROR_MSG(\"%s %d result=%d\", __func__, __LINE__, result); \\\n return result; \\\n }\n\n/**\n * Log levels\n */\ntypedef enum\n{\n NVSANDBOXUTILS_LOG_LEVEL_FATAL = 0, //!< Log fatal errors\n NVSANDBOXUTILS_LOG_LEVEL_ERROR = 1, //!< Log all errors\n NVSANDBOXUTILS_LOG_LEVEL_WARN = 2, //!< Log all warnings\n NVSANDBOXUTILS_LOG_LEVEL_DEBUG = 3, //!< Log all debug messages\n NVSANDBOXUTILS_LOG_LEVEL_INFO = 4, //!< Log all info messages\n NVSANDBOXUTILS_LOG_LEVEL_NONE = 0xFFFF, //!< Log none\n} nvSandboxUtilsLogLevel_t;\n\n/**\n * Input rootfs to help access files inside the driver container\n */\ntypedef enum\n{\n NV_ROOTFS_DEFAULT, //!< Default no rootfs\n NV_ROOTFS_PATH, //!< /run/nvidia/driver\n NV_ROOTFS_PID, //!< /proc/PID/mountinfo\n} nvSandboxUtilsRootfsInputType_t;\n\n/**\n * File type\n */\ntypedef enum\n{\n NV_DEV, //!< /dev file system\n NV_PROC, //!< /proc file system\n NV_SYS, //!< /sys file system\n} nvSandboxUtilsFileType_t;\n\n/**\n * File subtype\n */\ntypedef enum\n{\n NV_DEV_NVIDIA, //!< /dev/nvidia0\n NV_DEV_DRI_CARD, //!< /dev/dri/card1\n NV_DEV_DRI_RENDERD, //!< /dev/dri/renderD128\n NV_DEV_DRI_CARD_SYMLINK, //!< /dev/dri/by-path/pci-0000:41:00.0-card\n NV_DEV_DRI_RENDERD_SYMLINK, //!< /dev/dri/by-path/pci-0000:41:00.0-render\n NV_DEV_NVIDIA_UVM, //!< /dev/nvidia-uvm\n NV_DEV_NVIDIA_UVM_TOOLS, //!< /dev/nvidia-uvm-tools\n NV_DEV_NVIDIA_MODESET, //!< /dev/nvidia-uvm-modeset\n NV_DEV_NVIDIA_CTL, //!< /dev/nvidiactl\n NV_DEV_GDRDRV, //!< /dev/gdrdrv\n NV_DEV_NVIDIA_CAPS_NVIDIA_CAP, //!< /dev/nvidia-caps/nvidia-cap22\n NV_PROC_DRIVER_NVIDIA_GPUS_PCIBUSID, //!< /proc/driver/nvidia/gpus/0000:2d:00.0\n NV_PROC_DRIVER_NVIDIA_GPUS, //!< /proc/driver/nvidia/gpus (for mask out)\n NV_PROC_NVIDIA_PARAMS, //!< /proc/driver/nvidia/params\n NV_PROC_NVIDIA_CAPS_MIG_MINORS, //!< /proc/driver/nvidia-caps/mig-minors\n NV_PROC_DRIVER_NVIDIA_CAPABILITIES_GPU, //!< /proc/driver/nvidia/capabilities/gpu0\n NV_PROC_DRIVER_NVIDIA_CAPABILITIES, //!< /proc/driver/nvidia/capabilities (for mask out)\n NV_PROC_DRIVER_NVIDIA_CAPABILITIIES_GPU_MIG_CI_ACCESS, //!< proc/driver/nvidia/capabilities/gpu0/mig/gi2/ci0/access\n NV_SYS_MODULE_NVIDIA_DRIVER_PCIBUSID, //!< /sys/module/nvidia/drivers/pci:nvidia/0000:2d:00.0\n NV_SYS_MODULE_NVIDIA_DRIVER, //!< /sys/module/nvidia/drivers/pci:nvidia (for mask out)\n NV_NUM_SUBTYPE, // always at the end.\n} nvSandboxUtilsFileSystemSubType_t;\n\n/**\n * File module\n */\ntypedef enum\n{\n NV_GPU, //!< Target device\n NV_MIG, //!< Target device- MIG\n NV_DRIVER_NVIDIA, //!< NVIDIA kernel driver\n NV_DRIVER_NVIDIA_UVM, //!< NVIDIA kernel driver-UVM\n NV_DRIVER_NVIDIA_MODESET, //!< NVIDIA kernel driver-modeset\n NV_DRIVER_GDRDRV, //!< GDRDRV driver\n NV_SYSTEM, //!< System module\n} nvSandboxUtilsFileModule_t;\n\n/**\n * Flag to provide additional details about the file\n */\ntypedef enum\n{\n NV_FILE_FLAG_HINT = (1 << 0), //!< Default no hint\n NV_FILE_FLAG_MASKOUT = (1 << 1), //!< For /proc/driver/nvidia/gpus\n NV_FILE_FLAG_CONTENT = (1 << 2), //!< For /proc/driver/nvidia/params\n //!< For SYMLINK\n //!< Use \\p nvSandboxUtilsGetFileContent to get name of the linked file\n NV_FILE_FLAG_DEPRECTATED = (1 << 3), //!< For all the FIRMWARE GSP file\n NV_FILE_FLAG_CANDIDATES = (1 << 4), //!< For libcuda.so\n} nvSandboxUtilsFileFlag_t;\n\n/**\n * Input type of the target device\n */\ntypedef enum\n{\n NV_GPU_INPUT_GPU_UUID, //!< GPU UUID\n NV_GPU_INPUT_MIG_UUID, //!< MIG UUID\n NV_GPU_INPUT_PCI_ID, //!< PCIe DBDF ID\n NV_GPU_INPUT_PCI_INDEX, //!< PCIe bus order (0 points to the GPU that has lowest PCIe BDF)\n} nvSandboxUtilsGpuInputType_t;\n\n/** @} */\n\n/***************************************************************************************************/\n/** @defgroup dataTypes Structures and Unions\n * @{\n */\n/***************************************************************************************************/\n\n/**\n * Initalization input v1\n */\ntypedef struct\n{\n unsigned int version; //!< Version for the structure\n nvSandboxUtilsRootfsInputType_t type; //!< One of \\p nvSandboxUtilsRootfsInputType_t\n char value[INPUT_LENGTH]; //!< String representation of input\n} nvSandboxUtilsInitInput_v1_t;\n\ntypedef nvSandboxUtilsInitInput_v1_t nvSandboxUtilsInitInput_t;\n\n/**\n * File system information\n */\ntypedef struct nvSandboxUtilsGpuFileInfo_v1_t\n{\n struct nvSandboxUtilsGpuFileInfo_v1_t *next; //!< Pointer to the next node in the linked list\n nvSandboxUtilsFileType_t fileType; //!< One of \\p nvSandboxUtilsFileType_t\n nvSandboxUtilsFileSystemSubType_t fileSubType; //!< One of \\p nvSandboxUtilsFileSystemSubType_t\n nvSandboxUtilsFileModule_t module; //!< One of \\p nvSandboxUtilsFileModule_t\n nvSandboxUtilsFileFlag_t flags; //!< One of \\p nvSandboxUtilsFileFlag_t\n char *filePath; //!< Relative file path to rootfs\n}nvSandboxUtilsGpuFileInfo_v1_t;\n\n/**\n * GPU resource request v1\n */\ntypedef struct\n{\n unsigned int version; //!< Version for the structure\n nvSandboxUtilsGpuInputType_t inputType; //!< One of \\p nvSandboxUtilsGpuInputType_t\n char input[INPUT_LENGTH]; //!< String representation of input\n nvSandboxUtilsGpuFileInfo_v1_t *files; //!< Linked list of \\ref nvSandboxUtilsGpuFileInfo_v1_t\n} nvSandboxUtilsGpuRes_v1_t;\n\ntypedef nvSandboxUtilsGpuRes_v1_t nvSandboxUtilsGpuRes_t;\n\n/** @} */\n\n/***************************************************************************************************/\n/** @defgroup funcs Functions\n * @{\n */\n/***************************************************************************************************/\n\n/* *************************************************\n * Initialize library\n * *************************************************\n */\n/**\n * Prepare library resources before library API can be used.\n * This initialization will not fail if one of the initialization prerequisites fails.\n * @param input Reference to the called-supplied input struct that has initialization fields\n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n * @returns @ref NVSANDBOXUTILS_ERROR_INVALID_ARG if \\p input->value isn't a valid rootfs path\n * @returns @ref NVSANDBOXUTILS_ERROR_VERSION_NOT_SUPPORTED if \\p input->version isn't supported by the library\n * @returns @ref NVSANDBOXUTILS_ERROR_FILEPATH_NOT_FOUND if any of the required file paths are not found during initialization\n * @returns @ref NVSANDBOXUTILS_ERROR_OUT_OF_MEMORY if there is insufficient system memory during initialization\n * @returns @ref NVSANDBOXUTILS_ERROR_LIBRARY_LOAD on any error during loading the library\n */\nnvSandboxUtilsRet_t nvSandboxUtilsInit(nvSandboxUtilsInitInput_t *input);\n\n/* *************************************************\n * Shutdown library\n * *************************************************\n */\n/**\n * Clean up library resources created by init call\n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n */\nnvSandboxUtilsRet_t nvSandboxUtilsShutdown(void);\n\n/* *************************************************\n * Get NVIDIA RM driver version\n * *************************************************\n */\n/**\n * Get NVIDIA RM driver version\n * @param version Reference to caller-supplied buffer to return driver version string\n * @param length The maximum allowed length of the string returned in \\p version\n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n * @returns @ref NVSANDBOXUTILS_ERROR_INVALID_ARG if \\p version is NULL\n * @returns @ref NVSANDBOXUTILS_ERROR_NVML_LIB_CALL on any error during driver version query from NVML\n */\nnvSandboxUtilsRet_t nvSandboxUtilsGetDriverVersion(char *version, unsigned int length);\n\n/* *************************************************\n * Get /dev, /proc, /sys file system information\n * *************************************************\n */\n/**\n * Get /dev, /proc, /sys file system information\n * @param request Reference to caller-supplied request struct to return the file system information\n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n * @returns @ref NVSANDBOXUTILS_ERROR_INVALID_ARG if \\p request->input doesn't match any device\n * @returns @ref NVSANDBOXUTILS_ERROR_VERSION_NOT_SUPPORTED if \\p request->version isn't supported by the library\n */\nnvSandboxUtilsRet_t nvSandboxUtilsGetGpuResource(nvSandboxUtilsGpuRes_t *request);\n\n/* *************************************************\n * Get content of given file path\n * *************************************************\n */\n/**\n * Get file content of input file path\n * @param filePath Reference to the file path\n * @param content Reference to the caller-supplied buffer to return the file content\n * @param contentSize Reference to the maximum allowed size of content. It is updated to the actual size of the content on return\n *\n * @returns @ref NVSANDBOXUTILS_SUCCESS on success\n * @returns @ref NVSANDBOXUTILS_ERROR_INVALID_ARG if \\p filePath or \\p content is NULL\n * @returns @ref NVSANDBOXUTILS_ERROR_INSUFFICIENT_SIZE if \\p contentSize is too small\n * @returns @ref NVSANDBOXUTILS_ERROR_FILEPATH_NOT_FOUND on an error while obtaining the content for the file path\n */\nnvSandboxUtilsRet_t nvSandboxUtilsGetFileContent(char *filePath, char *content, unsigned int *contentSize);\n\n/** @} */\n\n#ifdef __cplusplus\n}\n#endif\n#endif // __NVSANDBOXUTILS_H__\n"
},
{
"path": "internal/nvsandboxutils/refcount.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\ntype refcount int\n\nfunc (r *refcount) IncOnNoError(err error) {\n\tif err == nil {\n\t\t(*r)++\n\t}\n}\n\nfunc (r *refcount) DecOnNoError(err error) {\n\tif err == nil && (*r) > 0 {\n\t\t(*r)--\n\t}\n}\n"
},
{
"path": "internal/nvsandboxutils/refcount_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestRefcount(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tworkload func(r *refcount)\n\t\texpectedRefcount refcount\n\t}{\n\t\t{\n\t\t\tdescription: \"No inc or dec\",\n\t\t\tworkload: func(r *refcount) {},\n\t\t\texpectedRefcount: refcount(0),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Single inc, no error\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t},\n\t\t\texpectedRefcount: refcount(1),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Single inc, with error\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(errors.New(\"\"))\n\t\t\t},\n\t\t\texpectedRefcount: refcount(0),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Double inc, no error\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t},\n\t\t\texpectedRefcount: refcount(2),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Double inc, one with error\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.IncOnNoError(errors.New(\"\"))\n\t\t\t},\n\t\t\texpectedRefcount: refcount(1),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Single dec, no error\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t},\n\t\t\texpectedRefcount: refcount(0),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Single dec, with error\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.DecOnNoError(errors.New(\"\"))\n\t\t\t},\n\t\t\texpectedRefcount: refcount(0),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Single inc, single dec, no errors\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t},\n\t\t\texpectedRefcount: refcount(0),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Double inc, Double dec, no errors\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t},\n\t\t\texpectedRefcount: refcount(0),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Double inc, Double dec, one inc error\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.IncOnNoError(errors.New(\"\"))\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t},\n\t\t\texpectedRefcount: refcount(0),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Double inc, Double dec, one dec error\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t\tr.DecOnNoError(errors.New(\"\"))\n\t\t\t},\n\t\t\texpectedRefcount: refcount(1),\n\t\t},\n\t\t{\n\t\t\tdescription: \"Double inc, Tripple dec, one dec error early on\",\n\t\t\tworkload: func(r *refcount) {\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.IncOnNoError(nil)\n\t\t\t\tr.DecOnNoError(errors.New(\"\"))\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t\tr.DecOnNoError(nil)\n\t\t\t},\n\t\t\texpectedRefcount: refcount(0),\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tvar r refcount\n\t\t\ttc.workload(&r)\n\t\t\trequire.Equal(t, tc.expectedRefcount, r)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/nvsandboxutils/return.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvsandboxutils\n\nimport (\n\t\"fmt\"\n)\n\n// nvsandboxutils.ErrorString()\nfunc (l *library) ErrorString(r Ret) string {\n\treturn r.Error()\n}\n\n// String returns the string representation of a Ret.\nfunc (r Ret) String() string {\n\treturn r.Error()\n}\n\n// Error returns the string representation of a Ret.\nfunc (r Ret) Error() string {\n\treturn errorStringFunc(r)\n}\n\n// Assigned to nvsandboxutils.ErrorString if the system nvsandboxutils library is in use.\nvar errorStringFunc = defaultErrorStringFunc\n\n// nvsanboxutilsErrorString is an alias for the default error string function.\nvar nvsanboxutilsErrorString = defaultErrorStringFunc\n\n// defaultErrorStringFunc provides a basic nvsandboxutils.ErrorString implementation.\n// This allows the nvsandboxutils.ErrorString function to be used even if the nvsandboxutils library\n// is not loaded.\nvar defaultErrorStringFunc = func(r Ret) string {\n\tswitch r {\n\tcase SUCCESS:\n\t\treturn \"SUCCESS\"\n\tcase ERROR_UNINITIALIZED:\n\t\treturn \"ERROR_UNINITIALIZED\"\n\tcase ERROR_NOT_SUPPORTED:\n\t\treturn \"ERROR_NOT_SUPPORTED\"\n\tcase ERROR_INVALID_ARG:\n\t\treturn \"ERROR_INVALID_ARG\"\n\tcase ERROR_INSUFFICIENT_SIZE:\n\t\treturn \"ERROR_INSUFFICIENT_SIZE\"\n\tcase ERROR_VERSION_NOT_SUPPORTED:\n\t\treturn \"ERROR_VERSION_NOT_SUPPORTED\"\n\tcase ERROR_LIBRARY_LOAD:\n\t\treturn \"ERROR_LIBRARY_LOAD\"\n\tcase ERROR_FUNCTION_NOT_FOUND:\n\t\treturn \"ERROR_FUNCTION_NOT_FOUND\"\n\tcase ERROR_DEVICE_NOT_FOUND:\n\t\treturn \"ERROR_DEVICE_NOT_FOUND\"\n\tcase ERROR_NVML_LIB_CALL:\n\t\treturn \"ERROR_NVML_LIB_CALL\"\n\tcase ERROR_UNKNOWN:\n\t\treturn \"ERROR_UNKNOWN\"\n\tdefault:\n\t\treturn fmt.Sprintf(\"unknown return value: %d\", r)\n\t}\n}\n"
},
{
"path": "internal/nvsandboxutils/types_gen.go",
"content": "// Code generated by cmd/cgo -godefs; DO NOT EDIT.\n// cgo -godefs types.go\n\npackage nvsandboxutils\n\ntype InitInput_v1 struct {\n\tVersion uint32\n\tType uint32\n\tValue [256]int8\n}\n\ntype InitInput struct {\n\tVersion uint32\n\tType uint32\n\tValue [256]int8\n}\n\ntype GpuFileInfo_v1 struct {\n\tNext *GpuFileInfo_v1\n\tFileType uint32\n\tFileSubType uint32\n\tModule uint32\n\tFlags uint32\n\tFilePath *int8\n}\n\ntype GpuRes_v1 struct {\n\tVersion uint32\n\tInputType uint32\n\tInput [256]int8\n\tFiles *GpuFileInfo_v1\n}\n\ntype GpuRes struct {\n\tVersion uint32\n\tInputType uint32\n\tInput [256]int8\n\tFiles *GpuFileInfo_v1\n}\n"
},
{
"path": "internal/nvsandboxutils/zz_generated.api.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\n// Generated Code; DO NOT EDIT.\n\npackage nvsandboxutils\n\n// The variables below represent package level methods from the library type.\nvar (\n\tErrorString = libnvsandboxutils.ErrorString\n\tGetDriverVersion = libnvsandboxutils.GetDriverVersion\n\tGetFileContent = libnvsandboxutils.GetFileContent\n\tGetGpuResource = libnvsandboxutils.GetGpuResource\n\tInit = libnvsandboxutils.Init\n\tLookupSymbol = libnvsandboxutils.LookupSymbol\n\tShutdown = libnvsandboxutils.Shutdown\n)\n\n// Interface represents the interface for the library type.\n//\n//go:generate moq -rm -fmt=goimports -out mock/interface.go -pkg mock . Interface:Interface\ntype Interface interface {\n\tErrorString(Ret) string\n\tGetDriverVersion() (string, Ret)\n\tGetFileContent(string) (string, Ret)\n\tGetGpuResource(string) ([]GpuFileInfo, Ret)\n\tInit(string) Ret\n\tLookupSymbol(string) error\n\tShutdown() Ret\n}\n"
},
{
"path": "internal/oci/args.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n)\n\nconst (\n\tspecFileName = \"config.json\"\n)\n\n// GetBundleDir returns the bundle directory or default depending on the\n// supplied command line arguments.\nfunc GetBundleDir(args []string) (string, error) {\n\tbundleDir, err := GetBundleDirFromArgs(args)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error getting bundle dir from args: %v\", err)\n\t}\n\n\treturn bundleDir, nil\n}\n\n// GetBundleDirFromArgs checks the specified slice of strings (argv) for a 'bundle' flag as allowed by runc.\n// The following are supported:\n// --bundle{{SEP}}BUNDLE_PATH\n// -bundle{{SEP}}BUNDLE_PATH\n// -b{{SEP}}BUNDLE_PATH\n// where {{SEP}} is either ' ' or '='\nfunc GetBundleDirFromArgs(args []string) (string, error) {\n\tvar bundleDir string\n\n\tfor i := 0; i < len(args); i++ {\n\t\tparam := args[i]\n\n\t\tparts := strings.SplitN(param, \"=\", 2)\n\t\tif !IsBundleFlag(parts[0]) {\n\t\t\tcontinue\n\t\t}\n\n\t\t// The flag has the format --bundle=/path\n\t\tif len(parts) == 2 {\n\t\t\tbundleDir = parts[1]\n\t\t\tcontinue\n\t\t}\n\n\t\t// The flag has the format --bundle /path\n\t\tif i+1 < len(args) {\n\t\t\tbundleDir = args[i+1]\n\t\t\ti++\n\t\t\tcontinue\n\t\t}\n\n\t\t// --bundle / -b was the last element of args\n\t\treturn \"\", fmt.Errorf(\"bundle option requires an argument\")\n\t}\n\n\treturn bundleDir, nil\n}\n\n// GetSpecFilePath returns the expected path to the OCI specification file for the given\n// bundle directory.\nfunc GetSpecFilePath(bundleDir string) string {\n\tspecFilePath := filepath.Join(bundleDir, specFileName)\n\treturn specFilePath\n}\n\n// IsBundleFlag is a helper function that checks wither the specified argument represents\n// a bundle flag (--bundle or -b)\nfunc IsBundleFlag(arg string) bool {\n\tif !strings.HasPrefix(arg, \"-\") {\n\t\treturn false\n\t}\n\n\ttrimmed := strings.TrimLeft(arg, \"-\")\n\treturn trimmed == \"b\" || trimmed == \"bundle\"\n}\n\n// HasCreateSubcommand checks the supplied arguments for a 'create' subcommand\nfunc HasCreateSubcommand(args []string) bool {\n\tvar previousWasBundle bool\n\tfor _, a := range args {\n\t\t// We check for '--bundle create' explicitly to ensure that we\n\t\t// don't inadvertently trigger a modification if the bundle directory\n\t\t// is specified as `create`\n\t\tif !previousWasBundle && IsBundleFlag(a) {\n\t\t\tpreviousWasBundle = true\n\t\t\tcontinue\n\t\t}\n\n\t\tif !previousWasBundle && a == \"create\" {\n\t\t\treturn true\n\t\t}\n\n\t\tpreviousWasBundle = false\n\t}\n\n\treturn false\n}\n"
},
{
"path": "internal/oci/args_test.go",
"content": "package oci\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetBundleDir(t *testing.T) {\n\ttype expected struct {\n\t\tbundle string\n\t\tisError bool\n\t}\n\ttestCases := []struct {\n\t\targv []string\n\t\texpected expected\n\t}{\n\t\t{\n\t\t\targv: []string{},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"create\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"--bundle\"},\n\t\t\texpected: expected{\n\t\t\t\tisError: true,\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"-b\"},\n\t\t\texpected: expected{\n\t\t\t\tisError: true,\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"--bundle\", \"/foo/bar\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"/foo/bar\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"--not-bundle\", \"/foo/bar\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"--\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"-bundle\", \"/foo/bar\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"/foo/bar\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"--bundle=/foo/bar\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"/foo/bar\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"-b=/foo/bar\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"/foo/bar\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"-b=/foo/=bar\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"/foo/=bar\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"-b\", \"/foo/bar\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"/foo/bar\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"create\", \"-b\", \"/foo/bar\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"/foo/bar\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"-b\", \"create\", \"create\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"create\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"-b=create\", \"create\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"create\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\targv: []string{\"-b\", \"create\"},\n\t\t\texpected: expected{\n\t\t\t\tbundle: \"create\",\n\t\t\t},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tbundle, err := GetBundleDir(tc.argv)\n\n\t\tif tc.expected.isError {\n\t\t\trequire.Errorf(t, err, \"%d: %v\", i, tc)\n\t\t} else {\n\t\t\trequire.NoErrorf(t, err, \"%d: %v\", i, tc)\n\t\t}\n\n\t\trequire.Equalf(t, tc.expected.bundle, bundle, \"%d: %v\", i, tc)\n\t}\n}\n\nfunc TestGetSpecFilePathAppendsFilename(t *testing.T) {\n\ttestCases := []struct {\n\t\tbundleDir string\n\t\texpected string\n\t}{\n\t\t{\n\t\t\tbundleDir: \"\",\n\t\t\texpected: \"config.json\",\n\t\t},\n\t\t{\n\t\t\tbundleDir: \"/not/empty/\",\n\t\t\texpected: \"/not/empty/config.json\",\n\t\t},\n\t\t{\n\t\t\tbundleDir: \"not/absolute\",\n\t\t\texpected: \"not/absolute/config.json\",\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tspecPath := GetSpecFilePath(tc.bundleDir)\n\n\t\trequire.Equalf(t, tc.expected, specPath, \"%d: %v\", i, tc)\n\t}\n}\n\nfunc TestHasCreateSubcommand(t *testing.T) {\n\ttestCases := []struct {\n\t\targs []string\n\t\tshouldModify bool\n\t}{\n\t\t{\n\t\t\tshouldModify: false,\n\t\t},\n\t\t{\n\t\t\targs: []string{\"create\"},\n\t\t\tshouldModify: true,\n\t\t},\n\t\t{\n\t\t\targs: []string{\"--bundle=create\"},\n\t\t\tshouldModify: false,\n\t\t},\n\t\t{\n\t\t\targs: []string{\"--bundle\", \"create\"},\n\t\t\tshouldModify: false,\n\t\t},\n\t\t{\n\t\t\targs: []string{\"create\"},\n\t\t\tshouldModify: true,\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\trequire.Equal(t, tc.shouldModify, HasCreateSubcommand(tc.args), \"%d: %v\", i, tc)\n\t}\n}\n"
},
{
"path": "internal/oci/options.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage oci\n\nimport \"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\ntype options struct {\n\tlogger logger.Interface\n\tallowUnkownFields bool\n}\n\ntype Option func(*options)\n\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(o *options) {\n\t\to.logger = logger\n\t}\n}\n\nfunc WithAllowUnknownFields(allowUnknownFields bool) Option {\n\treturn func(o *options) {\n\t\to.allowUnkownFields = allowUnknownFields\n\t}\n}\n"
},
{
"path": "internal/oci/runtime.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\n// Runtime is an interface for a runtime shim. The Exec method accepts a list\n// of command line arguments, and returns an error / nil.\n//\n//go:generate moq -rm -fmt=goimports -stub -out runtime_mock.go . Runtime\ntype Runtime interface {\n\tExec([]string) error\n\tString() string\n}\n"
},
{
"path": "internal/oci/runtime_low_level.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// NewLowLevelRuntime creates a Runtime that wraps a low-level runtime executable.\n// The executable specified is taken from the list of supplied candidates, with the first match\n// present in the PATH being selected. A logger is also specified.\nfunc NewLowLevelRuntime(logger logger.Interface, candidates []string) (Runtime, error) {\n\truntimePath, err := findRuntime(logger, candidates)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error locating runtime: %v\", err)\n\t}\n\treturn NewRuntimeForPath(logger, runtimePath)\n}\n\n// findRuntime checks elements in a list of supplied candidates for a matching executable in the PATH.\n// The absolute path to the first match is returned.\nfunc findRuntime(logger logger.Interface, candidates []string) (string, error) {\n\tif len(candidates) == 0 {\n\t\treturn \"\", fmt.Errorf(\"at least one runtime candidate must be specified\")\n\t}\n\n\tlocator := lookup.NewExecutableLocator(logger, \"/\")\n\tfor _, candidate := range candidates {\n\t\tlogger.Tracef(\"Looking for runtime binary '%v'\", candidate)\n\t\ttargets, err := locator.Locate(candidate)\n\t\tif err == nil && len(targets) > 0 {\n\t\t\tlogger.Tracef(\"Found runtime binary '%v'\", targets)\n\t\t\treturn targets[0], nil\n\t\t}\n\t}\n\n\treturn \"\", fmt.Errorf(\"no runtime binary found from candidate list: %v\", candidates)\n}\n"
},
{
"path": "internal/oci/runtime_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage oci\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that RuntimeMock does implement Runtime.\n// If this is not the case, regenerate this file with moq.\nvar _ Runtime = &RuntimeMock{}\n\n// RuntimeMock is a mock implementation of Runtime.\n//\n//\tfunc TestSomethingThatUsesRuntime(t *testing.T) {\n//\n//\t\t// make and configure a mocked Runtime\n//\t\tmockedRuntime := &RuntimeMock{\n//\t\t\tExecFunc: func(strings []string) error {\n//\t\t\t\tpanic(\"mock out the Exec method\")\n//\t\t\t},\n//\t\t\tStringFunc: func() string {\n//\t\t\t\tpanic(\"mock out the String method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedRuntime in code that requires Runtime\n//\t\t// and then make assertions.\n//\n//\t}\ntype RuntimeMock struct {\n\t// ExecFunc mocks the Exec method.\n\tExecFunc func(strings []string) error\n\n\t// StringFunc mocks the String method.\n\tStringFunc func() string\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Exec holds details about calls to the Exec method.\n\t\tExec []struct {\n\t\t\t// Strings is the strings argument value.\n\t\t\tStrings []string\n\t\t}\n\t\t// String holds details about calls to the String method.\n\t\tString []struct {\n\t\t}\n\t}\n\tlockExec sync.RWMutex\n\tlockString sync.RWMutex\n}\n\n// Exec calls ExecFunc.\nfunc (mock *RuntimeMock) Exec(strings []string) error {\n\tcallInfo := struct {\n\t\tStrings []string\n\t}{\n\t\tStrings: strings,\n\t}\n\tmock.lockExec.Lock()\n\tmock.calls.Exec = append(mock.calls.Exec, callInfo)\n\tmock.lockExec.Unlock()\n\tif mock.ExecFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.ExecFunc(strings)\n}\n\n// ExecCalls gets all the calls that were made to Exec.\n// Check the length with:\n//\n//\tlen(mockedRuntime.ExecCalls())\nfunc (mock *RuntimeMock) ExecCalls() []struct {\n\tStrings []string\n} {\n\tvar calls []struct {\n\t\tStrings []string\n\t}\n\tmock.lockExec.RLock()\n\tcalls = mock.calls.Exec\n\tmock.lockExec.RUnlock()\n\treturn calls\n}\n\n// String calls StringFunc.\nfunc (mock *RuntimeMock) String() string {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockString.Lock()\n\tmock.calls.String = append(mock.calls.String, callInfo)\n\tmock.lockString.Unlock()\n\tif mock.StringFunc == nil {\n\t\tvar (\n\t\t\tsOut string\n\t\t)\n\t\treturn sOut\n\t}\n\treturn mock.StringFunc()\n}\n\n// StringCalls gets all the calls that were made to String.\n// Check the length with:\n//\n//\tlen(mockedRuntime.StringCalls())\nfunc (mock *RuntimeMock) StringCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockString.RLock()\n\tcalls = mock.calls.String\n\tmock.lockString.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/oci/runtime_modifier.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype modifyingRuntimeWrapper struct {\n\tlogger logger.Interface\n\truntime Runtime\n\tociSpec Spec\n\tmodifier SpecModifier\n}\n\nvar _ Runtime = (*modifyingRuntimeWrapper)(nil)\n\n// NewModifyingRuntimeWrapper creates a runtime wrapper that applies the specified modifier to the OCI specification\n// before invoking the wrapped runtime. If the modifier is nil, the input runtime is returned.\nfunc NewModifyingRuntimeWrapper(logger logger.Interface, runtime Runtime, spec Spec, modifier SpecModifier) Runtime {\n\tif modifier == nil {\n\t\tlogger.Tracef(\"Using low-level runtime with no modification\")\n\t\treturn runtime\n\t}\n\n\trt := modifyingRuntimeWrapper{\n\t\tlogger: logger,\n\t\truntime: runtime,\n\t\tociSpec: spec,\n\t\tmodifier: modifier,\n\t}\n\treturn &rt\n}\n\n// Exec checks whether a modification of the OCI specification is required and modifies it accordingly before exec-ing\n// into the wrapped runtime.\nfunc (r *modifyingRuntimeWrapper) Exec(args []string) error {\n\tif HasCreateSubcommand(args) {\n\t\tr.logger.Debugf(\"Create command detected; applying OCI specification modifications\")\n\t\terr := r.modify()\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"could not apply required modification to OCI specification: %w\", err)\n\t\t}\n\t\tr.logger.Debugf(\"Applied required modification to OCI specification\")\n\t}\n\n\tr.logger.Debugf(\"Forwarding command to runtime %v\", r.runtime.String())\n\treturn r.runtime.Exec(args)\n}\n\n// modify loads, modifies, and flushes the OCI specification using the defined Modifier\nfunc (r *modifyingRuntimeWrapper) modify() error {\n\t_, err := r.ociSpec.Load()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error loading OCI specification for modification: %v\", err)\n\t}\n\n\terr = r.ociSpec.Modify(r.modifier)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error modifying OCI spec: %v\", err)\n\t}\n\n\terr = r.ociSpec.Flush()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error writing modified OCI specification: %v\", err)\n\t}\n\treturn nil\n}\n\n// String returns a string representation of the runtime.\nfunc (r *modifyingRuntimeWrapper) String() string {\n\treturn fmt.Sprintf(\"modify on-create and forward to %s\", r.runtime.String())\n}\n"
},
{
"path": "internal/oci/runtime_modifier_test.go",
"content": "/*\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestExec(t *testing.T) {\n\tlogger, hook := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tshouldLoad bool\n\t\tshouldModify bool\n\t\tshouldFlush bool\n\t\tshouldForward bool\n\t\targs []string\n\t\tmodifyError error\n\t\twriteError error\n\t\tmodifer SpecModifier\n\t}{\n\t\t{\n\t\t\tdescription: \"no args forwards\",\n\t\t\tshouldLoad: false,\n\t\t\tshouldModify: false,\n\t\t\tshouldFlush: false,\n\t\t\tshouldForward: true,\n\t\t\tmodifer: &modiferMock{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"create modifies\",\n\t\t\targs: []string{\"create\"},\n\t\t\tshouldLoad: true,\n\t\t\tshouldModify: true,\n\t\t\tshouldFlush: true,\n\t\t\tshouldForward: true,\n\t\t\tmodifer: &modiferMock{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"modify error does not write or forward\",\n\t\t\targs: []string{\"create\"},\n\t\t\tmodifyError: fmt.Errorf(\"error modifying\"),\n\t\t\tshouldLoad: true,\n\t\t\tshouldModify: true,\n\t\t\tshouldFlush: false,\n\t\t\tshouldForward: false,\n\t\t\tmodifer: &modiferMock{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"write error does not forward\",\n\t\t\targs: []string{\"create\"},\n\t\t\twriteError: fmt.Errorf(\"error writing\"),\n\t\t\tshouldLoad: true,\n\t\t\tshouldModify: true,\n\t\t\tshouldFlush: true,\n\t\t\tshouldForward: false,\n\t\t\tmodifer: &modiferMock{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"nil modifier forwards on create\",\n\t\t\targs: []string{\"create\"},\n\t\t\tshouldLoad: false,\n\t\t\tshouldModify: false,\n\t\t\tshouldFlush: false,\n\t\t\tshouldForward: true,\n\t\t\tmodifer: nil,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\thook.Reset()\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\truntimeMock := &RuntimeMock{}\n\t\t\tspecMock := &SpecMock{\n\t\t\t\tModifyFunc: func(specModifier SpecModifier) error {\n\t\t\t\t\treturn tc.modifyError\n\t\t\t\t},\n\t\t\t\tFlushFunc: func() error {\n\t\t\t\t\treturn tc.writeError\n\t\t\t\t},\n\t\t\t}\n\n\t\t\tshim := NewModifyingRuntimeWrapper(\n\t\t\t\tlogger,\n\t\t\t\truntimeMock,\n\t\t\t\tspecMock,\n\t\t\t\t// TODO: We should test the interactions with the SpecModifier too\n\t\t\t\ttc.modifer,\n\t\t\t)\n\n\t\t\terr := shim.Exec(tc.args)\n\t\t\tif tc.modifyError != nil || tc.writeError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\tif tc.shouldLoad {\n\t\t\t\trequire.Equal(t, 1, len(specMock.LoadCalls()))\n\t\t\t} else {\n\t\t\t\trequire.Equal(t, 0, len(specMock.LoadCalls()))\n\t\t\t}\n\t\t\tif tc.shouldModify {\n\t\t\t\trequire.Equal(t, 1, len(specMock.ModifyCalls()))\n\t\t\t} else {\n\t\t\t\trequire.Equal(t, 0, len(specMock.ModifyCalls()))\n\t\t\t}\n\t\t\tif tc.shouldFlush {\n\t\t\t\trequire.Equal(t, 1, len(specMock.FlushCalls()))\n\t\t\t} else {\n\t\t\t\trequire.Equal(t, 0, len(specMock.FlushCalls()))\n\t\t\t}\n\t\t\tif tc.shouldForward {\n\t\t\t\trequire.Equal(t, 1, len(runtimeMock.ExecCalls()))\n\t\t\t} else {\n\t\t\t\trequire.Equal(t, 0, len(runtimeMock.ExecCalls()))\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestNilModiferReturnsRuntime(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\truntimeMock := &RuntimeMock{}\n\tspecMock := &SpecMock{}\n\n\tshim := NewModifyingRuntimeWrapper(\n\t\tlogger,\n\t\truntimeMock,\n\t\tspecMock,\n\t\tnil,\n\t)\n\n\trequire.Equal(t, runtimeMock, shim)\n}\n\ntype modiferMock struct{}\n\nfunc (m modiferMock) Modify(*specs.Spec) error {\n\treturn nil\n}\n"
},
{
"path": "internal/oci/runtime_path.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// pathRuntime wraps the path that a binary and defines the semantics for how to exec into it.\n// This can be used to wrap an OCI-compliant low-level runtime binary, allowing it to be used through the\n// Runtime internface.\ntype pathRuntime struct {\n\tlogger logger.Interface\n\tpath string\n\texecRuntime Runtime\n}\n\nvar _ Runtime = (*pathRuntime)(nil)\n\n// NewRuntimeForPath creates a Runtime for the specified logger and path\nfunc NewRuntimeForPath(logger logger.Interface, path string) (Runtime, error) {\n\tinfo, err := os.Stat(path)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"invalid path '%v': %v\", path, err)\n\t}\n\tif info.IsDir() || info.Mode()&0111 == 0 {\n\t\treturn nil, fmt.Errorf(\"specified path '%v' is not an executable file\", path)\n\t}\n\n\tshim := pathRuntime{\n\t\tlogger: logger,\n\t\tpath: path,\n\t\texecRuntime: syscallExec{},\n\t}\n\n\treturn &shim, nil\n}\n\n// Exec exces into the binary at the path from the pathRuntime struct, passing it the supplied arguments\n// after ensuring that the first argument is the path of the target binary.\nfunc (s pathRuntime) Exec(args []string) error {\n\truntimeArgs := []string{s.path}\n\tif len(args) > 1 {\n\t\truntimeArgs = append(runtimeArgs, args[1:]...)\n\t}\n\n\treturn s.execRuntime.Exec(runtimeArgs)\n}\n\n// String returns the path to the specified runtime as the string representation.\nfunc (s pathRuntime) String() string {\n\treturn s.path\n}\n"
},
{
"path": "internal/oci/runtime_path_test.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\npackage oci\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestPathRuntimeConstructor(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tr, err := NewRuntimeForPath(logger, \"////an/invalid/path\")\n\trequire.Error(t, err)\n\trequire.Nil(t, r)\n\n\tr, err = NewRuntimeForPath(logger, \"/tmp\")\n\trequire.Error(t, err)\n\trequire.Nil(t, r)\n\n\tr, err = NewRuntimeForPath(logger, \"/dev/null\")\n\trequire.Error(t, err)\n\trequire.Nil(t, r)\n\n\tr, err = NewRuntimeForPath(logger, \"/bin/sh\")\n\trequire.NoError(t, err)\n\n\tf, ok := r.(*pathRuntime)\n\trequire.True(t, ok)\n\n\trequire.Equal(t, \"/bin/sh\", f.path)\n}\n\nfunc TestPathRuntimeForwardsArgs(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\texecRuntimeError error\n\t\targs []string\n\t}{\n\t\t{},\n\t\t{\n\t\t\targs: []string{\"shouldBeReplaced\"},\n\t\t},\n\t\t{\n\t\t\targs: []string{\"shouldBeReplaced\", \"arg1\"},\n\t\t},\n\t\t{\n\t\t\texecRuntimeError: fmt.Errorf(\"exec error\"),\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tmockedRuntime := &RuntimeMock{\n\t\t\tExecFunc: func(strings []string) error {\n\t\t\t\treturn tc.execRuntimeError\n\t\t\t},\n\t\t}\n\t\tr := pathRuntime{\n\t\t\tlogger: logger,\n\t\t\tpath: \"runtime\",\n\t\t\texecRuntime: mockedRuntime,\n\t\t}\n\t\terr := r.Exec(tc.args)\n\n\t\trequire.ErrorIs(t, err, tc.execRuntimeError)\n\n\t\tcalls := mockedRuntime.ExecCalls()\n\t\trequire.Len(t, calls, 1)\n\n\t\tnumArgs := len(tc.args)\n\t\tif numArgs == 0 {\n\t\t\tnumArgs = 1\n\t\t}\n\n\t\trequire.Len(t, calls[0].Strings, numArgs)\n\t\trequire.Equal(t, \"runtime\", calls[0].Strings[0])\n\n\t\tif numArgs > 1 {\n\t\t\trequire.EqualValues(t, tc.args[1:], calls[0].Strings[1:])\n\t\t}\n\t}\n}\n"
},
{
"path": "internal/oci/runtime_syscall_exec.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"syscall\"\n)\n\ntype syscallExec struct{}\n\nvar _ Runtime = (*syscallExec)(nil)\n\nfunc (r syscallExec) Exec(args []string) error {\n\t//nolint:gosec // TODO: Can we harden this so that there is less risk of command injection\n\terr := syscall.Exec(args[0], args, os.Environ())\n\tif err != nil {\n\t\treturn fmt.Errorf(\"could not exec '%v': %v\", args[0], err)\n\t}\n\n\t// syscall.Exec is not expected to return. This is an error state regardless of whether\n\t// err is nil or not.\n\treturn fmt.Errorf(\"unexpected return from exec '%v'\", args[0])\n}\n\nfunc (r syscallExec) String() string {\n\treturn \"exec\"\n}\n"
},
{
"path": "internal/oci/spec.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n)\n\n// SpecModifier defines an interface for modifying a (raw) OCI spec\ntype SpecModifier interface {\n\t// Modify is a method that accepts a pointer to an OCI Spec and returns an\n\t// error. The intention is that the function would modify the spec in-place.\n\tModify(*specs.Spec) error\n}\n\n// SpecModifiers is a collection of OCI Spec modifiers that can be treated as a\n// single modifier.\ntype SpecModifiers []SpecModifier\n\nvar _ SpecModifier = (SpecModifiers)(nil)\n\n// Spec defines the operations to be performed on an OCI specification\n//\n//go:generate moq -rm -fmt=goimports -stub -out spec_mock.go . Spec\ntype Spec interface {\n\tLoad() (*specs.Spec, error)\n\tFlush() error\n\tModify(SpecModifier) error\n\tLookupEnv(string) (string, bool)\n}\n\n// NewSpec creates fileSpec based on the command line arguments passed to the\n// application using the specified logger.\nfunc NewSpec(args []string, opts ...Option) (Spec, error) {\n\to := &options{\n\t\tallowUnkownFields: false,\n\t}\n\tfor _, opt := range opts {\n\t\topt(o)\n\t}\n\n\tbundleDir, err := GetBundleDir(args)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error getting bundle directory: %v\", err)\n\t}\n\to.logger.Debugf(\"Using bundle directory: %v\", bundleDir)\n\n\tociSpecPath := GetSpecFilePath(bundleDir)\n\to.logger.Infof(\"Using OCI specification file path: %v\", ociSpecPath)\n\n\tociSpec := NewFileSpec(ociSpecPath, !o.allowUnkownFields)\n\n\treturn ociSpec, nil\n}\n\n// Modify a spec based on a collection of modifiers.\nfunc (ms SpecModifiers) Modify(s *specs.Spec) error {\n\tfor _, m := range ms {\n\t\tif m == nil {\n\t\t\tcontinue\n\t\t}\n\t\tif err := m.Modify(s); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n"
},
{
"path": "internal/oci/spec_file.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n)\n\ntype fileSpec struct {\n\tmemorySpec\n\tpath string\n\tloader\n}\n\ntype loader bool\n\nconst (\n\tstrictLoader = loader(true)\n)\n\nvar _ Spec = (*fileSpec)(nil)\n\n// NewFileSpec creates an object that encapsulates a file-backed OCI spec.\n// This can be used to read from the file, modify the spec, and write to the\n// same file.\nfunc NewFileSpec(filepath string, isStrict bool) Spec {\n\tvar loader loader\n\tif isStrict {\n\t\tloader = strictLoader\n\t}\n\toci := fileSpec{\n\t\tpath: filepath,\n\t\tloader: loader,\n\t}\n\n\treturn &oci\n}\n\n// Load reads the contents of an OCI spec from file to be referenced internally.\n// The file is opened \"read-only\"\nfunc (s *fileSpec) Load() (*specs.Spec, error) {\n\tspecFile, err := os.Open(s.path)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error opening OCI specification file: %v\", err)\n\t}\n\tdefer specFile.Close()\n\n\tspec, err := s.loadFrom(specFile)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error loading OCI specification from file: %v\", err)\n\t}\n\ts.Spec = spec\n\treturn s.Spec, nil\n}\n\n// LoadFrom reads the contents of the OCI spec from the specified io.Reader.\nfunc (isStrict loader) loadFrom(reader io.Reader) (*specs.Spec, error) {\n\tdecoder := json.NewDecoder(reader)\n\tif isStrict {\n\t\tdecoder.DisallowUnknownFields()\n\t}\n\n\tvar spec specs.Spec\n\n\terr := decoder.Decode(&spec)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error reading OCI specification: %v\", err)\n\t}\n\n\treturn &spec, nil\n}\n\n// Modify applies the specified SpecModifier to the stored OCI specification.\nfunc (s *fileSpec) Modify(m SpecModifier) error {\n\treturn s.memorySpec.Modify(m)\n}\n\n// Flush writes the stored OCI specification to the filepath specified by the path member.\n// The file is truncated upon opening, overwriting any existing contents.\nfunc (s fileSpec) Flush() error {\n\tif s.Spec == nil {\n\t\treturn fmt.Errorf(\"no OCI specification loaded\")\n\t}\n\n\tspecFile, err := os.Create(s.path)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error opening OCI specification file: %v\", err)\n\t}\n\tdefer specFile.Close()\n\n\treturn flushTo(s.Spec, specFile)\n}\n\n// flushTo writes the stored OCI specification to the specified io.Writer.\nfunc flushTo(spec *specs.Spec, writer io.Writer) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\tencoder := json.NewEncoder(writer)\n\n\terr := encoder.Encode(spec)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error writing OCI specification: %v\", err)\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "internal/oci/spec_file_test.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage oci\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoadFrom(t *testing.T) {\n\ttestCases := []struct {\n\t\tcontents []byte\n\t\tisError bool\n\t\tspec *specs.Spec\n\t}{\n\t\t{\n\t\t\tcontents: []byte{},\n\t\t\tisError: true,\n\t\t},\n\t\t{\n\t\t\tcontents: []byte(\"{}\"),\n\t\t\tisError: false,\n\t\t\tspec: &specs.Spec{},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tvar spec *specs.Spec\n\t\tspec, err := strictLoader.loadFrom(bytes.NewReader(tc.contents))\n\n\t\tif tc.isError {\n\t\t\trequire.Error(t, err, \"%d: %v\", i, tc)\n\t\t} else {\n\t\t\trequire.NoError(t, err, \"%d: %v\", i, tc)\n\t\t}\n\n\t\tif tc.spec == nil {\n\t\t\trequire.Nil(t, spec, \"%d: %v\", i, tc)\n\t\t} else {\n\t\t\trequire.EqualValues(t, tc.spec, spec, \"%d: %v\", i, tc)\n\t\t}\n\t}\n}\n\nfunc TestFlushTo(t *testing.T) {\n\ttestCases := []struct {\n\t\tisError bool\n\t\tspec *specs.Spec\n\t\tcontents string\n\t}{\n\t\t{\n\t\t\tspec: nil,\n\t\t},\n\t\t{\n\t\t\tspec: &specs.Spec{},\n\t\t\tcontents: \"{\\\"ociVersion\\\":\\\"\\\"}\\n\",\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tbuffer := bytes.Buffer{}\n\n\t\terr := flushTo(tc.spec, &buffer)\n\n\t\tif tc.isError {\n\t\t\trequire.Error(t, err, \"%d: %v\", i, tc)\n\t\t} else {\n\t\t\trequire.NoError(t, err, \"%d: %v\", i, tc)\n\t\t}\n\n\t\trequire.EqualValues(t, tc.contents, buffer.String(), \"%d: %v\", i, tc)\n\t}\n\n\t// Add a simple test for a writer that returns an error when writing\n\terr := flushTo(&specs.Spec{}, errorWriter{})\n\trequire.Error(t, err)\n}\n\n// errorWriter implements the io.Writer interface, always returning an error when\n// writing.\ntype errorWriter struct{}\n\nfunc (e errorWriter) Write([]byte) (int, error) {\n\treturn 0, fmt.Errorf(\"error writing\")\n}\n"
},
{
"path": "internal/oci/spec_memory.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n)\n\ntype memorySpec struct {\n\t*specs.Spec\n}\n\n// NewMemorySpec creates a Spec instance from the specified OCI spec\nfunc NewMemorySpec(spec *specs.Spec) Spec {\n\ts := memorySpec{\n\t\tSpec: spec,\n\t}\n\n\treturn &s\n}\n\n// Load is a no-op for the memorySpec spec\nfunc (s *memorySpec) Load() (*specs.Spec, error) {\n\treturn s.Spec, nil\n}\n\n// Flush is a no-op for the memorySpec spec\nfunc (s *memorySpec) Flush() error {\n\treturn nil\n}\n\n// Modify applies the specified SpecModifier to the stored OCI specification.\nfunc (s *memorySpec) Modify(m SpecModifier) error {\n\tif s.Spec == nil {\n\t\treturn fmt.Errorf(\"cannot modify nil spec\")\n\t}\n\treturn m.Modify(s.Spec)\n}\n\n// LookupEnv mirrors os.LookupEnv for the OCI specification. It\n// retrieves the value of the environment variable named\n// by the key. If the variable is present in the environment the\n// value (which may be empty) is returned and the boolean is true.\n// Otherwise the returned value will be empty and the boolean will\n// be false.\nfunc (s memorySpec) LookupEnv(key string) (string, bool) {\n\tif s.Spec == nil || s.Process == nil {\n\t\treturn \"\", false\n\t}\n\n\tfor _, env := range s.Process.Env {\n\t\tif !strings.HasPrefix(env, key) {\n\t\t\tcontinue\n\t\t}\n\n\t\tparts := strings.SplitN(env, \"=\", 2)\n\t\tif parts[0] == key {\n\t\t\tif len(parts) < 2 {\n\t\t\t\treturn \"\", true\n\t\t\t}\n\t\t\treturn parts[1], true\n\t\t}\n\t}\n\n\treturn \"\", false\n}\n"
},
{
"path": "internal/oci/spec_memory_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage oci\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLookupEnv(t *testing.T) {\n\tconst envName = \"TEST_ENV\"\n\ttestCases := []struct {\n\t\tspec *specs.Spec\n\t\texpectedValue string\n\t\texpectedExits bool\n\t}{\n\t\t{\n\t\t\t// nil spec\n\t\t\tspec: nil,\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: false,\n\t\t},\n\t\t{\n\t\t\t// nil process\n\t\t\tspec: &specs.Spec{},\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: false,\n\t\t},\n\t\t{\n\t\t\t// nil env\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{},\n\t\t\t},\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: false,\n\t\t},\n\t\t{\n\t\t\t// empty env\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{Env: []string{}},\n\t\t\t},\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: false,\n\t\t},\n\t\t{\n\t\t\t// different env set\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{Env: []string{\"SOMETHING_ELSE=foo\"}},\n\t\t\t},\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: false,\n\t\t},\n\t\t{\n\t\t\t// same prefix\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{Env: []string{\"TEST_ENV_BUT_NOT=foo\"}},\n\t\t\t},\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: false,\n\t\t},\n\t\t{\n\t\t\t// same suffix\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{Env: []string{\"NOT_TEST_ENV=foo\"}},\n\t\t\t},\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: false,\n\t\t},\n\t\t{\n\t\t\t// set blank\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{Env: []string{\"TEST_ENV=\"}},\n\t\t\t},\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: true,\n\t\t},\n\t\t{\n\t\t\t// set no-equals\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{Env: []string{\"TEST_ENV\"}},\n\t\t\t},\n\t\t\texpectedValue: \"\",\n\t\t\texpectedExits: true,\n\t\t},\n\t\t{\n\t\t\t// set value\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{Env: []string{\"TEST_ENV=something\"}},\n\t\t\t},\n\t\t\texpectedValue: \"something\",\n\t\t\texpectedExits: true,\n\t\t},\n\t\t{\n\t\t\t// set with equals\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{Env: []string{\"TEST_ENV=something=somethingelse\"}},\n\t\t\t},\n\t\t\texpectedValue: \"something=somethingelse\",\n\t\t\texpectedExits: true,\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tspec := memorySpec{\n\t\t\tSpec: tc.spec,\n\t\t}\n\n\t\tvalue, exists := spec.LookupEnv(envName)\n\n\t\trequire.Equal(t, tc.expectedValue, value, \"%d: %v\", i, tc)\n\t\trequire.Equal(t, tc.expectedExits, exists, \"%d: %v\", i, tc)\n\t}\n}\n\nfunc TestModify(t *testing.T) {\n\n\ttestCases := []struct {\n\t\tspec *specs.Spec\n\t\tmodifierError error\n\t}{\n\t\t{\n\t\t\tspec: nil,\n\t\t},\n\t\t{\n\t\t\tspec: &specs.Spec{},\n\t\t},\n\t\t{\n\t\t\tspec: &specs.Spec{},\n\t\t\tmodifierError: fmt.Errorf(\"error in modifier\"),\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tspec := NewMemorySpec(tc.spec).(*memorySpec)\n\n\t\terr := spec.Modify(modifier{tc.modifierError})\n\n\t\tswitch {\n\t\tcase tc.spec == nil:\n\t\t\trequire.Error(t, err, \"%d: %v\", i, tc)\n\t\tcase tc.modifierError != nil:\n\t\t\trequire.EqualError(t, err, tc.modifierError.Error(), \"%d: %v\", i, tc)\n\t\t\trequire.EqualValues(t, &specs.Spec{}, spec.Spec, \"%d: %v\", i, tc)\n\t\tdefault:\n\t\t\trequire.NoError(t, err, \"%d: %v\", i, tc)\n\t\t\trequire.Equal(t, \"updated\", spec.Version, \"%d: %v\", i, tc)\n\t\t}\n\t}\n}\n\n// TODO: Ideally we would generated a mock for the SpecModifer too. This causes\n// an import cycle and we define a local type as a work-around.\ntype modifier struct {\n\tmodifierError error\n}\n\nfunc (m modifier) Modify(spec *specs.Spec) error {\n\tif m.modifierError == nil {\n\t\tspec.Version = \"updated\"\n\t}\n\treturn m.modifierError\n}\n"
},
{
"path": "internal/oci/spec_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage oci\n\nimport (\n\t\"sync\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n)\n\n// Ensure, that SpecMock does implement Spec.\n// If this is not the case, regenerate this file with moq.\nvar _ Spec = &SpecMock{}\n\n// SpecMock is a mock implementation of Spec.\n//\n//\tfunc TestSomethingThatUsesSpec(t *testing.T) {\n//\n//\t\t// make and configure a mocked Spec\n//\t\tmockedSpec := &SpecMock{\n//\t\t\tFlushFunc: func() error {\n//\t\t\t\tpanic(\"mock out the Flush method\")\n//\t\t\t},\n//\t\t\tLoadFunc: func() (*specs.Spec, error) {\n//\t\t\t\tpanic(\"mock out the Load method\")\n//\t\t\t},\n//\t\t\tLookupEnvFunc: func(s string) (string, bool) {\n//\t\t\t\tpanic(\"mock out the LookupEnv method\")\n//\t\t\t},\n//\t\t\tModifyFunc: func(specModifier SpecModifier) error {\n//\t\t\t\tpanic(\"mock out the Modify method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedSpec in code that requires Spec\n//\t\t// and then make assertions.\n//\n//\t}\ntype SpecMock struct {\n\t// FlushFunc mocks the Flush method.\n\tFlushFunc func() error\n\n\t// LoadFunc mocks the Load method.\n\tLoadFunc func() (*specs.Spec, error)\n\n\t// LookupEnvFunc mocks the LookupEnv method.\n\tLookupEnvFunc func(s string) (string, bool)\n\n\t// ModifyFunc mocks the Modify method.\n\tModifyFunc func(specModifier SpecModifier) error\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Flush holds details about calls to the Flush method.\n\t\tFlush []struct {\n\t\t}\n\t\t// Load holds details about calls to the Load method.\n\t\tLoad []struct {\n\t\t}\n\t\t// LookupEnv holds details about calls to the LookupEnv method.\n\t\tLookupEnv []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// Modify holds details about calls to the Modify method.\n\t\tModify []struct {\n\t\t\t// SpecModifier is the specModifier argument value.\n\t\t\tSpecModifier SpecModifier\n\t\t}\n\t}\n\tlockFlush sync.RWMutex\n\tlockLoad sync.RWMutex\n\tlockLookupEnv sync.RWMutex\n\tlockModify sync.RWMutex\n}\n\n// Flush calls FlushFunc.\nfunc (mock *SpecMock) Flush() error {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockFlush.Lock()\n\tmock.calls.Flush = append(mock.calls.Flush, callInfo)\n\tmock.lockFlush.Unlock()\n\tif mock.FlushFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.FlushFunc()\n}\n\n// FlushCalls gets all the calls that were made to Flush.\n// Check the length with:\n//\n//\tlen(mockedSpec.FlushCalls())\nfunc (mock *SpecMock) FlushCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockFlush.RLock()\n\tcalls = mock.calls.Flush\n\tmock.lockFlush.RUnlock()\n\treturn calls\n}\n\n// Load calls LoadFunc.\nfunc (mock *SpecMock) Load() (*specs.Spec, error) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockLoad.Lock()\n\tmock.calls.Load = append(mock.calls.Load, callInfo)\n\tmock.lockLoad.Unlock()\n\tif mock.LoadFunc == nil {\n\t\tvar (\n\t\t\tspecOut *specs.Spec\n\t\t\terrOut error\n\t\t)\n\t\treturn specOut, errOut\n\t}\n\treturn mock.LoadFunc()\n}\n\n// LoadCalls gets all the calls that were made to Load.\n// Check the length with:\n//\n//\tlen(mockedSpec.LoadCalls())\nfunc (mock *SpecMock) LoadCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockLoad.RLock()\n\tcalls = mock.calls.Load\n\tmock.lockLoad.RUnlock()\n\treturn calls\n}\n\n// LookupEnv calls LookupEnvFunc.\nfunc (mock *SpecMock) LookupEnv(s string) (string, bool) {\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockLookupEnv.Lock()\n\tmock.calls.LookupEnv = append(mock.calls.LookupEnv, callInfo)\n\tmock.lockLookupEnv.Unlock()\n\tif mock.LookupEnvFunc == nil {\n\t\tvar (\n\t\t\tsOut string\n\t\t\tbOut bool\n\t\t)\n\t\treturn sOut, bOut\n\t}\n\treturn mock.LookupEnvFunc(s)\n}\n\n// LookupEnvCalls gets all the calls that were made to LookupEnv.\n// Check the length with:\n//\n//\tlen(mockedSpec.LookupEnvCalls())\nfunc (mock *SpecMock) LookupEnvCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockLookupEnv.RLock()\n\tcalls = mock.calls.LookupEnv\n\tmock.lockLookupEnv.RUnlock()\n\treturn calls\n}\n\n// Modify calls ModifyFunc.\nfunc (mock *SpecMock) Modify(specModifier SpecModifier) error {\n\tcallInfo := struct {\n\t\tSpecModifier SpecModifier\n\t}{\n\t\tSpecModifier: specModifier,\n\t}\n\tmock.lockModify.Lock()\n\tmock.calls.Modify = append(mock.calls.Modify, callInfo)\n\tmock.lockModify.Unlock()\n\tif mock.ModifyFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.ModifyFunc(specModifier)\n}\n\n// ModifyCalls gets all the calls that were made to Modify.\n// Check the length with:\n//\n//\tlen(mockedSpec.ModifyCalls())\nfunc (mock *SpecMock) ModifyCalls() []struct {\n\tSpecModifier SpecModifier\n} {\n\tvar calls []struct {\n\t\tSpecModifier SpecModifier\n\t}\n\tmock.lockModify.RLock()\n\tcalls = mock.calls.Modify\n\tmock.lockModify.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/oci/spec_test.go",
"content": "package oci\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestMaintainSpec(t *testing.T) {\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tfiles := []string{\n\t\t\"config.clone3.json\",\n\t}\n\n\tfor _, f := range files {\n\t\tinputSpecPath := filepath.Join(moduleRoot, \"tests/input\", f)\n\n\t\tspec := NewFileSpec(inputSpecPath, true).(*fileSpec)\n\n\t\t_, err := spec.Load()\n\t\trequire.NoError(t, err)\n\n\t\toutputSpecPath := filepath.Join(moduleRoot, \"tests/output\", f)\n\t\tspec.path = outputSpecPath\n\t\tspec.Flush()\n\n\t\tinputContents, err := os.ReadFile(inputSpecPath)\n\t\trequire.NoError(t, err)\n\n\t\toutputContents, err := os.ReadFile(outputSpecPath)\n\t\trequire.NoError(t, err)\n\n\t\trequire.JSONEq(t, string(inputContents), string(outputContents))\n\t}\n}\n"
},
{
"path": "internal/oci/state.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage oci\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n)\n\n// State stores an OCI container state. This includes the spec path and the environment\ntype State specs.State\n\n// LoadContainerState loads the container state from the specified filename. If the filename is empty or '-' the state is loaded from STDIN\nfunc LoadContainerState(filename string) (*State, error) {\n\tif filename == \"\" || filename == \"-\" {\n\t\treturn ReadContainerState(os.Stdin)\n\t}\n\n\tinputFile, err := os.Open(filename)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to open file: %v\", err)\n\t}\n\tdefer inputFile.Close()\n\n\treturn ReadContainerState(inputFile)\n}\n\n// ReadContainerState reads the container state from the specified reader\nfunc ReadContainerState(reader io.Reader) (*State, error) {\n\tvar s State\n\n\td := json.NewDecoder(reader)\n\tif err := d.Decode(&s); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to decode container state: %v\", err)\n\t}\n\n\treturn &s, nil\n}\n\n// GetContainerRoot returns the root for the container from the associated spec. If the spec is not yet loaded, it is\n// loaded and cached.\nfunc (s *State) GetContainerRoot() (string, error) {\n\tspec, err := s.loadMinimalSpec()\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tvar containerRoot string\n\tif spec.Root != nil {\n\t\tcontainerRoot = spec.Root.Path\n\t}\n\n\tif filepath.IsAbs(containerRoot) {\n\t\treturn containerRoot, nil\n\t}\n\n\treturn filepath.Join(s.Bundle, containerRoot), nil\n}\n\n// loadMinimalSpec loads a reduced OCI spec associated with the container state.\nfunc (s *State) loadMinimalSpec() (*minimalSpec, error) {\n\tspecFilePath := GetSpecFilePath(s.Bundle)\n\tspecFile, err := os.Open(specFilePath)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to open OCI spec file: %v\", err)\n\t}\n\tdefer specFile.Close()\n\n\tms := &minimalSpec{}\n\tif err := json.NewDecoder(specFile).Decode(ms); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to load minimal OCI spec: %v\", err)\n\t}\n\treturn ms, nil\n}\n\n// A minimalSpec is used to return desired properties from the container config.\n// We define this here instead of using specs.Spec as is to avoid decoding\n// unneeded fields in container lifecycle hooks.\ntype minimalSpec struct {\n\t// Root configures the container's root filesystem.\n\tRoot *specs.Root `json:\"root,omitempty\"`\n}\n"
},
{
"path": "internal/platform-support/dgpu/by-path-hooks.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dgpu\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// byPathHookDiscoverer discovers the entities required for injecting by-path DRM device links\ntype byPathHookDiscoverer struct {\n\tlogger logger.Interface\n\tdevRoot string\n\thookCreator discover.HookCreator\n\tpciBusID string\n\tdeviceNodes discover.Discover\n}\n\nvar _ discover.Discover = (*byPathHookDiscoverer)(nil)\n\n// Devices returns the empty list for the by-path hook discoverer\nfunc (d *byPathHookDiscoverer) Devices() ([]discover.Device, error) {\n\treturn nil, nil\n}\n\n// EnvVars returns the empty list for the by-path hook discoverer\nfunc (d *byPathHookDiscoverer) EnvVars() ([]discover.EnvVar, error) {\n\treturn nil, nil\n}\n\n// Hooks returns the hooks for the GPU device.\n// The following hooks are detected:\n// 1. A hook to create /dev/dri/by-path symlinks\nfunc (d *byPathHookDiscoverer) Hooks() ([]discover.Hook, error) {\n\tlinks, err := d.deviceNodeLinks()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover DRA device links: %v\", err)\n\t}\n\tif len(links) == 0 {\n\t\treturn nil, nil\n\t}\n\n\thook := d.hookCreator.Create(\"create-symlinks\", links...)\n\n\treturn hook.Hooks()\n}\n\n// Mounts returns an empty slice for a full GPU\nfunc (d *byPathHookDiscoverer) Mounts() ([]discover.Mount, error) {\n\treturn nil, nil\n}\n\nfunc (d *byPathHookDiscoverer) deviceNodeLinks() ([]string, error) {\n\tdevices, err := d.deviceNodes.Devices()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover device nodes: %v\", err)\n\t}\n\n\tif len(devices) == 0 {\n\t\treturn nil, nil\n\t}\n\n\tselectedDevices := make(map[string]bool)\n\tfor _, d := range devices {\n\t\tselectedDevices[d.HostPath] = true\n\t}\n\n\tcandidates := []string{\n\t\tfmt.Sprintf(\"/dev/dri/by-path/pci-%s-card\", d.pciBusID),\n\t\tfmt.Sprintf(\"/dev/dri/by-path/pci-%s-render\", d.pciBusID),\n\t}\n\n\tvar links []string\n\tfor _, c := range candidates {\n\t\tlinkPath := filepath.Join(d.devRoot, c)\n\t\tdevice, err := os.Readlink(linkPath)\n\t\tif err != nil {\n\t\t\td.logger.Warningf(\"Failed to evaluate symlink %v; ignoring\", linkPath)\n\t\t\tcontinue\n\t\t}\n\n\t\tdeviceNode := device\n\t\tif !filepath.IsAbs(device) {\n\t\t\tdeviceNode = filepath.Join(filepath.Dir(linkPath), device)\n\t\t}\n\t\tif !selectedDevices[deviceNode] {\n\t\t\td.logger.Debugf(\"ignoring device symlink %v -> %v since %v is not mounted\", linkPath, device, deviceNode)\n\t\t\tcontinue\n\t\t}\n\t\td.logger.Debugf(\"adding device symlink %v -> %v\", linkPath, device)\n\t\tlinks = append(links, fmt.Sprintf(\"%v::%v\", device, linkPath))\n\t}\n\n\treturn links, nil\n}\n"
},
{
"path": "internal/platform-support/dgpu/dgpu.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dgpu\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvcaps\"\n)\n\n// NewForDevice creates a discoverer for the specified Device.\n// nvsandboxutils is used for discovery if specified, otherwise NVML is used.\nfunc NewForDevice(d device.Device, opts ...Option) (discover.Discover, error) {\n\to, err := new(opts...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar discoverers []discover.Discover\n\tvar errs error\n\tnvsandboxutilsDiscoverer, err := o.newNvsandboxutilsDGPUDiscoverer(d)\n\tif err != nil {\n\t\t// TODO: Log a warning\n\t\terrs = errors.Join(errs, err)\n\t} else if nvsandboxutilsDiscoverer != nil {\n\t\tdiscoverers = append(discoverers, nvsandboxutilsDiscoverer)\n\t}\n\n\tnvmlDiscoverer, err := o.newNvmlDGPUDiscoverer(&toRequiredInfo{d})\n\tif err != nil {\n\t\t// TODO: Log a warning\n\t\terrs = errors.Join(errs, err)\n\t} else if nvmlDiscoverer != nil {\n\t\tdiscoverers = append(discoverers, nvmlDiscoverer)\n\t}\n\n\tif len(discoverers) == 0 {\n\t\treturn nil, errs\n\t}\n\n\treturn discover.WithCache(\n\t\tdiscover.FirstValid(\n\t\t\tdiscoverers...,\n\t\t),\n\t), nil\n}\n\n// NewForMigDevice creates a discoverer for the specified device and its associated MIG device.\n// nvsandboxutils is used for discovery if specified, otherwise NVML is used.\nfunc NewForMigDevice(d device.Device, mig device.MigDevice, opts ...Option) (discover.Discover, error) {\n\to, err := new(opts...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\to.isMigDevice = true\n\n\tvar discoverers []discover.Discover\n\tvar errs error\n\tnvsandboxutilsDiscoverer, err := o.newNvsandboxutilsDGPUDiscoverer(mig)\n\tif err != nil {\n\t\t// TODO: Log a warning\n\t\terrs = errors.Join(errs, err)\n\t} else if nvsandboxutilsDiscoverer != nil {\n\t\tdiscoverers = append(discoverers, nvsandboxutilsDiscoverer)\n\t}\n\n\tnvmlDiscoverer, err := o.newNvmlMigDiscoverer(\n\t\t&toRequiredMigInfo{\n\t\t\tMigDevice: mig,\n\t\t\tparent: &toRequiredInfo{d},\n\t\t},\n\t)\n\tif err != nil {\n\t\t// TODO: Log a warning\n\t\terrs = errors.Join(errs, err)\n\t} else if nvmlDiscoverer != nil {\n\t\tdiscoverers = append(discoverers, nvmlDiscoverer)\n\t}\n\n\tif len(discoverers) == 0 {\n\t\treturn nil, errs\n\t}\n\n\treturn discover.WithCache(\n\t\tdiscover.FirstValid(\n\t\t\tdiscoverers...,\n\t\t),\n\t), nil\n\n}\n\nfunc new(opts ...Option) (*options, error) {\n\to := &options{}\n\tfor _, opt := range opts {\n\t\topt(o)\n\t}\n\tif o.driver == nil {\n\t\treturn nil, fmt.Errorf(\"a driver must be specified\")\n\t}\n\n\tif o.logger == nil {\n\t\to.logger = logger.New()\n\t}\n\n\tif o.migCaps == nil {\n\t\tmigCaps, err := nvcaps.NewMigCaps()\n\t\tif err != nil {\n\t\t\to.logger.Debugf(\"ignoring error getting MIG capability device paths: %v\", err)\n\t\t\to.migCapsError = err\n\t\t} else {\n\t\t\to.migCaps = migCaps\n\t\t}\n\t}\n\n\treturn o, nil\n}\n"
},
{
"path": "internal/platform-support/dgpu/dgpu_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dgpu_test\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml/mock/dgxa100\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/dgpu\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestNewForDevice(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCase := []struct {\n\t\tdescription string\n\t\tmocks\n\t\tdriverRootfs string\n\t\tdevRootfs string\n\t\texpectedErrorString string\n\t\texpectedDevices []discover.Device\n\t\texpectedMounts []discover.Mount\n\t\texpectedHooks []discover.Hook\n\t}{\n\t\t{\n\t\t\tdescription: \"single full gpu\",\n\t\t\tmocks: mocksServerForTest(),\n\t\t\tdevRootfs: \"rootfs-1\",\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCase {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdriverRoot := tc.driverRootfs\n\t\t\tif driverRoot != \"\" {\n\t\t\t\tdriverRoot = filepath.Join(lookupRoot, tc.driverRootfs)\n\t\t\t}\n\t\t\tdevRoot := tc.devRootfs\n\t\t\tif devRoot != \"\" {\n\t\t\t\tdevRoot = filepath.Join(lookupRoot, tc.devRootfs)\n\t\t\t}\n\t\t\tdriver := root.New(root.WithDriverRoot(driverRoot), root.WithDevRoot(devRoot))\n\n\t\t\tdevicelib := device.New(tc.nvmllib)\n\t\t\tdevice, err := devicelib.NewDevice(tc.device)\n\t\t\trequire.NoError(t, err)\n\n\t\t\td, err := dgpu.NewForDevice(device,\n\t\t\t\tdgpu.WithLogger(logger),\n\t\t\t\tdgpu.WithDriver(driver),\n\t\t\t)\n\t\t\tif tc.expectedErrorString == \"\" {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t} else {\n\t\t\t\trequire.EqualError(t, err, tc.expectedErrorString)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\tif devRoot == \"\" {\n\t\t\t\tdevRoot = driverRoot\n\t\t\t}\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedDevices, test.StripRoot(devices, devRoot))\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedMounts, test.StripRoot(mounts, driverRoot))\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedHooks, test.StripRoot(hooks, driverRoot))\n\n\t\t\tenvVars, err := d.EnvVars()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, envVars)\n\t\t})\n\n\t}\n}\n\ntype mocks struct {\n\tnvmllib nvml.Interface\n\tdevice nvml.Device\n}\n\nfunc mocksServerForTest() mocks {\n\tserver := dgxa100.New()\n\n\treturn mocks{\n\t\tnvmllib: server,\n\t\tdevice: server.Devices[0],\n\t}\n}\n"
},
{
"path": "internal/platform-support/dgpu/nvml.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dgpu\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info/drm\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvcaps\"\n)\n\ntype requiredInfo interface {\n\tGetMinorNumber() (int, error)\n\tGetPCIBusID() (string, error)\n\tgetDevNodePath() (string, error)\n}\n\nfunc (o *options) newNvmlDGPUDiscoverer(d requiredInfo) (discover.Discover, error) {\n\tpath, err := d.getDevNodePath()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error getting device node path: %w\", err)\n\t}\n\n\tpciBusID, err := d.GetPCIBusID()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error getting PCI info for device: %w\", err)\n\t}\n\n\tdrmDeviceNodes, err := drm.GetDeviceNodesByBusID(pciBusID)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to determine DRM devices for %v: %v\", pciBusID, err)\n\t}\n\n\tdeviceNodePaths := append([]string{path}, drmDeviceNodes...)\n\n\tdeviceNodes := discover.NewCharDeviceDiscoverer(\n\t\to.logger,\n\t\to.driver.DevRoot,\n\t\tdeviceNodePaths,\n\t)\n\n\tbyPathHooks := &byPathHookDiscoverer{\n\t\tlogger: o.logger,\n\t\tdevRoot: o.driver.DevRoot,\n\t\thookCreator: o.hookCreator,\n\t\tpciBusID: pciBusID,\n\t\tdeviceNodes: deviceNodes,\n\t}\n\n\tdd := discover.Merge(\n\t\tdeviceNodes,\n\t\tbyPathHooks,\n\t)\n\treturn dd, nil\n}\n\ntype requiredMigInfo interface {\n\tgetPlacementInfo() (int, int, int, error)\n\tgetDevNodePath() (string, error)\n}\n\nfunc (o *options) newNvmlMigDiscoverer(d requiredMigInfo) (discover.Discover, error) {\n\tif o.migCaps == nil || o.migCapsError != nil {\n\t\treturn nil, fmt.Errorf(\"error getting MIG capability device paths: %v\", o.migCapsError)\n\t}\n\n\tgpu, gi, ci, err := d.getPlacementInfo()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error getting placement info: %w\", err)\n\t}\n\n\tgiCap := nvcaps.NewGPUInstanceCap(gpu, gi)\n\tgiCapDevicePath, err := o.migCaps.GetCapDevicePath(giCap)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get GI cap device path: %v\", err)\n\t}\n\n\tciCap := nvcaps.NewComputeInstanceCap(gpu, gi, ci)\n\tciCapDevicePath, err := o.migCaps.GetCapDevicePath(ciCap)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get CI cap device path: %v\", err)\n\t}\n\n\tparentPath, err := d.getDevNodePath()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tdeviceNodes := discover.NewCharDeviceDiscoverer(\n\t\to.logger,\n\t\to.driver.DevRoot,\n\t\t[]string{\n\t\t\tparentPath,\n\t\t\tgiCapDevicePath,\n\t\t\tciCapDevicePath,\n\t\t},\n\t)\n\n\treturn deviceNodes, nil\n}\n\ntype toRequiredInfo struct {\n\tdevice.Device\n}\n\nfunc (d *toRequiredInfo) GetMinorNumber() (int, error) {\n\tminor, ret := d.Device.GetMinorNumber()\n\tif ret != nvml.SUCCESS {\n\t\treturn 0, ret\n\t}\n\treturn minor, nil\n}\n\nfunc (d *toRequiredInfo) getDevNodePath() (string, error) {\n\tminor, err := d.GetMinorNumber()\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error getting GPU device minor number: %w\", err)\n\t}\n\tpath := fmt.Sprintf(\"/dev/nvidia%d\", minor)\n\treturn path, nil\n}\n\ntype toRequiredMigInfo struct {\n\tdevice.MigDevice\n\tparent requiredInfo\n}\n\nfunc (d *toRequiredMigInfo) getPlacementInfo() (int, int, int, error) {\n\tgpu, err := d.parent.GetMinorNumber()\n\tif err != nil {\n\t\treturn 0, 0, 0, fmt.Errorf(\"error getting GPU minor: %w\", err)\n\t}\n\n\tgi, ret := d.GetGpuInstanceId()\n\tif ret != nvml.SUCCESS {\n\t\treturn 0, 0, 0, fmt.Errorf(\"error getting GPU Instance ID: %v\", ret)\n\t}\n\n\tci, ret := d.GetComputeInstanceId()\n\tif ret != nvml.SUCCESS {\n\t\treturn 0, 0, 0, fmt.Errorf(\"error getting Compute Instance ID: %v\", ret)\n\t}\n\n\treturn gpu, gi, ci, nil\n}\n\nfunc (d *toRequiredMigInfo) getDevNodePath() (string, error) {\n\treturn d.parent.getDevNodePath()\n}\n"
},
{
"path": "internal/platform-support/dgpu/nvml_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dgpu\n\nimport (\n\t\"testing\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml/mock\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvcaps\"\n)\n\n// TODO: In order to properly test this, we need a mechanism to inject /\n// override the char device discoverer.\nfunc TestNewNvmlDGPUDiscoverer(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tnvmllib := &mock.Interface{}\n\tdevicelib := device.New(\n\t\tnvmllib,\n\t)\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdevice nvml.Device\n\t\texpectedError error\n\t\texpectedDevices []discover.Device\n\t\texpectedHooks []discover.Hook\n\t\texpectedMounts []discover.Mount\n\t}{\n\t\t{\n\t\t\tdescription: \"\",\n\t\t\tdevice: &mock.Device{\n\t\t\t\tGetMinorNumberFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 3, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tGetPciInfoFunc: func() (nvml.PciInfo, nvml.Return) {\n\t\t\t\t\tvar busID [32]uint8\n\t\t\t\t\tfor i, b := range []byte(\"00000000:45:00:00\") {\n\t\t\t\t\t\tbusID[i] = b\n\t\t\t\t\t}\n\t\t\t\t\tinfo := nvml.PciInfo{\n\t\t\t\t\t\tBusId: busID,\n\t\t\t\t\t}\n\t\t\t\t\treturn info, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\to, err := new(WithLogger(logger), WithDriver(root.New()))\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevice, err := devicelib.NewDevice(tc.device)\n\t\t\trequire.NoError(t, err)\n\n\t\t\td, err := o.newNvmlDGPUDiscoverer(&toRequiredInfo{device})\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\n\t\t\tdevices, _ := d.Devices()\n\t\t\trequire.EqualValues(t, tc.expectedDevices, devices)\n\t\t\thooks, _ := d.Hooks()\n\t\t\trequire.EqualValues(t, tc.expectedHooks, hooks)\n\t\t\tmounts, _ := d.Mounts()\n\t\t\trequire.EqualValues(t, tc.expectedMounts, mounts)\n\t\t})\n\t}\n}\n\nfunc TestNewNvmlMIGDiscoverer(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tnvmllib := &mock.Interface{}\n\tdevicelib := device.New(\n\t\tnvmllib,\n\t)\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tmig *mock.Device\n\t\tparent nvml.Device\n\t\tmigCaps nvcaps.MigCaps\n\t\texpectedError error\n\t\texpectedDevices []discover.Device\n\t\texpectedHooks []discover.Hook\n\t\texpectedMounts []discover.Mount\n\t}{\n\t\t{\n\t\t\tdescription: \"\",\n\t\t\tmig: &mock.Device{\n\t\t\t\tIsMigDeviceHandleFunc: func() (bool, nvml.Return) {\n\t\t\t\t\treturn true, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tGetGpuInstanceIdFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 1, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tGetComputeInstanceIdFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 2, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\tparent: &mock.Device{\n\t\t\t\tGetMinorNumberFunc: func() (int, nvml.Return) {\n\t\t\t\t\treturn 3, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tGetPciInfoFunc: func() (nvml.PciInfo, nvml.Return) {\n\t\t\t\t\tvar busID [32]uint8\n\t\t\t\t\tfor i, b := range []byte(\"00000000:45:00:00\") {\n\t\t\t\t\t\tbusID[i] = b\n\t\t\t\t\t}\n\t\t\t\t\tinfo := nvml.PciInfo{\n\t\t\t\t\t\tBusId: busID,\n\t\t\t\t\t}\n\t\t\t\t\treturn info, nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\tmigCaps: nvcaps.MigCaps{\n\t\t\t\t\"gpu3/gi1/access\": 31,\n\t\t\t\t\"gpu3/gi1/ci2/access\": 312,\n\t\t\t},\n\t\t\texpectedDevices: nil,\n\t\t\texpectedMounts: nil,\n\t\t\texpectedHooks: nil,\n\t\t},\n\t}\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\n\t\t\ttc.mig.GetDeviceHandleFromMigDeviceHandleFunc = func() (nvml.Device, nvml.Return) {\n\t\t\t\treturn tc.parent, nvml.SUCCESS\n\t\t\t}\n\t\t\tparent, err := devicelib.NewDevice(tc.parent)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tmig, err := devicelib.NewMigDevice(tc.mig)\n\t\t\trequire.NoError(t, err)\n\n\t\t\td, err := NewForMigDevice(parent, mig,\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithDriver(root.New()),\n\t\t\t\tWithMIGCaps(tc.migCaps),\n\t\t\t)\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\n\t\t\tdevices, _ := d.Devices()\n\t\t\trequire.EqualValues(t, tc.expectedDevices, devices)\n\t\t\thooks, _ := d.Hooks()\n\t\t\trequire.EqualValues(t, tc.expectedHooks, hooks)\n\t\t\tmounts, _ := d.Mounts()\n\t\t\trequire.EqualValues(t, tc.expectedMounts, mounts)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/platform-support/dgpu/nvsandboxutils.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dgpu\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils\"\n)\n\ntype nvsandboxutilsDGPU struct {\n\tlib nvsandboxutils.Interface\n\tuuid string\n\tdevRoot string\n\tisMig bool\n\thookCreator discover.HookCreator\n\tdeviceLinks []string\n}\n\nvar _ discover.Discover = (*nvsandboxutilsDGPU)(nil)\n\ntype UUIDer interface {\n\tGetUUID() (string, nvml.Return)\n}\n\nfunc (o *options) newNvsandboxutilsDGPUDiscoverer(d UUIDer) (discover.Discover, error) {\n\tif o.nvsandboxutilslib == nil {\n\t\treturn nil, nil\n\t}\n\n\tuuid, nvmlRet := d.GetUUID()\n\tif nvmlRet != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to get device UUID: %w\", nvmlRet)\n\t}\n\n\tnvd := nvsandboxutilsDGPU{\n\t\tlib: o.nvsandboxutilslib,\n\t\tuuid: uuid,\n\t\tdevRoot: strings.TrimSuffix(filepath.Clean(o.driver.DevRoot), \"/dev\"),\n\t\tisMig: o.isMigDevice,\n\t\thookCreator: o.hookCreator,\n\t}\n\n\treturn &nvd, nil\n}\n\nfunc (d *nvsandboxutilsDGPU) Devices() ([]discover.Device, error) {\n\tgpuFileInfos, ret := d.lib.GetGpuResource(d.uuid)\n\tif ret != nvsandboxutils.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to get GPU resource: %w\", ret)\n\t}\n\n\tvar devices []discover.Device\n\tfor _, info := range gpuFileInfos {\n\t\tswitch info.SubType {\n\t\tcase nvsandboxutils.NV_DEV_DRI_CARD, nvsandboxutils.NV_DEV_DRI_RENDERD:\n\t\t\tif d.isMig {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tfallthrough\n\t\tcase nvsandboxutils.NV_DEV_NVIDIA, nvsandboxutils.NV_DEV_NVIDIA_CAPS_NVIDIA_CAP:\n\t\t\tcontainerPath := info.Path\n\t\t\tif d.devRoot != \"/\" {\n\t\t\t\tcontainerPath = strings.TrimPrefix(containerPath, d.devRoot)\n\t\t\t}\n\n\t\t\t// TODO: Extend discover.Device with additional information.\n\t\t\tdevice := discover.Device{\n\t\t\t\tHostPath: info.Path,\n\t\t\t\tPath: containerPath,\n\t\t\t}\n\t\t\tdevices = append(devices, device)\n\t\tcase nvsandboxutils.NV_DEV_DRI_CARD_SYMLINK, nvsandboxutils.NV_DEV_DRI_RENDERD_SYMLINK:\n\t\t\tif d.isMig {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif info.Flags == nvsandboxutils.NV_FILE_FLAG_CONTENT {\n\t\t\t\ttargetPath, ret := d.lib.GetFileContent(info.Path)\n\t\t\t\tif ret != nvsandboxutils.SUCCESS {\n\t\t\t\t\treturn nil, fmt.Errorf(\"failed to get symlink: %w\", ret)\n\t\t\t\t}\n\t\t\t\td.deviceLinks = append(d.deviceLinks, fmt.Sprintf(\"%v::%v\", targetPath, info.Path))\n\t\t\t}\n\t\t}\n\t}\n\n\treturn devices, nil\n}\n\nfunc (d *nvsandboxutilsDGPU) EnvVars() ([]discover.EnvVar, error) {\n\treturn nil, nil\n}\n\n// Hooks returns a hook to create the by-path symlinks for the discovered devices.\nfunc (d *nvsandboxutilsDGPU) Hooks() ([]discover.Hook, error) {\n\tif len(d.deviceLinks) == 0 {\n\t\treturn nil, nil\n\t}\n\n\thook := d.hookCreator.Create(\"create-symlinks\", d.deviceLinks...)\n\n\treturn hook.Hooks()\n}\n\nfunc (d *nvsandboxutilsDGPU) Mounts() ([]discover.Mount, error) {\n\treturn nil, nil\n}\n"
},
{
"path": "internal/platform-support/dgpu/nvsandboxutils_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dgpu\n\nimport (\n\t\"testing\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\tmocknvml \"github.com/NVIDIA/go-nvml/pkg/nvml/mock\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils\"\n\tmocknvsandboxutils \"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils/mock\"\n)\n\nfunc TestNewNvsandboxutilsDGPUDiscoverer(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tnvmllib := &mocknvml.Interface{}\n\tdevicelib := device.New(\n\t\tnvmllib,\n\t)\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdevRoot string\n\t\tdevice nvml.Device\n\t\tnvsandboxutils nvsandboxutils.Interface\n\t\texpectedError error\n\t\texpectedDevices []discover.Device\n\t\texpectedHooks []discover.Hook\n\t\texpectedMounts []discover.Mount\n\t}{\n\t\t{\n\t\t\tdescription: \"detects host devices\",\n\t\t\tdevice: &mocknvml.Device{\n\t\t\t\tGetUUIDFunc: func() (string, nvml.Return) {\n\t\t\t\t\treturn \"GPU-1234\", nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\tnvsandboxutils: &mocknvsandboxutils.Interface{\n\t\t\t\tGetGpuResourceFunc: func(s string) ([]nvsandboxutils.GpuFileInfo, nvsandboxutils.Ret) {\n\t\t\t\t\tinfos := []nvsandboxutils.GpuFileInfo{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t\t\t\tType: nvsandboxutils.NV_DEV,\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/nvidiactl\",\n\t\t\t\t\t\t\tType: nvsandboxutils.NV_DEV,\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/nvidia-uvm\",\n\t\t\t\t\t\t\tType: nvsandboxutils.NV_DEV,\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/nvidia-uvm-tools\",\n\t\t\t\t\t\t\tType: nvsandboxutils.NV_DEV,\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn infos, nvsandboxutils.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t\tHostPath: \"/dev/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidiactl\",\n\t\t\t\t\tHostPath: \"/dev/nvidiactl\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia-uvm\",\n\t\t\t\t\tHostPath: \"/dev/nvidia-uvm\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia-uvm-tools\",\n\t\t\t\t\tHostPath: \"/dev/nvidia-uvm-tools\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"detects container devices\",\n\t\t\tdevRoot: \"/some/root\",\n\t\t\tdevice: &mocknvml.Device{\n\t\t\t\tGetUUIDFunc: func() (string, nvml.Return) {\n\t\t\t\t\treturn \"GPU-1234\", nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\tnvsandboxutils: &mocknvsandboxutils.Interface{\n\t\t\t\tGetGpuResourceFunc: func(s string) ([]nvsandboxutils.GpuFileInfo, nvsandboxutils.Ret) {\n\t\t\t\t\tinfos := []nvsandboxutils.GpuFileInfo{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/some/root/dev/nvidia0\",\n\t\t\t\t\t\t\tType: nvsandboxutils.NV_DEV,\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/some/root/dev/nvidiactl\",\n\t\t\t\t\t\t\tType: nvsandboxutils.NV_DEV,\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/some/root/dev/nvidia-uvm\",\n\t\t\t\t\t\t\tType: nvsandboxutils.NV_DEV,\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/some/root/dev/nvidia-uvm-tools\",\n\t\t\t\t\t\t\tType: nvsandboxutils.NV_DEV,\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn infos, nvsandboxutils.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t\tHostPath: \"/some/root/dev/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidiactl\",\n\t\t\t\t\tHostPath: \"/some/root/dev/nvidiactl\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia-uvm\",\n\t\t\t\t\tHostPath: \"/some/root/dev/nvidia-uvm\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia-uvm-tools\",\n\t\t\t\t\tHostPath: \"/some/root/dev/nvidia-uvm-tools\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\to, err := new(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithDriver(root.New(root.WithDevRoot(tc.devRoot))),\n\t\t\t\tWithNvsandboxuitilsLib(tc.nvsandboxutils),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevice, err := devicelib.NewDevice(tc.device)\n\t\t\trequire.NoError(t, err)\n\n\t\t\td, err := o.newNvsandboxutilsDGPUDiscoverer(device)\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\n\t\t\tdevices, _ := d.Devices()\n\t\t\trequire.EqualValues(t, tc.expectedDevices, devices)\n\t\t\thooks, _ := d.Hooks()\n\t\t\trequire.EqualValues(t, tc.expectedHooks, hooks)\n\t\t\tmounts, _ := d.Mounts()\n\t\t\trequire.EqualValues(t, tc.expectedMounts, mounts)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/platform-support/dgpu/options.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage dgpu\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvcaps\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils\"\n)\n\ntype options struct {\n\tlogger logger.Interface\n\tdriver *root.Driver\n\thookCreator discover.HookCreator\n\n\tisMigDevice bool\n\t// migCaps stores the MIG capabilities for the system.\n\t// If MIG is not available, this is nil.\n\tmigCaps nvcaps.MigCaps\n\tmigCapsError error\n\n\tnvsandboxutilslib nvsandboxutils.Interface\n}\n\ntype Option func(*options)\n\n// WithDriver sets the driver root.\nfunc WithDriver(driver *root.Driver) Option {\n\treturn func(l *options) {\n\t\tl.driver = driver\n\t}\n}\n\n// WithLogger sets the logger for the library\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(l *options) {\n\t\tl.logger = logger\n\t}\n}\n\n// WithHookCreator sets the hook creator for the library\nfunc WithHookCreator(hookCreator discover.HookCreator) Option {\n\treturn func(l *options) {\n\t\tl.hookCreator = hookCreator\n\t}\n}\n\n// WithMIGCaps sets the MIG capabilities.\nfunc WithMIGCaps(migCaps nvcaps.MigCaps) Option {\n\treturn func(l *options) {\n\t\tl.migCaps = migCaps\n\t}\n}\n\n// WithNvsandboxuitilsLib sets the nvsandboxutils library implementation.\nfunc WithNvsandboxuitilsLib(nvsandboxutilslib nvsandboxutils.Interface) Option {\n\treturn func(l *options) {\n\t\tl.nvsandboxutilslib = nvsandboxutilslib\n\t}\n}\n"
},
{
"path": "internal/platform-support/tegra/csv/csv.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage csv\n\nimport (\n\t\"bufio\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\nconst (\n\t// DefaultMountSpecPath is default location of CSV files that define the modifications required to the OCI spec\n\tDefaultMountSpecPath = \"/etc/nvidia-container-runtime/host-files-for-container.d\"\n)\n\n// DefaultFileList returns the list of CSV files that are used by default.\nfunc DefaultFileList() []string {\n\tfiles := []string{\n\t\t\"devices.csv\",\n\t\t\"drivers.csv\",\n\t\t\"l4t.csv\",\n\t}\n\n\tvar paths []string\n\tfor _, file := range files {\n\t\tpaths = append(paths, filepath.Join(DefaultMountSpecPath, file))\n\t}\n\n\treturn paths\n}\n\n// GetFileList returns the (non-recursive) list of CSV files in the specified\n// folder\nfunc GetFileList(root string) ([]string, error) {\n\tcontents, err := os.ReadDir(root)\n\tif err != nil && errors.Is(err, os.ErrNotExist) {\n\t\treturn nil, nil\n\t} else if err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to read the contents of %v: %v\", root, err)\n\t}\n\n\tvar csvFilePaths []string\n\tfor _, c := range contents {\n\t\tif c.IsDir() {\n\t\t\tcontinue\n\t\t}\n\t\tif c.Name() == \".csv\" {\n\t\t\tcontinue\n\t\t}\n\t\text := strings.ToLower(filepath.Ext(c.Name()))\n\t\tif ext != \".csv\" {\n\t\t\tcontinue\n\t\t}\n\n\t\tcsvFilePaths = append(csvFilePaths, filepath.Join(root, c.Name()))\n\t}\n\n\treturn csvFilePaths, nil\n}\n\n// BaseFilesOnly filters out non-base CSV files from the list of CSV files.\nfunc BaseFilesOnly(filenames []string) []string {\n\tfilter := map[string]bool{\n\t\t\"l4t.csv\": true,\n\t\t\"drivers.csv\": true,\n\t\t\"devices.csv\": true,\n\t}\n\n\tvar selected []string\n\tfor _, file := range filenames {\n\t\tbase := filepath.Base(file)\n\t\tif filter[base] {\n\t\t\tselected = append(selected, file)\n\t\t}\n\t}\n\n\treturn selected\n}\n\n// Parser specifies an interface for parsing MountSpecs\ntype Parser interface {\n\tParse() ([]*MountSpec, error)\n}\n\ntype csv struct {\n\tlogger logger.Interface\n\tfilename string\n}\n\n// NewCSVFileParser creates a new parser for reading MountSpecs from the specified CSV file\nfunc NewCSVFileParser(logger logger.Interface, filename string) Parser {\n\tp := csv{\n\t\tlogger: logger,\n\t\tfilename: filename,\n\t}\n\n\treturn &p\n}\n\n// Parse parses the csv file and returns a list of MountSpecs in the file\nfunc (p csv) Parse() ([]*MountSpec, error) {\n\treader, err := os.Open(p.filename)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to open %v for reading: %v\", p.filename, err)\n\t}\n\tdefer reader.Close()\n\n\treturn p.parseFromReader(reader), nil\n}\n\n// parseFromReader parses the specified file and returns a list of required jetson mounts\nfunc (p csv) parseFromReader(reader io.Reader) []*MountSpec {\n\tvar targets []*MountSpec\n\n\tscanner := bufio.NewScanner(reader)\n\tfor scanner.Scan() {\n\t\tline := scanner.Text()\n\t\ttarget, err := NewMountSpecFromLine(line)\n\t\tif err != nil {\n\t\t\tp.logger.Debugf(\"Skipping invalid mount spec '%v': %v\", line, err)\n\t\t\tcontinue\n\t\t}\n\t\ttargets = append(targets, target)\n\t}\n\n\treturn targets\n}\n"
},
{
"path": "internal/platform-support/tegra/csv/csv_test.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage csv\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestGetFileList(t *testing.T) {\n\tmoduleRoot, _ := test.GetModuleRoot()\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\troot string\n\t\tfiles []string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"returns list of CSV files\",\n\t\t\troot: \"tests/input/csv_samples/\",\n\t\t\tfiles: []string{\n\t\t\t\t\"jetson.csv\",\n\t\t\t\t\"simple_wrong.csv\",\n\t\t\t\t\"simple.csv\",\n\t\t\t\t\"spaced.csv\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"handles empty folder\",\n\t\t\troot: \"tests/input/csv_samples/empty\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"handles non-existent folder\",\n\t\t\troot: \"tests/input/csv_samples/NONEXISTENT\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"handles non-existent folder root\",\n\t\t\troot: \"/NONEXISTENT/tests/input/csv_samples/\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\troot := filepath.Join(moduleRoot, tc.root)\n\t\t\tfiles, err := GetFileList(root)\n\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\trequire.Empty(t, files)\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\trequire.NoError(t, err)\n\n\t\t\tvar foundFiles []string\n\t\t\tfor _, f := range files {\n\t\t\t\trequire.Equal(t, root, filepath.Dir(f))\n\t\t\t\trequire.Equal(t, \".csv\", filepath.Ext(f))\n\t\t\t\tfoundFiles = append(foundFiles, filepath.Base(f))\n\t\t\t}\n\n\t\t\trequire.ElementsMatch(t, tc.files, foundFiles)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/platform-support/tegra/csv/mount_spec.go",
"content": "/**\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage csv\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n)\n\n// MountSpecType defines the mount types allowed in a CSV file\ntype MountSpecType string\n\nconst (\n\t// MountSpecDev is used for character devices\n\tMountSpecDev = MountSpecType(\"dev\")\n\t// MountSpecDir is used for directories\n\tMountSpecDir = MountSpecType(\"dir\")\n\t// MountSpecLib is used for libraries or regular files\n\tMountSpecLib = MountSpecType(\"lib\")\n\t// MountSpecSym is used for symlinks.\n\tMountSpecSym = MountSpecType(\"sym\")\n)\n\n// MountSpec represents a Jetson mount consisting of a type and a path.\ntype MountSpec struct {\n\tType MountSpecType\n\tPath string\n}\n\n// NewMountSpecFromLine parses the specified line and returns the MountSpec or an error if the line is malformed\nfunc NewMountSpecFromLine(line string) (*MountSpec, error) {\n\tparts := strings.SplitN(strings.TrimSpace(line), \",\", 2)\n\tif len(parts) < 2 {\n\t\treturn nil, fmt.Errorf(\"failed to parse line: %v\", line)\n\t}\n\tmountType := strings.TrimSpace(parts[0])\n\tpath := strings.TrimSpace(parts[1])\n\n\treturn NewMountSpec(mountType, path)\n}\n\n// NewMountSpec creates a MountSpec with the specified type and path. An error is returned if the type is invalid.\nfunc NewMountSpec(mountType string, path string) (*MountSpec, error) {\n\tmt := MountSpecType(mountType)\n\tswitch mt {\n\tcase MountSpecDev, MountSpecLib, MountSpecSym, MountSpecDir:\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"unexpected mount type: %v\", mt)\n\t}\n\tif path == \"\" {\n\t\treturn nil, fmt.Errorf(\"invalid path: %v\", path)\n\t}\n\n\tmount := MountSpec{\n\t\tType: mt,\n\t\tPath: path,\n\t}\n\n\treturn &mount, nil\n}\n"
},
{
"path": "internal/platform-support/tegra/csv/mount_spec_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage csv\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNewMountSpecFromLine(t *testing.T) {\n\tparseError := fmt.Errorf(\"failed to parse line\")\n\tunexpectedError := fmt.Errorf(\"unexpected mount type\")\n\n\ttestCases := []struct {\n\t\tline string\n\t\texpectedError error\n\t\texpectedValue MountSpec\n\t}{\n\t\t{\n\t\t\tline: \"\",\n\t\t\texpectedError: parseError,\n\t\t},\n\t\t{\n\t\t\tline: \"\\t\",\n\t\t\texpectedError: parseError,\n\t\t},\n\t\t{\n\t\t\tline: \",\",\n\t\t\texpectedError: parseError,\n\t\t},\n\t\t{\n\t\t\tline: \"dev,\",\n\t\t\texpectedError: parseError,\n\t\t},\n\t\t{\n\t\t\tline: \"dev ,/a/path\",\n\t\t\texpectedValue: MountSpec{\n\t\t\t\tPath: \"/a/path\",\n\t\t\t\tType: \"dev\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tline: \"dev ,/a/path,with,commas\",\n\t\t\texpectedValue: MountSpec{\n\t\t\t\tPath: \"/a/path,with,commas\",\n\t\t\t\tType: \"dev\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tline: \"not-dev ,/a/path\",\n\t\t\texpectedError: unexpectedError,\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"test case %d\", i), func(t *testing.T) {\n\t\t\ttc := tc\n\t\t\ttarget, err := NewMountSpecFromLine(tc.line)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\treturn\n\t\t\t}\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, &tc.expectedValue, target)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/platform-support/tegra/csv.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra/csv\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// newDiscovererFromMountSpecs creates a discoverer for the specified mount specs.\nfunc (o options) newDiscovererFromMountSpecs(targetsByType MountSpecPathsByType) discover.Discover {\n\tif len(targetsByType) == 0 {\n\t\to.logger.Warningf(\"No mount specs specified\")\n\t\treturn discover.None{}\n\t}\n\n\tdevices := discover.NewCharDeviceDiscoverer(\n\t\to.logger,\n\t\to.driver.DevRoot,\n\t\ttargetsByType[csv.MountSpecDev],\n\t)\n\n\tdirectories := discover.NewMounts(\n\t\to.logger,\n\t\tlookup.NewDirectoryLocator(lookup.WithLogger(o.logger), lookup.WithRoot(o.driver.Root)),\n\t\to.driver.Root,\n\t\ttargetsByType[csv.MountSpecDir],\n\t)\n\n\t// We create a discoverer for mounted libraries and add additional .so\n\t// symlinks for the driver.\n\tlibraries := discover.WithDriverDotSoSymlinks(\n\t\to.logger,\n\t\tdiscover.NewMounts(\n\t\t\to.logger,\n\t\t\to.symlinkLocator,\n\t\t\to.driver.Root,\n\t\t\ttargetsByType[csv.MountSpecLib],\n\t\t),\n\t\t\"\",\n\t\to.hookCreator,\n\t)\n\n\t// We process the explicitly requested symlinks.\n\tsymlinks := discover.NewMounts(\n\t\to.logger,\n\t\to.symlinkLocator,\n\t\to.driver.Root,\n\t\ttargetsByType[csv.MountSpecSym],\n\t)\n\tcreateSymlinks := o.createCSVSymlinkHooks(targetsByType[csv.MountSpecSym])\n\n\treturn discover.Merge(\n\t\tdevices,\n\t\tdirectories,\n\t\tlibraries,\n\t\tsymlinks,\n\t\tcreateSymlinks,\n\t)\n}\n\n// MountSpecsFromCSVFiles returns a MountSpecPathsByTyper for the specified list\n// of CSV files.\nfunc MountSpecsFromCSVFiles(logger logger.Interface, csvFilePaths ...string) MountSpecPathsByType {\n\tvar mountSpecs mountSpecPathsByTypers\n\n\tfor _, filename := range csvFilePaths {\n\t\ttargets, err := loadCSVFile(logger, filename)\n\t\tif err != nil {\n\t\t\tlogger.Warningf(\"Skipping CSV file %v: %v\", filename, err)\n\t\t\tcontinue\n\t\t}\n\t\ttargetsByType := make(MountSpecPathsByType)\n\t\tfor _, t := range targets {\n\t\t\ttargetsByType[t.Type] = append(targetsByType[t.Type], t.Path)\n\t\t}\n\t\tmountSpecs = append(mountSpecs, targetsByType)\n\t}\n\treturn mountSpecs.MountSpecPathsByType()\n}\n\n// loadCSVFile loads the specified CSV file and returns the list of mount specs\nfunc loadCSVFile(logger logger.Interface, filename string) ([]*csv.MountSpec, error) {\n\t// Create a discoverer for each file-kind combination\n\ttargets, err := csv.NewCSVFileParser(logger, filename).Parse()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to parse CSV file: %v\", err)\n\t}\n\tif len(targets) == 0 {\n\t\treturn nil, fmt.Errorf(\"CSV file is empty\")\n\t}\n\n\treturn targets, nil\n}\n"
},
{
"path": "internal/platform-support/tegra/csv_test.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nfunc TestDiscovererFromCSVFiles(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\ttestCases := []struct {\n\t\tdescription string\n\t\tmoutSpecs MountSpecPathsByType\n\t\tignorePatterns []string\n\t\tsymlinkLocator lookup.Locator\n\t\tsymlinkChainLocator lookup.Locator\n\t\tsymlinkResolver func(string) (string, error)\n\t\texpectedError error\n\t\texpectedMounts []discover.Mount\n\t\texpectedMountsError error\n\t\texpectedHooks []discover.Hook\n\t\texpectedHooksError error\n\t}{\n\t\t{\n\t\t\t// TODO: This current resolves to two mounts that are the same.\n\t\t\t// These are deduplicated at a later stage. We could consider deduplicating earlier in the pipeline.\n\t\t\tdescription: \"symlink is resolved to target; mounts and symlink are created\",\n\t\t\tmoutSpecs: MountSpecPathsByType{\n\t\t\t\t\"lib\": {\"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\"},\n\t\t\t\t\"sym\": {\"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\"},\n\t\t\t},\n\t\t\tsymlinkLocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(path string) ([]string, error) {\n\t\t\t\t\tif path == \"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\" {\n\t\t\t\t\t\treturn []string{\"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\"}, nil\n\t\t\t\t\t}\n\t\t\t\t\treturn []string{path}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tsymlinkChainLocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(path string) ([]string, error) {\n\t\t\t\t\tif path == \"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\" {\n\t\t\t\t\t\treturn []string{\"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\", \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\"}, nil\n\t\t\t\t\t}\n\t\t\t\t\treturn nil, fmt.Errorf(\"Unexpected path: %v\", path)\n\t\t\t\t},\n\t\t\t},\n\t\t\tsymlinkResolver: func(path string) (string, error) {\n\t\t\t\tif path == \"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\" {\n\t\t\t\t\treturn \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\", nil\n\t\t\t\t}\n\t\t\t\treturn path, nil\n\t\t\t},\n\t\t\texpectedMounts: []discover.Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tHostPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tOptions: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"},\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tHostPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tOptions: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []discover.Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\"nvidia-cdi-hook\",\n\t\t\t\t\t\t\"create-symlinks\",\n\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so::/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\",\n\t\t\t\t\t},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\t// TODO: This current resolves to two mounts that are the same.\n\t\t\t// These are deduplicated at a later stage. We could consider deduplicating earlier in the pipeline.\n\t\t\tdescription: \"single glob filter does not remove symlink mounts\",\n\t\t\tmoutSpecs: MountSpecPathsByType{\n\t\t\t\t\"lib\": {\"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\"},\n\t\t\t\t\"sym\": {\"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\"},\n\t\t\t},\n\t\t\tignorePatterns: []string{\"*.so\"},\n\t\t\tsymlinkLocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(path string) ([]string, error) {\n\t\t\t\t\tif path == \"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\" {\n\t\t\t\t\t\treturn []string{\"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\"}, nil\n\t\t\t\t\t}\n\t\t\t\t\treturn []string{path}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tsymlinkChainLocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(path string) ([]string, error) {\n\t\t\t\t\tif path == \"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\" {\n\t\t\t\t\t\treturn []string{\"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\", \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\"}, nil\n\t\t\t\t\t}\n\t\t\t\t\treturn nil, fmt.Errorf(\"Unexpected path: %v\", path)\n\t\t\t\t},\n\t\t\t},\n\t\t\tsymlinkResolver: func(path string) (string, error) {\n\t\t\t\tif path == \"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\" {\n\t\t\t\t\treturn \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\", nil\n\t\t\t\t}\n\t\t\t\treturn path, nil\n\t\t\t},\n\t\t\texpectedMounts: []discover.Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tHostPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tOptions: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"},\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tHostPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tOptions: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []discover.Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\"nvidia-cdi-hook\",\n\t\t\t\t\t\t\"create-symlinks\",\n\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so::/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\",\n\t\t\t\t\t},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"** filter removes symlink mounts\",\n\t\t\tmoutSpecs: MountSpecPathsByType{\n\t\t\t\t\"lib\": {\"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\"},\n\t\t\t\t\"sym\": {\"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\"},\n\t\t\t},\n\t\t\tsymlinkLocator: &lookup.LocatorMock{\n\t\t\t\tLocateFunc: func(path string) ([]string, error) {\n\t\t\t\t\tif path == \"/usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\" {\n\t\t\t\t\t\treturn []string{\"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\"}, nil\n\t\t\t\t\t}\n\t\t\t\t\treturn []string{path}, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\tignorePatterns: []string{\"**/*.so\"},\n\t\t\texpectedMounts: []discover.Mount{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tHostPath: \"/usr/lib/aarch64-linux-gnu/tegra/libv4l2_nvargus.so\",\n\t\t\t\t\tOptions: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\thookCreator := discover.NewHookCreator()\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\to := options{\n\t\t\t\tlogger: logger,\n\t\t\t\tdriver: root.New(),\n\t\t\t\thookCreator: hookCreator,\n\t\t\t\tsymlinkLocator: tc.symlinkLocator,\n\t\t\t\tsymlinkChainLocator: tc.symlinkChainLocator,\n\t\t\t\tresolveSymlink: tc.symlinkResolver,\n\n\t\t\t\tmountSpecs: Transform(\n\t\t\t\t\ttc.moutSpecs,\n\t\t\t\t\tIgnoreSymlinkMountSpecsByPattern(tc.ignorePatterns...),\n\t\t\t\t),\n\t\t\t}\n\n\t\t\td := o.newDiscovererFromMountSpecs(o.mountSpecs.MountSpecPathsByType())\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.ErrorIs(t, err, tc.expectedHooksError)\n\t\t\trequire.EqualValues(t, tc.expectedHooks, hooks)\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.ErrorIs(t, err, tc.expectedMountsError)\n\t\t\trequire.EqualValues(t, tc.expectedMounts, mounts)\n\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/platform-support/tegra/filter.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra\n\nimport (\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra/csv\"\n)\n\ntype ignoreSymlinkMountSpecPatterns []string\n\nfunc (d ignoreSymlinkMountSpecPatterns) match(name string) bool {\n\tfor _, pattern := range d {\n\t\ttarget := name\n\t\tif strings.HasPrefix(pattern, \"**/\") {\n\t\t\ttarget = filepath.Base(name)\n\t\t\tpattern = strings.TrimPrefix(pattern, \"**/\")\n\t\t}\n\t\tif match, _ := filepath.Match(pattern, target); match {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (d ignoreSymlinkMountSpecPatterns) filter(input ...string) []string {\n\tvar filtered []string\n\tfor _, name := range input {\n\t\tif d.match(name) {\n\t\t\tcontinue\n\t\t}\n\t\tfiltered = append(filtered, name)\n\t}\n\treturn filtered\n}\n\nfunc (d ignoreSymlinkMountSpecPatterns) Apply(input MountSpecPathsByTyper) MountSpecPathsByTyper {\n\tms := input.MountSpecPathsByType()\n\n\tif symlinks, ok := ms[csv.MountSpecSym]; ok {\n\t\tms[csv.MountSpecSym] = d.filter(symlinks...)\n\t}\n\n\treturn ms\n}\n\n// A filter removes elements from an input list and returns the remaining\n// elements.\ntype filter interface {\n\tapply(...string) []string\n}\n\n// A stringMatcher implements the MatchString function.\ntype stringMatcher interface {\n\tMatchString(string) bool\n}\n\n// A matcherAsFilter is used to ensure that a string matcher can be used as a filter.\ntype matcherAsFilter struct {\n\tstringMatcher\n}\n\ntype filterByMountSpecType map[csv.MountSpecType]filter\ntype filterByMountSpecPathsByTyper struct {\n\tMountSpecPathsByTyper\n}\n\ntype pathPatterns []string\ntype pathPattern string\ntype basenamePattern string\n\n// MatchString for a set of path patterns returns true if any of the patterns\n// matches against the input string.\nfunc (d pathPatterns) MatchString(input string) bool {\n\tfor _, pattern := range d {\n\t\tif match := pathPattern(pattern).MatchString(input); match {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\n// MatchString attempts to match a path pattern to the specified input string.\n// If the pattern starts with `**/` the input is treated as a path and only\n// the basenames are matched using regular glob rules.\nfunc (d pathPattern) MatchString(input string) bool {\n\tif strings.HasPrefix(string(d), \"**/\") {\n\t\treturn basenamePattern(d).MatchString(input)\n\t}\n\tmatch, _ := filepath.Match(string(d), input)\n\treturn match\n}\n\n// MatchString for a basename pattern applies the specified pattern against the\n// basename of the input.\n// If the pattern starts with **/, this is stripped before attempting to match.\nfunc (d basenamePattern) MatchString(input string) bool {\n\tpattern := strings.TrimPrefix(string(d), \"**/\")\n\tmatch, _ := filepath.Match(pattern, filepath.Base(input))\n\treturn match\n}\n\n// Apply the specified per-type filters to the input mount specs.\nfunc (p filterByMountSpecType) Apply(input MountSpecPathsByTyper) MountSpecPathsByTyper {\n\tms := input.MountSpecPathsByType()\n\tfor t, filter := range p {\n\t\tif len(ms[t]) == 0 {\n\t\t\tcontinue\n\t\t}\n\t\tms[t] = filter.apply(ms[t]...)\n\t}\n\treturn ms\n}\n\nfunc (p filterByMountSpecPathsByTyper) Apply(input MountSpecPathsByTyper) MountSpecPathsByTyper {\n\tf := make(filterByMountSpecType)\n\tfor t, paths := range p.MountSpecPathsByType() {\n\t\tf[t] = &matcherAsFilter{pathPatterns(paths)}\n\t}\n\treturn f.Apply(input)\n}\n\n// apply uses a matcher to filter an input string.\n// Each element in the input that matches is skipped and the remaining elements\n// are returned.\nfunc (f *matcherAsFilter) apply(input ...string) []string {\n\tvar filtered []string\n\tfor _, path := range input {\n\t\tif f.MatchString(path) {\n\t\t\tcontinue\n\t\t}\n\t\tfiltered = append(filtered, path)\n\t}\n\treturn filtered\n}\n\n// removeAll is a filter that will not return any inputs.\ntype removeAll struct{}\n\nfunc (a removeAll) apply(...string) []string {\n\treturn nil\n}\n"
},
{
"path": "internal/platform-support/tegra/filter_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestIgnorePatterns(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tblockedFilter pathPatterns\n\t\tinput []string\n\t\texpected []string\n\t}{\n\t\t{\n\t\t\tdescription: \"nil slice\",\n\t\t\tinput: []string{\"something\", \"somethingelse\"},\n\t\t\texpected: []string{\"something\", \"somethingelse\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"match libraries full path and so symlinks using globs\",\n\t\t\tblockedFilter: []string{\"*.so\", \"*.so.[0-9]\"},\n\t\t\tinput: []string{\"/foo/bar/libsomething.so\", \"libsometing.so\", \"libsometing.so.1\", \"libsometing.so.1.2.3\"},\n\t\t\texpected: []string{\"/foo/bar/libsomething.so\", \"libsometing.so.1.2.3\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"match libraries full path and so symlinks using globs with any path prefix\",\n\t\t\tblockedFilter: []string{\"**/*.so\", \"**/*.so.[0-9]\"},\n\t\t\tinput: []string{\"/foo/bar/libsomething.so\", \"libsometing.so\", \"libsometing.so.1\", \"libsometing.so.1.2.3\"},\n\t\t\texpected: []string{\"libsometing.so.1.2.3\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tfiltered := ignoreSymlinkMountSpecPatterns(tc.blockedFilter).filter(tc.input...)\n\t\t\trequire.ElementsMatch(t, tc.expected, filtered)\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/platform-support/tegra/mount_specs.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra\n\nimport (\n\t\"regexp\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra/csv\"\n)\n\ntype MountSpecPathsByTyper interface {\n\tMountSpecPathsByType() MountSpecPathsByType\n}\n\n// moutSpecPathsByTypers represents a collection of MountSpecPathsByTyper\ntype mountSpecPathsByTypers []MountSpecPathsByTyper\n\n// MountSpecPathsByType define the per-type paths that define the entities\n// (e.g. device nodes, directories, libraries, symlinks) that are required for\n// gpu use on Tegra-based systems.\n// These are typically populated from CSV files defined by the platform owner.\ntype MountSpecPathsByType map[csv.MountSpecType][]string\n\nvar _ MountSpecPathsByTyper = (MountSpecPathsByType)(nil)\nvar _ MountSpecPathsByTyper = (mountSpecPathsByTypers)(nil)\n\n// MountSpecPathsByType for a variable of type MountSpecPathsByType returns the\n// underlying data structure.\n// This allows for using this type in functions such as Merge and Filter.\nfunc (m MountSpecPathsByType) MountSpecPathsByType() MountSpecPathsByType {\n\treturn m\n}\n\n// MountSpecPathsByType returns the combination of mount specs by type for the\n// collection.\nfunc (collection mountSpecPathsByTypers) MountSpecPathsByType() MountSpecPathsByType {\n\tmerged := make(MountSpecPathsByType)\n\tfor _, t := range collection {\n\t\tif t == nil {\n\t\t\tcontinue\n\t\t}\n\t\tfor tType, targets := range t.MountSpecPathsByType() {\n\t\t\tmerged[tType] = append(merged[tType], targets...)\n\t\t}\n\t}\n\treturn merged\n\n}\n\n// A Transformer modifies a specified set of mount specs by type.\n// The output of a transformer is itself a set of mount specs by type.\ntype Transformer interface {\n\tApply(MountSpecPathsByTyper) MountSpecPathsByTyper\n}\n\n// Transform applies the specified transforms to a set of mount specs by type.\n// The result is itself a set of mount specs by type.\nfunc Transform(input MountSpecPathsByTyper, t ...Transformer) MountSpecPathsByTyper {\n\treturn transformMountSpecByPathsByType{\n\t\tTransformer: allTransformers(t),\n\t\tinput: input,\n\t}\n}\n\ntype allTransformers []Transformer\n\nfunc (ts allTransformers) Apply(input MountSpecPathsByTyper) MountSpecPathsByTyper {\n\tfor _, t := range ts {\n\t\tif t == nil {\n\t\t\tcontinue\n\t\t}\n\t\tinput = t.Apply(input)\n\t}\n\treturn input\n}\n\ntype transformMountSpecByPathsByType struct {\n\tTransformer\n\tinput MountSpecPathsByTyper\n}\n\ntype merge []MountSpecPathsByTyper\n\n// Merge combines the MountSpecPathsByType for the specified sources.\nfunc Merge(sources ...MountSpecPathsByTyper) MountSpecPathsByTyper {\n\treturn merge(sources)\n}\n\n// MountSpecPathsByType for a set of merged mount specs combines the list of\n// paths per type.\nfunc (ts merge) MountSpecPathsByType() MountSpecPathsByType {\n\ttargetsByType := make(MountSpecPathsByType)\n\tfor _, t := range ts {\n\t\tif t == nil {\n\t\t\tcontinue\n\t\t}\n\t\tfor tType, targets := range t.MountSpecPathsByType() {\n\t\t\ttargetsByType[tType] = append(targetsByType[tType], targets...)\n\t\t}\n\t}\n\treturn targetsByType\n}\n\nfunc (m transformMountSpecByPathsByType) MountSpecPathsByType() MountSpecPathsByType {\n\treturn m.Apply(m.input).MountSpecPathsByType()\n}\n\nfunc IgnoreSymlinkMountSpecsByPattern(ignorePatterns ...string) Transformer {\n\treturn ignoreSymlinkMountSpecPatterns(ignorePatterns)\n}\n\n// OnlyDeviceNodes creates a transformer that will remove any input mounts specs\n// that are not of the `MountSpecDev` type.\nfunc OnlyDeviceNodes() Transformer {\n\treturn filterByMountSpecType{\n\t\tcsv.MountSpecDir: removeAll{},\n\t\tcsv.MountSpecLib: removeAll{},\n\t\tcsv.MountSpecSym: removeAll{},\n\t}\n}\n\n// WithoutDeviceNodes creates a transformer that will remove entries with type\n// MountSpecDevice from the input.\nfunc WithoutDeviceNodes() Transformer {\n\treturn filterByMountSpecType{\n\t\tcsv.MountSpecDev: removeAll{},\n\t}\n}\n\nfunc Without(m MountSpecPathsByTyper) Transformer {\n\treturn filterByMountSpecPathsByTyper{m}\n}\n\n// WithoutRegularDeviceNodes creates a transfomer which removes\n// regular `/dev/nvidia[0-9]+` device nodes from the source.\nfunc WithoutRegularDeviceNodes() Transformer {\n\treturn filterByMountSpecType{\n\t\tcsv.MountSpecDev: &matcherAsFilter{regexp.MustCompile(\"^/dev/nvidia[0-9]+$\")},\n\t}\n}\n\n// DeviceNodes creates a set of MountSpecPaths for the specified device nodes.\n// These have the MoutSpecDev type.\nfunc DeviceNodes(dn ...string) MountSpecPathsByTyper {\n\treturn MountSpecPathsByType{\n\t\tcsv.MountSpecDev: dn,\n\t}\n}\n\n// DeviceNodes creates a set of MountSpecPaths for the specified symlinks.\n// These have the MountSpecSym type.\nfunc Symlinks(s ...string) MountSpecPathsByTyper {\n\treturn MountSpecPathsByType{\n\t\tcsv.MountSpecSym: s,\n\t}\n}\n"
},
{
"path": "internal/platform-support/tegra/options.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\ntype options struct {\n\tlogger logger.Interface\n\tdriver *root.Driver\n\thookCreator discover.HookCreator\n\tlibrarySearchPaths []string\n\n\t// The following can be overridden for testing\n\tsymlinkLocator lookup.Locator\n\tsymlinkChainLocator lookup.Locator\n\t// TODO: This should be replaced by a regular mock\n\tresolveSymlink func(string) (string, error)\n\n\tmountSpecs MountSpecPathsByTyper\n}\n\n// Option defines a functional option for configuring a Tegra discoverer.\ntype Option func(*options)\n\n// WithLogger sets the logger for the discoverer.\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(o *options) {\n\t\to.logger = logger\n\t}\n}\n\n// WithDriverRoot sets the driver root for the discoverer.\nfunc WithDriver(driver *root.Driver) Option {\n\treturn func(o *options) {\n\t\to.driver = driver\n\t}\n}\n\n// WithHookCreator sets the hook creator for the discoverer.\nfunc WithHookCreator(hookCreator discover.HookCreator) Option {\n\treturn func(o *options) {\n\t\to.hookCreator = hookCreator\n\t}\n}\n\n// WithLibrarySearchPaths sets the library search paths for the discoverer.\nfunc WithLibrarySearchPaths(librarySearchPaths ...string) Option {\n\treturn func(o *options) {\n\t\to.librarySearchPaths = librarySearchPaths\n\t}\n}\n\nfunc WithMountSpecs(mountSpecs ...MountSpecPathsByTyper) Option {\n\treturn func(o *options) {\n\t\to.mountSpecs = mountSpecPathsByTypers(mountSpecs)\n\t}\n}\n"
},
{
"path": "internal/platform-support/tegra/symlinks.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\ntype symlinkHook struct {\n\tdiscover.None\n\tlogger logger.Interface\n\thookCreator discover.HookCreator\n\ttargets []string\n\n\t// The following can be overridden for testing\n\tsymlinkChainLocator lookup.Locator\n\tresolveSymlink func(string) (string, error)\n}\n\n// createCSVSymlinkHooks creates a discoverer for a hook that creates required symlinks in the container\nfunc (o options) createCSVSymlinkHooks(targets []string) discover.Discover {\n\treturn symlinkHook{\n\t\tlogger: o.logger,\n\t\thookCreator: o.hookCreator,\n\t\ttargets: targets,\n\t\tsymlinkChainLocator: o.symlinkChainLocator,\n\t\tresolveSymlink: o.resolveSymlink,\n\t}\n}\n\n// Hooks returns a hook to create the symlinks from the required CSV files\nfunc (d symlinkHook) Hooks() ([]discover.Hook, error) {\n\treturn d.hookCreator.Create(\"create-symlinks\", d.getCSVFileSymlinks()...).Hooks()\n}\n\n// getSymlinkCandidates returns a list of symlinks that are candidates for being created.\nfunc (d symlinkHook) getSymlinkCandidates() []string {\n\tvar candidates []string\n\tfor _, target := range d.targets {\n\t\treslovedSymlinkChain, err := d.symlinkChainLocator.Locate(target)\n\t\tif err != nil {\n\t\t\td.logger.Warningf(\"Failed to locate symlink %v\", target)\n\t\t\tcontinue\n\t\t}\n\t\tcandidates = append(candidates, reslovedSymlinkChain...)\n\t}\n\treturn candidates\n}\n\nfunc (d symlinkHook) getCSVFileSymlinks() []string {\n\tvar links []string\n\tcreated := make(map[string]bool)\n\t// candidates is a list of absolute paths to symlinks in a chain, or the final target of the chain.\n\tfor _, candidate := range d.getSymlinkCandidates() {\n\t\ttarget, err := d.resolveSymlink(candidate)\n\t\tif err != nil {\n\t\t\td.logger.Debugf(\"Skipping invalid link: %v\", err)\n\t\t\tcontinue\n\t\t} else if target == candidate {\n\t\t\td.logger.Debugf(\"%v is not a symlink\", candidate)\n\t\t\tcontinue\n\t\t}\n\n\t\tlink := fmt.Sprintf(\"%v::%v\", target, candidate)\n\t\tif created[link] {\n\t\t\td.logger.Debugf(\"skipping duplicate link: %v\", link)\n\t\t\tcontinue\n\t\t}\n\t\tcreated[link] = true\n\n\t\tlinks = append(links, link)\n\t}\n\n\treturn links\n}\n"
},
{
"path": "internal/platform-support/tegra/tegra.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup/symlinks\"\n)\n\n// New creates a new tegra discoverer using the supplied functional options.\nfunc New(opts ...Option) (discover.Discover, error) {\n\to := &options{\n\t\tlogger: &logger.NullLogger{},\n\t\tmountSpecs: mountSpecPathsByTypers{},\n\t}\n\tfor _, opt := range opts {\n\t\topt(o)\n\t}\n\tif o.driver == nil {\n\t\treturn nil, fmt.Errorf(\"a driver must be specified\")\n\t}\n\n\tif o.symlinkLocator == nil {\n\t\to.symlinkLocator = lookup.NewSymlinkLocator(\n\t\t\tlookup.WithLogger(o.logger),\n\t\t\tlookup.WithRoot(o.driver.Root),\n\t\t\tlookup.WithSearchPaths(append(o.librarySearchPaths, \"/\")...),\n\t\t)\n\t}\n\n\tif o.symlinkChainLocator == nil {\n\t\to.symlinkChainLocator = lookup.NewSymlinkChainLocator(\n\t\t\tlookup.WithLogger(o.logger),\n\t\t\tlookup.WithRoot(o.driver.Root),\n\t\t)\n\t}\n\n\tif o.resolveSymlink == nil {\n\t\to.resolveSymlink = symlinks.Resolve\n\t}\n\n\tmountSpecDiscoverer := o.newDiscovererFromMountSpecs(o.mountSpecs.MountSpecPathsByType())\n\n\ttegraSystemMounts := discover.NewMounts(\n\t\to.logger,\n\t\tlookup.NewFileLocator(lookup.WithLogger(o.logger)),\n\t\t\"\",\n\t\t[]string{\n\t\t\t\"/etc/nv_tegra_release\",\n\t\t},\n\t)\n\n\td := discover.Merge(\n\t\tmountSpecDiscoverer,\n\t\ttegraSystemMounts,\n\t)\n\n\treturn d, nil\n}\n"
},
{
"path": "internal/platform-support/tegra/tegra_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage tegra_test\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra/csv\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestTegraNew(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdriverRootfs string\n\t\tdevRootfs string\n\t\texpectedDevices []discover.Device\n\t\texpectedMounts []discover.Mount\n\t\texpectedHooks []discover.Hook\n\t}{\n\t\t{\n\t\t\tdescription: \"empty rootfs returns no devices\",\n\t\t\tdriverRootfs: \"rootfs-empty\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"rootfs with device nodes returns devices\",\n\t\t\tdriverRootfs: \"rootfs-orin\",\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t},\n\t\t\texpectedMounts: []discover.Mount{\n\t\t\t\t{Path: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t{Path: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t},\n\t\t\texpectedHooks: []discover.Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"split rootfs\",\n\t\t\tdriverRootfs: \"rootfs-orin\",\n\t\t\tdevRootfs: \"rootfs-split/dev-root\",\n\t\t\texpectedDevices: []discover.Device{\n\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t\t{Path: \"/dev/nvidiactl\", HostPath: \"/dev/nvidiactl\"},\n\t\t\t},\n\t\t\texpectedMounts: []discover.Mount{\n\t\t\t\t{Path: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t{Path: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t},\n\t\t\texpectedHooks: []discover.Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\thookCreator := discover.NewHookCreator()\n\n\t// We use the same csv file list for all test cases.\n\tvar csvFiles []string\n\tfor _, csvFile := range csv.DefaultFileList() {\n\t\tcsvFiles = append(csvFiles, filepath.Join(lookupRoot, \"rootfs-orin\", csvFile))\n\t}\n\tmountSpecs := tegra.MountSpecsFromCSVFiles(logger, csvFiles...)\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdriverRoot := tc.driverRootfs\n\t\t\tif driverRoot != \"\" {\n\t\t\t\tdriverRoot = filepath.Join(lookupRoot, tc.driverRootfs)\n\t\t\t}\n\t\t\tdevRoot := tc.devRootfs\n\t\t\tif devRoot != \"\" {\n\t\t\t\tdevRoot = filepath.Join(lookupRoot, tc.devRootfs)\n\t\t\t}\n\t\t\tdriver := root.New(root.WithDriverRoot(driverRoot), root.WithDevRoot(devRoot))\n\t\t\td, err := tegra.New(\n\t\t\t\ttegra.WithLogger(logger),\n\t\t\t\ttegra.WithDriver(driver),\n\t\t\t\ttegra.WithHookCreator(hookCreator),\n\t\t\t\ttegra.WithMountSpecs(mountSpecs),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevices, err := d.Devices()\n\t\t\trequire.NoError(t, err)\n\n\t\t\tif devRoot == \"\" {\n\t\t\t\tdevRoot = driverRoot\n\t\t\t}\n\t\t\trequire.EqualValues(t, tc.expectedDevices, test.StripRoot(devices, devRoot))\n\n\t\t\tmounts, err := d.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedMounts, test.StripRoot(mounts, driverRoot))\n\n\t\t\thooks, err := d.Hooks()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedHooks, test.StripRoot(hooks, driverRoot))\n\n\t\t\tenvVars, err := d.EnvVars()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, envVars)\n\t\t})\n\t}\n}\n\nfunc TestOptions(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdriver *root.Driver\n\t\texpectedErrorstring string\n\t}{\n\t\t{\n\t\t\tdescription: \"nill driver returns an error\",\n\t\t\texpectedErrorstring: \"a driver must be specified\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"valid driver\",\n\t\t\tdriver: root.New(),\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\t_, err := tegra.New(\n\t\t\t\ttegra.WithDriver(tc.driver),\n\t\t\t)\n\t\t\tif tc.expectedErrorstring == \"\" {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t} else {\n\t\t\t\trequire.EqualError(t, err, tc.expectedErrorstring)\n\t\t\t}\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/requirements/constants.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage requirements\n\n// A list of supported requirements / properties\nconst (\n\tARCH = \"arch\"\n\tBRAND = \"brand\"\n\tCUDA = \"cuda\"\n\tDRIVER = \"driver\"\n)\n"
},
{
"path": "internal/requirements/constraints/binary.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n\nimport (\n\t\"fmt\"\n)\n\n// binary represents a binary operation. This can be used to compare a specified\n// property to a value\ntype binary struct {\n\tleft Property\n\toperator string\n\tright string\n}\n\n// String returns the string representation of the binary comparator\nfunc (c binary) String() string {\n\treturn fmt.Sprintf(\"%v%v%v\", c.left.Name(), c.operator, c.right)\n}\n\n// Assert compares the property to the required value using the supplied comparator\nfunc (c binary) Assert() error {\n\tsatisfied, err := c.eval()\n\tif err != nil {\n\t\treturn err\n\t}\n\tif satisfied {\n\t\treturn nil\n\t}\n\n\t// error_setx(err, \"unsatisfied condition: %s, please update your driver to a newer version, or use an earlier cuda container\", predicate_format);\n\treturn fmt.Errorf(\"unsatisfied condition: %v (%v)\", c.String(), c.left.String())\n}\n\nfunc (c binary) eval() (bool, error) {\n\tif c.left == nil {\n\t\treturn true, nil\n\t}\n\n\tcompare, err := c.left.CompareTo(c.right)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\tswitch c.operator {\n\tcase equal:\n\t\treturn compare == 0, nil\n\tcase notEqual:\n\t\treturn compare != 0, nil\n\tcase less:\n\t\treturn compare < 0, nil\n\tcase lessEqual:\n\t\treturn compare <= 0, nil\n\tcase greater:\n\t\treturn compare > 0, nil\n\tcase greaterEqual:\n\t\treturn compare >= 0, nil\n\t}\n\n\treturn false, fmt.Errorf(\"invalid operator %v\", c.operator)\n}\n"
},
{
"path": "internal/requirements/constraints/constants.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n\nconst (\n\tequal = \"=\"\n\tnotEqual = \"!=\"\n\tless = \"<\"\n\tlessEqual = \"<=\"\n\tgreater = \">\"\n\tgreaterEqual = \">=\"\n)\n\n// always is a constraint that is always met\ntype always struct{}\n\nfunc (c always) Assert() error {\n\treturn nil\n}\n\nfunc (c always) String() string {\n\treturn \"true\"\n}\n"
},
{
"path": "internal/requirements/constraints/constraint_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage constraints\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that ConstraintMock does implement Constraint.\n// If this is not the case, regenerate this file with moq.\nvar _ Constraint = &ConstraintMock{}\n\n// ConstraintMock is a mock implementation of Constraint.\n//\n//\tfunc TestSomethingThatUsesConstraint(t *testing.T) {\n//\n//\t\t// make and configure a mocked Constraint\n//\t\tmockedConstraint := &ConstraintMock{\n//\t\t\tAssertFunc: func() error {\n//\t\t\t\tpanic(\"mock out the Assert method\")\n//\t\t\t},\n//\t\t\tStringFunc: func() string {\n//\t\t\t\tpanic(\"mock out the String method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedConstraint in code that requires Constraint\n//\t\t// and then make assertions.\n//\n//\t}\ntype ConstraintMock struct {\n\t// AssertFunc mocks the Assert method.\n\tAssertFunc func() error\n\n\t// StringFunc mocks the String method.\n\tStringFunc func() string\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Assert holds details about calls to the Assert method.\n\t\tAssert []struct {\n\t\t}\n\t\t// String holds details about calls to the String method.\n\t\tString []struct {\n\t\t}\n\t}\n\tlockAssert sync.RWMutex\n\tlockString sync.RWMutex\n}\n\n// Assert calls AssertFunc.\nfunc (mock *ConstraintMock) Assert() error {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockAssert.Lock()\n\tmock.calls.Assert = append(mock.calls.Assert, callInfo)\n\tmock.lockAssert.Unlock()\n\tif mock.AssertFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.AssertFunc()\n}\n\n// AssertCalls gets all the calls that were made to Assert.\n// Check the length with:\n//\n//\tlen(mockedConstraint.AssertCalls())\nfunc (mock *ConstraintMock) AssertCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockAssert.RLock()\n\tcalls = mock.calls.Assert\n\tmock.lockAssert.RUnlock()\n\treturn calls\n}\n\n// String calls StringFunc.\nfunc (mock *ConstraintMock) String() string {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockString.Lock()\n\tmock.calls.String = append(mock.calls.String, callInfo)\n\tmock.lockString.Unlock()\n\tif mock.StringFunc == nil {\n\t\tvar (\n\t\t\tsOut string\n\t\t)\n\t\treturn sOut\n\t}\n\treturn mock.StringFunc()\n}\n\n// StringCalls gets all the calls that were made to String.\n// Check the length with:\n//\n//\tlen(mockedConstraint.StringCalls())\nfunc (mock *ConstraintMock) StringCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockString.RLock()\n\tcalls = mock.calls.String\n\tmock.lockString.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/requirements/constraints/constraints.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n\n// Constraint represents a constraint that is to be evaluated\n//\n//go:generate moq -rm -fmt=goimports -stub -out constraint_mock.go . Constraint\ntype Constraint interface {\n\tString() string\n\tAssert() error\n}\n"
},
{
"path": "internal/requirements/constraints/constraints_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n"
},
{
"path": "internal/requirements/constraints/factory.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype factory struct {\n\tlogger logger.Interface\n\tproperties map[string]Property\n}\n\n// New creates a new constraint for the supplied requirements and properties\nfunc New(logger logger.Interface, requirements []string, properties map[string]Property) (Constraint, error) {\n\tif len(requirements) == 0 {\n\t\treturn &always{}, nil\n\t}\n\n\tf := factory{\n\t\tlogger: logger,\n\t\tproperties: properties,\n\t}\n\n\tvar constraints []Constraint\n\tfor _, r := range requirements {\n\t\tc, err := f.newConstraintFromRequirement(r)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif c == nil {\n\t\t\tcontinue\n\t\t}\n\t\tconstraints = append(constraints, c)\n\t}\n\n\treturn AND(constraints), nil\n}\n\n// newConstraintFromRequirement takes a requirement string and generates\n// the associated constraint(s). Invalid constraints are ignored.\n// Each requirement can consist of multiple constraints, with space-separated constraints being ORed\n// together and comma-separated constraints being ANDed together.\nfunc (r factory) newConstraintFromRequirement(requirement string) (Constraint, error) {\n\tconst (\n\t\torSeparator = \" \"\n\t\tandSeparator = \",\"\n\t)\n\tif strings.TrimSpace(requirement) == \"\" {\n\t\treturn nil, nil\n\t}\n\n\tvar terms []Constraint\n\tfor _, term := range strings.Split(requirement, orSeparator) {\n\t\tvar factors []Constraint\n\t\tfor _, factor := range strings.Split(term, andSeparator) {\n\t\t\tf, err := r.parse(factor)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tif f == nil {\n\t\t\t\tr.logger.Debugf(\"Skipping unsupported constraint: %v\", factor)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tfactors = append(factors, f)\n\t\t}\n\n\t\tif len(factors) == 0 {\n\t\t\tcontinue\n\t\t}\n\n\t\tif len(factors) == 1 {\n\t\t\tterms = append(terms, factors[0])\n\t\t} else {\n\t\t\tterms = append(terms, and(factors))\n\t\t}\n\t}\n\n\treturn OR(terms), nil\n}\n\n// parse constructs a constraint from the specified string.\n// The string is expected to be of the form [PROPERTY][OPERATOR][VALUE]\nfunc (r factory) parse(condition string) (Constraint, error) {\n\tif strings.TrimSpace(condition) == \"\" {\n\t\treturn nil, nil\n\t}\n\n\toperators := []string{\n\t\tnotEqual,\n\t\tlessEqual,\n\t\tgreaterEqual,\n\t\tequal,\n\t\tless,\n\t\tgreater,\n\t}\n\n\tpropertyEnd := strings.IndexAny(condition, \"<>=!\")\n\tif propertyEnd == -1 {\n\t\treturn nil, fmt.Errorf(\"invalid constraint: %v\", condition)\n\t}\n\n\tproperty := condition[:propertyEnd]\n\tcondition = strings.TrimPrefix(condition, property)\n\n\tp, ok := r.properties[property]\n\tif !ok || p == nil {\n\t\treturn nil, nil\n\t}\n\n\tvar op string\n\tfor _, o := range operators {\n\t\tif strings.HasPrefix(condition, o) {\n\t\t\top = o\n\t\t\tbreak\n\t\t}\n\t}\n\tvalue := strings.TrimPrefix(condition, op)\n\n\tc := binary{\n\t\tleft: p,\n\t\tright: value,\n\t\toperator: op,\n\t}\n\treturn c, p.Validate(value)\n}\n"
},
{
"path": "internal/requirements/constraints/factory_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n\nimport (\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestParse(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tcuda := NewVersionProperty(\"cuda\", \"\")\n\n\tf := factory{\n\t\tlogger: logger,\n\t\tproperties: map[string]Property{\n\t\t\t\"cuda\": cuda,\n\t\t},\n\t}\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcondition string\n\t\texpectedError bool\n\t\texpected Constraint\n\t}{\n\t\t{\n\t\t\tdescription: \"empty is nil\",\n\t\t\tcondition: \"\",\n\t\t\texpected: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"missing operator is invalid\",\n\t\t\tcondition: \"notvalid\",\n\t\t\texpectedError: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"invalid property is invalid\",\n\t\t\tcondition: \"foo=45\",\n\t\t\texpected: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"cuda must be semver\",\n\t\t\tcondition: \"cuda=foo\",\n\t\t\texpectedError: true,\n\t\t\texpected: binary{cuda, equal, \"foo\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cuda greater than equal\",\n\t\t\tcondition: \"cuda>=11.6\",\n\t\t\texpected: binary{cuda, greaterEqual, \"11.6\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cuda greater than\",\n\t\t\tcondition: \"cuda>11.6\",\n\t\t\texpected: binary{cuda, greater, \"11.6\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cuda less than equal\",\n\t\t\tcondition: \"cuda<=11.6\",\n\t\t\texpected: binary{cuda, lessEqual, \"11.6\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cuda less than\",\n\t\t\tcondition: \"cuda<11.6\",\n\t\t\texpected: binary{cuda, less, \"11.6\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cuda equal\",\n\t\t\tcondition: \"cuda=11.6\",\n\t\t\texpected: binary{cuda, equal, \"11.6\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cuda not equal\",\n\t\t\tcondition: \"cuda!=11.6\",\n\t\t\texpected: binary{cuda, notEqual, \"11.6\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tc, err := f.parse(tc.condition)\n\t\t\tif tc.expectedError {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\t\t\trequire.EqualValues(t, tc.expected, c)\n\t\t})\n\t}\n}\n\nfunc TestNewConstraintFromRequirement(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tcuda := &PropertyMock{}\n\tarch := &PropertyMock{}\n\n\tf := factory{\n\t\tlogger: logger,\n\t\tproperties: map[string]Property{\n\t\t\t\"cuda\": cuda,\n\t\t\t\"arch\": arch,\n\t\t},\n\t}\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\trequirement string\n\t\texpectedError bool\n\t\texpected Constraint\n\t}{\n\t\t{\n\t\t\tdescription: \"empty is nil\",\n\t\t\trequirement: \"\",\n\t\t\texpected: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"malformed constraint is invalid\",\n\t\t\trequirement: \"notvalid\",\n\t\t\texpectedError: true,\n\t\t\texpected: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"unsupported property is ignored\",\n\t\t\trequirement: \"cuda>=11.6 foo=bar\",\n\t\t\texpected: binary{cuda, greaterEqual, \"11.6\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"space-separated is and\",\n\t\t\trequirement: \"cuda>=11.6 arch=5.3\",\n\t\t\texpected: and([]Constraint{\n\t\t\t\tbinary{cuda, greaterEqual, \"11.6\"},\n\t\t\t\tbinary{arch, equal, \"5.3\"},\n\t\t\t}),\n\t\t},\n\t\t{\n\t\t\tdescription: \"comma-separated is or\",\n\t\t\trequirement: \"cuda>=11.6,arch=5.3\",\n\t\t\texpected: or([]Constraint{\n\t\t\t\tbinary{cuda, greaterEqual, \"11.6\"},\n\t\t\t\tbinary{arch, equal, \"5.3\"},\n\t\t\t}),\n\t\t},\n\t\t{\n\t\t\tdescription: \"and takes precedence\",\n\t\t\trequirement: \"cuda<13.6 cuda>=11.6,arch=5.3\",\n\t\t\texpected: or([]Constraint{\n\t\t\t\tbinary{cuda, less, \"13.6\"},\n\t\t\t\tand([]Constraint{\n\t\t\t\t\tbinary{cuda, greaterEqual, \"11.6\"},\n\t\t\t\t\tbinary{arch, equal, \"5.3\"},\n\t\t\t\t}),\n\t\t\t}),\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tc, err := f.newConstraintFromRequirement(tc.requirement)\n\t\t\tif tc.expectedError {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\t\t\trequire.EqualValues(t, tc.expected, c)\n\t\t})\n\t}\n\n}\n"
},
{
"path": "internal/requirements/constraints/logical.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n)\n\n// or represents an OR operation on a set of constraints\ntype or []Constraint\n\n// and represents an AND (ALL) operation on a set of contraints\ntype and []Constraint\n\n// AND constructs a new constraint that is the logical AND of the supplied constraints\nfunc AND(constraints []Constraint) Constraint {\n\tif len(constraints) == 0 {\n\t\treturn &always{}\n\t}\n\tif len(constraints) == 1 {\n\t\treturn constraints[0]\n\t}\n\treturn and(constraints)\n}\n\n// OR constructs a new constrant that is the logical OR of the supplied constraints\nfunc OR(constraints []Constraint) Constraint {\n\tif len(constraints) == 0 {\n\t\treturn nil\n\t}\n\tif len(constraints) == 1 {\n\t\treturn constraints[0]\n\t}\n\n\treturn or(constraints)\n}\n\nfunc (operands or) Assert() error {\n\tfor _, o := range operands {\n\t\t// We stop on the first nil\n\t\tif err := o.Assert(); err == nil {\n\t\t\treturn nil\n\t\t}\n\t}\n\treturn fmt.Errorf(\"%v not met\", operands)\n}\n\nfunc (operands or) String() string {\n\tvar terms []string\n\n\tfor _, o := range operands {\n\t\tterms = append(terms, o.String())\n\t}\n\n\treturn strings.Join(terms, \"||\")\n}\n\nfunc (operands and) Assert() error {\n\tfor _, o := range operands {\n\t\t// We stop on the first Assert\n\t\tif err := o.Assert(); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc (operands and) String() string {\n\tvar terms []string\n\n\tfor _, o := range operands {\n\t\tterms = append(terms, o.String())\n\t}\n\n\treturn strings.Join(terms, \"&&\")\n}\n"
},
{
"path": "internal/requirements/constraints/logical_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestANDConstraint(t *testing.T) {\n\n\tnever := ConstraintMock{AssertFunc: func() error { return fmt.Errorf(\"false\") }}\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconstraints []Constraint\n\t\texpected bool\n\t}{\n\t\t{\n\t\t\tdescription: \"empty is always true\",\n\t\t\tconstraints: []Constraint{},\n\t\t\texpected: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"single true constraint is true\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&always{},\n\t\t\t},\n\t\t\texpected: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"single false constraint is false\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&never,\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple true constraints are true\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&always{}, &always{},\n\t\t\t},\n\t\t\texpected: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"mixed constraints are false (first is true)\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&always{}, &never,\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"mixed constraints are false (last is true)\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&never, &always{},\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\terr := and(tc.constraints).Assert()\n\t\t\tif tc.expected {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t} else {\n\t\t\t\trequire.Error(t, err)\n\t\t\t}\n\t\t})\n\t}\n\n}\n\nfunc TestORConstraint(t *testing.T) {\n\n\tnever := ConstraintMock{AssertFunc: func() error { return fmt.Errorf(\"false\") }}\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconstraints []Constraint\n\t\texpected bool\n\t}{\n\t\t{\n\t\t\tdescription: \"empty is always false\",\n\t\t\tconstraints: []Constraint{},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"single true constraint is true\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&always{},\n\t\t\t},\n\t\t\texpected: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"single false constraint is false\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&never,\n\t\t\t},\n\t\t\texpected: false,\n\t\t},\n\t\t{\n\t\t\tdescription: \"multiple true constraints are true\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&always{}, &always{},\n\t\t\t},\n\t\t\texpected: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"mixed constraints are true (first is true)\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&always{}, &never,\n\t\t\t},\n\t\t\texpected: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"mixed constraints are true (last is true)\",\n\t\t\tconstraints: []Constraint{\n\t\t\t\t&never, &always{},\n\t\t\t},\n\t\t\texpected: true,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\terr := or(tc.constraints).Assert()\n\t\t\tif tc.expected {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t} else {\n\t\t\t\trequire.Error(t, err)\n\t\t\t}\n\t\t})\n\t}\n\n}\n"
},
{
"path": "internal/requirements/constraints/property.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage constraints\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"golang.org/x/mod/semver\"\n)\n\n// Property represents a property that is used to check requirements\n//\n//go:generate moq -rm -fmt=goimports -stub -out property_mock.go . Property\ntype Property interface {\n\tName() string\n\tValue() (string, error)\n\tString() string\n\tCompareTo(string) (int, error)\n\tValidate(string) error\n}\n\n// NewStringProperty creates a string property based on the name-value pair\nfunc NewStringProperty(name string, value string) Property {\n\tp := stringProperty{\n\t\tname: name,\n\t\tvalue: value,\n\t}\n\n\treturn p\n}\n\n// NewVersionProperty creates a property representing a semantic version based on the name-value pair\nfunc NewVersionProperty(name string, value string) Property {\n\tp := versionProperty{\n\t\tstringProperty: stringProperty{\n\t\t\tname: name,\n\t\t\tvalue: value,\n\t\t},\n\t}\n\n\treturn p\n}\n\n// stringProperty represents a property that is used to check requirements\ntype stringProperty struct {\n\tname string\n\tvalue string\n}\n\ntype versionProperty struct {\n\tstringProperty\n}\n\n// Name returns a stringProperty's name\nfunc (p stringProperty) Name() string {\n\treturn p.name\n}\n\n// Value returns a stringProperty's value or an error if this cannot be determined\nfunc (p stringProperty) Value() (string, error) {\n\treturn p.value, nil\n}\n\n// CompareTo compares two strings to each other\nfunc (p stringProperty) CompareTo(other string) (int, error) {\n\tvalue := p.value\n\n\tif value < other {\n\t\treturn -1, nil\n\t}\n\n\tif value > other {\n\t\treturn 1, nil\n\t}\n\n\treturn 0, nil\n}\n\n// Validate returns nil for all input strings\nfunc (p stringProperty) Validate(string) error {\n\treturn nil\n}\n\n// String returns the string representation of the name value combination\nfunc (p stringProperty) String() string {\n\tv, err := p.Value()\n\tif err != nil {\n\t\treturn fmt.Sprintf(\"invalid %v: %v\", p.name, err)\n\t}\n\treturn fmt.Sprintf(\"%v=%v\", p.name, v)\n}\n\n// CompareTo compares two versions to each other as semantic versions\nfunc (p versionProperty) CompareTo(other string) (int, error) {\n\tif err := p.Validate(other); err != nil {\n\t\treturn 0, fmt.Errorf(\"invailid value for %v: %v\", p.name, err)\n\t}\n\n\tvValue := ensurePrefix(p.value, \"v\")\n\tvOther := ensurePrefix(other, \"v\")\n\treturn semver.Compare(vValue, vOther), nil\n}\n\n// Validate checks whether the supplied value is a valid semantic version\nfunc (p versionProperty) Validate(value string) error {\n\tif !semver.IsValid(ensurePrefix(value, \"v\")) {\n\t\treturn fmt.Errorf(\"invailid value %v; expected a valid version string\", value)\n\t}\n\n\treturn nil\n}\n\nfunc ensurePrefix(s string, prefix string) string {\n\treturn prefix + strings.TrimPrefix(s, prefix)\n}\n"
},
{
"path": "internal/requirements/constraints/property_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage constraints\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that PropertyMock does implement Property.\n// If this is not the case, regenerate this file with moq.\nvar _ Property = &PropertyMock{}\n\n// PropertyMock is a mock implementation of Property.\n//\n//\tfunc TestSomethingThatUsesProperty(t *testing.T) {\n//\n//\t\t// make and configure a mocked Property\n//\t\tmockedProperty := &PropertyMock{\n//\t\t\tCompareToFunc: func(s string) (int, error) {\n//\t\t\t\tpanic(\"mock out the CompareTo method\")\n//\t\t\t},\n//\t\t\tNameFunc: func() string {\n//\t\t\t\tpanic(\"mock out the Name method\")\n//\t\t\t},\n//\t\t\tStringFunc: func() string {\n//\t\t\t\tpanic(\"mock out the String method\")\n//\t\t\t},\n//\t\t\tValidateFunc: func(s string) error {\n//\t\t\t\tpanic(\"mock out the Validate method\")\n//\t\t\t},\n//\t\t\tValueFunc: func() (string, error) {\n//\t\t\t\tpanic(\"mock out the Value method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedProperty in code that requires Property\n//\t\t// and then make assertions.\n//\n//\t}\ntype PropertyMock struct {\n\t// CompareToFunc mocks the CompareTo method.\n\tCompareToFunc func(s string) (int, error)\n\n\t// NameFunc mocks the Name method.\n\tNameFunc func() string\n\n\t// StringFunc mocks the String method.\n\tStringFunc func() string\n\n\t// ValidateFunc mocks the Validate method.\n\tValidateFunc func(s string) error\n\n\t// ValueFunc mocks the Value method.\n\tValueFunc func() (string, error)\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// CompareTo holds details about calls to the CompareTo method.\n\t\tCompareTo []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// Name holds details about calls to the Name method.\n\t\tName []struct {\n\t\t}\n\t\t// String holds details about calls to the String method.\n\t\tString []struct {\n\t\t}\n\t\t// Validate holds details about calls to the Validate method.\n\t\tValidate []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t\t// Value holds details about calls to the Value method.\n\t\tValue []struct {\n\t\t}\n\t}\n\tlockCompareTo sync.RWMutex\n\tlockName sync.RWMutex\n\tlockString sync.RWMutex\n\tlockValidate sync.RWMutex\n\tlockValue sync.RWMutex\n}\n\n// CompareTo calls CompareToFunc.\nfunc (mock *PropertyMock) CompareTo(s string) (int, error) {\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockCompareTo.Lock()\n\tmock.calls.CompareTo = append(mock.calls.CompareTo, callInfo)\n\tmock.lockCompareTo.Unlock()\n\tif mock.CompareToFunc == nil {\n\t\tvar (\n\t\t\tnOut int\n\t\t\terrOut error\n\t\t)\n\t\treturn nOut, errOut\n\t}\n\treturn mock.CompareToFunc(s)\n}\n\n// CompareToCalls gets all the calls that were made to CompareTo.\n// Check the length with:\n//\n//\tlen(mockedProperty.CompareToCalls())\nfunc (mock *PropertyMock) CompareToCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockCompareTo.RLock()\n\tcalls = mock.calls.CompareTo\n\tmock.lockCompareTo.RUnlock()\n\treturn calls\n}\n\n// Name calls NameFunc.\nfunc (mock *PropertyMock) Name() string {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockName.Lock()\n\tmock.calls.Name = append(mock.calls.Name, callInfo)\n\tmock.lockName.Unlock()\n\tif mock.NameFunc == nil {\n\t\tvar (\n\t\t\tsOut string\n\t\t)\n\t\treturn sOut\n\t}\n\treturn mock.NameFunc()\n}\n\n// NameCalls gets all the calls that were made to Name.\n// Check the length with:\n//\n//\tlen(mockedProperty.NameCalls())\nfunc (mock *PropertyMock) NameCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockName.RLock()\n\tcalls = mock.calls.Name\n\tmock.lockName.RUnlock()\n\treturn calls\n}\n\n// String calls StringFunc.\nfunc (mock *PropertyMock) String() string {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockString.Lock()\n\tmock.calls.String = append(mock.calls.String, callInfo)\n\tmock.lockString.Unlock()\n\tif mock.StringFunc == nil {\n\t\tvar (\n\t\t\tsOut string\n\t\t)\n\t\treturn sOut\n\t}\n\treturn mock.StringFunc()\n}\n\n// StringCalls gets all the calls that were made to String.\n// Check the length with:\n//\n//\tlen(mockedProperty.StringCalls())\nfunc (mock *PropertyMock) StringCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockString.RLock()\n\tcalls = mock.calls.String\n\tmock.lockString.RUnlock()\n\treturn calls\n}\n\n// Validate calls ValidateFunc.\nfunc (mock *PropertyMock) Validate(s string) error {\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockValidate.Lock()\n\tmock.calls.Validate = append(mock.calls.Validate, callInfo)\n\tmock.lockValidate.Unlock()\n\tif mock.ValidateFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.ValidateFunc(s)\n}\n\n// ValidateCalls gets all the calls that were made to Validate.\n// Check the length with:\n//\n//\tlen(mockedProperty.ValidateCalls())\nfunc (mock *PropertyMock) ValidateCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockValidate.RLock()\n\tcalls = mock.calls.Validate\n\tmock.lockValidate.RUnlock()\n\treturn calls\n}\n\n// Value calls ValueFunc.\nfunc (mock *PropertyMock) Value() (string, error) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockValue.Lock()\n\tmock.calls.Value = append(mock.calls.Value, callInfo)\n\tmock.lockValue.Unlock()\n\tif mock.ValueFunc == nil {\n\t\tvar (\n\t\t\tsOut string\n\t\t\terrOut error\n\t\t)\n\t\treturn sOut, errOut\n\t}\n\treturn mock.ValueFunc()\n}\n\n// ValueCalls gets all the calls that were made to Value.\n// Check the length with:\n//\n//\tlen(mockedProperty.ValueCalls())\nfunc (mock *PropertyMock) ValueCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockValue.RLock()\n\tcalls = mock.calls.Value\n\tmock.lockValue.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "internal/requirements/requirements.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage requirements\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/requirements/constraints\"\n)\n\n// Requirements represents a collection of requirements that can be compared to properties\ntype Requirements struct {\n\tlogger logger.Interface\n\trequirements []string\n\tproperties map[string]constraints.Property\n}\n\n// New creates a new set of requirements\nfunc New(logger logger.Interface, requirements []string) *Requirements {\n\tr := Requirements{\n\t\tlogger: logger,\n\t\trequirements: requirements,\n\t\tproperties: map[string]constraints.Property{\n\t\t\t// Set up the supported properties. These are overridden with actual values.\n\t\t\tCUDA: constraints.NewVersionProperty(CUDA, \"\"),\n\t\t\tARCH: constraints.NewVersionProperty(ARCH, \"\"),\n\t\t\tDRIVER: constraints.NewVersionProperty(DRIVER, \"\"),\n\t\t\tBRAND: constraints.NewStringProperty(BRAND, \"\"),\n\t\t},\n\t}\n\n\treturn &r\n}\n\n// AddVersionProperty adds the specified property (name, value pair) to the requirements\nfunc (r *Requirements) AddVersionProperty(name string, value string) {\n\tr.properties[name] = constraints.NewVersionProperty(name, value)\n}\n\n// AddStringProperty adds the specified property (name, value pair) to the requirements\nfunc (r *Requirements) AddStringProperty(name string, value string) {\n\tr.properties[name] = constraints.NewStringProperty(name, value)\n}\n\n// Assert checks the specified requirements\nfunc (r Requirements) Assert() error {\n\tif len(r.requirements) == 0 {\n\t\treturn nil\n\t}\n\n\tr.logger.Debugf(\"Checking properties %+v against requirements %v\", r.properties, r.requirements)\n\tc, err := constraints.New(r.logger, r.requirements, r.properties)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn c.Assert()\n}\n"
},
{
"path": "internal/runtime/api.go",
"content": "package runtime\n\ntype rt struct {\n\tlogger *Logger\n\tmodeOverride string\n}\n\n// Interface is the interface for the runtime library.\ntype Interface interface {\n\tRun([]string) error\n}\n\n// Option is a function that configures the runtime.\ntype Option func(*rt)\n\n// New creates a runtime with the specified options.\nfunc New(opts ...Option) Interface {\n\tr := rt{}\n\tfor _, opt := range opts {\n\t\topt(&r)\n\t}\n\tif r.logger == nil {\n\t\tr.logger = NewLogger()\n\t}\n\treturn &r\n}\n\n// WithModeOverride allows for overriding the mode specified in the config.\nfunc WithModeOverride(mode string) Option {\n\treturn func(r *rt) {\n\t\tr.modeOverride = mode\n\t}\n}\n"
},
{
"path": "internal/runtime/logger.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage runtime\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"github.com/sirupsen/logrus\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// Logger adds a way to manage output to a log file to a logrus.Logger\ntype Logger struct {\n\tlogger.Interface\n\tpreviousLogger logger.Interface\n\tlogFiles []*os.File\n}\n\n// NewLogger creates an empty logger\nfunc NewLogger() *Logger {\n\treturn &Logger{\n\t\tInterface: logrus.New(),\n\t}\n}\n\n// Update constructs a Logger with a preddefined formatter\nfunc (l *Logger) Update(filename string, logLevel string, argv []string) {\n\n\tconfigFromArgs := parseArgs(argv)\n\n\tlevel, logLevelError := configFromArgs.getLevel(logLevel)\n\tdefer func() {\n\t\tif logLevelError != nil {\n\t\t\tl.Warningf(\"Error getting log level: %v\", logLevelError)\n\t\t}\n\t}()\n\n\tvar logFiles []*os.File\n\tvar argLogFileError error\n\n\t// We don't create log files if the version argument is supplied\n\tif !configFromArgs.version {\n\t\tconfigLogFile, err := createLogFile(filename)\n\t\tif err != nil {\n\t\t\targLogFileError = errors.Join(argLogFileError, err)\n\t\t}\n\t\tif configLogFile != nil {\n\t\t\tlogFiles = append(logFiles, configLogFile)\n\t\t}\n\n\t\targLogFile, err := createLogFile(configFromArgs.file)\n\t\tif argLogFile != nil {\n\t\t\tlogFiles = append(logFiles, argLogFile)\n\t\t}\n\t\targLogFileError = errors.Join(argLogFileError, err)\n\t}\n\tdefer func() {\n\t\tif argLogFileError != nil {\n\t\t\tl.Warningf(\"Failed to open log file: %v\", argLogFileError)\n\t\t}\n\t}()\n\n\tnewLogger := logrus.New()\n\n\tnewLogger.SetLevel(level)\n\tif level == logrus.DebugLevel {\n\t\tlogrus.SetReportCaller(true)\n\t\t// Shorten function and file names reported by the logger, by\n\t\t// trimming common \"github.com/opencontainers/runc\" prefix.\n\t\t// This is only done for text formatter.\n\t\t_, file, _, _ := runtime.Caller(0)\n\t\tprefix := filepath.Dir(file) + \"/\"\n\t\tlogrus.SetFormatter(&logrus.TextFormatter{\n\t\t\tCallerPrettyfier: func(f *runtime.Frame) (string, string) {\n\t\t\t\tfunction := strings.TrimPrefix(f.Function, prefix) + \"()\"\n\t\t\t\tfileLine := strings.TrimPrefix(f.File, prefix) + \":\" + strconv.Itoa(f.Line)\n\t\t\t\treturn function, fileLine\n\t\t\t},\n\t\t})\n\t}\n\n\tif configFromArgs.format == \"json\" {\n\t\tnewLogger.SetFormatter(new(logrus.JSONFormatter))\n\t}\n\n\tswitch len(logFiles) {\n\tcase 0:\n\t\tnewLogger.SetOutput(io.Discard)\n\tcase 1:\n\t\tnewLogger.SetOutput(logFiles[0])\n\tdefault:\n\t\tvar writers []io.Writer\n\t\tfor _, f := range logFiles {\n\t\t\twriters = append(writers, f)\n\t\t}\n\t\tnewLogger.SetOutput(io.MultiWriter(writers...))\n\t}\n\n\t*l = Logger{\n\t\tInterface: newLogger,\n\t\tpreviousLogger: l.Interface,\n\t\tlogFiles: logFiles,\n\t}\n}\n\n// Reset closes the log file (if any) and resets the logger output to what it\n// was before UpdateLogger was called.\nfunc (l *Logger) Reset() error {\n\tdefer func() {\n\t\tprevious := l.previousLogger\n\t\tif previous == nil {\n\t\t\tprevious = logrus.New()\n\t\t}\n\t\tl.Interface = previous\n\t\tl.previousLogger = nil\n\t\tl.logFiles = nil\n\t}()\n\n\tvar errs []error\n\tfor _, f := range l.logFiles {\n\t\terr := f.Close()\n\t\tif err != nil {\n\t\t\terrs = append(errs, err)\n\t\t}\n\t}\n\n\tvar err error\n\tfor _, e := range errs {\n\t\tif err == nil {\n\t\t\terr = e\n\t\t\tcontinue\n\t\t}\n\t\treturn fmt.Errorf(\"%v; %w\", e, err)\n\t}\n\n\treturn err\n}\n\nfunc createLogFile(filename string) (*os.File, error) {\n\tif filename == \"\" || filename == os.DevNull {\n\t\treturn nil, nil\n\t}\n\tif dir := filepath.Dir(filepath.Clean(filename)); dir != \".\" {\n\t\terr := os.MkdirAll(dir, 0755)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\treturn os.OpenFile(filename, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)\n}\n\ntype loggerConfig struct {\n\tfile string\n\tformat string\n\tdebug bool\n\tversion bool\n}\n\nfunc (c loggerConfig) getLevel(logLevel string) (logrus.Level, error) {\n\tif c.debug {\n\t\treturn logrus.DebugLevel, nil\n\t}\n\n\tif logLevel, err := logrus.ParseLevel(logLevel); err == nil {\n\t\treturn logLevel, nil\n\t}\n\n\treturn logrus.InfoLevel, fmt.Errorf(\"invalid log-level '%v'\", logLevel)\n}\n\n// Informed by Taken from https://github.com/opencontainers/runc/blob/7fd8b57001f5bfa102e89cb434d96bf71f7c1d35/main.go#L182\nfunc parseArgs(args []string) loggerConfig {\n\tc := loggerConfig{}\n\n\texpected := map[string]*string{\n\t\t\"log-format\": &c.format,\n\t\t\"log\": &c.file,\n\t}\n\n\tfound := make(map[string]bool)\n\n\tfor i := 0; i < len(args); i++ {\n\t\tif len(found) == 4 {\n\t\t\tbreak\n\t\t}\n\n\t\tparam := args[i]\n\n\t\tparts := strings.SplitN(param, \"=\", 2)\n\t\ttrimmed := strings.TrimLeft(parts[0], \"-\")\n\t\t// If this is not a flag we continue\n\t\tif parts[0] == trimmed {\n\t\t\tcontinue\n\t\t}\n\n\t\t// Check the version flag\n\t\tif trimmed == \"version\" {\n\t\t\tc.version = true\n\t\t\tfound[\"version\"] = true\n\t\t\t// For the version flag we don't process any other flags\n\t\t\tcontinue\n\t\t}\n\n\t\t// Check the debug flag\n\t\tif trimmed == \"debug\" {\n\t\t\tc.debug = true\n\t\t\tfound[\"debug\"] = true\n\t\t\tcontinue\n\t\t}\n\n\t\tdestination, exists := expected[trimmed]\n\t\tif !exists {\n\t\t\tcontinue\n\t\t}\n\n\t\tvar value string\n\t\tswitch {\n\t\tcase len(parts) == 2:\n\t\t\tvalue = parts[1]\n\t\tcase i+1 < len(args):\n\t\t\tvalue = args[i+1]\n\t\t\ti++\n\t\tdefault:\n\t\t\tcontinue\n\t\t}\n\n\t\t*destination = value\n\t\tfound[trimmed] = true\n\t}\n\n\treturn c\n}\n"
},
{
"path": "internal/runtime/logger_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage runtime\n\nimport (\n\t\"testing\"\n\n\t\"github.com/sirupsen/logrus\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLogger(t *testing.T) {\n\tl := NewLogger()\n\n\tl.Update(\"\", \"debug\", nil)\n\n\tll := l.Interface.(*logrus.Logger)\n\trequire.Equal(t, logrus.DebugLevel, ll.Level)\n\n\tlp := l.previousLogger.(*logrus.Logger)\n\trequire.Equal(t, logrus.InfoLevel, lp.Level)\n}\n"
},
{
"path": "internal/runtime/runtime.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage runtime\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n)\n\n// Run is an entry point that allows for idiomatic handling of errors\n// when calling from the main function.\nfunc (r rt) Run(argv []string) (rerr error) {\n\tdefer func() {\n\t\tif rerr != nil {\n\t\t\tr.logger.Errorf(\"%v\", rerr)\n\t\t}\n\t}()\n\n\tprintVersion := hasVersionFlag(argv)\n\tif printVersion {\n\t\tfmt.Printf(\"%v version %v\\n\", \"NVIDIA Container Runtime\", info.GetVersionString(fmt.Sprintf(\"spec: %v\", specs.Version)))\n\t}\n\n\tcfg, err := config.GetConfig()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error loading config: %v\", err)\n\t}\n\tr.logger.Update(\n\t\tcfg.NVIDIAContainerRuntimeConfig.DebugFilePath,\n\t\tcfg.NVIDIAContainerRuntimeConfig.LogLevel,\n\t\targv,\n\t)\n\tdefer func() {\n\t\tif rerr != nil {\n\t\t\tr.logger.Errorf(\"%v\", rerr)\n\t\t}\n\t\tif err := r.logger.Reset(); err != nil {\n\t\t\trerr = errors.Join(rerr, fmt.Errorf(\"failed to reset logger: %v\", err))\n\t\t}\n\t}()\n\n\t// We apply some config updates here to ensure that the config is valid in\n\t// all cases.\n\tif r.modeOverride != \"\" {\n\t\tcfg.NVIDIAContainerRuntimeConfig.Mode = r.modeOverride\n\t}\n\t//nolint:staticcheck // TODO(elezar): We should swith the nvidia-container-runtime from using nvidia-ctk to using nvidia-cdi-hook.\n\tcfg.NVIDIACTKConfig.Path = config.ResolveNVIDIACTKPath(&logger.NullLogger{}, cfg.NVIDIACTKConfig.Path)\n\tcfg.NVIDIAContainerRuntimeHookConfig.Path = config.ResolveNVIDIAContainerRuntimeHookPath(&logger.NullLogger{}, cfg.NVIDIAContainerRuntimeHookConfig.Path)\n\n\t// Log the config at Trace to allow for debugging if required.\n\tr.logger.Tracef(\"Running with config: %+v\", cfg)\n\n\tdriver := root.New(\n\t\troot.WithLogger(r.logger),\n\t\troot.WithDriverRoot(cfg.NVIDIAContainerCLIConfig.Root),\n\t\troot.WithDevRoot(cfg.NVIDIAContainerCLIConfig.Root),\n\t)\n\n\tr.logger.Tracef(\"Command line arguments: %v\", argv)\n\truntime, err := newNVIDIAContainerRuntime(r.logger, driver, cfg, argv)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to create NVIDIA Container Runtime: %v\", err)\n\t}\n\n\tif printVersion {\n\t\tfmt.Print(\"\\n\")\n\t}\n\treturn runtime.Exec(argv)\n}\n\nfunc (r rt) Errorf(format string, args ...interface{}) {\n\tr.logger.Errorf(format, args...)\n}\n\n// TODO: This should be refactored / combined with parseArgs in logger.\nfunc hasVersionFlag(args []string) bool {\n\tfor i := 0; i < len(args); i++ {\n\t\tparam := args[i]\n\n\t\tparts := strings.SplitN(param, \"=\", 2)\n\t\ttrimmed := strings.TrimLeft(parts[0], \"-\")\n\t\t// If this is not a flag we continue\n\t\tif parts[0] == trimmed {\n\t\t\tcontinue\n\t\t}\n\n\t\t// Check the version flag\n\t\tif trimmed == \"version\" {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n"
},
{
"path": "internal/runtime/runtime_factory.go",
"content": "/*\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage runtime\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/modifier\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n)\n\n// newNVIDIAContainerRuntime is a factory method that constructs a runtime based on the selected configuration and specified logger\nfunc newNVIDIAContainerRuntime(logger logger.Interface, driver *root.Driver, cfg *config.Config, argv []string) (oci.Runtime, error) {\n\tlowLevelRuntime, err := oci.NewLowLevelRuntime(logger, cfg.NVIDIAContainerRuntimeConfig.Runtimes)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error constructing low-level runtime: %v\", err)\n\t}\n\n\tlogger.Tracef(\"Using low-level runtime %v\", lowLevelRuntime.String())\n\tif !oci.HasCreateSubcommand(argv) {\n\t\tlogger.Tracef(\"Skipping modifier for non-create subcommand\")\n\t\treturn lowLevelRuntime, nil\n\t}\n\n\tociSpec, err := oci.NewSpec(argv,\n\t\toci.WithLogger(logger),\n\t\toci.WithAllowUnknownFields(cfg.Features.AllowUnknownOCISpecFields.IsEnabled()),\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error constructing OCI specification: %v\", err)\n\t}\n\n\tspecModifier, err := newSpecModifier(logger, driver, cfg, ociSpec)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to construct OCI spec modifier: %v\", err)\n\t}\n\n\t// Create the wrapping runtime with the specified modifier.\n\tr := oci.NewModifyingRuntimeWrapper(\n\t\tlogger,\n\t\tlowLevelRuntime,\n\t\tociSpec,\n\t\tspecModifier,\n\t)\n\n\treturn r, nil\n}\n\n// newSpecModifier is a factory method that creates constructs an OCI spec modifer based on the provided config.\nfunc newSpecModifier(logger logger.Interface, driver *root.Driver, cfg *config.Config, ociSpec oci.Spec) (oci.SpecModifier, error) {\n\tmode, image, err := initRuntimeModeAndImage(logger, cfg, ociSpec)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\thookCreator := discover.NewHookCreator(discover.WithNVIDIACDIHookPath(cfg.NVIDIACTKConfig.Path))\n\treturn modifier.New(\n\t\tmodifier.WithLogger(logger),\n\t\tmodifier.WithConfig(cfg),\n\t\tmodifier.WithImage(image),\n\t\tmodifier.WithDriver(driver),\n\t\tmodifier.WithHookCreator(hookCreator),\n\t\tmodifier.WithRuntimeMode(mode),\n\t)\n}\n\n// initRuntimeModeAndImage constructs an image from the specified OCI runtime\n// specification and runtime config.\n// The image is also used to determine the runtime mode to apply.\n// If a non-CDI mode is detected we ensure that the image does not process\n// annotation devices.\nfunc initRuntimeModeAndImage(logger logger.Interface, cfg *config.Config, ociSpec oci.Spec) (info.RuntimeMode, *image.CUDA, error) {\n\trawSpec, err := ociSpec.Load()\n\tif err != nil {\n\t\treturn \"\", nil, fmt.Errorf(\"failed to load OCI spec: %v\", err)\n\t}\n\n\timage, err := image.NewCUDAImageFromSpec(\n\t\trawSpec,\n\t\timage.WithLogger(logger),\n\t\timage.WithAcceptDeviceListAsVolumeMounts(cfg.AcceptDeviceListAsVolumeMounts),\n\t\timage.WithAcceptEnvvarUnprivileged(cfg.AcceptEnvvarUnprivileged),\n\t\timage.WithAnnotationsPrefixes(cfg.NVIDIAContainerRuntimeConfig.Modes.CDI.AnnotationPrefixes...),\n\t\timage.WithPreferredVisibleDevicesEnvVars(cfg.SwarmResource),\n\t\timage.WithIgnoreImexChannelRequests(cfg.Features.IgnoreImexChannelRequests.IsEnabled()),\n\t)\n\tif err != nil {\n\t\treturn \"\", nil, err\n\t}\n\n\tmodeResolver := info.NewRuntimeModeResolver(\n\t\tinfo.WithLogger(logger),\n\t\tinfo.WithImage(&image),\n\t)\n\tmode := modeResolver.ResolveRuntimeMode(cfg.NVIDIAContainerRuntimeConfig.Mode)\n\t// We update the mode here so that we can continue passing just the config to other functions.\n\tcfg.NVIDIAContainerRuntimeConfig.Mode = string(mode)\n\n\tif mode == \"cdi\" || len(cfg.NVIDIAContainerRuntimeConfig.Modes.CDI.AnnotationPrefixes) == 0 {\n\t\treturn mode, &image, nil\n\t}\n\n\t// For non-cdi modes we explicitly set the annotation prefixes to nil and\n\t// call this function again to force a reconstruction of the image.\n\t// Note that since the mode is now explicitly set, we will effectively skip\n\t// the mode resolution.\n\tcfg.NVIDIAContainerRuntimeConfig.Modes.CDI.AnnotationPrefixes = nil\n\n\treturn initRuntimeModeAndImage(logger, cfg, ociSpec)\n}\n"
},
{
"path": "internal/runtime/runtime_factory_test.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage runtime\n\nimport (\n\t\"encoding/json\"\n\t\"log\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/opencontainers/runtime-spec/specs-go\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/api/config/v1\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/oci\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nconst (\n\truncExecutableName = \"runc\"\n)\n\nfunc TestMain(m *testing.M) {\n\t// TEST SETUP\n\t// Determine the module root and the test binary path\n\tvar err error\n\tmoduleRoot, err := test.GetModuleRoot()\n\tif err != nil {\n\t\tlog.Fatalf(\"error in test setup: could not get module root: %v\", err)\n\t}\n\ttestBinPath := filepath.Join(moduleRoot, \"tests\", \"bin\")\n\n\t// Set the environment variables for the test\n\tos.Setenv(\"PATH\", test.PrependToPath(testBinPath, moduleRoot))\n\n\t// Confirm that the environment is configured correctly\n\truncPath, err := exec.LookPath(runcExecutableName)\n\tif err != nil || filepath.Join(testBinPath, runcExecutableName) != runcPath {\n\t\tlog.Fatalf(\"error in test setup: mock runc path set incorrectly in TestMain(): %v\", err)\n\t}\n\n\t// RUN TESTS\n\texitCode := m.Run()\n\n\tos.Exit(exitCode)\n}\n\nfunc TestFactoryMethod(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\tdriver := root.New(\n\t\troot.WithDriverRoot(\"/nvidia/driver/root\"),\n\t)\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tcfg *config.Config\n\t\tspec *specs.Spec\n\t\texpectedError bool\n\t}{\n\t\t{\n\t\t\tdescription: \"empty config raises error\",\n\t\t\tcfg: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{},\n\t\t\t},\n\t\t\texpectedError: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"config with runtime raises no error\",\n\t\t\tcfg: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tRuntimes: []string{\"runc\"},\n\t\t\t\t\tMode: \"legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"csv mode is supported\",\n\t\t\tcfg: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tRuntimes: []string{\"runc\"},\n\t\t\t\t\tMode: \"csv\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\tEnv: []string{\n\t\t\t\t\t\t\"NVIDIA_VISIBLE_DEVICES=all\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-legacy discover mode raises error\",\n\t\t\tcfg: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tRuntimes: []string{\"runc\"},\n\t\t\t\t\tMode: \"non-legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: true,\n\t\t},\n\t\t{\n\t\t\tdescription: \"legacy discover mode returns modifier\",\n\t\t\tcfg: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tRuntimes: []string{\"runc\"},\n\t\t\t\t\tMode: \"legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"csv discover mode returns modifier\",\n\t\t\tcfg: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tRuntimes: []string{\"runc\"},\n\t\t\t\t\tMode: \"csv\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty mode raises error\",\n\t\t\tcfg: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tRuntimes: []string{\"runc\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: true,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\n\t\t\tbundleDir := t.TempDir()\n\n\t\t\tspecFile, err := os.Create(filepath.Join(bundleDir, \"config.json\"))\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.NoError(t, json.NewEncoder(specFile).Encode(tc.spec))\n\n\t\t\targv := []string{\"--bundle\", bundleDir, \"create\"}\n\n\t\t\t_, err = newNVIDIAContainerRuntime(logger, driver, tc.cfg, argv)\n\t\t\tif tc.expectedError {\n\t\t\t\trequire.Error(t, err)\n\t\t\t} else {\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\t\t})\n\t}\n}\n\nfunc TestNewSpecModifier(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\tdriver := root.New(\n\t\troot.WithDriverRoot(\"/nvidia/driver/root\"),\n\t)\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconfig *config.Config\n\t\tspec *specs.Spec\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"csv mode removes nvidia-container-runtime-hook\",\n\t\t\tconfig: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"csv\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-runtime-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-runtime-hook\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: nil,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"csv mode removes nvidia-container-toolkit\",\n\t\t\tconfig: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"csv\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-toolkit\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-toolkit\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: nil,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi mode removes nvidia-container-runtime-hook\",\n\t\t\tconfig: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"cdi\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-runtime-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-runtime-hook\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: nil,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"cdi mode removes nvidia-container-toolkit\",\n\t\t\tconfig: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"cdi\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-toolkit\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-toolkit\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: nil,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"legacy mode keeps nvidia-container-runtime-hook\",\n\t\t\tconfig: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-runtime-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-runtime-hook\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-runtime-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-runtime-hook\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"legacy mode keeps nvidia-container-toolkit\",\n\t\t\tconfig: &config.Config{\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"legacy\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tspec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-toolkit\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-toolkit\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tHooks: &specs.Hooks{\n\t\t\t\t\tPrestart: []specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/path/to/nvidia-container-toolkit\",\n\t\t\t\t\t\t\tArgs: []string{\"/path/to/nvidia-container-toolkit\", \"prestart\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tspec := &oci.SpecMock{\n\t\t\t\tLoadFunc: func() (*specs.Spec, error) {\n\t\t\t\t\treturn tc.spec, nil\n\t\t\t\t},\n\t\t\t}\n\t\t\tm, err := newSpecModifier(logger, driver, tc.config, spec)\n\t\t\trequire.NoError(t, err)\n\n\t\t\terr = m.Modify(tc.spec)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.EqualValues(t, tc.expectedSpec, tc.spec)\n\t\t})\n\t}\n}\n\nfunc TestInitRuntimeModeAndImage(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\tdecription string\n\t\tconfig config.Config\n\t\tociSpec oci.Spec\n\t\texpectedError error\n\t\texpectedMode info.RuntimeMode\n\t\tassertValidImage func(*testing.T, *image.CUDA)\n\t}{\n\t\t{\n\t\t\tdecription: \"image with NVIDIA visible devices\",\n\t\t\tconfig: config.Config{\n\t\t\t\tAcceptEnvvarUnprivileged: true,\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"nvml\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tociSpec: &oci.SpecMock{\n\t\t\t\tLoadFunc: func() (*specs.Spec, error) {\n\t\t\t\t\ts := &specs.Spec{\n\t\t\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=all\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn s, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMode: \"nvml\",\n\t\t\tassertValidImage: func(t *testing.T, c *image.CUDA) {\n\t\t\t\trequire.EqualValues(t, []string{\"all\"}, c.VisibleDevices())\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdecription: \"image with DOCKER_SWARM envars\",\n\t\t\tconfig: config.Config{\n\t\t\t\tAcceptEnvvarUnprivileged: true,\n\t\t\t\tSwarmResource: \"DOCKER_SWARM\",\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"nvml\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tociSpec: &oci.SpecMock{\n\t\t\t\tLoadFunc: func() (*specs.Spec, error) {\n\t\t\t\t\ts := &specs.Spec{\n\t\t\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=all\", \"DOCKER_SWARM=GPU1\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn s, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMode: \"nvml\",\n\t\t\tassertValidImage: func(t *testing.T, c *image.CUDA) {\n\t\t\t\trequire.EqualValues(t, []string{\"GPU1\"}, c.VisibleDevices())\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdecription: \"image with multiple DOCKER_SWARM envars\",\n\t\t\tconfig: config.Config{\n\t\t\t\tAcceptEnvvarUnprivileged: true,\n\t\t\t\tSwarmResource: \"DOCKER_SWARM,ANOTHER_SWARM\",\n\t\t\t\tNVIDIAContainerRuntimeConfig: config.RuntimeConfig{\n\t\t\t\t\tMode: \"nvml\",\n\t\t\t\t},\n\t\t\t},\n\t\t\tociSpec: &oci.SpecMock{\n\t\t\t\tLoadFunc: func() (*specs.Spec, error) {\n\t\t\t\t\ts := &specs.Spec{\n\t\t\t\t\t\tProcess: &specs.Process{\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=all\", \"DOCKER_SWARM=GPU1\", \"ANOTHER_SWARM=GPU2\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t\treturn s, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMode: \"nvml\",\n\t\t\tassertValidImage: func(t *testing.T, c *image.CUDA) {\n\t\t\t\trequire.EqualValues(t, []string{\"GPU1\", \"GPU2\"}, c.VisibleDevices())\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.decription, func(t *testing.T) {\n\t\t\tmode, cudaImage, err := initRuntimeModeAndImage(logger, &tc.config, tc.ociSpec)\n\n\t\t\trequire.EqualValues(t, tc.expectedError, err)\n\t\t\trequire.EqualValues(t, tc.expectedMode, mode)\n\n\t\t\tif tc.assertValidImage != nil {\n\t\t\t\ttc.assertValidImage(t, cudaImage)\n\t\t\t}\n\t\t})\n\t}\n}\n"
},
{
"path": "internal/test/test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage test\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strings\"\n)\n\n// GetModuleRoot returns the path to the root of the go module\nfunc GetModuleRoot() (string, error) {\n\t_, filename, _, _ := runtime.Caller(0)\n\n\treturn hasGoMod(filename)\n}\n\n// PrependToPath prefixes the specified additional paths to the PATH environment variable\nfunc PrependToPath(additionalPaths ...string) string {\n\tif currentPath := strings.TrimSpace(os.Getenv(\"PATH\")); currentPath != \"\" {\n\t\tadditionalPaths = append(additionalPaths, currentPath)\n\t}\n\treturn strings.Join(additionalPaths, \":\")\n}\n\nfunc hasGoMod(dir string) (string, error) {\n\tif dir == \"\" || dir == \"/\" {\n\t\treturn \"\", fmt.Errorf(\"module root not found\")\n\t}\n\n\t_, err := os.Stat(filepath.Join(dir, \"go.mod\"))\n\tif err != nil {\n\t\treturn hasGoMod(filepath.Dir(dir))\n\t}\n\treturn dir, nil\n}\n\n// Strip root is used to remove the specified root from the string\n// representation of any type.\nfunc StripRoot[T any](v T, root string) T {\n\tstringRep, err := json.Marshal(v)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tstringRep = bytes.ReplaceAll(stringRep, []byte(root), []byte(\"\"))\n\n\tvar modified T\n\terr = json.Unmarshal(stringRep, &modified)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treturn modified\n}\n"
},
{
"path": "internal/test/to/to.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage to\n\n// Ptr returns a pointer to a value of any type.\nfunc Ptr[T any](x T) *T {\n\treturn &x\n}\n"
},
{
"path": "packaging/debian/changelog.old",
"content": "nvidia-container-runtime-hook (1.4.0-1) UNRELEASED; urgency=medium\n\n * 2f562d5 Add support for the --no-cgroups argument\n * 25bd7c4 Add flag to specify configuration file\n * 300aaf9 Add support for the --user argument\n\n -- NVIDIA CORPORATION Thu, 21 Jun 2018 18:15:20 +0000\n\nnvidia-container-runtime-hook (1.3.0-1) UNRELEASED; urgency=medium\n\n * b4d7682 Search for nvidia-container-cli in the custom root directory\n * 6e589e0 Add support for display capability\n * b406749 Add support for Ubuntu 14.04, Debian Jessie and Amazon Linux 2\n\n -- NVIDIA CORPORATION Thu, 08 Mar 2018 04:17:34 +0000\n\nnvidia-container-runtime-hook (1.2.1-1) UNRELEASED; urgency=medium\n\n * Extract hook from nvidia-container-runtime package\n\n -- NVIDIA CORPORATION Wed, 07 Mar 2018 02:43:03 +0000\n"
},
{
"path": "packaging/debian/compat",
"content": "9\n"
},
{
"path": "packaging/debian/control",
"content": "Source: nvidia-container-toolkit\nSection: @SECTION@utils\nPriority: optional\nMaintainer: NVIDIA CORPORATION \nStandards-Version: 3.9.8\nHomepage: https://github.com/NVIDIA/nvidia-container-toolkit\nVcs-Git: https://github.com/NVIDIA/nvidia-container-toolkit\nVcs-Browser: https://github.com/NVIDIA/nvidia-container-toolkit\nBuild-Depends: debhelper (>= 9)\n\nPackage: nvidia-container-toolkit\nArchitecture: any\nDepends: ${misc:Depends}, nvidia-container-toolkit-base (= @VERSION@), libnvidia-container-tools (= @VERSION@), libnvidia-container-tools (<< 2.0.0)\nBreaks: nvidia-container-runtime (<= 3.5.0-1), nvidia-container-runtime-hook\nReplaces: nvidia-container-runtime (<= 3.5.0-1), nvidia-container-runtime-hook\nDescription: NVIDIA Container toolkit\n Provides tools and utilities to enable GPU support in containers.\n\nPackage: nvidia-container-toolkit-base\nArchitecture: any\nDepends: ${misc:Depends}\nBreaks: nvidia-container-runtime (<= 3.5.0-1), nvidia-container-runtime-hook, nvidia-container-toolkit (<= 1.10.0-1)\nReplaces: nvidia-container-runtime (<= 3.5.0-1), nvidia-container-runtime-hook\nDescription: NVIDIA Container Toolkit Base\n Provides tools such as the NVIDIA Container Runtime and NVIDIA Container Toolkit CLI to enable GPU support in containers.\n\nPackage: nvidia-container-toolkit-operator-extensions\nArchitecture: any\nDepends: ${misc:Depends}, nvidia-container-toolkit-base (= @VERSION@)\nDescription: NVIDIA Container Toolkit Operator Extensions\n Provides tools for using the NVIDIA Container Toolkit with the GPU Operator\n"
},
{
"path": "packaging/debian/copyright",
"content": "Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/\nUpstream-Name: nvidia-container-toolkit\nSource: https://github.com/NVIDIA/nvidia-container-toolkit\n\nFiles: *\nCopyright: 2017-2020 NVIDIA CORPORATION \nLicense: Apache-2.0\n\nLicense: Apache-2.0\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n"
},
{
"path": "packaging/debian/nvidia-container-toolkit-base.install",
"content": "nvidia-container-runtime /usr/bin\nnvidia-ctk /usr/bin\nnvidia-cdi-hook /usr/bin\nnvidia-cdi-refresh.service /etc/systemd/system/\nnvidia-cdi-refresh.path /etc/systemd/system/\nnvidia-cdi-refresh.env /etc/nvidia-container-toolkit/\n"
},
{
"path": "packaging/debian/nvidia-container-toolkit-base.postinst",
"content": "#!/bin/sh\n\nset -e\n\ncase \"$1\" in\n configure)\n /usr/bin/nvidia-ctk --quiet config --config-file=/etc/nvidia-container-runtime/config.toml --in-place\n\n # Enable nvidia-cdi-refresh services on both install and upgrade\n # Support running and degraded systemd states\n if command -v systemctl >/dev/null 2>&1; then\n SYSTEMD_STATE=$(systemctl is-system-running 2>/dev/null || true)\n case \"$SYSTEMD_STATE\" in\n running|degraded)\n systemctl daemon-reload || echo \"Warning: Failed to reload systemd daemon\" >&2\n systemctl enable --now nvidia-cdi-refresh.path || echo \"Warning: Failed to enable nvidia-cdi-refresh.path\" >&2\n systemctl enable --now nvidia-cdi-refresh.service || echo \"Warning: Failed to enable nvidia-cdi-refresh.service\" >&2\n \n # Trigger CDI spec regeneration immediately after install/upgrade\n echo \"Regenerating NVIDIA CDI specification...\"\n systemctl start nvidia-cdi-refresh.service || echo \"Warning: Failed to trigger CDI refresh\" >&2\n ;;\n esac\n fi\n ;;\n\n abort-upgrade|abort-remove|abort-deconfigure)\n ;;\n\n *)\n echo \"postinst called with unknown argument \\`$1'\" >&2\n exit 1\n ;;\nesac\n\n#DEBHELPER#\n\nexit 0\n"
},
{
"path": "packaging/debian/nvidia-container-toolkit-operator-extensions.install",
"content": "nvidia-container-runtime.cdi /usr/bin\nnvidia-container-runtime.legacy /usr/bin"
},
{
"path": "packaging/debian/nvidia-container-toolkit.install",
"content": "nvidia-container-runtime-hook /usr/bin\n"
},
{
"path": "packaging/debian/nvidia-container-toolkit.lintian-overrides",
"content": "new-package-should-close-itp-bug\nbinary-without-manpage\nstatically-linked-binary\ndescription-is-pkg-name\n"
},
{
"path": "packaging/debian/nvidia-container-toolkit.postinst",
"content": "#!/bin/sh\n\nset -e\n\nNVIDIA_CONTAINER_RUNTIME_HOOK=/usr/bin/nvidia-container-runtime-hook\nNVIDIA_CONTAINER_TOOLKIT=/usr/bin/nvidia-container-toolkit\n\ncase \"$1\" in\n configure)\n if [ -f \"${NVIDIA_CONTAINER_RUNTIME_HOOK}\" ]; then\n\t\tif [ ! -e \"${NVIDIA_CONTAINER_TOOLKIT}\" ]; then\n\t\t\tln -s ${NVIDIA_CONTAINER_RUNTIME_HOOK} ${NVIDIA_CONTAINER_TOOLKIT}\n\t\tfi\n fi\n ;;\n\n abort-upgrade|abort-remove|abort-deconfigure)\n ;;\n\n *)\n echo \"postinst called with unknown argument \\`$1'\" >&2\n exit 1\n ;;\nesac\n\n#DEBHELPER#\n\nexit 0\n"
},
{
"path": "packaging/debian/nvidia-container-toolkit.postrm",
"content": "#!/bin/sh\n\nset -e\n\nNVIDIA_CONTAINER_RUNTIME_HOOK=/usr/bin/nvidia-container-runtime-hook\nNVIDIA_CONTAINER_TOOLKIT=/usr/bin/nvidia-container-toolkit\n\ncase \"$1\" in\n purge)\n [ -L \"${NVIDIA_CONTAINER_TOOLKIT}\" ] && rm ${NVIDIA_CONTAINER_TOOLKIT}\n ;;\n\n upgrade|failed-upgrade|remove|abort-install|abort-upgrade|disappear)\n ;;\n\n *)\n echo \"postrm called with unknown argument \\`$1'\" >&2\n exit 1\n ;;\nesac\n\n#DEBHELPER#\n\nexit 0\n"
},
{
"path": "packaging/debian/prepare",
"content": "#! /bin/bash\n\nset -e\n\nsed -i \"s;@SECTION@;${SECTION:+$SECTION/};g\" debian/control\nsed -i \"s;@VERSION@;${VERSION:+$VERSION};g\" debian/control\n\nif [ -n \"$DISTRIB\" ]; then\n sed -i \"s;UNRELEASED;$DISTRIB;\" debian/changelog\nfi\n"
},
{
"path": "packaging/debian/rules",
"content": "#!/usr/bin/make -f\n# -*- makefile -*-\n\n#export DH_VERBOSE=1\n\n%:\n\tdh $@\n\noverride_dh_fixperms:\n\tdh_fixperms\n\tchmod 755 debian/$(shell dh_listpackages)/usr/bin/nvidia-container-runtime-hook || true\n\tchmod 755 debian/$(shell dh_listpackages)/usr/bin/nvidia-container-runtime || true\n\tchmod 755 debian/$(shell dh_listpackages)/usr/bin/nvidia-container-runtime.cdi || true\n\tchmod 755 debian/$(shell dh_listpackages)/usr/bin/nvidia-container-runtime.legacy || true\n\tchmod 755 debian/$(shell dh_listpackages)/usr/bin/nvidia-ctk || true\n\tchmod 755 debian/$(shell dh_listpackages)/usr/bin/nvidia-cdi-hook || true\n\tchmod 644 debian/$(shell dh_listpackages)/etc/systemd/system/nvidia-cdi-refresh.service || true\n\tchmod 644 debian/$(shell dh_listpackages)/etc/systemd/system/nvidia-cdi-refresh.path || true\n"
},
{
"path": "packaging/rpm/SOURCES/LICENSE",
"content": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n"
},
{
"path": "packaging/rpm/SPECS/nvidia-container-toolkit.spec",
"content": "Name: nvidia-container-toolkit\nVersion: %{version}\nRelease: %{release}\nGroup: Development Tools\n\nVendor: NVIDIA CORPORATION\nPackager: NVIDIA CORPORATION \n\nSummary: NVIDIA Container Toolkit\nURL: https://github.com/NVIDIA/nvidia-container-toolkit\nLicense: Apache-2.0\n\nSource0: nvidia-container-runtime-hook\nSource1: nvidia-ctk\nSource2: LICENSE\nSource3: nvidia-container-runtime\nSource4: nvidia-container-runtime.cdi\nSource5: nvidia-container-runtime.legacy\nSource6: nvidia-cdi-hook\nSource7: nvidia-cdi-refresh.service\nSource8: nvidia-cdi-refresh.path\nSource9: nvidia-cdi-refresh.env\n\nObsoletes: nvidia-container-runtime <= 3.5.0-1, nvidia-container-runtime-hook <= 1.4.0-2\nProvides: nvidia-container-runtime\nProvides: nvidia-container-runtime-hook\nRequires: libnvidia-container-tools == %{version}-%{release}, libnvidia-container-tools < 2.0.0\nRequires: nvidia-container-toolkit-base == %{version}-%{release}\n\n%description\nProvides tools and utilities to enable GPU support in containers.\n\n%prep\ncp %{SOURCE0} %{SOURCE1} %{SOURCE2} %{SOURCE3} %{SOURCE4} %{SOURCE5} %{SOURCE6} %{SOURCE7} %{SOURCE8} %{SOURCE9} .\n\n%install\nmkdir -p %{buildroot}%{_bindir}\nmkdir -p %{buildroot}%{_sysconfdir}/systemd/system/\nmkdir -p %{buildroot}%{_sysconfdir}/nvidia-container-toolkit\n\ninstall -m 755 -t %{buildroot}%{_bindir} nvidia-container-runtime-hook\ninstall -m 755 -t %{buildroot}%{_bindir} nvidia-container-runtime\ninstall -m 755 -t %{buildroot}%{_bindir} nvidia-container-runtime.cdi\ninstall -m 755 -t %{buildroot}%{_bindir} nvidia-container-runtime.legacy\ninstall -m 755 -t %{buildroot}%{_bindir} nvidia-ctk\ninstall -m 755 -t %{buildroot}%{_bindir} nvidia-cdi-hook\ninstall -m 644 -t %{buildroot}%{_sysconfdir}/systemd/system nvidia-cdi-refresh.service\ninstall -m 644 -t %{buildroot}%{_sysconfdir}/systemd/system nvidia-cdi-refresh.path\ninstall -m 644 -t %{buildroot}%{_sysconfdir}/nvidia-container-toolkit nvidia-cdi-refresh.env\n\n%post\nif [ $1 -gt 1 ]; then # only on package upgrade\n mkdir -p %{_localstatedir}/lib/rpm-state/nvidia-container-toolkit\n cp -af %{_bindir}/nvidia-container-runtime-hook %{_localstatedir}/lib/rpm-state/nvidia-container-toolkit\nfi\n\n%posttrans\nif [ ! -e %{_bindir}/nvidia-container-runtime-hook ]; then\n # repairing lost file nvidia-container-runtime-hook\n cp -avf %{_localstatedir}/lib/rpm-state/nvidia-container-toolkit/nvidia-container-runtime-hook %{_bindir}\nfi\nrm -rf %{_localstatedir}/lib/rpm-state/nvidia-container-toolkit\nln -sf %{_bindir}/nvidia-container-runtime-hook %{_bindir}/nvidia-container-toolkit\n\n%postun\nif [ \"$1\" = 0 ]; then # package is uninstalled, not upgraded\n if [ -L %{_bindir}/nvidia-container-toolkit ]; then rm -f %{_bindir}/nvidia-container-toolkit; fi\nfi\n\n%files\n%license LICENSE\n%{_bindir}/nvidia-container-runtime-hook\n\n%changelog\n# As of 1.10.0-1 we generate the release information automatically\n* %{release_date} NVIDIA CORPORATION %{version}-%{release}\n- See https://github.com/NVIDIA/nvidia-container-toolkit/blob/%{git_commit}/CHANGELOG.md\n- Bump libnvidia-container dependency to libnvidia-container-tools == %{version}-%{release}\n\n# The BASE package consists of the NVIDIA Container Runtime and the NVIDIA Container Toolkit CLI.\n# This allows the package to be installed on systems where no NVIDIA Container CLI is available.\n%package base\nSummary: NVIDIA Container Toolkit Base\nObsoletes: nvidia-container-runtime <= 3.5.0-1, nvidia-container-runtime-hook <= 1.4.0-2\nProvides: nvidia-container-runtime\n# Since this package allows certain components of the NVIDIA Container Toolkit to be installed separately\n# it conflicts with older versions of the nvidia-container-toolkit package that also provide these files.\nConflicts: nvidia-container-toolkit <= 1.10.0-1\n\n%description base\nProvides tools such as the NVIDIA Container Runtime and NVIDIA Container Toolkit CLI to enable GPU support in containers.\n\n%post base\n# Generate the default config; If this file already exists no changes are made.\n%{_bindir}/nvidia-ctk --quiet config --config-file=%{_sysconfdir}/nvidia-container-runtime/config.toml --in-place\n\n# Reload systemd unit cache and enable nvidia-cdi-refresh services on both install and upgrade\nif command -v systemctl >/dev/null 2>&1; then\n SYSTEMD_STATE=$(systemctl is-system-running 2>/dev/null || true)\n case \"$SYSTEMD_STATE\" in\n running|degraded)\n systemctl daemon-reload || echo \"Warning: Failed to reload systemd daemon\" >&2\n systemctl enable --now nvidia-cdi-refresh.path || echo \"Warning: Failed to enable nvidia-cdi-refresh.path\" >&2\n systemctl enable --now nvidia-cdi-refresh.service || echo \"Warning: Failed to enable nvidia-cdi-refresh.service\" >&2\n \n # Trigger CDI spec regeneration immediately after install/upgrade\n echo \"Regenerating NVIDIA CDI specification...\"\n systemctl start nvidia-cdi-refresh.service || echo \"Warning: Failed to trigger CDI refresh\" >&2\n ;;\n esac\nfi\n\n%files base\n%license LICENSE\n%{_bindir}/nvidia-container-runtime\n%{_bindir}/nvidia-ctk\n%{_bindir}/nvidia-cdi-hook\n%{_sysconfdir}/systemd/system/nvidia-cdi-refresh.service\n%{_sysconfdir}/systemd/system/nvidia-cdi-refresh.path\n%config(noreplace) %{_sysconfdir}/nvidia-container-toolkit/nvidia-cdi-refresh.env\n\n# The OPERATOR EXTENSIONS package consists of components that are required to enable GPU support in Kubernetes.\n# This package is not distributed as part of the NVIDIA Container Toolkit RPMs.\n%package operator-extensions\nSummary: NVIDIA Container Toolkit Operator Extensions\nRequires: nvidia-container-toolkit-base == %{version}-%{release}\n\n%description operator-extensions\nProvides tools for using the NVIDIA Container Toolkit with the GPU Operator\n\n%files operator-extensions\n%license LICENSE\n%{_bindir}/nvidia-container-runtime.cdi\n%{_bindir}/nvidia-container-runtime.legacy\n"
},
{
"path": "pkg/config/engine/api.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage engine\n\nconst (\n\t// SaveToSTDOUT is used to write the specified config to stdout instead of\n\t// to a file on disk.\n\tSaveToSTDOUT = \"\"\n\t// UpdateActionSet is used as an argument to UpdateDefaultRuntime\n\t// when setting a runtime handler as the default in the config\n\tUpdateActionSet = \"set\"\n\t// UpdateActionUnset is used as an argument to UpdateDefaultRuntime\n\t// when unsetting a runtime handler as the default in the config\n\tUpdateActionUnset = \"unset\"\n)\n\n// Interface defines the API for a runtime config updater.\ntype Interface interface {\n\tAddRuntime(string, string, bool) error\n\tDefaultRuntime() string\n\tEnableCDI()\n\tGetRuntimeConfig(string) (RuntimeConfig, error)\n\tRemoveRuntime(string) error\n\tUpdateDefaultRuntime(string, string) error\n\tSave(string) (int64, error)\n\tString() string\n}\n\n// RuntimeConfig defines the interface to query container runtime handler configuration\ntype RuntimeConfig interface {\n\tGetBinaryPath() string\n}\n"
},
{
"path": "pkg/config/engine/config.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage engine\n\n// A Config represents a config for a container engine.\n// These include container, cri-o, and docker.\n// The config is logically split into a Source and Destination. This allows an\n// existing config to be updated (Source == Destination) or runtime-specific\n// settings to be written to a new config. The latter is useful when creation\n// NVIDIA-specific drop-in files for container engines that support this.\ntype Config struct {\n\tSource RuntimeConfigSource\n\tDestination RuntimeConfigDestination\n}\n\n// A RuntimeConfigSource allows runtime-specific settings to be READ from a\n// config.\ntype RuntimeConfigSource interface {\n\tDefaultRuntime() string\n\tGetRuntimeConfig(string) (RuntimeConfig, error)\n\tGetDefaultRuntimeOptions() interface{}\n\tString() string\n}\n\n// A RuntimeConfigDestination allows a runtime with specific settings to be\n// WRITTEN to a config.\ntype RuntimeConfigDestination interface {\n\tAddRuntimeWithOptions(string, string, bool, interface{}) error\n\tEnableCDI()\n\tRemoveRuntime(string) error\n\tUpdateDefaultRuntime(string, string) error\n\tSave(string) (int64, error)\n\tString() string\n}\n\n// AddRuntime adds a runtime to the destination config and optionally sets it as the default.\n// The options to apply to the added runtime are read from the source config\n// default runtime.\nfunc (c *Config) AddRuntime(name string, path string, setAsDefault bool) error {\n\toptions := c.Source.GetDefaultRuntimeOptions()\n\treturn c.Destination.AddRuntimeWithOptions(name, path, setAsDefault, options)\n}\n\n// RemoveRuntime removes a runtime from the destination config.\nfunc (c *Config) RemoveRuntime(runtime string) error {\n\treturn c.Destination.RemoveRuntime(runtime)\n}\n\n// UpdateDefaultRuntime updates the default runtime setting in the destination config.\n// When action is 'set' the provided runtime name is set as the default.\n// When action is 'unset' we make sure the provided runtime name is not\n// the default.\nfunc (c *Config) UpdateDefaultRuntime(runtime string, action string) error {\n\treturn c.Destination.UpdateDefaultRuntime(runtime, action)\n}\n\n// EnableCDI enables CDI in the destination config.\nfunc (c *Config) EnableCDI() {\n\tc.Destination.EnableCDI()\n}\n\n// DefaultRuntime returns the default runtime for the source config.\nfunc (c *Config) DefaultRuntime() string {\n\treturn c.Source.DefaultRuntime()\n}\n\n// GetRuntimeConfig returns the source config for the specified runtime.\nfunc (c *Config) GetRuntimeConfig(runtime string) (RuntimeConfig, error) {\n\treturn c.Source.GetRuntimeConfig(runtime)\n}\n\n// Save saves the destination runtime to the specified path.\nfunc (c *Config) Save(path string) (int64, error) {\n\treturn c.Destination.Save(path)\n}\n\nfunc (c *Config) String() string {\n\treturn c.Destination.String()\n}\n"
},
{
"path": "pkg/config/engine/containerd/config.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\n// AddRuntime adds a runtime to the containerd config\nfunc (c *Config) AddRuntime(name string, path string, setAsDefault bool) error {\n\tif c == nil || c.Tree == nil {\n\t\treturn fmt.Errorf(\"config is nil\")\n\t}\n\tdefaultRuntimeOptions := c.GetDefaultRuntimeOptions()\n\treturn c.AddRuntimeWithOptions(name, path, setAsDefault, defaultRuntimeOptions)\n}\n\nfunc (c *Config) GetDefaultRuntimeOptions() interface{} {\n\truntimeNamesForConfig := engine.GetLowLevelRuntimes(c)\n\tfor _, r := range runtimeNamesForConfig {\n\t\toptions := c.GetSubtreeByPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"runtimes\", r})\n\t\tif options != nil {\n\t\t\tc.Logger.Debugf(\"Using options from runtime %v: %v\", r, options)\n\t\t\treturn options.Copy()\n\t\t}\n\t}\n\tc.Logger.Warningf(\"Could not infer options from runtimes %v\", runtimeNamesForConfig)\n\toptions, _ := toml.TreeFromMap(map[string]interface{}{\n\t\t\"runtime_type\": c.RuntimeType,\n\t\t\"runtime_root\": \"\",\n\t\t\"runtime_engine\": \"\",\n\t\t\"privileged_without_host_devices\": false,\n\t})\n\treturn options\n}\n\nfunc (c *Config) AddRuntimeWithOptions(name string, path string, setAsDefault bool, options interface{}) error {\n\tconfig := *c.Tree\n\n\tconfig.Set(\"version\", c.Version)\n\n\tif options != nil {\n\t\tconfig.SetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"runtimes\", name}, options)\n\t}\n\tif len(c.ContainerAnnotations) > 0 {\n\t\tannotations, err := c.getStringArrayValue([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"runtimes\", name, \"container_annotations\"})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tannotations = append(c.ContainerAnnotations, annotations...)\n\t\tconfig.SetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"runtimes\", name, \"container_annotations\"}, annotations)\n\t}\n\n\tconfig.SetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"runtimes\", name, \"options\", \"BinaryName\"}, path)\n\n\tif setAsDefault {\n\t\tconfig.SetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"}, name)\n\t} else {\n\t\tdefaultRuntime, ok := config.GetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"}).(string)\n\t\tif ok && defaultRuntime == name {\n\t\t\tconfig.DeletePath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"})\n\t\t}\n\t}\n\t*c.Tree = config\n\treturn nil\n}\n\nfunc (c *Config) getStringArrayValue(path []string) ([]string, error) {\n\tif c == nil || c.Tree == nil {\n\t\treturn nil, nil\n\t}\n\n\tconfig := *c.Tree\n\tif !config.HasPath(path) {\n\t\treturn nil, nil\n\t}\n\tannotationsI, ok := config.GetPath(path).([]interface{})\n\tif !ok {\n\t\treturn nil, fmt.Errorf(\"invalid annotations: %v\", annotationsI)\n\t}\n\n\tvar annotations []string\n\tfor _, annotation := range annotationsI {\n\t\ta, ok := annotation.(string)\n\t\tif !ok {\n\t\t\treturn nil, fmt.Errorf(\"invalid annotation: %v\", annotation)\n\t\t}\n\t\tannotations = append(annotations, a)\n\t}\n\n\treturn annotations, nil\n}\n\n// DefaultRuntime returns the default runtime for the containerd config.\nfunc (c Config) DefaultRuntime() string {\n\tif runtime, ok := c.GetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"}).(string); ok {\n\t\treturn runtime\n\t}\n\treturn \"\"\n}\n\n// EnableCDI sets the enable_cdi field in the Containerd config to true.\nfunc (c *Config) EnableCDI() {\n\tconfig := *c.Tree\n\tconfig.SetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"enable_cdi\"}, true)\n\t*c.Tree = config\n}\n\n// RemoveRuntime removes a runtime from the containerd config\nfunc (c *Config) RemoveRuntime(name string) error {\n\tif c == nil || c.Tree == nil {\n\t\treturn nil\n\t}\n\n\tconfig := *c.Tree\n\n\tconfig.DeletePath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"runtimes\", name})\n\tif runtime, ok := config.GetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"}).(string); ok {\n\t\tif runtime == name {\n\t\t\tconfig.DeletePath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"})\n\t\t}\n\t}\n\n\truntimePath := []string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"runtimes\", name}\n\tfor i := 0; i < len(runtimePath); i++ {\n\t\tif runtimes, ok := config.GetPath(runtimePath[:len(runtimePath)-i]).(*toml.Tree); ok {\n\t\t\tif len(runtimes.Keys()) == 0 {\n\t\t\t\tconfig.DeletePath(runtimePath[:len(runtimePath)-i])\n\t\t\t}\n\t\t}\n\t}\n\n\tif len(config.Keys()) == 1 && config.Keys()[0] == \"version\" {\n\t\tconfig.Delete(\"version\")\n\t}\n\n\t*c.Tree = config\n\treturn nil\n}\n\n// UpdateDefaultRuntime updates the default runtime setting in the config.\n// When action is 'set' the provided runtime name is set as the default.\n// When action is 'unset' we make sure the provided runtime name is not\n// the default.\nfunc (c *Config) UpdateDefaultRuntime(name string, action string) error {\n\tif action != engine.UpdateActionSet && action != engine.UpdateActionUnset {\n\t\treturn fmt.Errorf(\"invalid action %q, valid actions are %q and %q\", action, engine.UpdateActionSet, engine.UpdateActionUnset)\n\t}\n\n\tif c == nil || c.Tree == nil {\n\t\tif action == engine.UpdateActionSet {\n\t\t\treturn fmt.Errorf(\"config toml is nil\")\n\t\t}\n\t\treturn nil\n\t}\n\n\tconfig := *c.Tree\n\tif action == engine.UpdateActionSet {\n\t\tconfig.SetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"}, name)\n\t} else {\n\t\tdefaultRuntime, ok := config.GetPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"}).(string)\n\t\tif ok && defaultRuntime == name {\n\t\t\tconfig.DeletePath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"default_runtime_name\"})\n\t\t}\n\t}\n\n\t*c.Tree = config\n\treturn nil\n}\n"
},
{
"path": "pkg/config/engine/containerd/config_drop_in.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n)\n\n// A ConfigWithDropIn represents a pair of containerd configs.\n// The first is the top-level config and the second is an in-memory drop-in config\n// that only contains modifications made to the config.\ntype ConfigWithDropIn struct {\n\tlogger logger.Interface\n\ttopLevelConfig *topLevelConfig\n\tengine.Interface\n}\n\nvar _ engine.Interface = (*ConfigWithDropIn)(nil)\n\n// A topLevelConfig stores the original on-disk top-level config.\n// The path to the config is also stored to allow it to be modified if required.\ntype topLevelConfig struct {\n\tlogger logger.Interface\n\tpath string\n\tcontainerToHostPathMap map[string]string\n\tconfig *Config\n}\n\nfunc NewConfigWithDropIn(logger logger.Interface, topLevelConfigPath string, containerToHostPathMap map[string]string, tlConfig *Config, dropInConfig engine.Interface) *ConfigWithDropIn {\n\treturn &ConfigWithDropIn{\n\t\tlogger: logger,\n\t\ttopLevelConfig: &topLevelConfig{\n\t\t\tlogger: logger,\n\t\t\tpath: topLevelConfigPath,\n\t\t\tcontainerToHostPathMap: containerToHostPathMap,\n\t\t\tconfig: tlConfig,\n\t\t},\n\t\tInterface: dropInConfig,\n\t}\n}\n\n// Save the drop-in config to the specified path.\n// The top-level config is optionally updated to include the required imports\n// to allow the drop-in-file to be created.\nfunc (c *ConfigWithDropIn) Save(dropInPath string) (int64, error) {\n\tif dropInPath == engine.SaveToSTDOUT {\n\t\tc.logger.Infof(\"Drop-in config:\")\n\t}\n\tbytesWritten, err := c.Interface.Save(dropInPath)\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\n\tswitch {\n\tcase bytesWritten == 0:\n\t\t// If the drop-in config is empty, we try to simplify the config.\n\t\tc.topLevelConfig.simplify(dropInPath)\n\tcase bytesWritten > 0:\n\t\t// If the drop-in config has contents, we need to ensure that the\n\t\t// drop-in path is included in the imports.\n\t\tc.topLevelConfig.ensureImports(dropInPath)\n\t}\n\n\t// TODO: Only do this if we've actually modified the config.\n\tif _, err := c.topLevelConfig.Save(dropInPath); err != nil {\n\t\treturn 0, fmt.Errorf(\"failed to save top-level config: %w\", err)\n\t}\n\n\treturn bytesWritten, nil\n}\n\n// RemoveRuntime removes the runtime from both configs.\nfunc (c *ConfigWithDropIn) RemoveRuntime(name string) error {\n\tif err := c.topLevelConfig.RemoveRuntime(name); err != nil {\n\t\treturn err\n\t}\n\treturn c.Interface.RemoveRuntime(name)\n}\n\n// UpdateDefaultRuntime updates the default runtime setting in the drop-in config.\n// When action is 'set' the provided runtime name is set as the default.\n// When action is 'unset' we make sure the provided runtime name is not\n// the default.\nfunc (c *ConfigWithDropIn) UpdateDefaultRuntime(name string, action string) error {\n\treturn c.Interface.UpdateDefaultRuntime(name, action)\n}\n\n// flush saves the top-level config to its path.\n// If the config is empty, the file will be deleted.\nfunc (c *topLevelConfig) Save(dropInPath string) (int64, error) {\n\tsaveToPath := c.path\n\tif dropInPath == engine.SaveToSTDOUT {\n\t\tsaveToPath = engine.SaveToSTDOUT\n\t\tc.logger.Infof(\"Top-level config:\")\n\t}\n\treturn c.config.Save(saveToPath)\n}\n\nfunc (c *topLevelConfig) simplify(dropInFilename string) {\n\tc.removeImports(dropInFilename)\n\tc.removeVersion()\n}\n\n// removeImports removes the imports specified in the file if the only entry\n// corresponds to the path for the drop-in-file and the only other field in the\n// file is the version field.\nfunc (c *topLevelConfig) removeImports(dropInFilename string) {\n\tif len(c.config.Keys()) != 2 {\n\t\treturn\n\t}\n\tif c.config.Get(\"version\") == nil || c.config.Get(\"imports\") == nil {\n\t\treturn\n\t}\n\n\tcurrentImports, _ := c.config.getStringArrayValue([]string{\"imports\"})\n\tif len(currentImports) != 1 {\n\t\treturn\n\t}\n\n\trequiredImport := c.importPattern(dropInFilename)\n\tif currentImports[0] != requiredImport {\n\t\treturn\n\t}\n\tc.config.Delete(\"imports\")\n}\n\nfunc (c *topLevelConfig) importPattern(dropInFilename string) string {\n\t// TODO: If we make output to STDOUT a property of the config itself, then\n\t// we can actually generate the correct import statement.\n\tif dropInFilename == engine.SaveToSTDOUT {\n\t\treturn \"/etc/containerd/conf.d/*.toml\"\n\t}\n\treturn c.asHostPath(filepath.Dir(dropInFilename)) + \"/*.toml\"\n}\n\nfunc (c *topLevelConfig) asHostPath(path string) string {\n\tif c.containerToHostPathMap == nil {\n\t\treturn path\n\t}\n\tif hostPath, ok := c.containerToHostPathMap[path]; ok {\n\t\treturn hostPath\n\t}\n\treturn path\n}\n\n// removeVersion removes the version if it is the ONLY field in the file.\nfunc (c *topLevelConfig) removeVersion() {\n\tif len(c.config.Keys()) > 1 {\n\t\treturn\n\t}\n\tif c.config.Get(\"version\") == nil {\n\t\treturn\n\t}\n\tc.config.Delete(\"version\")\n}\n\nfunc (c *topLevelConfig) getCurrentImports() []string {\n\trawImports := c.config.Get(\"imports\")\n\tif rawImports == nil {\n\t\treturn nil\n\t}\n\n\tif importsStringSlice, ok := rawImports.([]string); ok {\n\t\treturn importsStringSlice\n\t}\n\n\timportsAnySlice, ok := rawImports.([]any)\n\tif !ok {\n\t\treturn nil\n\t}\n\tvar importsStringSlice []string\n\tfor _, importAny := range importsAnySlice {\n\t\timportString, ok := importAny.(string)\n\t\tif !ok {\n\t\t\tcontinue\n\t\t}\n\t\timportsStringSlice = append(importsStringSlice, importString)\n\t}\n\n\treturn importsStringSlice\n}\n\nfunc (c *topLevelConfig) ensureImports(dropInFilename string) {\n\tconfig := c.config.Tree\n\tcurrentImports := c.getCurrentImports()\n\n\trequiredImport := c.importPattern(dropInFilename)\n\tfor _, currentImport := range currentImports {\n\t\t// If the requiredImport is already present, then we need not update the config.\n\t\tif currentImport == requiredImport {\n\t\t\treturn\n\t\t}\n\t}\n\n\tcurrentImports = append(currentImports, requiredImport)\n\n\t// If the config is empty we need to set the version too.\n\tif len(config.Keys()) == 0 {\n\t\tconfig.Set(\"version\", c.config.Version)\n\t}\n\tconfig.Set(\"imports\", currentImports)\n}\n\n// RemoveRuntime removes the specified runtime from the top-level config.\nfunc (c *topLevelConfig) RemoveRuntime(name string) error {\n\treturn c.config.RemoveRuntime(name)\n}\n"
},
{
"path": "pkg/config/engine/containerd/config_drop_in_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nfunc TestEnsureImports(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconfigMap map[string]any\n\t\tpath string\n\t\texpectedImports []string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty\",\n\t\t\tpath: \"/another/path/file.toml\",\n\t\t\texpectedImports: []string{\"/another/path/*.toml\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"existing imports as string slice\",\n\t\t\tconfigMap: map[string]any{\n\t\t\t\t\"imports\": []string{\"/foo/bar/*.toml\"},\n\t\t\t},\n\t\t\tpath: \"/another/path/file.toml\",\n\t\t\texpectedImports: []string{\"/foo/bar/*.toml\", \"/another/path/*.toml\"},\n\t\t},\n\t\t{\n\t\t\tdescription: \"existing imports as any slice\",\n\t\t\tconfigMap: map[string]any{\n\t\t\t\t\"imports\": []any{\"/foo/bar/*.toml\"},\n\t\t\t},\n\t\t\tpath: \"/another/path/file.toml\",\n\t\t\texpectedImports: []string{\"/foo/bar/*.toml\", \"/another/path/*.toml\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tcut := topLevelConfig{\n\t\t\t\tconfig: &Config{\n\t\t\t\t\tTree: func() *toml.Tree {\n\t\t\t\t\t\tt, _ := toml.FromMap(tc.configMap).Load()\n\t\t\t\t\t\treturn t\n\t\t\t\t\t}(),\n\t\t\t\t},\n\t\t\t}\n\n\t\t\tcut.ensureImports(\"/another/path/file.toml\")\n\t\t\trequire.EqualValues(t, tc.expectedImports, cut.config.Get(\"imports\"))\n\t\t})\n\t}\n\n}\n"
},
{
"path": "pkg/config/engine/containerd/config_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nfunc TestAddRuntime(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconfig string\n\t\tsetAsDefault bool\n\t\texpectedConfig string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"empty config not default runtime\",\n\t\t\texpectedConfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"\"\n\t\t\t\t\truntime_root = \"\"\n\t\t\t\t\truntime_type = \"io.containerd.runc.v2\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty config, set as default runtime\",\n\t\t\tsetAsDefault: true,\n\t\t\texpectedConfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\tdefault_runtime_name = \"test\"\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"\"\n\t\t\t\t\truntime_root = \"\"\n\t\t\t\t\truntime_type = \"io.containerd.runc.v2\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from runc are imported\",\n\t\t\tconfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from default runtime are imported\",\n\t\t\tconfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\tdefault_runtime_name = \"default\"\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.default]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.default.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/default\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\tdefault_runtime_name = \"default\"\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.default]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.default.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/default\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from the default runtime take precedence over runc\",\n\t\t\tconfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\tdefault_runtime_name = \"default\"\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.default]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"defaultengine\"\n\t\t\t\t\truntime_root = \"defaultroot\"\n\t\t\t\t\truntime_type = \"defaulttype\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.default.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/default\"\n\t\t\t\t\t\tSystemdCgroup = false\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\tdefault_runtime_name = \"default\"\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.default]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"defaultengine\"\n\t\t\t\t\truntime_root = \"defaultroot\"\n\t\t\t\t\truntime_type = \"defaulttype\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.default.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/default\"\n\t\t\t\t\t\tSystemdCgroup = false\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"defaultengine\"\n\t\t\t\t\truntime_root = \"defaultroot\"\n\t\t\t\t\truntime_type = \"defaulttype\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t\t\t\tSystemdCgroup = false\n\t\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty v3 spec is supported\",\n\t\t\tconfig: `\n\t\t\tversion = 3\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 3\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.cri.v1.runtime\"]\n\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"\"\n\t\t\t\t\truntime_root = \"\"\n\t\t\t\t\truntime_type = \"io.containerd.runc.v2\"\n\t\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"v3 spec is supported\",\n\t\t\tconfig: `\n\t\t\tversion = 3\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.cri.v1.runtime\"]\n\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 3\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.cri.v1.runtime\"]\n\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd]\n\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.\"io.containerd.cri.v1.runtime\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"runtime already exists in config, default runtime\",\n\t\t\tsetAsDefault: true,\n\t\t\tconfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\tdefault_runtime_name = \"test\"\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"\"\n\t\t\t\t\truntime_root = \"\"\n\t\t\t\t\truntime_type = \"io.containerd.runc.v2\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\tdefault_runtime_name = \"test\"\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"\"\n\t\t\t\t\truntime_root = \"\"\n\t\t\t\t\truntime_type = \"io.containerd.runc.v2\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"runtime already exists in config, not default runtime\",\n\t\t\tsetAsDefault: false,\n\t\t\tconfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\tdefault_runtime_name = \"test\"\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"\"\n\t\t\t\t\truntime_root = \"\"\n\t\t\t\t\truntime_type = \"io.containerd.runc.v2\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 2\n\t\t\t[plugins]\n\t\t\t[plugins.\"io.containerd.grpc.v1.cri\"]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd]\n\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"\"\n\t\t\t\t\truntime_root = \"\"\n\t\t\t\t\truntime_type = \"io.containerd.runc.v2\"\n\t\t\t\t\t[plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\texpectedConfig, err := toml.Load(tc.expectedConfig)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tc, err := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithConfigSource(toml.FromString(tc.config)),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\n\t\t\terr = c.AddRuntime(\"test\", \"/usr/bin/test\", tc.setAsDefault)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, expectedConfig.String(), c.String())\n\t\t})\n\t}\n}\n\nfunc TestGetRuntimeConfig(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\tconfig := `\n\tversion = 2\n\t[plugins]\n\t[plugins.\"io.containerd.grpc.v1.cri\"]\n [plugins.\"io.containerd.grpc.v1.cri\".containerd]\n default_runtime_name = \"nvidia\"\n disable_snapshot_annotations = true\n discard_unpacked_layers = false\n ignore_blockio_not_enabled_errors = false\n ignore_rdt_not_enabled_errors = false\n no_pivot = false\n snapshotter = \"overlayfs\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.default_runtime]\n base_runtime_spec = \"\"\n cni_conf_dir = \"\"\n cni_max_conf_num = 0\n container_annotations = []\n pod_annotations = []\n privileged_without_host_devices = false\n privileged_without_host_devices_all_devices_allowed = false\n runtime_engine = \"\"\n runtime_path = \"\"\n runtime_root = \"\"\n runtime_type = \"\"\n sandbox_mode = \"\"\n snapshotter = \"\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes]\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc]\n base_runtime_spec = \"\"\n cni_conf_dir = \"\"\n cni_max_conf_num = 0\n container_annotations = []\n pod_annotations = []\n privileged_without_host_devices = false\n privileged_without_host_devices_all_devices_allowed = false\n runtime_engine = \"\"\n runtime_path = \"\"\n runtime_root = \"\"\n runtime_type = \"io.containerd.runc.v2\"\n sandbox_mode = \"podsandbox\"\n snapshotter = \"\"\n\n [plugins.\"io.containerd.grpc.v1.cri\".containerd.runtimes.runc.options]\n BinaryName = \"/usr/bin/runc\"\n CriuImagePath = \"\"\n CriuPath = \"\"\n CriuWorkPath = \"\"\n IoGid = 0\n IoUid = 0\n NoNewKeyring = false\n NoPivotRoot = false\n Root = \"\"\n ShimCgroup = \"\"\n SystemdCgroup = false\n`\n\ttestCases := []struct {\n\t\tdescription string\n\t\truntime string\n\t\texpected string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"valid runtime config, existing runtime\",\n\t\t\truntime: \"runc\",\n\t\t\texpected: \"/usr/bin/runc\",\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"valid runtime config, non-existing runtime\",\n\t\t\truntime: \"some-other-runtime\",\n\t\t\texpected: \"\",\n\t\t\texpectedError: nil,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\n\t\t\tc, err := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithConfigSource(toml.FromString(config)),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trc, err := c.GetRuntimeConfig(tc.runtime)\n\t\t\trequire.Equal(t, tc.expectedError, err)\n\t\t\trequire.Equal(t, tc.expected, rc.GetBinaryPath())\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/config/engine/containerd/config_v1.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\n// ConfigV1 represents a version 1 containerd config\ntype ConfigV1 Config\n\nvar _ engine.Interface = (*ConfigV1)(nil)\n\n// AddRuntime adds a runtime to the containerd config\nfunc (c *ConfigV1) AddRuntime(name string, path string, setAsDefault bool) error {\n\tif c == nil || c.Tree == nil {\n\t\treturn fmt.Errorf(\"config is nil\")\n\t}\n\tdefaultRuntimeOptions := c.GetDefaultRuntimeOptions()\n\treturn c.AddRuntimeWithOptions(name, path, setAsDefault, defaultRuntimeOptions)\n}\n\nfunc (c *ConfigV1) GetDefaultRuntimeOptions() interface{} {\n\treturn (*Config)(c).GetDefaultRuntimeOptions()\n}\n\nfunc (c *ConfigV1) AddRuntimeWithOptions(name string, path string, setAsDefault bool, options interface{}) error {\n\tif err := (*Config)(c).AddRuntimeWithOptions(name, path, setAsDefault && !c.UseLegacyConfig, options); err != nil {\n\t\treturn err\n\t}\n\tconfig := *c.Tree\n\tconfig.SetPath([]string{\"plugins\", \"cri\", \"containerd\", \"runtimes\", name, \"options\", \"Runtime\"}, path)\n\t*c.Tree = config\n\n\tif !c.UseLegacyConfig || !setAsDefault {\n\t\treturn nil\n\t}\n\n\tconfig = *c.Tree\n\t// Note: This is deprecated in containerd 1.4.0 and will be removed in 1.5.0\n\tif config.GetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\"}) == nil {\n\t\tconfig.SetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\", \"runtime_type\"}, c.RuntimeType)\n\t\tconfig.SetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\", \"runtime_root\"}, \"\")\n\t\tconfig.SetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\", \"runtime_engine\"}, \"\")\n\t\tconfig.SetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\", \"privileged_without_host_devices\"}, false)\n\t}\n\tconfig.SetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\", \"options\", \"BinaryName\"}, path)\n\tconfig.SetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\", \"options\", \"Runtime\"}, path)\n\t*c.Tree = config\n\treturn nil\n}\n\n// DefaultRuntime returns the default runtime for the containerd config.\nfunc (c ConfigV1) DefaultRuntime() string {\n\tif runtime, ok := c.GetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime_name\"}).(string); ok {\n\t\treturn runtime\n\t}\n\treturn \"\"\n}\n\n// RemoveRuntime removes a runtime from the containerd config.\nfunc (c *ConfigV1) RemoveRuntime(name string) error {\n\tif c == nil || c.Tree == nil {\n\t\treturn nil\n\t}\n\n\tconfig := *c.Tree\n\n\t// If the specified runtime was set as the default runtime we need to remove the default runtime too.\n\truntimePath, ok := config.GetPath([]string{\"plugins\", \"cri\", \"containerd\", \"runtimes\", name, \"options\", \"BinaryName\"}).(string)\n\tif !ok || runtimePath == \"\" {\n\t\truntimePath, _ = config.GetPath([]string{\"plugins\", \"cri\", \"containerd\", \"runtimes\", name, \"options\", \"Runtime\"}).(string)\n\t}\n\tdefaultRuntimePath, ok := config.GetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\", \"options\", \"BinaryName\"}).(string)\n\tif !ok || defaultRuntimePath == \"\" {\n\t\tdefaultRuntimePath, _ = config.GetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\", \"options\", \"Runtime\"}).(string)\n\t}\n\tif runtimePath != \"\" && defaultRuntimePath != \"\" && runtimePath == defaultRuntimePath {\n\t\tconfig.DeletePath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime\"})\n\t}\n\n\tconfig.DeletePath([]string{\"plugins\", \"cri\", \"containerd\", \"runtimes\", name})\n\tif runtime, ok := config.GetPath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime_name\"}).(string); ok {\n\t\tif runtime == name {\n\t\t\tconfig.DeletePath([]string{\"plugins\", \"cri\", \"containerd\", \"default_runtime_name\"})\n\t\t}\n\t}\n\n\truntimeConfigPath := []string{\"plugins\", \"cri\", \"containerd\", \"runtimes\", name}\n\tfor i := 0; i < len(runtimeConfigPath); i++ {\n\t\tif runtimes, ok := config.GetPath(runtimeConfigPath[:len(runtimeConfigPath)-i]).(*toml.Tree); ok {\n\t\t\tif len(runtimes.Keys()) == 0 {\n\t\t\t\tconfig.DeletePath(runtimeConfigPath[:len(runtimeConfigPath)-i])\n\t\t\t}\n\t\t}\n\t}\n\n\tif len(config.Keys()) == 1 && config.Keys()[0] == \"version\" {\n\t\tconfig.Delete(\"version\")\n\t}\n\n\t*c.Tree = config\n\treturn nil\n}\n\nfunc (c *ConfigV1) UpdateDefaultRuntime(name string, action string) error {\n\treturn fmt.Errorf(\"this method is not implemented\")\n}\n\n// Save writes the config to a file\nfunc (c ConfigV1) Save(path string) (int64, error) {\n\treturn (Config)(c).Save(path)\n}\n\nfunc (c *ConfigV1) GetRuntimeConfig(name string) (engine.RuntimeConfig, error) {\n\tif c == nil || c.Tree == nil {\n\t\treturn nil, fmt.Errorf(\"config is nil\")\n\t}\n\truntimeData := c.GetSubtreeByPath([]string{\"plugins\", \"cri\", \"containerd\", \"runtimes\", name})\n\n\treturn &containerdCfgRuntime{\n\t\ttree: runtimeData,\n\t}, nil\n}\n\nfunc (c *ConfigV1) EnableCDI() {\n\tconfig := *c.Tree\n\tconfig.SetPath([]string{\"plugins\", \"cri\", \"containerd\", \"enable_cdi\"}, true)\n\t*c.Tree = config\n}\n"
},
{
"path": "pkg/config/engine/containerd/config_v1_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nfunc TestAddRuntimeV1(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconfig string\n\t\tsetAsDefault bool\n\t\texpectedConfig string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"empty config not default runtime\",\n\t\t\texpectedConfig: `\n\t\t\tversion = 1\n\t\t\t[plugins]\n\t\t\t[plugins.cri]\n\t\t\t\t[plugins.cri.containerd]\n\t\t\t\t[plugins.cri.containerd.runtimes]\n\t\t\t\t\t[plugins.cri.containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"\"\n\t\t\t\t\truntime_root = \"\"\n\t\t\t\t\truntime_type = \"\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t\t\t\tRuntime = \"/usr/bin/test\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from runc are imported\",\n\t\t\tconfig: `\n\t\t\t[plugins]\n\t\t\t[plugins.cri]\n\t\t\t\t[plugins.cri.containerd]\n\t\t\t\t[plugins.cri.containerd.runtimes]\n\t\t\t\t\t[plugins.cri.containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 1\n\t\t\t[plugins]\n\t\t\t[plugins.cri]\n\t\t\t\t[plugins.cri.containerd]\n\t\t\t\t[plugins.cri.containerd.runtimes]\n\t\t\t\t\t[plugins.cri.containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.cri.containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t\t\t\tRuntime = \"/usr/bin/test\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from default runtime are imported\",\n\t\t\tconfig: `\n\t\t\t[plugins]\n\t\t\t[plugins.cri]\n\t\t\t\t[plugins.cri.containerd]\n\t\t\t\tdefault_runtime_name = \"default\"\n\t\t\t\t[plugins.cri.containerd.runtimes]\n\t\t\t\t\t[plugins.cri.containerd.runtimes.default]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.default.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/default\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 1\n\t\t\t[plugins]\n\t\t\t[plugins.cri]\n\t\t\t\t[plugins.cri.containerd]\n\t\t\t\tdefault_runtime_name = \"default\"\n\t\t\t\t[plugins.cri.containerd.runtimes]\n\t\t\t\t\t[plugins.cri.containerd.runtimes.default]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.default.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/default\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.cri.containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t\t\t\tRuntime = \"/usr/bin/test\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from the default runtime take precedence over runc\",\n\t\t\tconfig: `\n\t\t\t[plugins]\n\t\t\t[plugins.cri]\n\t\t\t\t[plugins.cri.containerd]\n\t\t\t\tdefault_runtime_name = \"default\"\n\t\t\t\t[plugins.cri.containerd.runtimes]\n\t\t\t\t\t[plugins.cri.containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.cri.containerd.runtimes.default]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"defaultengine\"\n\t\t\t\t\truntime_root = \"defaultroot\"\n\t\t\t\t\truntime_type = \"defaulttype\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.default.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/default\"\n\t\t\t\t\t\tSystemdCgroup = false\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\tversion = 1\n\t\t\t[plugins]\n\t\t\t[plugins.cri]\n\t\t\t\t[plugins.cri.containerd]\n\t\t\t\tdefault_runtime_name = \"default\"\n\t\t\t\t[plugins.cri.containerd.runtimes]\n\t\t\t\t\t[plugins.cri.containerd.runtimes.runc]\n\t\t\t\t\tprivileged_without_host_devices = true\n\t\t\t\t\truntime_engine = \"engine\"\n\t\t\t\t\truntime_root = \"root\"\n\t\t\t\t\truntime_type = \"type\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.runc.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/runc\"\n\t\t\t\t\t\tSystemdCgroup = true\n\t\t\t\t\t[plugins.cri.containerd.runtimes.default]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"defaultengine\"\n\t\t\t\t\truntime_root = \"defaultroot\"\n\t\t\t\t\truntime_type = \"defaulttype\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.default.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/default\"\n\t\t\t\t\t\tSystemdCgroup = false\n\t\t\t\t\t[plugins.cri.containerd.runtimes.test]\n\t\t\t\t\tprivileged_without_host_devices = false\n\t\t\t\t\truntime_engine = \"defaultengine\"\n\t\t\t\t\truntime_root = \"defaultroot\"\n\t\t\t\t\truntime_type = \"defaulttype\"\n\t\t\t\t\t[plugins.cri.containerd.runtimes.test.options]\n\t\t\t\t\t\tBinaryName = \"/usr/bin/test\"\n\t\t\t\t\t\tRuntime = \"/usr/bin/test\"\n\t\t\t\t\t\tSystemdCgroup = false\n\t\t\t\t`,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\texpectedConfig, err := toml.Load(tc.expectedConfig)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tc, err := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithConfigSource(toml.FromString(tc.config)),\n\t\t\t\tWithUseLegacyConfig(true),\n\t\t\t\tWithRuntimeType(\"\"),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\n\t\t\terr = c.AddRuntime(\"test\", \"/usr/bin/test\", tc.setAsDefault)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, expectedConfig.String(), c.String())\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/config/engine/containerd/containerd.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nconst (\n\tdefaultConfigVersion = 2\n\tdefaultRuntimeType = \"io.containerd.runc.v2\"\n)\n\n// Config represents the containerd config\ntype Config struct {\n\t*toml.Tree\n\tconfigOptions\n}\n\ntype configOptions struct {\n\tVersion int64\n\tLogger logger.Interface\n\tRuntimeType string\n\tContainerAnnotations []string\n\t// UseLegacyConfig indicates whether a config file pre v1.3 should be generated.\n\t// For version 1 config prior to containerd v1.4 the default runtime was\n\t// specified in a containerd.runtimes.default_runtime section.\n\t// This was deprecated in v1.4 in favour of containerd.default_runtime_name.\n\t// Support for this section has been removed in v2.0.\n\tUseLegacyConfig bool\n\t// CRIRuntimePluginName represents the fully qualified name of the containerd plugin\n\t// for the CRI runtime service. The name of this plugin was changed in v3 of the\n\t// containerd configuration file.\n\tCRIRuntimePluginName string\n}\n\nvar _ engine.Interface = (*Config)(nil)\n\ntype containerdCfgRuntime struct {\n\ttree *toml.Tree\n}\n\nvar _ engine.RuntimeConfig = (*containerdCfgRuntime)(nil)\n\n// GetBinaryPath retrieves the path to the low-level runtime binary for a runtime.\n// If no path is available, the empty string is returned.\nfunc (c *containerdCfgRuntime) GetBinaryPath() string {\n\tif c == nil || c.tree == nil {\n\t\treturn \"\"\n\t}\n\n\tbinPath, _ := c.tree.GetPath([]string{\"options\", \"BinaryName\"}).(string)\n\treturn binPath\n}\n\n// New creates a containerd config with the specified options\nfunc New(opts ...Option) (engine.Interface, error) {\n\tb := &builder{\n\t\tconfigVersion: defaultConfigVersion,\n\t\truntimeType: defaultRuntimeType,\n\t}\n\tfor _, opt := range opts {\n\t\topt(b)\n\t}\n\tif b.logger == nil {\n\t\tb.logger = logger.New()\n\t}\n\tif b.configSource == nil {\n\t\tb.configSource = toml.FromFile(b.topLevelConfigPath)\n\t}\n\n\tsourceConfigTree, err := b.configSource.Load()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to load config: %v\", err)\n\t}\n\n\tconfigVersion, err := b.parseVersion(sourceConfigTree)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to parse config version: %w\", err)\n\t}\n\tb.logger.Infof(\"Using config version %v\", configVersion)\n\n\tcriRuntimePluginName, err := b.criRuntimePluginName(configVersion)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get CRI runtime plugin name: %w\", err)\n\t}\n\tb.logger.Infof(\"Using CRI runtime plugin name %q\", criRuntimePluginName)\n\n\tsourceConfigOptions := configOptions{\n\t\tVersion: configVersion,\n\t\tCRIRuntimePluginName: criRuntimePluginName,\n\t\tLogger: b.logger,\n\t\tRuntimeType: b.runtimeType,\n\t\tUseLegacyConfig: b.useLegacyConfig,\n\t\tContainerAnnotations: b.containerAnnotations,\n\t}\n\tsourceConfig := &Config{\n\t\tTree: sourceConfigTree,\n\t\tconfigOptions: sourceConfigOptions,\n\t}\n\tswitch configVersion {\n\tcase 1:\n\t\t// Version 1 configs do not support imports / drop-in files.\n\t\t// We return the sourceConfig as is.\n\t\treturn (*ConfigV1)(sourceConfig), nil\n\tdefault:\n\t\t// For other versions, we create a DropInConfig with a reference to the\n\t\t// top-level config if present.\n\t\ttopLevelConfig := &Config{\n\t\t\tTree: func() *toml.Tree {\n\t\t\t\tt, _ := toml.FromFile(b.topLevelConfigPath).Load()\n\t\t\t\treturn t\n\t\t\t}(),\n\t\t\tconfigOptions: sourceConfigOptions,\n\t\t}\n\t\tdropInConfig := &engine.Config{\n\t\t\tSource: sourceConfig,\n\t\t\t// The destinationConfig is a minimal config with the same options\n\t\t\t// as the source config. The starting content of the destinationConfig\n\t\t\t// is the entire plugins.\"io.containerd.grpc.v1.cri\" section of the source\n\t\t\t// config. This is needed due to how containerd merges configuration from\n\t\t\t// multiple files. In particular, plugins are overridden by key and the\n\t\t\t// content is not merged. This issue is fixed starting in containerd 2.1\n\t\t\t// Reference: https://github.com/containerd/containerd/issues/5837\n\t\t\tDestination: &Config{\n\t\t\t\tTree: getBaseDropInConfigTree(sourceConfig),\n\t\t\t\tconfigOptions: sourceConfigOptions,\n\t\t\t},\n\t\t}\n\n\t\tcfg := NewConfigWithDropIn(b.logger, b.topLevelConfigPath, b.containerToHostPathMap, topLevelConfig, dropInConfig)\n\t\treturn cfg, nil\n\t}\n}\n\n// parseVersion returns the version of the config\nfunc (b *builder) parseVersion(c *toml.Tree) (int64, error) {\n\tif c == nil || len(c.Keys()) == 0 {\n\t\t// No config exists, or the config file is empty.\n\t\tif b.useLegacyConfig {\n\t\t\t// If a legacy config is explicitly requested, we default to a v1 config.\n\t\t\treturn 1, nil\n\t\t}\n\t\t// Use the requested version.\n\t\treturn int64(b.configVersion), nil\n\t}\n\n\tswitch v := c.Get(\"version\").(type) {\n\tcase nil:\n\t\treturn 1, nil\n\tcase int64:\n\t\treturn v, nil\n\tdefault:\n\t\treturn -1, fmt.Errorf(\"unsupported type for version field: %v\", v)\n\t}\n}\n\nfunc (b *builder) criRuntimePluginName(configVersion int64) (string, error) {\n\tswitch configVersion {\n\tcase 1:\n\t\treturn \"cri\", nil\n\tcase 2:\n\t\treturn \"io.containerd.grpc.v1.cri\", nil\n\tdefault:\n\t\treturn \"io.containerd.cri.v1.runtime\", nil\n\t}\n}\n\nfunc (c *Config) GetRuntimeConfig(name string) (engine.RuntimeConfig, error) {\n\tif c == nil || c.Tree == nil {\n\t\treturn nil, fmt.Errorf(\"config is nil\")\n\t}\n\truntimeData := c.GetSubtreeByPath([]string{\"plugins\", c.CRIRuntimePluginName, \"containerd\", \"runtimes\", name})\n\treturn &containerdCfgRuntime{\n\t\ttree: runtimeData,\n\t}, nil\n}\n\n// CommandLineSource returns the CLI-based containerd config loader\nfunc CommandLineSource(hostRoot string, executablePath string) toml.Loader {\n\tif executablePath == \"\" {\n\t\texecutablePath = \"containerd\"\n\t}\n\treturn toml.FromCommandLine(chrootIfRequired(hostRoot, executablePath, \"config\", \"dump\")...)\n}\n\nfunc chrootIfRequired(hostRoot string, commandLine ...string) []string {\n\tif hostRoot == \"\" || hostRoot == \"/\" {\n\t\treturn commandLine\n\t}\n\n\treturn append([]string{\"chroot\", hostRoot}, commandLine...)\n}\n\n// getBaseDropInConfigTree returns the base config to use for the drop-in config file.\n// For older containerd versions (e.g. 1.7) the plugins section of multiple\n// configs are not fully merged, but merged by key instead. This means that we\n// need to duplicate the entire plugin-specific config in the drop in file so as\n// to not override settings applied in the base config.\nfunc getBaseDropInConfigTree(sourceConfig *Config) *toml.Tree {\n\tbaseDropInConfigTree := toml.NewEmpty()\n\tcriPlugin := sourceConfig.GetSubtreeByPath([]string{\"plugins\", sourceConfig.CRIRuntimePluginName})\n\tif criPlugin != nil {\n\t\tbaseDropInConfigTree.SetPath([]string{\"plugins\", sourceConfig.CRIRuntimePluginName}, criPlugin)\n\t}\n\treturn baseDropInConfigTree\n}\n"
},
{
"path": "pkg/config/engine/containerd/option.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage containerd\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\ntype builder struct {\n\tlogger logger.Interface\n\tconfigSource toml.Loader\n\tconfigVersion int\n\tuseLegacyConfig bool\n\ttopLevelConfigPath string\n\truntimeType string\n\tcontainerAnnotations []string\n\n\tcontainerToHostPathMap map[string]string\n}\n\n// Option defines a function that can be used to configure the config builder\ntype Option func(*builder)\n\n// WithContainerPathAsHostPath maps a given container path to a host path.\nfunc WithContainerPathAsHostPath(containerPath string, hostPath string) Option {\n\treturn func(b *builder) {\n\t\tif containerPath == \"\" || hostPath == \"\" || containerPath == hostPath {\n\t\t\treturn\n\t\t}\n\t\tif b.containerToHostPathMap == nil {\n\t\t\tb.containerToHostPathMap = make(map[string]string)\n\t\t}\n\t\tb.containerToHostPathMap[containerPath] = hostPath\n\t}\n}\n\n// WithLogger sets the logger for the config builder\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(b *builder) {\n\t\tb.logger = logger\n\t}\n}\n\n// WithTopLevelConfigPath sets the path for the top-level containerd config.\nfunc WithTopLevelConfigPath(path string) Option {\n\treturn func(b *builder) {\n\t\tb.topLevelConfigPath = path\n\t}\n}\n\n// WithConfigSource sets the source for the config.\nfunc WithConfigSource(configSource toml.Loader) Option {\n\treturn func(b *builder) {\n\t\tb.configSource = configSource\n\t}\n}\n\n// WithRuntimeType sets the runtime type for the config builder\nfunc WithRuntimeType(runtimeType string) Option {\n\treturn func(b *builder) {\n\t\tb.runtimeType = runtimeType\n\t}\n}\n\n// WithUseLegacyConfig sets the useLegacyConfig flag for the config builder.\nfunc WithUseLegacyConfig(useLegacyConfig bool) Option {\n\treturn func(b *builder) {\n\t\tb.useLegacyConfig = useLegacyConfig\n\t}\n}\n\n// WithConfigVersion sets the config version for the config builder\nfunc WithConfigVersion(configVersion int) Option {\n\treturn func(b *builder) {\n\t\tb.configVersion = configVersion\n\t}\n}\n\n// WithContainerAnnotations sets the container annotations for the config builder\nfunc WithContainerAnnotations(containerAnnotations ...string) Option {\n\treturn func(b *builder) {\n\t\tb.containerAnnotations = containerAnnotations\n\t}\n}\n"
},
{
"path": "pkg/config/engine/crio/crio.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage crio\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\n// Config represents the cri-o config\ntype Config struct {\n\t*toml.Tree\n\tLogger logger.Interface\n}\n\ntype crioRuntime struct {\n\ttree *toml.Tree\n}\n\nvar _ engine.RuntimeConfig = (*crioRuntime)(nil)\n\n// GetBinaryPath retrieves the path to the low-level runtime binary for a runtime.\n// If no path is available, the empty string is returned.\nfunc (c *crioRuntime) GetBinaryPath() string {\n\tif c.tree != nil {\n\t\tif binaryPath, ok := c.tree.GetPath([]string{\"runtime_path\"}).(string); ok {\n\t\t\treturn binaryPath\n\t\t}\n\t}\n\treturn \"\"\n}\n\nvar _ engine.Interface = (*Config)(nil)\n\n// New creates a cri-o config with the specified options\nfunc New(opts ...Option) (engine.Interface, error) {\n\tb := &builder{}\n\tfor _, opt := range opts {\n\t\topt(b)\n\t}\n\tif b.logger == nil {\n\t\tb.logger = logger.New()\n\t}\n\tif b.configSource == nil {\n\t\tb.configSource = toml.FromFile(b.topLevelConfigPath)\n\t}\n\n\tsourceConfig, err := b.configSource.Load()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar destinationConfig *toml.Tree\n\tif b.configDestination != nil {\n\t\tdestinationConfig, err = b.configDestination.Load()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t} else {\n\t\tdestinationConfig = toml.NewEmpty()\n\t}\n\n\tcfg := &engine.Config{\n\t\tSource: &Config{\n\t\t\tTree: sourceConfig,\n\t\t\tLogger: b.logger,\n\t\t},\n\t\tDestination: &Config{\n\t\t\tTree: destinationConfig,\n\t\t\tLogger: b.logger,\n\t\t},\n\t}\n\n\treturn cfg, nil\n}\n\n// AddRuntime adds a new runtime to the crio config.\n// The runtime options are extracted from the default runtime and the applicable\n// settings are overridden.\nfunc (c *Config) AddRuntime(name string, path string, setAsDefault bool) error {\n\tif c == nil || c.Tree == nil {\n\t\treturn fmt.Errorf(\"config is nil\")\n\t}\n\tdefaultRuntimeOptions := c.GetDefaultRuntimeOptions()\n\treturn c.AddRuntimeWithOptions(name, path, setAsDefault, defaultRuntimeOptions)\n}\n\nfunc (c *Config) GetDefaultRuntimeOptions() interface{} {\n\truntimeNamesForConfig := engine.GetLowLevelRuntimes(c)\n\tfor _, r := range runtimeNamesForConfig {\n\t\toptions := c.GetSubtreeByPath([]string{\"crio\", \"runtime\", \"runtimes\", r})\n\t\tif options != nil {\n\t\t\tc.Logger.Debugf(\"Using options from runtime %v: %v\", r, options)\n\t\t\treturn options.Copy()\n\t\t}\n\t}\n\tc.Logger.Warningf(\"Could not infer options from runtimes %v\", runtimeNamesForConfig)\n\treturn nil\n}\n\nfunc (c *Config) AddRuntimeWithOptions(name string, path string, setAsDefault bool, options interface{}) error {\n\tconfig := *c.Tree\n\n\tif options != nil {\n\t\tconfig.SetPath([]string{\"crio\", \"runtime\", \"runtimes\", name}, options)\n\t}\n\tconfig.SetPath([]string{\"crio\", \"runtime\", \"runtimes\", name, \"runtime_path\"}, path)\n\tconfig.SetPath([]string{\"crio\", \"runtime\", \"runtimes\", name, \"runtime_type\"}, \"oci\")\n\n\tif setAsDefault {\n\t\tconfig.SetPath([]string{\"crio\", \"runtime\", \"default_runtime\"}, name)\n\t} else {\n\t\tif defaultRuntime, ok := config.GetPath([]string{\"crio\", \"runtime\", \"default_runtime\"}).(string); ok {\n\t\t\tif defaultRuntime == name {\n\t\t\t\tconfig.DeletePath([]string{\"crio\", \"runtime\", \"default_runtime\"})\n\t\t\t}\n\t\t}\n\t}\n\t*c.Tree = config\n\treturn nil\n}\n\n// DefaultRuntime returns the default runtime for the cri-o config\nfunc (c *Config) DefaultRuntime() string {\n\tif c == nil || c.Tree == nil {\n\t\treturn \"\"\n\t}\n\tif runtime, ok := c.GetPath([]string{\"crio\", \"runtime\", \"default_runtime\"}).(string); ok {\n\t\treturn runtime\n\t}\n\treturn \"\"\n}\n\n// RemoveRuntime removes a runtime from the cri-o config\nfunc (c *Config) RemoveRuntime(name string) error {\n\tif c == nil {\n\t\treturn nil\n\t}\n\n\tconfig := *c.Tree\n\tif runtime, ok := config.GetPath([]string{\"crio\", \"runtime\", \"default_runtime\"}).(string); ok {\n\t\tif runtime == name {\n\t\t\tconfig.DeletePath([]string{\"crio\", \"runtime\", \"default_runtime\"})\n\t\t}\n\t}\n\n\truntimeClassPath := []string{\"crio\", \"runtime\", \"runtimes\", name}\n\tconfig.DeletePath(runtimeClassPath)\n\tfor i := 0; i < len(runtimeClassPath); i++ {\n\t\tremainingPath := runtimeClassPath[:len(runtimeClassPath)-i]\n\t\tif entry, ok := config.GetPath(remainingPath).(*toml.Tree); ok {\n\t\t\tif len(entry.Keys()) != 0 {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tconfig.DeletePath(remainingPath)\n\t\t}\n\t}\n\n\t*c.Tree = config\n\treturn nil\n}\n\n// UpdateDefaultRuntime updates the default runtime setting in the config.\n// When action is 'set' the provided runtime name is set as the default.\n// When action is 'unset' we make sure the provided runtime name is not\n// the default.\nfunc (c *Config) UpdateDefaultRuntime(name string, action string) error {\n\tif action != engine.UpdateActionSet && action != engine.UpdateActionUnset {\n\t\treturn fmt.Errorf(\"invalid action %q, valid actions are %q and %q\", action, engine.UpdateActionSet, engine.UpdateActionUnset)\n\t}\n\n\tif c == nil || c.Tree == nil {\n\t\tif action == engine.UpdateActionSet {\n\t\t\treturn fmt.Errorf(\"config toml is nil\")\n\t\t}\n\t\treturn nil\n\t}\n\n\tconfig := *c.Tree\n\n\tif action == engine.UpdateActionSet {\n\t\tconfig.SetPath([]string{\"crio\", \"runtime\", \"default_runtime\"}, name)\n\t} else {\n\t\tif runtime, ok := config.GetPath([]string{\"crio\", \"runtime\", \"default_runtime\"}).(string); ok {\n\t\t\tif runtime == name {\n\t\t\t\tconfig.DeletePath([]string{\"crio\", \"runtime\", \"default_runtime\"})\n\t\t\t}\n\t\t}\n\t}\n\n\t*c.Tree = config\n\treturn nil\n}\n\nfunc (c *Config) GetRuntimeConfig(name string) (engine.RuntimeConfig, error) {\n\tif c == nil || c.Tree == nil {\n\t\treturn nil, fmt.Errorf(\"config is nil\")\n\t}\n\truntimeData := c.GetSubtreeByPath([]string{\"crio\", \"runtime\", \"runtimes\", name})\n\treturn &crioRuntime{\n\t\ttree: runtimeData,\n\t}, nil\n}\n\n// EnableCDI is a no-op for CRI-O since it always enabled where supported.\nfunc (c *Config) EnableCDI() {}\n\n// CommandLineSource returns the CLI-based crio config loader\nfunc CommandLineSource(hostRoot string, executablePath string) toml.Loader {\n\tif executablePath == \"\" {\n\t\texecutablePath = \"crio\"\n\t}\n\treturn toml.LoadFirst(\n\t\ttoml.FromCommandLine(chrootIfRequired(hostRoot, executablePath, \"status\", \"config\")...),\n\t\ttoml.FromCommandLine(chrootIfRequired(hostRoot, \"crio-status\", \"config\")...),\n\t)\n}\n\nfunc chrootIfRequired(hostRoot string, commandLine ...string) []string {\n\tif hostRoot == \"\" || hostRoot == \"/\" {\n\t\treturn commandLine\n\t}\n\n\treturn append([]string{\"chroot\", hostRoot}, commandLine...)\n}\n"
},
{
"path": "pkg/config/engine/crio/crio_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage crio\n\nimport (\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\nfunc TestAddRuntime(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\ttestCases := []struct {\n\t\tdescription string\n\t\tconfig string\n\t\tsetAsDefault bool\n\t\texpectedConfig string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"empty config not default runtime\",\n\t\t\texpectedConfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty config, set as default runtime\",\n\t\t\tsetAsDefault: true,\n\t\t\texpectedConfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\tdefault_runtime = \"test\"\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from runc are imported\",\n\t\t\tconfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime.runtimes.runc]\n\t\t\truntime_path = \"/usr/bin/runc\"\n\t\t\truntime_type = \"runcoci\"\n\t\t\trunc_option = \"option\"\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\trunc_option = \"option\"\n\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from default runtime are imported\",\n\t\t\tconfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\tdefault_runtime = \"default\"\n\t\t\t[crio.runtime.runtimes.default]\n\t\t\truntime_path = \"/usr/bin/default\"\n\t\t\truntime_type = \"defaultoci\"\n\t\t\tdefault_option = \"option\"\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\tdefault_option = \"option\"\n\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"options from the default runtime take precedence over runc\",\n\t\t\tconfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\tdefault_runtime = \"default\"\n\t\t\t[crio.runtime.runtimes.default]\n\t\t\truntime_path = \"/usr/bin/default\"\n\t\t\truntime_type = \"defaultoci\"\n\t\t\tdefault_option = \"option\"\n\t\t\t[crio.runtime.runtimes.runc]\n\t\t\truntime_path = \"/usr/bin/runc\"\n\t\t\truntime_type = \"runcoci\"\n\t\t\trunc_option = \"option\"\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\tdefault_option = \"option\"\n\t\t\t`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"runtime already exists in config, default runtime\",\n\t\t\tsetAsDefault: true,\n\t\t\tconfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\tdefault_runtime = \"test\"\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\tdefault_runtime = \"test\"\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"runtime already exists in config, not default runtime\",\n\t\t\tsetAsDefault: false,\n\t\t\tconfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\tdefault_runtime = \"test\"\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\t`,\n\t\t\texpectedConfig: `\n\t\t\t[crio]\n\t\t\t[crio.runtime]\n\t\t\t[crio.runtime.runtimes.test]\n\t\t\truntime_path = \"/usr/bin/test\"\n\t\t\truntime_type = \"oci\"\n\t\t\t`,\n\t\t\texpectedError: nil,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\texpectedConfig, err := toml.Load(tc.expectedConfig)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tc, err := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithConfigSource(toml.FromString(tc.config)),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\n\t\t\terr = c.AddRuntime(\"test\", \"/usr/bin/test\", tc.setAsDefault)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, expectedConfig.String(), c.String())\n\t\t})\n\t}\n}\n\nfunc TestGetRuntimeConfig(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\tconfig := `\n[crio.image]\nsignature_policy = \"/etc/crio/policy.json\"\n\n[crio.runtime]\ndefault_runtime = \"crun\"\n\n[crio.runtime.runtimes.crun]\nruntime_path = \"/usr/libexec/crio/crun\"\nruntime_root = \"/run/crun\"\nmonitor_path = \"/usr/libexec/crio/conmon\"\nallowed_annotations = [\n \"io.containers.trace-syscall\",\n]\n\n[crio.runtime.runtimes.runc]\nruntime_path = \"/usr/libexec/crio/runc\"\nruntime_root = \"/run/runc\"\nmonitor_path = \"/usr/libexec/crio/conmon\"\n`\n\ttestCases := []struct {\n\t\tdescription string\n\t\truntime string\n\t\texpected string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"valid runtime config, existing runtime\",\n\t\t\truntime: \"crun\",\n\t\t\texpected: \"/usr/libexec/crio/crun\",\n\t\t\texpectedError: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"valid runtime config, non-existing runtime\",\n\t\t\truntime: \"some-other-runtime\",\n\t\t\texpected: \"\",\n\t\t\texpectedError: nil,\n\t\t},\n\t}\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tc, err := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithConfigSource(toml.FromString(config)),\n\t\t\t)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trc, err := c.GetRuntimeConfig(tc.runtime)\n\t\t\trequire.Equal(t, tc.expectedError, err)\n\t\t\trequire.Equal(t, tc.expected, rc.GetBinaryPath())\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/config/engine/crio/option.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage crio\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml\"\n)\n\ntype builder struct {\n\tlogger logger.Interface\n\tconfigSource toml.Loader\n\tconfigDestination toml.Loader\n\ttopLevelConfigPath string\n}\n\n// Option defines a function that can be used to configure the config builder\ntype Option func(*builder)\n\n// WithLogger sets the logger for the config builder\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(b *builder) {\n\t\tb.logger = logger\n\t}\n}\n\n// WithTopLevelConfigPath sets the path for the top-level containerd config.\nfunc WithTopLevelConfigPath(path string) Option {\n\treturn func(b *builder) {\n\t\tb.topLevelConfigPath = path\n\t}\n}\n\n// WithConfigSource sets the TOML source for the config.\nfunc WithConfigSource(configSource toml.Loader) Option {\n\treturn func(b *builder) {\n\t\tb.configSource = configSource\n\t}\n}\n\n// WithConfigDestination sets the TOML destination for the config.\nfunc WithConfigDestination(configDestination toml.Loader) Option {\n\treturn func(b *builder) {\n\t\tb.configDestination = configDestination\n\t}\n}\n"
},
{
"path": "pkg/config/engine/docker/docker.go",
"content": "/**\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage docker\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine\"\n)\n\nconst (\n\tdefaultDockerRuntime = \"runc\"\n)\n\n// Config defines a docker config file.\n// TODO: This should not be public, but we need to access it from the tests in tools/container/docker\ntype Config map[string]interface{}\n\nvar _ engine.Interface = (*Config)(nil)\n\ntype dockerRuntime map[string]interface{}\n\nvar _ engine.RuntimeConfig = (*dockerRuntime)(nil)\n\n// GetBinaryPath retrieves the path to the low-level runtime binary for a runtime.\n// If no path is available, the empty string is returned.\nfunc (d dockerRuntime) GetBinaryPath() string {\n\tif d == nil {\n\t\treturn \"\"\n\t}\n\n\tpath, _ := d[\"path\"].(string)\n\treturn path\n}\n\n// New creates a docker config with the specified options\nfunc New(opts ...Option) (engine.Interface, error) {\n\tb := &builder{}\n\tfor _, opt := range opts {\n\t\topt(b)\n\t}\n\n\tif b.logger == nil {\n\t\tb.logger = logger.New()\n\t}\n\n\treturn b.build()\n}\n\n// AddRuntime adds a new runtime to the docker config\nfunc (c *Config) AddRuntime(name string, path string, setAsDefault bool) error {\n\tif c == nil {\n\t\treturn fmt.Errorf(\"config is nil\")\n\t}\n\n\tconfig := *c\n\n\t// Read the existing runtimes\n\truntimes := make(map[string]interface{})\n\tif _, exists := config[\"runtimes\"]; exists {\n\t\truntimes = config[\"runtimes\"].(map[string]interface{})\n\t}\n\n\t// Add / update the runtime definitions\n\truntimes[name] = map[string]interface{}{\n\t\t\"path\": path,\n\t\t\"args\": []string{},\n\t}\n\n\tconfig[\"runtimes\"] = runtimes\n\n\tif setAsDefault {\n\t\tconfig[\"default-runtime\"] = name\n\t}\n\n\t*c = config\n\treturn nil\n}\n\n// DefaultRuntime returns the default runtime for the docker config\nfunc (c Config) DefaultRuntime() string {\n\tr, ok := c[\"default-runtime\"].(string)\n\tif !ok {\n\t\treturn \"\"\n\t}\n\treturn r\n}\n\n// EnableCDI sets features.cdi to true in the docker config.\nfunc (c *Config) EnableCDI() {\n\tif c == nil {\n\t\treturn\n\t}\n\tconfig := *c\n\n\tfeatures, ok := config[\"features\"].(map[string]bool)\n\tif !ok {\n\t\tfeatures = make(map[string]bool)\n\t}\n\tfeatures[\"cdi\"] = true\n\n\tconfig[\"features\"] = features\n\n\t*c = config\n}\n\n// RemoveRuntime removes a runtime from the docker config\nfunc (c *Config) RemoveRuntime(name string) error {\n\tif c == nil {\n\t\treturn nil\n\t}\n\tconfig := *c\n\n\tif _, exists := config[\"default-runtime\"]; exists {\n\t\tdefaultRuntime := config[\"default-runtime\"].(string)\n\t\tif defaultRuntime == name {\n\t\t\tconfig[\"default-runtime\"] = defaultDockerRuntime\n\t\t}\n\t}\n\n\tif _, exists := config[\"runtimes\"]; exists {\n\t\truntimes := config[\"runtimes\"].(map[string]interface{})\n\n\t\tdelete(runtimes, name)\n\n\t\tif len(runtimes) == 0 {\n\t\t\tdelete(config, \"runtimes\")\n\t\t}\n\t}\n\n\t*c = config\n\n\treturn nil\n}\n\n// UpdateDefaultRuntime updates the default runtime setting in the config.\n// When action is 'set' the provided runtime name is set as the default.\n// When action is 'unset' we make sure the provided runtime name is not\n// the default.\nfunc (c *Config) UpdateDefaultRuntime(name string, action string) error {\n\tif action != engine.UpdateActionSet && action != engine.UpdateActionUnset {\n\t\treturn fmt.Errorf(\"invalid action %q, valid actions are %q and %q\", action, engine.UpdateActionSet, engine.UpdateActionUnset)\n\t}\n\n\tif c == nil {\n\t\tif action == engine.UpdateActionSet {\n\t\t\treturn fmt.Errorf(\"config toml is nil\")\n\t\t}\n\t\treturn nil\n\t}\n\n\tconfig := *c\n\n\tif action == engine.UpdateActionSet {\n\t\tconfig[\"default-runtime\"] = name\n\t} else {\n\t\tif _, exists := config[\"default-runtime\"]; exists {\n\t\t\tdefaultRuntime := config[\"default-runtime\"].(string)\n\t\t\tif defaultRuntime == name {\n\t\t\t\tconfig[\"default-runtime\"] = defaultDockerRuntime\n\t\t\t}\n\t\t}\n\t}\n\n\t*c = config\n\treturn nil\n}\n\n// Save writes the config to the specified path\nfunc (c Config) Save(path string) (int64, error) {\n\toutput, err := json.MarshalIndent(c, \"\", \" \")\n\tif err != nil {\n\t\treturn 0, fmt.Errorf(\"unable to convert to JSON: %v\", err)\n\t}\n\n\tn, err := config.Raw(path).Write(output)\n\treturn int64(n), err\n}\n\n// GetRuntimeConfig returns the runtime info of the runtime passed as input\nfunc (c *Config) GetRuntimeConfig(name string) (engine.RuntimeConfig, error) {\n\tif c == nil {\n\t\treturn nil, fmt.Errorf(\"config is nil\")\n\t}\n\n\tcfg := *c\n\n\tvar runtimes map[string]interface{}\n\tif _, ok := cfg[\"runtimes\"]; ok {\n\t\truntimes = cfg[\"runtimes\"].(map[string]interface{})\n\t\tif r, ok := runtimes[name]; ok {\n\t\t\tdr := dockerRuntime(r.(map[string]interface{}))\n\t\t\treturn &dr, nil\n\t\t}\n\t}\n\treturn &dockerRuntime{}, nil\n}\n\n// String returns the string representation of the JSON config.\nfunc (c Config) String() string {\n\toutput, err := json.MarshalIndent(c, \"\", \" \")\n\tif err != nil {\n\t\treturn fmt.Sprintf(\"invalid JSON: %v\", err)\n\t}\n\n\treturn string(output)\n}\n"
},
{
"path": "pkg/config/engine/docker/docker_test.go",
"content": "/**\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage docker\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestUpdateConfigDefaultRuntime(t *testing.T) {\n\ttestCases := []struct {\n\t\tconfig Config\n\t\truntimeName string\n\t\tsetAsDefault bool\n\t\texpectedDefaultRuntimeName interface{}\n\t}{\n\t\t{\n\t\t\tsetAsDefault: false,\n\t\t\texpectedDefaultRuntimeName: nil,\n\t\t},\n\t\t{\n\t\t\truntimeName: \"NAME\",\n\t\t\tsetAsDefault: true,\n\t\t\texpectedDefaultRuntimeName: \"NAME\",\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"default-runtime\": \"ALREADY_SET\",\n\t\t\t},\n\t\t\truntimeName: \"NAME\",\n\t\t\tsetAsDefault: false,\n\t\t\texpectedDefaultRuntimeName: \"ALREADY_SET\",\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"default-runtime\": \"ALREADY_SET\",\n\t\t\t},\n\t\t\truntimeName: \"NAME\",\n\t\t\tsetAsDefault: true,\n\t\t\texpectedDefaultRuntimeName: \"NAME\",\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"test case %d\", i), func(t *testing.T) {\n\t\t\tif tc.config == nil {\n\t\t\t\ttc.config = make(map[string]interface{})\n\t\t\t}\n\t\t\terr := tc.config.AddRuntime(tc.runtimeName, \"\", tc.setAsDefault)\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdefaultRuntimeName := tc.config[\"default-runtime\"]\n\t\t\trequire.EqualValues(t, tc.expectedDefaultRuntimeName, defaultRuntimeName)\n\t\t})\n\t}\n}\n\nfunc TestUpdateConfigRuntimes(t *testing.T) {\n\ttestCases := []struct {\n\t\tconfig Config\n\t\truntimes map[string]string\n\t\texpectedConfig map[string]interface{}\n\t}{\n\t\t{\n\t\t\tconfig: map[string]interface{}{},\n\t\t\truntimes: map[string]string{\n\t\t\t\t\"runtime1\": \"/test/runtime/dir/runtime1\",\n\t\t\t\t\"runtime2\": \"/test/runtime/dir/runtime2\",\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"runtime1\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/runtime1\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"runtime2\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/runtime2\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"runtime1\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"runtime1\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\truntimes: map[string]string{\n\t\t\t\t\"runtime1\": \"/test/runtime/dir/runtime1\",\n\t\t\t\t\"runtime2\": \"/test/runtime/dir/runtime2\",\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"runtime1\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/runtime1\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"runtime2\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/runtime2\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"not-nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"some-other-path\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\truntimes: map[string]string{\n\t\t\t\t\"runtime1\": \"/test/runtime/dir/runtime1\",\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"not-nvidia\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"some-other-path\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t\t\"runtime1\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/runtime1\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"exec-opts\": []string{\"native.cgroupdriver=systemd\"},\n\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t},\n\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t},\n\t\t\truntimes: map[string]string{\n\t\t\t\t\"runtime1\": \"/test/runtime/dir/runtime1\",\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"exec-opts\": []string{\"native.cgroupdriver=systemd\"},\n\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t},\n\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\t\t\"runtime1\": map[string]interface{}{\n\t\t\t\t\t\t\"path\": \"/test/runtime/dir/runtime1\",\n\t\t\t\t\t\t\"args\": []string{},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tconfig: map[string]interface{}{\n\t\t\t\t\"exec-opts\": []string{\"native.cgroupdriver=systemd\"},\n\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t},\n\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t},\n\t\t\texpectedConfig: map[string]interface{}{\n\t\t\t\t\"exec-opts\": []string{\"native.cgroupdriver=systemd\"},\n\t\t\t\t\"log-driver\": \"json-file\",\n\t\t\t\t\"log-opts\": map[string]string{\n\t\t\t\t\t\"max-size\": \"100m\",\n\t\t\t\t},\n\t\t\t\t\"storage-driver\": \"overlay2\",\n\t\t\t},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"test case %d\", i), func(t *testing.T) {\n\t\t\tfor runtimeName, runtimePath := range tc.runtimes {\n\t\t\t\terr := tc.config.AddRuntime(runtimeName, runtimePath, false)\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\tconfigContent, err := json.MarshalIndent(tc.config, \"\", \" \")\n\t\t\trequire.NoError(t, err)\n\n\t\t\texpectedContent, err := json.MarshalIndent(tc.expectedConfig, \"\", \" \")\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, string(expectedContent), string(configContent))\n\t\t})\n\n\t}\n}\n\nfunc TestGetRuntimeConfig(t *testing.T) {\n\tc := map[string]interface{}{\n\t\t\"runtimes\": map[string]interface{}{\n\t\t\t\"nvidia\": map[string]interface{}{\n\t\t\t\t\"path\": \"nvidia-container-runtime\",\n\t\t\t\t\"args\": []string{},\n\t\t\t},\n\t\t},\n\t}\n\tcfg := Config(c)\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\truntime string\n\t\texpected string\n\t}{\n\t\t{\n\t\t\tdescription: \"existing runtime\",\n\t\t\truntime: \"nvidia\",\n\t\t\texpected: \"nvidia-container-runtime\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"non-existent runtime\",\n\t\t\truntime: \"some-other-runtime\",\n\t\t\texpected: \"\",\n\t\t},\n\t}\n\tfor _, tc := range testCases {\n\t\trc, err := cfg.GetRuntimeConfig(tc.runtime)\n\t\trequire.NoError(t, err)\n\t\trequire.Equal(t, tc.expected, rc.GetBinaryPath())\n\t}\n}\n"
},
{
"path": "pkg/config/engine/docker/option.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage docker\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype builder struct {\n\tlogger logger.Interface\n\tpath string\n}\n\n// Option defines a function that can be used to configure the config builder\ntype Option func(*builder)\n\n// WithLogger sets the logger for the config builder\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(b *builder) {\n\t\tb.logger = logger\n\t}\n}\n\n// WithPath sets the path for the config builder\nfunc WithPath(path string) Option {\n\treturn func(b *builder) {\n\t\tb.path = path\n\t}\n}\n\nfunc (b *builder) build() (*Config, error) {\n\tif b.path == \"\" {\n\t\tempty := make(Config)\n\t\treturn &empty, nil\n\t}\n\n\treturn b.loadConfig(b.path)\n}\n\n// loadConfig loads the docker config from disk\nfunc (b *builder) loadConfig(config string) (*Config, error) {\n\tinfo, err := os.Stat(config)\n\tif os.IsExist(err) && info.IsDir() {\n\t\treturn nil, fmt.Errorf(\"config file is a directory\")\n\t}\n\n\tcfg := make(Config)\n\n\tif os.IsNotExist(err) {\n\t\tb.logger.Infof(\"Config file does not exist; using empty config\")\n\t\treturn &cfg, nil\n\t}\n\n\tb.logger.Infof(\"Loading config from %v\", config)\n\treadBytes, err := os.ReadFile(config)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"unable to read config: %v\", err)\n\t}\n\n\treader := bytes.NewReader(readBytes)\n\tif err := json.NewDecoder(reader).Decode(&cfg); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &cfg, nil\n}\n"
},
{
"path": "pkg/config/engine/engine.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage engine\n\nimport \"strings\"\n\n// GetBinaryPathsForRuntimes returns the list of binary paths for common runtimes.\n// The following list of runtimes is considered:\n//\n//\tthe default runtime, \"runc\", and \"crun\"\n//\n// If an nvidia* runtime is set as the default runtime, this is ignored.\nfunc GetBinaryPathsForRuntimes(cfg defaultRuntimesGetter) []string {\n\n\tvar binaryPaths []string\n\tseen := make(map[string]bool)\n\tfor _, runtime := range GetLowLevelRuntimes(cfg) {\n\t\truntimeConfig, err := cfg.GetRuntimeConfig(runtime)\n\t\tif err != nil {\n\t\t\t// TODO: It will be useful to log the error when GetRuntimeConfig fails for a runtime\n\t\t\tcontinue\n\t\t}\n\t\tbinaryPath := runtimeConfig.GetBinaryPath()\n\t\tif binaryPath == \"\" || seen[binaryPath] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[binaryPath] = true\n\t\tbinaryPaths = append(binaryPaths, binaryPath)\n\t}\n\n\treturn binaryPaths\n}\n\ntype defaultRuntimesGetter interface {\n\tDefaultRuntime() string\n\tGetRuntimeConfig(string) (RuntimeConfig, error)\n}\n\n// GetLowLevelRuntimes returns a predefined list low-level runtimes from the specified config.\n// nvidia* runtimes are ignored.\nfunc GetLowLevelRuntimes(cfg defaultRuntimesGetter) []string {\n\tvar runtimes []string\n\tisValidDefault := func(s string) bool {\n\t\tif s == \"\" {\n\t\t\treturn false\n\t\t}\n\t\t// ignore nvidia* runtimes.\n\t\treturn !strings.HasPrefix(s, \"nvidia\")\n\t}\n\tif defaultRuntime := cfg.DefaultRuntime(); isValidDefault(defaultRuntime) {\n\t\truntimes = append(runtimes, defaultRuntime)\n\t}\n\treturn append(runtimes, \"runc\", \"crun\")\n}\n"
},
{
"path": "pkg/config/ocihook/hooks.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ocihook\n\n// podmanHook is the hook configuration structure.\n// This is taken from `Hook` at https://github.com/containers/podman/blob/3c53200e9d61fdf95fe1da825bb2a89372551350/pkg/hooks/1.0.0/hook.go#L18\ntype podmanHook struct {\n\tVersion string `json:\"version\"`\n\tHook specHook `json:\"hook\"`\n\tWhen When `json:\"when\"`\n\tStages []string `json:\"stages\"`\n}\n\n// specHook specifies a command that is run at a particular event in the lifecycle of a container\n// This is taken from `Hook` at https://github.com/opencontainers/runtime-spec/blob/9ee22abf867e374c5464c7bbe0d0db01482254ab/specs-go/config.go#L128\ntype specHook struct {\n\tPath string `json:\"path\"`\n\tArgs []string `json:\"args,omitempty\"`\n\tEnv []string `json:\"env,omitempty\"`\n\tTimeout *int `json:\"timeout,omitempty\"`\n}\n\n// When holds hook-injection conditions.\n// This is taken from `When` at https://github.com/containers/podman/blob/3c53200e9d61fdf95fe1da825bb2a89372551350/pkg/hooks/1.0.0/when.go#L11\ntype When struct {\n\tAlways *bool `json:\"always,omitempty\"`\n\tAnnotations map[string]string `json:\"annotations,omitempty\"`\n\tCommands []string `json:\"commands,omitempty\"`\n\tHasBindMounts *bool `json:\"hasBindMounts,omitempty\"`\n\n\t// Or enables any-of matching.\n\t//\n\t// Deprecated: this property is for is backwards-compatibility with\n\t// 0.1.0 hooks. It will be removed when we drop support for them.\n\tOr bool `json:\"-\"`\n}\n"
},
{
"path": "pkg/config/ocihook/oci-hook.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage ocihook\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n)\n\n// CreateHook creates an OCI hook file for the specified NVIDIA Container Runtime hook path\nfunc CreateHook(hookFilePath string, nvidiaContainerRuntimeHookExecutablePath string) error {\n\tvar output io.Writer\n\tif hookFilePath == \"\" {\n\t\toutput = os.Stdout\n\t} else {\n\t\tif hooksDir := filepath.Dir(hookFilePath); hooksDir != \"\" {\n\t\t\terr := os.MkdirAll(hooksDir, 0755)\n\t\t\tif err != nil {\n\t\t\t\treturn fmt.Errorf(\"error creating hooks directory %v: %v\", hooksDir, err)\n\t\t\t}\n\t\t}\n\n\t\thookFile, err := os.Create(hookFilePath)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"error creating hook file '%v': %v\", hookFilePath, err)\n\t\t}\n\t\tdefer hookFile.Close()\n\t\toutput = hookFile\n\t}\n\n\tencoder := json.NewEncoder(output)\n\tencoder.SetIndent(\"\", \" \")\n\tif err := encoder.Encode(generateOciHook(nvidiaContainerRuntimeHookExecutablePath)); err != nil {\n\t\treturn fmt.Errorf(\"error writing hook file: %v\", err)\n\t}\n\treturn nil\n}\n\nfunc generateOciHook(executablePath string) podmanHook {\n\tpathParts := []string{\"/usr/local/sbin\", \"/usr/local/bin\", \"/usr/sbin\", \"/usr/bin\", \"/sbin\", \"/bin\"}\n\n\tdir := filepath.Dir(executablePath)\n\tvar found bool\n\tfor _, pathPart := range pathParts {\n\t\tif pathPart == dir {\n\t\t\tfound = true\n\t\t\tbreak\n\t\t}\n\t}\n\tif !found {\n\t\tpathParts = append(pathParts, dir)\n\t}\n\n\tenvPath := \"PATH=\" + strings.Join(pathParts, \":\")\n\talways := true\n\n\thook := podmanHook{\n\t\tVersion: \"1.0.0\",\n\t\tStages: []string{\"prestart\"},\n\t\tHook: specHook{\n\t\t\tPath: executablePath,\n\t\t\tArgs: []string{filepath.Base(executablePath), \"prestart\"},\n\t\t\tEnv: []string{envPath},\n\t\t},\n\t\tWhen: When{\n\t\t\tAlways: &always,\n\t\t\tCommands: []string{\".*\"},\n\t\t},\n\t}\n\treturn hook\n}\n"
},
{
"path": "pkg/config/raw.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage config\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n)\n\n// Raw represents a raw config file\ntype Raw string\n\n// Write writes the specified contents to a config file.\nfunc (c Raw) Write(output []byte) (int, error) {\n\tpath := string(c)\n\tif path == \"\" {\n\t\tn, err := os.Stdout.Write(output)\n\t\tif err == nil {\n\t\t\tos.Stdout.WriteString(\"\\n\")\n\t\t}\n\t\treturn n, err\n\t}\n\n\tif len(output) == 0 {\n\t\terr := os.Remove(path)\n\t\tif err != nil {\n\t\t\treturn 0, fmt.Errorf(\"unable to remove empty file: %v\", err)\n\t\t}\n\t\treturn 0, nil\n\t}\n\n\tif dir := filepath.Dir(path); dir != \"\" {\n\t\terr := os.MkdirAll(dir, 0755)\n\t\tif err != nil {\n\t\t\treturn 0, fmt.Errorf(\"unable to create directory %v: %v\", dir, err)\n\t\t}\n\t}\n\n\tf, err := os.Create(path)\n\tif err != nil {\n\t\treturn 0, fmt.Errorf(\"unable to open %v for writing: %v\", path, err)\n\t}\n\tdefer f.Close()\n\n\treturn f.Write(output)\n}\n"
},
{
"path": "pkg/config/toml/list.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toml\n\nimport \"errors\"\n\ntype firstOf []Loader\n\nfunc LoadFirst(loaders ...Loader) Loader {\n\treturn firstOf(loaders)\n}\n\nfunc (loaders firstOf) Load() (*Tree, error) {\n\tvar errs error\n\tfor _, loader := range loaders {\n\t\tif loader == nil {\n\t\t\tcontinue\n\t\t}\n\t\ttree, err := loader.Load()\n\t\tif err != nil {\n\t\t\terrs = errors.Join(errs, err)\n\t\t\tcontinue\n\t\t}\n\t\treturn tree, nil\n\t}\n\treturn nil, errs\n}\n"
},
{
"path": "pkg/config/toml/source-cli.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toml\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"os/exec\"\n)\n\ntype tomlCliSource struct {\n\tcommand string\n\targs []string\n}\n\nfunc (c tomlCliSource) Load() (*Tree, error) {\n\t//nolint:gosec // Subprocess launched with a potential tainted input or cmd arguments\n\tcmd := exec.Command(c.command, c.args...)\n\n\tvar outb bytes.Buffer\n\tvar errb bytes.Buffer\n\n\tcmd.Stdout = &outb\n\tcmd.Stderr = &errb\n\tif err := cmd.Run(); err != nil {\n\t\t// TODO: Log to stderr in case of failure\n\t\treturn nil, fmt.Errorf(\"failed to run command %v %v: %w\", c.command, c.args, err)\n\t}\n\n\treturn LoadBytes(outb.Bytes())\n}\n"
},
{
"path": "pkg/config/toml/source-empty.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toml\n\nimport (\n\t\"github.com/pelletier/go-toml\"\n)\n\ntype empty string\n\nvar _ Loader = (*empty)(nil)\n\n// Load is a no-op for an empty source.\nfunc (e empty) Load() (*Tree, error) {\n\treturn NewEmpty(), nil\n}\n\nfunc NewEmpty() *Tree {\n\ttomlTree, _ := toml.TreeFromMap(nil)\n\treturn (*Tree)(tomlTree)\n}\n"
},
{
"path": "pkg/config/toml/source-file.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toml\n\nimport (\n\t\"fmt\"\n\t\"os\"\n)\n\ntype tomlFile string\n\nvar _ Loader = (*tomlFile)(nil)\n\n// Load loads the contents of the specified TOML file as a map.\nfunc (f tomlFile) Load() (*Tree, error) {\n\tinfo, err := os.Stat(string(f))\n\tif os.IsExist(err) && info.IsDir() {\n\t\treturn nil, fmt.Errorf(\"config file %s is a directory\", string(f))\n\t}\n\n\tif os.IsNotExist(err) {\n\t\treturn Empty.Load()\n\t}\n\n\treturn LoadFile(string(f))\n}\n"
},
{
"path": "pkg/config/toml/source-map.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toml\n\ntype tomlMap map[string]interface{}\n\nvar _ Loader = (*tomlFile)(nil)\n\n// Load loads the contents of the specified TOML file as a map.\nfunc (l tomlMap) Load() (*Tree, error) {\n\treturn LoadMap(l)\n}\n"
},
{
"path": "pkg/config/toml/source-string.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toml\n\ntype tomlString string\n\nvar _ Loader = (*tomlFile)(nil)\n\n// Load loads the contents of the specified TOML file as a map.\nfunc (l tomlString) Load() (*Tree, error) {\n\treturn Load(string(l))\n}\n"
},
{
"path": "pkg/config/toml/source.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toml\n\nconst (\n\tEmpty = empty(\"\")\n)\n\n// Loader represents a source for a toml config.\ntype Loader interface {\n\tLoad() (*Tree, error)\n}\n\n// FromCommandLine creates a TOML source from the output of a shell command and its corresponding args.\n// If the command is empty, an empty config is returned.\nfunc FromCommandLine(cmds ...string) Loader {\n\tif len(cmds) == 0 {\n\t\treturn Empty\n\t}\n\treturn &tomlCliSource{\n\t\tcommand: cmds[0],\n\t\targs: cmds[1:],\n\t}\n}\n\n// FromFile creates a TOML source from the specified file.\n// If an empty string is passed an empty toml config is used.\nfunc FromFile(path string) Loader {\n\tif path == \"\" {\n\t\treturn Empty\n\t}\n\treturn tomlFile(path)\n}\n\n// FromMap creates a TOML source for the specified map.\n// If an empty map is passed and empty tomly config is used.\nfunc FromMap(m map[string]interface{}) Loader {\n\tif m == nil {\n\t\treturn Empty\n\t}\n\treturn tomlMap(m)\n}\n\n// FromString creates a TOML source for the specified contents.\n// If an empty string is passed an empty toml config is used.\nfunc FromString(contents string) Loader {\n\tif contents == \"\" {\n\t\treturn Empty\n\t}\n\treturn tomlString(contents)\n}\n"
},
{
"path": "pkg/config/toml/toml.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage toml\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pelletier/go-toml\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/config\"\n)\n\ntype Tree toml.Tree\n\n// Copy produces a copy of the contents of the Tree.\nfunc (t *Tree) Copy() *Tree {\n\tcopy, _ := Load(t.String())\n\treturn copy\n}\n\nfunc (t *Tree) GetSubtreeByPath(keys []string) *Tree {\n\tsubtree := t.GetPath(keys)\n\tif subtree == nil {\n\t\treturn nil\n\t}\n\n\tswitch subtree := subtree.(type) {\n\tcase *toml.Tree:\n\t\treturn (*Tree)(subtree)\n\tcase *Tree:\n\t\treturn subtree\n\tdefault:\n\t\tpanic(fmt.Errorf(\"invalid subtree type %T\", subtree))\n\t}\n}\n\nfunc (t *Tree) DeletePath(keys []string) error {\n\treturn (*toml.Tree)(t).DeletePath(keys)\n}\n\nfunc (t *Tree) HasPath(keys []string) bool {\n\treturn (*toml.Tree)(t).HasPath(keys)\n}\n\nfunc (t *Tree) Get(key string) interface{} {\n\treturn toTreeFromRaw((*toml.Tree)(t).Get(key))\n}\n\nfunc (t *Tree) GetPath(keys []string) interface{} {\n\treturn toTreeFromRaw((*toml.Tree)(t).GetPath(keys))\n}\n\nfunc (t *Tree) SetPath(keys []string, value interface{}) {\n\t(*toml.Tree)(t).SetPath(keys, toRawFromTree(value))\n}\n\nfunc (t *Tree) Set(key string, value interface{}) {\n\t(*toml.Tree)(t).Set(key, toRawFromTree(value))\n}\n\nfunc (t *Tree) Delete(key string) error {\n\treturn (*toml.Tree)(t).Delete(key)\n}\n\nfunc (t *Tree) Keys() []string {\n\treturn (*toml.Tree)(t).Keys()\n}\n\nfunc (t *Tree) String() string {\n\treturn (*toml.Tree)(t).String()\n}\n\nfunc (t *Tree) ToMap() map[string]interface{} {\n\treturn (*toml.Tree)(t).ToMap()\n}\n\nfunc (t *Tree) Raw() *toml.Tree {\n\treturn (*toml.Tree)(t)\n}\n\nfunc toRawFromTree(value interface{}) interface{} {\n\tif tree, ok := value.(*Tree); ok {\n\t\treturn (*toml.Tree)(tree)\n\t}\n\treturn value\n}\n\nfunc toTreeFromRaw(value interface{}) interface{} {\n\tif tree, ok := value.(*toml.Tree); ok {\n\t\treturn (*Tree)(tree)\n\t}\n\treturn value\n}\n\nfunc TreeFromMap(m map[string]interface{}) (*Tree, error) {\n\treturn new(func() (*toml.Tree, error) {\n\t\treturn toml.TreeFromMap(m)\n\t})\n}\n\nfunc Load(content string) (*Tree, error) {\n\treturn new(func() (*toml.Tree, error) {\n\t\treturn toml.Load(content)\n\t})\n}\n\nfunc LoadBytes(b []byte) (*Tree, error) {\n\treturn new(func() (*toml.Tree, error) {\n\t\treturn toml.LoadBytes(b)\n\t})\n}\n\nfunc LoadFile(path string) (*Tree, error) {\n\treturn new(func() (*toml.Tree, error) {\n\t\treturn toml.LoadFile(path)\n\t})\n}\n\nfunc LoadMap(m map[string]interface{}) (*Tree, error) {\n\treturn TreeFromMap(m)\n}\n\nfunc Marshal(v interface{}) ([]byte, error) {\n\treturn toml.Marshal(v)\n}\n\nfunc new(construct func() (*toml.Tree, error)) (*Tree, error) {\n\ttomlTree, err := construct()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn (*Tree)(tomlTree), nil\n}\n\n// Save writes the config to the specified path\nfunc (t *Tree) Save(path string) (int64, error) {\n\tcfg := (*toml.Tree)(t)\n\toutput, err := cfg.Marshal()\n\tif err != nil {\n\t\treturn 0, fmt.Errorf(\"unable to convert to TOML: %v\", err)\n\t}\n\n\tn, err := config.Raw(path).Write(output)\n\treturn int64(n), err\n}\n"
},
{
"path": "pkg/lookup/device.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n)\n\n// NewCharDeviceLocator creates a Locator that can be used to find char devices at the specified root. A logger is\n// also specified.\nfunc NewCharDeviceLocator(opts ...Option) Locator {\n\tfilter := devices.AssertCharDevice\n\n\topts = append(opts,\n\t\t// Device nodes can be specified by their full path e.g. /dev/nvidia0 or\n\t\t// by the name of the device node e.g nvidia0.\n\t\t// We thus set the search path to include \"/\" and \"/dev\" to cover both\n\t\t// cases.\n\t\tWithSearchPaths(\"/\", \"/dev\"),\n\t\tWithFilter(filter),\n\t)\n\treturn NewFactory(opts...).NewFileLocator()\n}\n"
},
{
"path": "pkg/lookup/device_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestCharDeviceLocator(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\troot string\n\t\texpectedPrefixes []string\n\t}{\n\t\t{\n\t\t\troot: \"\",\n\t\t\texpectedPrefixes: []string{\"/\", \"/dev\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/\",\n\t\t\texpectedPrefixes: []string{\"/\", \"/dev\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/some/root\",\n\t\t\texpectedPrefixes: []string{\"/some/root\", \"/some/root/dev\"},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"%d\", i), func(t *testing.T) {\n\t\t\trequired, ok := NewCharDeviceLocator(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithRoot(tc.root),\n\t\t\t).(*requiredLocator)\n\t\t\trequire.True(t, ok)\n\n\t\t\tf, ok := required.wraps.(*file)\n\t\t\trequire.True(t, ok)\n\n\t\t\trequire.EqualValues(t, tc.expectedPrefixes, f.prefixes)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/lookup/dir.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage lookup\n\nimport (\n\t\"fmt\"\n\t\"os\"\n)\n\n// NewDirectoryLocator creates a Locator that can be used to find directories at the specified root.\nfunc NewDirectoryLocator(opts ...Option) Locator {\n\treturn NewFactory(\n\t\tappend(\n\t\t\topts,\n\t\t\tWithFilter(assertDirectory),\n\t\t)...,\n\t).NewFileLocator()\n}\n\n// assertDirectory checks wither the specified path is a directory.\nfunc assertDirectory(filename string) error {\n\tinfo, err := os.Stat(filename)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error getting info for %v: %v\", filename, err)\n\t}\n\n\tif !info.IsDir() {\n\t\treturn fmt.Errorf(\"specified path '%v' is not a directory\", filename)\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "pkg/lookup/executable.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage lookup\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype executable struct {\n\tLocator\n}\n\n// NewExecutableLocator creates a locator to fine executable files in the path. A logger can also be specified.\nfunc NewExecutableLocator(logger logger.Interface, root string) Locator {\n\tpaths := GetPaths(root)\n\n\treturn newExecutableLocator(logger, root, paths...)\n}\n\nfunc newExecutableLocator(logger logger.Interface, root string, paths ...string) *executable {\n\tf := NewFactory(\n\t\tWithLogger(logger),\n\t\tWithRoot(root),\n\t\tWithSearchPaths(paths...),\n\t\tWithFilter(assertExecutable),\n\t\tWithCount(1),\n\t)\n\n\te := &executable{\n\t\tLocator: f.NewFileLocator(),\n\t}\n\treturn e\n}\n\nvar _ Locator = (*executable)(nil)\n\n// Locate finds executable files with the specified pattern in the path.\n// If a relative or absolute path is specified, the prefix paths are not considered.\nfunc (p executable) Locate(pattern string) ([]string, error) {\n\t// For absolute paths we ensure that it is executable\n\tif strings.Contains(pattern, \"/\") {\n\t\terr := assertExecutable(pattern)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"absolute path %v is not an executable file: %v\", pattern, err)\n\t\t}\n\t\treturn []string{pattern}, nil\n\t}\n\n\treturn p.Locator.Locate(pattern)\n}\n\n// assertExecutable checks whether the specified path is an execuable file.\nfunc assertExecutable(filename string) error {\n\terr := assertFile(filename)\n\tif err != nil {\n\t\treturn err\n\t}\n\tinfo, err := os.Stat(filename)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tif info.Mode()&0111 == 0 {\n\t\treturn fmt.Errorf(\"specified file '%v' is not executable\", filename)\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "pkg/lookup/executable_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestExecutableLocator(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestCases := []struct {\n\t\troot string\n\t\tpaths []string\n\t\texpectedPrefixes []string\n\t}{\n\t\t{\n\t\t\troot: \"\",\n\t\t\texpectedPrefixes: []string{\"\"},\n\t\t},\n\t\t{\n\t\t\troot: \"\",\n\t\t\tpaths: []string{\"/\"},\n\t\t\texpectedPrefixes: []string{\"/\"},\n\t\t},\n\t\t{\n\t\t\troot: \"\",\n\t\t\tpaths: []string{\"/\", \"/bin\"},\n\t\t\texpectedPrefixes: []string{\"/\", \"/bin\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/\",\n\t\t\texpectedPrefixes: []string{\"/\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/\",\n\t\t\tpaths: []string{\"/\"},\n\t\t\texpectedPrefixes: []string{\"/\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/\",\n\t\t\tpaths: []string{\"/\", \"/bin\"},\n\t\t\texpectedPrefixes: []string{\"/\", \"/bin\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/some/path\",\n\t\t\tpaths: []string{\"/\", \"/bin\"},\n\t\t\texpectedPrefixes: []string{\"/some/path\", \"/some/path/bin\"},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"%d\", i), func(t *testing.T) {\n\t\t\trequired, ok := newExecutableLocator(logger, tc.root, tc.paths...).Locator.(*requiredLocator)\n\t\t\trequire.True(t, ok)\n\n\t\t\tf, ok := required.wraps.(*file)\n\t\t\trequire.True(t, ok)\n\n\t\t\trequire.True(t, ok)\n\t\t\trequire.EqualValues(t, tc.expectedPrefixes, f.prefixes)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/lookup/factory.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport \"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\n// Factory defines a builder for locators.\ntype Factory struct {\n\tlogger logger.Interface\n\troot string\n\tsearchPaths []string\n\tfilter func(string) error\n\tcount int\n}\n\ntype Option func(*Factory)\n\nfunc NewFactory(opts ...Option) *Factory {\n\to := &Factory{}\n\tfor _, opt := range opts {\n\t\topt(o)\n\t}\n\tif o.logger == nil {\n\t\to.logger = logger.New()\n\t}\n\tif o.filter == nil {\n\t\to.filter = assertFile\n\t}\n\treturn o\n}\n\n// WithRoot sets the root for the file locator\nfunc WithRoot(root string) Option {\n\treturn func(f *Factory) {\n\t\tf.root = root\n\t}\n}\n\n// WithLogger sets the logger for the file locator\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(f *Factory) {\n\t\tf.logger = logger\n\t}\n}\n\n// WithSearchPaths sets the search paths for the file locator.\nfunc WithSearchPaths(paths ...string) Option {\n\treturn func(f *Factory) {\n\t\tf.searchPaths = NormalizePaths(paths...)\n\t}\n}\n\n// WithFilter sets the filter for the file locator\n// The filter is called for each candidate file and candidates that return nil are considered.\nfunc WithFilter(assert func(string) error) Option {\n\treturn func(f *Factory) {\n\t\tf.filter = assert\n\t}\n}\n\n// WithCount sets the maximum number of candidates to discover\nfunc WithCount(count int) Option {\n\treturn func(f *Factory) {\n\t\tf.count = count\n\t}\n}\n"
},
{
"path": "pkg/lookup/factory_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestNewFactory(t *testing.T) {\n\ttestCases := []struct {\n\t\tdesciption string\n\t\toptions []Option\n\t\texpectedSearchPaths []string\n\t}{\n\t\t{\n\t\t\tdesciption: \"search paths are expanded\",\n\t\t\toptions: []Option{\n\t\t\t\tWithSearchPaths(\"/foo:/bar\", \"/baz\"),\n\t\t\t},\n\t\t\texpectedSearchPaths: []string{\"/foo\", \"/bar\", \"/baz\"},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.desciption, func(t *testing.T) {\n\t\t\tf := NewFactory(\n\t\t\t\ttc.options...,\n\t\t\t)\n\t\t\trequire.EqualValues(t, tc.expectedSearchPaths, f.searchPaths)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/lookup/file.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage lookup\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// file can be used to locate file (or file-like elements) at a specified set of\n// prefixes. The validity of a file is determined by a filter function.\ntype file struct {\n\tlogger logger.Interface\n\tcount int\n\tfilter func(string) error\n\tprefixes []string\n}\n\n// NewFileLocator creates a Locator that can be used to find files with the specified builder.\nfunc NewFileLocator(opts ...Option) Locator {\n\treturn NewFactory(opts...).NewFileLocator()\n}\n\nfunc (o Factory) NewFileLocator() Locator {\n\tf := file{\n\t\tlogger: o.logger,\n\t\tfilter: o.filter,\n\t\tcount: o.count,\n\t\t// Since the `Locate` implementations rely on the root already being specified we update\n\t\t// the prefixes to include the root.\n\t\tprefixes: getSearchPrefixes(o.root, o.searchPaths...),\n\t}\n\treturn asRequired(&f)\n}\n\n// getSearchPrefixes generates a list of unique paths to be searched by a file locator.\n//\n// For each of the unique prefixes
specified, the path
is searched, where is the\n// specified root. If no prefixes are specified, is returned as the only search prefix.\n//\n// Note that an empty root is equivalent to searching relative to the current working directory, and\n// if the root filesystem should be searched instead, root should be specified as \"/\" explicitly.\n//\n// Also, a prefix of \"\" forces the root to be included in returned set of paths. This means that if\n// the root in addition to another prefix must be searched the function should be called with:\n//\n//\tgetSearchPrefixes(\"/root\", \"\", \"another/path\")\n//\n// and will result in the search paths []{\"/root\", \"/root/another/path\"} being returned.\nfunc getSearchPrefixes(root string, prefixes ...string) []string {\n\tseen := make(map[string]bool)\n\tvar uniquePrefixes []string\n\tfor _, p := range prefixes {\n\t\tif seen[p] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[p] = true\n\t\tuniquePrefixes = append(uniquePrefixes, filepath.Join(root, p))\n\t}\n\n\tif len(uniquePrefixes) == 0 {\n\t\tuniquePrefixes = append(uniquePrefixes, root)\n\t}\n\n\treturn uniquePrefixes\n}\n\nvar _ Locator = (*file)(nil)\n\n// Locate attempts to find files with names matching the specified pattern.\n// All prefixes are searched and any matching candidates are returned. If no matches are found, an error is returned.\nfunc (p file) Locate(pattern string) ([]string, error) {\n\tvar filenames []string\n\n\tp.logger.Debugf(\"Locating %q in %v\", pattern, p.prefixes)\nvisit:\n\tfor _, prefix := range p.prefixes {\n\t\tpathPattern := filepath.Join(prefix, pattern)\n\t\tcandidates, err := filepath.Glob(pathPattern)\n\t\tif err != nil {\n\t\t\tp.logger.Debugf(\"Checking pattern '%v' failed: %v\", pathPattern, err)\n\t\t}\n\n\t\tfor _, candidate := range candidates {\n\t\t\tp.logger.Debugf(\"Checking candidate '%v'\", candidate)\n\t\t\terr := p.filter(candidate)\n\t\t\tif err != nil {\n\t\t\t\tp.logger.Debugf(\"Candidate '%v' does not meet requirements: %v\", candidate, err)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tfilenames = append(filenames, candidate)\n\t\t\tif p.count > 0 && len(filenames) == p.count {\n\t\t\t\tp.logger.Debugf(\"Found %d candidates; ignoring further candidates\", len(filenames))\n\t\t\t\tbreak visit\n\t\t\t}\n\t\t}\n\t}\n\n\treturn filenames, nil\n}\n\n// assertFile checks whether the specified path is a regular file\nfunc assertFile(filename string) error {\n\tinfo, err := os.Stat(filename)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error getting info for %v: %v\", filename, err)\n\t}\n\n\tif info.IsDir() {\n\t\treturn fmt.Errorf(\"specified path '%v' is a directory\", filename)\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "pkg/lookup/file_test.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestGetSearchPrefixes(t *testing.T) {\n\ttestCases := []struct {\n\t\troot string\n\t\tprefixes []string\n\t\texpectedPrefixes []string\n\t}{\n\t\t{\n\t\t\troot: \"\",\n\t\t\texpectedPrefixes: []string{\"\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/\",\n\t\t\texpectedPrefixes: []string{\"/\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/some/root\",\n\t\t\texpectedPrefixes: []string{\"/some/root\"},\n\t\t},\n\t\t{\n\t\t\troot: \"\",\n\t\t\tprefixes: []string{\"foo\", \"bar\"},\n\t\t\texpectedPrefixes: []string{\"foo\", \"bar\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/\",\n\t\t\tprefixes: []string{\"foo\", \"bar\"},\n\t\t\texpectedPrefixes: []string{\"/foo\", \"/bar\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/\",\n\t\t\tprefixes: []string{\"/foo\", \"/bar\"},\n\t\t\texpectedPrefixes: []string{\"/foo\", \"/bar\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/some/root\",\n\t\t\tprefixes: []string{\"foo\", \"bar\"},\n\t\t\texpectedPrefixes: []string{\"/some/root/foo\", \"/some/root/bar\"},\n\t\t},\n\t\t{\n\t\t\troot: \"\",\n\t\t\tprefixes: []string{\"foo\", \"bar\", \"bar\", \"foo\"},\n\t\t\texpectedPrefixes: []string{\"foo\", \"bar\"},\n\t\t},\n\t\t{\n\t\t\troot: \"/some/root\",\n\t\t\tprefixes: []string{\"foo\", \"bar\", \"foo\", \"bar\"},\n\t\t\texpectedPrefixes: []string{\"/some/root/foo\", \"/some/root/bar\"},\n\t\t},\n\t}\n\n\tfor i, tc := range testCases {\n\t\tt.Run(fmt.Sprintf(\"%d\", i), func(t *testing.T) {\n\t\t\tprefixes := getSearchPrefixes(tc.root, tc.prefixes...)\n\t\t\trequire.EqualValues(t, tc.expectedPrefixes, prefixes)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/lookup/ldcache.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/ldcache\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup/symlinks\"\n)\n\ntype ldcacheLocator struct {\n\tlogger logger.Interface\n\troot string\n\n\tlibraries []string\n}\n\nvar _ Locator = (*ldcacheLocator)(nil)\n\n// newLdcacheLocator creates a locator that allows libraries to be found using\n// the ldcache.\nfunc (f *Factory) newLdcacheLocator() Locator {\n\tcache, err := ldcache.New(f.logger, f.root)\n\tif err != nil {\n\t\tf.logger.Warningf(\"Failed to load ldcache: %v\", err)\n\t\treturn notFound\n\t}\n\n\tvar libraries []string\n\t_, libs64 := cache.List()\n\tfor _, library := range libs64 {\n\t\tchain, err := symlinks.ResolveChain(library)\n\t\tif err != nil {\n\t\t\tf.logger.Warningf(\"Failed to resolve symlink chain for library %q: %v\", library, err)\n\t\t\tcontinue\n\t\t}\n\t\tlibraries = append(libraries, chain...)\n\t}\n\n\tl := &ldcacheLocator{\n\t\tlogger: f.logger,\n\t\troot: f.root,\n\t\tlibraries: libraries,\n\t}\n\n\treturn AsUnique(WithEvaluatedSymlinks(l))\n}\n\n// Locate finds the specified pattern in the libraries in the ldcache.\n// If the pattern is a path (includes a slash), the locator root is prefixed to\n// the pattern and libraries in the ldcache that match this pattern are\n// returned. If the pattern is a filename, the pattern is compared to the\n// basename of the libraries in the ldcache instead.\nfunc (l *ldcacheLocator) Locate(pattern string) ([]string, error) {\n\tmatcher := l.newPathPatternMatcher(pattern)\n\n\tvar matches []string\n\tfor _, library := range l.libraries {\n\t\tif !matcher.Match(library) {\n\t\t\tcontinue\n\t\t}\n\t\tmatches = append(matches, library)\n\t}\n\n\tif len(matches) == 0 {\n\t\treturn nil, fmt.Errorf(\"%s: %w\", pattern, ErrNotFound)\n\t}\n\n\treturn matches, nil\n}\n\ntype fullMatcher string\ntype basenameMatcher string\ntype matcher interface {\n\tMatch(string) bool\n}\n\nfunc (l *ldcacheLocator) newPathPatternMatcher(pattern string) matcher {\n\tif strings.Contains(pattern, \"/\") {\n\t\treturn fullMatcher(filepath.Join(l.root, pattern))\n\t}\n\treturn basenameMatcher(pattern)\n}\n\nfunc (m fullMatcher) Match(input string) bool {\n\tmatches, err := filepath.Match(string(m), input)\n\tif err != nil {\n\t\treturn false\n\t}\n\treturn matches\n}\n\nfunc (m basenameMatcher) Match(input string) bool {\n\treturn (fullMatcher)(m).Match(filepath.Base(input))\n}\n"
},
{
"path": "pkg/lookup/ldcache_test.go",
"content": "package lookup\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestLDCacheLookup(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\ttestCases := []struct {\n\t\trootFs string\n\t\tinputs []string\n\t\texpected string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\trootFs: \"rootfs-empty\",\n\t\t\tinputs: []string{\"libcuda.so.1\", \"libcuda.so.*\", \"libcuda.so.*.*\", \"libcuda.so.999.88.77\"},\n\t\t\texpectedError: ErrNotFound,\n\t\t},\n\t\t{\n\t\t\trootFs: \"rootfs-1\",\n\t\t\tinputs: []string{\n\t\t\t\t\"libcuda.so.1\",\n\t\t\t\t\"libcuda.so.*\",\n\t\t\t\t\"libcuda.so.*.*\",\n\t\t\t\t\"libcuda.so.999.88.77\",\n\t\t\t\t\"/lib/x86_64-linux-gnu/libcuda.so.1\",\n\t\t\t\t\"/lib/x86_64-linux-gnu/libcuda.so.*\",\n\t\t\t\t\"/lib/x86_64-linux-gnu/libcuda.so.*.*\",\n\t\t\t\t\"/lib/x86_64-linux-gnu/libcuda.so.999.88.77\",\n\t\t\t},\n\t\t\texpected: \"/lib/x86_64-linux-gnu/libcuda.so.999.88.77\",\n\t\t},\n\t\t{\n\t\t\trootFs: \"rootfs-2\",\n\t\t\tinputs: []string{\n\t\t\t\t\"libcuda.so.1\",\n\t\t\t\t\"libcuda.so.*\",\n\t\t\t\t\"libcuda.so.*.*\",\n\t\t\t\t\"libcuda.so.999.88.77\",\n\t\t\t\t\"/var/lib/nvidia/lib64/libcuda.so.1\",\n\t\t\t\t\"/var/lib/nvidia/lib64/libcuda.so.*\",\n\t\t\t\t\"/var/lib/nvidia/lib64/libcuda.so.*.*\",\n\t\t\t\t\"/var/lib/nvidia/lib64/libcuda.so.999.88.77\",\n\t\t\t},\n\t\t\texpected: \"/var/lib/nvidia/lib64/libcuda.so.999.88.77\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tfor _, input := range tc.inputs {\n\t\t\tt.Run(tc.rootFs+\" \"+input, func(t *testing.T) {\n\t\t\t\trootfs := filepath.Join(moduleRoot, \"testdata\", \"lookup\", tc.rootFs)\n\t\t\t\tl := NewFactory(\n\t\t\t\t\tWithLogger(logger),\n\t\t\t\t\tWithRoot(rootfs),\n\t\t\t\t).newLdcacheLocator()\n\n\t\t\t\tcandidates, err := l.Locate(input)\n\t\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\t\tif tc.expectedError == nil {\n\t\t\t\t\trequire.Equal(t, []string{filepath.Join(rootfs, tc.expected)}, candidates)\n\t\t\t\t}\n\t\t\t})\n\t\t}\n\t}\n}\n"
},
{
"path": "pkg/lookup/library.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage lookup\n\n// NewLibraryLocator creates a library locator using the specified options.\n// If search paths (WithSearchPaths(path1, path2, ...)) are explicitly specified\n// a library locator using these as absolute paths are used. Otherwise the\n// library is constructed using the following ordering, returning the first\n// successful result:\n// - attempt to locate the library / pattern using dlopen\n// - attempt to locate the library from a set of predefined search paths.\n// - attempt to locate the library from the ldcache.\nfunc NewLibraryLocator(opts ...Option) Locator {\n\tf := NewFactory(opts...)\n\n\t// If search paths are already specified, we return a locator for the specified search paths.\n\tif len(f.searchPaths) > 0 {\n\t\treturn NewSymlinkLocator(\n\t\t\tWithLogger(f.logger),\n\t\t\tWithSearchPaths(f.searchPaths...),\n\t\t\tWithRoot(\"/\"),\n\t\t)\n\t}\n\topts = append(opts,\n\t\tWithSearchPaths([]string{\n\t\t\t\"/\",\n\t\t\t\"/usr/lib64\",\n\t\t\t\"/usr/lib/x86_64-linux-gnu\",\n\t\t\t\"/usr/lib/aarch64-linux-gnu\",\n\t\t\t\"/usr/lib/x86_64-linux-gnu/nvidia/current\",\n\t\t\t\"/usr/lib/aarch64-linux-gnu/nvidia/current\",\n\t\t\t\"/lib64\",\n\t\t\t\"/lib/x86_64-linux-gnu\",\n\t\t\t\"/lib/aarch64-linux-gnu\",\n\t\t\t\"/lib/x86_64-linux-gnu/nvidia/current\",\n\t\t\t\"/lib/aarch64-linux-gnu/nvidia/current\",\n\t\t}...),\n\t)\n\tl := First(\n\t\tNewSymlinkLocator(opts...),\n\t\tf.newLdcacheLocator(),\n\t)\n\treturn l\n}\n"
},
{
"path": "pkg/lookup/library_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLibraryLocator(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\ttestDir := t.TempDir()\n\tsymlinkDir := filepath.Join(testDir, \"/lib/symlink\")\n\trequire.NoError(t, os.MkdirAll(symlinkDir, 0755))\n\n\tversionLib := filepath.Join(symlinkDir, \"libcuda.so.1.2.3\")\n\tsoLink := filepath.Join(symlinkDir, \"libcuda.so\")\n\tsonameLink := filepath.Join(symlinkDir, \"libcuda.so.1\")\n\n\tf, err := os.Create(versionLib)\n\trequire.NoError(t, err)\n\tf.Close()\n\trequire.NoError(t, os.Symlink(versionLib, sonameLink))\n\trequire.NoError(t, os.Symlink(sonameLink, soLink))\n\n\t// We create a set of symlinks for duplicate resolution\n\tlibTarget1 := filepath.Join(symlinkDir, \"libtarget.so.1.2.3\")\n\tsource1 := filepath.Join(symlinkDir, \"libsource1.so\")\n\tsource2 := filepath.Join(symlinkDir, \"libsource2.so\")\n\n\ttarget1, err := os.Create(libTarget1)\n\trequire.NoError(t, err)\n\ttarget1.Close()\n\trequire.NoError(t, os.Symlink(libTarget1, source1))\n\trequire.NoError(t, os.Symlink(source1, source2))\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tlibname string\n\t\tlibrarySearchPaths []string\n\t\texpected []string\n\t\texpectedError error\n\t}{\n\t\t{\n\t\t\tdescription: \"slash in path resoves symlink\",\n\t\t\tlibname: \"/lib/symlink/libcuda.so\",\n\t\t\texpected: []string{filepath.Join(testDir, \"/lib/symlink/libcuda.so.1.2.3\")},\n\t\t},\n\t\t{\n\t\t\tdescription: \"slash in path resoves symlink\",\n\t\t\tlibname: \"/lib/symlink/libcuda.so.1\",\n\t\t\texpected: []string{filepath.Join(testDir, \"/lib/symlink/libcuda.so.1.2.3\")},\n\t\t},\n\t\t{\n\t\t\tdescription: \"slash in path with pattern resolves symlinks\",\n\t\t\tlibname: \"/lib/symlink/libcuda.so.*\",\n\t\t\texpected: []string{filepath.Join(testDir, \"/lib/symlink/libcuda.so.1.2.3\")},\n\t\t},\n\t\t{\n\t\t\tdescription: \"library not found returns error\",\n\t\t\tlibname: \"/lib/symlink/libnotcuda.so\",\n\t\t\texpectedError: ErrNotFound,\n\t\t},\n\t\t{\n\t\t\tdescription: \"slash in path with pattern resoves symlink\",\n\t\t\tlibname: \"/lib/symlink/libcuda.so.*.*.*\",\n\t\t\texpected: []string{filepath.Join(testDir, \"/lib/symlink/libcuda.so.1.2.3\")},\n\t\t},\n\t\t{\n\t\t\tdescription: \"symlinks are deduplicated\",\n\t\t\tlibname: \"/lib/symlink/libsource*.so\",\n\t\t\texpected: []string{filepath.Join(testDir, \"/lib/symlink/libtarget.so.1.2.3\")},\n\t\t},\n\t\t{\n\t\t\tdescription: \"pattern resolves to multiple targets\",\n\t\t\tlibname: \"/lib/symlink/lib*.so.1.2.3\",\n\t\t\texpected: []string{\n\t\t\t\tfilepath.Join(testDir, \"/lib/symlink/libcuda.so.1.2.3\"),\n\t\t\t\tfilepath.Join(testDir, \"/lib/symlink/libtarget.so.1.2.3\"),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"search paths are searched\",\n\t\t\tlibname: \"lib*.so.1.2.3\",\n\t\t\tlibrarySearchPaths: []string{filepath.Join(testDir, \"/lib/symlink\")},\n\t\t\texpected: []string{\n\t\t\t\tfilepath.Join(testDir, \"/lib/symlink/libcuda.so.1.2.3\"),\n\t\t\t\tfilepath.Join(testDir, \"/lib/symlink/libtarget.so.1.2.3\"),\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"search paths are absolute to root\",\n\t\t\tlibname: \"lib*.so.1.2.3\",\n\t\t\tlibrarySearchPaths: []string{\"/lib/symlink\"},\n\t\t\texpectedError: ErrNotFound,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tlut := NewLibraryLocator(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithRoot(testDir),\n\t\t\t\tWithSearchPaths(tc.librarySearchPaths...),\n\t\t\t)\n\n\t\t\tcandidates, err := lut.Locate(tc.libname)\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\n\t\t\tvar cleanedCandidates []string\n\t\t\tfor _, c := range candidates {\n\t\t\t\t// On MacOS /var and /tmp symlink to /private/var and /private/tmp which is included in the resolved path.\n\t\t\t\tcleanedCandidates = append(cleanedCandidates, strings.TrimPrefix(c, \"/private\"))\n\t\t\t}\n\t\t\trequire.EqualValues(t, tc.expected, cleanedCandidates)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/lookup/locator.go",
"content": "/*\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n*/\n\npackage lookup\n\nimport \"errors\"\n\n//go:generate moq -rm -fmt=goimports -stub -out locator_mock.go . Locator\n\n// Locator defines the interface for locating files on a system.\ntype Locator interface {\n\tLocate(string) ([]string, error)\n}\n\n// ErrNotFound indicates that a specified pattern or file could not be found.\nvar ErrNotFound = errors.New(\"not found\")\n"
},
{
"path": "pkg/lookup/locator_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage lookup\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that LocatorMock does implement Locator.\n// If this is not the case, regenerate this file with moq.\nvar _ Locator = &LocatorMock{}\n\n// LocatorMock is a mock implementation of Locator.\n//\n//\tfunc TestSomethingThatUsesLocator(t *testing.T) {\n//\n//\t\t// make and configure a mocked Locator\n//\t\tmockedLocator := &LocatorMock{\n//\t\t\tLocateFunc: func(s string) ([]string, error) {\n//\t\t\t\tpanic(\"mock out the Locate method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedLocator in code that requires Locator\n//\t\t// and then make assertions.\n//\n//\t}\ntype LocatorMock struct {\n\t// LocateFunc mocks the Locate method.\n\tLocateFunc func(s string) ([]string, error)\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Locate holds details about calls to the Locate method.\n\t\tLocate []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t}\n\t}\n\tlockLocate sync.RWMutex\n}\n\n// Locate calls LocateFunc.\nfunc (mock *LocatorMock) Locate(s string) ([]string, error) {\n\tcallInfo := struct {\n\t\tS string\n\t}{\n\t\tS: s,\n\t}\n\tmock.lockLocate.Lock()\n\tmock.calls.Locate = append(mock.calls.Locate, callInfo)\n\tmock.lockLocate.Unlock()\n\tif mock.LocateFunc == nil {\n\t\tvar (\n\t\t\tstringsOut []string\n\t\t\terrOut error\n\t\t)\n\t\treturn stringsOut, errOut\n\t}\n\treturn mock.LocateFunc(s)\n}\n\n// LocateCalls gets all the calls that were made to Locate.\n// Check the length with:\n//\n//\tlen(mockedLocator.LocateCalls())\nfunc (mock *LocatorMock) LocateCalls() []struct {\n\tS string\n} {\n\tvar calls []struct {\n\t\tS string\n\t}\n\tmock.lockLocate.RLock()\n\tcalls = mock.calls.Locate\n\tmock.lockLocate.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "pkg/lookup/merge.go",
"content": "/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"errors\"\n)\n\ntype first []Locator\n\ntype unique struct {\n\tlocator Locator\n}\n\n// First returns a locator that returns the first non-empty match\nfunc First(locators ...Locator) Locator {\n\tvar f first\n\tfor _, l := range locators {\n\t\tif l == nil {\n\t\t\tcontinue\n\t\t}\n\t\tf = append(f, l)\n\t}\n\treturn f\n}\n\n// Locate returns the results for the first locator that returns a non-empty non-error result.\nfunc (f first) Locate(pattern string) ([]string, error) {\n\tvar allErrors []error\n\tfor _, l := range f {\n\t\tif l == nil {\n\t\t\tcontinue\n\t\t}\n\t\tcandidates, err := l.Locate(pattern)\n\t\tif err != nil {\n\t\t\tallErrors = append(allErrors, err)\n\t\t\tcontinue\n\t\t}\n\t\tif len(candidates) > 0 {\n\t\t\treturn candidates, nil\n\t\t}\n\t}\n\n\treturn nil, errors.Join(allErrors...)\n}\n\nfunc AsUnique(locator Locator) Locator {\n\treturn &unique{\n\t\tlocator: locator,\n\t}\n}\n\n// Locate returns the unique candidates from the wrapped Locator.\nfunc (l *unique) Locate(pattern string) ([]string, error) {\n\tcandidates, err := l.locator.Locate(pattern)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar uniqueCandidates []string\n\tseen := make(map[string]bool)\n\tfor _, candidate := range candidates {\n\t\tif seen[candidate] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[candidate] = true\n\t\tuniqueCandidates = append(uniqueCandidates, candidate)\n\t}\n\n\treturn uniqueCandidates, nil\n}\n"
},
{
"path": "pkg/lookup/null.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport \"fmt\"\n\nconst (\n\tnotFound = notFoundLocator(\"\")\n)\n\n// A notFoundLocator always returns an ErrNotFound error.\ntype notFoundLocator string\n\nfunc (l notFoundLocator) Locate(s string) ([]string, error) {\n\treturn nil, l.NewError(s)\n}\n\nfunc (l notFoundLocator) NewError(s string) error {\n\treturn fmt.Errorf(\"%s: %w\", s, ErrNotFound)\n}\n"
},
{
"path": "pkg/lookup/optional.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"errors\"\n)\n\ntype optionalLocator struct {\n\twraps Locator\n}\n\n// AsOptional converts the specified Locator to a Locator that does not raise an\n// error if no candidate can be found for a specified pattern.\nfunc AsOptional(l Locator) Locator {\n\treturn &optionalLocator{\n\t\twraps: l,\n\t}\n}\n\nfunc (l *optionalLocator) Locate(pattern string) ([]string, error) {\n\tcandidates, err := l.wraps.Locate(pattern)\n\tif errors.Is(err, ErrNotFound) {\n\t\treturn nil, nil\n\t}\n\treturn candidates, err\n}\n\ntype requiredLocator struct {\n\twraps Locator\n}\n\nfunc asRequired(l Locator) Locator {\n\treturn &requiredLocator{\n\t\twraps: l,\n\t}\n}\n\nfunc (l *requiredLocator) Locate(pattern string) ([]string, error) {\n\tcandidates, err := l.wraps.Locate(pattern)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif len(candidates) == 0 {\n\t\treturn nil, notFound.NewError(pattern)\n\t}\n\treturn candidates, nil\n}\n"
},
{
"path": "pkg/lookup/path.go",
"content": "/**\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"os\"\n\t\"path\"\n\t\"path/filepath\"\n\t\"strings\"\n)\n\nconst (\n\tenvPath = \"PATH\"\n)\n\nvar (\n\tdefaultPATH = []string{\"/usr/local/sbin\", \"/usr/local/bin\", \"/usr/sbin\", \"/usr/bin\", \"/sbin\", \"/bin\"}\n)\n\n// GetPaths returns a list of paths for a specified root. These are constructed from the\n// PATH environment variable, a default path list, and the supplied root.\nfunc GetPaths(root string) []string {\n\tdirs := NormalizePaths(os.Getenv(envPath))\n\n\tinDirs := make(map[string]bool)\n\tfor _, d := range dirs {\n\t\tinDirs[d] = true\n\t}\n\n\t// directories from the environment have higher precedence\n\tfor _, d := range defaultPATH {\n\t\tif inDirs[d] {\n\t\t\t// We don't add paths that are already included\n\t\t\tcontinue\n\t\t}\n\t\tdirs = append(dirs, d)\n\t}\n\n\tif root != \"\" && root != \"/\" {\n\t\trootDirs := []string{}\n\t\tfor _, dir := range dirs {\n\t\t\trootDirs = append(rootDirs, path.Join(root, dir))\n\t\t}\n\t\t// directories with the root prefix have higher precedence\n\t\tdirs = append(rootDirs, dirs...)\n\t}\n\n\treturn dirs\n}\n\n// GetPath returns a colon-separated path value that can be used to set the PATH\n// environment variable\nfunc GetPath(root string) string {\n\treturn strings.Join(GetPaths(root), \":\")\n}\n\n// NormalizePaths takes a list of paths and normalizes these.\n// Each of the elements in the list is expanded, meaning that if it consists of\n// strings separated by the platform-specific path separator, the element is\n// converted to a list by splitting on the separator.\n// This allows for the contents of envvironment variables such as `PATH` or\n// `LD_LIBRARY_PATH` to be processed allongside other explicit strings.\nfunc NormalizePaths(paths ...string) []string {\n\tvar normalized []string\n\tfor _, path := range paths {\n\t\tnormalized = append(normalized, filepath.SplitList(path)...)\n\t}\n\treturn normalized\n}\n"
},
{
"path": "pkg/lookup/symlinks/symlink.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage symlinks\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n)\n\n// Resolve returns the link target of the specified filename or the filename if it is not a link.\nfunc Resolve(filename string) (string, error) {\n\tinfo, err := os.Lstat(filename)\n\tif err != nil {\n\t\treturn filename, fmt.Errorf(\"failed to get file info: %w\", err)\n\t}\n\tif info.Mode()&os.ModeSymlink == 0 {\n\t\treturn filename, nil\n\t}\n\n\treturn os.Readlink(filename)\n}\n\n// ResolveChain returns the resolved symlink chain starting with the specified\n// link.\n// The symlink chain for a regular file consists of only the regular file.\nfunc ResolveChain(filename string) ([]string, error) {\n\tseen := make(map[string]bool)\n\tvar chain []string\n\n\tfor {\n\t\ttarget, err := Resolve(filename)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif seen[filename] {\n\t\t\treturn chain, nil\n\t\t}\n\t\tseen[filename] = true\n\t\tchain = append(chain, filename)\n\t\tif !filepath.IsAbs(target) {\n\t\t\ttarget, err = filepath.Abs(filepath.Join(filepath.Dir(filename), target))\n\t\t\tif err != nil {\n\t\t\t\treturn nil, fmt.Errorf(\"failed to construct absolute path: %v\", err)\n\t\t\t}\n\t\t}\n\t\tfilename = target\n\t}\n}\n\n// ForceCreate creates a specified symlink.\n// If a file (or empty directory) exists at the path it is removed.\nfunc ForceCreate(target string, link string) error {\n\t_, err := os.Lstat(link)\n\tif err != nil && !os.IsNotExist(err) {\n\t\treturn fmt.Errorf(\"failed to get file info: %w\", err)\n\t}\n\tif !os.IsNotExist(err) {\n\t\tif err := os.Remove(link); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to remove existing file: %w\", err)\n\t\t}\n\t}\n\treturn os.Symlink(target, link)\n}\n"
},
{
"path": "pkg/lookup/symlinks.go",
"content": "/**\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage lookup\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup/symlinks\"\n)\n\ntype symlinkChain struct {\n\tlogger logger.Interface\n\tlocator Locator\n}\n\ntype symlink struct {\n\tlocator Locator\n}\n\n// NewSymlinkChainLocator creats a locator that can be used for locating files through symlinks.\nfunc NewSymlinkChainLocator(opts ...Option) Locator {\n\tf := NewFactory(opts...)\n\tl := &symlinkChain{\n\t\tlogger: f.logger,\n\t\tlocator: f.NewFileLocator(),\n\t}\n\n\treturn l\n}\n\n// NewSymlinkLocator creats a locator that can be used for locating files through symlinks.\nfunc NewSymlinkLocator(opts ...Option) Locator {\n\tf := NewFactory(opts...)\n\treturn AsUnique(WithEvaluatedSymlinks(f.NewFileLocator()))\n}\n\n// WithEvaluatedSymlinks wraps a locator in one that ensures that returned\n// symlinks are resolved.\nfunc WithEvaluatedSymlinks(locator Locator) Locator {\n\tl := symlink{\n\t\tlocator: locator,\n\t}\n\treturn &l\n}\n\n// Locate finds the specified pattern at the specified root.\n// If the file is a symlink, the link is followed and all candidates to the final target are returned.\nfunc (p symlinkChain) Locate(pattern string) ([]string, error) {\n\tcandidates, err := p.locator.Locate(pattern)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar filenames []string\n\tfound := make(map[string]bool)\n\n\tfor _, candidate := range candidates {\n\t\tif found[candidate] {\n\t\t\tcontinue\n\t\t}\n\t\ttargets, err := symlinks.ResolveChain(candidate)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error resolving symlink chain: %w\", err)\n\t\t}\n\t\tif len(targets) > 0 {\n\t\t\tp.logger.Debugf(\"Resolved link: %v\", strings.Join(targets, \" => \"))\n\t\t}\n\t\tfor _, target := range targets {\n\t\t\tif found[target] {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tfound[target] = true\n\t\t\tfilenames = append(filenames, target)\n\t\t}\n\t}\n\treturn filenames, nil\n}\n\n// Locate finds the specified pattern at the specified root.\n// If the file is a symlink, the link is resolved and the target returned.\nfunc (p symlink) Locate(pattern string) ([]string, error) {\n\tcandidates, err := p.locator.Locate(pattern)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar targets []string\n\tfor _, candidate := range candidates {\n\t\ttarget, err := filepath.EvalSymlinks(candidate)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to resolve link: %w\", err)\n\t\t}\n\t\ttargets = append(targets, target)\n\t}\n\treturn targets, err\n}\n"
},
{
"path": "pkg/nvcdi/api.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/spec\"\n)\n\n// Interface defines the API for the nvcdi package\ntype Interface interface {\n\tSpecGenerator\n\tGetCommonEdits() (*cdi.ContainerEdits, error)\n\tGetDeviceSpecsByID(...string) ([]specs.Device, error)\n\t// Deprecated: GetAllDeviceSpecs is deprecated. Use GetDeviceSpecsByID(\"all\") instead.\n\tGetAllDeviceSpecs() ([]specs.Device, error)\n}\n\n// A SpecGenerator is used to generate a complete CDI spec for a collected set\n// of devices.\ntype SpecGenerator interface {\n\tGetSpec(...string) (spec.Interface, error)\n}\n\n// A DeviceSpecGenerator is used to generate the specs for one or more devices.\ntype DeviceSpecGenerator interface {\n\tGetDeviceSpecs() ([]specs.Device, error)\n}\n\n// A HookName represents one of the predefined NVIDIA CDI hooks.\ntype HookName = discover.HookName\n\nconst (\n\t// AllHooks is a special hook name that allows all hooks to be matched.\n\tAllHooks = discover.AllHooks\n\n\t// A CreateSymlinksHook is used to create symlinks in the container.\n\tCreateSymlinksHook = discover.CreateSymlinksHook\n\t// DisableDeviceNodeModificationHook refers to the hook used to ensure that\n\t// device nodes are not created by libnvidia-ml.so or nvidia-smi in a\n\t// container.\n\t// Added in v1.17.8\n\tDisableDeviceNodeModificationHook = discover.DisableDeviceNodeModificationHook\n\t// An EnableCudaCompatHook is used to enabled CUDA Forward Compatibility.\n\t// Added in v1.17.5\n\tEnableCudaCompatHook = discover.EnableCudaCompatHook\n\t// An UpdateLDCacheHook is used to update the ldcache in the container.\n\tUpdateLDCacheHook = discover.UpdateLDCacheHook\n\n\t// Deprecated: Use CreateSymlinksHook instead.\n\tHookCreateSymlinks = CreateSymlinksHook\n\t// Deprecated: Use EnableCudaCompatHook instead.\n\tHookEnableCudaCompat = EnableCudaCompatHook\n\t// Deprecated: Use UpdateLDCacheHook instead.\n\tHookUpdateLDCache = UpdateLDCacheHook\n)\n\n// A FeatureFlag refers to a specific feature that can be toggled in the CDI api.\n// All features are off by default.\ntype FeatureFlag string\n\nconst (\n\t// FeatureEnableExplicitDriverLibraries enables the inclusion of a list of\n\t// explicit driver libraries.\n\tFeatureEnableExplicitDriverLibraries = FeatureFlag(\"enable-explicit-driver-libraries\")\n\n\t// FeatureDisableNvsandboxUtils disables the use of nvsandboxutils when\n\t// querying devices.\n\tFeatureDisableNvsandboxUtils = FeatureFlag(\"disable-nvsandboxutils\")\n\n\t// FeatureEnableCoherentAnnotations enables the addition of annotations\n\t// coherent or non-coherent devices.\n\tFeatureEnableCoherentAnnotations = FeatureFlag(\"enable-coherent-annotations\")\n\n\t// FeatureDisableMultipleCSVDevices disables the handling of multiple devices\n\t// in CSV mode.\n\tFeatureDisableMultipleCSVDevices = FeatureFlag(\"disable-multiple-csv-devices\")\n\n\t// FeatureNoAdditionalGIDsForDeviceNodes disables the injection of additional GIDs\n\t// for a device node when the node is not readable and writable by the user.\n\tFeatureNoAdditionalGIDsForDeviceNodes = FeatureFlag(\"no-additional-gids-for-device-nodes\")\n)\n"
},
{
"path": "pkg/nvcdi/common-nvml.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\n// newCommonNVMLDiscoverer returns a discoverer for entities that are not associated with a specific CDI device.\n// This includes driver libraries and meta devices, for example.\nfunc (l *nvmllib) newCommonNVMLDiscoverer() (discover.Discover, error) {\n\tmetaDevices := l.controlDeviceNodeDiscoverer()\n\n\tgraphicsMounts, err := discover.NewGraphicsMountsDiscoverer(l.logger, l.driver, l.hookCreator)\n\tif err != nil {\n\t\tl.logger.Warningf(\"failed to create discoverer for graphics mounts: %v\", err)\n\t}\n\n\tdriverFiles, err := l.NewDriverDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for driver files: %v\", err)\n\t}\n\n\td := discover.Merge(\n\t\tmetaDevices,\n\t\tgraphicsMounts,\n\t\tdriverFiles,\n\t)\n\n\treturn d, nil\n}\n\nfunc (l *nvmllib) controlDeviceNodeDiscoverer() discover.Discover {\n\treturn discover.NewCharDeviceDiscoverer(\n\t\tl.logger,\n\t\tl.driver.DevRoot,\n\t\t[]string{\n\t\t\t\"/dev/nvidia-modeset\",\n\t\t\t\"/dev/nvidia-uvm-tools\",\n\t\t\t\"/dev/nvidia-uvm\",\n\t\t\t\"/dev/nvidiactl\",\n\t\t},\n\t)\n}\n"
},
{
"path": "pkg/nvcdi/device-wsl.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\nconst (\n\tdxgDeviceNode = \"/dev/dxg\"\n)\n\n// newDXGDeviceDiscoverer returns a Discoverer for DXG devices under WSL2.\nfunc (l *wsllib) newDXGDeviceDiscoverer() discover.Discover {\n\tdeviceNodes := discover.NewCharDeviceDiscoverer(\n\t\tl.logger,\n\t\tl.driver.DevRoot,\n\t\t[]string{dxgDeviceNode},\n\t)\n\n\treturn deviceNodes\n}\n"
},
{
"path": "pkg/nvcdi/driver-nvml.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"golang.org/x/sys/unix\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\n// NewDriverDiscoverer creates a discoverer for the libraries and binaries associated with a driver installation.\n// The supplied NVML Library is used to query the expected driver version.\nfunc (l *nvmllib) NewDriverDiscoverer() (discover.Discover, error) {\n\treturn (*nvcdilib)(l).newDriverVersionDiscoverer()\n}\n\nfunc (l *nvcdilib) newDriverVersionDiscoverer() (discover.Discover, error) {\n\tversion, err := l.driver.Version()\n\tif err != nil || version == \"\" || version == \"*.*\" {\n\t\treturn nil, fmt.Errorf(\"failed to determine driver version (%q): %w\", version, err)\n\t}\n\n\tlibcudasoParentDirPath, err := l.driver.GetDriverLibDirectory()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get libcuda.so parent path: %w\", err)\n\t}\n\n\tlibraries, err := l.NewDriverLibraryDiscoverer(version, libcudasoParentDirPath)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for driver libraries: %v\", err)\n\t}\n\n\tipcs, err := discover.NewIPCDiscoverer(l.logger, l.driver.Root)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for IPC sockets: %v\", err)\n\t}\n\n\tfirmwares, err := l.newDriverFirmwareDiscoverer(version)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for GSP firmware: %v\", err)\n\t}\n\n\tbinaries := l.newDriverBinariesDiscoverer()\n\n\td := discover.Merge(\n\t\tlibraries,\n\t\tipcs,\n\t\tfirmwares,\n\t\tbinaries,\n\t)\n\n\treturn d, nil\n}\n\n// NewDriverLibraryDiscoverer creates a discoverer for the libraries associated with the specified driver version.\nfunc (l *nvcdilib) NewDriverLibraryDiscoverer(version string, libcudaSoParentDirPath string) (discover.Discover, error) {\n\tversionSuffixLibraryMounts, err := l.getVersionSuffixDriverLibraryMounts(version)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\texplicitLibraryMounts, err := l.getExplicitDriverLibraryMounts()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tlibraries := discover.Merge(\n\t\tversionSuffixLibraryMounts,\n\t\texplicitLibraryMounts,\n\t)\n\n\tvar discoverers []discover.Discover\n\n\tdriverDotSoSymlinksDiscoverer := discover.WithDriverDotSoSymlinks(\n\t\tl.logger,\n\t\tlibraries,\n\t\t// Since we don't only match version suffixes, we now need to match on wildcards.\n\t\t\"\",\n\t\tl.hookCreator,\n\t)\n\tdiscoverers = append(discoverers, driverDotSoSymlinksDiscoverer)\n\n\tcudaCompatLibHookDiscoverer := discover.NewCUDACompatHookDiscoverer(l.logger, l.hookCreator, &discover.EnableCUDACompatHookOptions{HostDriverVersion: version})\n\tdiscoverers = append(discoverers, cudaCompatLibHookDiscoverer)\n\n\tupdateLDCache, _ := discover.NewLDCacheUpdateHook(l.logger, libraries, l.hookCreator)\n\tdiscoverers = append(discoverers, updateLDCache)\n\n\tdisableDeviceNodeModification := l.hookCreator.Create(DisableDeviceNodeModificationHook)\n\tdiscoverers = append(discoverers, disableDeviceNodeModification)\n\n\tdriverLibDirectory, err := l.driver.GetDriverLibDirectory()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get libcuda.so parent directory path: %w\", err)\n\t}\n\tenvironmentVariable := &discover.EnvVar{\n\t\tName: \"NVIDIA_CTK_LIBCUDA_DIR\",\n\t\tValue: driverLibDirectory,\n\t}\n\tdiscoverers = append(discoverers, environmentVariable)\n\n\td := discover.Merge(discoverers...)\n\n\treturn d, nil\n}\n\nfunc (l *nvcdilib) getVersionSuffixDriverLibraryMounts(version string) (discover.Discover, error) {\n\tversionSuffixLibraryPaths, err := l.getVersionLibs(version)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get libraries for driver version: %v\", err)\n\t}\n\n\tmounts := discover.NewMounts(\n\t\tl.logger,\n\t\tlookup.NewFileLocator(\n\t\t\tlookup.WithLogger(l.logger),\n\t\t\tlookup.WithRoot(l.driver.Root),\n\t\t),\n\t\tl.driver.Root,\n\t\tversionSuffixLibraryPaths,\n\t)\n\n\treturn mounts, nil\n}\n\nfunc (l *nvcdilib) getExplicitDriverLibraryMounts() (discover.Discover, error) {\n\tif !l.featureFlags[FeatureEnableExplicitDriverLibraries] {\n\t\treturn nil, nil\n\t}\n\n\t// List of explicit libraries to locate\n\t// TODO(ArangoGutierrez): we should load the version of the libraries from\n\t// the sandboxutils-filelist or have a way to allow users to specify the\n\t// libraries to mount from the config file.\n\texplicitLibraries := []string{\n\t\t\"libEGL.so\",\n\t\t\"libGL.so\",\n\t\t\"libGLESv1_CM.so\",\n\t\t\"libGLESv2.so\",\n\t\t\"libGLX.so\",\n\t\t\"libGLdispatch.so\",\n\t\t\"libOpenCL.so\",\n\t\t\"libOpenGL.so\",\n\t\t\"libnvidia-api.so\",\n\t\t\"libnvidia-egl-xcb.so\",\n\t\t\"libnvidia-egl-xlib.so\",\n\t}\n\n\tdriverLibraryLocator, err := l.driver.DriverLibraryLocator()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get driver library locator: %w\", err)\n\t}\n\tmounts := discover.NewMounts(\n\t\tl.logger,\n\t\tdriverLibraryLocator,\n\t\tl.driver.Root,\n\t\texplicitLibraries,\n\t)\n\n\treturn mounts, nil\n\n}\n\nfunc getUTSRelease() (string, error) {\n\tutsname := &unix.Utsname{}\n\tif err := unix.Uname(utsname); err != nil {\n\t\treturn \"\", err\n\t}\n\treturn unix.ByteSliceToString(utsname.Release[:]), nil\n}\n\nfunc getFirmwareSearchPaths(logger logger.Interface) ([]string, error) {\n\n\tvar firmwarePaths []string\n\tif p := getCustomFirmwareClassPath(logger); p != \"\" {\n\t\tlogger.Debugf(\"using custom firmware class path: %s\", p)\n\t\tfirmwarePaths = append(firmwarePaths, p)\n\t}\n\n\tutsRelease, err := getUTSRelease()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get UTS_RELEASE: %v\", err)\n\t}\n\n\tstandardPaths := []string{\n\t\tfilepath.Join(\"/lib/firmware/updates/\", utsRelease),\n\t\t\"/lib/firmware/updates/\",\n\t\tfilepath.Join(\"/lib/firmware/\", utsRelease),\n\t\t\"/lib/firmware/\",\n\t}\n\n\treturn append(firmwarePaths, standardPaths...), nil\n}\n\n// getCustomFirmwareClassPath returns the custom firmware class path if it exists.\nfunc getCustomFirmwareClassPath(logger logger.Interface) string {\n\tcustomFirmwareClassPath, err := os.ReadFile(\"/sys/module/firmware_class/parameters/path\")\n\tif err != nil {\n\t\tlogger.Warningf(\"failed to get custom firmware class path: %v\", err)\n\t\treturn \"\"\n\t}\n\n\treturn strings.TrimSpace(string(customFirmwareClassPath))\n}\n\n// newDriverFirmwareDiscoverer creates a discoverer for GSP firmware associated with the specified driver version.\nfunc (l *nvcdilib) newDriverFirmwareDiscoverer(version string) (discover.Discover, error) {\n\tgspFirmwareSearchPaths, err := getFirmwareSearchPaths(l.logger)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get firmware search paths: %v\", err)\n\t}\n\tgspFirmwarePaths := filepath.Join(\"nvidia\", version, \"gsp*.bin\")\n\treturn discover.NewMounts(\n\t\tl.logger,\n\t\tlookup.NewFileLocator(\n\t\t\tlookup.WithLogger(l.logger),\n\t\t\tlookup.WithRoot(l.driver.Root),\n\t\t\tlookup.WithSearchPaths(gspFirmwareSearchPaths...),\n\t\t),\n\t\tl.driver.Root,\n\t\t[]string{gspFirmwarePaths},\n\t), nil\n}\n\n// newDriverBinariesDiscoverer creates a discoverer for GSP firmware associated with the GPU driver.\nfunc (l *nvcdilib) newDriverBinariesDiscoverer() discover.Discover {\n\treturn discover.NewMounts(\n\t\tl.logger,\n\t\tlookup.NewExecutableLocator(l.logger, l.driver.Root),\n\t\tl.driver.Root,\n\t\t[]string{\n\t\t\t\"nvidia-smi\", /* System management interface */\n\t\t\t\"nvidia-debugdump\", /* GPU coredump utility */\n\t\t\t\"nvidia-persistenced\", /* Persistence mode utility */\n\t\t\t\"nvidia-cuda-mps-control\", /* Multi process service CLI */\n\t\t\t\"nvidia-cuda-mps-server\", /* Multi process service server */\n\t\t\t\"nvidia-imex\", /* NVIDIA IMEX Daemon */\n\t\t\t\"nvidia-imex-ctl\", /* NVIDIA IMEX control */\n\t\t},\n\t)\n}\n\n// getVersionLibs checks the LDCache for libraries ending in the specified driver version.\n// Although the ldcache at the specified driverRoot is queried, the paths are returned relative to this driverRoot.\n// This allows the standard mount location logic to be used for resolving the mounts.\nfunc (l *nvcdilib) getVersionLibs(version string) ([]string, error) {\n\tl.logger.Infof(\"Using driver version %v\", version)\n\n\tlibraries, err := l.driver.DriverLibraryLocator(\"vdpau\")\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get driver library locator: %w\", err)\n\t}\n\n\tlibs, err := libraries.Locate(\"*.so.\" + version)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to locate libraries for driver version %v: %v\", version, err)\n\t}\n\n\tif l.driver.Root == \"/\" || l.driver.Root == \"\" {\n\t\treturn libs, nil\n\t}\n\n\tvar relative []string\n\tfor _, lib := range libs {\n\t\trelative = append(relative, strings.TrimPrefix(lib, l.driver.Root))\n\t}\n\n\treturn relative, nil\n}\n"
},
{
"path": "pkg/nvcdi/driver-wsl.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/dxcore\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n)\n\nvar requiredDriverStoreFiles = []string{\n\t\"libcuda.so.1.1\", /* Core library for cuda support */\n\t\"libcuda_loader.so\", /* Core library for cuda support on WSL */\n\t\"libnvidia-ptxjitcompiler.so.1\", /* Core library for PTX Jit support */\n\t\"libnvidia-ml.so.1\", /* Core library for nvml */\n\t\"libnvidia-ml_loader.so\", /* Core library for nvml on WSL */\n\t\"libdxcore.so\", /* Core library for dxcore support */\n\t\"libnvdxgdmal.so.1\", /* dxgdmal library for cuda */\n\t\"nvcubins.bin\", /* Binary containing GPU code for cuda */\n\t\"nvidia-smi\", /* nvidia-smi binary*/\n}\n\n// newWSLDriverDiscoverer returns a Discoverer for WSL2 drivers.\nfunc (l *wsllib) newWSLDriverDiscoverer() (discover.Discover, error) {\n\tif err := dxcore.Init(); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to initialize dxcore: %w\", err)\n\t}\n\tdefer func() {\n\t\tif err := dxcore.Shutdown(); err != nil {\n\t\t\tl.logger.Warningf(\"failed to shutdown dxcore: %w\", err)\n\t\t}\n\t}()\n\n\tdriverStorePaths := dxcore.GetDriverStorePaths()\n\tif len(driverStorePaths) == 0 {\n\t\treturn nil, fmt.Errorf(\"no driver store paths found\")\n\t}\n\tif len(driverStorePaths) > 1 {\n\t\tl.logger.Warningf(\"Found multiple driver store paths: %v\", driverStorePaths)\n\t}\n\tl.logger.Infof(\"Using WSL driver store paths: %v\", driverStorePaths)\n\n\tdriverStorePaths = append(driverStorePaths, \"/usr/lib/wsl/lib\")\n\n\tdriverStoreMounts := discover.NewMounts(\n\t\tl.logger,\n\t\tlookup.NewFileLocator(\n\t\t\tlookup.WithLogger(l.logger),\n\t\t\tlookup.WithSearchPaths(\n\t\t\t\tdriverStorePaths...,\n\t\t\t),\n\t\t\tlookup.WithCount(1),\n\t\t),\n\t\tl.driver.Root,\n\t\trequiredDriverStoreFiles,\n\t)\n\n\tsymlinkHook := nvidiaSMISimlinkHook{\n\t\tlogger: l.logger,\n\t\tmountsFrom: driverStoreMounts,\n\t\thookCreator: l.hookCreator,\n\t}\n\n\tldcacheHook, _ := discover.NewLDCacheUpdateHook(l.logger, driverStoreMounts, l.hookCreator)\n\n\td := discover.Merge(\n\t\tdriverStoreMounts,\n\t\tsymlinkHook,\n\t\tldcacheHook,\n\t)\n\n\treturn d, nil\n}\n\ntype nvidiaSMISimlinkHook struct {\n\tdiscover.None\n\tlogger logger.Interface\n\tmountsFrom discover.Discover\n\thookCreator discover.HookCreator\n}\n\n// Hooks returns a hook that creates a symlink to nvidia-smi in the driver store.\n// On WSL2 the driver store location is used unchanged, for this reason we need\n// to create a symlink from /usr/bin/nvidia-smi to the nvidia-smi binary in the\n// driver store.\nfunc (m nvidiaSMISimlinkHook) Hooks() ([]discover.Hook, error) {\n\tmounts, err := m.mountsFrom.Mounts()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to discover mounts: %w\", err)\n\t}\n\n\tvar target string\n\tfor _, mount := range mounts {\n\t\tif filepath.Base(mount.Path) == \"nvidia-smi\" {\n\t\t\ttarget = mount.Path\n\t\t\tbreak\n\t\t}\n\t}\n\n\tif target == \"\" {\n\t\tm.logger.Warningf(\"Failed to find nvidia-smi in mounts: %v\", mounts)\n\t\treturn nil, nil\n\t}\n\tlink := \"/usr/bin/nvidia-smi\"\n\tlinks := []string{fmt.Sprintf(\"%s::%s\", target, link)}\n\tsymlinkHook := m.hookCreator.Create(CreateSymlinksHook, links...)\n\n\treturn symlinkHook.Hooks()\n}\n"
},
{
"path": "pkg/nvcdi/driver-wsl_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n)\n\nfunc TestNvidiaSMISymlinkHook(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\thookCreator := discover.NewHookCreator()\n\n\terrMounts := errors.New(\"mounts error\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tmounts discover.Discover\n\t\texpectedError error\n\t\texpectedHooks []discover.Hook\n\t}{\n\t\t{\n\t\t\tdescription: \"mounts error is returned\",\n\t\t\tmounts: &discover.DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]discover.Mount, error) {\n\t\t\t\t\treturn nil, errMounts\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: errMounts,\n\t\t},\n\t\t{\n\t\t\tdescription: \"no mounts returns no hooks\",\n\t\t\tmounts: &discover.DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]discover.Mount, error) {\n\t\t\t\t\treturn nil, nil\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"no nvidia-smi returns no hooks\",\n\t\t\tmounts: &discover.DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]discover.Mount, error) {\n\t\t\t\t\tmounts := []discover.Mount{\n\t\t\t\t\t\t{Path: \"/not-nvidia-smi\"},\n\t\t\t\t\t\t{Path: \"/also-not-nvidia-smi\"},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"nvidia-smi must be in path\",\n\t\t\tmounts: &discover.DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]discover.Mount, error) {\n\t\t\t\t\tmounts := []discover.Mount{\n\t\t\t\t\t\t{Path: \"/not-nvidia-smi\", HostPath: \"nvidia-smi\"},\n\t\t\t\t\t\t{Path: \"/also-not-nvidia-smi\", HostPath: \"not-nvidia-smi\"},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"nvidia-smi returns hook\",\n\t\t\tmounts: &discover.DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]discover.Mount, error) {\n\t\t\t\t\tmounts := []discover.Mount{\n\t\t\t\t\t\t{Path: \"nvidia-smi\"},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []discover.Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\",\n\t\t\t\t\t\t\"--link\", \"nvidia-smi::/usr/bin/nvidia-smi\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"checks basename\",\n\t\t\tmounts: &discover.DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]discover.Mount, error) {\n\t\t\t\t\tmounts := []discover.Mount{\n\t\t\t\t\t\t{Path: \"/some/path/nvidia-smi\"},\n\t\t\t\t\t\t{Path: \"/nvidia-smi/but-not\"},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []discover.Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\",\n\t\t\t\t\t\t\"--link\", \"/some/path/nvidia-smi::/usr/bin/nvidia-smi\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"returns first match\",\n\t\t\tmounts: &discover.DiscoverMock{\n\t\t\t\tMountsFunc: func() ([]discover.Mount, error) {\n\t\t\t\t\tmounts := []discover.Mount{\n\t\t\t\t\t\t{Path: \"/some/path/nvidia-smi\"},\n\t\t\t\t\t\t{Path: \"/another/path/nvidia-smi\"},\n\t\t\t\t\t}\n\t\t\t\t\treturn mounts, nil\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedHooks: []discover.Hook{\n\t\t\t\t{\n\t\t\t\t\tLifecycle: \"createContainer\",\n\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\",\n\t\t\t\t\t\t\"--link\", \"/some/path/nvidia-smi::/usr/bin/nvidia-smi\"},\n\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tm := nvidiaSMISimlinkHook{\n\t\t\t\tlogger: logger,\n\t\t\t\tmountsFrom: tc.mounts,\n\t\t\t\thookCreator: hookCreator,\n\t\t\t}\n\n\t\t\tdevices, err := m.Devices()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, devices)\n\n\t\t\tmounts, err := m.Mounts()\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Empty(t, mounts)\n\n\t\t\thooks, err := m.Hooks()\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\trequire.Equal(t, tc.expectedHooks, hooks)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/full-gpu-nvml.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/dgpu\"\n)\n\n// A fullGPUDeviceSpecGenerator generates the CDI device specifications for a\n// single full GPU.\ntype fullGPUDeviceSpecGenerator struct {\n\t*nvmllib\n\tuuid string\n\tindex int\n\n\tfeatureFlags map[FeatureFlag]bool\n\tadditionalDiscoverers []discover.Discover\n}\n\nvar _ DeviceSpecGenerator = (*fullGPUDeviceSpecGenerator)(nil)\n\nfunc (l *fullGPUDeviceSpecGenerator) GetUUID() (string, error) {\n\treturn l.uuid, nil\n}\n\nfunc (l *nvmllib) newFullGPUDeviceSpecGeneratorFromDevice(index int, d device.Device, featureFlags map[FeatureFlag]bool) (*fullGPUDeviceSpecGenerator, error) {\n\tuuid, ret := d.GetUUID()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to get device UUID: %v\", ret)\n\t}\n\te := &fullGPUDeviceSpecGenerator{\n\t\tnvmllib: l,\n\t\tuuid: uuid,\n\t\tindex: index,\n\n\t\tfeatureFlags: featureFlags,\n\t}\n\n\treturn e, nil\n}\n\nfunc (l *nvmllib) newFullGPUDeviceSpecGeneratorFromNVMLDevice(uuid string, nvmlDevice nvml.Device, featureFlags map[FeatureFlag]bool) (DeviceSpecGenerator, error) {\n\tindex, ret := nvmlDevice.GetIndex()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to get device index: %v\", ret)\n\t}\n\n\te := &fullGPUDeviceSpecGenerator{\n\t\tnvmllib: l,\n\t\tuuid: uuid,\n\t\tindex: index,\n\n\t\tfeatureFlags: featureFlags,\n\t}\n\treturn e, nil\n}\n\nfunc (l *fullGPUDeviceSpecGenerator) GetDeviceSpecs() ([]specs.Device, error) {\n\tdeviceEdits, err := l.getDeviceEdits()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get CDI device edits: %w\", err)\n\t}\n\n\tnames, err := l.getNames()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get device names: %w\", err)\n\t}\n\n\tannotations, err := l.getDeviceAnnotations()\n\tif err != nil {\n\t\tl.logger.Warningf(\"Ignoring error getting device annotations for device(s) %v: %v\", names, err)\n\t\tannotations = nil\n\t}\n\tvar deviceSpecs []specs.Device\n\tfor _, name := range names {\n\t\tdeviceSpec := specs.Device{\n\t\t\tName: name,\n\t\t\tContainerEdits: *deviceEdits.ContainerEdits,\n\t\t\tAnnotations: annotations,\n\t\t}\n\t\tdeviceSpecs = append(deviceSpecs, deviceSpec)\n\t}\n\n\treturn deviceSpecs, nil\n}\n\nfunc (l *fullGPUDeviceSpecGenerator) device() (device.Device, error) {\n\treturn l.devicelib.NewDeviceByUUID(l.uuid)\n}\n\nfunc (l *fullGPUDeviceSpecGenerator) getDeviceAnnotations() (map[string]string, error) {\n\tif !l.featureFlags[FeatureEnableCoherentAnnotations] {\n\t\treturn nil, nil\n\t}\n\n\tdevice, err := l.device()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// TODO: Should we distinguish between not-supported and disabled?\n\tisCoherent, err := device.IsCoherent()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to check device coherence: %w\", err)\n\t}\n\n\tannotations := map[string]string{\n\t\t\"gpu.nvidia.com/coherent\": fmt.Sprintf(\"%v\", isCoherent),\n\t}\n\n\treturn annotations, nil\n}\n\n// GetGPUDeviceEdits returns the CDI edits for the full GPU represented by 'device'.\nfunc (l *fullGPUDeviceSpecGenerator) getDeviceEdits() (*cdi.ContainerEdits, error) {\n\tdevice, err := l.device()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tdeviceDiscoverer, err := l.newFullGPUDiscoverer(device)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create device discoverer: %v\", err)\n\t}\n\teditsForDevice, err := l.editsFactory.FromDiscoverer(deviceDiscoverer)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create container edits for device: %v\", err)\n\t}\n\n\treturn editsForDevice, nil\n}\n\nfunc (l *fullGPUDeviceSpecGenerator) getNames() ([]string, error) {\n\treturn l.deviceNamers.GetDeviceNames(l.index, l)\n}\n\n// newFullGPUDiscoverer creates a discoverer for the full GPU defined by the specified device.\nfunc (l *fullGPUDeviceSpecGenerator) newFullGPUDiscoverer(d device.Device) (discover.Discover, error) {\n\tdeviceNodes, err := dgpu.NewForDevice(d,\n\t\tdgpu.WithDriver(l.driver),\n\t\tdgpu.WithLogger(l.logger),\n\t\tdgpu.WithHookCreator(l.hookCreator),\n\t\tdgpu.WithNvsandboxuitilsLib(l.nvsandboxutilslib),\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create device discoverer: %v\", err)\n\t}\n\n\tdeviceFolderPermissionHooks := (*nvcdilib)(l.nvmllib).newDeviceFolderPermissionHookDiscoverer(\n\t\tdeviceNodes,\n\t)\n\n\tvar discoverers []discover.Discover\n\n\tdiscoverers = append(discoverers,\n\t\tdeviceNodes,\n\t\tdeviceFolderPermissionHooks,\n\t)\n\n\tdiscoverers = append(discoverers, l.additionalDiscoverers...)\n\n\tdd := discover.Merge(\n\t\tdiscoverers...,\n\t)\n\n\treturn dd, nil\n}\n"
},
{
"path": "pkg/nvcdi/gated.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\ntype gatedlib struct {\n\t*nvcdilib\n\tmode Mode\n}\n\nvar _ deviceSpecGeneratorFactory = (*gatedlib)(nil)\n\nfunc (l *gatedlib) DeviceSpecGenerators(...string) (DeviceSpecGenerator, error) {\n\treturn l, nil\n}\n\n// GetDeviceSpecs returns the CDI device specs for a single all device.\nfunc (l *gatedlib) GetDeviceSpecs() ([]specs.Device, error) {\n\tdiscoverer, err := l.getModeDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for mode %q: %w\", l.mode, err)\n\t}\n\tedits, err := l.editsFactory.FromDiscoverer(discoverer)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create container edits: %w\", err)\n\t}\n\n\tdeviceSpec := specs.Device{\n\t\tName: \"all\",\n\t\tContainerEdits: *edits.ContainerEdits,\n\t}\n\n\treturn []specs.Device{deviceSpec}, nil\n}\n\nfunc (l *gatedlib) getModeDiscoverer() (discover.Discover, error) {\n\tswitch l.mode {\n\tcase ModeGdrcopy:\n\t\treturn discover.NewGDRCopyDiscoverer(l.logger, l.driver)\n\tcase ModeGds:\n\t\treturn discover.NewGDSDiscoverer(l.logger, l.driver)\n\tcase ModeMofed:\n\t\treturn discover.NewMOFEDDiscoverer(l.logger, l.driver)\n\tcase ModeNvswitch:\n\t\treturn discover.NewNvSwitchDiscoverer(l.logger, l.driver)\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"unrecognized mode\")\n\t}\n}\n\n// GetCommonEdits generates a CDI specification that can be used for ANY devices\nfunc (l *gatedlib) GetCommonEdits() (*cdi.ContainerEdits, error) {\n\treturn l.editsFactory.FromDiscoverer(discover.None{})\n}\n"
},
{
"path": "pkg/nvcdi/info-interface_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage nvcdi\n\nimport (\n\t\"sync\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/info\"\n)\n\n// Ensure, that infoInterfaceMock does implement infoInterface.\n// If this is not the case, regenerate this file with moq.\nvar _ infoInterface = &infoInterfaceMock{}\n\n// infoInterfaceMock is a mock implementation of infoInterface.\n//\n//\tfunc TestSomethingThatUsesinfoInterface(t *testing.T) {\n//\n//\t\t// make and configure a mocked infoInterface\n//\t\tmockedinfoInterface := &infoInterfaceMock{\n//\t\t\tHasAnIntegratedGPUFunc: func() (bool, string) {\n//\t\t\t\tpanic(\"mock out the HasAnIntegratedGPU method\")\n//\t\t\t},\n//\t\t\tHasDXCoreFunc: func() (bool, string) {\n//\t\t\t\tpanic(\"mock out the HasDXCore method\")\n//\t\t\t},\n//\t\t\tHasNvmlFunc: func() (bool, string) {\n//\t\t\t\tpanic(\"mock out the HasNvml method\")\n//\t\t\t},\n//\t\t\tHasTegraFilesFunc: func() (bool, string) {\n//\t\t\t\tpanic(\"mock out the HasTegraFiles method\")\n//\t\t\t},\n//\t\t\tResolvePlatformFunc: func() info.Platform {\n//\t\t\t\tpanic(\"mock out the ResolvePlatform method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedinfoInterface in code that requires infoInterface\n//\t\t// and then make assertions.\n//\n//\t}\ntype infoInterfaceMock struct {\n\t// HasAnIntegratedGPUFunc mocks the HasAnIntegratedGPU method.\n\tHasAnIntegratedGPUFunc func() (bool, string)\n\n\t// HasDXCoreFunc mocks the HasDXCore method.\n\tHasDXCoreFunc func() (bool, string)\n\n\t// HasNvmlFunc mocks the HasNvml method.\n\tHasNvmlFunc func() (bool, string)\n\n\t// HasTegraFilesFunc mocks the HasTegraFiles method.\n\tHasTegraFilesFunc func() (bool, string)\n\n\t// ResolvePlatformFunc mocks the ResolvePlatform method.\n\tResolvePlatformFunc func() info.Platform\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// HasAnIntegratedGPU holds details about calls to the HasAnIntegratedGPU method.\n\t\tHasAnIntegratedGPU []struct {\n\t\t}\n\t\t// HasDXCore holds details about calls to the HasDXCore method.\n\t\tHasDXCore []struct {\n\t\t}\n\t\t// HasNvml holds details about calls to the HasNvml method.\n\t\tHasNvml []struct {\n\t\t}\n\t\t// HasTegraFiles holds details about calls to the HasTegraFiles method.\n\t\tHasTegraFiles []struct {\n\t\t}\n\t\t// ResolvePlatform holds details about calls to the ResolvePlatform method.\n\t\tResolvePlatform []struct {\n\t\t}\n\t}\n\tlockHasAnIntegratedGPU sync.RWMutex\n\tlockHasDXCore sync.RWMutex\n\tlockHasNvml sync.RWMutex\n\tlockHasTegraFiles sync.RWMutex\n\tlockResolvePlatform sync.RWMutex\n}\n\n// HasAnIntegratedGPU calls HasAnIntegratedGPUFunc.\nfunc (mock *infoInterfaceMock) HasAnIntegratedGPU() (bool, string) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockHasAnIntegratedGPU.Lock()\n\tmock.calls.HasAnIntegratedGPU = append(mock.calls.HasAnIntegratedGPU, callInfo)\n\tmock.lockHasAnIntegratedGPU.Unlock()\n\tif mock.HasAnIntegratedGPUFunc == nil {\n\t\tvar (\n\t\t\tbOut bool\n\t\t\tsOut string\n\t\t)\n\t\treturn bOut, sOut\n\t}\n\treturn mock.HasAnIntegratedGPUFunc()\n}\n\n// HasAnIntegratedGPUCalls gets all the calls that were made to HasAnIntegratedGPU.\n// Check the length with:\n//\n//\tlen(mockedinfoInterface.HasAnIntegratedGPUCalls())\nfunc (mock *infoInterfaceMock) HasAnIntegratedGPUCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockHasAnIntegratedGPU.RLock()\n\tcalls = mock.calls.HasAnIntegratedGPU\n\tmock.lockHasAnIntegratedGPU.RUnlock()\n\treturn calls\n}\n\n// HasDXCore calls HasDXCoreFunc.\nfunc (mock *infoInterfaceMock) HasDXCore() (bool, string) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockHasDXCore.Lock()\n\tmock.calls.HasDXCore = append(mock.calls.HasDXCore, callInfo)\n\tmock.lockHasDXCore.Unlock()\n\tif mock.HasDXCoreFunc == nil {\n\t\tvar (\n\t\t\tbOut bool\n\t\t\tsOut string\n\t\t)\n\t\treturn bOut, sOut\n\t}\n\treturn mock.HasDXCoreFunc()\n}\n\n// HasDXCoreCalls gets all the calls that were made to HasDXCore.\n// Check the length with:\n//\n//\tlen(mockedinfoInterface.HasDXCoreCalls())\nfunc (mock *infoInterfaceMock) HasDXCoreCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockHasDXCore.RLock()\n\tcalls = mock.calls.HasDXCore\n\tmock.lockHasDXCore.RUnlock()\n\treturn calls\n}\n\n// HasNvml calls HasNvmlFunc.\nfunc (mock *infoInterfaceMock) HasNvml() (bool, string) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockHasNvml.Lock()\n\tmock.calls.HasNvml = append(mock.calls.HasNvml, callInfo)\n\tmock.lockHasNvml.Unlock()\n\tif mock.HasNvmlFunc == nil {\n\t\tvar (\n\t\t\tbOut bool\n\t\t\tsOut string\n\t\t)\n\t\treturn bOut, sOut\n\t}\n\treturn mock.HasNvmlFunc()\n}\n\n// HasNvmlCalls gets all the calls that were made to HasNvml.\n// Check the length with:\n//\n//\tlen(mockedinfoInterface.HasNvmlCalls())\nfunc (mock *infoInterfaceMock) HasNvmlCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockHasNvml.RLock()\n\tcalls = mock.calls.HasNvml\n\tmock.lockHasNvml.RUnlock()\n\treturn calls\n}\n\n// HasTegraFiles calls HasTegraFilesFunc.\nfunc (mock *infoInterfaceMock) HasTegraFiles() (bool, string) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockHasTegraFiles.Lock()\n\tmock.calls.HasTegraFiles = append(mock.calls.HasTegraFiles, callInfo)\n\tmock.lockHasTegraFiles.Unlock()\n\tif mock.HasTegraFilesFunc == nil {\n\t\tvar (\n\t\t\tbOut bool\n\t\t\tsOut string\n\t\t)\n\t\treturn bOut, sOut\n\t}\n\treturn mock.HasTegraFilesFunc()\n}\n\n// HasTegraFilesCalls gets all the calls that were made to HasTegraFiles.\n// Check the length with:\n//\n//\tlen(mockedinfoInterface.HasTegraFilesCalls())\nfunc (mock *infoInterfaceMock) HasTegraFilesCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockHasTegraFiles.RLock()\n\tcalls = mock.calls.HasTegraFiles\n\tmock.lockHasTegraFiles.RUnlock()\n\treturn calls\n}\n\n// ResolvePlatform calls ResolvePlatformFunc.\nfunc (mock *infoInterfaceMock) ResolvePlatform() info.Platform {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockResolvePlatform.Lock()\n\tmock.calls.ResolvePlatform = append(mock.calls.ResolvePlatform, callInfo)\n\tmock.lockResolvePlatform.Unlock()\n\tif mock.ResolvePlatformFunc == nil {\n\t\tvar (\n\t\t\tplatformOut info.Platform\n\t\t)\n\t\treturn platformOut\n\t}\n\treturn mock.ResolvePlatformFunc()\n}\n\n// ResolvePlatformCalls gets all the calls that were made to ResolvePlatform.\n// Check the length with:\n//\n//\tlen(mockedinfoInterface.ResolvePlatformCalls())\nfunc (mock *infoInterfaceMock) ResolvePlatformCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockResolvePlatform.RLock()\n\tcalls = mock.calls.ResolvePlatform\n\tmock.lockResolvePlatform.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "pkg/nvcdi/lib-csv.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\t\"slices\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/info\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"github.com/google/uuid\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra\"\n)\n\nconst (\n\tdefaultOrinCompatContainerRoot = \"/usr/local/cuda/compat_orin\"\n)\n\ntype csvOptions struct {\n\tFiles []string\n\tIgnorePatterns []string\n\tCompatContainerRoot string\n}\n\ntype csvlib nvcdilib\ntype mixedcsvlib nvcdilib\n\nvar _ deviceSpecGeneratorFactory = (*csvlib)(nil)\n\n// DeviceSpecGenerators creates a set of generators for the specified set of\n// devices.\n// If NVML is not available or the disable-multiple-csv-devices feature flag is\n// enabled, a single device is assumed.\nfunc (l *csvlib) DeviceSpecGenerators(ids ...string) (DeviceSpecGenerator, error) {\n\tif l.usePureCSVDeviceSpecGenerator() {\n\t\treturn l.purecsvDeviceSpecGenerators(ids...)\n\t}\n\tmixed, err := l.mixedDeviceSpecGenerators(ids...)\n\tif err != nil {\n\t\tl.logger.Warningf(\"Failed to create mixed CSV spec generator; falling back to pure CSV implementation: %v\", err)\n\t\treturn l.purecsvDeviceSpecGenerators(ids...)\n\t}\n\treturn mixed, nil\n}\n\nfunc (l *csvlib) usePureCSVDeviceSpecGenerator() bool {\n\tif l.featureFlags[FeatureDisableMultipleCSVDevices] {\n\t\treturn true\n\t}\n\thasNVML, _ := l.infolib.HasNvml()\n\tif !hasNVML {\n\t\treturn true\n\t}\n\tasNvmlLib := (*nvmllib)(l)\n\terr := asNvmlLib.init()\n\tif err != nil {\n\t\treturn true\n\t}\n\tdefer asNvmlLib.tryShutdown()\n\n\tnumDevices, ret := l.nvmllib.DeviceGetCount()\n\tif ret != nvml.SUCCESS {\n\t\treturn true\n\t}\n\n\treturn numDevices <= 1\n}\n\nfunc (l *csvlib) purecsvDeviceSpecGenerators(ids ...string) (DeviceSpecGenerator, error) {\n\tfor _, id := range ids {\n\t\tswitch id {\n\t\tcase \"all\":\n\t\tcase \"0\":\n\t\tdefault:\n\t\t\treturn nil, fmt.Errorf(\"unsupported device id: %v\", id)\n\t\t}\n\t}\n\tg := &csvDeviceGenerator{\n\t\tcsvlib: l,\n\t\tindex: 0,\n\t\tuuid: \"\",\n\t}\n\treturn g, nil\n}\n\nfunc (l *csvlib) mixedDeviceSpecGenerators(ids ...string) (DeviceSpecGenerator, error) {\n\treturn (*mixedcsvlib)(l).DeviceSpecGenerators(ids...)\n}\n\n// A csvDeviceGenerator generates CDI specs for a device based on a set of\n// platform-specific CSV files.\ntype csvDeviceGenerator struct {\n\t*csvlib\n\tindex int\n\tuuid string\n\tmode csvGeneratorMode\n}\n\ntype csvGeneratorMode string\n\nconst (\n\tiGPUGeneratorMode = csvGeneratorMode(\"igpu\")\n\tdGPUGeneratorMode = csvGeneratorMode(\"dgpu\")\n)\n\nfunc (l *csvDeviceGenerator) GetUUID() (string, error) {\n\treturn l.uuid, nil\n}\n\n// GetDeviceSpecs returns the CDI device specs for a single device.\nfunc (l *csvDeviceGenerator) GetDeviceSpecs() ([]specs.Device, error) {\n\tdeviceNodeDiscoverer, err := l.deviceNodeDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for device nodes from CSV files: %w\", err)\n\t}\n\te, err := l.editsFactory.FromDiscoverer(deviceNodeDiscoverer)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create container edits for CSV files: %w\", err)\n\t}\n\n\tnames, err := l.deviceNamers.GetDeviceNames(l.index, l)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get device name: %w\", err)\n\t}\n\tvar deviceSpecs []specs.Device\n\tfor _, name := range names {\n\t\tdeviceSpec := specs.Device{\n\t\t\tName: name,\n\t\t\tContainerEdits: *e.ContainerEdits,\n\t\t}\n\t\tdeviceSpecs = append(deviceSpecs, deviceSpec)\n\t}\n\n\treturn deviceSpecs, nil\n}\n\n// deviceNodeDiscoverer creates a discoverer for the device nodes associated\n// with the specified device.\n// The CSV mount specs are used as the source for which device nodes are\n// required with the following additions:\n//\n// - Any regular device nodes (i.e. /dev/nvidia[0-9]+) are removed from the\n// input set.\n// - The device node (i.e. /dev/nvidia{{ .index }}) associated with this\n// particular device is added to the set of device nodes to be discovered.\nfunc (l *csvDeviceGenerator) deviceNodeDiscoverer() (discover.Discover, error) {\n\treturn tegra.New(\n\t\ttegra.WithLogger(l.logger),\n\t\ttegra.WithDriver(l.driver),\n\t\ttegra.WithHookCreator(l.hookCreator),\n\t\ttegra.WithLibrarySearchPaths(l.librarySearchPaths...),\n\t\ttegra.WithMountSpecs(l.deviceNodeMountSpecs()),\n\t)\n}\n\nfunc (l *csvDeviceGenerator) deviceNodeMountSpecs() tegra.MountSpecPathsByTyper {\n\tmountSpecs := tegra.Transform(\n\t\ttegra.MountSpecsFromCSVFiles(l.logger, l.csv.Files...),\n\t\t// We remove non-device nodes.\n\t\ttegra.OnlyDeviceNodes(),\n\t)\n\tswitch l.mode {\n\tcase dGPUGeneratorMode:\n\t\treturn tegra.Transform(\n\t\t\tmountSpecs,\n\t\t\t// For a dGPU we remove all regular device nodes (nvidia[0-9]+)\n\t\t\t// from the list of device nodes taken from the CSV mount specs.\n\t\t\t// The device nodes for the GPU are discovered for the full GPU.\n\t\t\ttegra.WithoutRegularDeviceNodes(),\n\t\t\t// We also ignore control device nodes since these are included in\n\t\t\t// the full GPU spec generator.\n\t\t\ttegra.Without(\n\t\t\t\ttegra.DeviceNodes(\n\t\t\t\t\t\"/dev/nvidia-modeset\",\n\t\t\t\t\t\"/dev/nvidia-uvm-tools\",\n\t\t\t\t\t\"/dev/nvidia-uvm\",\n\t\t\t\t\t\"/dev/nvidiactl\",\n\t\t\t\t),\n\t\t\t),\n\t\t)\n\tcase iGPUGeneratorMode:\n\t\treturn tegra.Merge(\n\t\t\ttegra.Transform(\n\t\t\t\tmountSpecs,\n\t\t\t\t// We remove the /dev/nvidia1 device node.\n\t\t\t\t// TODO: This assumes that the dGPU has the index 1 and remove\n\t\t\t\t// it from the set of device nodes.\n\t\t\t\ttegra.Without(tegra.DeviceNodes(\"/dev/nvidia1\")),\n\t\t\t),\n\t\t\t// We add the display device from the iGPU.\n\t\t\ttegra.DeviceNodes(\"/dev/nvidia2\"),\n\t\t)\n\tdefault:\n\t\treturn mountSpecs\n\t}\n}\n\n// GetCommonEdits generates a CDI specification that can be used for ANY devices\n// These explicitly do not include any device nodes.\nfunc (l *csvlib) GetCommonEdits() (*cdi.ContainerEdits, error) {\n\tdriverDiscoverer, err := l.driverDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create driver discoverer from CSV files: %w\", err)\n\t}\n\treturn l.editsFactory.FromDiscoverer(driverDiscoverer)\n}\n\nfunc (l *mixedcsvlib) DeviceSpecGenerators(ids ...string) (DeviceSpecGenerator, error) {\n\tasNvmlLib := (*nvmllib)(l)\n\terr := asNvmlLib.init()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to initialize nvml: %w\", err)\n\t}\n\tdefer asNvmlLib.tryShutdown()\n\n\tif slices.Contains(ids, \"all\") {\n\t\tids, err = l.getAllDeviceIndices()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to get device indices: %w\", err)\n\t\t}\n\t}\n\n\tvar DeviceSpecGenerators DeviceSpecGenerators\n\tfor _, id := range ids {\n\t\tgenerator, err := l.deviceSpecGeneratorForId(device.Identifier(id))\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to create device spec generator for device %q: %w\", id, err)\n\t\t}\n\t\tDeviceSpecGenerators = append(DeviceSpecGenerators, generator)\n\t}\n\n\treturn DeviceSpecGenerators, nil\n}\n\nfunc (l *mixedcsvlib) getAllDeviceIndices() ([]string, error) {\n\tnumDevices, ret := l.nvmllib.DeviceGetCount()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"faled to get device count: %v\", ret)\n\t}\n\n\tvar allIndices []string\n\tfor index := range numDevices {\n\t\tallIndices = append(allIndices, fmt.Sprintf(\"%d\", index))\n\t}\n\treturn allIndices, nil\n}\n\nfunc (l *mixedcsvlib) deviceSpecGeneratorForId(id device.Identifier) (DeviceSpecGenerator, error) {\n\tswitch {\n\tcase id.IsGpuUUID(), isOrinGPUID(id):\n\t\tuuid := string(id)\n\t\tdevice, ret := l.nvmllib.DeviceGetHandleByUUID(uuid)\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn nil, fmt.Errorf(\"failed to get device handle from UUID %q: %v\", uuid, ret)\n\t\t}\n\t\tindex, ret := device.GetIndex()\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn nil, fmt.Errorf(\"failed to get device index: %v\", ret)\n\t\t}\n\t\treturn l.csvDeviceSpecGenerator(index, uuid, device)\n\tcase id.IsGpuIndex():\n\t\tindex, err := strconv.Atoi(string(id))\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to convert device index to an int: %w\", err)\n\t\t}\n\t\tdevice, ret := l.nvmllib.DeviceGetHandleByIndex(index)\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn nil, fmt.Errorf(\"failed to get device handle from index: %v\", ret)\n\t\t}\n\t\tuuid, ret := device.GetUUID()\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn nil, fmt.Errorf(\"failed to get UUID: %v\", ret)\n\t\t}\n\t\treturn l.csvDeviceSpecGenerator(index, uuid, device)\n\tcase id.IsMigUUID():\n\t\tfallthrough\n\tcase id.IsMigIndex():\n\t\treturn nil, fmt.Errorf(\"generating a CDI spec for MIG id %q is not supported in CSV mode\", id)\n\t}\n\treturn nil, fmt.Errorf(\"identifier is not a valid UUID or index: %q\", id)\n}\n\nfunc (l *mixedcsvlib) csvDeviceSpecGenerator(index int, uuid string, device nvml.Device) (DeviceSpecGenerator, error) {\n\tisIntegrated, err := isIntegratedGPU(device)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"is-integrated check failed for device (index=%v,uuid=%v)\", index, uuid)\n\t}\n\n\tif isIntegrated {\n\t\treturn l.iGPUDeviceSpecGenerator(index, uuid)\n\t}\n\n\treturn l.dGPUDeviceSpecGenerator(index, uuid)\n}\n\nfunc (l *mixedcsvlib) dGPUDeviceSpecGenerator(index int, uuid string) (DeviceSpecGenerator, error) {\n\tif index != 1 {\n\t\treturn nil, fmt.Errorf(\"unexpected device index for dGPU: %d\", index)\n\t}\n\tg := &csvDeviceGenerator{\n\t\tcsvlib: (*csvlib)(l),\n\t\tindex: index,\n\t\tuuid: uuid,\n\t\tmode: dGPUGeneratorMode,\n\t}\n\n\tcsvDeviceNodeDiscoverer, err := g.deviceNodeDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for devices nodes: %w\", err)\n\t}\n\n\t// If this is not an integrated GPU, we also create a spec generator for\n\t// the full GPU.\n\tdgpu := (*nvmllib)(l).withInit(&fullGPUDeviceSpecGenerator{\n\t\tnvmllib: (*nvmllib)(l),\n\t\tuuid: uuid,\n\t\tindex: index,\n\t\t// For the CSV case, we include the control device nodes at a\n\t\t// device level.\n\t\tadditionalDiscoverers: []discover.Discover{\n\t\t\t(*nvmllib)(l).controlDeviceNodeDiscoverer(),\n\t\t\tcsvDeviceNodeDiscoverer,\n\t\t},\n\t\tfeatureFlags: l.featureFlags,\n\t})\n\treturn dgpu, nil\n}\n\nfunc (l *mixedcsvlib) iGPUDeviceSpecGenerator(index int, uuid string) (DeviceSpecGenerator, error) {\n\tif index != 0 {\n\t\treturn nil, fmt.Errorf(\"unexpected device index for iGPU: %d\", index)\n\t}\n\tg := &csvDeviceGenerator{\n\t\tcsvlib: (*csvlib)(l),\n\t\tindex: index,\n\t\tuuid: uuid,\n\t\tmode: iGPUGeneratorMode,\n\t}\n\treturn g, nil\n}\n\n// isOrinGPUID returns true if the specified device identifier represents\n// an Orin iGPU uuid (as opposed to a discrete GPU).\n// Based on practical examples, the identifier for an Orin iGPU is a standard\n// hexadecimal UUID in the 8-4-4-4-12 format, whereas discrete GPU UUIDs have\n// the prefix `GPU-` or `MIG-` for full GPUs or MIG devices, respectively. Thor\n// iGPUs follow the same format as discrete GPUs.\nfunc isOrinGPUID(id device.Identifier) bool {\n\t_, err := uuid.Parse(string(id))\n\treturn err == nil\n}\n\n// isIntegratedGPU checks whether the specified device is an integrated GPU.\n// The following heuristic is followed:\n// - If the device does not support getting PCI bus information, we fall back to\n// checking the device name and consider Orin and Thor devices iGPUs.\n// - If the device does support PCI bus information, we check for a specific\n// bus ID that is associated with Thor devices.\n//\n// TODO: This should be replaced by an explicit NVML call once available.\nfunc isIntegratedGPU(d nvml.Device) (bool, error) {\n\tpciInfo, ret := d.GetPciInfo()\n\tif ret == nvml.ERROR_NOT_SUPPORTED {\n\t\tname, ret := d.GetName()\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn false, fmt.Errorf(\"failed to get device name: %v\", ret)\n\t\t}\n\t\treturn info.IsIntegratedGPUName(name), nil\n\t}\n\tif ret != nvml.SUCCESS {\n\t\treturn false, fmt.Errorf(\"failed to get PCI info: %v\", ret)\n\t}\n\n\t// On Thor-based systems, the iGPU always has the PCI bus ID '0000:01:00.0'.\n\t// We explicitly handle this case.\n\tif pciInfo.Domain == 0 && pciInfo.Bus == 1 && pciInfo.Device == 0 {\n\t\treturn true, nil\n\t}\n\treturn false, nil\n}\n\nfunc (l *csvlib) driverDiscoverer() (discover.Discover, error) {\n\tmountSpecs := tegra.Transform(\n\t\ttegra.Transform(\n\t\t\ttegra.MountSpecsFromCSVFiles(l.logger, l.csv.Files...),\n\t\t\ttegra.WithoutDeviceNodes(),\n\t\t),\n\t\ttegra.IgnoreSymlinkMountSpecsByPattern(l.csv.IgnorePatterns...),\n\t)\n\tdriverDiscoverer, err := tegra.New(\n\t\ttegra.WithLogger(l.logger),\n\t\ttegra.WithDriver(l.driver),\n\t\ttegra.WithHookCreator(l.hookCreator),\n\t\ttegra.WithLibrarySearchPaths(l.librarySearchPaths...),\n\t\ttegra.WithMountSpecs(mountSpecs),\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer from CSV files: %w\", err)\n\t}\n\n\tcudaCompatDiscoverer := l.cudaCompatDiscoverer()\n\n\tldcacheUpdateHook, err := discover.NewLDCacheUpdateHook(l.logger, driverDiscoverer, l.hookCreator)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create ldcache update hook discoverer: %w\", err)\n\t}\n\n\td := discover.Merge(\n\t\tdriverDiscoverer,\n\t\tcudaCompatDiscoverer,\n\t\t// The ldcacheUpdateHook is added last to ensure that the created symlinks are included\n\t\tldcacheUpdateHook,\n\t)\n\treturn d, nil\n}\n\n// cudaCompatDiscoverer returns a discoverer for the CUDA forward compat hook\n// on Tegra-based systems.\n// If the system has NVML available, this is used to determine the driver\n// version to be passed to the hook.\n// On Orin-based systems, the compat library root in the container is also set.\nfunc (l *csvlib) cudaCompatDiscoverer() discover.Discover {\n\tc, err := l.getEnableCUDACompatHookOptions()\n\tif err != nil {\n\t\tl.logger.Warningf(\"Skipping CUDA Forward Compat hook creation: %v\", err)\n\t}\n\tif c == nil {\n\t\treturn nil\n\t}\n\n\treturn discover.NewCUDACompatHookDiscoverer(l.logger, l.hookCreator, c)\n}\n\nfunc (l *csvlib) getEnableCUDACompatHookOptions() (*discover.EnableCUDACompatHookOptions, error) {\n\thasNvml, _ := l.infolib.HasNvml()\n\tif !hasNvml {\n\t\treturn nil, nil\n\t}\n\n\tret := l.nvmllib.Init()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to initialize NVML: %v\", ret)\n\t}\n\tdefer func() {\n\t\t_ = l.nvmllib.Shutdown()\n\t}()\n\n\tvar cudaCompatContainerRoot string\n\tif l.hasOrinDevices() {\n\t\t// For Orin devices we need to use a different container compat root.\n\t\t// We allow this to be overridden by the user.\n\t\tcudaCompatContainerRoot = l.csv.CompatContainerRoot\n\t}\n\n\thostCUDAVersion, err := l.getCUDAVersionString()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get host CUDA version: %v\", ret)\n\t}\n\n\tf := &discover.EnableCUDACompatHookOptions{\n\t\tHostCUDAVersion: hostCUDAVersion,\n\t\tCUDACompatContainerRoot: cudaCompatContainerRoot,\n\t}\n\treturn f, nil\n}\n\nfunc (l *csvlib) hasOrinDevices() bool {\n\tvar names []string\n\terr := l.devicelib.VisitDevices(func(i int, d device.Device) error {\n\t\tname, ret := d.GetName()\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn fmt.Errorf(\"device %v: %v\", i, ret)\n\t\t}\n\t\tnames = append(names, name)\n\t\treturn nil\n\t})\n\tif err != nil {\n\t\tl.logger.Warningf(\"Failed to get device names: %v; assuming non-orin devices\", err)\n\t\treturn false\n\t}\n\n\tfor _, name := range names {\n\t\tif strings.Contains(name, \"Orin (nvgpu)\") {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n\nfunc (l *csvlib) getCUDAVersionString() (string, error) {\n\tv, ret := l.nvmllib.SystemGetCudaDriverVersion()\n\tif ret != nvml.SUCCESS {\n\t\treturn \"\", ret\n\t}\n\tmajor := v / 1000\n\tminor := v % 1000 / 10\n\n\treturn fmt.Sprintf(\"%d.%d\", major, minor), nil\n}\n"
},
{
"path": "pkg/nvcdi/lib-csv_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"testing\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml/mock\"\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/edits\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test/to\"\n)\n\nfunc TestDeviceSpecGenerators(t *testing.T) {\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlogger, _ := testlog.NewNullLogger()\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\n\t\trootfsFolder string\n\n\t\tlib *csvlib\n\t\texpectedError error\n\t\texpectedSpecError error\n\t\texpectedDeviceSpecs []specs.Device\n\t\texpectedCommonEdits *cdi.ContainerEdits\n\t}{\n\t\t{\n\t\t\tdescription: \"single orin CSV device\",\n\t\t\trootfsFolder: \"rootfs-orin\",\n\t\t\tlib: &csvlib{\n\t\t\t\tplatformlibs: platformlibs{\n\t\t\t\t\t// test-case specific\n\t\t\t\t\tinfolib: &infoInterfaceMock{\n\t\t\t\t\t\tHasNvmlFunc: func() (bool, string) { return true, \"forced\" },\n\t\t\t\t\t},\n\t\t\t\t\tnvmllib: mockOrinServer(),\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDeviceSpecs: []specs.Device{\n\t\t\t\t{\n\t\t\t\t\tName: \"0\",\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedCommonEdits: &cdi.ContainerEdits{\n\t\t\t\tContainerEdits: &specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", ContainerPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t\t{HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", ContainerPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t},\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"enable-cuda-compat\", \"--host-cuda-version=13.1\", \"--cuda-compat-container-root=/usr/local/cuda/compat_orin\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/usr/lib/aarch64-linux-gnu/nvidia\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"single orin CSV device; custom container compat root\",\n\t\t\trootfsFolder: \"rootfs-orin\",\n\t\t\tlib: &csvlib{\n\t\t\t\tplatformlibs: platformlibs{\n\t\t\t\t\t// test-case specific\n\t\t\t\t\tinfolib: &infoInterfaceMock{\n\t\t\t\t\t\tHasNvmlFunc: func() (bool, string) { return true, \"forced\" },\n\t\t\t\t\t},\n\t\t\t\t\tnvmllib: mockOrinServer(),\n\t\t\t\t},\n\t\t\t\tcsv: csvOptions{\n\t\t\t\t\tCompatContainerRoot: \"/another/compat/root\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDeviceSpecs: []specs.Device{\n\t\t\t\t{\n\t\t\t\t\tName: \"0\",\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedCommonEdits: &cdi.ContainerEdits{\n\t\t\t\tContainerEdits: &specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", ContainerPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t\t{HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", ContainerPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t},\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"enable-cuda-compat\", \"--host-cuda-version=13.1\", \"--cuda-compat-container-root=/another/compat/root\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/usr/lib/aarch64-linux-gnu/nvidia\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"thor device with dGPU\",\n\t\t\trootfsFolder: \"rootfs-thor-dgpu\",\n\t\t\tlib: &csvlib{\n\t\t\t\tplatformlibs: platformlibs{\n\t\t\t\t\t// test-case specific\n\t\t\t\t\tinfolib: &infoInterfaceMock{\n\t\t\t\t\t\tHasNvmlFunc: func() (bool, string) { return true, \"forced\" },\n\t\t\t\t\t},\n\t\t\t\t\tnvmllib: mockIGXServer(),\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDeviceSpecs: []specs.Device{\n\t\t\t\t{\n\t\t\t\t\tName: \"0\",\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t\t\t\t\t{Path: \"/dev/nvidiactl\", HostPath: \"/dev/nvidiactl\"},\n\t\t\t\t\t\t\t{Path: \"/dev/nvmap\", HostPath: \"/dev/nvmap\", FileMode: to.Ptr(os.FileMode(0400)), Permissions: \"rwm\", GID: to.Ptr[uint32](44)},\n\t\t\t\t\t\t\t{Path: \"/dev/nvidia2\", HostPath: \"/dev/nvidia2\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tName: \"1\",\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t{Path: \"/dev/nvidia1\", HostPath: \"/dev/nvidia1\"},\n\t\t\t\t\t\t\t{Path: \"/dev/nvidiactl\", HostPath: \"/dev/nvidiactl\"},\n\t\t\t\t\t\t\t{Path: \"/dev/nvmap\", HostPath: \"/dev/nvmap\", FileMode: to.Ptr(os.FileMode(0400)), Permissions: \"rwm\", GID: to.Ptr[uint32](44)},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedCommonEdits: &cdi.ContainerEdits{\n\t\t\t\tContainerEdits: &specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"enable-cuda-compat\", \"--host-cuda-version=13.1\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tdriverRoot := filepath.Join(lookupRoot, tc.rootfsFolder)\n\n\t\ttc.lib.logger = logger\n\t\ttc.lib.editsFactory = edits.NewFactory(edits.WithLogger(logger))\n\t\ttc.lib.deviceNamers = []DeviceNamer{deviceNameIndex{}}\n\t\ttc.lib.hookCreator = discover.NewHookCreator()\n\n\t\ttc.lib.devicelib = device.New(tc.lib.nvmllib)\n\n\t\ttc.lib.driver = root.New(root.WithDriverRoot(driverRoot))\n\t\ttc.lib.devRoot = driverRoot\n\t\ttc.lib.driver = root.New(root.WithDriverRoot(driverRoot), root.WithDevRoot(driverRoot))\n\t\ttc.lib.csv.Files = []string{\n\t\t\tfilepath.Join(driverRoot, \"/etc/nvidia-container-runtime/host-files-for-container.d/devices.csv\"),\n\t\t\tfilepath.Join(driverRoot, \"/etc/nvidia-container-runtime/host-files-for-container.d/drivers.csv\"),\n\t\t}\n\t\tif tc.lib.csv.CompatContainerRoot == \"\" {\n\t\t\ttc.lib.csv.CompatContainerRoot = defaultOrinCompatContainerRoot\n\t\t}\n\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tgenerator, err := tc.lib.DeviceSpecGenerators(\"all\")\n\n\t\t\trequire.EqualValues(t, tc.expectedError, err)\n\n\t\t\tif tc.expectedError != nil {\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\tdeviceSpecs, err := generator.GetDeviceSpecs()\n\t\t\trequire.EqualValues(t, tc.expectedSpecError, err)\n\t\t\trequire.EqualValues(t, tc.expectedDeviceSpecs, stripRoot(driverRoot, deviceSpecs))\n\n\t\t\tcommonEdits, err := tc.lib.GetCommonEdits()\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedCommonEdits, stripRoot(driverRoot, commonEdits))\n\t\t})\n\t}\n\n}\n\nfunc stripRoot[T any](root string, v T) T {\n\tstringRep, err := json.Marshal(v)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tstringRep = bytes.ReplaceAll(stringRep, []byte(root), []byte(\"\"))\n\n\tvar modified T\n\terr = json.Unmarshal(stringRep, &modified)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treturn modified\n}\n\n// TODO: We should move this mock to go-nvml/mock\nfunc mockOrinServer() nvml.Interface {\n\treturn &mock.Interface{\n\t\tInitFunc: func() nvml.Return {\n\t\t\treturn nvml.SUCCESS\n\t\t},\n\t\tShutdownFunc: func() nvml.Return {\n\t\t\treturn nvml.SUCCESS\n\t\t},\n\t\tSystemGetDriverVersionFunc: func() (string, nvml.Return) {\n\t\t\treturn \"540.3.0\", nvml.SUCCESS\n\t\t},\n\t\tSystemGetCudaDriverVersionFunc: func() (int, nvml.Return) {\n\t\t\treturn 13010, nvml.SUCCESS\n\t\t},\n\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\treturn 1, nvml.SUCCESS\n\t\t},\n\t\tDeviceGetHandleByIndexFunc: func(n int) (nvml.Device, nvml.Return) {\n\t\t\tif n != 0 {\n\t\t\t\treturn nil, nvml.ERROR_INVALID_ARGUMENT\n\t\t\t}\n\t\t\tdevice := &mock.Device{\n\t\t\t\tGetUUIDFunc: func() (string, nvml.Return) {\n\t\t\t\t\treturn \"GPU-orin\", nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\t\t\treturn \"Orin (nvgpu)\", nvml.SUCCESS\n\t\t\t\t},\n\t\t\t\tGetPciInfoFunc: func() (nvml.PciInfo, nvml.Return) {\n\t\t\t\t\treturn nvml.PciInfo{}, nvml.ERROR_NOT_SUPPORTED\n\t\t\t\t},\n\t\t\t}\n\t\t\treturn device, nvml.SUCCESS\n\t\t},\n\t}\n}\n\n// TODO: We should move this mock to go-nvml/mock\nfunc mockIGXServer() nvml.Interface {\n\tthor := &mock.Device{\n\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\treturn \"NVIDIA Thor\", nvml.SUCCESS\n\t\t},\n\t\tGetUUIDFunc: func() (string, nvml.Return) {\n\t\t\treturn \"GPU-0\", nvml.SUCCESS\n\t\t},\n\t\tGetPciInfoFunc: func() (nvml.PciInfo, nvml.Return) {\n\t\t\treturn nvml.PciInfo{\n\t\t\t\tBus: 1,\n\t\t\t}, nvml.SUCCESS\n\t\t},\n\t}\n\trtx := &mock.Device{\n\t\tGetNameFunc: func() (string, nvml.Return) {\n\t\t\treturn \"RTX Pro 6000\", nvml.SUCCESS\n\t\t},\n\t\tGetUUIDFunc: func() (string, nvml.Return) {\n\t\t\treturn \"GPU-1\", nvml.SUCCESS\n\t\t},\n\t\tGetPciInfoFunc: func() (nvml.PciInfo, nvml.Return) {\n\t\t\treturn nvml.PciInfo{\n\t\t\t\tBus: 3,\n\t\t\t}, nvml.SUCCESS\n\t\t},\n\t\tGetMinorNumberFunc: func() (int, nvml.Return) {\n\t\t\treturn 1, nvml.SUCCESS\n\t\t},\n\t}\n\n\treturn &mock.Interface{\n\t\tInitFunc: func() nvml.Return {\n\t\t\treturn nvml.SUCCESS\n\t\t},\n\t\tShutdownFunc: func() nvml.Return {\n\t\t\treturn nvml.SUCCESS\n\t\t},\n\t\tSystemGetDriverVersionFunc: func() (string, nvml.Return) {\n\t\t\treturn \"540.3.0\", nvml.SUCCESS\n\t\t},\n\t\tSystemGetCudaDriverVersionFunc: func() (int, nvml.Return) {\n\t\t\treturn 13010, nvml.SUCCESS\n\t\t},\n\t\tDeviceGetCountFunc: func() (int, nvml.Return) {\n\t\t\treturn 2, nvml.SUCCESS\n\t\t},\n\t\tDeviceGetHandleByIndexFunc: func(n int) (nvml.Device, nvml.Return) {\n\t\t\tswitch n {\n\t\t\tcase 0:\n\t\t\t\treturn thor, nvml.SUCCESS\n\t\t\tcase 1:\n\t\t\t\treturn rtx, nvml.SUCCESS\n\t\t\t}\n\t\t\treturn nil, nvml.ERROR_INVALID_ARGUMENT\n\t\t},\n\t\tDeviceGetHandleByUUIDFunc: func(s string) (nvml.Device, nvml.Return) {\n\t\t\tswitch s {\n\t\t\tcase \"GPU-0\":\n\t\t\t\treturn thor, nvml.SUCCESS\n\t\t\tcase \"GPU-1\":\n\t\t\t\treturn rtx, nvml.SUCCESS\n\t\t\t}\n\t\t\treturn nil, nvml.ERROR_INVALID_ARGUMENT\n\t\t},\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/lib-imex.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n)\n\ntype imexlib nvcdilib\n\ntype imexChannel struct {\n\tid string\n\tdevRoot string\n}\n\nvar _ deviceSpecGeneratorFactory = (*imexlib)(nil)\n\nconst (\n\tclassImexChannel = \"imex-channel\"\n)\n\n// GetCommonEdits returns an empty set of edits for IMEX devices.\nfunc (l *imexlib) GetCommonEdits() (*cdi.ContainerEdits, error) {\n\treturn l.editsFactory.FromDiscoverer(discover.None{})\n}\n\n// DeviceSpecGenerators returns the CDI device spec generators for the specified\n// imex channel IDs.\n// Valid IDs are:\n// * numeric channel IDs\n// * channel\n// * the special ID 'all'\nfunc (l *imexlib) DeviceSpecGenerators(ids ...string) (DeviceSpecGenerator, error) {\n\tchannelsIDs, err := l.getChannelIDs(ids...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar deviceSpecGenerators DeviceSpecGenerators\n\tfor _, id := range channelsIDs {\n\t\tdeviceSpecGenerators = append(deviceSpecGenerators, &imexChannel{id: id, devRoot: l.driver.DevRoot})\n\t}\n\n\treturn deviceSpecGenerators, nil\n}\n\nfunc (l *imexlib) getChannelIDs(ids ...string) ([]string, error) {\n\tvar channelIDs []string\n\tfor _, id := range ids {\n\t\ttrimmed := strings.TrimPrefix(id, \"channel\")\n\t\tif trimmed == \"all\" {\n\t\t\treturn l.getAllChannelIDs()\n\t\t}\n\t\t_, err := strconv.ParseUint(trimmed, 10, 64)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"invalid channel ID %v: %w\", id, err)\n\t\t}\n\t\tchannelIDs = append(channelIDs, trimmed)\n\t}\n\treturn channelIDs, nil\n}\n\n// getAllChannelIDs returns the device IDs for all available IMEX channels.\nfunc (l *imexlib) getAllChannelIDs() ([]string, error) {\n\tchannelsDiscoverer := discover.NewCharDeviceDiscoverer(\n\t\tl.logger,\n\t\tl.driver.DevRoot,\n\t\t[]string{\"/dev/nvidia-caps-imex-channels/channel*\"},\n\t)\n\n\tchannels, err := channelsDiscoverer.Devices()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar channelIDs []string\n\tfor _, channel := range channels {\n\t\tchannelID := filepath.Base(channel.Path)\n\t\tchannelIDs = append(channelIDs, strings.TrimPrefix(channelID, \"channel\"))\n\t}\n\n\treturn channelIDs, nil\n}\n\n// GetDeviceSpecs returns the CDI device specs the specified IMEX channel.\nfunc (l *imexChannel) GetDeviceSpecs() ([]specs.Device, error) {\n\tpath := \"/dev/nvidia-caps-imex-channels/channel\" + l.id\n\tdeviceSpec := specs.Device{\n\t\tName: l.id,\n\t\tContainerEdits: specs.ContainerEdits{\n\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t{\n\t\t\t\t\tPath: path,\n\t\t\t\t\tHostPath: filepath.Join(l.devRoot, path),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\treturn []specs.Device{deviceSpec}, nil\n}\n"
},
{
"path": "pkg/nvcdi/lib-imex_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"bytes\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestImexMode(t *testing.T) {\n\tdefer devices.SetAllForTest()()\n\n\tlogger, _ := testlog.NewNullLogger()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\thostRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\", \"rootfs-1\")\n\n\texpectedSpec := `---\ncdiVersion: 0.5.0\nkind: nvidia.com/imex-channel\ndevices:\n - name: \"0\"\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia-caps-imex-channels/channel0\n hostPath: {{ .hostRoot }}/dev/nvidia-caps-imex-channels/channel0\n - name: \"1\"\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia-caps-imex-channels/channel1\n hostPath: {{ .hostRoot }}/dev/nvidia-caps-imex-channels/channel1\n - name: \"2047\"\n containerEdits:\n deviceNodes:\n - path: /dev/nvidia-caps-imex-channels/channel2047\n hostPath: {{ .hostRoot }}/dev/nvidia-caps-imex-channels/channel2047\ncontainerEdits:\n env:\n - NVIDIA_VISIBLE_DEVICES=void\n`\n\texpectedSpec = strings.ReplaceAll(expectedSpec, \"{{ .hostRoot }}\", hostRoot)\n\n\tlib, err := New(\n\t\tWithLogger(logger),\n\t\tWithMode(ModeImex),\n\t\tWithDriverRoot(hostRoot),\n\t)\n\trequire.NoError(t, err)\n\n\tspec, err := lib.GetSpec()\n\trequire.NoError(t, err)\n\n\tvar b bytes.Buffer\n\n\t_, err = spec.WriteTo(&b)\n\trequire.NoError(t, err)\n\trequire.Equal(t, expectedSpec, b.String())\n}\n"
},
{
"path": "pkg/nvcdi/lib-nvml.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils\"\n)\n\ntype nvmllib nvcdilib\n\nvar _ deviceSpecGeneratorFactory = (*nvmllib)(nil)\n\n// GetCommonEdits generates a CDI specification that can be used for ANY devices\nfunc (l *nvmllib) GetCommonEdits() (*cdi.ContainerEdits, error) {\n\tcommon, err := l.newCommonNVMLDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for common entities: %v\", err)\n\t}\n\n\treturn l.editsFactory.FromDiscoverer(common)\n}\n\n// DeviceSpecGenerators returns the CDI device spec generators for NVML devices\n// with the specified IDs.\n// Supported IDs are:\n// * an index of a GPU or MIG device\n// * a UUID of a GPU or MIG device\n// * the special ID 'all'\nfunc (l *nvmllib) DeviceSpecGenerators(ids ...string) (DeviceSpecGenerator, error) {\n\tif err := l.init(); err != nil {\n\t\treturn nil, err\n\t}\n\tdefer l.tryShutdown()\n\n\tdsgs, err := l.getDeviceSpecGeneratorsForIDs(ids...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn l.withInit(dsgs), nil\n}\n\nfunc (l *nvmllib) getDeviceSpecGeneratorsForIDs(ids ...string) (DeviceSpecGenerator, error) {\n\tvar identifiers []device.Identifier\n\tfor _, id := range ids {\n\t\tif id == \"none\" {\n\t\t\treturn emptyDeviceSpecGenerator(\"none\"), nil\n\t\t}\n\t\tif id == \"all\" {\n\t\t\treturn l.getDeviceSpecGeneratorsForAllDevices()\n\t\t}\n\t\tidentifiers = append(identifiers, device.Identifier(id))\n\t}\n\n\tuuids, err := l.normalizeDeviceIDs(identifiers...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar DeviceSpecGenerators DeviceSpecGenerators\n\tfor _, uuid := range uuids {\n\t\tdevice, ret := l.nvmllib.DeviceGetHandleByUUID(string(uuid))\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn nil, fmt.Errorf(\"failed to get device handle from UUID: %v\", ret)\n\t\t}\n\t\tgenerator, err := l.newDeviceSpecGeneratorFromNVMLDevice(string(uuid), device)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tDeviceSpecGenerators = append(DeviceSpecGenerators, generator)\n\t}\n\n\treturn DeviceSpecGenerators, nil\n}\n\nfunc (l *nvmllib) newDeviceSpecGeneratorFromNVMLDevice(id string, nvmlDevice nvml.Device) (DeviceSpecGenerator, error) {\n\tisMig, ret := nvmlDevice.IsMigDeviceHandle()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"%v\", ret)\n\t}\n\tif isMig {\n\t\treturn l.newMIGDeviceSpecGeneratorFromNVMLDevice(id, nvmlDevice)\n\t}\n\n\treturn l.newFullGPUDeviceSpecGeneratorFromNVMLDevice(id, nvmlDevice, l.featureFlags)\n}\n\n// getDeviceSpecGeneratorsForAllDevices returns the CDI device spec generators\n// for all NVML devices detected on the system.\n// This includes full GPUs as well as MIG devices.\nfunc (l *nvmllib) getDeviceSpecGeneratorsForAllDevices() (DeviceSpecGenerator, error) {\n\tvar DeviceSpecGenerators DeviceSpecGenerators\n\terr := l.devicelib.VisitDevices(func(i int, d device.Device) error {\n\t\tisMigEnabled, err := d.IsMigEnabled()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif isMigEnabled {\n\t\t\treturn nil\n\t\t}\n\t\tfullGPU, err := l.newFullGPUDeviceSpecGeneratorFromDevice(i, d, l.featureFlags)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tDeviceSpecGenerators = append(DeviceSpecGenerators, fullGPU)\n\t\treturn nil\n\t})\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get full GPU device editors: %w\", err)\n\t}\n\n\terr = l.devicelib.VisitMigDevices(func(i int, d device.Device, j int, mig device.MigDevice) error {\n\t\tmigDevice, err := l.newMIGDeviceSpecGeneratorFromDevice(i, d, j, mig)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tDeviceSpecGenerators = append(DeviceSpecGenerators, migDevice)\n\t\treturn nil\n\t})\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get MIG device editors: %w\", err)\n\t}\n\n\treturn DeviceSpecGenerators, nil\n}\n\n// TODO: move this to go-nvlib?\n// normalizeDeviceID returns the UUIDs of the devices specified by the identifier.\nfunc (l *nvmllib) normalizeDeviceIDs(identifiers ...device.Identifier) ([]device.Identifier, error) {\n\tvar uuids []device.Identifier\n\tfor _, id := range identifiers {\n\t\tuuid, err := l.normalizeDeviceID(id)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tuuids = append(uuids, uuid)\n\t}\n\treturn uuids, nil\n}\n\nfunc (l *nvmllib) normalizeDeviceID(id device.Identifier) (device.Identifier, error) {\n\tvar err error\n\n\tif id.IsUUID() {\n\t\treturn id, nil\n\t}\n\n\tif id.IsGpuIndex() {\n\t\tidx, err := strconv.Atoi(string(id))\n\t\tif err != nil {\n\t\t\treturn \"\", fmt.Errorf(\"failed to convert device index to an int: %w\", err)\n\t\t}\n\t\tdev, ret := l.nvmllib.DeviceGetHandleByIndex(idx)\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn \"\", fmt.Errorf(\"failed to get device handle from index: %v\", ret)\n\t\t}\n\t\tuuid, ret := dev.GetUUID()\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn \"\", fmt.Errorf(\"failed to get device UUID: %v\", ret)\n\t\t}\n\t\treturn device.Identifier(uuid), nil\n\t}\n\n\tif id.IsMigIndex() {\n\t\tvar gpuIdx, migIdx int\n\t\tvar parent nvml.Device\n\t\tsplit := strings.SplitN(string(id), \":\", 2)\n\t\tif gpuIdx, err = strconv.Atoi(split[0]); err != nil {\n\t\t\treturn \"\", fmt.Errorf(\"failed to convert device index to an int: %w\", err)\n\t\t}\n\t\tif migIdx, err = strconv.Atoi(split[1]); err != nil {\n\t\t\treturn \"\", fmt.Errorf(\"failed to convert device index to an int: %w\", err)\n\t\t}\n\t\tparent, ret := l.nvmllib.DeviceGetHandleByIndex(gpuIdx)\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn \"\", fmt.Errorf(\"failed to get parent device handle: %v\", ret)\n\t\t}\n\t\tmig, ret := parent.GetMigDeviceHandleByIndex(migIdx)\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn \"\", fmt.Errorf(\"failed to get MIG handle by index: %v\", ret)\n\t\t}\n\t\tuuid, ret := mig.GetUUID()\n\t\tif ret != nvml.SUCCESS {\n\t\t\treturn \"\", fmt.Errorf(\"failed to get MIG UUID: %v\", ret)\n\t\t}\n\t\treturn device.Identifier(uuid), nil\n\t}\n\n\treturn \"\", fmt.Errorf(\"identifier is not a valid UUID or index: %q\", id)\n}\n\nfunc (l *nvmllib) init() error {\n\tif r := l.nvmllib.Init(); r != nvml.SUCCESS {\n\t\treturn fmt.Errorf(\"failed to initialize NVML: %w\", r)\n\t}\n\n\tif l.nvsandboxutilslib == nil {\n\t\treturn nil\n\t}\n\tif r := l.nvsandboxutilslib.Init(l.driver.Root); r != nvsandboxutils.SUCCESS {\n\t\tl.logger.Warningf(\"Failed to init nvsandboxutils: %v; ignoring\", r)\n\t\tl.nvsandboxutilslib = nil\n\t}\n\treturn nil\n}\n\nfunc (l *nvmllib) tryShutdown() {\n\tif l.nvsandboxutilslib != nil {\n\t\tif r := l.nvsandboxutilslib.Shutdown(); r != nvsandboxutils.SUCCESS {\n\t\t\tl.logger.Warningf(\"failed to shutdown nvsandboxutils: %v\", r)\n\t\t}\n\t}\n\tif r := l.nvmllib.Shutdown(); r != nvml.SUCCESS {\n\t\tl.logger.Warningf(\"failed to shutdown NVML: %v\", r)\n\t}\n}\n\ntype deviceSpecGeneratorsWithAndShutdown struct {\n\t*nvmllib\n\tDeviceSpecGenerator\n}\n\nfunc (l *nvmllib) withInit(dsg DeviceSpecGenerator) DeviceSpecGenerator {\n\treturn &deviceSpecGeneratorsWithAndShutdown{\n\t\tnvmllib: l,\n\t\tDeviceSpecGenerator: dsg,\n\t}\n}\n\n// GetDeviceSpecs ensures that the init and shutdown are called before (and\n// after) generating the required device specs.\nfunc (d *deviceSpecGeneratorsWithAndShutdown) GetDeviceSpecs() ([]specs.Device, error) {\n\tif err := d.init(); err != nil {\n\t\treturn nil, err\n\t}\n\tdefer d.tryShutdown()\n\n\treturn d.DeviceSpecGenerator.GetDeviceSpecs()\n}\n\ntype emptyDeviceSpecGenerator string\n\nfunc (d emptyDeviceSpecGenerator) GetDeviceSpecs() ([]specs.Device, error) {\n\t// Since the CDI specification does not allow devices to have no edits, we\n\t// add a dummy envvar to the container edits for an \"empty\" device.\n\tnoneDevice := specs.Device{\n\t\tName: string(d),\n\t\tContainerEdits: specs.ContainerEdits{\n\t\t\tEnv: []string{\"NVCT_EMPTY_DEVICE=\"},\n\t\t},\n\t}\n\treturn []specs.Device{noneDevice}, nil\n}\n"
},
{
"path": "pkg/nvcdi/lib-nvml_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"testing\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\tmocknvml \"github.com/NVIDIA/go-nvml/pkg/nvml/mock\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml/mock/dgxa100\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n)\n\nfunc TestNvmllibGetDeviceSpecGeneratorsForIDs(t *testing.T) {\n\ttestCases := []struct {\n\t\tname string\n\t\tids []string\n\t\tsetupMock func(*dgxa100.Server)\n\t\texpectedError error\n\t\texpectedLength int\n\t\texpectedGenerators DeviceSpecGenerators\n\t}{\n\t\t{\n\t\t\tname: \"all devices\",\n\t\t\tids: []string{\"all\"},\n\t\t\texpectedError: nil,\n\t\t\texpectedLength: 8,\n\t\t},\n\t\t{\n\t\t\tname: \"single GPU index\",\n\t\t\tids: []string{\"0\"},\n\t\t\tsetupMock: func(server *dgxa100.Server) {\n\t\t\t\tfor _, d := range server.Devices {\n\t\t\t\t\t// TODO: This is not implemented in the mock.\n\t\t\t\t\t(d.(*dgxa100.Device)).IsMigDeviceHandleFunc = func() (bool, nvml.Return) {\n\t\t\t\t\t\treturn false, nvml.SUCCESS\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\texpectedLength: 1,\n\t\t},\n\t\t{\n\t\t\tname: \"single UUID\",\n\t\t\tids: []string{\"GPU-12345678-1234-1234-1234-123456789abc\"},\n\t\t\tsetupMock: func(server *dgxa100.Server) {\n\t\t\t\tfor _, d := range server.Devices {\n\t\t\t\t\t// TODO: This is not implemented in the mock.\n\t\t\t\t\t(d.(*dgxa100.Device)).IsMigDeviceHandleFunc = func() (bool, nvml.Return) {\n\t\t\t\t\t\treturn false, nvml.SUCCESS\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tserver.DeviceGetHandleByUUIDFunc = func(s string) (nvml.Device, nvml.Return) {\n\t\t\t\t\tif s == \"GPU-12345678-1234-1234-1234-123456789abc\" {\n\t\t\t\t\t\treturn server.Devices[3], nvml.SUCCESS\n\t\t\t\t\t}\n\t\t\t\t\treturn server.Devices[0], nvml.SUCCESS\n\t\t\t\t}\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\texpectedLength: 1,\n\t\t},\n\t\t{\n\t\t\tname: \"MIG device index\",\n\t\t\tids: []string{\"0:0\"},\n\t\t\tsetupMock: func(server *dgxa100.Server) {\n\t\t\t\tmig := &mocknvml.Device{\n\t\t\t\t\tIsMigDeviceHandleFunc: func() (bool, nvml.Return) {\n\t\t\t\t\t\treturn true, nvml.SUCCESS\n\t\t\t\t\t},\n\t\t\t\t\tGetDeviceHandleFromMigDeviceHandleFunc: func() (nvml.Device, nvml.Return) {\n\t\t\t\t\t\treturn server.Devices[0], nvml.SUCCESS\n\t\t\t\t\t},\n\t\t\t\t\tGetIndexFunc: func() (int, nvml.Return) {\n\t\t\t\t\t\treturn 0, nvml.SUCCESS\n\t\t\t\t\t},\n\t\t\t\t\tGetUUIDFunc: func() (string, nvml.Return) {\n\t\t\t\t\t\treturn \"MIG-foo\", nvml.SUCCESS\n\t\t\t\t\t},\n\t\t\t\t}\n\n\t\t\t\tserver.Devices[0].(*dgxa100.Device).GetMigDeviceHandleByIndexFunc = func(n int) (nvml.Device, nvml.Return) {\n\t\t\t\t\tif n != 0 {\n\t\t\t\t\t\treturn nil, nvml.ERROR_INVALID_ARGUMENT\n\t\t\t\t\t}\n\n\t\t\t\t\treturn mig, nvml.SUCCESS\n\t\t\t\t}\n\n\t\t\t\tserver.DeviceGetHandleByUUIDFunc = func(s string) (nvml.Device, nvml.Return) {\n\t\t\t\t\tif s == \"MIG-foo\" {\n\t\t\t\t\t\treturn mig, nvml.SUCCESS\n\t\t\t\t\t}\n\t\t\t\t\treturn nil, nvml.ERROR_INVALID_ARGUMENT\n\t\t\t\t}\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\texpectedLength: 1,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.name, func(t *testing.T) {\n\t\t\t// Set up a mock server, using the DGX A100 mock.\n\t\t\tmockNvml := dgxa100.New()\n\t\t\tmockOverrides(mockNvml)\n\t\t\tif tc.setupMock != nil {\n\t\t\t\ttc.setupMock(mockNvml)\n\t\t\t}\n\n\t\t\tmockDev := device.New(mockNvml)\n\n\t\t\tl := &nvmllib{\n\t\t\t\tplatformlibs: platformlibs{\n\t\t\t\t\tnvmllib: mockNvml,\n\t\t\t\t\tdevicelib: mockDev,\n\t\t\t\t},\n\t\t\t}\n\t\t\t// Call the function under test\n\t\t\tgenerators, err := l.getDeviceSpecGeneratorsForIDs(tc.ids...)\n\n\t\t\trequire.EqualValues(t, tc.expectedError, err)\n\t\t\trequire.Len(t, generators, tc.expectedLength)\n\t\t})\n\t}\n}\n\n// TODO: These need to be implemented in go-nvlib\nfunc mockOverrides(server *dgxa100.Server) {\n\tfor i, d := range server.Devices {\n\t\t// TODO: This is not implemented in the mock.\n\t\t(d.(*dgxa100.Device)).GetMaxMigDeviceCountFunc = func() (int, nvml.Return) {\n\t\t\treturn 0, nvml.SUCCESS\n\t\t}\n\t\t(d.(*dgxa100.Device)).GetIndexFunc = func() (int, nvml.Return) {\n\t\t\treturn i, nvml.SUCCESS\n\t\t}\n\t\t(d.(*dgxa100.Device)).GetUUIDFunc = func() (string, nvml.Return) {\n\t\t\treturn d.(*dgxa100.Device).UUID, nvml.SUCCESS\n\t\t}\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/lib-wsl.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\ntype wsllib nvcdilib\n\nvar _ deviceSpecGeneratorFactory = (*wsllib)(nil)\n\nfunc (l *wsllib) DeviceSpecGenerators(...string) (DeviceSpecGenerator, error) {\n\treturn l, nil\n}\n\n// GetDeviceSpecs returns the CDI device specs for a single all device.\nfunc (l *wsllib) GetDeviceSpecs() ([]specs.Device, error) {\n\tdevice := l.newDXGDeviceDiscoverer()\n\tdeviceEdits, err := l.editsFactory.FromDiscoverer(device)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create container edits for DXG device: %v\", err)\n\t}\n\n\tdeviceSpec := specs.Device{\n\t\tName: \"all\",\n\t\tContainerEdits: *deviceEdits.ContainerEdits,\n\t}\n\n\treturn []specs.Device{deviceSpec}, nil\n}\n\n// GetCommonEdits generates a CDI specification that can be used for ANY devices\nfunc (l *wsllib) GetCommonEdits() (*cdi.ContainerEdits, error) {\n\tdriver, err := l.newWSLDriverDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create discoverer for WSL driver: %v\", err)\n\t}\n\n\treturn l.editsFactory.FromDiscoverer(driver)\n}\n"
},
{
"path": "pkg/nvcdi/lib.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\t\"slices\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/edits\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/root\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils\"\n)\n\ntype nvcdilib struct {\n\tlogger logger.Interface\n\tplatformlibs\n\tdeviceNamers DeviceNamers\n\t// TODO: We should use the devRoot associated with the driver.\n\tdevRoot string\n\tlibrarySearchPaths []string\n\n\tcsv csvOptions\n\n\tdriver *root.Driver\n\n\tfeatureFlags map[FeatureFlag]bool\n\n\thookCreator discover.HookCreator\n\teditsFactory edits.Factory\n}\n\n// New creates a new nvcdi library\nfunc New(opts ...Option) (Interface, error) {\n\to := populateOptions(opts...)\n\n\tl := &nvcdilib{\n\t\tlogger: o.logger,\n\t\tplatformlibs: o.platformlibs,\n\t\tdriver: root.New(\n\t\t\to.getDriverOptions()...,\n\t\t),\n\t\tdevRoot: o.devRoot,\n\t\tdeviceNamers: o.deviceNamers,\n\n\t\tlibrarySearchPaths: slices.Clone(o.librarySearchPaths),\n\t\tfeatureFlags: o.featureFlags,\n\n\t\tcsv: o.csv,\n\n\t\thookCreator: discover.NewHookCreator(\n\t\t\tdiscover.WithNVIDIACDIHookPath(o.nvidiaCDIHookPath),\n\t\t\tdiscover.WithEnabledHooks(o.enabledHooks...),\n\t\t\tdiscover.WithLdconfigPath(o.ldconfigPath),\n\t\t\tdiscover.WithDisabledHooks(o.disabledHooks...),\n\t\t),\n\t\teditsFactory: o.editsFactory,\n\t}\n\n\tvar factory deviceSpecGeneratorFactory\n\tswitch o.mode {\n\tcase ModeCSV:\n\t\tfactory = (*csvlib)(l)\n\tcase ModeManagement:\n\t\tfactory = (*managementlib)(l)\n\tcase ModeNvml:\n\t\tfactory = (*nvmllib)(l)\n\tcase ModeWsl:\n\t\tfactory = (*wsllib)(l)\n\tcase ModeGdrcopy, ModeGds, ModeMofed, ModeNvswitch:\n\t\tfactory = &gatedlib{\n\t\t\tnvcdilib: l,\n\t\t\tmode: o.mode,\n\t\t}\n\tcase ModeImex:\n\t\tfactory = (*imexlib)(l)\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"unknown mode %q\", o.mode)\n\t}\n\n\tw := wrapper{\n\t\tfactory: factory,\n\t\tvendor: o.getVendorOrDefault(),\n\t\tclass: o.getClassOrDefault(),\n\t\tmergedDeviceOptions: o.mergedDeviceOptions,\n\t}\n\treturn &w, nil\n}\n\ntype nvmllibAsVersioner struct {\n\tnvml.Interface\n}\n\nfunc nvmllibWithVersion(nvmllib nvml.Interface) *nvmllibAsVersioner {\n\tif nvmllib == nil {\n\t\treturn nil\n\t}\n\treturn &nvmllibAsVersioner{\n\t\tInterface: nvmllib,\n\t}\n}\n\nfunc (l *nvmllibAsVersioner) Version() (string, error) {\n\tif l == nil || l.Interface == nil {\n\t\treturn \"\", fmt.Errorf(\"nvml library not initialized\")\n\t}\n\n\tr := l.Init()\n\tif r != nvml.SUCCESS {\n\t\treturn \"\", fmt.Errorf(\"failed to initialize nvml: %v\", r)\n\t}\n\tdefer func() {\n\t\t_ = l.Shutdown()\n\t}()\n\n\tversion, r := l.SystemGetDriverVersion()\n\tif r != nvml.SUCCESS {\n\t\treturn \"\", fmt.Errorf(\"failed to get driver version: %v\", r)\n\t}\n\treturn version, nil\n}\n\ntype nvsandboxutilslibAsVersioner struct {\n\tnvsandboxutils.Interface\n}\n\nfunc nvsandboxutilslibWithVersion(nvsandboxutilslib nvsandboxutils.Interface) *nvsandboxutilslibAsVersioner {\n\tif nvsandboxutilslib == nil {\n\t\treturn nil\n\t}\n\treturn &nvsandboxutilslibAsVersioner{\n\t\tInterface: nvsandboxutilslib,\n\t}\n}\n\nfunc (l *nvsandboxutilslibAsVersioner) Version() (string, error) {\n\tif l == nil || l.Interface == nil {\n\t\treturn \"\", fmt.Errorf(\"libnvsandboxutils is not available\")\n\t}\n\n\t// Sandboxutils initialization should happen before this function is called\n\tversion, ret := l.GetDriverVersion()\n\tif ret != nvsandboxutils.SUCCESS {\n\t\treturn \"\", fmt.Errorf(\"%v\", ret)\n\t}\n\treturn version, nil\n}\n\nfunc (o *options) getNvmlLib() nvml.Interface {\n\tif o.nvmllib != nil {\n\t\treturn o.nvmllib\n\t}\n\n\tvar nvmlOpts []nvml.LibraryOption\n\tcandidates, err := o.driverLibraryLocator().Locate(\"libnvidia-ml.so.1\")\n\tif err != nil {\n\t\to.logger.Warningf(\"Ignoring error in locating libnvidia-ml.so.1: %v\", err)\n\t} else {\n\t\tlibNvidiaMlPath := candidates[0]\n\t\to.logger.Infof(\"Using %v\", libNvidiaMlPath)\n\t\tnvmlOpts = append(nvmlOpts, nvml.WithLibraryPath(libNvidiaMlPath))\n\t}\n\treturn nvml.New(nvmlOpts...)\n}\n\n// getNvsandboxUtilsLib returns the nvsandboxutilslib to use for CDI spec\n// generation.\nfunc (o *options) getNvsandboxUtilsLib() nvsandboxutils.Interface {\n\tif o.featureFlags[FeatureDisableNvsandboxUtils] {\n\t\treturn nil\n\t}\n\tif o.nvsandboxutilslib != nil {\n\t\treturn o.nvsandboxutilslib\n\t}\n\n\tvar nvsandboxutilsOpts []nvsandboxutils.LibraryOption\n\t// Set the library path for libnvidia-sandboxutils\n\tcandidates, err := o.driverLibraryLocator().Locate(\"libnvidia-sandboxutils.so.1\")\n\tif err != nil {\n\t\to.logger.Warningf(\"Ignoring error in locating libnvidia-sandboxutils.so.1: %v\", err)\n\t} else {\n\t\tlibNvidiaSandboxutilsPath := candidates[0]\n\t\to.logger.Infof(\"Using %v\", libNvidiaSandboxutilsPath)\n\t\tnvsandboxutilsOpts = append(nvsandboxutilsOpts, nvsandboxutils.WithLibraryPath(libNvidiaSandboxutilsPath))\n\t}\n\n\t// We try to initialize the library once to ensure that we have a valid installation.\n\tlib := nvsandboxutils.New(nvsandboxutilsOpts...)\n\t// TODO: Should this accept the driver root or the devRoot?\n\tif r := lib.Init(o.driverRoot); r != nvsandboxutils.SUCCESS {\n\t\to.logger.Warningf(\"Failed to init nvsandboxutils: %v; ignoring\", r)\n\t\treturn nil\n\t}\n\tdefer func() {\n\t\t_ = lib.Shutdown()\n\t}()\n\n\treturn lib\n}\n\nfunc (o *options) getDriverOptions() []root.Option {\n\treturn []root.Option{\n\t\troot.WithLogger(o.logger),\n\t\troot.WithDriverRoot(o.driverRoot),\n\t\troot.WithDevRoot(o.devRoot),\n\t\troot.WithLibrarySearchPaths(o.librarySearchPaths...),\n\t\troot.WithConfigSearchPaths(o.configSearchPaths...),\n\t\troot.WithVersioner(\n\t\t\troot.FirstOf(\n\t\t\t\tnvsandboxutilslibWithVersion(o.nvsandboxutilslib),\n\t\t\t\tnvmllibWithVersion(o.nvmllib),\n\t\t\t),\n\t\t),\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/lib_test.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"path/filepath\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/test\"\n)\n\nfunc TestNew(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tdefer devices.SetAllForTest()()\n\n\tmoduleRoot, err := test.GetModuleRoot()\n\trequire.NoError(t, err)\n\n\tlookupRoot := filepath.Join(moduleRoot, \"testdata\", \"lookup\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\tmode string\n\t\tadditionalOptions []Option\n\t\tdriverRootfs string\n\t\tdevRootfs string\n\t\texpectedInitError error\n\n\t\texpectedSpec *specs.Spec\n\t\texpectedSpecError error\n\t}{\n\t\t{\n\t\t\tdescription: \"nvswitch mode is supported\",\n\t\t\tmode: \"nvswitch\",\n\t\t\tdriverRootfs: \"rootfs-with-nvswitch\",\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tVersion: specs.CurrentVersion,\n\t\t\t\tKind: \"nvidia.com/nvswitch\",\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/nvidia-nvswitch0\",\n\t\t\t\t\t\t\t\t\tHostPath: \"/dev/nvidia-nvswitch0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/nvidia-nvswitch1\",\n\t\t\t\t\t\t\t\t\tHostPath: \"/dev/nvidia-nvswitch1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/nvidia-nvswitchctl\",\n\t\t\t\t\t\t\t\t\tHostPath: \"/dev/nvidia-nvswitchctl\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\n\t\t\t\t\t\t\"NVIDIA_VISIBLE_DEVICES=void\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"gds mode is supported\",\n\t\t\tmode: \"gds\",\n\t\t\tdriverRootfs: \"rootfs-1\",\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tVersion: specs.CurrentVersion,\n\t\t\t\tKind: \"nvidia.com/gds\",\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-fs0\", HostPath: \"/dev/nvidia-fs0\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t\t\t{ContainerPath: \"/etc/cufile.json\", HostPath: \"/etc/cufile.json\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t\t\t\t{ContainerPath: \"/run/udev\", HostPath: \"/run/udev\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\n\t\t\t\t\t\t\"NVIDIA_VISIBLE_DEVICES=void\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"gdrcopy mode is supported\",\n\t\t\tmode: \"gdrcopy\",\n\t\t\tdriverRootfs: \"rootfs-1\",\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tVersion: specs.CurrentVersion,\n\t\t\t\tKind: \"nvidia.com/gdrcopy\",\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/gdrdrv\",\n\t\t\t\t\t\t\t\t\tHostPath: \"/dev/gdrdrv\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\n\t\t\t\t\t\t\"NVIDIA_VISIBLE_DEVICES=void\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mofed mode is supported\",\n\t\t\tmode: \"mofed\",\n\t\t\tdriverRootfs: \"rootfs-1\",\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tVersion: specs.CurrentVersion,\n\t\t\t\tKind: \"nvidia.com/mofed\",\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{Path: \"/dev/infiniband/rdma_cm\", HostPath: \"/dev/infiniband/rdma_cm\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/infiniband/uverbs0\", HostPath: \"/dev/infiniband/uverbs0\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\n\t\t\t\t\t\t\"NVIDIA_VISIBLE_DEVICES=void\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"management mode is supported\",\n\t\t\tmode: \"management\",\n\t\t\tdriverRootfs: \"rootfs-1\",\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tVersion: specs.CurrentVersion,\n\t\t\t\tKind: \"management.nvidia.com/gpu\",\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidiactl\", HostPath: \"/dev/nvidiactl\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-caps-imex-channels/channel0\", HostPath: \"/dev/nvidia-caps-imex-channels/channel0\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-caps-imex-channels/channel1\", HostPath: \"/dev/nvidia-caps-imex-channels/channel1\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-caps-imex-channels/channel2047\", HostPath: \"/dev/nvidia-caps-imex-channels/channel2047\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-caps/nvidia-cap1\", HostPath: \"/dev/nvidia-caps/nvidia-cap1\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\n\t\t\t\t\t\t\"NVIDIA_CTK_LIBCUDA_DIR=/lib/x86_64-linux-gnu\",\n\t\t\t\t\t\t\"NVIDIA_VISIBLE_DEVICES=void\",\n\t\t\t\t\t},\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{ContainerPath: \"/lib/x86_64-linux-gnu/libcuda.so.999.88.77\", HostPath: \"/lib/x86_64-linux-gnu/libcuda.so.999.88.77\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t\t{ContainerPath: \"/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\", HostPath: \"/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t},\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/lib/x86_64-linux-gnu/libcuda.so\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/lib/x86_64-linux-gnu\", \"--folder\", \"/lib/x86_64-linux-gnu/vdpau\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"management mode is supported in split root\",\n\t\t\tmode: \"management\",\n\t\t\tdriverRootfs: \"rootfs-split/driver-root\",\n\t\t\tdevRootfs: \"rootfs-split/dev-root\",\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tVersion: specs.CurrentVersion,\n\t\t\t\tKind: \"management.nvidia.com/gpu\",\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidiactl\", HostPath: \"/dev/nvidiactl\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-caps-imex-channels/channel0\", HostPath: \"/dev/nvidia-caps-imex-channels/channel0\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-caps-imex-channels/channel1\", HostPath: \"/dev/nvidia-caps-imex-channels/channel1\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-caps-imex-channels/channel2047\", HostPath: \"/dev/nvidia-caps-imex-channels/channel2047\"},\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia-caps/nvidia-cap1\", HostPath: \"/dev/nvidia-caps/nvidia-cap1\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\n\t\t\t\t\t\t\"NVIDIA_CTK_LIBCUDA_DIR=/lib/x86_64-linux-gnu\",\n\t\t\t\t\t\t\"NVIDIA_VISIBLE_DEVICES=void\",\n\t\t\t\t\t},\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{ContainerPath: \"/lib/x86_64-linux-gnu/libcuda.so.999.88.77\", HostPath: \"/lib/x86_64-linux-gnu/libcuda.so.999.88.77\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t\t{ContainerPath: \"/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\", HostPath: \"/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t},\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/lib/x86_64-linux-gnu/libcuda.so\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/lib/x86_64-linux-gnu\", \"--folder\", \"/lib/x86_64-linux-gnu/vdpau\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"imex mode\",\n\t\t\tmode: \"imex\",\n\t\t\tdriverRootfs: \"rootfs-1\",\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tVersion: specs.CurrentVersion,\n\t\t\t\tKind: \"nvidia.com/imex-channel\",\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/nvidia-caps-imex-channels/channel0\",\n\t\t\t\t\t\t\t\t\tHostPath: \"/dev/nvidia-caps-imex-channels/channel0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"1\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/nvidia-caps-imex-channels/channel1\",\n\t\t\t\t\t\t\t\t\tHostPath: \"/dev/nvidia-caps-imex-channels/channel1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"2047\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/nvidia-caps-imex-channels/channel2047\",\n\t\t\t\t\t\t\t\t\tHostPath: \"/dev/nvidia-caps-imex-channels/channel2047\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=void\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"csv mode\",\n\t\t\tmode: \"csv\",\n\t\t\tdriverRootfs: \"rootfs-orin\",\n\t\t\tadditionalOptions: []Option{\n\t\t\t\tWithCSVFiles([]string{\n\t\t\t\t\tfilepath.Join(lookupRoot, \"rootfs-orin\", \"/etc/nvidia-container-runtime/host-files-for-container.d/devices.csv\"),\n\t\t\t\t\tfilepath.Join(lookupRoot, \"rootfs-orin\", \"/etc/nvidia-container-runtime/host-files-for-container.d/drivers.csv\"),\n\t\t\t\t}),\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tVersion: specs.CurrentVersion,\n\t\t\t\tKind: \"nvidia.com/gpu\",\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{Path: \"/dev/nvidia0\", HostPath: \"/dev/nvidia0\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"NVIDIA_VISIBLE_DEVICES=void\"},\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", ContainerPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t\t{HostPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", ContainerPath: \"/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\", Options: []string{\"ro\", \"nosuid\", \"nodev\", \"rbind\", \"rprivate\"}},\n\t\t\t\t\t},\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"create-symlinks\", \"--link\", \"libcuda.so.1::/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"update-ldcache\", \"--folder\", \"/usr/lib/aarch64-linux-gnu/nvidia\"},\n\t\t\t\t\t\t\tEnv: []string{\"NVIDIA_CTK_DEBUG=false\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tdriverRoot := tc.driverRootfs\n\t\t\tif driverRoot != \"\" {\n\t\t\t\tdriverRoot = filepath.Join(lookupRoot, tc.driverRootfs)\n\t\t\t}\n\t\t\tdevRoot := tc.devRootfs\n\t\t\tif devRoot != \"\" {\n\t\t\t\tdevRoot = filepath.Join(lookupRoot, tc.devRootfs)\n\t\t\t}\n\n\t\t\tl, err := New(\n\t\t\t\tappend([]Option{\n\t\t\t\t\tWithLogger(logger),\n\t\t\t\t\tWithMode(tc.mode),\n\t\t\t\t\tWithDriverRoot(driverRoot),\n\t\t\t\t\tWithDevRoot(devRoot),\n\t\t\t\t}, tc.additionalOptions...)...,\n\t\t\t)\n\t\t\trequire.EqualValues(t, tc.expectedInitError, err)\n\n\t\t\ts, err := l.GetSpec()\n\t\t\trequire.EqualValues(t, tc.expectedSpecError, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, test.StripRoot(test.StripRoot(s.Raw(), driverRoot), devRoot))\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/management.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils\"\n)\n\ntype managementlib nvcdilib\n\nvar _ deviceSpecGeneratorFactory = (*managementlib)(nil)\n\nfunc (l *managementlib) DeviceSpecGenerators(...string) (DeviceSpecGenerator, error) {\n\treturn l, nil\n}\n\n// GetDeviceSpecs returns the CDI device specs for a single all device.\nfunc (l *managementlib) GetDeviceSpecs() ([]specs.Device, error) {\n\tdevices, err := l.newManagementDeviceDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create device discoverer: %v\", err)\n\t}\n\n\tedits, err := l.editsFactory.FromDiscoverer(devices)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create edits from discoverer: %v\", err)\n\t}\n\n\tif len(edits.DeviceNodes) == 0 {\n\t\treturn nil, fmt.Errorf(\"no NVIDIA device nodes found\")\n\t}\n\n\tdevice := specs.Device{\n\t\tName: \"all\",\n\t\tContainerEdits: *edits.ContainerEdits,\n\t}\n\treturn []specs.Device{device}, nil\n}\n\n// GetCommonEdits returns the common edits for use in managementlib containers.\nfunc (l *managementlib) GetCommonEdits() (*cdi.ContainerEdits, error) {\n\tif l.nvsandboxutilslib != nil {\n\t\tif r := l.nvsandboxutilslib.Init(l.driver.Root); r != nvsandboxutils.SUCCESS {\n\t\t\tl.logger.Warningf(\"Failed to init nvsandboxutils: %v; ignoring\", r)\n\t\t\tl.nvsandboxutilslib = nil\n\t\t}\n\t\tdefer func() {\n\t\t\tif l.nvsandboxutilslib == nil {\n\t\t\t\treturn\n\t\t\t}\n\t\t\t_ = l.nvsandboxutilslib.Shutdown()\n\t\t}()\n\t}\n\n\tdriver, err := (*nvcdilib)(l).newDriverVersionDiscoverer()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create driver library discoverer: %v\", err)\n\t}\n\n\tedits, err := l.editsFactory.FromDiscoverer(driver)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create edits from discoverer: %v\", err)\n\t}\n\n\treturn edits, nil\n}\n\ntype managementDiscoverer struct {\n\tdiscover.Discover\n}\n\n// newManagementDeviceDiscoverer returns a discover.Discover that discovers device nodes for use in managementlib containers.\n// NVML is not used to query devices and all device nodes are returned.\nfunc (l *managementlib) newManagementDeviceDiscoverer() (discover.Discover, error) {\n\tdeviceNodes := discover.NewCharDeviceDiscoverer(\n\t\tl.logger,\n\t\tl.driver.DevRoot,\n\t\t[]string{\n\t\t\t\"/dev/nvidia*\",\n\t\t\t\"/dev/nvidia-caps/nvidia-cap*\",\n\t\t\t\"/dev/nvidia-modeset\",\n\t\t\t\"/dev/nvidia-uvm-tools\",\n\t\t\t\"/dev/nvidia-uvm\",\n\t\t\t\"/dev/nvidiactl\",\n\t\t\t\"/dev/nvidia-caps-imex-channels/channel*\",\n\t\t},\n\t)\n\n\tdeviceFolderPermissionHooks := (*nvcdilib)(l).newDeviceFolderPermissionHookDiscoverer(\n\t\tdeviceNodes,\n\t)\n\n\td := discover.Merge(\n\t\t&managementDiscoverer{deviceNodes},\n\t\tdeviceFolderPermissionHooks,\n\t)\n\treturn d, nil\n}\n\nfunc (m *managementDiscoverer) Devices() ([]discover.Device, error) {\n\tdevices, err := m.Discover.Devices()\n\tif err != nil {\n\t\treturn devices, err\n\t}\n\n\tvar filteredDevices []discover.Device\n\tfor _, device := range devices {\n\t\tif m.nodeIsBlocked(device.HostPath) {\n\t\t\tcontinue\n\t\t}\n\t\tfilteredDevices = append(filteredDevices, device)\n\t}\n\n\treturn filteredDevices, nil\n}\n\n// nodeIsBlocked returns true if the specified device node should be ignored.\nfunc (m managementDiscoverer) nodeIsBlocked(path string) bool {\n\tblockedPrefixes := []string{\"nvidia-fs\", \"nvidia-nvswitch\", \"nvidia-nvlink\"}\n\tnodeName := filepath.Base(path)\n\tfor _, prefix := range blockedPrefixes {\n\t\tif strings.HasPrefix(nodeName, prefix) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n"
},
{
"path": "pkg/nvcdi/mig-device-nvml.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/dgpu\"\n)\n\ntype migDeviceSpecGenerator struct {\n\t*fullGPUDeviceSpecGenerator\n\tmigIndex int\n\tmigUUID string\n}\n\nvar _ DeviceSpecGenerator = (*migDeviceSpecGenerator)(nil)\n\nfunc (l *migDeviceSpecGenerator) GetUUID() (string, error) {\n\treturn l.migUUID, nil\n}\n\nfunc (l *nvmllib) newMIGDeviceSpecGeneratorFromDevice(i int, d device.Device, j int, m device.MigDevice) (*migDeviceSpecGenerator, error) {\n\tparent, err := l.newFullGPUDeviceSpecGeneratorFromDevice(i, d, make(map[FeatureFlag]bool))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tmigUUID, ret := m.GetUUID()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to get MIG UUID: %v\", ret)\n\t}\n\n\te := &migDeviceSpecGenerator{\n\t\tfullGPUDeviceSpecGenerator: parent,\n\t\tmigIndex: j,\n\t\tmigUUID: migUUID,\n\t}\n\n\treturn e, nil\n}\n\nfunc (l *nvmllib) newMIGDeviceSpecGeneratorFromNVMLDevice(uuid string, nvmlMIGDevice nvml.Device) (DeviceSpecGenerator, error) {\n\tmigDevice, err := l.devicelib.NewMigDevice(nvmlMIGDevice)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tnvmlParentDevice, ret := migDevice.GetDeviceHandleFromMigDeviceHandle()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to get parent device handle: %v\", ret)\n\t}\n\tparentDevice, err := l.devicelib.NewDevice(nvmlParentDevice)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tparentIndex, ret := parentDevice.GetIndex()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to get parent device index: %v\", ret)\n\t}\n\n\tmigDeviceIndex, ret := nvmlMIGDevice.GetIndex()\n\tif ret != nvml.SUCCESS {\n\t\treturn nil, fmt.Errorf(\"failed to get MIG device index: %w\", ret)\n\t}\n\n\treturn l.newMIGDeviceSpecGeneratorFromDevice(parentIndex, parentDevice, migDeviceIndex, migDevice)\n}\n\nfunc (l *migDeviceSpecGenerator) GetDeviceSpecs() ([]specs.Device, error) {\n\tdeviceEdits, err := l.getDeviceEdits()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get CDI device edits: %w\", err)\n\t}\n\n\tnames, err := l.getNames()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get device names: %w\", err)\n\t}\n\n\tvar deviceSpecs []specs.Device\n\tfor _, name := range names {\n\t\tdeviceSpec := specs.Device{\n\t\t\tName: name,\n\t\t\tContainerEdits: *deviceEdits.ContainerEdits,\n\t\t}\n\t\tdeviceSpecs = append(deviceSpecs, deviceSpec)\n\t}\n\n\treturn deviceSpecs, nil\n}\n\nfunc (l *migDeviceSpecGenerator) migDevice() (device.MigDevice, error) {\n\treturn l.devicelib.NewMigDeviceByUUID(l.migUUID)\n}\n\n// GetMIGDeviceEdits returns the CDI edits for the MIG device represented by 'mig' on 'parent'.\nfunc (l *migDeviceSpecGenerator) getDeviceEdits() (*cdi.ContainerEdits, error) {\n\tdevice, err := l.device()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tmigDevice, err := l.migDevice()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdeviceNodes, err := dgpu.NewForMigDevice(device, migDevice,\n\t\tdgpu.WithDriver(l.driver),\n\t\tdgpu.WithLogger(l.logger),\n\t\tdgpu.WithHookCreator(l.hookCreator),\n\t\tdgpu.WithNvsandboxuitilsLib(l.nvsandboxutilslib),\n\t)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create device discoverer: %v\", err)\n\t}\n\n\teditsForDevice, err := l.editsFactory.FromDiscoverer(deviceNodes)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create container edits for Compute Instance: %v\", err)\n\t}\n\n\treturn editsForDevice, nil\n}\n\nfunc (l *migDeviceSpecGenerator) getNames() ([]string, error) {\n\treturn l.deviceNamers.GetMigDeviceNames(l.index, l.fullGPUDeviceSpecGenerator, l.migIndex, l)\n}\n"
},
{
"path": "pkg/nvcdi/mocks.go",
"content": "/**\n# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.\n# SPDX-License-Identifier: Apache-2.0\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport \"github.com/NVIDIA/go-nvlib/pkg/nvlib/info\"\n\n//go:generate moq -rm -fmt=goimports -stub -out info-interface_mock.go . infoInterface\ntype infoInterface info.Interface\n"
},
{
"path": "pkg/nvcdi/mode.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"sync\"\n\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/info\"\n)\n\ntype Mode string\n\nconst (\n\t// ModeAuto configures the CDI spec generator to automatically detect the system configuration\n\tModeAuto = Mode(\"auto\")\n\t// ModeNvml configures the CDI spec generator to use the NVML library.\n\tModeNvml = Mode(\"nvml\")\n\t// ModeWsl configures the CDI spec generator to generate a WSL spec.\n\tModeWsl = Mode(\"wsl\")\n\t// ModeManagement configures the CDI spec generator to generate a management spec.\n\tModeManagement = Mode(\"management\")\n\t// ModeGdrcopy configures the CDI spec generator to generate a GDR Copy spec.\n\tModeGdrcopy = Mode(\"gdrcopy\")\n\t// ModeGds configures the CDI spec generator to generate a GDS spec.\n\tModeGds = Mode(\"gds\")\n\t// ModeMofed configures the CDI spec generator to generate a MOFED spec.\n\tModeMofed = Mode(\"mofed\")\n\t// ModeCSV configures the CDI spec generator to generate a spec based on the contents of CSV\n\t// mountspec files.\n\tModeCSV = Mode(\"csv\")\n\t// ModeImex configures the CDI spec generator to generate a spec for the available IMEX channels.\n\tModeImex = Mode(\"imex\")\n\t// ModeNvswitch configures the CDI spec generator to generate a spec for the available nvswitch devices.\n\tModeNvswitch = Mode(\"nvswitch\")\n)\n\ntype modeConstraint interface {\n\tstring | Mode\n}\n\ntype modes struct {\n\tlookup map[Mode]bool\n\tall []Mode\n}\n\nvar validModes modes\nvar validModesOnce sync.Once\n\nfunc getModes() modes {\n\tvalidModesOnce.Do(func() {\n\t\tall := []Mode{\n\t\t\tModeAuto,\n\t\t\tModeCSV,\n\t\t\tModeGdrcopy,\n\t\t\tModeGds,\n\t\t\tModeImex,\n\t\t\tModeManagement,\n\t\t\tModeMofed,\n\t\t\tModeNvml,\n\t\t\tModeNvswitch,\n\t\t\tModeWsl,\n\t\t}\n\t\tlookup := make(map[Mode]bool)\n\n\t\tfor _, m := range all {\n\t\t\tlookup[m] = true\n\t\t}\n\n\t\tvalidModes = modes{\n\t\t\tlookup: lookup,\n\t\t\tall: all,\n\t\t}\n\t},\n\t)\n\treturn validModes\n}\n\n// AllModes returns the set of valid modes.\nfunc AllModes[T modeConstraint]() []T {\n\tvar output []T\n\tfor _, m := range getModes().all {\n\t\toutput = append(output, T(m))\n\t}\n\treturn output\n}\n\n// IsValidMode checks whether a specified mode is valid.\nfunc IsValidMode[T modeConstraint](mode T) bool {\n\treturn getModes().lookup[Mode(mode)]\n}\n\n// resolveMode resolves the mode for CDI spec generation based on the current system.\nfunc (o *options) resolveMode() (rmode Mode) {\n\tif o.mode != ModeAuto {\n\t\treturn o.mode\n\t}\n\tdefer func() {\n\t\to.logger.Infof(\"Auto-detected mode as '%v'\", rmode)\n\t}()\n\n\tplatform := o.infolib.ResolvePlatform()\n\tswitch platform {\n\tcase info.PlatformNVML:\n\t\treturn ModeNvml\n\tcase info.PlatformTegra:\n\t\treturn ModeCSV\n\tcase info.PlatformWSL:\n\t\treturn ModeWsl\n\t}\n\to.logger.Warningf(\"Unsupported platform detected: %v; assuming %v\", platform, ModeNvml)\n\treturn ModeNvml\n}\n"
},
{
"path": "pkg/nvcdi/namer.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n)\n\n// UUIDer is an interface for getting UUIDs.\ntype UUIDer interface {\n\tGetUUID() (string, error)\n}\n\n// DeviceNamers represents a list of device namers\ntype DeviceNamers []DeviceNamer\n\n// DeviceNamer is an interface for getting device names\ntype DeviceNamer interface {\n\tGetDeviceName(int, UUIDer) (string, error)\n\tGetMigDeviceName(int, UUIDer, int, UUIDer) (string, error)\n}\n\n// Supported device naming strategies\nconst (\n\t// DeviceNameStrategyIndex generates devices names such as 0 or 1:0\n\tDeviceNameStrategyIndex = \"index\"\n\t// DeviceNameStrategyTypeIndex generates devices names such as gpu0 or mig1:0\n\tDeviceNameStrategyTypeIndex = \"type-index\"\n\t// DeviceNameStrategyUUID uses the device UUID as the name\n\tDeviceNameStrategyUUID = \"uuid\"\n)\n\ntype deviceNameIndex struct {\n\tgpuPrefix string\n\tmigPrefix string\n}\ntype deviceNameUUID struct{}\n\n// NewDeviceNamer creates a Device Namer based on the supplied strategy.\n// This namer can be used to construct the names for MIG and GPU devices when generating the CDI spec.\nfunc NewDeviceNamer(strategy string) (DeviceNamer, error) {\n\tswitch strategy {\n\tcase DeviceNameStrategyIndex:\n\t\treturn deviceNameIndex{}, nil\n\tcase DeviceNameStrategyTypeIndex:\n\t\treturn deviceNameIndex{gpuPrefix: \"gpu\", migPrefix: \"mig\"}, nil\n\tcase DeviceNameStrategyUUID:\n\t\treturn deviceNameUUID{}, nil\n\t}\n\n\treturn nil, fmt.Errorf(\"invalid device name strategy: %v\", strategy)\n}\n\n// GetDeviceName returns the name for the specified device based on the naming strategy\nfunc (s deviceNameIndex) GetDeviceName(i int, _ UUIDer) (string, error) {\n\treturn fmt.Sprintf(\"%s%d\", s.gpuPrefix, i), nil\n}\n\n// GetMigDeviceName returns the name for the specified device based on the naming strategy\nfunc (s deviceNameIndex) GetMigDeviceName(i int, _ UUIDer, j int, _ UUIDer) (string, error) {\n\treturn fmt.Sprintf(\"%s%d:%d\", s.migPrefix, i, j), nil\n}\n\n// GetDeviceName returns the name for the specified device based on the naming strategy\nfunc (s deviceNameUUID) GetDeviceName(i int, d UUIDer) (string, error) {\n\tuuid, err := d.GetUUID()\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to get device UUID: %v\", err)\n\t}\n\treturn uuid, nil\n}\n\n// GetMigDeviceName returns the name for the specified device based on the naming strategy\nfunc (s deviceNameUUID) GetMigDeviceName(i int, _ UUIDer, j int, mig UUIDer) (string, error) {\n\tuuid, err := mig.GetUUID()\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to get device UUID: %v\", err)\n\t}\n\treturn uuid, nil\n}\n\n//go:generate moq -rm -fmt=goimports -stub -out namer_nvml_mock.go . nvmlUUIDer\ntype nvmlUUIDer interface {\n\tGetUUID() (string, nvml.Return)\n}\n\ntype convert struct {\n\tnvmlUUIDer\n}\n\ntype uuidUnsupported struct{}\n\nfunc (m convert) GetUUID() (string, error) {\n\tif m.nvmlUUIDer == nil {\n\t\treturn uuidUnsupported{}.GetUUID()\n\t}\n\tuuid, ret := m.nvmlUUIDer.GetUUID()\n\tif ret != nvml.SUCCESS {\n\t\treturn \"\", ret\n\t}\n\treturn uuid, nil\n}\n\nvar errUUIDUnsupported = errors.New(\"GetUUID is not supported\")\n\nfunc (m uuidUnsupported) GetUUID() (string, error) {\n\treturn \"\", errUUIDUnsupported\n}\n\nfunc (l DeviceNamers) GetDeviceNames(i int, d UUIDer) ([]string, error) {\n\tvar names []string\n\tfor _, namer := range l {\n\t\tname, err := namer.GetDeviceName(i, d)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif name == \"\" {\n\t\t\tcontinue\n\t\t}\n\t\tnames = append(names, name)\n\t}\n\tif len(names) == 0 {\n\t\treturn nil, errors.New(\"no names defined\")\n\t}\n\treturn names, nil\n}\n\nfunc (l DeviceNamers) GetMigDeviceNames(i int, d UUIDer, j int, mig UUIDer) ([]string, error) {\n\tvar names []string\n\tfor _, namer := range l {\n\t\tname, err := namer.GetMigDeviceName(i, d, j, mig)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif name == \"\" {\n\t\t\tcontinue\n\t\t}\n\t\tnames = append(names, name)\n\t}\n\tif len(names) == 0 {\n\t\treturn nil, errors.New(\"no names defined\")\n\t}\n\treturn names, nil\n}\n"
},
{
"path": "pkg/nvcdi/namer_nvml_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage nvcdi\n\nimport (\n\t\"sync\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n)\n\n// Ensure, that nvmlUUIDerMock does implement nvmlUUIDer.\n// If this is not the case, regenerate this file with moq.\nvar _ nvmlUUIDer = &nvmlUUIDerMock{}\n\n// nvmlUUIDerMock is a mock implementation of nvmlUUIDer.\n//\n//\tfunc TestSomethingThatUsesnvmlUUIDer(t *testing.T) {\n//\n//\t\t// make and configure a mocked nvmlUUIDer\n//\t\tmockednvmlUUIDer := &nvmlUUIDerMock{\n//\t\t\tGetUUIDFunc: func() (string, nvml.Return) {\n//\t\t\t\tpanic(\"mock out the GetUUID method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockednvmlUUIDer in code that requires nvmlUUIDer\n//\t\t// and then make assertions.\n//\n//\t}\ntype nvmlUUIDerMock struct {\n\t// GetUUIDFunc mocks the GetUUID method.\n\tGetUUIDFunc func() (string, nvml.Return)\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// GetUUID holds details about calls to the GetUUID method.\n\t\tGetUUID []struct {\n\t\t}\n\t}\n\tlockGetUUID sync.RWMutex\n}\n\n// GetUUID calls GetUUIDFunc.\nfunc (mock *nvmlUUIDerMock) GetUUID() (string, nvml.Return) {\n\tcallInfo := struct {\n\t}{}\n\tmock.lockGetUUID.Lock()\n\tmock.calls.GetUUID = append(mock.calls.GetUUID, callInfo)\n\tmock.lockGetUUID.Unlock()\n\tif mock.GetUUIDFunc == nil {\n\t\tvar (\n\t\t\tsOut string\n\t\t\treturnOut nvml.Return\n\t\t)\n\t\treturn sOut, returnOut\n\t}\n\treturn mock.GetUUIDFunc()\n}\n\n// GetUUIDCalls gets all the calls that were made to GetUUID.\n// Check the length with:\n//\n//\tlen(mockednvmlUUIDer.GetUUIDCalls())\nfunc (mock *nvmlUUIDerMock) GetUUIDCalls() []struct {\n} {\n\tvar calls []struct {\n\t}\n\tmock.lockGetUUID.RLock()\n\tcalls = mock.calls.GetUUID\n\tmock.lockGetUUID.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "pkg/nvcdi/namer_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"testing\"\n\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestConvert(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tnvml nvmlUUIDer\n\t\texpectedError error\n\t\texpecteUUID string\n\t}{\n\t\t{\n\t\t\tdescription: \"empty UUIDer returns error\",\n\t\t\texpectedError: errUUIDUnsupported,\n\t\t\texpecteUUID: \"\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"nvmlUUIDer returns UUID\",\n\t\t\tnvml: &nvmlUUIDerMock{\n\t\t\t\tGetUUIDFunc: func() (string, nvml.Return) {\n\t\t\t\t\treturn \"SOME_UUID\", nvml.SUCCESS\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: nil,\n\t\t\texpecteUUID: \"SOME_UUID\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"nvmlUUIDer returns error\",\n\t\t\tnvml: &nvmlUUIDerMock{\n\t\t\t\tGetUUIDFunc: func() (string, nvml.Return) {\n\t\t\t\t\treturn \"SOME_UUID\", nvml.ERROR_UNKNOWN\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: nvml.ERROR_UNKNOWN,\n\t\t\texpecteUUID: \"\",\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tuuid, err := convert{tc.nvml}.GetUUID()\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\trequire.Equal(t, tc.expecteUUID, uuid)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/options.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/device\"\n\t\"github.com/NVIDIA/go-nvlib/pkg/nvlib/info\"\n\t\"github.com/NVIDIA/go-nvml/pkg/nvml\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/edits\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/nvsandboxutils\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/platform-support/tegra/csv\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/lookup\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\ntype options struct {\n\tlogger logger.Interface\n\tplatformlibs\n\tmode Mode\n\tdeviceNamers DeviceNamers\n\tdriverRoot string\n\tdevRoot string\n\tnvidiaCDIHookPath string\n\tldconfigPath string\n\tconfigSearchPaths []string\n\tlibrarySearchPaths []string\n\n\tcsv csvOptions\n\n\tvendor string\n\tclass string\n\n\tmergedDeviceOptions []transform.MergedDeviceOption\n\n\tfeatureFlags map[FeatureFlag]bool\n\n\tdisabledHooks []discover.HookName\n\tenabledHooks []discover.HookName\n\n\teditsFactory edits.Factory\n}\n\ntype platformlibs struct {\n\tnvmllib nvml.Interface\n\tdevicelib device.Interface\n\tinfolib info.Interface\n\n\tnvsandboxutilslib nvsandboxutils.Interface\n}\n\n// populateOptions applies the functional options and resolves the required\n// defaults.\nfunc populateOptions(opts ...Option) *options {\n\to := &options{\n\t\tmode: ModeAuto,\n\t\tdriverRoot: \"/\",\n\t\tnvidiaCDIHookPath: \"/usr/bin/nvidia-cdi-hook\",\n\t}\n\tfor _, opt := range opts {\n\t\topt(o)\n\t}\n\tif o.logger == nil {\n\t\to.logger = logger.New()\n\t}\n\tif len(o.deviceNamers) == 0 {\n\t\tindexNamer, _ := NewDeviceNamer(DeviceNameStrategyIndex)\n\t\to.deviceNamers = []DeviceNamer{indexNamer}\n\t}\n\tif o.devRoot == \"\" {\n\t\to.devRoot = o.driverRoot\n\t}\n\tif o.nvsandboxutilslib == nil {\n\t\to.nvsandboxutilslib = o.getNvsandboxUtilsLib()\n\t}\n\tif o.nvmllib == nil {\n\t\to.nvmllib = o.getNvmlLib()\n\t}\n\tif o.devicelib == nil {\n\t\to.devicelib = device.New(o.nvmllib)\n\t}\n\tif o.infolib == nil {\n\t\to.infolib = info.New(\n\t\t\tinfo.WithRoot(o.driverRoot),\n\t\t\tinfo.WithLogger(o.logger),\n\t\t\tinfo.WithNvmlLib(o.nvmllib),\n\t\t\tinfo.WithDeviceLib(o.devicelib),\n\t\t)\n\t}\n\to.mode = o.resolveMode()\n\n\tif o.mode == ModeCSV && len(o.csv.Files) == 0 {\n\t\to.csv.Files = csv.DefaultFileList()\n\t}\n\n\tif o.mode == ModeCSV && o.csv.CompatContainerRoot == \"\" {\n\t\to.csv.CompatContainerRoot = defaultOrinCompatContainerRoot\n\t}\n\n\tif o.mode == ModeManagement {\n\t\t// For management mode we explicitly disable the hooks that enable CUDA\n\t\t// compatibility and disable device node modifications.\n\t\to.disabledHooks = append(o.disabledHooks, HookEnableCudaCompat, DisableDeviceNodeModificationHook)\n\t}\n\n\tif o.editsFactory == nil {\n\t\to.editsFactory = edits.NewFactory(\n\t\t\tedits.WithLogger(o.logger),\n\t\t\tedits.WithNoAdditionalGIDsForDeviceNodes(o.featureFlags[FeatureNoAdditionalGIDsForDeviceNodes]),\n\t\t)\n\t}\n\n\treturn o\n}\n\nfunc (o *options) driverLibraryLocator() lookup.Locator {\n\treturn lookup.NewLibraryLocator(\n\t\tlookup.WithLogger(o.logger),\n\t\tlookup.WithRoot(o.driverRoot),\n\t\tlookup.WithSearchPaths(o.librarySearchPaths...),\n\t)\n}\n\nfunc (o *options) getVendorOrDefault() string {\n\tif o.vendor != \"\" {\n\t\treturn o.vendor\n\t}\n\tswitch o.mode {\n\tcase ModeManagement:\n\t\treturn \"management.nvidia.com\"\n\tdefault:\n\t\treturn \"nvidia.com\"\n\t}\n}\n\nfunc (o *options) getClassOrDefault() string {\n\tif o.class != \"\" {\n\t\treturn o.class\n\t}\n\tswitch o.mode {\n\tcase ModeImex:\n\t\treturn classImexChannel\n\tcase ModeGdrcopy, ModeGds, ModeMofed, ModeNvswitch:\n\t\treturn string(o.mode)\n\tdefault:\n\t\treturn \"gpu\"\n\t}\n}\n\n// Option is a function that configures the nvcdi library options.\ntype Option func(*options)\n\n// WithDeviceLib sets the device library for the library\nfunc WithDeviceLib(devicelib device.Interface) Option {\n\treturn func(l *options) {\n\t\tl.devicelib = devicelib\n\t}\n}\n\n// WithInfoLib sets the info library for CDI spec generation.\nfunc WithInfoLib(infolib info.Interface) Option {\n\treturn func(l *options) {\n\t\tl.infolib = infolib\n\t}\n}\n\n// WithDeviceNamers sets the device namer for the library\nfunc WithDeviceNamers(namers ...DeviceNamer) Option {\n\treturn func(l *options) {\n\t\tl.deviceNamers = namers\n\t}\n}\n\n// WithDriverRoot sets the driver root for the library\nfunc WithDriverRoot(root string) Option {\n\treturn func(l *options) {\n\t\tl.driverRoot = root\n\t}\n}\n\n// WithDevRoot sets the root where /dev is located.\nfunc WithDevRoot(root string) Option {\n\treturn func(l *options) {\n\t\tl.devRoot = root\n\t}\n}\n\nfunc WithEditsFactory(editsFactory edits.Factory) Option {\n\treturn func(l *options) {\n\t\tl.editsFactory = editsFactory\n\t}\n}\n\n// WithLogger sets the logger for the library\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(l *options) {\n\t\tl.logger = logger\n\t}\n}\n\n// WithNVIDIACTKPath sets the path to the NVIDIA Container Toolkit CLI path for the library\n//\n// Deprecated: Use WithNVIDIACDIHookPath instead.\nfunc WithNVIDIACTKPath(path string) Option {\n\treturn WithNVIDIACDIHookPath(path)\n}\n\n// WithNVIDIACDIHookPath sets the path to the NVIDIA Container Toolkit CLI path for the library\nfunc WithNVIDIACDIHookPath(path string) Option {\n\treturn func(l *options) {\n\t\tl.nvidiaCDIHookPath = path\n\t}\n}\n\n// WithLdconfigPath sets the path to the ldconfig program\nfunc WithLdconfigPath(path string) Option {\n\treturn func(l *options) {\n\t\tl.ldconfigPath = path\n\t}\n}\n\n// WithNvmlLib sets the nvml library for the library\nfunc WithNvmlLib(nvmllib nvml.Interface) Option {\n\treturn func(l *options) {\n\t\tl.nvmllib = nvmllib\n\t}\n}\n\n// WithMode sets the discovery mode for the library\nfunc WithMode[m modeConstraint](mode m) Option {\n\treturn func(l *options) {\n\t\tl.mode = Mode(mode)\n\t}\n}\n\n// WithVendor sets the vendor for the library\nfunc WithVendor(vendor string) Option {\n\treturn func(o *options) {\n\t\to.vendor = vendor\n\t}\n}\n\n// WithClass sets the class for the library\nfunc WithClass(class string) Option {\n\treturn func(o *options) {\n\t\to.class = class\n\t}\n}\n\n// WithMergedDeviceOptions sets the merged device options for the library\n// If these are not set, no merged device will be generated.\nfunc WithMergedDeviceOptions(opts ...transform.MergedDeviceOption) Option {\n\treturn func(o *options) {\n\t\to.mergedDeviceOptions = opts\n\t}\n}\n\n// WithCSVFiles sets the CSV files for the library\nfunc WithCSVFiles(csvFiles []string) Option {\n\treturn func(o *options) {\n\t\to.csv.Files = csvFiles\n\t}\n}\n\n// WithCSVIgnorePatterns sets the ignore patterns for entries in the CSV files.\nfunc WithCSVIgnorePatterns(csvIgnorePatterns []string) Option {\n\treturn func(o *options) {\n\t\to.csv.IgnorePatterns = csvIgnorePatterns\n\t}\n}\n\n// WithCSVCompatContainerRoot sets the compat root to use for the container in\n// the case of nvgpu-only devices.\nfunc WithCSVCompatContainerRoot(csvCompatContainerRoot string) Option {\n\treturn func(o *options) {\n\t\to.csv.CompatContainerRoot = csvCompatContainerRoot\n\t}\n}\n\n// WithConfigSearchPaths sets the search paths for config files.\nfunc WithConfigSearchPaths(paths []string) Option {\n\treturn func(o *options) {\n\t\to.configSearchPaths = paths\n\t}\n}\n\n// WithLibrarySearchPaths sets the library search paths.\n// This is currently only used for CSV-mode.\nfunc WithLibrarySearchPaths(paths []string) Option {\n\treturn func(o *options) {\n\t\to.librarySearchPaths = paths\n\t}\n}\n\n// WithDisabledHooks allows specific hooks to be disabled.\nfunc WithDisabledHooks[T string | HookName](hooks ...T) Option {\n\treturn func(o *options) {\n\t\tfor _, hook := range hooks {\n\t\t\to.disabledHooks = append(o.disabledHooks, discover.HookName(hook))\n\t\t}\n\t}\n}\n\n// WithEnabledHooks explicitly enables a specific set of hooks.\n// If a hook is explicitly enabled, this takes precedence over it being disabled.\nfunc WithEnabledHooks[T string | HookName](hooks ...T) Option {\n\treturn func(o *options) {\n\t\tfor _, hook := range hooks {\n\t\t\to.enabledHooks = append(o.enabledHooks, discover.HookName(hook))\n\t\t}\n\t}\n}\n\n// WithFeatureFlags allows the specified set of features to be toggled on.\nfunc WithFeatureFlags[T string | FeatureFlag](featureFlags ...T) Option {\n\treturn func(o *options) {\n\t\tif o.featureFlags == nil {\n\t\t\to.featureFlags = make(map[FeatureFlag]bool)\n\t\t}\n\t\tfor _, featureFlag := range featureFlags {\n\t\t\t// The initial release of the FeatureDisableNvsandboxUtils feature\n\t\t\t// flag included a typo which we handle here.\n\t\t\tif string(featureFlag) == \"disable-nvsandbox-utils\" {\n\t\t\t\tfeatureFlag = T(FeatureDisableNvsandboxUtils)\n\t\t\t}\n\t\t\to.featureFlags[FeatureFlag(featureFlag)] = true\n\t\t}\n\t}\n}\n\n// WithDisabledHook allows specific hooks to be disabled.\n// This option can be specified multiple times for each hook.\n//\n// Deprecated: Use WithDisabledHooks instead\nfunc WithDisabledHook[T string | HookName](hook T) Option {\n\treturn WithDisabledHooks(hook)\n}\n\n// WithFeatureFlag allows specified features to be toggled on.\n// This option can be specified multiple times for each feature flag.\n//\n// Deprecated: Use WithFeatureFlags\nfunc WithFeatureFlag[T string | FeatureFlag](featureFlag T) Option {\n\treturn WithFeatureFlags(featureFlag)\n}\n"
},
{
"path": "pkg/nvcdi/spec/api.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage spec\n\nimport (\n\t\"io\"\n\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nconst (\n\t// DetectMinimumVersion is a constant that triggers a spec to detect the minimum required version.\n\t//\n\t// Deprecated: DetectMinimumVersion is deprecated and will be removed.\n\tDetectMinimumVersion = \"DETECT_MINIMUM_VERSION\"\n\n\t// FormatJSON indicates a JSON output format\n\tFormatJSON = \"json\"\n\t// FormatYAML indicates a YAML output format\n\tFormatYAML = \"yaml\"\n)\n\n// Interface is the interface for the spec API\ntype Interface interface {\n\tio.WriterTo\n\tSave(string) error\n\tRaw() *specs.Spec\n}\n"
},
{
"path": "pkg/nvcdi/spec/builder.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage spec\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/parser\"\n\tcdi \"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\ntype builder struct {\n\traw *cdi.Spec\n\tversion string\n\tvendor string\n\tclass string\n\tdeviceSpecs []cdi.Device\n\tedits cdi.ContainerEdits\n\tformat string\n\n\tmergedDeviceOptions []transform.MergedDeviceOption\n\tnoSimplify bool\n\tpermissions os.FileMode\n\n\ttransformOnSave transform.Transformer\n}\n\n// newBuilder creates a new spec builder with the supplied options\nfunc newBuilder(opts ...Option) *builder {\n\ts := &builder{}\n\tfor _, opt := range opts {\n\t\topt(s)\n\t}\n\n\tif s.raw != nil {\n\t\ts.noSimplify = true\n\t\tvendor, class := parser.ParseQualifier(s.raw.Kind)\n\t\tif s.vendor == \"\" {\n\t\t\ts.vendor = vendor\n\t\t}\n\t\tif s.class == \"\" {\n\t\t\ts.class = class\n\t\t}\n\t\tif s.version == \"\" || s.version == DetectMinimumVersion {\n\t\t\ts.version = s.raw.Version\n\t\t}\n\t}\n\tif s.version == \"\" || s.version == DetectMinimumVersion {\n\t\ts.transformOnSave = &setMinimumRequiredVersion{}\n\t\ts.version = cdi.CurrentVersion\n\t}\n\tif s.vendor == \"\" {\n\t\ts.vendor = \"nvidia.com\"\n\t}\n\tif s.class == \"\" {\n\t\ts.class = \"gpu\"\n\t}\n\tif s.format == \"\" {\n\t\ts.format = FormatYAML\n\t}\n\tif s.permissions == 0 {\n\t\ts.permissions = 0644\n\t}\n\treturn s\n}\n\n// Build builds a CDI spec form the spec builder.\nfunc (o *builder) Build() (*spec, error) {\n\traw := o.raw\n\tif raw == nil {\n\t\traw = &cdi.Spec{\n\t\t\tVersion: o.version,\n\t\t\tKind: fmt.Sprintf(\"%s/%s\", o.vendor, o.class),\n\t\t\tDevices: o.deviceSpecs,\n\t\t\tContainerEdits: o.edits,\n\t\t}\n\t}\n\tif raw.Version == \"\" {\n\t\traw.Version = o.version\n\t}\n\n\tif !o.noSimplify {\n\t\terr := transform.NewSimplifier().Transform(raw)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to simplify spec: %v\", err)\n\t\t}\n\t}\n\n\tif len(o.mergedDeviceOptions) > 0 {\n\t\tmerge, err := transform.NewMergedDevice(o.mergedDeviceOptions...)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to create merged device transformer: %v\", err)\n\t\t}\n\t\tif err := merge.Transform(raw); err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to merge devices: %v\", err)\n\t\t}\n\t}\n\n\ts := spec{\n\t\tSpec: raw,\n\t\tformat: o.format,\n\t\tpermissions: o.permissions,\n\t\ttransformOnSave: o.transformOnSave,\n\t}\n\treturn &s, nil\n}\n\n// Option defines a function that can be used to configure the spec builder.\ntype Option func(*builder)\n\n// WithDeviceSpecs sets the device specs for the spec builder\nfunc WithDeviceSpecs(deviceSpecs []cdi.Device) Option {\n\treturn func(o *builder) {\n\t\to.deviceSpecs = deviceSpecs\n\t}\n}\n\n// WithEdits sets the container edits for the spec builder\nfunc WithEdits(edits cdi.ContainerEdits) Option {\n\treturn func(o *builder) {\n\t\to.edits = edits\n\t}\n}\n\n// WithVersion sets the version for the spec builder\nfunc WithVersion(version string) Option {\n\treturn func(o *builder) {\n\t\to.version = version\n\t}\n}\n\n// WithVendor sets the vendor for the spec builder\nfunc WithVendor(vendor string) Option {\n\treturn func(o *builder) {\n\t\to.vendor = vendor\n\t}\n}\n\n// WithClass sets the class for the spec builder\nfunc WithClass(class string) Option {\n\treturn func(o *builder) {\n\t\to.class = class\n\t}\n}\n\n// WithFormat sets the output file format\nfunc WithFormat(format string) Option {\n\treturn func(o *builder) {\n\t\to.format = format\n\t}\n}\n\n// WithNoSimplify sets whether the spec must be simplified\nfunc WithNoSimplify(noSimplify bool) Option {\n\treturn func(o *builder) {\n\t\to.noSimplify = noSimplify\n\t}\n}\n\n// WithRawSpec sets the raw spec for the spec builder\nfunc WithRawSpec(raw *cdi.Spec) Option {\n\treturn func(o *builder) {\n\t\to.raw = raw\n\t}\n}\n\n// WithPermissions sets the permissions for the generated spec file\nfunc WithPermissions(permissions os.FileMode) Option {\n\treturn func(o *builder) {\n\t\to.permissions = permissions\n\t}\n}\n\n// WithMergedDeviceOptions sets the options for generating a merged device.\nfunc WithMergedDeviceOptions(opts ...transform.MergedDeviceOption) Option {\n\treturn func(o *builder) {\n\t\to.mergedDeviceOptions = opts\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/spec/set-minimum-version.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage spec\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\ntype setMinimumRequiredVersion struct{}\n\nfunc (d setMinimumRequiredVersion) Transform(spec *specs.Spec) error {\n\tminVersion, err := cdi.MinimumRequiredVersion(spec)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to get minimum required CDI spec version: %v\", err)\n\t}\n\tspec.Version = minVersion\n\treturn nil\n}\n"
},
{
"path": "pkg/nvcdi/spec/spec.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage spec\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\ntype spec struct {\n\t*specs.Spec\n\tformat string\n\tpermissions os.FileMode\n\ttransformOnSave transform.Transformer\n}\n\nvar _ Interface = (*spec)(nil)\n\n// New creates a new spec with the specified options.\nfunc New(opts ...Option) (Interface, error) {\n\treturn newBuilder(opts...).Build()\n}\n\n// Save writes the spec to the specified path and overwrites the file if it exists.\nfunc (s *spec) Save(path string) error {\n\tif s.transformOnSave != nil {\n\t\terr := s.transformOnSave.Transform(s.Raw())\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"error applying transform: %w\", err)\n\t\t}\n\t}\n\tpath, err := s.normalizePath(path)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to normalize path: %w\", err)\n\t}\n\n\tspecDir, filename := filepath.Split(path)\n\tcache, _ := cdi.NewCache(\n\t\tcdi.WithAutoRefresh(false),\n\t\tcdi.WithSpecDirs(specDir),\n\t)\n\tif err := cache.WriteSpec(s.Raw(), filename); err != nil {\n\t\treturn fmt.Errorf(\"failed to write spec: %w\", err)\n\t}\n\n\tspecDirAsRoot, err := os.OpenRoot(specDir)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to open root: %w\", err)\n\t}\n\tdefer specDirAsRoot.Close()\n\n\tif err := specDirAsRoot.Chmod(filename, s.permissions); err != nil {\n\t\treturn fmt.Errorf(\"failed to set permissions on spec file: %w\", err)\n\t}\n\n\treturn nil\n}\n\n// WriteTo writes the spec to the specified writer.\nfunc (s *spec) WriteTo(w io.Writer) (int64, error) {\n\ttmpFile, err := os.CreateTemp(\"\", \"nvcdi-spec-*\"+s.extension())\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\ttmpDir, tmpFileName := filepath.Split(tmpFile.Name())\n\n\ttmpDirRoot, err := os.OpenRoot(tmpDir)\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\tdefer tmpDirRoot.Close()\n\tdefer func() {\n\t\t_ = tmpDirRoot.Remove(tmpFileName)\n\t}()\n\n\tif err := s.Save(tmpFile.Name()); err != nil {\n\t\treturn 0, err\n\t}\n\n\tif err := tmpFile.Close(); err != nil {\n\t\treturn 0, fmt.Errorf(\"failed to close temporary file: %w\", err)\n\t}\n\n\tsavedFile, err := tmpDirRoot.Open(tmpFileName)\n\tif err != nil {\n\t\treturn 0, fmt.Errorf(\"failed to open temporary file: %w\", err)\n\t}\n\tdefer savedFile.Close()\n\n\treturn savedFile.WriteTo(w)\n}\n\n// Raw returns a pointer to the raw spec.\nfunc (s *spec) Raw() *specs.Spec {\n\treturn s.Spec\n}\n\n// normalizePath ensures that the specified path has a supported extension\nfunc (s *spec) normalizePath(path string) (string, error) {\n\tif ext := filepath.Ext(path); ext != \".yaml\" && ext != \".json\" {\n\t\tpath += s.extension()\n\t}\n\n\tif filepath.Clean(filepath.Dir(path)) == \".\" {\n\t\tpwd, err := os.Getwd()\n\t\tif err != nil {\n\t\t\treturn path, fmt.Errorf(\"failed to get current working directory: %v\", err)\n\t\t}\n\t\tpath = filepath.Join(pwd, path)\n\t}\n\n\treturn path, nil\n}\n\nfunc (s *spec) extension() string {\n\tswitch s.format {\n\tcase FormatJSON:\n\t\treturn \".json\"\n\tcase FormatYAML:\n\t\treturn \".yaml\"\n\t}\n\n\treturn \".yaml\"\n}\n"
},
{
"path": "pkg/nvcdi/spec/spec_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage spec\n\nimport (\n\t\"bytes\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform/root\"\n)\n\nfunc TestSpec(t *testing.T) {\n\tminimalSpec := &specs.Spec{\n\t\tKind: \"nvidia.com/gpu\",\n\t\tDevices: []specs.Device{\n\t\t\t{\n\t\t\t\tName: \"one\",\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"DEVICE_FOO=bar\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\toptions []Option\n\t\texpectedNewError error\n\t\ttransform transform.Transformer\n\t\texpectedSpec string\n\t}{\n\t\t{\n\t\t\tdescription: \"version is overridden\",\n\t\t\toptions: []Option{WithVersion(\"0.8.0\"), WithRawSpec(minimalSpec)},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.8.0\nkind: nvidia.com/gpu\ndevices:\n - name: one\n containerEdits:\n env:\n - DEVICE_FOO=bar\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"raw spec is used as is\",\n\t\t\toptions: []Option{WithRawSpec(\n\t\t\t\t&specs.Spec{\n\t\t\t\t\tVersion: \"0.5.0\",\n\t\t\t\t\tKind: \"nvidia.com/gpu\",\n\t\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tName: \"one\",\n\t\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\t\tEnv: []string{\"DEVICE_FOO=bar\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t)},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.5.0\nkind: nvidia.com/gpu\ndevices:\n - name: one\n containerEdits:\n env:\n - DEVICE_FOO=bar\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"raw spec with no version uses minimum version\",\n\t\t\toptions: []Option{WithRawSpec(\n\t\t\t\t&specs.Spec{\n\t\t\t\t\tKind: \"nvidia.com/gpu\",\n\t\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tName: \"one\",\n\t\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\t\tEnv: []string{\"DEVICE_FOO=bar\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t)},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.3.0\nkind: nvidia.com/gpu\ndevices:\n - name: one\n containerEdits:\n env:\n - DEVICE_FOO=bar\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"spec with host dev path uses 0.5.0 version\",\n\t\t\toptions: []Option{WithRawSpec(\n\t\t\t\t&specs.Spec{\n\t\t\t\t\tKind: \"nvidia.com/gpu\",\n\t\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tName: \"one\",\n\t\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\t\tEnv: []string{\"DEVICE_FOO=bar\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tHostPath: \"/some/dev/dev0\",\n\t\t\t\t\t\t\t\tPath: \"/dev/dev0\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t)},\n\t\t\texpectedSpec: `---\ncdiVersion: 0.5.0\nkind: nvidia.com/gpu\ndevices:\n - name: one\n containerEdits:\n env:\n - DEVICE_FOO=bar\ncontainerEdits:\n deviceNodes:\n - path: /dev/dev0\n hostPath: /some/dev/dev0\n`,\n\t\t},\n\t\t{\n\t\t\tdescription: \"transformed spec uses minimum version\",\n\t\t\toptions: []Option{WithRawSpec(\n\t\t\t\t&specs.Spec{\n\t\t\t\t\tKind: \"nvidia.com/gpu\",\n\t\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tName: \"one\",\n\t\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\t\tEnv: []string{\"DEVICE_FOO=bar\"},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\tHostPath: \"/some/dev/dev0\",\n\t\t\t\t\t\t\t\tPath: \"/dev/dev0\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t)},\n\t\t\ttransform: transform.Merge(\n\t\t\t\troot.New(\n\t\t\t\t\troot.WithRoot(\"/some/dev/\"),\n\t\t\t\t\troot.WithTargetRoot(\"/dev/\"),\n\t\t\t\t\troot.WithRelativeTo(\"host\"),\n\t\t\t\t),\n\t\t\t\ttransform.NewSimplifier(),\n\t\t\t),\n\t\t\texpectedSpec: `---\ncdiVersion: 0.5.0\nkind: nvidia.com/gpu\ndevices:\n - name: one\n containerEdits:\n env:\n - DEVICE_FOO=bar\ncontainerEdits:\n deviceNodes:\n - path: /dev/dev0\n hostPath: /dev/dev0\n`,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\n\t\t\ts, err := New(tc.options...)\n\t\t\trequire.ErrorIs(t, err, tc.expectedNewError)\n\n\t\t\tif tc.transform != nil {\n\t\t\t\terr := tc.transform.Transform(s.Raw())\n\t\t\t\trequire.NoError(t, err)\n\t\t\t}\n\n\t\t\tbuf := new(bytes.Buffer)\n\n\t\t\t_, err = s.WriteTo(buf)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, buf.String())\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/transform/api.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport \"tags.cncf.io/container-device-interface/specs-go\"\n\n// Transformer defines the API for applying arbitrary transforms to a spec in-place\ntype Transformer interface {\n\tTransform(*specs.Spec) error\n}\n"
},
{
"path": "pkg/nvcdi/transform/deduplicate.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"slices\"\n\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\ntype dedupe struct{}\n\nvar _ Transformer = (*dedupe)(nil)\n\n// NewDedupe creates a transformer that deduplicates container edits.\nfunc NewDedupe() (Transformer, error) {\n\treturn &dedupe{}, nil\n}\n\n// Transform removes duplicate entris from devices and common container edits.\nfunc (d dedupe) Transform(spec *specs.Spec) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\tif err := d.transformEdits(&spec.ContainerEdits); err != nil {\n\t\treturn err\n\t}\n\tvar updatedDevices []specs.Device\n\tfor _, device := range spec.Devices {\n\t\tdevice := device\n\t\tif err := d.transformEdits(&device.ContainerEdits); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tupdatedDevices = append(updatedDevices, device)\n\t}\n\tspec.Devices = updatedDevices\n\treturn nil\n}\n\nfunc (d dedupe) transformEdits(edits *specs.ContainerEdits) error {\n\tadditionalGIDs, err := d.deduplicateAdditionalGIDs(edits.AdditionalGIDs)\n\tif err != nil {\n\t\treturn err\n\t}\n\tedits.AdditionalGIDs = additionalGIDs\n\n\tdeviceNodes, err := d.deduplicateDeviceNodes(edits.DeviceNodes)\n\tif err != nil {\n\t\treturn err\n\t}\n\tedits.DeviceNodes = deviceNodes\n\n\tenvs, err := d.deduplicateEnvs(edits.Env)\n\tif err != nil {\n\t\treturn err\n\t}\n\tedits.Env = envs\n\n\thooks, err := d.deduplicateHooks(edits.Hooks)\n\tif err != nil {\n\t\treturn err\n\t}\n\tedits.Hooks = hooks\n\n\tmounts, err := d.deduplicateMounts(edits.Mounts)\n\tif err != nil {\n\t\treturn err\n\t}\n\tedits.Mounts = mounts\n\n\treturn nil\n}\n\nfunc (d dedupe) deduplicateDeviceNodes(entities []*specs.DeviceNode) ([]*specs.DeviceNode, error) {\n\tseen := make(map[string]bool)\n\tvar deviceNodes []*specs.DeviceNode\n\tfor _, e := range entities {\n\t\tif e == nil {\n\t\t\tcontinue\n\t\t}\n\t\tid, err := deviceNode(*e).id()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif seen[id] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[id] = true\n\t\tdeviceNodes = append(deviceNodes, e)\n\t}\n\treturn deviceNodes, nil\n}\n\nfunc (d dedupe) deduplicateEnvs(entities []string) ([]string, error) {\n\tseen := make(map[string]bool)\n\tvar envs []string\n\tfor _, e := range entities {\n\t\tid := e\n\t\tif seen[id] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[id] = true\n\t\tenvs = append(envs, e)\n\t}\n\treturn envs, nil\n}\n\nfunc (d dedupe) deduplicateHooks(entities []*specs.Hook) ([]*specs.Hook, error) {\n\tseen := make(map[string]bool)\n\tvar hooks []*specs.Hook\n\tfor _, e := range entities {\n\t\tif e == nil {\n\t\t\tcontinue\n\t\t}\n\t\tid, err := hook(*e).id()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif seen[id] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[id] = true\n\t\thooks = append(hooks, e)\n\t}\n\treturn hooks, nil\n}\n\nfunc (d dedupe) deduplicateMounts(entities []*specs.Mount) ([]*specs.Mount, error) {\n\tseen := make(map[string]bool)\n\tvar mounts []*specs.Mount\n\tfor _, e := range entities {\n\t\tif e == nil {\n\t\t\tcontinue\n\t\t}\n\t\tid, err := mount(*e).id()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif seen[id] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[id] = true\n\t\tmounts = append(mounts, e)\n\t}\n\treturn mounts, nil\n}\n\nfunc (d dedupe) deduplicateAdditionalGIDs(entities []uint32) ([]uint32, error) {\n\tseen := make(map[uint32]bool)\n\tvar additionalGIDs []uint32\n\tfor _, e := range entities {\n\t\tif seen[e] {\n\t\t\tcontinue\n\t\t}\n\t\tseen[e] = true\n\t\tadditionalGIDs = append(additionalGIDs, e)\n\t}\n\n\tslices.Sort(additionalGIDs)\n\n\treturn additionalGIDs, nil\n}\n"
},
{
"path": "pkg/nvcdi/transform/deduplicate_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nfunc TestDeduplicate(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tspec *specs.Spec\n\t\texpectedError error\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"nil spec\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicate deviceNode is removed\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/gpu0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/gpu0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/gpu0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicate deviceNode is remved from device edits\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/gpu0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/gpu0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/gpu0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicate hook is removed\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicate mount is removed\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHostPath: \"/host/mount2\",\n\t\t\t\t\t\t\t\t\tContainerPath: \"/mount2\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHostPath: \"/host/mount2\",\n\t\t\t\t\t\t\t\t\tContainerPath: \"/mount2\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHostPath: \"/host/mount1\",\n\t\t\t\t\t\t\t\t\tContainerPath: \"/mount1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/mount1\",\n\t\t\t\t\t\t\tContainerPath: \"/mount1\",\n\t\t\t\t\t\t\tOptions: []string{\"bind\", \"ro\"},\n\t\t\t\t\t\t\tType: \"tmpfs\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/mount1\",\n\t\t\t\t\t\t\tContainerPath: \"/mount1\",\n\t\t\t\t\t\t\tOptions: []string{\"bind\", \"ro\"},\n\t\t\t\t\t\t\tType: \"tmpfs\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/mount1\",\n\t\t\t\t\t\t\tContainerPath: \"/mount1\",\n\t\t\t\t\t\t\tOptions: []string{\"bind\", \"ro\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHostPath: \"/host/mount2\",\n\t\t\t\t\t\t\t\t\tContainerPath: \"/mount2\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHostPath: \"/host/mount1\",\n\t\t\t\t\t\t\t\t\tContainerPath: \"/mount1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/mount1\",\n\t\t\t\t\t\t\tContainerPath: \"/mount1\",\n\t\t\t\t\t\t\tOptions: []string{\"bind\", \"ro\"},\n\t\t\t\t\t\t\tType: \"tmpfs\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/mount1\",\n\t\t\t\t\t\t\tContainerPath: \"/mount1\",\n\t\t\t\t\t\t\tOptions: []string{\"bind\", \"ro\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"duplicate env is removed\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tEnv: []string{\"ENV1=VAL1\", \"ENV1=VAL1\", \"ENV2=ONE_VALUE\", \"ENV2=ANOTHER_VALUE\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"ENV1=VAL1\", \"ENV1=VAL1\", \"ENV2=ONE_VALUE\", \"ENV2=ANOTHER_VALUE\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tEnv: []string{\"ENV1=VAL1\", \"ENV2=ONE_VALUE\", \"ENV2=ANOTHER_VALUE\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"ENV1=VAL1\", \"ENV2=ONE_VALUE\", \"ENV2=ANOTHER_VALUE\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\td := dedupe{}\n\n\t\t\terr := d.Transform(tc.spec)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\treturn\n\t\t\t}\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, tc.spec)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/transform/edits.go",
"content": "/*\n*\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"encoding/json\"\n\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\ntype containerEdits specs.ContainerEdits\n\n// IsEmpty returns true if the edits are empty.\nfunc (e containerEdits) IsEmpty() bool {\n\t// Devices with empty edits are invalid\n\tif len(e.DeviceNodes) > 0 {\n\t\treturn false\n\t}\n\tif len(e.Env) > 0 {\n\t\treturn false\n\t}\n\tif len(e.Hooks) > 0 {\n\t\treturn false\n\t}\n\tif len(e.Mounts) > 0 {\n\t\treturn false\n\t}\n\n\treturn true\n}\n\nfunc (e *containerEdits) getEntityIds() ([]string, error) {\n\tif e == nil {\n\t\treturn nil, nil\n\t}\n\tuniqueIDs := make(map[string]bool)\n\n\tdeviceNodes, err := e.getDeviceNodeIDs()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tfor k := range deviceNodes {\n\t\tuniqueIDs[k] = true\n\t}\n\n\tenvs, err := e.getEnvIDs()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tfor k := range envs {\n\t\tuniqueIDs[k] = true\n\t}\n\n\thooks, err := e.getHookIDs()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tfor k := range hooks {\n\t\tuniqueIDs[k] = true\n\t}\n\n\tmounts, err := e.getMountIDs()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tfor k := range mounts {\n\t\tuniqueIDs[k] = true\n\t}\n\n\tvar ids []string\n\tfor k := range uniqueIDs {\n\t\tids = append(ids, k)\n\t}\n\n\treturn ids, nil\n}\n\nfunc (e *containerEdits) getDeviceNodeIDs() (map[string]bool, error) {\n\tdeviceIDs := make(map[string]bool)\n\tfor _, entity := range e.DeviceNodes {\n\t\tid, err := deviceNode(*entity).id()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tdeviceIDs[id] = true\n\t}\n\treturn deviceIDs, nil\n}\n\nfunc (e *containerEdits) getEnvIDs() (map[string]bool, error) {\n\tenvIDs := make(map[string]bool)\n\tfor _, entity := range e.Env {\n\t\tid, err := env(entity).id()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tenvIDs[id] = true\n\t}\n\treturn envIDs, nil\n}\n\nfunc (e *containerEdits) getHookIDs() (map[string]bool, error) {\n\thookIDs := make(map[string]bool)\n\tfor _, entity := range e.Hooks {\n\t\tid, err := hook(*entity).id()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\thookIDs[id] = true\n\t}\n\treturn hookIDs, nil\n}\n\nfunc (e *containerEdits) getMountIDs() (map[string]bool, error) {\n\tmountIDs := make(map[string]bool)\n\tfor _, entity := range e.Mounts {\n\t\tid, err := mount(*entity).id()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tmountIDs[id] = true\n\t}\n\treturn mountIDs, nil\n}\n\ntype deviceNode specs.DeviceNode\n\nfunc (dn deviceNode) id() (string, error) {\n\tb, err := json.Marshal(dn)\n\treturn string(b), err\n}\n\ntype env string\n\nfunc (e env) id() (string, error) {\n\treturn string(e), nil\n}\n\ntype mount specs.Mount\n\nfunc (m mount) id() (string, error) {\n\tb, err := json.Marshal(m)\n\treturn string(b), err\n}\n\ntype hook specs.Hook\n\nfunc (m hook) id() (string, error) {\n\tb, err := json.Marshal(m)\n\treturn string(b), err\n}\n"
},
{
"path": "pkg/nvcdi/transform/merge.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport \"tags.cncf.io/container-device-interface/specs-go\"\n\ntype merged []Transformer\n\n// Merge creates a merged transofrmer from the specified transformers.\nfunc Merge(transformers ...Transformer) Transformer {\n\treturn merged(transformers)\n}\n\n// Transform applies all the transformers in the merged set.\nfunc (t merged) Transform(spec *specs.Spec) error {\n\tfor _, transformer := range t {\n\t\tif err := transformer.Transform(spec); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n"
},
{
"path": "pkg/nvcdi/transform/merged-device.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/edits\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/pkg/parser\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nconst (\n\tallDeviceName = \"all\"\n)\n\ntype mergedDevice struct {\n\tname string\n\tskipIfExists bool\n\tsimplifier Transformer\n}\n\nvar _ Transformer = (*mergedDevice)(nil)\n\n// MergedDeviceOption is a function that configures a merged device\ntype MergedDeviceOption func(*mergedDevice)\n\n// WithName sets the name of the merged device\nfunc WithName(name string) MergedDeviceOption {\n\treturn func(m *mergedDevice) {\n\t\tm.name = name\n\t}\n}\n\n// WithSkipIfExists sets whether to skip adding the merged device if it already exists\nfunc WithSkipIfExists(skipIfExists bool) MergedDeviceOption {\n\treturn func(m *mergedDevice) {\n\t\tm.skipIfExists = skipIfExists\n\t}\n}\n\n// NewMergedDevice creates a transformer with the specified options\nfunc NewMergedDevice(opts ...MergedDeviceOption) (Transformer, error) {\n\tm := &mergedDevice{}\n\tfor _, opt := range opts {\n\t\topt(m)\n\t}\n\tif m.name == \"\" {\n\t\tm.name = allDeviceName\n\t}\n\tm.simplifier = NewSimplifier()\n\n\tif err := parser.ValidateDeviceName(m.name); err != nil {\n\t\treturn nil, fmt.Errorf(\"invalid device name %q: %v\", m.name, err)\n\t}\n\n\treturn m, nil\n}\n\n// Transform adds a merged device to the spec\nfunc (m mergedDevice) Transform(spec *specs.Spec) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\n\tmergedDevice, err := mergeDeviceSpecs(spec.Devices, m.name)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to generate merged device %q: %v\", m.name, err)\n\t}\n\tif mergedDevice == nil {\n\t\tif m.skipIfExists {\n\t\t\treturn nil\n\t\t}\n\t\treturn fmt.Errorf(\"device %q already exists\", m.name)\n\t}\n\n\tspec.Devices = append(spec.Devices, *mergedDevice)\n\n\tif err := m.simplifier.Transform(spec); err != nil {\n\t\treturn fmt.Errorf(\"failed to simplify spec after merging device %q: %v\", m.name, err)\n\t}\n\n\treturn nil\n}\n\n// mergeDeviceSpecs creates a device with the specified name which combines the edits from the previous devices.\n// If a device of the specified name already exists, no device is created and nil is returned.\nfunc mergeDeviceSpecs(deviceSpecs []specs.Device, mergedDeviceName string) (*specs.Device, error) {\n\tfor _, d := range deviceSpecs {\n\t\tif d.Name == mergedDeviceName {\n\t\t\treturn nil, nil\n\t\t}\n\t}\n\n\tmergedEdits := edits.EmptyFactory.New()\n\n\tfor _, d := range deviceSpecs {\n\t\td := d\n\t\tedit := cdi.ContainerEdits{\n\t\t\tContainerEdits: &d.ContainerEdits,\n\t\t}\n\t\tmergedEdits.Append(&edit)\n\t}\n\n\tmerged := specs.Device{\n\t\tName: mergedDeviceName,\n\t\tContainerEdits: *mergedEdits.ContainerEdits,\n\t}\n\treturn &merged, nil\n}\n"
},
{
"path": "pkg/nvcdi/transform/merged-device_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"fmt\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nfunc TestMergeDeviceSpecs(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdeviceSpecs []specs.Device\n\t\tmergedDeviceName string\n\t\tcreateError error\n\t\texpectedError error\n\t\texpected *specs.Device\n\t}{\n\t\t{\n\t\t\tdescription: \"no devices\",\n\t\t\tmergedDeviceName: \"all\",\n\t\t\texpected: &specs.Device{\n\t\t\t\tName: \"all\",\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"one device\",\n\t\t\tmergedDeviceName: \"all\",\n\t\t\tdeviceSpecs: []specs.Device{\n\t\t\t\t{\n\t\t\t\t\tName: \"gpu0\",\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tEnv: []string{\"GPU=0\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: &specs.Device{\n\t\t\t\tName: \"all\",\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"GPU=0\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"two devices\",\n\t\t\tmergedDeviceName: \"all\",\n\t\t\tdeviceSpecs: []specs.Device{\n\t\t\t\t{\n\t\t\t\t\tName: \"gpu0\",\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tEnv: []string{\"GPU=0\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tName: \"gpu1\",\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tEnv: []string{\"GPU=1\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: &specs.Device{\n\t\t\t\tName: \"all\",\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"GPU=0\", \"GPU=1\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"has merged device\",\n\t\t\tmergedDeviceName: \"gpu0\",\n\t\t\tdeviceSpecs: []specs.Device{\n\t\t\t\t{\n\t\t\t\t\tName: \"gpu0\",\n\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\tEnv: []string{\"GPU=0\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"invalid merged device name\",\n\t\t\tmergedDeviceName: \".-not-valid\",\n\t\t\tcreateError: fmt.Errorf(\"invalid device name %q\", \".-not-valid\"),\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\t_, err := NewMergedDevice(\n\t\t\t\tWithName(tc.mergedDeviceName),\n\t\t\t)\n\t\t\tif tc.createError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\treturn\n\t\t\t}\n\t\t\trequire.NoError(t, err)\n\n\t\t\tdevice, err := mergeDeviceSpecs(tc.deviceSpecs, tc.mergedDeviceName)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\treturn\n\t\t\t}\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expected, device)\n\t\t})\n\t}\n}\n\nfunc TestMergedDevice(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tspec *specs.Spec\n\t\texpectedError error\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"duplicate hooks are removed\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"gpu0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"gpu1\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"gpu0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"gpu1\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tm, err := NewMergedDevice()\n\t\t\trequire.NoError(t, err)\n\n\t\t\terr = m.Transform(tc.spec)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\treturn\n\t\t\t}\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, tc.spec)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/transform/noop/no-op.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage noop\n\nimport (\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\ntype noop struct{}\n\nvar _ transform.Transformer = (*noop)(nil)\n\n// New returns a no-op transformer.\nfunc New() transform.Transformer {\n\treturn noop{}\n}\n\n// Transform is a no-op for a noop transformer.\nfunc (n noop) Transform(spec *specs.Spec) error {\n\treturn nil\n}\n"
},
{
"path": "pkg/nvcdi/transform/remove.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\ntype remove map[string]bool\n\nfunc newRemover(ids ...string) Transformer {\n\tr := make(remove)\n\tfor _, id := range ids {\n\t\tr[id] = true\n\t}\n\treturn r\n}\n\n// Transform remove the specified entities from the spec.\nfunc (r remove) Transform(spec *specs.Spec) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\n\tfor _, device := range spec.Devices {\n\t\tdevice := device\n\t\tif err := r.transformEdits(&device.ContainerEdits); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to remove edits from device %q: %w\", device.Name, err)\n\t\t}\n\t}\n\n\treturn r.transformEdits(&spec.ContainerEdits)\n}\n\nfunc (r remove) transformEdits(edits *specs.ContainerEdits) error {\n\tif edits == nil {\n\t\treturn nil\n\t}\n\n\tvar deviceNodes []*specs.DeviceNode\n\tfor _, entity := range edits.DeviceNodes {\n\t\tid, err := deviceNode(*entity).id()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif r[id] {\n\t\t\tcontinue\n\t\t}\n\t\tdeviceNodes = append(deviceNodes, entity)\n\t}\n\tedits.DeviceNodes = deviceNodes\n\n\tvar envs []string\n\tfor _, entity := range edits.Env {\n\t\tid := entity\n\t\tif r[id] {\n\t\t\tcontinue\n\t\t}\n\t\tenvs = append(envs, entity)\n\t}\n\tedits.Env = envs\n\n\tvar hooks []*specs.Hook\n\tfor _, entity := range edits.Hooks {\n\t\tid, err := hook(*entity).id()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif r[id] {\n\t\t\tcontinue\n\t\t}\n\t\thooks = append(hooks, entity)\n\t}\n\tedits.Hooks = hooks\n\n\tvar mounts []*specs.Mount\n\tfor _, entity := range edits.Mounts {\n\t\tid, err := mount(*entity).id()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif r[id] {\n\t\t\tcontinue\n\t\t}\n\t\tmounts = append(mounts, entity)\n\t}\n\tedits.Mounts = mounts\n\n\treturn nil\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/builder.go",
"content": "/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform/noop\"\n)\n\ntype builder struct {\n\ttransformer\n\trelativeTo string\n}\n\nfunc (b *builder) build() transform.Transformer {\n\tif b.root == b.targetRoot {\n\t\treturn noop.New()\n\t}\n\n\tif b.relativeTo == \"container\" {\n\t\treturn containerRootTransformer(b.transformer)\n\t}\n\treturn hostRootTransformer(b.transformer)\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/container-root.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\n// containerRootTransformer transforms the roots of container paths in a CDI spec.\ntype containerRootTransformer transformer\n\nvar _ transform.Transformer = (*containerRootTransformer)(nil)\n\n// Transform replaces the root in a spec with a new root.\n// It walks the spec and replaces all container paths that start with root with the target root.\nfunc (t containerRootTransformer) Transform(spec *specs.Spec) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\n\tfor _, d := range spec.Devices {\n\t\td := d\n\t\tif err := t.applyToEdits(&d.ContainerEdits); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to apply root transform to device %s: %w\", d.Name, err)\n\t\t}\n\t}\n\n\tif err := t.applyToEdits(&spec.ContainerEdits); err != nil {\n\t\treturn fmt.Errorf(\"failed to apply root transform to spec: %w\", err)\n\t}\n\treturn nil\n}\n\nfunc (t containerRootTransformer) applyToEdits(edits *specs.ContainerEdits) error {\n\tfor i, dn := range edits.DeviceNodes {\n\t\tedits.DeviceNodes[i] = t.transformDeviceNode(dn)\n\t}\n\n\tfor i, hook := range edits.Hooks {\n\t\tedits.Hooks[i] = t.transformHook(hook)\n\t}\n\n\tfor i, mount := range edits.Mounts {\n\t\tedits.Mounts[i] = t.transformMount(mount)\n\t}\n\n\treturn nil\n}\n\nfunc (t containerRootTransformer) transformDeviceNode(dn *specs.DeviceNode) *specs.DeviceNode {\n\tdn.Path = t.transformPath(dn.Path)\n\n\treturn dn\n}\n\nfunc (t containerRootTransformer) transformHook(hook *specs.Hook) *specs.Hook {\n\t// The Path in the startContainer hook MUST resolve in the container namespace.\n\tif hook.HookName == \"startContainer\" {\n\t\thook.Path = t.transformPath(hook.Path)\n\t}\n\n\t// The createContainer and startContainer hooks MUST execute in the container namespace.\n\tif hook.HookName != \"createContainer\" && hook.HookName != \"startContainer\" {\n\t\treturn hook\n\t}\n\n\tvar args []string\n\tfor _, arg := range hook.Args {\n\t\tif !strings.Contains(arg, \"::\") {\n\t\t\targs = append(args, t.transformPath(arg))\n\t\t\tcontinue\n\t\t}\n\n\t\t// For the 'create-symlinks' hook, special care is taken for the\n\t\t// '--link' flag argument which takes the form ::.\n\t\t// Both paths, the target and link paths, are transformed.\n\t\tsplit := strings.SplitN(arg, \"::\", 2)\n\t\tsplit[0] = t.transformPath(split[0])\n\t\tsplit[1] = t.transformPath(split[1])\n\t\targs = append(args, strings.Join(split, \"::\"))\n\t}\n\thook.Args = args\n\n\treturn hook\n}\n\nfunc (t containerRootTransformer) transformMount(mount *specs.Mount) *specs.Mount {\n\tmount.ContainerPath = t.transformPath(mount.ContainerPath)\n\treturn mount\n}\n\nfunc (t containerRootTransformer) transformPath(path string) string {\n\treturn (transformer)(t).transformPath(path)\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/container-root_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nfunc TestContainerRootTransformer(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\troot string\n\t\ttargetRoot string\n\t\tspec *specs.Spec\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"nil spec\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: nil,\n\t\t\texpectedSpec: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty spec\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{},\n\t\t\texpectedSpec: &specs.Spec{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device nodes\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{HostPath: \"/root/dev/nvidia0\", Path: \"/root/dev/nvidia0\"},\n\t\t\t\t\t\t{HostPath: \"/target-root/dev/nvidia1\", Path: \"/target-root/dev/nvidia1\"},\n\t\t\t\t\t\t{HostPath: \"/different-root/dev/nvidia2\", Path: \"/different-root/dev/nvidia2\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{HostPath: \"/root/dev/nvidia0\", Path: \"/target-root/dev/nvidia0\"},\n\t\t\t\t\t\t{HostPath: \"/target-root/dev/nvidia1\", Path: \"/target-root/dev/nvidia1\"},\n\t\t\t\t\t\t{HostPath: \"/different-root/dev/nvidia2\", Path: \"/different-root/dev/nvidia2\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mounts\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{HostPath: \"/root/lib/lib1.so\", ContainerPath: \"/root/lib/lib1.so\"},\n\t\t\t\t\t\t{HostPath: \"/target-root/lib/lib2.so\", ContainerPath: \"/target-root/lib/lib2.so\"},\n\t\t\t\t\t\t{HostPath: \"/different-root/lib/lib3.so\", ContainerPath: \"/different-root/lib/lib3.so\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{HostPath: \"/root/lib/lib1.so\", ContainerPath: \"/target-root/lib/lib1.so\"},\n\t\t\t\t\t\t{HostPath: \"/target-root/lib/lib2.so\", ContainerPath: \"/target-root/lib/lib2.so\"},\n\t\t\t\t\t\t{HostPath: \"/different-root/lib/lib3.so\", ContainerPath: \"/different-root/lib/lib3.so\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"hooks\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/different-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/different-root/path/to/target::/different-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/different-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/different-root/path/to/target::/different-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"update ldcache hooks\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"nvidia-cdi-hook\", \"update-ldcache\",\n\t\t\t\t\t\t\t\t\"--folder\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"nvidia-cdi-hook\", \"update-ldcache\",\n\t\t\t\t\t\t\t\t\"--folder\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/different-root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"nvidia-cdi-hook\", \"update-ldcache\",\n\t\t\t\t\t\t\t\t\"--folder\",\n\t\t\t\t\t\t\t\t\"/different-root/path/to/target\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"nvidia-cdi-hook\", \"update-ldcache\",\n\t\t\t\t\t\t\t\t\"--folder\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"nvidia-cdi-hook\", \"update-ldcache\",\n\t\t\t\t\t\t\t\t\"--folder\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/different-root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"nvidia-cdi-hook\", \"update-ldcache\",\n\t\t\t\t\t\t\t\t\"--folder\",\n\t\t\t\t\t\t\t\t\"/different-root/path/to/target\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"startContainer hook updates path and arguments\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"startContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"startContainer\",\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"createContainer hook skips path but updates arguments\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"createRuntime hook skips path and arguments\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createRuntime\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createRuntime\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\terr := New(\n\t\t\t\tWithRoot(tc.root),\n\t\t\t\tWithTargetRoot(tc.targetRoot),\n\t\t\t\tWithRelativeTo(\"container\"),\n\t\t\t).Transform(tc.spec)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, tc.spec, tc.expectedSpec)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/driver-root.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\ntype DriverOption func(*driverOptions)\n\nfunc WithDriverRoot(root string) DriverOption {\n\treturn func(do *driverOptions) {\n\t\tdo.driverRoot = root\n\t}\n}\n\nfunc WithTargetDriverRoot(root string) DriverOption {\n\treturn func(do *driverOptions) {\n\t\tdo.targetDriverRoot = root\n\t}\n}\n\nfunc WithDevRoot(root string) DriverOption {\n\treturn func(do *driverOptions) {\n\t\tdo.devRoot = root\n\t}\n}\n\nfunc WithTargetDevRoot(root string) DriverOption {\n\treturn func(do *driverOptions) {\n\t\tdo.targetDevRoot = root\n\t}\n}\n\ntype driverOptions struct {\n\tdriverRoot string\n\ttargetDriverRoot string\n\tdevRoot string\n\ttargetDevRoot string\n}\n\n// NewDriverTransformer creates a transformer for transforming driver specifications.\nfunc NewDriverTransformer(opts ...DriverOption) transform.Transformer {\n\td := &driverOptions{}\n\tfor _, opt := range opts {\n\t\topt(d)\n\t}\n\tif d.driverRoot == \"\" {\n\t\td.driverRoot = \"/\"\n\t}\n\tif d.targetDriverRoot == \"\" {\n\t\td.targetDriverRoot = \"/\"\n\t}\n\tif d.devRoot == \"\" {\n\t\td.devRoot = d.driverRoot\n\t}\n\tif d.targetDevRoot == \"\" {\n\t\td.targetDevRoot = d.targetDriverRoot\n\t}\n\n\tvar transformers []transform.Transformer\n\n\tif d.targetDevRoot != d.targetDriverRoot {\n\t\tdevRootTransformer := New(\n\t\t\tWithRoot(ensureDev(d.devRoot)),\n\t\t\tWithTargetRoot(ensureDev(d.targetDevRoot)),\n\t\t)\n\t\ttransformers = append(transformers, devRootTransformer)\n\t}\n\n\tdriverRootTransformer := New(\n\t\tWithRoot(d.driverRoot),\n\t\tWithTargetRoot(d.targetDriverRoot),\n\t)\n\ttransformers = append(transformers, driverRootTransformer)\n\n\treturn transform.Merge(transformers...)\n}\n\nfunc ensureDev(p string) string {\n\treturn filepath.Join(strings.TrimSuffix(filepath.Clean(p), \"/dev\"), \"/dev\")\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/driver-root_test.go",
"content": "/**\n# Copyright 2024 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nfunc TestDriverTransformer(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdriverRoot string\n\t\ttargetDriverRoot string\n\t\tdevRoot string\n\t\ttargetDevRoot string\n\t\tspec *specs.Spec\n\t\texpectedError error\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"dev root not specified\",\n\t\t\tdriverRoot: \"/driver-root\",\n\t\t\ttargetDriverRoot: \"/host/driver/root/\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/driver-root/host/path\",\n\t\t\t\t\t\t\tContainerPath: \"/driver-root/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/driver-root/dev/host/path\",\n\t\t\t\t\t\t\tPath: \"/driver-root/dev/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/driver/root/host/path\",\n\t\t\t\t\t\t\tContainerPath: \"/driver-root/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/driver/root/dev/host/path\",\n\t\t\t\t\t\t\tPath: \"/driver-root/dev/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"dev driver root matches\",\n\t\t\tdriverRoot: \"/driver-root\",\n\t\t\ttargetDriverRoot: \"/host/driver/root/\",\n\t\t\tdevRoot: \"/driver-root\",\n\t\t\ttargetDevRoot: \"/host/driver/root/\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/driver-root/host/path\",\n\t\t\t\t\t\t\tContainerPath: \"/driver-root/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/driver-root/dev/host/path\",\n\t\t\t\t\t\t\tPath: \"/driver-root/dev/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/driver/root/host/path\",\n\t\t\t\t\t\t\tContainerPath: \"/driver-root/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/driver/root/dev/host/path\",\n\t\t\t\t\t\t\tPath: \"/driver-root/dev/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"dev driver root matches separate target dev root\",\n\t\t\tdriverRoot: \"/driver-root\",\n\t\t\ttargetDriverRoot: \"/host/driver/root/\",\n\t\t\tdevRoot: \"/driver-root\",\n\t\t\ttargetDevRoot: \"/host/dev/root/\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/driver-root/host/path\",\n\t\t\t\t\t\t\tContainerPath: \"/driver-root/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/driver-root/dev/host/path\",\n\t\t\t\t\t\t\tPath: \"/driver-root/dev/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/driver/root/host/path\",\n\t\t\t\t\t\t\tContainerPath: \"/driver-root/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/dev/root/dev/host/path\",\n\t\t\t\t\t\t\tPath: \"/driver-root/dev/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"dev root specified with explicit target\",\n\t\t\tdriverRoot: \"/driver-root\",\n\t\t\ttargetDriverRoot: \"/host/driver/root/\",\n\t\t\tdevRoot: \"/\",\n\t\t\ttargetDevRoot: \"/dev/root/\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/driver-root/host/path\",\n\t\t\t\t\t\t\tContainerPath: \"/driver-root/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/dev/host/path\",\n\t\t\t\t\t\t\tPath: \"/dev/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/host/driver/root/host/path\",\n\t\t\t\t\t\t\tContainerPath: \"/driver-root/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHostPath: \"/dev/root/dev/host/path\",\n\t\t\t\t\t\t\tPath: \"/dev/container/path\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ttransformer := NewDriverTransformer(\n\t\t\t\tWithDriverRoot(tc.driverRoot),\n\t\t\t\tWithTargetDriverRoot(tc.targetDriverRoot),\n\t\t\t\tWithDevRoot(tc.devRoot),\n\t\t\t\tWithTargetDevRoot(tc.targetDevRoot),\n\t\t\t)\n\n\t\t\terr := transformer.Transform(tc.spec)\n\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\trequire.EqualValues(t, tc.expectedSpec, tc.spec)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/host-root.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\n// hostRootTransformer transforms the roots of host paths in a CDI spec.\ntype hostRootTransformer transformer\n\nvar _ transform.Transformer = (*hostRootTransformer)(nil)\n\n// Transform replaces the root in a spec with a new root.\n// It walks the spec and replaces all host paths that start with root with the target root.\nfunc (t hostRootTransformer) Transform(spec *specs.Spec) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\n\tfor _, d := range spec.Devices {\n\t\td := d\n\t\tif err := t.applyToEdits(&d.ContainerEdits); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to apply root transform to device %s: %w\", d.Name, err)\n\t\t}\n\t}\n\n\tif err := t.applyToEdits(&spec.ContainerEdits); err != nil {\n\t\treturn fmt.Errorf(\"failed to apply root transform to spec: %w\", err)\n\t}\n\treturn nil\n}\n\nfunc (t hostRootTransformer) applyToEdits(edits *specs.ContainerEdits) error {\n\tfor i, dn := range edits.DeviceNodes {\n\t\tedits.DeviceNodes[i] = t.transformDeviceNode(dn)\n\t}\n\n\tfor i, hook := range edits.Hooks {\n\t\tedits.Hooks[i] = t.transformHook(hook)\n\t}\n\n\tfor i, mount := range edits.Mounts {\n\t\tedits.Mounts[i] = t.transformMount(mount)\n\t}\n\n\treturn nil\n}\n\nfunc (t hostRootTransformer) transformDeviceNode(dn *specs.DeviceNode) *specs.DeviceNode {\n\tif dn.HostPath == \"\" {\n\t\tdn.HostPath = dn.Path\n\t}\n\tdn.HostPath = t.transformPath(dn.HostPath)\n\n\treturn dn\n}\n\nfunc (t hostRootTransformer) transformHook(hook *specs.Hook) *specs.Hook {\n\t// The Path in the startContainer hook MUST resolve in the container namespace.\n\tif hook.HookName != \"startContainer\" {\n\t\thook.Path = t.transformPath(hook.Path)\n\t}\n\n\t// The createContainer and startContainer hooks MUST execute in the container namespace.\n\tif hook.HookName == \"createContainer\" || hook.HookName == \"startContainer\" {\n\t\treturn hook\n\t}\n\n\tvar args []string\n\tfor _, arg := range hook.Args {\n\t\tif !strings.Contains(arg, \"::\") {\n\t\t\targs = append(args, t.transformPath(arg))\n\t\t\tcontinue\n\t\t}\n\n\t\t// For the 'create-symlinks' hook, special care is taken for the\n\t\t// '--link' flag argument which takes the form ::.\n\t\t// Both paths, the target and link paths, are transformed.\n\t\tsplit := strings.SplitN(arg, \"::\", 2)\n\t\tsplit[0] = t.transformPath(split[0])\n\t\tsplit[1] = t.transformPath(split[1])\n\t\targs = append(args, strings.Join(split, \"::\"))\n\t}\n\thook.Args = args\n\n\treturn hook\n}\n\nfunc (t hostRootTransformer) transformMount(mount *specs.Mount) *specs.Mount {\n\tmount.HostPath = t.transformPath(mount.HostPath)\n\treturn mount\n}\n\nfunc (t hostRootTransformer) transformPath(path string) string {\n\treturn (transformer)(t).transformPath(path)\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/host-root_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nfunc TestHostRootTransformer(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\troot string\n\t\ttargetRoot string\n\t\tspec *specs.Spec\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"nil spec\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: nil,\n\t\t\texpectedSpec: nil,\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty spec\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{},\n\t\t\texpectedSpec: &specs.Spec{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"device nodes\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{HostPath: \"/root/dev/nvidia0\", Path: \"/root/dev/nvidia0\"},\n\t\t\t\t\t\t{HostPath: \"/target-root/dev/nvidia1\", Path: \"/target-root/dev/nvidia1\"},\n\t\t\t\t\t\t{HostPath: \"/different-root/dev/nvidia2\", Path: \"/different-root/dev/nvidia2\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{HostPath: \"/target-root/dev/nvidia0\", Path: \"/root/dev/nvidia0\"},\n\t\t\t\t\t\t{HostPath: \"/target-root/dev/nvidia1\", Path: \"/target-root/dev/nvidia1\"},\n\t\t\t\t\t\t{HostPath: \"/different-root/dev/nvidia2\", Path: \"/different-root/dev/nvidia2\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mounts\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{HostPath: \"/root/lib/lib1.so\", ContainerPath: \"/root/lib/lib1.so\"},\n\t\t\t\t\t\t{HostPath: \"/target-root/lib/lib2.so\", ContainerPath: \"/target-root/lib/lib2.so\"},\n\t\t\t\t\t\t{HostPath: \"/different-root/lib/lib3.so\", ContainerPath: \"/different-root/lib/lib3.so\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{HostPath: \"/target-root/lib/lib1.so\", ContainerPath: \"/root/lib/lib1.so\"},\n\t\t\t\t\t\t{HostPath: \"/target-root/lib/lib2.so\", ContainerPath: \"/target-root/lib/lib2.so\"},\n\t\t\t\t\t\t{HostPath: \"/different-root/lib/lib3.so\", ContainerPath: \"/different-root/lib/lib3.so\"},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"hooks\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/different-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/different-root/path/to/target::/different-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/different-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/different-root/path/to/target::/different-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"createContainer hook skips arguments\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"startContainer hook skips path and arguments\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"startContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"startContainer\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"createRuntime hook updates path and arguments\",\n\t\t\troot: \"/root\",\n\t\t\ttargetRoot: \"/target-root\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createRuntime\",\n\t\t\t\t\t\t\tPath: \"/root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/root/path/to/target::/root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tHookName: \"createRuntime\",\n\t\t\t\t\t\t\tPath: \"/target-root/usr/bin/nvidia-ctk\",\n\t\t\t\t\t\t\tArgs: []string{\n\t\t\t\t\t\t\t\t\"--link\",\n\t\t\t\t\t\t\t\t\"/target-root/path/to/target::/target-root/path/to/link\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\terr := New(\n\t\t\t\tWithRoot(tc.root),\n\t\t\t\tWithTargetRoot(tc.targetRoot),\n\t\t\t).Transform(tc.spec)\n\t\t\trequire.NoError(t, err)\n\t\t\trequire.Equal(t, tc.spec, tc.expectedSpec)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/options.go",
"content": "/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\n// Option defines a functional option for configuring a transormer.\ntype Option func(*builder)\n\n// WithRoot sets the (from) root for the root transformer.\nfunc WithRoot(root string) Option {\n\treturn func(b *builder) {\n\t\tb.root = root\n\t}\n}\n\n// WithTargetRoot sets the (to) target root for the root transformer.\nfunc WithTargetRoot(root string) Option {\n\treturn func(b *builder) {\n\t\tb.targetRoot = root\n\t}\n}\n\n// WithRelativeTo sets whether the specified root is relative to the host or container.\nfunc WithRelativeTo(relativeTo string) Option {\n\treturn func(b *builder) {\n\t\tb.relativeTo = relativeTo\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/transform/root/root.go",
"content": "/**\n# Copyright 2023 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage root\n\nimport (\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\n// transformer transforms roots of paths.\ntype transformer struct {\n\troot string\n\ttargetRoot string\n}\n\n// New creates a root transformer using the specified options.\nfunc New(opts ...Option) transform.Transformer {\n\tb := &builder{}\n\tfor _, opt := range opts {\n\t\topt(b)\n\t}\n\treturn b.build()\n}\n\nfunc (t transformer) transformPath(path string) string {\n\tif !strings.HasPrefix(path, t.root) {\n\t\treturn path\n\t}\n\n\treturn filepath.Join(t.targetRoot, strings.TrimPrefix(path, t.root))\n}\n"
},
{
"path": "pkg/nvcdi/transform/simplify.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\ntype simplify struct{}\n\nvar _ Transformer = (*simplify)(nil)\n\n// NewSimplifier creates a simplifier transformer.\n// This transoformer ensures that entities in the spec are deduplicated and that common edits are removed from device-specific edits.\nfunc NewSimplifier() Transformer {\n\treturn Merge(\n\t\tdedupe{},\n\t\tsimplify{},\n\t\tsorter{},\n\t)\n}\n\n// Transform simplifies the supplied spec.\n// Edits that are present in the common edits are removed from device-specific edits.\nfunc (s simplify) Transform(spec *specs.Spec) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\n\tdedupe := dedupe{}\n\tif err := dedupe.Transform(spec); err != nil {\n\t\treturn err\n\t}\n\n\tcommonEntityIDs, err := (*containerEdits)(&spec.ContainerEdits).getEntityIds()\n\tif err != nil {\n\t\treturn err\n\t}\n\n\ttoRemove := newRemover(commonEntityIDs...)\n\tvar updatedDevices []specs.Device\n\tfor _, device := range spec.Devices {\n\t\tdeviceAsSpec := specs.Spec{\n\t\t\tContainerEdits: device.ContainerEdits,\n\t\t}\n\t\terr := toRemove.Transform(&deviceAsSpec)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to transform device edits: %w\", err)\n\t\t}\n\n\t\tif !(containerEdits)(deviceAsSpec.ContainerEdits).IsEmpty() {\n\t\t\t// Devices with empty edits are invalid.\n\t\t\t// We only update the container edits for the device if this would\n\t\t\t// result in a valid device.\n\t\t\tdevice.ContainerEdits = deviceAsSpec.ContainerEdits\n\t\t}\n\t\tupdatedDevices = append(updatedDevices, device)\n\t}\n\tspec.Devices = updatedDevices\n\n\treturn nil\n}\n"
},
{
"path": "pkg/nvcdi/transform/simplify_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nfunc TestSimplify(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tspec *specs.Spec\n\t\texpectedError error\n\t\texpectedSpec *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"nil spec is a no-op\",\n\t\t},\n\t\t{\n\t\t\tdescription: \"empty spec is simplified\",\n\t\t\tspec: &specs.Spec{},\n\t\t\texpectedSpec: &specs.Spec{},\n\t\t},\n\t\t{\n\t\t\tdescription: \"simplify does not allow empty device\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tEnv: []string{\"FOO=BAR\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"FOO=BAR\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tEnv: []string{\"FOO=BAR\"},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"FOO=BAR\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"simplify removes common entities\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tEnv: []string{\"FOO=BAR\"},\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/gpu0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"FOO=BAR\"},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/gpu0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tEnv: []string{\"FOO=BAR\"},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"simplify removes hooks\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"gpu0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"gpu1\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedSpec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"gpu0\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"gpu1\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"all\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tHooks: []*specs.Hook{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tHookName: \"createContainer\",\n\t\t\t\t\t\t\t\t\tPath: \"/usr/bin/nvidia-cdi-hook\",\n\t\t\t\t\t\t\t\t\tArgs: []string{\"nvidia-cdi-hook\", \"chmod\", \"--mode\", \"755\", \"--path\", \"/dev/dri\"},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ts := simplify{}\n\n\t\t\terr := s.Transform(tc.spec)\n\t\t\tif tc.expectedError != nil {\n\t\t\t\trequire.Error(t, err)\n\t\t\t\treturn\n\t\t\t}\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expectedSpec, tc.spec)\n\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/transform/sorter.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"os\"\n\t\"path/filepath\"\n\t\"sort\"\n\t\"strings\"\n\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\ntype sorter struct{}\n\nvar _ Transformer = (*sorter)(nil)\n\n// NewSorter creates a transformer that sorts container edits.\nfunc NewSorter() Transformer {\n\treturn nil\n}\n\n// Transform sorts the entities in the specified CDI specification.\nfunc (d sorter) Transform(spec *specs.Spec) error {\n\tif spec == nil {\n\t\treturn nil\n\t}\n\tif err := d.transformEdits(&spec.ContainerEdits); err != nil {\n\t\treturn err\n\t}\n\tvar updatedDevices []specs.Device\n\tfor _, device := range spec.Devices {\n\t\tdevice := device\n\t\tif err := d.transformEdits(&device.ContainerEdits); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tupdatedDevices = append(updatedDevices, device)\n\t}\n\tspec.Devices = d.sortDevices(updatedDevices)\n\treturn nil\n}\n\nfunc (d sorter) transformEdits(edits *specs.ContainerEdits) error {\n\tedits.DeviceNodes = d.sortDeviceNodes(edits.DeviceNodes)\n\tedits.Mounts = d.sortMounts(edits.Mounts)\n\treturn nil\n}\n\nfunc (d sorter) sortDevices(devices []specs.Device) []specs.Device {\n\tsort.Slice(devices, func(i, j int) bool {\n\t\treturn devices[i].Name < devices[j].Name\n\t})\n\treturn devices\n}\n\n// sortDeviceNodes sorts the specified device nodes by container path.\n// If two device nodes have the same container path, the host path is used to break ties.\nfunc (d sorter) sortDeviceNodes(entities []*specs.DeviceNode) []*specs.DeviceNode {\n\tsort.Slice(entities, func(i, j int) bool {\n\t\tip := strings.Count(filepath.Clean(entities[i].Path), string(os.PathSeparator))\n\t\tjp := strings.Count(filepath.Clean(entities[j].Path), string(os.PathSeparator))\n\t\tif ip == jp {\n\t\t\treturn entities[i].Path < entities[j].Path\n\t\t}\n\t\treturn ip < jp\n\t})\n\treturn entities\n}\n\n// sortMounts sorts the specified mounts by container path.\n// If two mounts have the same mount path, the host path is used to break ties.\nfunc (d sorter) sortMounts(entities []*specs.Mount) []*specs.Mount {\n\tsort.Slice(entities, func(i, j int) bool {\n\t\tip := strings.Count(filepath.Clean(entities[i].ContainerPath), string(os.PathSeparator))\n\t\tjp := strings.Count(filepath.Clean(entities[j].ContainerPath), string(os.PathSeparator))\n\t\tif ip == jp {\n\t\t\treturn entities[i].ContainerPath < entities[j].ContainerPath\n\t\t}\n\t\treturn ip < jp\n\t})\n\treturn entities\n}\n"
},
{
"path": "pkg/nvcdi/transform/sorter_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage transform\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/require\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n)\n\nfunc TestSortSpec(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tspec *specs.Spec\n\t\texpected *specs.Spec\n\t}{\n\t\t{\n\t\t\tdescription: \"sort sorts devices by name and device edits\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device2\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/device2/dev0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/device2/dev1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tContainerPath: \"/lib/device2/mount1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tContainerPath: \"/lib/device2/mount0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device1\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/device1/dev1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/device1/dev0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tContainerPath: \"/lib/device1/mount0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tContainerPath: \"/lib/device1/mount1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: &specs.Spec{\n\t\t\t\tDevices: []specs.Device{\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device1\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/device1/dev0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/device1/dev1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tContainerPath: \"/lib/device1/mount0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tContainerPath: \"/lib/device1/mount1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tName: \"device2\",\n\t\t\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/device2/dev0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tPath: \"/dev/device2/dev1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tContainerPath: \"/lib/device2/mount0\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tContainerPath: \"/lib/device2/mount1\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"sort sorts common edits\",\n\t\t\tspec: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/device2/dev0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/device2/dev1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/device1/dev1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/device1/dev0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tContainerPath: \"/lib/device2/mount1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tContainerPath: \"/lib/device2/mount0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tContainerPath: \"/lib/device1/mount0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tContainerPath: \"/lib/device1/mount1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\texpected: &specs.Spec{\n\t\t\t\tContainerEdits: specs.ContainerEdits{\n\t\t\t\t\tDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/device1/dev0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/device1/dev1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/device2/dev0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tPath: \"/dev/device2/dev1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tMounts: []*specs.Mount{\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tContainerPath: \"/lib/device1/mount0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tContainerPath: \"/lib/device1/mount1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tContainerPath: \"/lib/device2/mount0\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tContainerPath: \"/lib/device2/mount1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ts := sorter{}\n\t\t\terr := s.Transform(tc.spec)\n\t\t\trequire.NoError(t, err)\n\n\t\t\trequire.EqualValues(t, tc.expected, tc.spec)\n\t\t})\n\t}\n}\n\nfunc TestSortDeviceNodes(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tdeviceNodes []*specs.DeviceNode\n\t\texpectedDeviceNodes []*specs.DeviceNode\n\t}{\n\t\t{\n\t\t\tdescription: \"sorted remains sorted\",\n\t\t\tdeviceNodes: []*specs.DeviceNode{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia1\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia1\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"unsorted gets sorted\",\n\t\t\tdeviceNodes: []*specs.DeviceNode{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia1\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia1\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"shorter paths are first\",\n\t\t\tdeviceNodes: []*specs.DeviceNode{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0/another\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedDeviceNodes: []*specs.DeviceNode{\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tPath: \"/dev/nvidia0/another\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ts := sorter{}\n\t\t\tsorted := s.sortDeviceNodes(tc.deviceNodes)\n\n\t\t\trequire.EqualValues(t, tc.expectedDeviceNodes, sorted)\n\t\t})\n\t}\n}\n\nfunc TestStortMounts(t *testing.T) {\n\ttestCases := []struct {\n\t\tdescription string\n\t\tmounts []*specs.Mount\n\t\texpectedMounts []*specs.Mount\n\t}{\n\t\t{\n\t\t\tdescription: \"sorted remains sorted\",\n\t\t\tmounts: []*specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia1\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []*specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia1\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"unsorted gets sorted\",\n\t\t\tmounts: []*specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia1\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia0\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []*specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia1\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"shorter paths are first\",\n\t\t\tmounts: []*specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia0/another\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia0\",\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedMounts: []*specs.Mount{\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia0\",\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tContainerPath: \"/lib/nvidia0/another\",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\ts := sorter{}\n\t\t\tsorted := s.sortMounts(tc.mounts)\n\n\t\t\trequire.EqualValues(t, tc.expectedMounts, sorted)\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/nvcdi/workarounds-device-folder-permissions.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\t\"path/filepath\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/discover\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\ntype deviceFolderPermissions struct {\n\tlogger logger.Interface\n\tdevRoot string\n\tdevices discover.Discover\n\thookCreator discover.HookCreator\n}\n\nvar _ discover.Discover = (*deviceFolderPermissions)(nil)\n\n// newDeviceFolderPermissionHookDiscoverer creates a discoverer that can be used to update the permissions for the parent folders of nested device nodes from the specified set of device specs.\n// This works around an issue with rootless podman when using crun as a low-level runtime.\n// See https://github.com/containers/crun/issues/1047\n// The nested devices that are applicable to the NVIDIA GPU devices are:\n// - DRM devices at /dev/dri/*\n// - NVIDIA Caps devices at /dev/nvidia-caps/*\nfunc (l *nvcdilib) newDeviceFolderPermissionHookDiscoverer(devices discover.Discover) discover.Discover {\n\td := &deviceFolderPermissions{\n\t\tlogger: l.logger,\n\t\tdevRoot: l.driver.DevRoot,\n\t\thookCreator: l.hookCreator,\n\t\tdevices: devices,\n\t}\n\n\treturn d\n}\n\n// Devices are empty for this discoverer\nfunc (d *deviceFolderPermissions) Devices() ([]discover.Device, error) {\n\treturn nil, nil\n}\n\n// EnvVars are empty for this discoverer\nfunc (d *deviceFolderPermissions) EnvVars() ([]discover.EnvVar, error) {\n\treturn nil, nil\n}\n\n// Hooks returns a set of hooks that sets the file mode to 755 of parent folders for nested device nodes.\nfunc (d *deviceFolderPermissions) Hooks() ([]discover.Hook, error) {\n\tfolders, err := d.getDeviceSubfolders()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get device subfolders: %v\", err)\n\t}\n\n\t//nolint:staticcheck // The ChmodHook is deprecated and will be removed in a future release.\n\treturn d.hookCreator.Create(discover.ChmodHook, folders...).Hooks()\n}\n\nfunc (d *deviceFolderPermissions) getDeviceSubfolders() ([]string, error) {\n\t// For now we only consider the following special case paths\n\tallowedPaths := map[string]bool{\n\t\t\"/dev/dri\": true,\n\t\t\"/dev/nvidia-caps\": true,\n\t}\n\n\tdevices, err := d.devices.Devices()\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to get devices: %v\", err)\n\t}\n\n\tvar folders []string\n\tseen := make(map[string]bool)\n\tfor _, device := range devices {\n\t\tdf := filepath.Dir(device.Path)\n\t\tif seen[df] {\n\t\t\tcontinue\n\t\t}\n\t\t// We only consider the special case paths\n\t\tif !allowedPaths[df] {\n\t\t\tcontinue\n\t\t}\n\t\tfolders = append(folders, df)\n\t\tseen[df] = true\n\t\tif len(folders) == len(allowedPaths) {\n\t\t\tbreak\n\t\t}\n\t}\n\n\treturn folders, nil\n}\n\n// Mounts are empty for this discoverer\nfunc (d *deviceFolderPermissions) Mounts() ([]discover.Mount, error) {\n\treturn nil, nil\n}\n"
},
{
"path": "pkg/nvcdi/wrapper.go",
"content": "/**\n# Copyright 2025 NVIDIA CORPORATION\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvcdi\n\nimport (\n\t\"fmt\"\n\n\t\"tags.cncf.io/container-device-interface/pkg/cdi\"\n\t\"tags.cncf.io/container-device-interface/specs-go\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/config/image\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/spec\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/pkg/nvcdi/transform\"\n)\n\ntype wrapper struct {\n\tfactory deviceSpecGeneratorFactory\n\n\tvendor string\n\tclass string\n\n\tmergedDeviceOptions []transform.MergedDeviceOption\n}\n\n// TODO: Rename this type\ntype deviceSpecGeneratorFactory interface {\n\tDeviceSpecGenerators(...string) (DeviceSpecGenerator, error)\n\tGetCommonEdits() (*cdi.ContainerEdits, error)\n}\n\n// DeviceSpecGenerators can be used to combine multiple device spec generators.\n// This type also implements the DeviceSpecGenerator interface.\ntype DeviceSpecGenerators []DeviceSpecGenerator\n\nvar _ DeviceSpecGenerator = (DeviceSpecGenerators)(nil)\n\n// GetSpec combines the device specs and common edits from the wrapped Interface to a single spec.Interface.\nfunc (l *wrapper) GetSpec(devices ...string) (spec.Interface, error) {\n\tif len(devices) == 0 {\n\t\tdevices = append(devices, \"all\")\n\t}\n\tdeviceSpecs, err := l.GetDeviceSpecsByID(devices...)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tedits, err := l.GetCommonEdits()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn spec.New(\n\t\tspec.WithDeviceSpecs(deviceSpecs),\n\t\tspec.WithEdits(*edits.ContainerEdits),\n\t\tspec.WithVendor(l.vendor),\n\t\tspec.WithClass(l.class),\n\t\tspec.WithMergedDeviceOptions(l.mergedDeviceOptions...),\n\t)\n}\n\n// GetDeviceSpecsByID returns the CDI device specs for devices with the\n// specified IDs.\n// The device IDs are interpreted by the configured factory.\nfunc (l *wrapper) GetDeviceSpecsByID(devices ...string) ([]specs.Device, error) {\n\tgenerators, err := l.factory.DeviceSpecGenerators(devices...)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to construct device spec generators: %w\", err)\n\t}\n\treturn generators.GetDeviceSpecs()\n}\n\n// GetAllDeviceSpecs returns the device specs for all available devices.\n//\n// Deprecated: Use GetDeviceSpecsByID(\"all\") instead.\nfunc (l *wrapper) GetAllDeviceSpecs() ([]specs.Device, error) {\n\treturn l.GetDeviceSpecsByID(\"all\")\n}\n\n// GetCommonEdits returns the wrapped edits and adds additional edits on top.\nfunc (m *wrapper) GetCommonEdits() (*cdi.ContainerEdits, error) {\n\tedits, err := m.factory.GetCommonEdits()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tedits.Env = append(edits.Env, image.EnvVarNvidiaVisibleDevices+\"=void\")\n\n\treturn edits, nil\n}\n\n// GetDeviceSpecs returns the combined specs for each device spec generator.\nfunc (g DeviceSpecGenerators) GetDeviceSpecs() ([]specs.Device, error) {\n\tvar allDeviceSpecs []specs.Device\n\tfor _, dsg := range g {\n\t\tif dsg == nil {\n\t\t\tcontinue\n\t\t}\n\t\tdeviceSpecs, err := dsg.GetDeviceSpecs()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tallDeviceSpecs = append(allDeviceSpecs, deviceSpecs...)\n\t}\n\n\treturn allDeviceSpecs, nil\n}\n"
},
{
"path": "pkg/system/nvdevices/devices.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATIOm. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvdevices\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info/proc/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\nvar errInvalidDeviceNode = errors.New(\"invalid device node\")\n\n// Interface provides a set of utilities for interacting with NVIDIA devices on the system.\ntype Interface struct {\n\tdevices.Devices\n\n\tlogger logger.Interface\n\n\tdryRun bool\n\t// devRoot is the root directory where device nodes are expected to exist.\n\tdevRoot string\n\n\tmknoder\n}\n\n// New constructs a new Interface struct with the specified options.\nfunc New(opts ...Option) (*Interface, error) {\n\ti := &Interface{}\n\tfor _, opt := range opts {\n\t\topt(i)\n\t}\n\n\tif i.logger == nil {\n\t\ti.logger = logger.New()\n\t}\n\tif i.devRoot == \"\" {\n\t\ti.devRoot = \"/\"\n\t}\n\tif i.Devices == nil {\n\t\tdevices, err := devices.GetNVIDIADevices()\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to create devices info: %v\", err)\n\t\t}\n\t\ti.Devices = devices\n\t}\n\n\tif i.dryRun {\n\t\ti.mknoder = &mknodLogger{i.logger}\n\t} else {\n\t\ti.mknoder = &mknodUnix{i.logger}\n\t}\n\treturn i, nil\n}\n\n// CreateNVIDIAControlDevices creates the NVIDIA control device nodes at the configured devRoot.\nfunc (m *Interface) CreateNVIDIAControlDevices() error {\n\tcontrolNodes := []string{\"nvidiactl\", \"nvidia-modeset\", \"nvidia-uvm\", \"nvidia-uvm-tools\"}\n\tfor _, node := range controlNodes {\n\t\terr := m.CreateNVIDIADevice(node)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"failed to create device node %s: %w\", node, err)\n\t\t}\n\t}\n\treturn nil\n}\n\n// CreateNVIDIADevice creates the specified NVIDIA device node at the configured devRoot.\nfunc (m *Interface) CreateNVIDIADevice(node string) error {\n\tnode = filepath.Base(node)\n\tif !strings.HasPrefix(node, \"nvidia\") {\n\t\treturn fmt.Errorf(\"invalid device node %q: %w\", node, errInvalidDeviceNode)\n\t}\n\n\tmajor, err := m.Major(node)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to determine major: %w\", err)\n\t}\n\n\tminor, err := m.Minor(node)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"failed to determine minor: %w\", err)\n\t}\n\n\treturn m.createDeviceNode(filepath.Join(\"dev\", node), int(major), int(minor))\n}\n\n// createDeviceNode creates the specified device node with the require major and minor numbers.\n// If a devRoot is configured, this is prepended to the path.\nfunc (m *Interface) createDeviceNode(path string, major int, minor int) error {\n\tpath = filepath.Join(m.devRoot, path)\n\treturn m.Mknode(path, major, minor)\n}\n\n// Major returns the major number for the specified NVIDIA device node.\n// If the device node is not supported, an error is returned.\nfunc (m *Interface) Major(node string) (int64, error) {\n\tvar valid bool\n\tvar major devices.Major\n\tswitch node {\n\tcase \"nvidia-uvm\", \"nvidia-uvm-tools\":\n\t\tmajor, valid = m.Get(devices.NVIDIAUVM)\n\tcase \"nvidia-modeset\", \"nvidiactl\":\n\t\tmajor, valid = m.Get(devices.NVIDIAGPU)\n\t}\n\n\tif valid {\n\t\treturn int64(major), nil\n\t}\n\n\treturn 0, errInvalidDeviceNode\n}\n\n// Minor returns the minor number for the specified NVIDIA device node.\n// If the device node is not supported, an error is returned.\nfunc (m *Interface) Minor(node string) (int64, error) {\n\tswitch node {\n\tcase \"nvidia-modeset\":\n\t\treturn devices.NVIDIAModesetMinor, nil\n\tcase \"nvidia-uvm-tools\":\n\t\treturn devices.NVIDIAUVMToolsMinor, nil\n\tcase \"nvidia-uvm\":\n\t\treturn devices.NVIDIAUVMMinor, nil\n\tcase \"nvidiactl\":\n\t\treturn devices.NVIDIACTLMinor, nil\n\t}\n\n\treturn 0, errInvalidDeviceNode\n}\n"
},
{
"path": "pkg/system/nvdevices/devices_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvdevices\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info/proc/devices\"\n)\n\nfunc TestCreateControlDevices(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\tnvidiaDevices := devices.New(\n\t\tdevices.WithDeviceToMajor(map[string]int{\n\t\t\t\"nvidia-frontend\": 195,\n\t\t\t\"nvidia-uvm\": 243,\n\t\t}),\n\t)\n\tnvidia550Devices := devices.New(\n\t\tdevices.WithDeviceToMajor(map[string]int{\n\t\t\t\"nvidia\": 195,\n\t\t\t\"nvidia-uvm\": 243,\n\t\t}),\n\t)\n\n\tmknodeError := errors.New(\"mknode error\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\troot string\n\t\tdevices devices.Devices\n\t\tmknodeError error\n\t\texpectedError error\n\t\texpectedCalls []struct {\n\t\t\tS string\n\t\t\tN1 int\n\t\t\tN2 int\n\t\t}\n\t}{\n\t\t{\n\t\t\tdescription: \"no root specified; pre 550 driver\",\n\t\t\troot: \"\",\n\t\t\tdevices: nvidiaDevices,\n\t\t\tmknodeError: nil,\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tN1 int\n\t\t\t\tN2 int\n\t\t\t}{\n\t\t\t\t{\"/dev/nvidiactl\", 195, 255},\n\t\t\t\t{\"/dev/nvidia-modeset\", 195, 254},\n\t\t\t\t{\"/dev/nvidia-uvm\", 243, 0},\n\t\t\t\t{\"/dev/nvidia-uvm-tools\", 243, 1},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"no root specified; 550 driver\",\n\t\t\troot: \"\",\n\t\t\tdevices: nvidia550Devices,\n\t\t\tmknodeError: nil,\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tN1 int\n\t\t\t\tN2 int\n\t\t\t}{\n\t\t\t\t{\"/dev/nvidiactl\", 195, 255},\n\t\t\t\t{\"/dev/nvidia-modeset\", 195, 254},\n\t\t\t\t{\"/dev/nvidia-uvm\", 243, 0},\n\t\t\t\t{\"/dev/nvidia-uvm-tools\", 243, 1},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"some root specified\",\n\t\t\troot: \"/some/root\",\n\t\t\tdevices: nvidiaDevices,\n\t\t\tmknodeError: nil,\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tN1 int\n\t\t\t\tN2 int\n\t\t\t}{\n\t\t\t\t{\"/some/root/dev/nvidiactl\", 195, 255},\n\t\t\t\t{\"/some/root/dev/nvidia-modeset\", 195, 254},\n\t\t\t\t{\"/some/root/dev/nvidia-uvm\", 243, 0},\n\t\t\t\t{\"/some/root/dev/nvidia-uvm-tools\", 243, 1},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"mknod error returns error\",\n\t\t\tdevices: nvidiaDevices,\n\t\t\tmknodeError: mknodeError,\n\t\t\texpectedError: mknodeError,\n\t\t\t// We expect the first call to this to fail, and the rest to be skipped\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tN1 int\n\t\t\t\tN2 int\n\t\t\t}{\n\t\t\t\t{\"/dev/nvidiactl\", 195, 255},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"missing major returns error\",\n\t\t\tdevices: &devices.DevicesMock{\n\t\t\t\tGetFunc: func(name devices.Name) (devices.Major, bool) {\n\t\t\t\t\treturn 0, false\n\t\t\t\t},\n\t\t\t},\n\t\t\texpectedError: errInvalidDeviceNode,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tmknode := &mknoderMock{\n\t\t\t\tMknodeFunc: func(string, int, int) error {\n\t\t\t\t\treturn tc.mknodeError\n\t\t\t\t},\n\t\t\t}\n\n\t\t\td, _ := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithDevRoot(tc.root),\n\t\t\t\tWithDevices(tc.devices),\n\t\t\t)\n\t\t\td.mknoder = mknode\n\n\t\t\terr := d.CreateNVIDIAControlDevices()\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\t\t\trequire.EqualValues(t, tc.expectedCalls, mknode.MknodeCalls())\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/system/nvdevices/mknod.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvdevices\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\n\t\"golang.org/x/sys/unix\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n//go:generate moq -rm -fmt=goimports -stub -out mknod_mock.go . mknoder\ntype mknoder interface {\n\tMknode(string, int, int) error\n}\n\ntype mknodLogger struct {\n\tlogger.Interface\n}\n\nfunc (m *mknodLogger) Mknode(path string, major, minor int) error {\n\tm.Infof(\"Running: mknod --mode=0666 %s c %d %d\", path, major, minor)\n\treturn nil\n}\n\ntype mknodUnix struct {\n\tlogger logger.Interface\n}\n\nfunc (m *mknodUnix) Mknode(path string, major, minor int) error {\n\t// TODO: Ensure that the existing device node has the correct properties.\n\tif _, err := os.Stat(path); err == nil {\n\t\tm.logger.Infof(\"Skipping: %s already exists\", path)\n\t\treturn nil\n\t} else if !os.IsNotExist(err) {\n\t\treturn fmt.Errorf(\"failed to stat %s: %v\", path, err)\n\t}\n\n\terr := unix.Mknod(path, unix.S_IFCHR, int(unix.Mkdev(uint32(major), uint32(minor))))\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn unix.Chmod(path, 0666)\n}\n"
},
{
"path": "pkg/system/nvdevices/mknod_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage nvdevices\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that mknoderMock does implement mknoder.\n// If this is not the case, regenerate this file with moq.\nvar _ mknoder = &mknoderMock{}\n\n// mknoderMock is a mock implementation of mknoder.\n//\n//\tfunc TestSomethingThatUsesmknoder(t *testing.T) {\n//\n//\t\t// make and configure a mocked mknoder\n//\t\tmockedmknoder := &mknoderMock{\n//\t\t\tMknodeFunc: func(s string, n1 int, n2 int) error {\n//\t\t\t\tpanic(\"mock out the Mknode method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedmknoder in code that requires mknoder\n//\t\t// and then make assertions.\n//\n//\t}\ntype mknoderMock struct {\n\t// MknodeFunc mocks the Mknode method.\n\tMknodeFunc func(s string, n1 int, n2 int) error\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Mknode holds details about calls to the Mknode method.\n\t\tMknode []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t\t// N1 is the n1 argument value.\n\t\t\tN1 int\n\t\t\t// N2 is the n2 argument value.\n\t\t\tN2 int\n\t\t}\n\t}\n\tlockMknode sync.RWMutex\n}\n\n// Mknode calls MknodeFunc.\nfunc (mock *mknoderMock) Mknode(s string, n1 int, n2 int) error {\n\tcallInfo := struct {\n\t\tS string\n\t\tN1 int\n\t\tN2 int\n\t}{\n\t\tS: s,\n\t\tN1: n1,\n\t\tN2: n2,\n\t}\n\tmock.lockMknode.Lock()\n\tmock.calls.Mknode = append(mock.calls.Mknode, callInfo)\n\tmock.lockMknode.Unlock()\n\tif mock.MknodeFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.MknodeFunc(s, n1, n2)\n}\n\n// MknodeCalls gets all the calls that were made to Mknode.\n// Check the length with:\n//\n//\tlen(mockedmknoder.MknodeCalls())\nfunc (mock *mknoderMock) MknodeCalls() []struct {\n\tS string\n\tN1 int\n\tN2 int\n} {\n\tvar calls []struct {\n\t\tS string\n\t\tN1 int\n\t\tN2 int\n\t}\n\tmock.lockMknode.RLock()\n\tcalls = mock.calls.Mknode\n\tmock.lockMknode.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "pkg/system/nvdevices/options.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvdevices\n\nimport (\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/info/proc/devices\"\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// Option is a function that sets an option on the Interface struct.\ntype Option func(*Interface)\n\n// WithDryRun sets the dry run option for the Interface struct.\nfunc WithDryRun(dryRun bool) Option {\n\treturn func(i *Interface) {\n\t\ti.dryRun = dryRun\n\t}\n}\n\n// WithLogger sets the logger for the Interface struct.\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(i *Interface) {\n\t\ti.logger = logger\n\t}\n}\n\n// WithDevRoot sets the root directory for the NVIDIA device nodes.\nfunc WithDevRoot(devRoot string) Option {\n\treturn func(i *Interface) {\n\t\ti.devRoot = devRoot\n\t}\n}\n\n// WithDevices sets the devices for the Interface struct.\nfunc WithDevices(devices devices.Devices) Option {\n\treturn func(i *Interface) {\n\t\ti.Devices = devices\n\t}\n}\n"
},
{
"path": "pkg/system/nvmodules/cmd.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvmodules\n\nimport (\n\t\"fmt\"\n\t\"os/exec\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n//go:generate moq -rm -fmt=goimports -stub -out cmd_mock.go . cmder\ntype cmder interface {\n\t// Run executes the command and returns the stdout, stderr, and an error if any\n\tRun(string, ...string) error\n}\n\ntype cmderLogger struct {\n\tlogger.Interface\n}\n\nfunc (c *cmderLogger) Run(cmd string, args ...string) error {\n\tc.Infof(\"Running: %v %v\", cmd, strings.Join(args, \" \"))\n\treturn nil\n}\n\ntype cmderExec struct{}\n\nfunc (c *cmderExec) Run(cmd string, args ...string) error {\n\tif output, err := exec.Command(cmd, args...).CombinedOutput(); err != nil {\n\t\treturn fmt.Errorf(\"%w; output=%v\", err, string(output))\n\t}\n\treturn nil\n}\n"
},
{
"path": "pkg/system/nvmodules/cmd_mock.go",
"content": "// Code generated by moq; DO NOT EDIT.\n// github.com/matryer/moq\n\npackage nvmodules\n\nimport (\n\t\"sync\"\n)\n\n// Ensure, that cmderMock does implement cmder.\n// If this is not the case, regenerate this file with moq.\nvar _ cmder = &cmderMock{}\n\n// cmderMock is a mock implementation of cmder.\n//\n//\tfunc TestSomethingThatUsescmder(t *testing.T) {\n//\n//\t\t// make and configure a mocked cmder\n//\t\tmockedcmder := &cmderMock{\n//\t\t\tRunFunc: func(s string, strings ...string) error {\n//\t\t\t\tpanic(\"mock out the Run method\")\n//\t\t\t},\n//\t\t}\n//\n//\t\t// use mockedcmder in code that requires cmder\n//\t\t// and then make assertions.\n//\n//\t}\ntype cmderMock struct {\n\t// RunFunc mocks the Run method.\n\tRunFunc func(s string, strings ...string) error\n\n\t// calls tracks calls to the methods.\n\tcalls struct {\n\t\t// Run holds details about calls to the Run method.\n\t\tRun []struct {\n\t\t\t// S is the s argument value.\n\t\t\tS string\n\t\t\t// Strings is the strings argument value.\n\t\t\tStrings []string\n\t\t}\n\t}\n\tlockRun sync.RWMutex\n}\n\n// Run calls RunFunc.\nfunc (mock *cmderMock) Run(s string, strings ...string) error {\n\tcallInfo := struct {\n\t\tS string\n\t\tStrings []string\n\t}{\n\t\tS: s,\n\t\tStrings: strings,\n\t}\n\tmock.lockRun.Lock()\n\tmock.calls.Run = append(mock.calls.Run, callInfo)\n\tmock.lockRun.Unlock()\n\tif mock.RunFunc == nil {\n\t\tvar (\n\t\t\terrOut error\n\t\t)\n\t\treturn errOut\n\t}\n\treturn mock.RunFunc(s, strings...)\n}\n\n// RunCalls gets all the calls that were made to Run.\n// Check the length with:\n//\n//\tlen(mockedcmder.RunCalls())\nfunc (mock *cmderMock) RunCalls() []struct {\n\tS string\n\tStrings []string\n} {\n\tvar calls []struct {\n\t\tS string\n\t\tStrings []string\n\t}\n\tmock.lockRun.RLock()\n\tcalls = mock.calls.Run\n\tmock.lockRun.RUnlock()\n\treturn calls\n}\n"
},
{
"path": "pkg/system/nvmodules/modules.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvmodules\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n)\n\n// Interface provides a set of utilities for interacting with NVIDIA modules on the system.\ntype Interface struct {\n\tlogger logger.Interface\n\n\tdryRun bool\n\troot string\n\n\tcmder\n}\n\n// New constructs a new Interface struct with the specified options.\nfunc New(opts ...Option) *Interface {\n\tm := &Interface{}\n\tfor _, opt := range opts {\n\t\topt(m)\n\t}\n\n\tif m.logger == nil {\n\t\tm.logger = logger.New()\n\t}\n\tif m.root == \"\" {\n\t\tm.root = \"/\"\n\t}\n\n\tif m.dryRun {\n\t\tm.cmder = &cmderLogger{m.logger}\n\t} else {\n\t\tm.cmder = &cmderExec{}\n\t}\n\treturn m\n}\n\n// LoadAll loads all the NVIDIA kernel modules.\nfunc (m *Interface) LoadAll() error {\n\tmodules := []string{\"nvidia\", \"nvidia-uvm\", \"nvidia-modeset\"}\n\n\tfor _, module := range modules {\n\t\tif err := m.Load(module); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to load module %s: %w\", module, err)\n\t\t}\n\t}\n\treturn nil\n}\n\nvar errInvalidModule = fmt.Errorf(\"invalid module\")\n\n// Load loads the specified NVIDIA kernel module.\n// If the root is specified we first chroot into this root.\nfunc (m *Interface) Load(module string) error {\n\tif !strings.HasPrefix(module, \"nvidia\") {\n\t\treturn errInvalidModule\n\t}\n\n\tvar args []string\n\tif m.root != \"/\" {\n\t\targs = append(args, \"chroot\", m.root)\n\t}\n\targs = append(args, \"/sbin/modprobe\", module)\n\n\tm.logger.Debugf(\"Loading kernel module %s: %v\", module, args)\n\terr := m.Run(args[0], args[1:]...)\n\tif err != nil {\n\t\tm.logger.Debugf(\"Failed to load kernel module %s: %v\", module, err)\n\t\treturn err\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "pkg/system/nvmodules/modules_test.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvmodules\n\nimport (\n\t\"errors\"\n\t\"testing\"\n\n\ttestlog \"github.com/sirupsen/logrus/hooks/test\"\n\t\"github.com/stretchr/testify/require\"\n)\n\nfunc TestLoadAll(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\trunError := errors.New(\"run error\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\troot string\n\t\trunError error\n\t\texpectedError error\n\t\texpectedCalls []struct {\n\t\t\tS string\n\t\t\tStrings []string\n\t\t}\n\t}{\n\t\t{\n\t\t\tdescription: \"no root specified\",\n\t\t\troot: \"\",\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tStrings []string\n\t\t\t}{\n\t\t\t\t{\"/sbin/modprobe\", []string{\"nvidia\"}},\n\t\t\t\t{\"/sbin/modprobe\", []string{\"nvidia-uvm\"}},\n\t\t\t\t{\"/sbin/modprobe\", []string{\"nvidia-modeset\"}},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"root causes chroot\",\n\t\t\troot: \"/some/root\",\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tStrings []string\n\t\t\t}{\n\t\t\t\t{\"chroot\", []string{\"/some/root\", \"/sbin/modprobe\", \"nvidia\"}},\n\t\t\t\t{\"chroot\", []string{\"/some/root\", \"/sbin/modprobe\", \"nvidia-uvm\"}},\n\t\t\t\t{\"chroot\", []string{\"/some/root\", \"/sbin/modprobe\", \"nvidia-modeset\"}},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"run failure is returned\",\n\t\t\troot: \"\",\n\t\t\trunError: runError,\n\t\t\texpectedError: runError,\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tStrings []string\n\t\t\t}{\n\t\t\t\t{\"/sbin/modprobe\", []string{\"nvidia\"}},\n\t\t\t},\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tcmder := &cmderMock{\n\t\t\t\tRunFunc: func(cmd string, args ...string) error {\n\t\t\t\t\treturn tc.runError\n\t\t\t\t},\n\t\t\t}\n\t\t\tm := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithRoot(tc.root),\n\t\t\t)\n\t\t\tm.cmder = cmder\n\n\t\t\terr := m.LoadAll()\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\n\t\t\trequire.EqualValues(t, tc.expectedCalls, cmder.RunCalls())\n\t\t})\n\t}\n}\n\nfunc TestLoad(t *testing.T) {\n\tlogger, _ := testlog.NewNullLogger()\n\n\trunError := errors.New(\"run error\")\n\n\ttestCases := []struct {\n\t\tdescription string\n\t\troot string\n\t\tmodule string\n\t\trunError error\n\t\texpectedError error\n\t\texpectedCalls []struct {\n\t\t\tS string\n\t\t\tStrings []string\n\t\t}\n\t}{\n\t\t{\n\t\t\tdescription: \"no root specified\",\n\t\t\troot: \"\",\n\t\t\tmodule: \"nvidia\",\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tStrings []string\n\t\t\t}{\n\t\t\t\t{\"/sbin/modprobe\", []string{\"nvidia\"}},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"root causes chroot\",\n\t\t\troot: \"/some/root\",\n\t\t\tmodule: \"nvidia\",\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tStrings []string\n\t\t\t}{\n\t\t\t\t{\"chroot\", []string{\"/some/root\", \"/sbin/modprobe\", \"nvidia\"}},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"run failure is returned\",\n\t\t\troot: \"\",\n\t\t\tmodule: \"nvidia\",\n\t\t\trunError: runError,\n\t\t\texpectedError: runError,\n\t\t\texpectedCalls: []struct {\n\t\t\t\tS string\n\t\t\t\tStrings []string\n\t\t\t}{\n\t\t\t\t{\"/sbin/modprobe\", []string{\"nvidia\"}},\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tdescription: \"module prefis is checked\",\n\t\t\tmodule: \"not-nvidia\",\n\t\t\texpectedError: errInvalidModule,\n\t\t},\n\t}\n\n\tfor _, tc := range testCases {\n\t\tt.Run(tc.description, func(t *testing.T) {\n\t\t\tcmder := &cmderMock{\n\t\t\t\tRunFunc: func(cmd string, args ...string) error {\n\t\t\t\t\treturn tc.runError\n\t\t\t\t},\n\t\t\t}\n\t\t\tm := New(\n\t\t\t\tWithLogger(logger),\n\t\t\t\tWithRoot(tc.root),\n\t\t\t)\n\t\t\tm.cmder = cmder\n\n\t\t\terr := m.Load(tc.module)\n\t\t\trequire.ErrorIs(t, err, tc.expectedError)\n\n\t\t\trequire.EqualValues(t, tc.expectedCalls, cmder.RunCalls())\n\t\t})\n\t}\n}\n"
},
{
"path": "pkg/system/nvmodules/options.go",
"content": "/**\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n**/\n\npackage nvmodules\n\nimport \"github.com/NVIDIA/nvidia-container-toolkit/internal/logger\"\n\n// Option is a function that sets an option on the Interface struct.\ntype Option func(*Interface)\n\n// WithDryRun sets the dry run option for the Interface struct.\nfunc WithDryRun(dryRun bool) Option {\n\treturn func(i *Interface) {\n\t\ti.dryRun = dryRun\n\t}\n}\n\n// WithLogger sets the logger for the Interface struct.\nfunc WithLogger(logger logger.Interface) Option {\n\treturn func(i *Interface) {\n\t\ti.logger = logger\n\t}\n}\n\n// WithRoot sets the root directory for the NVIDIA device nodes.\nfunc WithRoot(root string) Option {\n\treturn func(i *Interface) {\n\t\ti.root = root\n\t}\n}\n"
},
{
"path": "scripts/Dockerfile.sign.deb",
"content": "FROM ubuntu:18.04\n\nRUN apt-get update && \\\n apt-get install -y apt-utils gpg xz-utils\n"
},
{
"path": "scripts/Dockerfile.sign.rpm",
"content": "FROM quay.io/centos/centos:stream9\n\nRUN yum install -y createrepo rpm-sign pinentry\n"
},
{
"path": "scripts/build-all-components.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This script is used to build the packages for the components of the NVIDIA\n# Container Stack. These include the nvidia-container-toolkit in this repository\n# as well as the components included in the third_party folder.\n# All required packages are generated in the specified dist folder.\n\nfunction assert_usage() {\n echo \"Missing argument $1\"\n echo \"$(basename \"${BASH_SOURCE[0]}\") TARGET\"\n exit 1\n}\n\nset -e\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../scripts && pwd )\"\nPROJECT_ROOT=\"$( cd \"${SCRIPTS_DIR}\"/.. && pwd )\"\n\nif [[ $# -ne 1 ]]; then\n assert_usage \"TARGET\"\nfi\n\nTARGET=$1\n\nsource \"${SCRIPTS_DIR}\"/utils.sh\n\n: \"${DIST_DIR:=${PROJECT_ROOT}/dist}\"\nexport DIST_DIR\n\necho \"Building ${TARGET} for all packages to ${DIST_DIR}\"\n\n: \"${LIBNVIDIA_CONTAINER_ROOT:=${PROJECT_ROOT}/third_party/libnvidia-container}\"\n: \"${NVIDIA_CONTAINER_TOOLKIT_ROOT:=${PROJECT_ROOT}}\"\n\n\nif [[ -z \"${NVIDIA_CONTAINER_TOOLKIT_VERSION}\" || -z \"${LIBNVIDIA_CONTAINER_VERSION}\" ]]; then\neval $(${SCRIPTS_DIR}/get-component-versions.sh)\nfi\n\nif [[ -z \"${GOLANG_VERSION}\" ]]; then\n GOLANG_VERSION=$(${PROJECT_ROOT}/hack/golang-version.sh)\nfi\n\n# Build libnvidia-container\nif [[ -z ${SKIP_LIBNVIDIA_CONTAINER} ]]; then\n make -C \"${LIBNVIDIA_CONTAINER_ROOT}\" -f mk/docker.mk \\\n LIB_VERSION=${NVIDIA_CONTAINER_TOOLKIT_VERSION} \\\n LIB_TAG=${NVIDIA_CONTAINER_TOOLKIT_TAG} \\\n GOLANG_VERSION=${GOLANG_VERSION} \\\n \"${TARGET}\"\nfi\n\nif [[ -z ${SKIP_NVIDIA_CONTAINER_TOOLKIT} ]]; then\n# Build nvidia-container-toolkit\nmake -C \"${NVIDIA_CONTAINER_TOOLKIT_ROOT}\" \\\n LIBNVIDIA_CONTAINER_VERSION=\"${NVIDIA_CONTAINER_TOOLKIT_VERSION}\" \\\n LIBNVIDIA_CONTAINER_TAG=\"${NVIDIA_CONTAINER_TOOLKIT_TAG}\" \\\n \"${TARGET}\"\nfi\n\n# Repackage RPMs if required.\n\"${SCRIPTS_DIR}/repackage-rpms.sh\" \"${TARGET}\"\n"
},
{
"path": "scripts/build-packages.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This script is used to build the packages for the components of the NVIDIA\n# Container Stack. These include the nvidia-container-toolkit in this repository\n# as well as the components included in the third_party folder.\n# All required packages are generated in the specified dist folder.\n\nset -e\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../scripts && pwd )\"\n\nsource \"${SCRIPTS_DIR}\"/utils.sh\n\nif [[ $# -gt 0 ]]; then\n targets=($*)\nelse\n targets=${all[@]}\nfi\n\ngit submodule update --init\ngit submodule status\n\neval $(${SCRIPTS_DIR}/get-component-versions.sh)\n\nexport NVIDIA_CONTAINER_TOOLKIT_VERSION\nexport NVIDIA_CONTAINER_TOOLKIT_TAG\n\nfor target in ${targets[@]}; do\n \"${SCRIPTS_DIR}/build-all-components.sh\" \"${target}\"\ndone\n"
},
{
"path": "scripts/extract-packages.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfunction assert_usage() {\n echo \"Incorrect arguments: $*\" >&2\n echo \"$(basename \"${BASH_SOURCE[0]}\") PACKAGE_IMAGE_NAME:PACKAGE_IMAGE_TAG\" >&2\n echo -e \"\\\\tPACKAGE_IMAGE: container image holding packages [e.g. ghcr.io/nvidia/container-toolkit]\" >&2\n echo -e \"\\\\tPACKAGE_TAG: tag for container image holding packages. [e.g. 1a2b3c4-packaging]\" >&2\n exit 1\n}\n\nset -e\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../scripts && pwd )\"\nPROJECT_ROOT=\"$( cd \"${SCRIPTS_DIR}/..\" && pwd )\"\n\nif [[ $# -ne 1 ]]; then\n assert_usage \"$@\"\nfi\n\nPACKAGE_IMAGE=$1\n\n# TODO: accept ARTIFACTS_DIR as a command-line argument\n: \"${ARTIFACTS_DIR=\"${PROJECT_ROOT}/artifacts\"}\"\n\n# For release-candidates we skip certain packages.\n# This function returns 0 if a package should be skipped and 1 otherwise.\nfunction skip-for-release-candidate() {\n # We always skip nvidia-container-toolkit-operator-extensions packages\n if [[ \"${package_name/\"nvidia-container-toolkit-operator-extensions\"/}\" != \"${package_name}\" ]]; then\n return 0\n fi\n\n local is_non_patch_full_release=1\n # We allow all other packages for non-rc and non-patch release versions.\n if [[ \"${VERSION/rc./}\" != \"${VERSION}\" ]]; then\n is_non_patch_full_release=0\n fi\n if [[ \"${VERSION%.0}\" == \"${VERSION}\" ]]; then\n is_non_patch_full_release=0\n fi\n return 1\n}\n\n# extract-file copies a file from a specified image.\n# If regctl is available this is used, otherwise a docker container is run and the file is copied from\n# there.\nfunction copy-file() {\n local image=$1\n local path_in_image=$2\n local path_on_host=$3\n if command -v regctl; then\n regctl image get-file \"${image}\" \"${path_in_image}\" \"${path_on_host}\"\n else\n # Note this will only work for destinations where the `path_on_host` is in `pwd`\n docker run --rm \\\n -v \"$(pwd):$(pwd)\" \\\n -w \"$(pwd)\" \\\n -u \"$(id -u):$(id -g)\" \\\n --entrypoint=\"sh\" \\\n \"${image}\" \\\n -c \"cp -p ${path_in_image} ${path_on_host}\"\n fi\n}\n\neval $(${SCRIPTS_DIR}/get-component-versions.sh)\n\n# extract-all extracts all package for the specified distribution from the package image.\n# The manifest.txt file in the image is used to detemine the applicable files for the combination.\n# Files are extracted to ${ARTIFACTS_DIR}/artifacts/packages/${dist}/${arch}\nfunction extract-all() {\n local dist=$1\n\n echo \"Extracting packages for ${dist} from ${PACKAGE_IMAGE}\"\n # Extract every file for the specified dist-arch combiniation in MANIFEST.txt\n grep \"/${dist}/\" \"${ARTIFACTS_DIR}/manifest.txt\" | while read -r f ; do\n package_name=\"$(basename \"$f\")\"\n # For release-candidates, we skip certain packages\n if skip-for-release-candidate \"${package_name}\"; then\n echo \"Skipping $f for release-candidate ${VERSION}\"\n continue\n fi\n target=\"${ARTIFACTS_DIR}/${f##/artifacts/}\"\n mkdir -p \"$(dirname \"$target\")\"\n copy-file \"${PACKAGE_IMAGE}\" \"${f}\" \"${target}\"\n done\n}\n\nmkdir -p \"${ARTIFACTS_DIR}\"\ncopy-file \"${PACKAGE_IMAGE}\" \"/artifacts/manifest.txt\" \"${ARTIFACTS_DIR}/manifest.txt\"\n\nextract-all ubuntu18.04\nextract-all centos7\n"
},
{
"path": "scripts/get-component-versions.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This script is used to build the packages for the components of the NVIDIA\n# Container Stack. These include the nvidia-container-toolkit in this repository\n# as well as the components included in the third_party folder.\n# All required packages are generated in the specified dist folder.\n\nfunction assert_usage() {\n exit 1\n}\n\nset -e\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../scripts && pwd )\"\nPROJECT_ROOT=\"$( cd ${SCRIPTS_DIR}/.. && pwd )\"\n\nNVIDIA_CONTAINER_TOOLKIT_ROOT=${PROJECT_ROOT}\n\nversions_makefile=${NVIDIA_CONTAINER_TOOLKIT_ROOT}/versions.mk\n# Get version for nvidia-container-toolit\nnvidia_container_toolkit_version=$(grep -m 1 \"^LIB_VERSION := \" ${versions_makefile} | sed -e 's/LIB_VERSION :=[[:space:]]\\(.*\\)[[:space:]]*/\\1/')\nnvidia_container_toolkit_tag=$(grep -m 1 \"^LIB_TAG .= \" ${versions_makefile} | sed -e 's/LIB_TAG .=[[:space:]]\\(.*\\)[[:space:]]*/\\1/')\nnvidia_container_toolkit_version_tag=\"${nvidia_container_toolkit_version}${nvidia_container_toolkit_tag:+~${nvidia_container_toolkit_tag}}\"\n\necho \"NVIDIA_CONTAINER_TOOLKIT_VERSION=${nvidia_container_toolkit_version}\"\necho \"NVIDIA_CONTAINER_TOOLKIT_TAG=${nvidia_container_toolkit_tag}\"\necho \"NVIDIA_CONTAINER_TOOLKIT_PACKAGE_VERSION=${nvidia_container_toolkit_version_tag//\\~/-}\"\n"
},
{
"path": "scripts/packages-sign-all.sh",
"content": "#!/usr/bin/env bash\n\n: \"${ALL_DEBS:? Must set ALL_DEBS}\"\n: \"${ALL_RPMS:? Must set ALL_RPMS}\"\n: \"${GPG_LOCAL_USER:? Must set GPG_LOCAL_USER}\"\n: \"${TARGETS:? Must set TARGETS}\"\n\nset -x -e\n\nfunction deb-sign {\n local last_found\n for r in \"$@\"; do\n if [ -f \"./${r}\" ]; then\n last_found=${r}\n fi\n done\n if [[ -z ${last_found} ]]; then\n echo \"WARNING: No expected package found in $(pwd); skipping signing of repo;\"\n return\n fi\n apt-ftparchive packages . \\\n | tee Packages \\\n | xz > Packages.xz\n apt-ftparchive -c repo.conf release . \\\n | gpg --batch --yes --expert --clearsign \\\n --armor \\\n --no-emit-version \\\n --no-comments \\\n --personal-digest-preferences sha512 \\\n --local-user \"${GPG_LOCAL_USER}\" \\\n > InRelease\n}\n\nfunction rpm-sign {\n for r in \"$@\"; do\n if [ -f \"./${r}\" ]; then\n rpmsign --addsign --key-id A04EA552 --digest-algo=sha512 \"${r}\"\n fi\n done\n createrepo -v --no-database -s sha512 --compress-type xz --revision \"1.0\" .\n gpg2 --batch --yes --expert --sign --detach-sign \\\n --armor \\\n --no-emit-version \\\n --no-comments --personal-digest-preferences sha512 \\\n --local-user \"${GPG_LOCAL_USER}\" \\\n repodata/repomd.xml\n}\n\nfunction sign() {\n local target=$1\n local dst_root=$2\n local by_package_type=$3\n\n local src_dist=${target%-*}\n local dst_dist=${src_dist/amazonlinux/amzn}\n\n local pkg_type=unknown\n local arch=${target##*-}\n local dst_arch=${arch}\n\n case ${src_dist} in\n amazonlinux*) pkg_type=rpm\n ;;\n centos* | rpm) pkg_type=rpm\n ;;\n debian*) pkg_type=deb\n ;;\n fedora*) pkg_type=rpm\n ;;\n opensuse-leap*) pkg_type=rpm\n ;;\n ubuntu* | deb) pkg_type=deb\n arch=${arch//ppc64le/ppc64el}\n ;;\n *) echo \"ERROR: unexpected distribution ${src_dist}\"\n ;;\n esac\n\n if [[ x\"${by_package_type}\" == x\"true\" ]]; then\n dst_dist=${pkg_type}\n fi\n\n local dst=${dst_root}/${dst_dist}/${arch}\n\n if [[ ! -d ${dst} ]]; then\n echo \"Directory ${dst} not found. Skipping\"\n return\n fi\n\n cd \"${dst}\"\n if [[ -f \"/etc/debian_version\" ]]; then\n [[ \"${pkg_type}\" == \"deb\" ]] && deb-sign ${ALL_DEBS}\n else\n [[ \"${pkg_type}\" == \"rpm\" ]] && rpm-sign ${ALL_RPMS}\n fi\n cd -\n}\n\nfor target in ${TARGETS[@]}; do\n echo \"checking target=${target}\"\n by_package_type=\n case ${target} in\n ubuntu18.04-* | centos7-*)\n by_package_type=\"true\"\n ;;\n *)\n echo \"Skipping target ${target}\"\n continue\n ;;\n esac\n sign \"${target}\" \"$(pwd)\" ${by_package_type}\ndone\n"
},
{
"path": "scripts/publish-image.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This script is used to publish images to a registry. It checks whether the image\n# already exists in the registry and skips publishing if it does. This can be overridden\n# using the FORCE_PUBLISH_IMAGES environment variable.\n\nset -ex\n\n: ${DOCKER=docker}\n: ${REGCTL=regctl}\n\nINPUT_IMAGE=$1\nOUTPUT_IMAGE=$2\n\nfunction publish_docker() {\n ${DOCKER} tag ${1} ${2}\n ${DOCKER} push ${2}\n}\n\nfunction publish_regctl() {\n ${REGCTL} image copy ${1} ${2}\n}\n\nfunction publish() {\n if [[ x\"${BUILD_MULTI_ARCH_IMAGES}\" == x\"true\" || $(command -v ${REGCTL}) ]]; then\n publish_regctl $@\n else\n publish_docker $@\n fi\n}\n\n# image_exists returns 0 if the image exists in a registry and a non-zero return\n# code if this is not the case.\nfunction image_exists() {\n local image=$1\n ${DOCKER} manifest inspect ${image}\n}\n\nif [[ -z ${FORCE_PUBLISH_IMAGES} && $(image_exists ${OUTPUT_IMAGE}) ]]; then\n echo \"Skipping publishing of ${INPUT_IMAGE} as ${OUTPUT_IMAGE} already exists\"\n exit 0\nfi\n\necho \"Publishing ${INPUT_IMAGE} as ${OUTPUT_IMAGE}\"\npublish ${INPUT_IMAGE} ${OUTPUT_IMAGE}\n"
},
{
"path": "scripts/release-kitmaker-artifactory.sh",
"content": "#!/bin/bash\n\n# Copyright (c) NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfunction assert_usage() {\ncat >&2 << EOF\nIncorrect arguments: $*\n$(basename \"${BASH_SOURCE[0]}\") KITMAKER_ARTIFACTORY_REPO\n KITMAKER_ARTIFACTORY_REPO must contain repo path for package, including hostname.\n\nEnvironment Variables\n ARTIFACTORY_TOKEN: must contain an auth token. [required]\nEOF\n exit 1\n}\n\nset -e\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../scripts && pwd )\"\nPROJECT_ROOT=\"$( cd \"${SCRIPTS_DIR}/..\" && pwd )\"\n\nif [[ $# -ne 1 ]]; then\n assert_usage \"$@\"\nfi\n\nsource \"${SCRIPTS_DIR}\"/utils.sh\n\n# KITMAKER_ARTIFACTORY_REPO=https://urm.nvidia.com/artifactory/sw-gpu-cloudnative-generic-local/testing\nKITMAKER_ARTIFACTORY_REPO=$1\n\n: ${CURL:=curl}\n\n# ARTIFACTS_DIR represents the root of the artifacts (deb and rpm packages)\n# extracted from the packaging image.\n# TODO: accept ARTIFACTS_DIR as a command-line argument\n: \"${ARTIFACTS_DIR=\"${PROJECT_ROOT}/artifacts\"}\"\n\nif [[ ! -d \"${ARTIFACTS_DIR}\" ]]; then\n echo \"ERROR: ARTIFACTS_DIR does not exist.\" >&2\n assert_usage \"$@\"\nfi\n\nif [[ ! -f \"${ARTIFACTS_DIR}/manifest.txt\" ]]; then\n echo \"ERROR: Manifest file not found.\" >&2\n assert_usage \"$@\"\nfi\n\nif [[ -z \"${ARTIFACTORY_TOKEN}\" ]]; then\n echo \"ERROR: ARTIFACTORY_TOKEN must be defined.\" >&2\n assert_usage \"$@\"\nfi\n\n# TODO: accept KITMAKER_DIR as a command-line argument\n: \"${KITMAKER_DIR=\"${PROJECT_ROOT}/artifacts/kitmaker\"}\"\n\nKITMAKER_SCRATCH=\"${KITMAKER_DIR}/.scratch\"\n\nIMAGE_EPOCH=$(extract_info \"IMAGE_EPOCH\")\nGIT_COMMIT=$(extract_info \"GIT_COMMIT\")\nGIT_COMMIT_SHORT=$(extract_info \"GIT_COMMIT_SHORT\")\nVERSION=$(extract_info \"PACKAGE_VERSION\")\n\n\n# add_distro adds the specified component, os, and arch to the .package folder from which a kitmaker archive is generated.\nfunction add_distro() {\n local component=$1\n local branch=$2\n local os=$3\n local arch=$4\n\n local package_dist=$5\n local package_arch=$6\n\n local name=\"${component}-${os}-${arch}\"\n\n local scratch_dir=\"${KITMAKER_SCRATCH}/${name}/${branch}/${component}\"\n local packages_dir=\"${scratch_dir}/.packages\"\n\n mkdir -p \"${packages_dir}\"\n\n # Copy the extracted files to the .packages directory so that a kitmaker file can be created.\n source=\"${ARTIFACTS_DIR}/packages/${package_dist}/${package_arch}\"\n cp -r \"${source}/\"* \"${packages_dir}/\"\n}\n\n# create_archive creates a kitmaker archive for the specified component, os, and arch.\nfunction create_archive() {\n local component=$1\n local branch=$2\n local os=$3\n local arch=$4\n local version=$5\n\n local name=\"${component}-${os}-${arch}\"\n local archive=\"${KITMAKER_DIR}/${branch}/${name}-${version}.tar.gz\"\n\n local scratch_dir=\"${KITMAKER_SCRATCH}/${name}/${branch}/${component}\"\n local packages_dir=\"${scratch_dir}/.packages/\"\n\n mkdir -p $(dirname \"${archive}\")\n\n tar zcvf \"${archive}\" -C \"${scratch_dir}/..\" \"${component}\"\n echo \"Created: ${archive}\"\n ls -l \"${archive}\"\n echo \"With contents:\"\n tar -tzvf \"${archive}\"\n echo \"\"\n\n # Clean up the scratch directories:\n rm -f \"${scratch_dir}/.packages/\"*\n rmdir \"${scratch_dir}/.packages\"\n rmdir \"${scratch_dir}\"\n}\n\nfunction optionally_add_property() {\n local property=$1\n local value=$2\n if [[ -n \"${value}\" ]]; then\n props+=(\"${property}=${value}\")\n fi\n}\n\nfunction upload_archive() {\n local component=$1\n local branch=$2\n local os=$3\n local arch=$4\n local version=$5\n local package_builds=$(join_by , ${@:6})\n\n local name=\"${component}-${os}-${arch}\"\n local archive=\"${KITMAKER_DIR}/${branch}/${name}-${version}.tar.gz\"\n\n if [ ! -r \"${archive}\" ]; then\n echo \"ERROR: File not found or not readable: ${archive}\"\n exit 1\n fi\n local sha1_checksum=$(sha1sum -b \"${archive}\" | awk '{ print $1 }')\n\n local upload_url=\"${KITMAKER_ARTIFACTORY_REPO}/${branch}/${component}/${os}-${arch}/${version}/$(basename ${archive})\"\n\n local props=()\n # Required KITMAKER properties:\n props+=(\"component_name=${component}\")\n props+=(\"version=${version}\")\n props+=(\"os=${os}\")\n props+=(\"arch=${arch}\")\n props+=(\"platform=${os}-${arch}\")\n props+=(\"changelist=${GIT_COMMIT_SHORT}\")\n props+=(\"branch=${branch}\")\n props+=(\"source=https://github.com/NVIDIA/nvidia-container-toolkit\")\n # Package properties:\n props+=(\"package.epoch=${IMAGE_EPOCH}\")\n props+=(\"package.version=${VERSION}\")\n props+=(\"package.commit=${GIT_COMMIT}\")\n optionally_add_property \"package.builds\" \"${package_builds}\"\n\n for var in \"CI_PROJECT_ID\" \"CI_PIPELINE_ID\" \"CI_JOB_ID\" \"CI_JOB_URL\" \"CI_PROJECT_PATH\"; do\n if [ -n \"${!var}\" ]; then\n optionally_add_property \"${var}\" \"${!var}\"\n fi\n done\n local PROPS=$(join_by \";\" \"${props[@]}\")\n\n echo \"Uploading ${upload_url} from ${archive}\"\n echo -H \"X-JFrog-Art-Api: REDACTED\" \\\n -H \"X-Checksum-Sha1: ${sha1_checksum}\" \\\n ${archive:+-T ${archive}} -X PUT \\\n \"${upload_url};${PROPS}\"\n if ! ${CURL} -f \\\n -H \"X-JFrog-Art-Api: ${ARTIFACTORY_TOKEN}\" \\\n -H \"X-Checksum-Sha1: ${sha1_checksum}\" \\\n ${archive:+-T ${archive}} -X PUT \\\n \"${upload_url};${PROPS}\" ;\n then\n echo \"ERROR: upload file failed: ${archive}\"\n exit 1\n fi\n}\n\ncomponent=\"nvidia_container_toolkit\"\nversion=\"${VERSION%~rc.*}\"\nversion_suffix=$(date -r \"${IMAGE_EPOCH}\" '+%Y.%m.%d.%s' || date -d @\"${IMAGE_EPOCH}\" '+%Y.%m.%d.%s')\nkitmaker_version=\"${VERSION%~rc.*}.${version_suffix}\"\nkitmaker_os=\"linux\"\n\n# create_and_upload creates a kitmaker archive for the specified component, os, and arch and uploads it.\nfunction create_and_upload() {\n local branch=$1\n local kitmaker_arch=$2\n local builds=${@:3}\n\n for build in ${builds}; do\n local package_dist=$(echo ${build} | cut -d- -f1)\n local package_arch=$(echo ${build} | cut -d- -f2)\n\n add_distro \"${component}\" \"${branch}\" \"${kitmaker_os}\" \"${kitmaker_arch}\" \"${package_dist}\" \"${package_arch}\"\n done\n\n create_archive \"${component}\" \"${branch}\" \"${kitmaker_os}\" \"${kitmaker_arch}\" \"${kitmaker_version}\"\n upload_archive \"${component}\" \"${branch}\" \"${kitmaker_os}\" \"${kitmaker_arch}\" \"${kitmaker_version}\" ${builds}\n}\n\n# Create archive for x86_64 linux distributions\ncreate_and_upload \"main\" \"x86_64\" \"ubuntu18.04-amd64\" \"centos7-x86_64\"\n\n# Create archive for sbsa linux distributions\ncreate_and_upload \"main\" \"sbsa\" \"ubuntu18.04-arm64\" \"centos7-aarch64\"\n# Create archive for aarch64 linux distributions\n# NOTE: From the perspective of the NVIDIA Container Toolkit aarch64 is just a duplicate of sbsa\ncreate_and_upload \"main\" \"aarch64\" \"ubuntu18.04-arm64\" \"centos7-aarch64\"\n"
},
{
"path": "scripts/release-packages-artifactory.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2021-2022, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# Dependencies:\n# regctl\n#\n\nfunction assert_usage() {\ncat >&2 << EOF\nIncorrect arguments: $*\n$(basename \"${BASH_SOURCE[0]}\") DIST-ARCH\n DIST: The distribution.\n ARCH: The architecture.\n\nEnvironment Variables\n ARTIFACTORY_TOKEN: must contain an auth token. [required]\n LIB_TAG: optional package tag.\n CI_COMMIT_REF_NAME: provided by CI/CD system.\n CI_COMMIT_SHA: provided by CI/CD system.\nEOF\n exit 1\n}\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../scripts && pwd )\"\nPROJECT_ROOT=\"$( cd \"${SCRIPTS_DIR}/..\" && pwd )\"\n\nsource \"${SCRIPTS_DIR}\"/utils.sh\n\nif [[ $# -ne 1 ]]; then\n assert_usage \"$@\"\nfi\n\nDISTARCH=$1\nARTIFACTORY_PATH=$2\nDIST=${DISTARCH%-*}\nARCH=${DISTARCH##*-}\n\nCURL=${CURL:-curl}\n\nif [[ -z \"${DIST}\" || -z \"${ARCH}\" ]]; then\n echo \"ERROR: Distro and Architecture must be specified.\" >&2\n assert_usage \"$@\"\nfi\n\nif [[ -z \"${ARTIFACTORY_PATH}\" ]]; then\n echo \"ERROR: Package repo must be specified.\" >&2\n assert_usage \"$@\"\nfi\n\nif [[ -z \"${ARTIFACTORY_TOKEN}\" ]]; then\n echo \"ERROR: ARTIFACTORY_TOKEN must be defined.\" >&2\n assert_usage \"$@\"\nfi\n\n# TODO: accept PACKAGES_DIR as a command-line argument\n: \"${ARTIFACTS_DIR=\"${PROJECT_ROOT}/artifacts\"}\"\n: \"${PACKAGES_DIR=\"${ARTIFACTS_DIR}/packages\"}\"\n\neval $(${SCRIPTS_DIR}/get-component-versions.sh)\n\n# Returns the key=value property if the value isn't empty\n# Prepends with \";\" if needed\nset_prop_value() {\n local key=$1\n local value=$2\n if [ -n \"${value}\" ]; then\n if [ -z \"${PROPS}\" ]; then\n echo \"${key}=${value}\"\n else\n echo \";${key}=${value}\"\n fi\n fi\n}\n\nprocess_props() {\n local dist=$1\n local arch=$2\n local file=$3\n local component_name=\"${file%%.*}\"\n component_name=\"${component_name%-*}\"\n local pkg_type=\"$(package_type $dist)\"\n\n ## Component owner is free to define these\n # PROPS+=$(set_prop_value \"version\" \"${VERSION}\")\n # PROPS+=$(set_prop_value \"lws_version\" \"${LWS_VER}\")\n # PROPS+=$(set_prop_value \"platform\" \"${DISTARCH}\")\n\n # TODO: Use `git describe` to get this information if it's not available.\n PROPS+=$(set_prop_value \"changelist\" \"${CI_COMMIT_SHA}\")\n PROPS+=$(set_prop_value \"branch\" \"${CI_COMMIT_REF_NAME}\")\n\n # PROPS+=$(set_prop_value \"category\" \"utils\")\n # PROPS+=$(set_prop_value \"platform\" \"${DISTARCH}\")\n\n # Gitlab variables to expose\n for var in CI_PROJECT_ID CI_PIPELINE_ID CI_JOB_ID CI_JOB_URL CI_PROJECT_PATH; do\n if [ -n \"${!var}\" ]; then\n PROPS+=$(set_prop_value \"${var}\" \"${!var}\")\n fi\n done\n\n # We also set the package-specific properties to allow this to be used for other artifactory repositories\n PROPS+=$(set_prop_value \"${pkg_type}.distribution\" \"${dist}\")\n PROPS+=$(set_prop_value \"${pkg_type}.architecture\" \"${arch}\")\n PROPS+=$(set_prop_value \"${pkg_type}.component\" \"${component_name}\")\n}\n\n# Uploads file ARTIFACTORY_PATH\n# Relies on global variables: DIST, ARCH, ARTIFACTORY_TOKEN, ARTIFACTORY_PATH\nupload_file() {\n local dist=$1\n local arch=$2\n local file=$3\n\n # TODO: These should be set by envvars\n local artifactory_host=\"urm.nvidia.com\"\n local artifactory_repo=\"$(get_artifactory_repository $dist)\"\n\n if [ ! -r \"${file}\" ]; then\n echo \"ERROR: File not found or not readable: ${file}\"\n exit 1\n fi\n\n local PROPS\n process_props \"${dist}\" \"${arch}\" \"${file}\"\n\n # Collect sum\n SHA1_SUM=$(sha1sum -b \"${file}\" | awk '{ print $1 }')\n\n url=\"https://${artifactory_host}/artifactory/${artifactory_repo}/${dist}/${arch}/$(basename \"${file}\")\"\n # NOTE: The URL to set the properties through the API is:\n # \"https://${artifactory_host}/artifactory/api/storage/${artifactory_repo}/${dist}/${arch}/$(basename ${file})\"\n\n echo \"Uploading ${file} to ${url}\"\n if ! ${CURL} -f \\\n -H \"X-JFrog-Art-Api: ${ARTIFACTORY_TOKEN}\" \\\n -H \"X-Checksum-Sha1: ${SHA1_SUM}\" \\\n ${file:+-T ${file}} -X PUT \\\n \"${url};${PROPS}\" ;\n then\n echo \"ERROR: upload file failed: ${file}\"\n exit 1\n fi\n}\n\nfunction push-artifactory() {\n local dist=\"$1\"\n local arch=\"$2\"\n\n source=\"${ARTIFACTS_DIR}/packages/${dist}/${arch}\"\n\n find \"${source}\" -maxdepth 1 | while read -r f ; do\n upload_file \"$dist\" \"$arch\" \"$f\"\n done\n}\n\n# TODO: use this to adapt as a general purpose command-line tool\n# case \"${COMMAND}\" in\n# set)\n# set_props\n# ;;\n# upload)\n# if [ -z \"${UPLOAD_FILE}\" ]; then\n# echo \"ERROR: Upload package filename must be set using -f\"\n# usage\n# fi\n#\n# upload_file\n# ;;\n# *)\n# echo \"ERROR: Invalid command ${COMMAND}\"\n# usage\n# ;;\n# esac\n\npush-artifactory \"${DIST}\" \"${ARCH}\"\n"
},
{
"path": "scripts/release-packages.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nfunction assert_usage() {\n echo \"Incorrect arguments: $*\"\n echo \"$(basename ${BASH_SOURCE[0]}) PACKAGE_REPO_ROOT [SHA]\"\n echo \"\\tPACKAGE_REPO_ROOT: The path to the libnvidia-container repository\"\n echo \"\\tSHA: The SHA / reference to release. [Default: HEAD]\"\n exit 1\n}\n\nset -e\n\nSCRIPTS_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\"/../scripts && pwd )\"\nPROJECT_ROOT=\"$( cd ${SCRIPTS_DIR}/.. && pwd )\"\n\nif [[ $# -lt 1 || $# -gt 2 ]]; then\n assert_usage $*\nfi\n\nsource \"${SCRIPTS_DIR}\"/utils.sh\n\nPACKAGE_REPO_ROOT=$1\nif [[ ! -d ${PACKAGE_REPO_ROOT} ]]; then\n echo \"The specified PACKAGE_REPO_ROOT '${PACKAGE_REPO_ROOT}' must exist\"\n exit 1\nfi\n\n: ${REFERENCE:=\"HEAD\"}\nif [[ $# -ge 2 ]]; then\n REFERENCE=$2\nfi\n\nSHA=$(git rev-parse --short=8 ${REFERENCE})\nIMAGE_NAME=\"ghcr.io/nvidia/container-toolkit\"\nIMAGE_TAG=${SHA}-packaging\n\n: ${VERSION:=\"$(get_version_from_image ${IMAGE_NAME}:${IMAGE_TAG} ${SHA})\"}\n\nREPO=\"experimental\"\nif [[ ${VERSION/rc./} == ${VERSION} ]]; then\n REPO=\"stable\"\nfi\n\nPACKAGE_CACHE=release-${VERSION}-${REPO}\n\necho \"Fetching packages with SHA '${SHA}' as tag '${VERSION}' to ${PACKAGE_CACHE}\"\n${SCRIPTS_DIR}/../hack/pull-packages.sh \\\n ${IMAGE_NAME}:${IMAGE_TAG} \\\n ${PACKAGE_CACHE}\n\n: ${ALL_RPMS:=\"$(find ${PACKAGE_CACHE} -name \"*.rpm\" -exec basename {} \\; | sort | uniq)\"}\n: ${ALL_DEBS:=\"$(find ${PACKAGE_CACHE} -name \"*.deb\" -exec basename {} \\; | sort | uniq)\"}\n\n\nPACKAGE_REPO_ROOT=$(cd \"${PACKAGE_REPO_ROOT}\" && pwd)\necho \"Updating ${REPO} repo at ${PACKAGE_REPO_ROOT}\"\n\ndocker build \\\n -t nvidia/toolkit-deb-pkg-signer \\\n -f ${SCRIPTS_DIR}/Dockerfile.sign.deb \\\n ${SCRIPTS_DIR}\n\ndocker build \\\n -t nvidia/toolkit-rpm-pkg-signer \\\n -f ${SCRIPTS_DIR}/Dockerfile.sign.rpm \\\n ${SCRIPTS_DIR}\n\nfunction sync() {\n local target=$1\n local src_root=$2\n local dst_root=$3\n local by_package_type=$4\n\n local src_dist=${target%-*}\n local dst_dist=${src_dist/amazonlinux/amzn}\n\n local pkg_type=unknown\n local arch=${target##*-}\n local dst_arch=${arch}\n\n case ${src_dist} in\n amazonlinux*) pkg_type=rpm\n ;;\n centos*) pkg_type=rpm\n ;;\n debian*) pkg_type=deb\n ;;\n fedora*) pkg_type=rpm\n ;;\n opensuse-leap*) pkg_type=rpm\n ;;\n ubuntu*) pkg_type=deb\n dst_arch=${arch//ppc64le/ppc64el}\n ;;\n *) echo \"ERROR: unexpected distribution ${src_dist}\"\n exit 1\n ;;\n esac\n\n if [[ x\"${by_package_type}\" == x\"true\" ]]; then\n dst_dist=${pkg_type}\n fi\n\n local src=${src_root}/${src_dist}/${arch}\n local dst=${dst_root}/${dst_dist}/${dst_arch}\n\n if [[ ! -d ${src} || -z $(ls ${src}/*.${pkg_type}) ]]; then\n echo \"Skipping ${src}\"\n return\n fi\n mkdir -p ${dst}\n\n for f in $(ls ${src}/libnvidia-container*.${pkg_type} ${src}/nvidia-container-toolkit*.${pkg_type}); do\n # We never release nvidia-container-toolkit-operator-extensions packages\n if [[ \"${f/\"nvidia-container-toolkit-operator-extensions\"/}\" != \"${f}\" ]]; then\n echo \"Skipping ${f}\"\n continue\n fi\n\n df=${dst}/$(basename ${f})\n df_stable=${df//\"/experimental/\"/\"/stable/\"}\n if [[ -f \"${df}\" ]]; then\n echo \"${df} already exists; skipping\"\n elif [[ ${REPO} == \"experimental\" && -f ${df_stable} ]]; then\n echo \"${df_stable} already exists; skipping\"\n else\n cp ${f} ${df}\n fi\n\n done\n}\n\ntargets=${all[@]}\n\n_current_branch=$(git -C ${PACKAGE_REPO_ROOT} rev-parse --abbrev-ref HEAD)\nif [[ x\"${_current_branch}\" != x\"gh-pages\" ]]; then\n echo \"It is expected that the gh-pages branch be checked out\"\n exit 1\nfi\n\n: ${UPSTREAM_REMOTE:=\"origin\"}\n\n: ${UPSTREAM_REFERENCE:=\"${UPSTREAM_REMOTE}/gh-pages\"}\ngit -C ${PACKAGE_REPO_ROOT} reset --hard ${UPSTREAM_REFERENCE}\ngit -C ${PACKAGE_REPO_ROOT} clean -fdx ${REPO}\n\nfor target in ${targets[@]}; do\n echo \"checking target=${target}\"\n by_package_type=\n case ${target} in\n ubuntu18.04-* | centos7-*)\n by_package_type=\"true\"\n ;;\n *)\n echo \"Skipping target ${target}\"\n continue\n ;;\n esac\n sync ${target} ${PACKAGE_CACHE}/packages ${PACKAGE_REPO_ROOT}/${REPO} ${by_package_type}\ndone\n\ngit -C ${PACKAGE_REPO_ROOT} add ${REPO}\n\n# Experimental / release candidate release\ngit -C ${PACKAGE_REPO_ROOT} commit -s -F- < /dev/null; then\n regctl image get-file \"${image}\" \"${path_in_image}\" \"${path_on_host}\"\n else\n # Note this will only work for destinations where the `path_on_host` is in `pwd`\n docker run --rm \\\n -v \"$(pwd):$(pwd)\" \\\n -w \"$(pwd)\" \\\n -u \"$(id -u):$(id -g)\" \\\n --entrypoint=\"sh\" \\\n \"${image}\" \\\n -c \"cp -p ${path_in_image} ${path_on_host}\"\n fi\n}\n\n# extract_info extracts the value of the specified variable from the manifest.txt file.\nfunction extract_from_manifest() {\n local variable=$1\n local manifest=$2\n local value=$(cat ${manifest} | grep \"#${variable}=\" | sed -e \"s/#${variable}=//\" | tr -d '\\r')\n echo $value\n}\n\n# extract_info extracts the value of the specified variable from the manifest.txt file.\nfunction extract_info() {\n extract_from_manifest $1 \"${ARTIFACTS_DIR}/manifest.txt\"\n}\n\nfunction get_version_from_image() {\n local image=$1\n local manifest=\"manifest-${2}.txt\"\n copy_file ${image} \"/artifacts/manifest.txt\" ${manifest}\n version=$(extract_from_manifest \"PACKAGE_VERSION\" ${manifest})\n echo \"v${version/\\~/-}\"\n rm -f ${manifest}\n}\n\nfunction join_by { local IFS=\"$1\"; shift; echo \"$*\"; }"
},
{
"path": "testdata/go.mod",
"content": ""
},
{
"path": "testdata/installer/artifacts/deb/usr/bin/nvidia-cdi-hook",
"content": "nvidia-cdi-hook\n"
},
{
"path": "testdata/installer/artifacts/deb/usr/bin/nvidia-container-cli",
"content": "nvidia-container-cli\n"
},
{
"path": "testdata/installer/artifacts/deb/usr/bin/nvidia-container-runtime",
"content": "nvidia-container-runtime\n"
},
{
"path": "testdata/installer/artifacts/deb/usr/bin/nvidia-container-runtime-hook",
"content": "nvidia-container-runtime-hook\n"
},
{
"path": "testdata/installer/artifacts/deb/usr/bin/nvidia-container-runtime.cdi",
"content": "nvidia-container-runtime.cdi\n"
},
{
"path": "testdata/installer/artifacts/deb/usr/bin/nvidia-container-runtime.legacy",
"content": "nvidia-container-runtime.legacy\n"
},
{
"path": "testdata/installer/artifacts/deb/usr/bin/nvidia-ctk",
"content": "nvidia-ctk\n"
},
{
"path": "testdata/installer/artifacts/deb/usr/lib/x86_64-linux-gnu/libnvidia-container-go.so.99.88.77",
"content": ""
},
{
"path": "testdata/installer/artifacts/deb/usr/lib/x86_64-linux-gnu/libnvidia-container.so.99.88.77",
"content": ""
},
{
"path": "testdata/installer/artifacts/rpm/usr/bin/nvidia-cdi-hook",
"content": "nvidia-cdi-hook\n"
},
{
"path": "testdata/installer/artifacts/rpm/usr/bin/nvidia-container-cli",
"content": "nvidia-container-cli\n"
},
{
"path": "testdata/installer/artifacts/rpm/usr/bin/nvidia-container-runtime",
"content": "nvidia-container-runtime\n"
},
{
"path": "testdata/installer/artifacts/rpm/usr/bin/nvidia-container-runtime-hook",
"content": "nvidia-container-runtime-hook\n"
},
{
"path": "testdata/installer/artifacts/rpm/usr/bin/nvidia-container-runtime.cdi",
"content": "nvidia-container-runtime.cdi\n"
},
{
"path": "testdata/installer/artifacts/rpm/usr/bin/nvidia-container-runtime.legacy",
"content": "nvidia-container-runtime.legacy\n"
},
{
"path": "testdata/installer/artifacts/rpm/usr/bin/nvidia-ctk",
"content": "nvidia-ctk\n"
},
{
"path": "testdata/installer/artifacts/rpm/usr/lib64/libnvidia-container-go.so.99.88.77",
"content": ""
},
{
"path": "testdata/installer/artifacts/rpm/usr/lib64/libnvidia-container.so.99.88.77",
"content": ""
},
{
"path": "testdata/lookup/csv-mode/dev/nvidia0",
"content": ""
},
{
"path": "testdata/lookup/csv-mode/etc/nvidia-container-runtime/host-files-for-container.d/devices.csv",
"content": "dev, /dev/dri/card*\ndev, /dev/dri/renderD*\ndir, /dev/dri/by-path\ndev, /dev/fb0\ndev, /dev/fb1\ndev, /dev/host1x-fence\ndev, /dev/nvhost-as-gpu\ndev, /dev/nvhost-ctrl-gpu\ndev, /dev/nvhost-ctrl-nvdla0\ndev, /dev/nvhost-ctrl-nvdla1\ndev, /dev/nvhost-ctrl-pva0\ndev, /dev/nvhost-ctxsw-gpu\ndev, /dev/nvhost-dbg-gpu\ndev, /dev/nvhost-gpu\ndev, /dev/nvhost-nvsched-gpu\ndev, /dev/nvhost-power-gpu\ndev, /dev/nvhost-prof-ctx-gpu\ndev, /dev/nvhost-prof-dev-gpu\ndev, /dev/nvhost-prof-gpu\ndev, /dev/nvhost-sched-gpu\ndev, /dev/nvhost-tsg-gpu\ndev, /dev/nvgpu/igpu0/as\ndev, /dev/nvgpu/igpu0/channel\ndev, /dev/nvgpu/igpu0/ctrl\ndev, /dev/nvgpu/igpu0/ctxsw\ndev, /dev/nvgpu/igpu0/dbg\ndev, /dev/nvgpu/igpu0/nvsched\ndev, /dev/nvgpu/igpu0/power\ndev, /dev/nvgpu/igpu0/prof\ndev, /dev/nvgpu/igpu0/prof-ctx\ndev, /dev/nvgpu/igpu0/prof-dev\ndev, /dev/nvgpu/igpu0/sched\ndev, /dev/nvgpu/igpu0/tsg\ndev, /dev/nvidia-modeset\ndev, /dev/nvidia0\ndev, /dev/nvidiactl\ndev, /dev/nvmap\ndev, /dev/nvsciipc\ndev, /dev/v4l2-nvdec\ndev, /dev/v4l2-nvenc\n"
},
{
"path": "testdata/lookup/csv-mode/etc/nvidia-container-runtime/host-files-for-container.d/drivers.csv",
"content": "lib, /usr/lib/aarch64-linux-gnu/libv4l2.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/desktop-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/drm-backend.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/EGLWLInputEventExample\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/EGLWLMockNavigation\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/fullscreen-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/gl-renderer.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/hmi-controller.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/ivi-controller.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/ivi-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/LayerManagerControl\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libilmClient.so.2.2.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libilmCommon.so.2.2.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libilmControl.so.2.2.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libilmInput.so.2.2.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libweston-6.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libweston-desktop-6.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/simple-weston-client\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/spring-tool\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/wayland-backend.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-calibrator\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-clickdot\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-cliptest\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-content-protection\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-debug\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-desktop-shell\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-dnd\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-eventdemo\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-flower\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-fullscreen\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-image\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-info\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-ivi-shell-user-interface\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-keyboard\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-launch\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-multi-resource\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-output-mode\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-resizor\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-scaler\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-screenshooter\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-dmabuf-egldevice\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-egl\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-pattern-hdr\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-shm\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-touch\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-smoke\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-stacking\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-subsurfaces\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-terminal\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-transformed\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvarguscamerasrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvcompositor.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvdrmvideosink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnveglglessink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnveglstreamsrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvegltransform.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvipcpipeline.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvivafilter.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvjpeg.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvtee.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvv4l2camerasrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvidconv.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideo4linux2.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideosink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideosinks.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstcapture-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstipctestapp-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstplayer-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/libgstnvegl-1.0.so.0\nlib, /usr/lib/aarch64-linux-gnu/libgstnvexifmeta.so\nlib, /usr/lib/aarch64-linux-gnu/libgstnvivameta.so\nlib, /usr/lib/aarch64-linux-gnu/libnvsample_cudaprocess.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvcustomhelper.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvdsseimeta.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnveglstreamproducer.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvcustomhelper.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvdsseimeta.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdla_compiler.so\nlib, /etc/vulkansc/icd.d/nvidia_icd_vksc.json\nlib, /usr/lib/aarch64-linux-gnu/nvidia/ld.so.conf\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libGLX_nvidia.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libjetsonpower.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus_socketclient.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus_socketserver.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbuf_fdmap.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurface.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurftransform.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcameratools.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamerautils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcam_imageencoder.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamlog.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcapture.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcolorutil.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcucompat.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcudla.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcuvidv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvddk_2d_v2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvddk_vic.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdecode2eglimage.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdla_runtime.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdsbufferpool.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnveventlib.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvexif.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnet.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnetstoredefog.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnetstorehdfx.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfusacapinterface.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfusacap.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_boot.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_camera.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_force.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_generic.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_gpucompute.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_graphics.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_il.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_spincircle.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_tbc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_ui.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-allocator.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-eglcore.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-gbm.so.1.1.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-wayland.so.1.1.11\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glcore.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glsi.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glvkspirv.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-gpucomp.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-kms.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-nvvm.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ptxjitcompiler.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-rmapi-tegra.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-rtcore.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-tls.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-vksc-core.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvid_mapper.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvimp.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisppg.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisp.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisp_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvjpeg.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_dla.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_eglstream.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ide_parser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ide_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_iep_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ijpd_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ijpe_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_iofa_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_isp_ext.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedialdc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_tensor.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_contentpipe.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_image.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_video.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_parser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvodm_imager.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvofsdk.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvoggopus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvomxilclient.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvomx.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvosd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvos.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvparser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvphsd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvphs.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvplayfair.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpva_algorithms.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpvaintf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpva.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpvaumd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_chip.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_gpu.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_host1x.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_mem.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_stream.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_surface.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_sync.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscibuf.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscicommon.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscievent.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsciipc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscistream.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscisync.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsocsys.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtegrahv.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtracebuf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtvmr_2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtvmr.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvv4lconvert.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvic.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvideoencode_ppe.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvideo.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libsensors.hal-client.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libsensors_hal.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libsensors.l4t.no_fusion.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libtegrav4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libtegrawfd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvargus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvcuvidvideocodec.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvvideocodec.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libVkLayer_json_gen.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libVkSCLayer_khronos_validation.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so.1.0.10\nlib, /usr/lib/aarch64-linux-gnu/nvidia/nvidia_icd.json\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/ld.so.conf\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libEGL_nvidia.so.0\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libGLESv1_CM_nvidia.so.1\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libGLESv2_nvidia.so.2\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/nvidia.json\nsym, /etc/vulkan/icd.d/nvidia_icd.json\nsym, /usr/lib/aarch64-linux-gnu/gbm/nvidia-drm_gbm.so\nsym, /usr/lib/aarch64-linux-gnu/gbm/tegra_gbm.so\nsym, /usr/lib/aarch64-linux-gnu/gbm/tegra-udrm_gbm.so\nsym, /usr/lib/aarch64-linux-gnu/libcuda.so\nsym, /usr/lib/aarch64-linux-gnu/libnvcucompat.so\nsym, /usr/lib/aarch64-linux-gnu/libnvcudla.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l2.so.0.0.999999\nsym, /usr/lib/aarch64-linux-gnu/libv4lconvert.so.0.0.999999\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvcuvidvideocodec.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvvideocodec.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurface.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurftransform.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvdsbufferpool.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-allocator.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-gbm.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-wayland.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-kms.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-nvvm.so.4\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ptxjitcompiler.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-vksc-core.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-vksc-core.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvid_mapper.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscibuf.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscicommon.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscistream.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscisync.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2.so.0\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libv4lconvert.so.0\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so.1\nsym, /usr/lib/aarch64-linux-gnu/tegra\nsym, /usr/share/glvnd/egl_vendor.d/10_nvidia.json\nlib, //lib/firmware/tegra19x/nvhost_nvdec040_ns.fw\nlib, /lib/firmware/tegra19x/nvhost_nvdec040_ns.fw\nlib, /lib/firmware/tegra23x/nvhost_nvdec050_desc_prod.bin\nlib, /usr/sbin/nvidia-smi\nlib, /usr/share/doc/nvidia-tegra/LICENSE.nvidia-smi\n"
},
{
"path": "testdata/lookup/rootfs-1/README.md",
"content": "This rootfs represents a host with the CUDA driver libraries installed in\n/lib/x86_64-linux-gnu. The included /etc/ld.so.cache was copied from such as system."
},
{
"path": "testdata/lookup/rootfs-1/dev/gdrdrv",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/infiniband/rdma_cm",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/infiniband/uverbs0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidia-caps/nvidia-cap1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidia-caps-imex-channels/channel0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidia-caps-imex-channels/channel1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidia-caps-imex-channels/channel2047",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidia-fs0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidia-nvswitch0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidia-nvswitchctl",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidia0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/dev/nvidiactl",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/etc/cufile.json",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/lib/x86_64-linux-gnu/libcuda.so.999.88.77",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77",
"content": ""
},
{
"path": "testdata/lookup/rootfs-1/run/udev/.gitkeep",
"content": ""
},
{
"path": "testdata/lookup/rootfs-2/README.md",
"content": "This rootfs represents a host with the CUDA driver libraries installed in\n/var/lib/nvidia/lib64. The included /etc/ld.so.cache was generated in a container\nsimulating such as system."
},
{
"path": "testdata/lookup/rootfs-2/var/lib/nvidia/lib64/libcuda.so.999.88.77",
"content": ""
},
{
"path": "testdata/lookup/rootfs-drm/dev/dri/card0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-drm/dev/dri/renderD128",
"content": ""
},
{
"path": "testdata/lookup/rootfs-empty/README.md",
"content": "The folders represents an empty rootfs.\n"
},
{
"path": "testdata/lookup/rootfs-no-cache-lib64/usr/lib64/libcuda.so.999.88.77",
"content": ""
},
{
"path": "testdata/lookup/rootfs-orin/dev/nvidia0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-orin/etc/nvidia-container-runtime/host-files-for-container.d/devices.csv",
"content": "dev, /dev/dri/card*\ndev, /dev/dri/renderD*\ndir, /dev/dri/by-path\ndev, /dev/fb0\ndev, /dev/fb1\ndev, /dev/host1x-fence\ndev, /dev/nvhost-as-gpu\ndev, /dev/nvhost-ctrl-gpu\ndev, /dev/nvhost-ctrl-nvdla0\ndev, /dev/nvhost-ctrl-nvdla1\ndev, /dev/nvhost-ctrl-pva0\ndev, /dev/nvhost-ctxsw-gpu\ndev, /dev/nvhost-dbg-gpu\ndev, /dev/nvhost-gpu\ndev, /dev/nvhost-nvsched-gpu\ndev, /dev/nvhost-power-gpu\ndev, /dev/nvhost-prof-ctx-gpu\ndev, /dev/nvhost-prof-dev-gpu\ndev, /dev/nvhost-prof-gpu\ndev, /dev/nvhost-sched-gpu\ndev, /dev/nvhost-tsg-gpu\ndev, /dev/nvgpu/igpu0/as\ndev, /dev/nvgpu/igpu0/channel\ndev, /dev/nvgpu/igpu0/ctrl\ndev, /dev/nvgpu/igpu0/ctxsw\ndev, /dev/nvgpu/igpu0/dbg\ndev, /dev/nvgpu/igpu0/nvsched\ndev, /dev/nvgpu/igpu0/power\ndev, /dev/nvgpu/igpu0/prof\ndev, /dev/nvgpu/igpu0/prof-ctx\ndev, /dev/nvgpu/igpu0/prof-dev\ndev, /dev/nvgpu/igpu0/sched\ndev, /dev/nvgpu/igpu0/tsg\ndev, /dev/nvidia-modeset\ndev, /dev/nvidia0\ndev, /dev/nvidiactl\ndev, /dev/nvmap\ndev, /dev/nvsciipc\ndev, /dev/v4l2-nvdec\ndev, /dev/v4l2-nvenc\n"
},
{
"path": "testdata/lookup/rootfs-orin/etc/nvidia-container-runtime/host-files-for-container.d/drivers.csv",
"content": "lib, /usr/lib/aarch64-linux-gnu/libv4l2.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/desktop-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/drm-backend.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/EGLWLInputEventExample\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/EGLWLMockNavigation\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/fullscreen-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/gl-renderer.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/hmi-controller.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/ivi-controller.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/ivi-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/LayerManagerControl\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libilmClient.so.2.2.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libilmCommon.so.2.2.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libilmControl.so.2.2.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libilmInput.so.2.2.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libweston-6.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/libweston-desktop-6.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/simple-weston-client\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/spring-tool\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/wayland-backend.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-calibrator\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-clickdot\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-cliptest\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-content-protection\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-debug\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-desktop-shell\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-dnd\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-eventdemo\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-flower\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-fullscreen\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-image\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-info\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-ivi-shell-user-interface\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-keyboard\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-launch\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-multi-resource\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-output-mode\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-resizor\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-scaler\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-screenshooter\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-dmabuf-egldevice\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-egl\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-pattern-hdr\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-shm\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-simple-touch\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-smoke\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-stacking\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-subsurfaces\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-terminal\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston/weston-transformed\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvarguscamerasrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvcompositor.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvdrmvideosink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnveglglessink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnveglstreamsrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvegltransform.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvipcpipeline.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvivafilter.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvjpeg.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvtee.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvv4l2camerasrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvidconv.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideo4linux2.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideosink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideosinks.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstcapture-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstipctestapp-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstplayer-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/libgstnvegl-1.0.so.0\nlib, /usr/lib/aarch64-linux-gnu/libgstnvexifmeta.so\nlib, /usr/lib/aarch64-linux-gnu/libgstnvivameta.so\nlib, /usr/lib/aarch64-linux-gnu/libnvsample_cudaprocess.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvcustomhelper.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvdsseimeta.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnveglstreamproducer.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvcustomhelper.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvdsseimeta.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdla_compiler.so\nlib, /etc/vulkansc/icd.d/nvidia_icd_vksc.json\nlib, /usr/lib/aarch64-linux-gnu/nvidia/ld.so.conf\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libGLX_nvidia.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libjetsonpower.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus_socketclient.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus_socketserver.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbuf_fdmap.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurface.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurftransform.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcameratools.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamerautils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcam_imageencoder.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamlog.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcapture.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcolorutil.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcucompat.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcudla.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcuvidv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvddk_2d_v2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvddk_vic.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdecode2eglimage.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdla_runtime.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdsbufferpool.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnveventlib.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvexif.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnet.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnetstoredefog.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnetstorehdfx.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfusacapinterface.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfusacap.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_boot.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_camera.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_force.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_generic.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_gpucompute.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_graphics.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_il.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_spincircle.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_tbc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvgov_ui.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-allocator.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-eglcore.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-gbm.so.1.1.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-wayland.so.1.1.11\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glcore.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glsi.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glvkspirv.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-gpucomp.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-kms.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-nvvm.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ptxjitcompiler.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-rmapi-tegra.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-rtcore.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-tls.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-vksc-core.so.540.3.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvid_mapper.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvimp.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisppg.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisp.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisp_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvjpeg.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_dla.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_eglstream.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ide_parser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ide_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_iep_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ijpd_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ijpe_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_iofa_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_isp_ext.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedialdc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_tensor.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_contentpipe.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_image.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_video.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_parser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvodm_imager.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvofsdk.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvoggopus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvomxilclient.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvomx.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvosd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvos.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvparser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvphsd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvphs.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvplayfair.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpva_algorithms.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpvaintf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpva.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpvaumd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_chip.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_gpu.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_host1x.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_mem.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_stream.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_surface.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_sync.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscibuf.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscicommon.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscievent.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsciipc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscistream.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscisync.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsocsys.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtegrahv.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtracebuf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtvmr_2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtvmr.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvv4lconvert.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvic.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvideoencode_ppe.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvideo.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libsensors.hal-client.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libsensors_hal.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libsensors.l4t.no_fusion.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libtegrav4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libtegrawfd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvargus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvcuvidvideocodec.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvvideocodec.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libVkLayer_json_gen.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libVkSCLayer_khronos_validation.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so.1.0.10\nlib, /usr/lib/aarch64-linux-gnu/nvidia/nvidia_icd.json\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/ld.so.conf\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libEGL_nvidia.so.0\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libGLESv1_CM_nvidia.so.1\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libGLESv2_nvidia.so.2\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/nvidia.json\nsym, /etc/vulkan/icd.d/nvidia_icd.json\nsym, /usr/lib/aarch64-linux-gnu/gbm/nvidia-drm_gbm.so\nsym, /usr/lib/aarch64-linux-gnu/gbm/tegra_gbm.so\nsym, /usr/lib/aarch64-linux-gnu/gbm/tegra-udrm_gbm.so\nsym, /usr/lib/aarch64-linux-gnu/libcuda.so\nsym, /usr/lib/aarch64-linux-gnu/libnvcucompat.so\nsym, /usr/lib/aarch64-linux-gnu/libnvcudla.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l2.so.0.0.999999\nsym, /usr/lib/aarch64-linux-gnu/libv4lconvert.so.0.0.999999\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvcuvidvideocodec.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvvideocodec.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurface.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurftransform.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvdsbufferpool.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-allocator.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-gbm.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-wayland.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-kms.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-nvvm.so.4\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ptxjitcompiler.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-vksc-core.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-vksc-core.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvid_mapper.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscibuf.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscicommon.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscistream.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscisync.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2.so.0\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libv4lconvert.so.0\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so.1\nsym, /usr/lib/aarch64-linux-gnu/tegra\nsym, /usr/share/glvnd/egl_vendor.d/10_nvidia.json\nlib, //lib/firmware/tegra19x/nvhost_nvdec040_ns.fw\nlib, /lib/firmware/tegra19x/nvhost_nvdec040_ns.fw\nlib, /lib/firmware/tegra23x/nvhost_nvdec050_desc_prod.bin\nlib, /usr/sbin/nvidia-smi\nlib, /usr/share/doc/nvidia-tegra/LICENSE.nvidia-smi\n"
},
{
"path": "testdata/lookup/rootfs-orin/usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-orin/usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/dev-root/dev/gdrdrv",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/dev-root/dev/nvidia-caps/nvidia-cap1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/dev-root/dev/nvidia-caps-imex-channels/channel0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/dev-root/dev/nvidia-caps-imex-channels/channel1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/dev-root/dev/nvidia-caps-imex-channels/channel2047",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/dev-root/dev/nvidia-fs0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/dev-root/dev/nvidia0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/dev-root/dev/nvidiactl",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/driver-root/etc/cufile.json",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/driver-root/lib/x86_64-linux-gnu/libcuda.so.1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/driver-root/lib/x86_64-linux-gnu/libcuda.so.999.88.77",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/driver-root/lib/x86_64-linux-gnu/vdpau/libvdpau_nvidia.so.999.88.77",
"content": ""
},
{
"path": "testdata/lookup/rootfs-split/driver-root/run/udev/.gitkeep",
"content": ""
},
{
"path": "testdata/lookup/rootfs-thor-dgpu/dev/nvidia0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-thor-dgpu/dev/nvidia1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-thor-dgpu/dev/nvidia2",
"content": ""
},
{
"path": "testdata/lookup/rootfs-thor-dgpu/dev/nvidiactl",
"content": ""
},
{
"path": "testdata/lookup/rootfs-thor-dgpu/dev/nvmap",
"content": "{\n \"file_mode\": 256,\n \"gid\": 44\n}"
},
{
"path": "testdata/lookup/rootfs-thor-dgpu/etc/nvidia-container-runtime/host-files-for-container.d/devices.csv",
"content": "dev, /dev/dri/card*\ndev, /dev/dri/renderD*\ndir, /dev/dri/by-path\ndev, /dev/fb0\ndev, /dev/fb1\ndev, /dev/host1x-fence\ndev, /dev/nvhost-as-gpu\ndev, /dev/nvhost-ctrl-gpu\ndev, /dev/nvhost-ctrl-nvdla0\ndev, /dev/nvhost-ctrl-nvdla1\ndev, /dev/nvhost-ctrl-pva0\ndev, /dev/nvhost-ctxsw-gpu\ndev, /dev/nvhost-dbg-gpu\ndev, /dev/nvhost-gpu\ndev, /dev/nvhost-nvsched-gpu\ndev, /dev/nvhost-power-gpu\ndev, /dev/nvhost-prof-ctx-gpu\ndev, /dev/nvhost-prof-dev-gpu\ndev, /dev/nvhost-prof-gpu\ndev, /dev/nvhost-sched-gpu\ndev, /dev/nvhost-tsg-gpu\ndev, /dev/nvgpu/igpu0/as\ndev, /dev/nvgpu/igpu0/channel\ndev, /dev/nvgpu/igpu0/ctrl\ndev, /dev/nvgpu/igpu0/ctxsw\ndev, /dev/nvgpu/igpu0/dbg\ndev, /dev/nvgpu/igpu0/nvsched\ndev, /dev/nvgpu/igpu0/power\ndev, /dev/nvgpu/igpu0/prof\ndev, /dev/nvgpu/igpu0/prof-ctx\ndev, /dev/nvgpu/igpu0/prof-dev\ndev, /dev/nvgpu/igpu0/sched\ndev, /dev/nvgpu/igpu0/tsg\ndev, /dev/nvidia-modeset\ndev, /dev/nvidia0\ndev, /dev/nvidia1\ndev, /dev/nvidiactl\ndev, /dev/nvmap\ndev, /dev/nvsciipc\ndev, /dev/v4l2-nvdec\ndev, /dev/v4l2-nvenc\n"
},
{
"path": "testdata/lookup/rootfs-thor-dgpu/etc/nvidia-container-runtime/host-files-for-container.d/drivers.csv",
"content": "lib, /usr/lib/aarch64-linux-gnu/libv4l2.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/color-lcms.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/desktop-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/drm-backend.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/EGLWLInputEventExample\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/EGLWLMockNavigation\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/fullscreen-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/gl-renderer.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/headless-backend.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/hmi-controller.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/ivi-controller.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/ivi-shell.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/LayerManagerControl\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/libilmClient.so.2.3.2\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/libilmCommon.so.2.3.2\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/libilmControl.so.2.3.2\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/libilmInput.so.2.3.2\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/libweston-13.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/simple-weston-client\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/spring-tool\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/wayland-backend.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-calibrator\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-clickdot\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-cliptest\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-content-protection\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-debug\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-desktop-shell\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-dnd\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-eventdemo\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-flower\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-fullscreen\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-image\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-ivi-shell-user-interface\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-keyboard\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-multi-resource\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-output-mode\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-presentation-shm\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-resizor\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-scaler\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-screenshooter\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-simple-damage\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-simple-dmabuf-egl\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-simple-dmabuf-egldevice\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-simple-dmabuf-feedback\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-simple-egl\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-simple-im\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-simple-shm\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-simple-touch\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-smoke\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-stacking\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-subsurfaces\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-tablet\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-terminal\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-touch-calibrator\nlib, /usr/lib/aarch64-linux-gnu/nvidia/weston-13.0/weston-transformed\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvarguscamerasrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvcompositor.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvdrmvideosink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnveglglessink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnveglstreamsrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvegltransform.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvipcpipeline.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvivafilter.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvjpeg.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvsiplsrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvtee.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvunixfd.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvv4l2camerasrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvidconv.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideo4linux2.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideosink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideosinks.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstcapture-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstipctestapp-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/nvgstplayer-1.0_README.txt\nlib, /usr/lib/aarch64-linux-gnu/libgstnvegl-1.0.so.0\nlib, /usr/lib/aarch64-linux-gnu/libgstnvexifmeta.so\nlib, /usr/lib/aarch64-linux-gnu/libgstnvivameta.so\nlib, /usr/lib/aarch64-linux-gnu/libnvsample_cudaprocess.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvcustomhelper.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvdsseimeta.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnveglstreamproducer.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvcustomhelper.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libgstnvdsseimeta.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdla_compiler.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcuvid.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-encode.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-opticalflow.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvcuvid.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-encode.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-opticalflow.so.1\nlib, /etc/vulkansc/icd.d/nvidia_icd_vksc.json\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libcuda_instrumentation.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libdrm.so.2\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libGLX_nvidia.so.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libgnarl-24.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libgnat-24.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libjetsonpower.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus_socketclient.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvargus_socketserver.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbuf_fdmap.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurface_nvsci.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurface.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurftransform.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamerahal.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcameratools.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamerautils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcam_imageencoder.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamlog.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcamv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcapture.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcolorutil.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcucompat.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcudla.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcuextend.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvddk_2d_v2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvddk_vic.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdecode2eglimage.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdla_runtime.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvdsbufferpool.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnveventlib.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvexif.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnet.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnetstoredefog.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfnetstorehdfx.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfusacapinterface.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvfusacap.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-allocator.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-eglcore.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-gbm.so.1.1.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-wayland.so.1.1.11\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-xcb.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-xlib.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glcore.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glsi.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-glvkspirv.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-gpucomp.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-kms.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ml.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-nvvm70.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-nvvm.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ptxjitcompiler.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-rmapi-tegra.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-rtcore.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-tls.so.580.00\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvid_mapper.so.1.0.0\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvimp.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisppg.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisp.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvisp_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvll.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_dla.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_eglstream.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ide_parser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ide_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_iep_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ijpd_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_ijpe_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_iofa_sci.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_isp_ext.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedialdc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmedia_tensor.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_contentpipe.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_jpeg.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_image.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmmlite_video.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_parser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvmm_utils.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvodm_imager.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvoggopus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvomxilclient.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvomx.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvosd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvos.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvparser.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvplayfair.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpva_algorithms.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpvaintf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpva.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpvaumd_core.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvpvaumd_cuda.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_chip.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_gpu.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_host1x.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_mem.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_stream.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_surface.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvrm_sync.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscibuf.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscicommon.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscievent.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsciipc.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscistream.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvscisync.so.1\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsipl_control.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsipl_devblk_cdi.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsipl_devblk_crypto.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsipl_devblk_ddi.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsipl_devblk.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsipl_pipeline.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsipl_query.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsipl.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvsocsys.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtegrahv.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtracebuf.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtvmr_2d.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvtvmr.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvv4lconvert.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvic.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvideoencode_ppe.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvvideo.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libtegrawfd.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvargus.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libVkLayer_json_gen.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libVkSCLayer_khronos_validation.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so.1.0.10\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libvulkan.so.1.4.321\nlib, /usr/lib/aarch64-linux-gnu/nvidia/nvidia_icd.json\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libEGL_nvidia.so.0\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libGLESv1_CM_nvidia.so.1\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/libGLESv2_nvidia.so.2\nlib, /usr/lib/aarch64-linux-gnu/tegra-egl/nvidia.json\nlib, /usr/lib/nvsipl_drv/libnvsipl_qry_vb1940.so\nlib, /usr/lib/nvsipl_uddf/libnvuddf_eagle_library.so\nsym, /etc/vulkan/icd.d/nvidia_icd.json\nsym, /usr/lib/aarch64-linux-gnu/gbm/nvidia-drm_gbm.so\nsym, /usr/lib/aarch64-linux-gnu/gbm/tegra_gbm.so\nsym, /usr/lib/aarch64-linux-gnu/libcuda_instrumentation.so\nsym, /usr/lib/aarch64-linux-gnu/libcuda.so\nsym, /usr/lib/aarch64-linux-gnu/libnvcucompat.so\nsym, /usr/lib/aarch64-linux-gnu/libnvcudla.so\nsym, /usr/lib/aarch64-linux-gnu/libnvcuextend.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l2.so.0.0.999999\nsym, /usr/lib/aarch64-linux-gnu/libv4lconvert.so.0.0.999999\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvargus.so\nsym, /usr/lib/aarch64-linux-gnu/libvulkan.so.1.4.321\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libcuda_instrumentation.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libcuda.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libgnarl.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libgnat.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurface_nvsci.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurface.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvbufsurftransform.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvdsbufferpool.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-allocator.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-gbm.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-egl-wayland.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-kms.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-nvvm70.so.4\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-nvvm.so.4\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvidia-ptxjitcompiler.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvid_mapper.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscibuf.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscicommon.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscistream.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libnvscisync.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2.so.0\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libv4lconvert.so.0\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libvulkansc.so.1\nsym, /usr/lib/aarch64-linux-gnu/nvidia/libvulkan.so.1\nsym, /usr/lib/aarch64-linux-gnu/tegra\nsym, /usr/share/glvnd/egl_vendor.d/10_nvidia.json\nlib, /lib/firmware/tegra23x/nvhost_nvdec050_desc_prod.bin\nlib, /usr/bin/nvidia-cuda-mps-control\nlib, /usr/bin/nvidia-cuda-mps-server\nlib, /usr/sbin/nvidia-smi\nlib, /usr/share/doc/package_name/LICENSE.nvidia-cuda-mps-control\nlib, /usr/share/doc/package_name/LICENSE.nvidia-cuda-mps-server\nlib, /usr/share/doc/package_name/LICENSE.nvidia-smi\nlib, /var/nvidia/nvcam/settings/ar0234.nito\nlib, /var/nvidia/nvcam/settings/e3333.nito\nlib, /var/nvidia/nvcam/settings/imx185.nito\nlib, /var/nvidia/nvcam/settings/imx219.nito\nlib, /var/nvidia/nvcam/settings/imx274_li.nito\nlib, /var/nvidia/nvcam/settings/imx477.nito\nlib, /var/nvidia/nvcam/settings/sipl/vb1940.nito\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libnvcuvidv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvcuvidvideocodec.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvcuvidvideocodec.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libtegrav4l2.so\nlib, /usr/lib/aarch64-linux-gnu/nvidia/libv4l2_nvvideocodec.so\nsym, /usr/lib/aarch64-linux-gnu/libv4l/plugins/nv/libv4l2_nvvideocodec.so\n"
},
{
"path": "testdata/lookup/rootfs-with-nvswitch/dev/nvidia-nvswitch0",
"content": ""
},
{
"path": "testdata/lookup/rootfs-with-nvswitch/dev/nvidia-nvswitch1",
"content": ""
},
{
"path": "testdata/lookup/rootfs-with-nvswitch/dev/nvidia-nvswitchctl",
"content": ""
},
{
"path": "tests/bin/nvidia-container-runtime-hook",
"content": "#!/bin/bash\necho mock hook\n"
},
{
"path": "tests/bin/runc",
"content": "#!/bin/bash\necho mock runc\n"
},
{
"path": "tests/container/common.sh",
"content": "#! /bin/bash\n# Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nreadonly CRIO_HOOKS_DIR=\"/usr/share/containers/oci/hooks.d\"\nreadonly CRIO_HOOK_FILENAME=\"oci-nvidia-hook.json\"\n\n# shellcheck disable=SC2015\n[ -t 2 ] && readonly LOG_TTY=1 || readonly LOG_NO_TTY=1\n\nif [ \"${LOG_TTY-0}\" -eq 1 ] && [ \"$(tput colors)\" -ge 15 ]; then\n\treadonly FMT_BOLD=$(tput bold)\n\treadonly FMT_RED=$(tput setaf 1)\n\treadonly FMT_YELLOW=$(tput setaf 3)\n\treadonly FMT_BLUE=$(tput setaf 12)\n\treadonly FMT_CLEAR=$(tput sgr0)\nfi\n\nlog() {\n\tlocal -r level=\"$1\"; shift\n\tlocal -r message=\"$*\"\n\n\tlocal fmt_on=\"${FMT_CLEAR-}\"\n\tlocal -r fmt_off=\"${FMT_CLEAR-}\"\n\n\tcase \"${level}\" in\n\t\tINFO) fmt_on=\"${FMT_BLUE-}\" ;;\n\t\tWARN) fmt_on=\"${FMT_YELLOW-}\" ;;\n\t\tERROR) fmt_on=\"${FMT_RED-}\" ;;\n\tesac\n\tprintf \"%s[%s]%s %b\\n\" \"${fmt_on}\" \"${level}\" \"${fmt_off}\" \"${message}\" >&2\n}\n\nwith_retry() {\n\tlocal max_attempts=\"$1\"\n\tlocal delay=\"$2\"\n\tlocal count=0\n\tlocal rc\n\tshift 2\n\n\twhile true; do\n\t\tset +e\n\t\t\"$@\"; rc=\"$?\"\n\t\tset -e\n\n\t\tcount=\"$((count+1))\"\n\n\t\tif [[ \"${rc}\" -eq 0 ]]; then\n\t\t\treturn 0\n\t\tfi\n\n\t\tif [[ \"${max_attempts}\" -le 0 ]] || [[ \"${count}\" -lt \"${max_attempts}\" ]]; then\n\t\t\tsleep \"${delay}\"\n\t\telse\n\t\t\tbreak\n\t\tfi\n\tdone\n\n\treturn 1\n}\n\ntesting::setup() {\n\tcp -Rp ${basedir}/shared ${shared_dir}\n\tmkdir -p \"${shared_dir}/etc/containerd\"\n\tmkdir -p \"${shared_dir}/etc/docker\"\n\tmkdir -p \"${shared_dir}/run/docker/containerd\"\n\tmkdir -p \"${shared_dir}/run/nvidia\"\n\tmkdir -p \"${shared_dir}/usr/local/nvidia\"\n\tmkdir -p \"${shared_dir}${CRIO_HOOKS_DIR}\"\n}\n\ntesting::cleanup() {\n\tif [[ \"${CLEANUP}\" == \"false\" ]]; then\n\t\techo \"Skipping cleanup: CLEANUP=${CLEANUP}\"\n\t\treturn 0\n\tfi\n\tif [[ -e \"${shared_dir}\" ]]; then\n\t\tdocker run --rm \\\n\t\t\t-v \"${shared_dir}:/work\" \\\n\t\t\talpine sh -c 'rm -rf /work/*'\n\t\trmdir \"${shared_dir}\"\n\tfi\n\n\tif [[ \"${test_cases:-\"\"}\" == \"\" ]]; then\n\t\techo \"No test cases defined. Skipping test case cleanup\"\n\t\treturn 0\n\tfi\n\n\tfor tc in ${test_cases}; do\n\t\ttesting::${tc}::cleanup\n\tdone\n}\n\ntesting::docker_run::toolkit::shell() {\n\tdocker run --rm --privileged \\\n\t\t--entrypoint sh \\\n\t\t-v \"${shared_dir}/etc/containerd:/etc/containerd\" \\\n\t\t-v \"${shared_dir}/etc/docker:/etc/docker\" \\\n\t\t-v \"${shared_dir}/run/docker/containerd:/run/docker/containerd\" \\\n\t\t-v \"${shared_dir}/run/nvidia:/run/nvidia\" \\\n\t\t-v \"${shared_dir}/usr/local/nvidia:/usr/local/nvidia\" \\\n\t\t-v \"${shared_dir}${CRIO_HOOKS_DIR}:${CRIO_HOOKS_DIR}\" \\\n\t\t\"${toolkit_container_image}\" \"-c\" \"$*\"\n}\n\n\n"
},
{
"path": "tests/container/containerd_test.sh",
"content": "#! /bin/bash\n# Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nreadonly containerd_dind_ctr=\"container-config-containerd-dind-ctr-name\"\nreadonly containerd_test_ctr=\"container-config-containerd-test-ctr-name\"\nreadonly containerd_dind_socket=\"/run/nvidia/docker.sock\"\nreadonly containerd_dind_containerd_dir=\"/run/docker/containerd\"\n\ntesting::containerd::dind::setup() {\n\t# Docker creates /etc/docker when starting\n\t# by default there isn't any config in this directory (even after the daemon starts)\n\tdocker run -d --rm --privileged \\\n\t\t-v \"${shared_dir}/etc/docker:/etc/docker\" \\\n\t\t-v \"${shared_dir}/run/nvidia:/run/nvidia\" \\\n\t\t-v \"${shared_dir}/usr/local/nvidia:/usr/local/nvidia\" \\\n\t\t-v \"${shared_dir}/run/docker/containerd:/run/docker/containerd\" \\\n\t\t--name \"${containerd_dind_ctr}\" \\\n\t\tdocker:dind -H unix://${containerd_dind_socket}\n}\n\ntesting::containerd::dind::exec() {\n\tdocker exec \"${containerd_dind_ctr}\" sh -c \"$*\"\n}\n\ntesting::containerd::toolkit::run() {\n\tlocal version=${1}\n\n\t# We run ctr image list to ensure that containerd has successfully started in the docker-in-docker container\n\twith_retry 5 5s testing::containerd::dind::exec \" \\\n\t\tctr --address=${containerd_dind_containerd_dir}/containerd.sock image list -q\"\n\n\t# Ensure that we can run some non GPU containers from within dind\n\twith_retry 3 5s testing::containerd::dind::exec \" \\\n\t\tctr --address=${containerd_dind_containerd_dir}/containerd.sock image pull nvcr.io/nvidia/cuda:11.1.1-base-ubuntu20.04; \\\n\t\tctr --address=${containerd_dind_containerd_dir}/containerd.sock run --rm --runtime=io.containerd.runtime.v1.linux nvcr.io/nvidia/cuda:11.1.1-base-ubuntu20.04 cuda echo foo\"\n\n\t# Share the volumes so that we can edit the config file and point to the new runtime\n\t# Share the pid so that we can ask docker to reload its config\n\tdocker run --rm --privileged \\\n\t\t--volumes-from \"${containerd_dind_ctr}\" \\\n\t\t-v \"${shared_dir}/etc/containerd/config_${version}.toml:${containerd_dind_containerd_dir}/containerd.toml\" \\\n\t\t--pid \"container:${containerd_dind_ctr}\" \\\n\t\t-e RUNTIME=\"containerd\" \\\n\t\t-e RUNTIME_ARGS=\"--config=${containerd_dind_containerd_dir}/containerd.toml --socket=${containerd_dind_containerd_dir}/containerd.sock\" \\\n\t\t--name \"${containerd_test_ctr}\" \\\n\t\t\"${toolkit_container_image}\" \"/usr/local/nvidia\" \"--no-daemon\"\n\n\t# We run ctr image list to ensure that containerd has successfully started in the docker-in-docker container\n\twith_retry 5 5s testing::containerd::dind::exec \" \\\n\t\tctr --address=${containerd_dind_containerd_dir}/containerd.sock image list -q\"\n\n\t# Ensure that we haven't broken non GPU containers\n\twith_retry 3 5s testing::containerd::dind::exec \" \\\n\t\tctr --address=${containerd_dind_containerd_dir}/containerd.sock image pull nvcr.io/nvidia/cuda:11.1.1-base-ubuntu20.04; \\\n\t\tctr --address=${containerd_dind_containerd_dir}/containerd.sock run --rm --runtime=io.containerd.runtime.v1.linux nvcr.io/nvidia/cuda:11.1.1-base-ubuntu20.04 cuda echo foo\"\n}\n\n# This test runs containerd setup and containerd cleanup in succession to ensure that the\n# config is restored correctly.\ntesting::containerd::toolkit::test_config() {\n\tlocal version=${1}\n\n\t# We run ctr image list to ensure that containerd has successfully started in the docker-in-docker container\n\twith_retry 5 5s testing::containerd::dind::exec \" \\\n\t\tctr --address=${containerd_dind_containerd_dir}/containerd.sock image list -q\"\n\n\tlocal input_config=\"${shared_dir}/etc/containerd/config_${version}.toml\"\n\tlocal output_config=\"${shared_dir}/output/config_${version}.toml\"\n\tlocal output_dir=$(dirname ${output_config})\n\n\tmkdir -p ${output_dir}\n\tcp -p \"${input_config}\" \"${output_config}\"\n\n\tdocker run --rm --privileged \\\n\t\t--volumes-from \"${containerd_dind_ctr}\" \\\n\t\t-v \"${output_dir}:${output_dir}\" \\\n\t\t--name \"${containerd_test_ctr}\" \\\n\t\t--entrypoint sh \\\n\t\t\"${toolkit_container_image}\" -c \"containerd setup \\\n\t\t\t--config=${output_config} \\\n\t\t\t--socket=${containerd_dind_containerd_dir}/containerd.sock \\\n\t\t\t--restart-mode=none \\\n\t\t\t\t/usr/local/nvidia/toolkit\"\n\n\t# As a basic test we check that the config has changed\n\tdiff \"${input_config}\" \"${output_config}\" || test ${?} -ne 0\n\tgrep -q -E \"^version = \\d\" \"${output_config}\"\n\tgrep -q -E \"default_runtime_name = \\\"nvidia\\\"\" \"${output_config}\"\n\n\tdocker run --rm --privileged \\\n\t\t--volumes-from \"${containerd_dind_ctr}\" \\\n\t\t-v \"${output_dir}:${output_dir}\" \\\n\t\t--name \"${containerd_test_ctr}\" \\\n\t\t--entrypoint sh \\\n\t\t\"${toolkit_container_image}\" -c \"containerd cleanup \\\n\t\t\t\t\t--config=${output_config} \\\n\t\t\t--socket=${containerd_dind_containerd_dir}/containerd.sock \\\n\t\t\t--restart-mode=none \\\n\t\t\t\t/usr/local/nvidia/toolkit\"\n\n\tif [[ -s \"${input_config}\" ]]; then\n\t\t# Compare the input and output config. These should be the same.\n\t\tdiff \"${input_config}\" \"${output_config}\" || true\n\telse\n\t\t# If the input config is empty, the output should not exist.\n\t\ttest ! -e \"${output_config}\"\n\tfi\n}\n\ntesting::containerd::main() {\n\ttesting::containerd::dind::setup\n\n\ttesting::containerd::toolkit::test_config empty\n\ttesting::containerd::toolkit::test_config v1\n\ttesting::containerd::toolkit::test_config v2\n\n\ttesting::containerd::cleanup\n\n\ttesting::containerd::dind::setup\n\ttesting::containerd::toolkit::run empty\n\ttesting::containerd::cleanup\n\n\ttesting::containerd::dind::setup\n\ttesting::containerd::toolkit::run v1\n\ttesting::containerd::cleanup\n\n\ttesting::containerd::dind::setup\n\ttesting::containerd::toolkit::run v2\n\ttesting::containerd::cleanup\n}\n\ntesting::containerd::cleanup() {\n\tdocker kill \"${containerd_dind_ctr}\" &> /dev/null || true\n\tdocker kill \"${containerd_test_ctr}\" &> /dev/null || true\n}\n"
},
{
"path": "tests/container/crio_test.sh",
"content": "#! /bin/bash\n# Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\ntesting::crio::hook_created() {\n\ttesting::docker_run::toolkit::shell 'crio setup /run/nvidia/toolkit'\n\n\ttest ! -z \"$(ls -A \"${shared_dir}${CRIO_HOOKS_DIR}\")\"\n\n\tcat \"${shared_dir}${CRIO_HOOKS_DIR}/${CRIO_HOOK_FILENAME}\" | \\\n\t\tjq -r '.hook.path' | grep -q \"/run/nvidia/toolkit/\"\n\ttest $? -eq 0\n\tcat \"${shared_dir}${CRIO_HOOKS_DIR}/${CRIO_HOOK_FILENAME}\" | \\\n\t\tjq -r '.hook.env[0]' | grep -q \":/run/nvidia/toolkit\"\n\ttest $? -eq 0\n}\n\ntesting::crio::hook_cleanup() {\n\ttesting::docker_run::toolkit::shell 'crio cleanup --nvidia-runtime-dir /run/nvidia/toolkit/'\n\n\ttest -z \"$(ls -A \"${shared_dir}${CRIO_HOOKS_DIR}\")\"\n}\n\ntesting::crio::main() {\n\ttesting::crio::hook_created\n\ttesting::crio::hook_cleanup\n}\n\ntesting::crio::cleanup() {\n\t:\n}\n"
},
{
"path": "tests/container/docker_test.sh",
"content": "#! /bin/bash\n# Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nreadonly docker_dind_ctr=\"container-config-docker-dind-ctr-name\"\nreadonly docker_test_ctr=\"container-config-docker-test-ctr-name\"\nreadonly docker_dind_socket=\"/run/nvidia/docker.sock\"\n\ntesting::docker::dind::setup() {\n\t# Docker creates /etc/docker when starting\n\t# by default there isn't any config in this directory (even after the daemon starts)\n\tdocker run -d --rm --privileged \\\n\t\t-v \"${shared_dir}/etc/docker:/etc/docker\" \\\n\t\t-v \"${shared_dir}/run/nvidia:/run/nvidia\" \\\n\t\t-v \"${shared_dir}/usr/local/nvidia:/usr/local/nvidia\" \\\n\t\t--name \"${docker_dind_ctr}\" \\\n\t\tdocker:dind -H unix://${docker_dind_socket}\n}\n\ntesting::docker::dind::exec() {\n\tdocker exec \"${docker_dind_ctr}\" sh -c \"$*\"\n}\n\ntesting::docker::toolkit::run() {\n\t# Share the volumes so that we can edit the config file and point to the new runtime\n\t# Share the pid so that we can ask docker to reload its config\n\tdocker run -d --rm --privileged \\\n\t\t--volumes-from \"${docker_dind_ctr}\" \\\n\t\t--pid \"container:${docker_dind_ctr}\" \\\n\t\t-e RUNTIME_ARGS=\"--socket ${docker_dind_socket}\" \\\n\t\t--name \"${docker_test_ctr}\" \\\n\t\t\"${toolkit_container_image}\" \"/usr/local/nvidia\" \"--no-daemon\"\n\n\t# Ensure that we haven't broken non GPU containers\n\twith_retry 3 5s testing::docker::dind::exec docker run -t alpine echo foo\n}\n\ntesting::docker::main() {\n\ttesting::docker::dind::setup\n\ttesting::docker::toolkit::run\n}\n\ntesting::docker::cleanup() {\n\tdocker kill \"${docker_dind_ctr}\" &> /dev/null || true\n\tdocker kill \"${docker_test_ctr}\" &> /dev/null || true\n}\n"
},
{
"path": "tests/container/main.sh",
"content": "#! /bin/bash\n# Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nset -eEuo pipefail\nshopt -s lastpipe\n\nreadonly basedir=\"$(dirname \"$(realpath \"$0\")\")\"\nsource \"${basedir}/common.sh\"\n\nsource \"${basedir}/docker_test.sh\"\nsource \"${basedir}/crio_test.sh\"\nsource \"${basedir}/containerd_test.sh\"\n\n: ${CLEANUP:=true}\n\nusage() {\n\tcat >&2 </dev/null`\n\n\tsetSystemdDegradedScript = `#!/usr/bin/env bash\n\t# Start the dummy service to force systemd to enter a degraded state\n\tcat < /etc/systemd/system/dummy.service\n[Unit]\nDescription=Dummy systemd service\n\n[Service]\nType=oneshot\nExecStart=/usr/bin/sh -c \"exit 1\"\nEOF\n\n\t# We know the dummy service will fail, so we can ignore the error\n\tsystemctl start --now dummy.service 2>/dev/null || true\n\t`\n\n\tfixSystemDegradedScript = `#!/usr/bin/env bash\n\t# Start the dummy service to force systemd to enter a degraded state\n\tcat < /etc/systemd/system/dummy.service\n[Unit]\nDescription=Dummy systemd service\n\n[Service]\nType=oneshot\nExecStart=/usr/bin/sh -c \"exit 0\"\nEOF\n\n\tsystemctl daemon-reload\n\n\tsystemctl start --now dummy.service 2>/dev/null || true\n\n\trm -rf /etc/systemd/system/dummy.service\n\tsystemctl daemon-reload\n`\n\n\tnvidiaCdiRefreshPathActiveTemplate = `\n\tif ! systemctl status nvidia-cdi-refresh.path | grep \"Active: active\"; then\n\t\techo \"nvidia-cdi-refresh.path is not Active\"\n\t\texit 1\n\tfi\n\t`\n\tnvidiaCdiRefreshServiceLoadedTemplate = `\n\tif ! systemctl status nvidia-cdi-refresh.service | grep \"Loaded: loaded\"; then\n\t\techo \"nvidia-cdi-refresh.service is not loaded\"\n\t\texit 1\n\tfi\n\t`\n\n\tnvidiaCdiRefreshFileExistsTemplate = `\n\t# is /var/run/cdi/nvidia.yaml exists? and exit with 0 if it does not exist\n\tif [ ! -f /var/run/cdi/nvidia.yaml ]; then\n\t\techo \"nvidia.yaml file does not exist\"\n\t\texit 1\n\tfi\n\n\t# generate the nvidia.yaml file\n\tnvidia-ctk cdi generate --output=/tmp/nvidia.yaml\n\n\t# diff the generated file with the one in /var/run/cdi/nvidia.yaml and exit with 0 if they are the same\n\tif ! diff /var/run/cdi/nvidia.yaml /tmp/nvidia.yaml; then\n\t\techo \"nvidia.yaml file is different\"\n\t\texit 1\n\tfi\n\t`\n\n\tnvidiaCdiRefreshUpgradeTemplate = `\n\t# remove the generated files\n\trm /var/run/cdi/nvidia.yaml /tmp/nvidia.yaml\n\n\t# Touch the nvidia-ctk binary to change the mtime\n\t# This will trigger the nvidia-cdi-refresh.path unit to call the\n\t# nvidia-cdi-refresh.service unit, simulating a change(update/downgrade) in the nvidia-ctk binary.\n\ttouch $(which nvidia-ctk)\n\n\t# wait for 3 seconds\n\tsleep 3\n\n\t# Check if the file /var/run/cdi/nvidia.yaml is created\n\tif [ ! -f /var/run/cdi/nvidia.yaml ]; then\n\t\techo \"nvidia.yaml file is not created after updating the modules.dep file\"\n\t\texit 1\n\tfi\n\n\t# generate the nvidia.yaml file\n\tnvidia-ctk cdi generate --output=/tmp/nvidia.yaml\n\n\t# diff the generated file with the one in /var/run/cdi/nvidia.yaml and exit with 0 if they are the same\n\tif ! diff /var/run/cdi/nvidia.yaml /tmp/nvidia.yaml; then\n\t\techo \"nvidia.yaml file is different\"\n\t\texit 1\n\tfi\n\t`\n)\n\nvar _ = Describe(\"nvidia-cdi-refresh\", Ordered, ContinueOnFailure, Label(\"systemd-unit\"), func() {\n\tvar (\n\t\tcontainerName = \"nvctk-e2e-nvidia-cdi-refresh-tests\"\n\t\tsystemdRunner Runner\n\t\t// TODO(@ArangoGutierrez): https://github.com/NVIDIA/nvidia-container-toolkit/pull/1235/files#r2302013660\n\t\touterContainerImage = \"docker.io/kindest/base:v20250521-31a79fd4\"\n\t)\n\n\tBeforeAll(func(ctx context.Context) {\n\t\tvar err error\n\t\tsystemdRunner, err = NewNestedContainerRunner(runner, outerContainerImage, false, containerName, localCacheDir, true)\n\t\tExpect(err).ToNot(HaveOccurred())\n\t\tfor range 10 {\n\t\t\tstate, _, err := systemdRunner.Run(getSystemStateScript)\n\t\t\tif err == nil {\n\t\t\t\tGinkgoLogr.Info(\"systemd started\", \"state\", state)\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tGinkgoLogr.Error(err, \"systemctl state\")\n\t\t\ttime.Sleep(1 * time.Second)\n\t\t}\n\t})\n\n\tAfterAll(func(ctx context.Context) {\n\t\t// Cleanup: remove the container and the temporary script on the host.\n\t\t// Use || true to ensure cleanup doesn't fail the test\n\t\trunner.Run(fmt.Sprintf(\"docker rm -f %s 2>/dev/null || true\", containerName))\n\t})\n\n\tWhen(\"installing nvidia-container-toolkit\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\n\t\t\t_, _, err := toolkitInstaller.Install(systemdRunner)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\toutput, _, err := systemdRunner.Run(\"nvidia-ctk --version\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tGinkgoLogr.Info(\"using nvidia-ctk\", \"version\", strings.TrimSpace(output))\n\t\t})\n\n\t\tAfterAll(func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(\"apt-get purge -y libnvidia-container* nvidia-container-toolkit*\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should load the nvidia-cdi-refresh.path unit\", func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(nvidiaCdiRefreshPathActiveTemplate)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should load the nvidia-cdi-refresh.service unit\", func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(nvidiaCdiRefreshServiceLoadedTemplate)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should generate the nvidia.yaml file\", func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(nvidiaCdiRefreshFileExistsTemplate)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should refresh the nvidia.yaml file after upgrading the nvidia-container-toolkit\", func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(nvidiaCdiRefreshUpgradeTemplate)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\t})\n\n\tWhen(\"installing nvidia-container-toolkit on a system with a degraded systemd\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(setSystemdDegradedScript)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t_, _, err = systemdRunner.Run(getSystemStateScript)\n\t\t\tExpect(err).To(HaveOccurred())\n\t\t\tExpect(err.Error()).To(ContainSubstring(\"degraded\"))\n\t\t})\n\n\t\tAfterAll(func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(fixSystemDegradedScript)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\tstate, _, err := systemdRunner.Run(getSystemStateScript)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(strings.TrimSpace(state)).To(Equal(\"running\"))\n\t\t})\n\n\t\tIt(\"should load the nvidia-cdi-refresh.path unit\", func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(nvidiaCdiRefreshPathActiveTemplate)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should load the nvidia-cdi-refresh.service unit\", func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(nvidiaCdiRefreshServiceLoadedTemplate)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should generate the nvidia.yaml file\", func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(nvidiaCdiRefreshFileExistsTemplate)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should generate the nvidia.yaml file\", func(ctx context.Context) {\n\t\t\t_, _, err := systemdRunner.Run(nvidiaCdiRefreshFileExistsTemplate)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\t})\n})\n"
},
{
"path": "tests/e2e/nvidia-container-cli_test.go",
"content": "/*\n * Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\npackage e2e\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"strings\"\n\n\t. \"github.com/onsi/ginkgo/v2\"\n\t. \"github.com/onsi/gomega\"\n)\n\nconst (\n\tlibnvidiaContainerCliTestTemplate = `\n# Create a temporary directory and rootfs path\nTMPDIR=\"$(mktemp -d)\"\nROOTFS=\"${TMPDIR}/rootfs\"\nmkdir -p \"${ROOTFS}\"\n\n# Expose ROOTFS for the child namespace\nexport ROOTFS TMPDIR\n\n# Download Ubuntu base image with error handling\ncurl -fsSL http://cdimage.ubuntu.com/ubuntu-base/releases/22.04/release/ubuntu-base-22.04-base-amd64.tar.gz | tar -C $ROOTFS -xz || {\n echo \"Failed to download or extract Ubuntu base image\"\n exit 1\n}\n\n# Enter a new mount + PID namespace so we can pivot_root without touching the\n# container'\\''s original filesystem.\nunshare --mount --pid --fork --propagation private -- sh -eux <<'\\''IN_NS'\\''\n : \"${ROOTFS:?}\"\n\n # 1 Bind-mount the new root and make the mount private\n mount --bind \"$ROOTFS\" \"$ROOTFS\"\n mount --make-private \"$ROOTFS\"\n cd \"$ROOTFS\"\n\n # 2 Minimal virtual filesystems\n mount -t proc proc proc\n mount -t sysfs sys sys\n mount -t tmpfs tmp tmp\n mount -t tmpfs run run\n\n # 3 Configure NVIDIA devices\n nvidia-container-cli --load-kmods configure --ldconfig=@/sbin/ldconfig.real --no-cgroups --utility --device 0 $(pwd)\n\n # 4 Switch root into the prepared filesystem\n pivot_root . mnt\n umount -l mnt\n nvidia-smi -L\n\nIN_NS\n`\n)\n\nvar _ = Describe(\"nvidia-container-cli\", Ordered, ContinueOnFailure, Label(\"libnvidia-container\"), func() {\n\tvar (\n\t\tcontainerName = \"nvct-e2e-nvidia-container-cli-tests\"\n\t\tnestedContainerRunner Runner\n\t\thostOutput string\n\t)\n\n\tBeforeAll(func(ctx context.Context) {\n\t\tvar err error\n\t\tnestedContainerRunner, err = NewNestedContainerRunner(runner, \"ubuntu\", !installCTK, containerName, localCacheDir, true)\n\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\tif installCTK {\n\t\t\t// We MAY also need to install the toolkit in the nested runner.\n\t\t\t_, _, err = toolkitInstaller.Install(nestedContainerRunner)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t}\n\n\t\t// Capture the host GPU list.\n\t\thostOutput, _, err = runner.Run(\"nvidia-smi -L\")\n\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t// Normalize the output once\n\t\thostOutput = strings.TrimSpace(strings.ReplaceAll(hostOutput, \"\\r\", \"\"))\n\t})\n\n\tAfterAll(func(ctx context.Context) {\n\t\t// Cleanup: remove the container and the temporary script on the host.\n\t\t// Use || true to ensure cleanup doesn't fail the test\n\t\trunner.Run(fmt.Sprintf(\"docker rm -f %s 2>/dev/null || true\", containerName)) //nolint:errcheck\n\t})\n\n\tIt(\"should report the same GPUs inside the container as on the host\", func(ctx context.Context) {\n\t\t// Run the test script in the container.\n\t\toutput, _, err := nestedContainerRunner.Run(libnvidiaContainerCliTestTemplate)\n\t\tExpect(err).ToNot(HaveOccurred())\n\t\tExpect(strings.TrimSpace(output)).ToNot(BeEmpty())\n\t\tExpect(hostOutput).To(ContainSubstring(strings.TrimSpace(output)))\n\t})\n})\n"
},
{
"path": "tests/e2e/nvidia-container-toolkit_test.go",
"content": "/*\n * Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\npackage e2e\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"strings\"\n\n\t. \"github.com/onsi/ginkgo/v2\"\n\t. \"github.com/onsi/gomega\"\n\n\t\"golang.org/x/mod/semver\"\n)\n\n// Integration tests for Docker runtime\nvar _ = Describe(\"docker\", Ordered, ContinueOnFailure, func() {\n\tvar dockerVersion string\n\tvar hostDriverVersion string\n\tvar hostDriverMajor string\n\tvar hostOutput string\n\n\t// Install the NVIDIA Container Toolkit\n\tBeforeAll(func(ctx context.Context) {\n\t\t// Get the docker version output in the form:\n\t\t// Docker version 29.1.3, build f52814d\n\t\tversionOutput, _, err := runner.Run(\"docker --version\")\n\t\tGinkgoLogr.Info(fmt.Sprintf(\"Extracted docker version string as: %q\", versionOutput))\n\t\tExpect(err).ToNot(HaveOccurred())\n\t\tdockerVersion = \"v\" + strings.TrimPrefix(strings.SplitN(versionOutput, \",\", 2)[0], \"Docker version \")\n\n\t\tdriverOutput, _, err := runner.Run(\"nvidia-smi -q | grep \\\"Driver Version\\\"\")\n\t\tExpect(err).ToNot(HaveOccurred())\n\t\tparts := strings.SplitN(driverOutput, \":\", 2)\n\t\tExpect(parts).To(HaveLen(2))\n\n\t\thostDriverVersion = strings.TrimSpace(parts[1])\n\t\tExpect(hostDriverVersion).ToNot(BeEmpty())\n\t\thostDriverMajor = strings.SplitN(hostDriverVersion, \".\", 2)[0]\n\n\t\thostOutput, _, err = runner.Run(\"nvidia-smi -L\")\n\t\tExpect(err).ToNot(HaveOccurred())\n\t})\n\n\t// GPUs are accessible in a container: Running nvidia-smi -L inside the\n\t// container shows the same output inside the container as outside the\n\t// container. This means that the following commands must all produce\n\t// the same output\n\tWhen(\"running nvidia-smi -L\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker pull ubuntu\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should support NVIDIA_VISIBLE_DEVICES\", func(ctx context.Context) {\n\t\t\tcontainerOutput, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all ubuntu nvidia-smi -L\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(containerOutput).To(Equal(hostOutput))\n\t\t})\n\n\t\tIt(\"should support automatic CDI spec generation\", func(ctx context.Context) {\n\t\t\tcontainerOutput, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all ubuntu nvidia-smi -L\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(containerOutput).To(Equal(hostOutput))\n\t\t})\n\n\t\tIt(\"should support automatic CDI spec generation with the --gpus flag\", func(ctx context.Context) {\n\t\t\tcontainerOutput, _, err := runner.Run(\"docker run --rm -i --gpus=all --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all ubuntu nvidia-smi -L\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(containerOutput).To(Equal(hostOutput))\n\t\t})\n\n\t\tIt(\"should support the --gpus flag using the nvidia-container-runtime\", func(ctx context.Context) {\n\t\t\tcontainerOutput, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia --gpus all ubuntu nvidia-smi -L\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(containerOutput).To(Equal(hostOutput))\n\t\t})\n\n\t\tIt(\"should support the --gpus flag using the nvidia-container-runtime-hook\", func(ctx context.Context) {\n\t\t\tcontainerOutput, _, err := runner.Run(\"docker run --rm -i --gpus all ubuntu nvidia-smi -L\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(containerOutput).To(Equal(hostOutput))\n\t\t})\n\n\t\tIt(\"should show no devices when NVIDIA_VISIBLE_DEVICES=none\", func(ctx context.Context) {\n\t\t\tcontainerOutput, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=none ubuntu nvidia-smi -L\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(strings.TrimSpace(containerOutput)).To(Equal(\"No devices found.\"))\n\t\t})\n\t})\n\n\t// A vectorAdd sample runs in a container with access to all GPUs.\n\t// The following should all produce the same result.\n\tWhen(\"Running the cuda-vectorAdd sample\", Ordered, func() {\n\t\tvar referenceOutput string\n\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker pull nvcr.io/nvidia/k8s/cuda-sample:vectoradd-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should support NVIDIA_VISIBLE_DEVICES\", func(ctx context.Context) {\n\t\t\tvar err error\n\t\t\treferenceOutput, _, err = runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all nvcr.io/nvidia/k8s/cuda-sample:vectoradd-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\tExpect(referenceOutput).To(ContainSubstring(\"Test PASSED\"))\n\t\t})\n\n\t\tIt(\"should support automatic CDI spec generation\", func(ctx context.Context) {\n\t\t\tout2, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all nvcr.io/nvidia/k8s/cuda-sample:vectoradd-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(referenceOutput).To(Equal(out2))\n\t\t})\n\n\t\tIt(\"should support the --gpus flag using the nvidia-container-runtime\", func(ctx context.Context) {\n\t\t\tout3, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia --gpus all nvcr.io/nvidia/k8s/cuda-sample:vectoradd-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(referenceOutput).To(Equal(out3))\n\t\t})\n\n\t\tIt(\"should support the --gpus flag using the nvidia-container-runtime-hook\", func(ctx context.Context) {\n\t\t\tout4, _, err := runner.Run(\"docker run --rm -i --gpus all nvcr.io/nvidia/k8s/cuda-sample:vectoradd-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(referenceOutput).To(Equal(out4))\n\t\t})\n\t})\n\n\t// A deviceQuery sample runs in a container with access to all GPUs\n\t// The following should all produce the same result.\n\tWhen(\"Running the cuda-deviceQuery sample\", Ordered, func() {\n\t\tvar referenceOutput string\n\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker pull nvcr.io/nvidia/k8s/cuda-sample:devicequery-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should support NVIDIA_VISIBLE_DEVICES\", func(ctx context.Context) {\n\t\t\tvar err error\n\t\t\treferenceOutput, _, err = runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all nvcr.io/nvidia/k8s/cuda-sample:devicequery-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(referenceOutput).To(ContainSubstring(\"Result = PASS\"))\n\t\t})\n\n\t\tIt(\"should support automatic CDI spec generation\", func(ctx context.Context) {\n\t\t\tout2, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all nvcr.io/nvidia/k8s/cuda-sample:devicequery-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(referenceOutput).To(Equal(out2))\n\t\t})\n\n\t\tIt(\"should support the --gpus flag using the nvidia-container-runtime\", func(ctx context.Context) {\n\t\t\tout3, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia --gpus all nvcr.io/nvidia/k8s/cuda-sample:devicequery-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(referenceOutput).To(Equal(out3))\n\t\t})\n\n\t\tIt(\"should support the --gpus flag using the nvidia-container-runtime-hook\", func(ctx context.Context) {\n\t\t\tout4, _, err := runner.Run(\"docker run --rm -i --gpus all nvcr.io/nvidia/k8s/cuda-sample:devicequery-cuda12.5.0\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(referenceOutput).To(Equal(out4))\n\t\t})\n\t})\n\n\tWhen(\"Testing CUDA Forward compatibility\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker pull nvcr.io/nvidia/cuda:12.9.0-base-ubi8\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\tcompatOutput, _, err := runner.Run(\"docker run --rm -i -e NVIDIA_VISIBLE_DEVICES=void nvcr.io/nvidia/cuda:12.9.0-base-ubi8 bash -c \\\"ls /usr/local/cuda/compat/libcuda.*.*\\\"\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(compatOutput).ToNot(BeEmpty())\n\n\t\t\tcompatDriverVersion := strings.TrimPrefix(filepath.Base(compatOutput), \"libcuda.so.\")\n\t\t\tcompatMajor := strings.SplitN(compatDriverVersion, \".\", 2)[0]\n\n\t\t\tif hostDriverMajor >= compatMajor {\n\t\t\t\tGinkgoLogr.Info(\"CUDA Forward Compatibility tests require an older driver version\", \"hostDriverVersion\", hostDriverVersion, \"compatDriverVersion\", compatDriverVersion)\n\t\t\t\tSkip(\"CUDA Forward Compatibility tests require an older driver version\")\n\t\t\t}\n\t\t})\n\n\t\tIt(\"should work with the nvidia runtime in legacy mode\", func(ctx context.Context) {\n\t\t\tldconfigOut, _, err := runner.Run(\"docker run --rm -i -e NVIDIA_DISABLE_REQUIRE=true --runtime=nvidia --gpus all nvcr.io/nvidia/cuda:12.9.0-base-ubi8 bash -c \\\"ldconfig -p | grep libcuda.so.1\\\"\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(ldconfigOut).To(ContainSubstring(\"/usr/local/cuda-12.9/compat/\"))\n\t\t})\n\n\t\tIt(\"should work with the nvidia runtime in CDI mode\", func(ctx context.Context) {\n\t\t\tldconfigOut, _, err := runner.Run(\"docker run --rm -i -e NVIDIA_DISABLE_REQUIRE=true --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all nvcr.io/nvidia/cuda:12.9.0-base-ubi8 bash -c \\\"ldconfig -p | grep libcuda.so.1\\\"\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(ldconfigOut).To(ContainSubstring(\"/usr/local/cuda-12.9/compat/\"))\n\t\t})\n\n\t\tIt(\"should work with nvidia-container-runtime-hook\", func(ctx context.Context) {\n\t\t\tldconfigOut, _, err := runner.Run(\"docker run --rm -i -e NVIDIA_DISABLE_REQUIRE=true --runtime=runc --gpus all nvcr.io/nvidia/cuda:12.9.0-base-ubi8 bash -c \\\"ldconfig -p | grep libcuda.so.1\\\"\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(ldconfigOut).To(ContainSubstring(\"/usr/local/cuda-12.9/compat/\"))\n\t\t})\n\n\t\tIt(\"should create a single ld.so.conf.d config file\", func(ctx context.Context) {\n\t\t\tlsout, _, err := runner.Run(\"docker run --rm -i -e NVIDIA_DISABLE_REQUIRE=true --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all nvcr.io/nvidia/cuda:12.9.0-base-ubi8 bash -c \\\"ls -l /etc/ld.so.conf.d/00-compat-*.conf\\\"\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(lsout).To(WithTransform(\n\t\t\t\tfunc(s string) []string {\n\t\t\t\t\treturn strings.Split(strings.TrimSpace(s), \"\\n\")\n\t\t\t\t}, HaveLen(1),\n\t\t\t))\n\t\t})\n\t})\n\n\tWhen(\"Disabling device node creation\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker pull ubuntu\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should work with nvidia-container-runtime-hook\", func(ctx context.Context) {\n\t\t\toutput, _, err := runner.Run(\"docker run --rm -i --runtime=runc --gpus=all ubuntu bash -c \\\"grep ModifyDeviceFiles: /proc/driver/nvidia/params\\\"\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(output).To(Equal(\"ModifyDeviceFiles: 0\\n\"))\n\t\t})\n\n\t\tIt(\"should work with automatic CDI spec generation\", func(ctx context.Context) {\n\t\t\toutput, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all ubuntu bash -c \\\"grep ModifyDeviceFiles: /proc/driver/nvidia/params\\\"\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(output).To(Equal(\"ModifyDeviceFiles: 0\\n\"))\n\t\t})\n\t})\n\n\tWhen(\"A container is run using CDI\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker pull ubuntu\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\t_, _, err = runner.Run(\"docker pull busybox\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should include libcuda.so in the ldcache\", func(ctx context.Context) {\n\t\t\tldcacheOutput, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all ubuntu bash -c \\\"ldconfig -p | grep 'libcuda.so'\\\"\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(ldcacheOutput).ToNot(BeEmpty())\n\n\t\t\tldcacheLines := strings.Split(ldcacheOutput, \"\\n\")\n\t\t\tvar libs []string\n\t\t\tfor _, line := range ldcacheLines {\n\t\t\t\tparts := strings.SplitN(line, \" (\", 2)\n\t\t\t\tlibs = append(libs, strings.TrimSpace(parts[0]))\n\t\t\t}\n\n\t\t\tExpect(libs).To(ContainElements([]string{\"libcuda.so\", \"libcuda.so.1\"}))\n\t\t})\n\n\t\tIt(\"should include .so and SONAME symlinks\", func(ctx context.Context) {\n\t\t\tsymlinkOutput, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all busybox ls -l /usr/lib/x86_64-linux-gnu/ | awk '{print $1, $9, $11}'\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(symlinkOutput).ToNot(BeEmpty())\n\n\t\t\t// This produces output similar to:\n\t\t\t// We check this to ensure that we have valid driver library symlink\n\t\t\t// chains.\n\t\t\t// lrwxrwxrwx libcuda.so libcuda.so.1\n\t\t\t// lrwxrwxrwx libcuda.so.1 libcuda.so.570.133.20\n\t\t\t// -rw-r--r-- libcuda.so.570.133.20\n\t\t\t// lrwxrwxrwx libcudadebugger.so libcudadebugger.so.1\n\t\t\t// lrwxrwxrwx libcudadebugger.so.1 libcudadebugger.so.570.133.20\n\t\t\t// -rw-r--r-- libcudadebugger.so.570.133.20\n\t\t\t// lrwxrwxrwx libnvidia-ml.so libnvidia-ml.so.1\n\t\t\t// lrwxrwxrwx libnvidia-ml.so.1 libnvidia-ml.so.570.133.20\n\t\t\t// -rw-r--r-- libnvidia-ml.so.570.133.20\n\t\t\t// lrwxrwxrwx libnvidia-nvvm.so libnvidia-nvvm.so.4\n\t\t\t// lrwxrwxrwx libnvidia-nvvm.so.4 libnvidia-nvvm.so.570.133.20\n\t\t\t// -rw-r--r-- libnvidia-nvvm.so.570.133.20\n\t\t\t// lrwxrwxrwx libnvidia-opencl.so libnvidia-opencl.so.1\n\t\t\t// lrwxrwxrwx libnvidia-opencl.so.1 libnvidia-opencl.so.570.133.20\n\t\t\t// -rw-r--r-- libnvidia-opencl.so.570.133.20\n\t\t\t// -rw-r--r-- libnvidia-pkcs11-openssl3.so.570.133.20\n\t\t\t// -rw-r--r-- libnvidia-pkcs11.so.570.133.20\n\t\t\t// lrwxrwxrwx libnvidia-ptxjitcompiler.so libnvidia-ptxjitcompiler.so.1\n\t\t\t// lrwxrwxrwx libnvidia-ptxjitcompiler.so.1 libnvidia-ptxjitcompiler.so.570.133.20\n\t\t\t// -rw-r--r-- libnvidia-ptxjitcompiler.so.570.133.20\n\n\t\t\tsymlinkOutputLines := strings.Split(symlinkOutput, \"\\n\")\n\t\t\tsymlinks := make(map[string][]string)\n\t\t\tvar soSymlink string\n\t\t\tfor _, line := range symlinkOutputLines {\n\t\t\t\ttrimmed := strings.TrimSpace(line)\n\t\t\t\tif trimmed == \"\" {\n\t\t\t\t\tsoSymlink = \"\"\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\t// We only consider links and regular files.\n\t\t\t\tif trimmed[0] != 'l' && trimmed[0] != '-' {\n\t\t\t\t\tsoSymlink = \"\"\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tfmt.Printf(\"trimmed = %q\\n\", trimmed)\n\t\t\t\tparts := strings.SplitN(trimmed, \" \", 3)\n\t\t\t\tpermissionString := parts[0]\n\n\t\t\t\t// If the line represents a symlink we may have to handle a new symlink chain.\n\t\t\t\tif strings.HasPrefix(permissionString, \"l\") && soSymlink == \"\" {\n\t\t\t\t\tif strings.HasSuffix(parts[1], \".so\") {\n\t\t\t\t\t\tsoSymlink = parts[1]\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\t// Keep track of the symlink chain.\n\t\t\t\tsymlinks[soSymlink] = append(symlinks[soSymlink], parts[1:]...)\n\n\t\t\t\t// We assume a regular file is the end of a symlink chain.\n\t\t\t\tif strings.HasPrefix(permissionString, \"-\") {\n\t\t\t\t\tsoSymlink = \"\"\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// The RM_VERSION symlink chains have the pattern:\n\t\t\t// [A.so -> A.so.1 -> A.so.driverVersion]\n\t\t\t// A has the suffix .so.\n\t\t\tExpect(symlinks).ToNot(BeEmpty())\n\t\t\tfor soSymlink, chain := range symlinks {\n\t\t\t\tif soSymlink == \"\" {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tfor _, c := range chain {\n\t\t\t\t\tExpect(c).To(HavePrefix(soSymlink))\n\t\t\t\t}\n\t\t\t\tExpect(chain[0]).To(HaveSuffix(\".so\"))\n\t\t\t\tExpect(chain[1]).ToNot(Equal(soSymlink))\n\t\t\t\tExpect(chain[len(chain)-1]).ToNot(Equal(soSymlink))\n\t\t\t}\n\t\t\tExpect(symlinks).To(And(\n\t\t\t\tHaveKey(\"libcuda.so\"),\n\t\t\t\tHaveKey(\"libnvcuvid.so\"),\n\t\t\t))\n\n\t\t\t// The libnvidia-ml.so symlink was removed in the 560 driver branch.\n\t\t\tif hostDriverMajor < \"560\" {\n\t\t\t\tExpect(symlinks).To(HaveKey(\"libnvidia-ml.so\"))\n\t\t\t}\n\t\t})\n\t})\n\n\tWhen(\"Running containers with shared mount propagation\", Ordered, func() {\n\t\tvar mountsBefore string\n\t\tvar tmpDirPath string\n\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker pull ubuntu\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\tstdout, _, err := runner.Run(\"mktemp -d --tmpdir=/tmp\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(stdout).ToNot(BeEmpty())\n\t\t\tExpect(stdout).To(HavePrefix(\"/tmp\"))\n\t\t\ttmpDirPath = strings.TrimSpace(stdout)\n\n\t\t\toutput, _, err := runner.Run(\"mount | sort\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(output).ToNot(BeEmpty())\n\t\t\tmountsBefore = output\n\t\t})\n\n\t\tAfterEach(func() {\n\t\t\tmountsAfter, _, err := runner.Run(\"mount | sort\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(mountsAfter).To(Equal(mountsBefore))\n\t\t})\n\n\t\tIt(\"should not leak mounts when using the nvidia-container-runtime-hook\", Label(\"legacy\"), func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker run --rm -i --runtime=runc -e NVIDIA_VISIBLE_DEVICES=all -e NVIDIA_DRIVER_CAPABILITIES=all --mount type=bind,source=\" + tmpDirPath + \",target=/empty,bind-propagation=shared ubuntu true\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should not leak mounts when using the nvidia-container-runtime\", func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all -e NVIDIA_DRIVER_CAPABILITIES=all --mount type=bind,source=\" + tmpDirPath + \",target=/empty,bind-propagation=shared ubuntu true\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should not leak mounts when using CDI mode\", func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker run --rm -i --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all -e NVIDIA_DRIVER_CAPABILITIES=runtime.nvidia.com/gpu=all --mount type=bind,source=\" + tmpDirPath + \",target=/empty,bind-propagation=shared ubuntu true\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\t})\n\n\tWhen(\"Running a container where the firmware folder resolves outside the container root\", Ordered, func() {\n\t\tvar outputDir string\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\toutput, _, err := runner.Run(\"mktemp -d -p $(pwd)\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\toutputDir = strings.TrimSpace(output)\n\n\t\t\t_, _, err = runner.Run(\"docker pull ubuntu\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t_, _, err = runner.Run(`docker build -t firmware-test \\\n --build-arg RM_VERSION=\"$(basename $(ls -d /lib/firmware/nvidia/*.*))\" \\\n --build-arg CURRENT_DIR=\"` + outputDir + `\" \\\n - <= 0 {\n\t\t\t\tSkip(fmt.Sprintf(\"This test requires Docker < v29.2.0. Found %s\", dockerVersion))\n\t\t\t}\n\t\t\toutput, stderr, err := runner.Run(\"docker run --rm --runtime=runc --gpus=all firmware-test\")\n\t\t\tExpect(err).To(HaveOccurred())\n\t\t\tExpect(output).To(BeEmpty())\n\t\t\tExpect(stderr).To(ContainSubstring(\": mount error: path error: /lib/firmware/nvidia/\"))\n\t\t})\n\n\t\tIt(\"should not fail when the --gpus flag is handled as a CDI request\", func(ctx context.Context) {\n\t\t\t// As of Docker v29.2.0, the --gpus flag is handled as a CDI\n\t\t\t// device request if CDI specs are available.\n\t\t\tif semver.Compare(dockerVersion, \"v29.2.0\") < 0 {\n\t\t\t\tSkip(fmt.Sprintf(\"This test requires Docker >= v29.2.0. Found %s\", dockerVersion))\n\t\t\t}\n\t\t\toutput, stderr, err := runner.Run(\"docker run --rm --runtime=runc --gpus=all firmware-test\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(output).To(BeEmpty())\n\t\t\tExpect(stderr).To(BeEmpty())\n\t\t})\n\t})\n\n\tWhen(\"Running a container with LD_PRELOAD\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t// Create the source for the poc.\n\t\t\t_, _, err := runner.Run(`cat < poc.c\n/**\nCode taken from https://youtu.be/56vcNIh35PA?si=gmh7Cx9P-lNTbl4L&t=328\n**/\n#include \n#include \n#include \n#include \n__attribute__((constructor))\nvoid init() {\n// Ultra-minimal exploit just create a marker file\nint fd = open(\"/owned\", O_CREAT | O_WRONLY, 0644);\n\tif (fd >= 0) {\n\t\twrite(fd, \"EXPLOITED\\n\", 10);\n\t\tclose(fd);\n\t}\n}\nEOF`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t// Create the local Dockerfile\n\t\t\t_, _, err = runner.Run(`cat < Dockerfile.nvidiascape\nFROM ubuntu AS build\nRUN apt-get update && \\\n\tapt-get install -y gcc \\\n\t&& \\\n\trm -rf /var/lib/apt/lists/*\nADD poc.c .\nRUN gcc -shared -fPIC -o poc.so poc.c\nFROM ubuntu\nENV LD_PRELOAD=/proc/self/cwd/poc.so\nCOPY --from=build poc.so /\nEOF`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t// Build the test image.\n\t\t\t_, _, err = runner.Run(`docker build -t nvidiascape-test -f Dockerfile.nvidiascape .`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t_, _, err = runner.Run(\"rm -f /owned\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tAfterAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"rm -f poc.c\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t_, _, err = runner.Run(\"rm -f Dockerfile.nvidiascape\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tAfterEach(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"rm -f /owned\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should not escape when using CDI\", func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker run --rm --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all nvidiascape-test\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\tstdout, stderr, err := runner.Run(`cat /owned || echo \"Unsuccessful\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(stderr).To(BeEmpty())\n\t\t\tExpect(strings.TrimSpace(stdout)).To(Equal(\"Unsuccessful\"))\n\t\t})\n\n\t\tIt(\"should not escape when using the nvidia-container-runtime\", func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker run --rm --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all -e NVIDIA_DRIVER_CAPABILITIES=all nvidiascape-test\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\tstdout, stderr, err := runner.Run(`cat /owned || echo \"Unsuccessful\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(stderr).To(BeEmpty())\n\t\t\tExpect(strings.TrimSpace(stdout)).To(Equal(\"Unsuccessful\"))\n\t\t})\n\n\t\tIt(\"should not escape when using the nvidia-container-runtime-hook\", Label(\"legacy\"), func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker run --rm --runtime=runc --gpus=all nvidiascape-test\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\tstdout, stderr, err := runner.Run(`cat /owned || echo \"Unsuccessful\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(stderr).To(BeEmpty())\n\t\t\tExpect(strings.TrimSpace(stdout)).To(Equal(\"Unsuccessful\"))\n\t\t})\n\t})\n\n\tWhen(\"Running a container that installs ocl-icd-libopencl1\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(\"docker pull ubuntu\")\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\t\tIt(\"should succeed when using the nvidia-container-runtime\", func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(`docker run --rm --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all -e NVIDIA_DRIVER_CAPABILITIES=all \\\n\t\t\t\tubuntu bash -c \"apt-get update && apt-get install -y ocl-icd-libopencl1\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\t\tIt(\"should succeed when using the nvidia-container-runtime-hook\", Label(\"legacy\"), func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(`docker run --rm --runtime=runc --gpus=all -e NVIDIA_DRIVER_CAPABILITIES=all \\\n\t\t\t\tubuntu bash -c \"apt-get update && apt-get install -y ocl-icd-libopencl1\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\t})\n\n\tWhen(\"running a container an ubuntu container with specific ld.so.conf ordering\", Ordered, func() {\n\t\tvar (\n\t\t\texpectedOutput string\n\t\t)\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(`docker build -t libordering \\\n - < /etc/ld.so.conf.d/00-xxx.conf\nRUN ldconfig\nEOF`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\texpectedOutput, _, err = runner.Run(`docker run --rm --runtime=runc libordering bash -c \"ldconfig -p | grep libc.so.\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should not change the ordering of libraries\", func(ctx context.Context) {\n\t\t\toutput, _, err := runner.Run(`docker run --rm --runtime=nvidia libordering bash -c \"ldconfig -p | grep libc.so.\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(output).To(Equal(expectedOutput))\n\t\t})\n\t})\n\n\tWhen(\"running a ubi9 container\", Ordered, func() {\n\t\tvar (\n\t\t\texpectedOutput string\n\t\t)\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(`docker pull redhat/ubi9`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\texpectedOutput, _, err = runner.Run(`docker run --rm --runtime=runc redhat/ubi9 bash -c \"ldconfig -p | grep libc.so.\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t})\n\n\t\tIt(\"should include the system libraries when using the nvidia-container-runtime\", func(ctx context.Context) {\n\t\t\toutput, _, err := runner.Run(`docker run --rm --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all redhat/ubi9 bash -c \"ldconfig -p | grep libc.so.\"`)\n\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\tExpect(output).To(Equal(expectedOutput))\n\t\t})\n\t})\n\n\tWhen(\"running an alpine container\", Ordered, func() {\n\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t_, _, err := runner.Run(`docker build -t alpinecompat \\\n - < /dev/null 2>&1; then\n\t\techo \"containerd is ready\"\n\t\texit 0\n\tfi\n\techo \"Waiting for containerd to be ready...\"\n\tsleep 1\ndone\necho \"containerd failed to start\"\nexit 1\n`\n)\n\n// containerdTestEnv defines the test environment for different containerd\n// versions\ntype containerdTestEnv struct {\n\tname string\n\timage string\n\tconfigVersion int64\n\tpluginName string\n\t// TODO: We could read this from the original config.\n\tcdiEnabledByDefault bool\n}\n\n// Define both containerd versions to test\nvar containerdEnvs = []*containerdTestEnv{\n\t{\n\t\tname: \"containerd-1.7\",\n\t\timage: \"kindest/node:v1.30.0@sha256:047357ac0cfea04663786a612ba1eaba9702bef25227a794b52890dd8bcd692e\",\n\t\tconfigVersion: 2,\n\t\tpluginName: \"io.containerd.grpc.v1.cri\",\n\t},\n\t{\n\t\tname: \"containerd-2.1\",\n\t\timage: \"docker.io/kindest/base:v20250521-31a79fd4\",\n\t\tconfigVersion: 3,\n\t\tpluginName: \"io.containerd.cri.v1.runtime\",\n\t\t// containerd >= 2.0 has CDI enabled by default\n\t\tcdiEnabledByDefault: true,\n\t},\n}\n\ntype toolkitConfig struct {\n\tsetAsDefault bool\n\tcdiEnabled bool\n}\n\nvar toolkitConfigVariants = []*toolkitConfig{\n\t{\n\t\tsetAsDefault: true,\n\t\tcdiEnabled: true,\n\t},\n\t{\n\t\tsetAsDefault: false,\n\t\tcdiEnabled: true,\n\t},\n\t{\n\t\tsetAsDefault: false,\n\t\tcdiEnabled: false,\n\t},\n}\n\ntype testConfig struct {\n\t*containerdTestEnv\n\t*toolkitConfig\n}\n\nfunc (c *testConfig) name() string {\n\treturn fmt.Sprintf(\"%s-default=%v-cdi=%v\", c.containerdTestEnv.name, c.setAsDefault, c.cdiEnabled)\n}\n\n// Integration tests for containerd drop-in config functionality.\n// These tests verify that nvidia-ctk runtime configure correctly applies\n// configuration changes while preserving existing settings. The preservation\n// validation is critical for containerd < 2.1 where plugin merge behavior\n// (commit 598c632) requires duplicating the CRI plugin section.\nvar _ = Describe(\"containerd\", Ordered, ContinueOnFailure, Label(\"container-runtime\"), func() {\n\tvar testsConfigs []*testConfig\n\tfor _, env := range containerdEnvs {\n\t\tfor _, variant := range toolkitConfigVariants {\n\t\t\tconfig := &testConfig{\n\t\t\t\tenv,\n\t\t\t\tvariant,\n\t\t\t}\n\t\t\ttestsConfigs = append(testsConfigs, config)\n\t\t}\n\t}\n\n\t// Run all tests for each testConfig\n\tfor _, tc := range testsConfigs {\n\t\tContext(tc.name(), Ordered, func() {\n\t\t\tvar (\n\t\t\t\tnestedContainerRunner Runner\n\t\t\t\tcontainerName = \"nvctk-e2e-containerd-tests\"\n\t\t\t\tbaselineConfig *toml.Tree\n\t\t\t\tbaselineConfigPlugins *toml.Tree\n\t\t\t\tbaselineConfigRuntimes map[string]any\n\t\t\t)\n\n\t\t\t// restartContainerdAndWait restarts containerd and waits for it\n\t\t\t// to be ready\n\t\t\trestartContainerdAndWait := func(runner Runner) error {\n\t\t\t\t_, _, err := runner.Run(restartContainerdScript)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn fmt.Errorf(\"failed to restart containerd: %w\", err)\n\t\t\t\t}\n\n\t\t\t\t_, _, err = runner.Run(waitForContainerdScript)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn fmt.Errorf(\"containerd did not become ready after restart\")\n\t\t\t\t}\n\t\t\t\treturn nil\n\t\t\t}\n\n\t\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t\tvar err error\n\n\t\t\t\t// Create the nested container with the global cache mounted\n\t\t\t\tnestedContainerRunner, err = NewNestedContainerRunner(runner, tc.image, false, containerName, localCacheDir, false)\n\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t\t// Backup original containerd configuration\n\t\t\t\t_, _, err = nestedContainerRunner.Run(`\n\t\t\t# Backup the original conf.d directory\n\t\t\tif [ -d /etc/containerd/conf.d ]; then\n\t\t\t\tcp -r /etc/containerd/conf.d /tmp/containerd-conf.d.backup\n\t\t\tfi\n\n\t\t\t# Backup the original config.toml\n\t\t\tif [ -f /etc/containerd/config.toml ]; then\n\t\t\t\tcp /etc/containerd/config.toml /tmp/containerd-config.toml.backup\n\t\t\tfi\n\t\t`)\n\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to backup containerd configuration\")\n\n\t\t\t\t// Restart containerd to ensure clean state before capturing baseline\n\t\t\t\terr = restartContainerdAndWait(nestedContainerRunner)\n\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to restart containerd before baseline capture\")\n\n\t\t\t\t// CAPTURE BASELINE: Get config BEFORE any modifications\n\t\t\t\tbaselineOutput, _, err := nestedContainerRunner.Run(\"containerd config dump\")\n\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to dump baseline configuration\")\n\n\t\t\t\tbaselineConfig, err = toml.Load(baselineOutput)\n\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to parse baseline configuration\")\n\n\t\t\t\t// Get plugin configs for comparison\n\t\t\t\tbaselineConfigPlugins, err = getPluginConfig(baselineConfig, tc.pluginName)\n\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t\tbaselineConfigRuntimes, err = getRuntimesConfig(baselineConfigPlugins)\n\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t\t// Install the NVIDIA Container Toolkit packages\n\t\t\t\t_, _, err = toolkitInstaller.Install(nestedContainerRunner)\n\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to install toolkit for containerd\")\n\t\t\t})\n\n\t\t\tAfterAll(func(ctx context.Context) {\n\t\t\t\t// Cleanup: remove the container\n\t\t\t\t_, _, err := runner.Run(fmt.Sprintf(\"docker rm -f %s 2>/dev/null || true\", containerName))\n\t\t\t\tif err != nil {\n\t\t\t\t\tGinkgoLogr.Error(err, \"failed to cleanup container\", \"container\", containerName)\n\t\t\t\t}\n\t\t\t})\n\n\t\t\tWhen(\"configuring containerd\", func() {\n\t\t\t\tvar (\n\t\t\t\t\tmergedConfig *toml.Tree\n\t\t\t\t\tmergedConfigPlugins *toml.Tree\n\t\t\t\t\tmergedConfigRuntimes map[string]any\n\t\t\t\t)\n\n\t\t\t\tBeforeAll(func(ctx context.Context) {\n\t\t\t\t\t// Apply nvidia-ctk configuration\n\t\t\t\t\tcmd := []string{\"nvidia-ctk runtime configure --runtime=containerd\"}\n\n\t\t\t\t\tif tc.setAsDefault {\n\t\t\t\t\t\tcmd = append(cmd, \"--set-as-default\")\n\t\t\t\t\t}\n\t\t\t\t\tif tc.cdiEnabled {\n\t\t\t\t\t\tcmd = append(cmd, \"--cdi.enabled\")\n\t\t\t\t\t}\n\n\t\t\t\t\tGinkgoLogr.Info(\"Applying nvidia-ctk configuration\", \"cmd\", strings.Join(cmd, \" \"))\n\t\t\t\t\t_, _, err := nestedContainerRunner.Run(strings.Join(cmd, \" \"))\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to configure containerd\")\n\n\t\t\t\t\t// Restart containerd to apply merged configuration\n\t\t\t\t\terr = restartContainerdAndWait(nestedContainerRunner)\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to restart containerd\")\n\n\t\t\t\t\t// Get merged configuration\n\t\t\t\t\tmergedOutput, _, err := nestedContainerRunner.Run(\"containerd config dump\")\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to dump merged configuration\")\n\n\t\t\t\t\tmergedConfig, err = toml.Load(mergedOutput)\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred(), \"Failed to parse merged configuration\")\n\n\t\t\t\t\tmergedConfigPlugins, err = getPluginConfig(mergedConfig, tc.pluginName)\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t\t\tmergedConfigRuntimes, err = getRuntimesConfig(mergedConfigPlugins)\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\t\t\t\t})\n\n\t\t\t\tIt(\"existing runtimes should remain unchanged\", func(ctx context.Context) {\n\t\t\t\t\tfor runtimeName, runtimeConfig := range baselineConfigRuntimes {\n\t\t\t\t\t\tExpect(mergedConfigRuntimes).To(HaveKeyWithValue(runtimeName, runtimeConfig))\n\t\t\t\t\t}\n\t\t\t\t})\n\n\t\t\t\tIt(\"the nvidia runtime should be added with the correct options\", func(ctx context.Context) {\n\t\t\t\t\truncToml, err := toml.TreeFromMap(baselineConfigRuntimes[\"runc\"].(map[string]any))\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t\t\truncTomlString, err := runcToml.ToTomlString()\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t\t\tvar addedRuntimes []string\n\t\t\t\t\tfor runtimeName, runtimeConfig := range mergedConfigRuntimes {\n\t\t\t\t\t\tif _, ok := baselineConfigRuntimes[runtimeName]; ok {\n\t\t\t\t\t\t\tcontinue\n\t\t\t\t\t\t}\n\t\t\t\t\t\taddedRuntimes = append(addedRuntimes, runtimeName)\n\n\t\t\t\t\t\tExpect(runtimeConfig).To(\n\t\t\t\t\t\t\tHaveKeyWithValue(\n\t\t\t\t\t\t\t\t\"options\", HaveKeyWithValue(\"BinaryName\", \"/usr/bin/nvidia-container-runtime\"),\n\t\t\t\t\t\t\t),\n\t\t\t\t\t\t)\n\n\t\t\t\t\t\truntimeToml, err := toml.TreeFromMap(runtimeConfig.(map[string]any))\n\t\t\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t\t\t\t// TODO: for some reason the podsandboxer is set to \"\" in the updated config\n\t\t\t\t\t\t// but set to a valid string in the runc config. This is most likely due to\n\t\t\t\t\t\t// the config source that we're implicitly using.\n\t\t\t\t\t\tif runcSandboxer := runcToml.Get(\"sandboxer\"); runcSandboxer != nil {\n\t\t\t\t\t\t\truntimeToml.Set(\"sandboxer\", runcSandboxer)\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\truncPath := runcToml.GetPath([]string{\"options\", \"BinaryName\"})\n\t\t\t\t\t\tif runcPath == nil {\n\t\t\t\t\t\t\truntimeToml.DeletePath([]string{\"options\", \"BinaryName\"})\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tfor _, option := range runcToml.Get(\"options\").(*toml.Tree).Keys() {\n\t\t\t\t\t\t\truncOption := runcToml.GetPath([]string{\"options\", option})\n\t\t\t\t\t\t\tswitch v := runcOption.(type) {\n\t\t\t\t\t\t\tcase int64:\n\t\t\t\t\t\t\t\tif runcOption.(int64) != 0 {\n\t\t\t\t\t\t\t\t\tGinkgoLogr.Info(fmt.Sprintf(\"non-zero option for %v: %+v %T\", option, runcOption, v))\n\t\t\t\t\t\t\t\t\tcontinue\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tcase string:\n\t\t\t\t\t\t\t\tif runcOption.(string) != \"\" {\n\t\t\t\t\t\t\t\t\tGinkgoLogr.Info(fmt.Sprintf(\"non-zero option for %v: %+v %T\", option, runcOption, v))\n\t\t\t\t\t\t\t\t\tcontinue\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tcase bool:\n\t\t\t\t\t\t\t\tif runcOption.(bool) {\n\t\t\t\t\t\t\t\t\tGinkgoLogr.Info(fmt.Sprintf(\"non-zero option for %v: %+v %T\", option, runcOption, v))\n\t\t\t\t\t\t\t\t\tcontinue\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\t\tpanic(fmt.Sprintf(\"invalid type for option %v: %+v %T\", option, runcOption, v))\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\truntimeToml.SetPath([]string{\"options\", option}, runcOption)\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tExpect(runtimeToml.ToTomlString()).To(BeEquivalentTo(runcTomlString))\n\t\t\t\t\t}\n\n\t\t\t\t\tExpect(addedRuntimes).To(Equal([]string{\"nvidia\"}))\n\t\t\t\t})\n\n\t\t\t\tIt(\"should set the default runtime\", func(ctx context.Context) {\n\t\t\t\t\texpectedDefault := \"runc\"\n\t\t\t\t\tif tc.setAsDefault {\n\t\t\t\t\t\texpectedDefault = \"nvidia\"\n\t\t\t\t\t}\n\t\t\t\t\tExpect(mergedConfigPlugins).To(\n\t\t\t\t\t\tWithTransform(\n\t\t\t\t\t\t\tfunc(t *toml.Tree) any {\n\t\t\t\t\t\t\t\treturn t.GetPath([]string{\"containerd\", \"default_runtime_name\"})\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBeEquivalentTo(expectedDefault),\n\t\t\t\t\t\t),\n\t\t\t\t\t)\n\t\t\t\t})\n\n\t\t\t\tIt(\"should set cdi_enabled as expected\", func(ctx context.Context) {\n\t\t\t\t\tExpect(mergedConfigPlugins).To(\n\t\t\t\t\t\tWithTransform(\n\t\t\t\t\t\t\tfunc(t *toml.Tree) any {\n\t\t\t\t\t\t\t\treturn t.GetPath([]string{\"enable_cdi\"})\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBeEquivalentTo(tc.cdiEnabledByDefault || tc.cdiEnabled),\n\t\t\t\t\t\t),\n\t\t\t\t\t)\n\t\t\t\t})\n\n\t\t\t\tIt(\"should update the imports as expected\", func(ctx context.Context) {\n\t\t\t\t\tExpect(mergedConfig).To(\n\t\t\t\t\t\tWithTransform(\n\t\t\t\t\t\t\tfunc(t *toml.Tree) any {\n\t\t\t\t\t\t\t\treturn t.Get(\"imports\")\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tContainElement(HavePrefix(\"/etc/containerd/conf.d/\")),\n\t\t\t\t\t\t),\n\t\t\t\t\t)\n\t\t\t\t})\n\n\t\t\t\tIt(\"should preserve the other config options\", func(ctx context.Context) {\n\t\t\t\t\tstrippedMergedConfig, err := toml.TreeFromMap(mergedConfig.ToMap())\n\t\t\t\t\tExpect(err).ToNot(HaveOccurred())\n\n\t\t\t\t\t// We remove the nvidia runtime that was added.\n\t\t\t\t\tstrippedMergedConfig.DeletePath([]string{\"plugins\", tc.pluginName, \"containerd\", \"runtimes\", \"nvidia\"})\n\t\t\t\t\t// We update the settings that we expect to change.\n\t\t\t\t\tfor _, p := range [][]string{\n\t\t\t\t\t\t{\"plugins\", tc.pluginName, \"containerd\", \"default_runtime_name\"},\n\t\t\t\t\t\t{\"plugins\", tc.pluginName, \"enable_cdi\"},\n\t\t\t\t\t\t{\"imports\"},\n\t\t\t\t\t} {\n\t\t\t\t\t\tstrippedMergedConfig.SetPath(p, baselineConfig.GetPath(p))\n\t\t\t\t\t}\n\n\t\t\t\t\tExpect(strippedMergedConfig.ToTomlString()).To(BeEquivalentTo(func() string {\n\t\t\t\t\t\ts, _ := baselineConfig.ToTomlString()\n\t\t\t\t\t\treturn s\n\t\t\t\t\t}()))\n\t\t\t\t})\n\t\t\t})\n\t\t})\n\t}\n})\n\n// getPluginConfig navigates to the appropriate plugin configuration based on\n// containerd version\nfunc getPluginConfig(tree *toml.Tree, pluginName string) (*toml.Tree, error) {\n\tpluginTree := tree.GetPath([]string{\"plugins\", pluginName})\n\tif pluginTree == nil {\n\t\treturn nil, fmt.Errorf(\"plugin %v not found\", pluginName)\n\t}\n\n\tif pt, ok := pluginTree.(*toml.Tree); ok {\n\t\treturn pt, nil\n\t}\n\treturn nil, fmt.Errorf(\"plugin config is not a TOML tree\")\n}\n\n// getRuntimesConfig gets the runtimes configuration from the plugin config\nfunc getRuntimesConfig(pluginConfig *toml.Tree) (map[string]interface{}, error) {\n\truntimes := pluginConfig.GetPath([]string{\"containerd\", \"runtimes\"})\n\tif runtimes == nil {\n\t\treturn nil, fmt.Errorf(\"runtimes section not found\")\n\t}\n\n\t// Handle both map and *toml.Tree types\n\tswitch v := runtimes.(type) {\n\tcase map[string]interface{}:\n\t\treturn v, nil\n\tcase *toml.Tree:\n\t\treturn v.ToMap(), nil\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"runtimes is not a map or toml.Tree, got %T\", runtimes)\n\t}\n}\n"
},
{
"path": "tests/e2e/runner.go",
"content": "/*\n* Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n */\n\npackage e2e\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"os\"\n\t\"os/exec\"\n\t\"strings\"\n\t\"text/template\"\n\t\"time\"\n\n\t\"golang.org/x/crypto/ssh\"\n)\n\nconst (\n\tinstallPrerequisitesScript = `\nset -e\nexport DEBIAN_FRONTEND=noninteractive\n# Install prerequisites\napt-get update\napt-get install -y curl gnupg2\n`\n)\n\ntype localRunner struct{}\ntype remoteRunner struct {\n\tsshKey string\n\tsshUser string\n\thost string\n\tport string\n}\n\ntype nestedContainerRunner struct {\n\trunner Runner\n\tcontainerName string\n}\n\ntype runnerOption func(*remoteRunner)\n\ntype Runner interface {\n\tRun(script string) (string, string, error)\n}\n\nfunc WithSshKey(key string) runnerOption {\n\treturn func(r *remoteRunner) {\n\t\tr.sshKey = key\n\t}\n}\n\nfunc WithSshUser(user string) runnerOption {\n\treturn func(r *remoteRunner) {\n\t\tr.sshUser = user\n\t}\n}\n\nfunc WithHost(host string) runnerOption {\n\treturn func(r *remoteRunner) {\n\t\tr.host = host\n\t}\n}\n\nfunc WithPort(port string) runnerOption {\n\treturn func(r *remoteRunner) {\n\t\tr.port = port\n\t}\n}\n\nfunc NewRunner(opts ...runnerOption) Runner {\n\tr := &remoteRunner{}\n\tfor _, opt := range opts {\n\t\topt(r)\n\t}\n\n\t// If the Host is empty, return a local runner\n\tif r.host == \"\" {\n\t\treturn localRunner{}\n\t}\n\n\t// Otherwise, return a remote runner\n\treturn r\n}\n\n// NewNestedContainerRunner creates a new nested container runner.\n// A nested container runs a container inside another container based on a\n// given runner (remote or local).\nfunc NewNestedContainerRunner(runner Runner, baseImage string, mountToolkitFromHost bool, containerName string, cacheDir string, requiresGPUs bool) (Runner, error) {\n\t// If a container with the same name exists from a previous test run, remove it first.\n\t// Ignore errors as container might not exist\n\t_, _, err := runner.Run(fmt.Sprintf(\"docker rm -f %s 2>/dev/null || true\", containerName))\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to remove container: %w\", err)\n\t}\n\n\tvar additionalContainerArguments []string\n\n\tif requiresGPUs {\n\t\t// If the container requires access to GPUs we explicitly add the nvidia\n\t\t// runtime and set `NVIDIA_VISIBLE_DEVICES` to trigger jit-cdi spec\n\t\t// generation.\n\t\tadditionalContainerArguments = append(additionalContainerArguments,\n\t\t\t\"--runtime=nvidia\",\n\t\t\t\"-e NVIDIA_VISIBLE_DEVICES=runtime.nvidia.com/gpu=all\",\n\t\t)\n\t}\n\n\tif cacheDir != \"\" {\n\t\tadditionalContainerArguments = append(additionalContainerArguments,\n\t\t\t\"-v \"+cacheDir+\":\"+cacheDir+\":ro\",\n\t\t)\n\t}\n\n\tif mountToolkitFromHost {\n\t\t// TODO: This is actually ONLY needed for the CLI tests.\n\t\t// If installCTK is false, we use the preinstalled toolkit.\n\t\t// This means we need to add toolkit libraries and binaries from the \"host\"\n\n\t\t// TODO: This should be updated for other distributions and other components of the toolkit.\n\t\toutput, _, err := runner.Run(\"ls /lib/**/libnvidia-container*.so.*.*\")\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"failed to list toolkit libraries: %w\", err)\n\t\t}\n\n\t\toutput = strings.TrimSpace(output)\n\t\tif output == \"\" {\n\t\t\treturn nil, fmt.Errorf(\"no toolkit libraries found\")\n\t\t}\n\n\t\tfor _, lib := range strings.Split(output, \"\\n\") {\n\t\t\tadditionalContainerArguments = append(additionalContainerArguments, \"-v \"+lib+\":\"+lib)\n\t\t}\n\n\t\t// Look for NVIDIA binaries in standard locations and mount them as volumes\n\t\tnvidiaBinaries := []string{\n\t\t\t\"nvidia-container-cli\",\n\t\t\t\"nvidia-container-runtime\",\n\t\t\t\"nvidia-container-runtime-hook\",\n\t\t\t\"nvidia-ctk\",\n\t\t\t\"nvidia-cdi-hook\",\n\t\t\t\"nvidia-container-runtime.cdi\",\n\t\t\t\"nvidia-container-runtime.legacy\",\n\t\t}\n\n\t\tsearchPaths := []string{\n\t\t\t\"/usr/bin\",\n\t\t\t\"/usr/sbin\",\n\t\t\t\"/usr/local/bin\",\n\t\t\t\"/usr/local/sbin\",\n\t\t}\n\n\t\tfor _, binary := range nvidiaBinaries {\n\t\t\tfor _, searchPath := range searchPaths {\n\t\t\t\tbinaryPath := searchPath + \"/\" + binary\n\t\t\t\t// Check if the binary exists at this path\n\t\t\t\tcheckCmd := fmt.Sprintf(\"test -f %s && echo 'exists'\", binaryPath)\n\t\t\t\toutput, _, err := runner.Run(checkCmd)\n\t\t\t\tif err == nil && strings.TrimSpace(output) == \"exists\" {\n\t\t\t\t\t// Binary found, add it as a volume mount\n\t\t\t\t\tadditionalContainerArguments = append(additionalContainerArguments,\n\t\t\t\t\t\tfmt.Sprintf(\"-v %s:%s\", binaryPath, binaryPath))\n\t\t\t\t\tbreak // Move to the next binary once found\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Mount the /lib/modules directory as a volume to enable the nvidia-cdi-refresh service\n\tadditionalContainerArguments = append(additionalContainerArguments, \"-v /lib/modules:/lib/modules\")\n\n\t// Launch the container in detached mode.\n\tcontainer := outerContainer{\n\t\tName: containerName,\n\t\tBaseImage: baseImage,\n\t\tAdditionalArguments: additionalContainerArguments,\n\t}\n\n\tscript, err := container.Render()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t_, _, err = runner.Run(script)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to run start container script: %w\", err)\n\t}\n\n\tinContainer := &nestedContainerRunner{\n\t\trunner: runner,\n\t\tcontainerName: containerName,\n\t}\n\n\t_, _, err = inContainer.Run(installPrerequisitesScript)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to install prerequisites: %w\", err)\n\t}\n\n\treturn inContainer, nil\n}\n\nfunc (l localRunner) Run(script string) (string, string, error) {\n\t// Create a command to run the script using bash\n\tcmd := exec.Command(\"bash\", \"-c\", script)\n\n\t// Buffer to capture standard output\n\tvar stdout bytes.Buffer\n\tcmd.Stdout = &stdout\n\n\t// Buffer to capture standard error\n\tvar stderr bytes.Buffer\n\tcmd.Stderr = &stderr\n\n\t// Run the command\n\terr := cmd.Run()\n\tif err != nil {\n\t\treturn \"\", \"\", fmt.Errorf(\"script execution failed: %v\\nSTDOUT: %s\\nSTDERR: %s\", err, stdout.String(), stderr.String())\n\t}\n\n\t// Return the captured stdout and nil error\n\treturn stdout.String(), \"\", nil\n}\n\nfunc (r remoteRunner) Run(script string) (string, string, error) {\n\t// Create a new SSH connection\n\tclient, err := connectOrDie(r.sshKey, r.sshUser, r.host, r.port)\n\tif err != nil {\n\t\treturn \"\", \"\", fmt.Errorf(\"failed to connect to %s: %v\", r.host, err)\n\t}\n\tdefer client.Close()\n\n\t// Create a session\n\tsession, err := client.NewSession()\n\tif err != nil {\n\t\treturn \"\", \"\", fmt.Errorf(\"failed to create session: %v\", err)\n\t}\n\tdefer session.Close()\n\n\t// Capture stdout and stderr\n\tvar stdout, stderr bytes.Buffer\n\tsession.Stdout = &stdout\n\tsession.Stderr = &stderr\n\n\t// Run the script\n\terr = session.Run(script)\n\tif err != nil {\n\t\treturn \"\", stderr.String(), fmt.Errorf(\"script execution failed: %v\\nSTDOUT: %s\\nSTDERR: %s\", err, stdout.String(), stderr.String())\n\t}\n\n\t// Return stdout as string if no errors\n\treturn stdout.String(), \"\", nil\n}\n\n// Run runs teh specified script in the container using the docker exec command.\n// The script is is run as the root user.\nfunc (r nestedContainerRunner) Run(script string) (string, string, error) {\n\treturn r.runner.Run(`docker exec -u root \"` + r.containerName + `\" bash -c '` + script + `'`)\n}\n\n// createSshClient creates a ssh client, and retries if it fails to connect\nfunc connectOrDie(sshKey, sshUser, host, port string) (*ssh.Client, error) {\n\tvar client *ssh.Client\n\tvar err error\n\tkey, err := os.ReadFile(sshKey)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to read key file: %v\", err)\n\t}\n\tsigner, err := ssh.ParsePrivateKey(key)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to parse private key: %v\", err)\n\t}\n\tsshConfig := &ssh.ClientConfig{\n\t\tUser: sshUser,\n\t\tAuth: []ssh.AuthMethod{\n\t\t\tssh.PublicKeys(signer),\n\t\t},\n\t\tHostKeyCallback: ssh.InsecureIgnoreHostKey(),\n\t}\n\n\tconnectionFailed := false\n\tfor i := 0; i < 20; i++ {\n\t\tclient, err = ssh.Dial(\"tcp\", host+\":\"+port, sshConfig)\n\t\tif err == nil {\n\t\t\treturn client, nil // Connection succeeded, return the client.\n\t\t}\n\t\tconnectionFailed = true\n\t\t// Sleep for a brief moment before retrying.\n\t\t// You can adjust the duration based on your requirements.\n\t\ttime.Sleep(1 * time.Second)\n\t}\n\n\tif connectionFailed {\n\t\treturn nil, fmt.Errorf(\"failed to connect to %s after 10 retries, giving up\", host)\n\t}\n\n\treturn client, nil\n}\n\n// outerContainerTemplate represents a template to start a container with\n// a name specified.\ntype outerContainer struct {\n\tName string\n\tBaseImage string\n\tAdditionalArguments []string\n}\n\nfunc (o *outerContainer) Render() (string, error) {\n\ttmpl, err := template.New(\"startContainer\").Parse(`docker run -d --name {{.Name}} --privileged \\\n{{ range $i, $a := .AdditionalArguments -}}\n{{ $a }} \\\n{{ end -}}\n{{.BaseImage}} sleep infinity`)\n\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tvar script strings.Builder\n\terr = tmpl.Execute(&script, o)\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"failed to execute template: %w\", err)\n\t}\n\n\treturn script.String(), nil\n}\n"
},
{
"path": "tests/go.mod",
"content": "module github.com/NVIDIA/nvidia-container-toolkit/tests\n\ngo 1.24.0\n\ntoolchain go1.24.1\n\nrequire (\n\tgithub.com/onsi/ginkgo/v2 v2.28.1\n\tgithub.com/onsi/gomega v1.39.1\n\tgithub.com/pelletier/go-toml v1.9.5\n\tgolang.org/x/crypto v0.48.0\n\tgolang.org/x/mod v0.33.0\n)\n\nrequire (\n\tgithub.com/Masterminds/semver/v3 v3.4.0 // indirect\n\tgithub.com/go-logr/logr v1.4.3 // indirect\n\tgithub.com/go-task/slim-sprig/v3 v3.0.0 // indirect\n\tgithub.com/google/go-cmp v0.7.0 // indirect\n\tgithub.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83 // indirect\n\tgo.yaml.in/yaml/v3 v3.0.4 // indirect\n\tgolang.org/x/net v0.49.0 // indirect\n\tgolang.org/x/sync v0.19.0 // indirect\n\tgolang.org/x/sys v0.41.0 // indirect\n\tgolang.org/x/text v0.34.0 // indirect\n\tgolang.org/x/tools v0.41.0 // indirect\n)\n"
},
{
"path": "tests/go.sum",
"content": "github.com/Masterminds/semver/v3 v3.4.0 h1:Zog+i5UMtVoCU8oKka5P7i9q9HgrJeGzI9SA1Xbatp0=\ngithub.com/Masterminds/semver/v3 v3.4.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM=\ngithub.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=\ngithub.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=\ngithub.com/gkampitakis/ciinfo v0.3.2 h1:JcuOPk8ZU7nZQjdUhctuhQofk7BGHuIy0c9Ez8BNhXs=\ngithub.com/gkampitakis/ciinfo v0.3.2/go.mod h1:1NIwaOcFChN4fa/B0hEBdAb6npDlFL8Bwx4dfRLRqAo=\ngithub.com/gkampitakis/go-diff v1.3.2 h1:Qyn0J9XJSDTgnsgHRdz9Zp24RaJeKMUHg2+PDZZdC4M=\ngithub.com/gkampitakis/go-diff v1.3.2/go.mod h1:LLgOrpqleQe26cte8s36HTWcTmMEur6OPYerdAAS9tk=\ngithub.com/gkampitakis/go-snaps v0.5.15 h1:amyJrvM1D33cPHwVrjo9jQxX8g/7E2wYdZ+01KS3zGE=\ngithub.com/gkampitakis/go-snaps v0.5.15/go.mod h1:HNpx/9GoKisdhw9AFOBT1N7DBs9DiHo/hGheFGBZ+mc=\ngithub.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=\ngithub.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=\ngithub.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI=\ngithub.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8=\ngithub.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw=\ngithub.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=\ngithub.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=\ngithub.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=\ngithub.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83 h1:z2ogiKUYzX5Is6zr/vP9vJGqPwcdqsWjOt+V8J7+bTc=\ngithub.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83/go.mod h1:MxpfABSjhmINe3F1It9d+8exIHFvUqtLIRCdOGNXqiI=\ngithub.com/joshdk/go-junit v1.0.0 h1:S86cUKIdwBHWwA6xCmFlf3RTLfVXYQfvanM5Uh+K6GE=\ngithub.com/joshdk/go-junit v1.0.0/go.mod h1:TiiV0PqkaNfFXjEiyjWM3XXrhVyCa1K4Zfga6W52ung=\ngithub.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=\ngithub.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=\ngithub.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=\ngithub.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=\ngithub.com/maruel/natural v1.1.1 h1:Hja7XhhmvEFhcByqDoHz9QZbkWey+COd9xWfCfn1ioo=\ngithub.com/maruel/natural v1.1.1/go.mod h1:v+Rfd79xlw1AgVBjbO0BEQmptqb5HvL/k9GRHB7ZKEg=\ngithub.com/mfridman/tparse v0.18.0 h1:wh6dzOKaIwkUGyKgOntDW4liXSo37qg5AXbIhkMV3vE=\ngithub.com/mfridman/tparse v0.18.0/go.mod h1:gEvqZTuCgEhPbYk/2lS3Kcxg1GmTxxU7kTC8DvP0i/A=\ngithub.com/onsi/ginkgo/v2 v2.28.1 h1:S4hj+HbZp40fNKuLUQOYLDgZLwNUVn19N3Atb98NCyI=\ngithub.com/onsi/ginkgo/v2 v2.28.1/go.mod h1:CLtbVInNckU3/+gC8LzkGUb9oF+e8W8TdUsxPwvdOgE=\ngithub.com/onsi/gomega v1.39.1 h1:1IJLAad4zjPn2PsnhH70V4DKRFlrCzGBNrNaru+Vf28=\ngithub.com/onsi/gomega v1.39.1/go.mod h1:hL6yVALoTOxeWudERyfppUcZXjMwIMLnuSfruD2lcfg=\ngithub.com/pelletier/go-toml v1.9.5 h1:4yBQzkHv+7BHq2PQUZF3Mx0IYxG7LsP222s7Agd3ve8=\ngithub.com/pelletier/go-toml v1.9.5/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=\ngithub.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=\ngithub.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=\ngithub.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII=\ngithub.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o=\ngithub.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=\ngithub.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=\ngithub.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY=\ngithub.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=\ngithub.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=\ngithub.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=\ngithub.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4=\ngithub.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=\ngithub.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY=\ngithub.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28=\ngo.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc=\ngo.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=\ngolang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts=\ngolang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos=\ngolang.org/x/mod v0.33.0 h1:tHFzIWbBifEmbwtGz65eaWyGiGZatSrT9prnU8DbVL8=\ngolang.org/x/mod v0.33.0/go.mod h1:swjeQEj+6r7fODbD2cqrnje9PnziFuw4bmLbBZFrQ5w=\ngolang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o=\ngolang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8=\ngolang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4=\ngolang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=\ngolang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=\ngolang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=\ngolang.org/x/term v0.40.0 h1:36e4zGLqU4yhjlmxEaagx2KuYbJq3EwY8K943ZsHcvg=\ngolang.org/x/term v0.40.0/go.mod h1:w2P8uVp06p2iyKKuvXIm7N/y0UCRt3UfJTfZ7oOpglM=\ngolang.org/x/text v0.34.0 h1:oL/Qq0Kdaqxa1KbNeMKwQq0reLCCaFtqu2eNuSeNHbk=\ngolang.org/x/text v0.34.0/go.mod h1:homfLqTYRFyVYemLBFl5GgL/DWEiH5wcsQ5gSh1yziA=\ngolang.org/x/tools v0.41.0 h1:a9b8iMweWG+S0OBnlU36rzLp20z1Rp10w+IY2czHTQc=\ngolang.org/x/tools v0.41.0/go.mod h1:XSY6eDqxVNiYgezAVqqCeihT4j1U2CCsqvH3WhQpnlg=\ngoogle.golang.org/protobuf v1.36.7 h1:IgrO7UwFQGJdRNXH/sQux4R1Dj1WAKcLElzeeRaXV2A=\ngoogle.golang.org/protobuf v1.36.7/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY=\ngopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=\ngopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=\ngopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=\ngopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=\ngopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=\n"
},
{
"path": "tests/input/config.clone3.json",
"content": "{\n \"ociVersion\": \"1.0.2-dev\",\n \"process\": {\n \"terminal\": true,\n \"user\": {\n \"uid\": 0,\n \"gid\": 0\n },\n \"args\": [\n \"sleep\",\n \"60\"\n ],\n \"env\": [\n \"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\",\n \"HOSTNAME=8de5efc6a95c\",\n \"TERM=xterm\"\n ],\n \"cwd\": \"/\",\n \"capabilities\": {\n \"bounding\": [\n \"CAP_CHOWN\",\n \"CAP_DAC_OVERRIDE\",\n \"CAP_FSETID\",\n \"CAP_FOWNER\",\n \"CAP_MKNOD\",\n \"CAP_NET_RAW\",\n \"CAP_SETGID\",\n \"CAP_SETUID\",\n \"CAP_SETFCAP\",\n \"CAP_SETPCAP\",\n \"CAP_NET_BIND_SERVICE\",\n \"CAP_SYS_CHROOT\",\n \"CAP_KILL\",\n \"CAP_AUDIT_WRITE\"\n ],\n \"effective\": [\n \"CAP_CHOWN\",\n \"CAP_DAC_OVERRIDE\",\n \"CAP_FSETID\",\n \"CAP_FOWNER\",\n \"CAP_MKNOD\",\n \"CAP_NET_RAW\",\n \"CAP_SETGID\",\n \"CAP_SETUID\",\n \"CAP_SETFCAP\",\n \"CAP_SETPCAP\",\n \"CAP_NET_BIND_SERVICE\",\n \"CAP_SYS_CHROOT\",\n \"CAP_KILL\",\n \"CAP_AUDIT_WRITE\"\n ],\n \"inheritable\": [\n \"CAP_CHOWN\",\n \"CAP_DAC_OVERRIDE\",\n \"CAP_FSETID\",\n \"CAP_FOWNER\",\n \"CAP_MKNOD\",\n \"CAP_NET_RAW\",\n \"CAP_SETGID\",\n \"CAP_SETUID\",\n \"CAP_SETFCAP\",\n \"CAP_SETPCAP\",\n \"CAP_NET_BIND_SERVICE\",\n \"CAP_SYS_CHROOT\",\n \"CAP_KILL\",\n \"CAP_AUDIT_WRITE\"\n ],\n \"permitted\": [\n \"CAP_CHOWN\",\n \"CAP_DAC_OVERRIDE\",\n \"CAP_FSETID\",\n \"CAP_FOWNER\",\n \"CAP_MKNOD\",\n \"CAP_NET_RAW\",\n \"CAP_SETGID\",\n \"CAP_SETUID\",\n \"CAP_SETFCAP\",\n \"CAP_SETPCAP\",\n \"CAP_NET_BIND_SERVICE\",\n \"CAP_SYS_CHROOT\",\n \"CAP_KILL\",\n \"CAP_AUDIT_WRITE\"\n ]\n },\n \"apparmorProfile\": \"docker-default\",\n \"oomScoreAdj\": 0\n },\n \"root\": {\n \"path\": \"/var/lib/docker/overlay2/fbf92f54592ddb439159bc7eb25c865b9347a2d71d63b41b7b4e4a471847c84f/merged\"\n },\n \"hostname\": \"8de5efc6a95c\",\n \"mounts\": [\n {\n \"destination\": \"/proc\",\n \"type\": \"proc\",\n \"source\": \"proc\",\n \"options\": [\n \"nosuid\",\n \"noexec\",\n \"nodev\"\n ]\n },\n {\n \"destination\": \"/dev\",\n \"type\": \"tmpfs\",\n \"source\": \"tmpfs\",\n \"options\": [\n \"nosuid\",\n \"strictatime\",\n \"mode=755\",\n \"size=65536k\"\n ]\n },\n {\n \"destination\": \"/dev/pts\",\n \"type\": \"devpts\",\n \"source\": \"devpts\",\n \"options\": [\n \"nosuid\",\n \"noexec\",\n \"newinstance\",\n \"ptmxmode=0666\",\n \"mode=0620\",\n \"gid=5\"\n ]\n },\n {\n \"destination\": \"/sys\",\n \"type\": \"sysfs\",\n \"source\": \"sysfs\",\n \"options\": [\n \"nosuid\",\n \"noexec\",\n \"nodev\",\n \"ro\"\n ]\n },\n {\n \"destination\": \"/sys/fs/cgroup\",\n \"type\": \"cgroup\",\n \"source\": \"cgroup\",\n \"options\": [\n \"ro\",\n \"nosuid\",\n \"noexec\",\n \"nodev\"\n ]\n },\n {\n \"destination\": \"/dev/mqueue\",\n \"type\": \"mqueue\",\n \"source\": \"mqueue\",\n \"options\": [\n \"nosuid\",\n \"noexec\",\n \"nodev\"\n ]\n },\n {\n \"destination\": \"/dev/shm\",\n \"type\": \"tmpfs\",\n \"source\": \"shm\",\n \"options\": [\n \"nosuid\",\n \"noexec\",\n \"nodev\",\n \"mode=1777\",\n \"size=67108864\"\n ]\n },\n {\n \"destination\": \"/etc/resolv.conf\",\n \"type\": \"bind\",\n \"source\": \"/var/lib/docker/containers/8de5efc6a95c4ddae36dde7beb656ed5c7de912ecec2f628c42dbd0ef7bbeec6/resolv.conf\",\n \"options\": [\n \"rbind\",\n \"rprivate\"\n ]\n },\n {\n \"destination\": \"/etc/hostname\",\n \"type\": \"bind\",\n \"source\": \"/var/lib/docker/containers/8de5efc6a95c4ddae36dde7beb656ed5c7de912ecec2f628c42dbd0ef7bbeec6/hostname\",\n \"options\": [\n \"rbind\",\n \"rprivate\"\n ]\n },\n {\n \"destination\": \"/etc/hosts\",\n \"type\": \"bind\",\n \"source\": \"/var/lib/docker/containers/8de5efc6a95c4ddae36dde7beb656ed5c7de912ecec2f628c42dbd0ef7bbeec6/hosts\",\n \"options\": [\n \"rbind\",\n \"rprivate\"\n ]\n }\n ],\n \"hooks\": {\n \"prestart\": [\n {\n \"path\": \"/proc/593/exe\",\n \"args\": [\n \"libnetwork-setkey\",\n \"-exec-root=/var/run/docker\",\n \"8de5efc6a95c4ddae36dde7beb656ed5c7de912ecec2f628c42dbd0ef7bbeec6\",\n \"9967b9f7c4d4\"\n ]\n }\n ]\n },\n \"linux\": {\n \"sysctl\": {\n \"net.ipv4.ip_unprivileged_port_start\": \"0\"\n },\n \"resources\": {\n \"devices\": [\n {\n \"allow\": false,\n \"access\": \"rwm\"\n },\n {\n \"allow\": true,\n \"type\": \"c\",\n \"major\": 1,\n \"minor\": 5,\n \"access\": \"rwm\"\n },\n {\n \"allow\": true,\n \"type\": \"c\",\n \"major\": 1,\n \"minor\": 3,\n \"access\": \"rwm\"\n },\n {\n \"allow\": true,\n \"type\": \"c\",\n \"major\": 1,\n \"minor\": 9,\n \"access\": \"rwm\"\n },\n {\n \"allow\": true,\n \"type\": \"c\",\n \"major\": 1,\n \"minor\": 8,\n \"access\": \"rwm\"\n },\n {\n \"allow\": true,\n \"type\": \"c\",\n \"major\": 5,\n \"minor\": 0,\n \"access\": \"rwm\"\n },\n {\n \"allow\": true,\n \"type\": \"c\",\n \"major\": 5,\n \"minor\": 1,\n \"access\": \"rwm\"\n },\n {\n \"allow\": false,\n \"type\": \"c\",\n \"major\": 10,\n \"minor\": 229,\n \"access\": \"rwm\"\n }\n ],\n \"memory\": {\n \"disableOOMKiller\": false\n },\n \"cpu\": {\n \"shares\": 0\n },\n \"blockIO\": {\n \"weight\": 0\n }\n },\n \"cgroupsPath\": \"/docker/8de5efc6a95c4ddae36dde7beb656ed5c7de912ecec2f628c42dbd0ef7bbeec6\",\n \"namespaces\": [\n {\n \"type\": \"mount\"\n },\n {\n \"type\": \"network\"\n },\n {\n \"type\": \"uts\"\n },\n {\n \"type\": \"pid\"\n },\n {\n \"type\": \"ipc\"\n }\n ],\n \"seccomp\": {\n \"defaultAction\": \"SCMP_ACT_ERRNO\",\n \"architectures\": [\n \"SCMP_ARCH_X86_64\",\n \"SCMP_ARCH_X86\",\n \"SCMP_ARCH_X32\"\n ],\n \"syscalls\": [\n {\n \"names\": [\n \"accept\",\n \"accept4\",\n \"access\",\n \"adjtimex\",\n \"alarm\",\n \"bind\",\n \"brk\",\n \"capget\",\n \"capset\",\n \"chdir\",\n \"chmod\",\n \"chown\",\n \"chown32\",\n \"clock_adjtime\",\n \"clock_adjtime64\",\n \"clock_getres\",\n \"clock_getres_time64\",\n \"clock_gettime\",\n \"clock_gettime64\",\n \"clock_nanosleep\",\n \"clock_nanosleep_time64\",\n \"close\",\n \"close_range\",\n \"connect\",\n \"copy_file_range\",\n \"creat\",\n \"dup\",\n \"dup2\",\n \"dup3\",\n \"epoll_create\",\n \"epoll_create1\",\n \"epoll_ctl\",\n \"epoll_ctl_old\",\n \"epoll_pwait\",\n \"epoll_pwait2\",\n \"epoll_wait\",\n \"epoll_wait_old\",\n \"eventfd\",\n \"eventfd2\",\n \"execve\",\n \"execveat\",\n \"exit\",\n \"exit_group\",\n \"faccessat\",\n \"faccessat2\",\n \"fadvise64\",\n \"fadvise64_64\",\n \"fallocate\",\n \"fanotify_mark\",\n \"fchdir\",\n \"fchmod\",\n \"fchmodat\",\n \"fchown\",\n \"fchown32\",\n \"fchownat\",\n \"fcntl\",\n \"fcntl64\",\n \"fdatasync\",\n \"fgetxattr\",\n \"flistxattr\",\n \"flock\",\n \"fork\",\n \"fremovexattr\",\n \"fsetxattr\",\n \"fstat\",\n \"fstat64\",\n \"fstatat64\",\n \"fstatfs\",\n \"fstatfs64\",\n \"fsync\",\n \"ftruncate\",\n \"ftruncate64\",\n \"futex\",\n \"futex_time64\",\n \"futimesat\",\n \"getcpu\",\n \"getcwd\",\n \"getdents\",\n \"getdents64\",\n \"getegid\",\n \"getegid32\",\n \"geteuid\",\n \"geteuid32\",\n \"getgid\",\n \"getgid32\",\n \"getgroups\",\n \"getgroups32\",\n \"getitimer\",\n \"getpeername\",\n \"getpgid\",\n \"getpgrp\",\n \"getpid\",\n \"getppid\",\n \"getpriority\",\n \"getrandom\",\n \"getresgid\",\n \"getresgid32\",\n \"getresuid\",\n \"getresuid32\",\n \"getrlimit\",\n \"get_robust_list\",\n \"getrusage\",\n \"getsid\",\n \"getsockname\",\n \"getsockopt\",\n \"get_thread_area\",\n \"gettid\",\n \"gettimeofday\",\n \"getuid\",\n \"getuid32\",\n \"getxattr\",\n \"inotify_add_watch\",\n \"inotify_init\",\n \"inotify_init1\",\n \"inotify_rm_watch\",\n \"io_cancel\",\n \"ioctl\",\n \"io_destroy\",\n \"io_getevents\",\n \"io_pgetevents\",\n \"io_pgetevents_time64\",\n \"ioprio_get\",\n \"ioprio_set\",\n \"io_setup\",\n \"io_submit\",\n \"io_uring_enter\",\n \"io_uring_register\",\n \"io_uring_setup\",\n \"ipc\",\n \"kill\",\n \"lchown\",\n \"lchown32\",\n \"lgetxattr\",\n \"link\",\n \"linkat\",\n \"listen\",\n \"listxattr\",\n \"llistxattr\",\n \"_llseek\",\n \"lremovexattr\",\n \"lseek\",\n \"lsetxattr\",\n \"lstat\",\n \"lstat64\",\n \"madvise\",\n \"membarrier\",\n \"memfd_create\",\n \"mincore\",\n \"mkdir\",\n \"mkdirat\",\n \"mknod\",\n \"mknodat\",\n \"mlock\",\n \"mlock2\",\n \"mlockall\",\n \"mmap\",\n \"mmap2\",\n \"mprotect\",\n \"mq_getsetattr\",\n \"mq_notify\",\n \"mq_open\",\n \"mq_timedreceive\",\n \"mq_timedreceive_time64\",\n \"mq_timedsend\",\n \"mq_timedsend_time64\",\n \"mq_unlink\",\n \"mremap\",\n \"msgctl\",\n \"msgget\",\n \"msgrcv\",\n \"msgsnd\",\n \"msync\",\n \"munlock\",\n \"munlockall\",\n \"munmap\",\n \"nanosleep\",\n \"newfstatat\",\n \"_newselect\",\n \"open\",\n \"openat\",\n \"openat2\",\n \"pause\",\n \"pidfd_open\",\n \"pidfd_send_signal\",\n \"pipe\",\n \"pipe2\",\n \"poll\",\n \"ppoll\",\n \"ppoll_time64\",\n \"prctl\",\n \"pread64\",\n \"preadv\",\n \"preadv2\",\n \"prlimit64\",\n \"pselect6\",\n \"pselect6_time64\",\n \"pwrite64\",\n \"pwritev\",\n \"pwritev2\",\n \"read\",\n \"readahead\",\n \"readlink\",\n \"readlinkat\",\n \"readv\",\n \"recv\",\n \"recvfrom\",\n \"recvmmsg\",\n \"recvmmsg_time64\",\n \"recvmsg\",\n \"remap_file_pages\",\n \"removexattr\",\n \"rename\",\n \"renameat\",\n \"renameat2\",\n \"restart_syscall\",\n \"rmdir\",\n \"rseq\",\n \"rt_sigaction\",\n \"rt_sigpending\",\n \"rt_sigprocmask\",\n \"rt_sigqueueinfo\",\n \"rt_sigreturn\",\n \"rt_sigsuspend\",\n \"rt_sigtimedwait\",\n \"rt_sigtimedwait_time64\",\n \"rt_tgsigqueueinfo\",\n \"sched_getaffinity\",\n \"sched_getattr\",\n \"sched_getparam\",\n \"sched_get_priority_max\",\n \"sched_get_priority_min\",\n \"sched_getscheduler\",\n \"sched_rr_get_interval\",\n \"sched_rr_get_interval_time64\",\n \"sched_setaffinity\",\n \"sched_setattr\",\n \"sched_setparam\",\n \"sched_setscheduler\",\n \"sched_yield\",\n \"seccomp\",\n \"select\",\n \"semctl\",\n \"semget\",\n \"semop\",\n \"semtimedop\",\n \"semtimedop_time64\",\n \"send\",\n \"sendfile\",\n \"sendfile64\",\n \"sendmmsg\",\n \"sendmsg\",\n \"sendto\",\n \"setfsgid\",\n \"setfsgid32\",\n \"setfsuid\",\n \"setfsuid32\",\n \"setgid\",\n \"setgid32\",\n \"setgroups\",\n \"setgroups32\",\n \"setitimer\",\n \"setpgid\",\n \"setpriority\",\n \"setregid\",\n \"setregid32\",\n \"setresgid\",\n \"setresgid32\",\n \"setresuid\",\n \"setresuid32\",\n \"setreuid\",\n \"setreuid32\",\n \"setrlimit\",\n \"set_robust_list\",\n \"setsid\",\n \"setsockopt\",\n \"set_thread_area\",\n \"set_tid_address\",\n \"setuid\",\n \"setuid32\",\n \"setxattr\",\n \"shmat\",\n \"shmctl\",\n \"shmdt\",\n \"shmget\",\n \"shutdown\",\n \"sigaltstack\",\n \"signalfd\",\n \"signalfd4\",\n \"sigprocmask\",\n \"sigreturn\",\n \"socket\",\n \"socketcall\",\n \"socketpair\",\n \"splice\",\n \"stat\",\n \"stat64\",\n \"statfs\",\n \"statfs64\",\n \"statx\",\n \"symlink\",\n \"symlinkat\",\n \"sync\",\n \"sync_file_range\",\n \"syncfs\",\n \"sysinfo\",\n \"tee\",\n \"tgkill\",\n \"time\",\n \"timer_create\",\n \"timer_delete\",\n \"timer_getoverrun\",\n \"timer_gettime\",\n \"timer_gettime64\",\n \"timer_settime\",\n \"timer_settime64\",\n \"timerfd_create\",\n \"timerfd_gettime\",\n \"timerfd_gettime64\",\n \"timerfd_settime\",\n \"timerfd_settime64\",\n \"times\",\n \"tkill\",\n \"truncate\",\n \"truncate64\",\n \"ugetrlimit\",\n \"umask\",\n \"uname\",\n \"unlink\",\n \"unlinkat\",\n \"utime\",\n \"utimensat\",\n \"utimensat_time64\",\n \"utimes\",\n \"vfork\",\n \"vmsplice\",\n \"wait4\",\n \"waitid\",\n \"waitpid\",\n \"write\",\n \"writev\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\"\n },\n {\n \"names\": [\n \"ptrace\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\"\n },\n {\n \"names\": [\n \"personality\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\",\n \"args\": [\n {\n \"index\": 0,\n \"value\": 0,\n \"op\": \"SCMP_CMP_EQ\"\n }\n ]\n },\n {\n \"names\": [\n \"personality\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\",\n \"args\": [\n {\n \"index\": 0,\n \"value\": 8,\n \"op\": \"SCMP_CMP_EQ\"\n }\n ]\n },\n {\n \"names\": [\n \"personality\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\",\n \"args\": [\n {\n \"index\": 0,\n \"value\": 131072,\n \"op\": \"SCMP_CMP_EQ\"\n }\n ]\n },\n {\n \"names\": [\n \"personality\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\",\n \"args\": [\n {\n \"index\": 0,\n \"value\": 131080,\n \"op\": \"SCMP_CMP_EQ\"\n }\n ]\n },\n {\n \"names\": [\n \"personality\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\",\n \"args\": [\n {\n \"index\": 0,\n \"value\": 4294967295,\n \"op\": \"SCMP_CMP_EQ\"\n }\n ]\n },\n {\n \"names\": [\n \"arch_prctl\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\"\n },\n {\n \"names\": [\n \"modify_ldt\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\"\n },\n {\n \"names\": [\n \"clone\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\",\n \"args\": [\n {\n \"index\": 0,\n \"value\": 2114060288,\n \"op\": \"SCMP_CMP_MASKED_EQ\"\n }\n ]\n },\n {\n \"names\": [\n \"clone3\"\n ],\n \"action\": \"SCMP_ACT_ERRNO\",\n \"errnoRet\": 38\n },\n {\n \"names\": [\n \"chroot\"\n ],\n \"action\": \"SCMP_ACT_ALLOW\"\n }\n ]\n },\n \"maskedPaths\": [\n \"/proc/asound\",\n \"/proc/acpi\",\n \"/proc/kcore\",\n \"/proc/keys\",\n \"/proc/latency_stats\",\n \"/proc/timer_list\",\n \"/proc/timer_stats\",\n \"/proc/sched_debug\",\n \"/proc/scsi\",\n \"/sys/firmware\"\n ],\n \"readonlyPaths\": [\n \"/proc/bus\",\n \"/proc/fs\",\n \"/proc/irq\",\n \"/proc/sys\",\n \"/proc/sysrq-trigger\"\n ]\n }\n}"
},
{
"path": "tests/input/csv_samples/.csv",
"content": ""
},
{
"path": "tests/input/csv_samples/empty/.gitignore",
"content": ""
},
{
"path": "tests/input/csv_samples/jetson.csv",
"content": "dev, nvidiactl\ndev, nvhost-gpu\ndev, nvhost-ctrl\ndev, nvhost-nvdec\ndev, nvhost-ctrl-gpu\ndev, nvhost-prof-gpu\ndev, nvhost-dbg-gpu\ndev, nvmap\ndev, tegra_dc_ctrl\ndev, tegra_dc_0\ndev, tegra_dc_1\ndev, nvhost-vic\ndev, nvhost-as-gpu\ndir, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/include\ndir, /usr/lib/aarch64-linux-gnu/tegra-egl\ndir, /usr/src/tensorrt\ndir, /usr/local/cuda\nlib, /usr/lib/aarch64-linux-gnu/libv4l/plugins/libv4l2_nvvidconv.so\nlib, /usr/lib/aarch64-linux-gnu/libv4l/plugins/libv4l2_nvvideocodec.so\nlib, /usr/lib/aarch64-linux-gnu/libv4l1.so.0\nlib, /usr/lib/aarch64-linux-gnu/libv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/libv4lconvert.so.0\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvarguscamerasrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvcompositor.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvdrmvideosink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnveglglessink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnveglstreamsrc.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvegltransform.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvivafilter.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvjpeg.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvtee.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvidconv.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideo4linux2.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideocuda.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideosink.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstnvvideosinks.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstomx.so\nlib, /usr/lib/aarch64-linux-gnu/gstreamer-1.0/libgstpulseaudio.so\nlib, /usr/lib/aarch64-linux-gnu/libgstnvivameta.so\nlib, /usr/lib/aarch64-linux-gnu/libgstnvexifmeta.so\nlib, /usr/lib/aarch64-linux-gnu/libgstnvegl-1.0.so.0\nlib, /usr/lib/aarch64-linux-gnu/libnvonnxparser.so\nlib, /usr/lib/aarch64-linux-gnu/libnvinfer.so\nlib, /usr/lib/aarch64-linux-gnu/libnvinfer_plugin.so\nlib, /usr/lib/aarch64-linux-gnu/libnvparsers.so\nlib, /usr/lib/aarch64-linux-gnu/libcudnn.so\nlib, /usr/lib/aarch64-linux-gnu/libnvsample_cudaprocess.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libdrm.so.2\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvapputil.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvargus.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvargus_socketclient.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvargus_socketserver.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvavp.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvbuf_utils.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvcam_imageencoder.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvcameratools.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvcamerautils.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvcamlog.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvcamv4l2.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvcolorutil.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvdc.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvddk_2d_v2.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvddk_vic.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnveglstream_camconsumer.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnveglstreamproducer.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnveventlib.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvexif.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvfnet.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvfnetstoredefog.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvfnetstorehdfx.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_boot.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_camera.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_force.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_generic.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_gpucompute.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_graphics.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_il.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_spincircle.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_tbc.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvgov_ui.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvid_mapper.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-egl-wayland.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-eglcore.so.32.1.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-fatbinaryloader.so.32.1.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-glcore.so.32.1.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-glsi.so.32.1.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-glvkspirv.so.32.1.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-ptxjitcompiler.so.1\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-rmapi-tegra.so.32.1.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvidia-tls.so.32.1.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvimp.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvjpeg.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvll.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmedia.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmm.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmm_contentpipe.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmm_parser.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmm_utils.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmmlite.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmmlite_image.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmmlite_utils.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvmmlite_video.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvodm_imager.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvomx.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvomxilclient.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvos.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvosd.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvparser.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvphs.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvphsd.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvrm.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvrm_gpu.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvrm_graphics.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvscf.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvtestresults.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvtnr.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvtracebuf.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvtvmr.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvtx_helper.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libnvwinsys.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libsensors.hal-client.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libsensors.l4t.no_fusion.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libsensors_hal.nvs.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/libtegrav4l2.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/nvidia_icd.json\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/EGLWLInputEventExample\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/EGLWLMockNavigation\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/LayerManagerControl\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/desktop-shell.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/drm-backend.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/eglstream-backend.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/gl-renderer.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/hmi-controller.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/ivi-controller.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/ivi-shell.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/libilmClient.so.2.0.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/libilmCommon.so.2.0.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/libilmControl.so.2.0.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/libilmInput.so.2.0.0\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/libinput.so.10.10.1\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/spring-tool\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/wayland-backend.so\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-calibrator\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-clickdot\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-cliptest\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-desktop-shell\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-dnd\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-eventdemo\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-flower\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-fullscreen\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-image\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-info\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-ivi-shell-user-interface\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-keyboard\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-launch\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-multi-resource\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-resizor\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-scaler\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-screenshooter\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-simple-egl\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-simple-shm\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-simple-touch\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-smoke\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-stacking\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-subsurfaces\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-terminal\nlib, /usr/lib/aarch64-linux-gnu/tegra/weston/weston-transformed\nlib, /usr/lib/libvisionworks_tracking.so.0.88\nlib, /usr/lib/libvisionworks_sfm.so.0.90\nlib, /usr/lib/libvisionworks.so\n"
},
{
"path": "tests/input/csv_samples/other.not_csv",
"content": ""
},
{
"path": "tests/input/csv_samples/simple.csv",
"content": "lib,/lib/target\ndir,/lib/target\ndev,/dev/null\ndev,full\ndev,/dev/target\nsym,/source\n"
},
{
"path": "tests/input/csv_samples/simple_wrong.csv",
"content": "dir\n"
},
{
"path": "tests/input/csv_samples/spaced.csv",
"content": " dev , /dev/target \nlib, /lib/target\n\ndir,/lib/target \n\nsym, /source\n\n \n\n"
},
{
"path": "tests/input/nvidia-container-runtime/config.toml",
"content": ""
},
{
"path": "tests/input/test_spec.json",
"content": "{\n\t\"ociVersion\": \"1.0.1-dev\",\n\t\"process\": {\n\t\t\"terminal\": true,\n\t\t\"user\": {\n\t\t\t\"uid\": 0,\n\t\t\t\"gid\": 0\n\t\t},\n\t\t\"args\": [\n\t\t\t\"sh\"\n\t\t],\n\t\t\"env\": [\n\t\t\t\"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin\",\n\t\t\t\"TERM=xterm\"\n\t\t],\n\t\t\"cwd\": \"/\",\n\t\t\"capabilities\": {\n\t\t\t\"bounding\": [\n\t\t\t\t\"CAP_AUDIT_WRITE\",\n\t\t\t\t\"CAP_KILL\",\n\t\t\t\t\"CAP_NET_BIND_SERVICE\"\n\t\t\t],\n\t\t\t\"effective\": [\n\t\t\t\t\"CAP_AUDIT_WRITE\",\n\t\t\t\t\"CAP_KILL\",\n\t\t\t\t\"CAP_NET_BIND_SERVICE\"\n\t\t\t],\n\t\t\t\"inheritable\": [\n\t\t\t\t\"CAP_AUDIT_WRITE\",\n\t\t\t\t\"CAP_KILL\",\n\t\t\t\t\"CAP_NET_BIND_SERVICE\"\n\t\t\t],\n\t\t\t\"permitted\": [\n\t\t\t\t\"CAP_AUDIT_WRITE\",\n\t\t\t\t\"CAP_KILL\",\n\t\t\t\t\"CAP_NET_BIND_SERVICE\"\n\t\t\t],\n\t\t\t\"ambient\": [\n\t\t\t\t\"CAP_AUDIT_WRITE\",\n\t\t\t\t\"CAP_KILL\",\n\t\t\t\t\"CAP_NET_BIND_SERVICE\"\n\t\t\t]\n\t\t},\n\t\t\"rlimits\": [\n\t\t\t{\n\t\t\t\t\"type\": \"RLIMIT_NOFILE\",\n\t\t\t\t\"hard\": 1024,\n\t\t\t\t\"soft\": 1024\n\t\t\t}\n\t\t],\n\t\t\"noNewPrivileges\": true\n\t},\n\t\"root\": {\n\t\t\"path\": \"rootfs\",\n\t\t\"readonly\": true\n\t},\n\t\"hostname\": \"runc\",\n\t\"mounts\": [\n\t\t{\n\t\t\t\"destination\": \"/proc\",\n\t\t\t\"type\": \"proc\",\n\t\t\t\"source\": \"proc\"\n\t\t},\n\t\t{\n\t\t\t\"destination\": \"/dev\",\n\t\t\t\"type\": \"tmpfs\",\n\t\t\t\"source\": \"tmpfs\",\n\t\t\t\"options\": [\n\t\t\t\t\"nosuid\",\n\t\t\t\t\"strictatime\",\n\t\t\t\t\"mode=755\",\n\t\t\t\t\"size=65536k\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"destination\": \"/dev/pts\",\n\t\t\t\"type\": \"devpts\",\n\t\t\t\"source\": \"devpts\",\n\t\t\t\"options\": [\n\t\t\t\t\"nosuid\",\n\t\t\t\t\"noexec\",\n\t\t\t\t\"newinstance\",\n\t\t\t\t\"ptmxmode=0666\",\n\t\t\t\t\"mode=0620\",\n\t\t\t\t\"gid=5\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"destination\": \"/dev/shm\",\n\t\t\t\"type\": \"tmpfs\",\n\t\t\t\"source\": \"shm\",\n\t\t\t\"options\": [\n\t\t\t\t\"nosuid\",\n\t\t\t\t\"noexec\",\n\t\t\t\t\"nodev\",\n\t\t\t\t\"mode=1777\",\n\t\t\t\t\"size=65536k\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"destination\": \"/dev/mqueue\",\n\t\t\t\"type\": \"mqueue\",\n\t\t\t\"source\": \"mqueue\",\n\t\t\t\"options\": [\n\t\t\t\t\"nosuid\",\n\t\t\t\t\"noexec\",\n\t\t\t\t\"nodev\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"destination\": \"/sys\",\n\t\t\t\"type\": \"sysfs\",\n\t\t\t\"source\": \"sysfs\",\n\t\t\t\"options\": [\n\t\t\t\t\"nosuid\",\n\t\t\t\t\"noexec\",\n\t\t\t\t\"nodev\",\n\t\t\t\t\"ro\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"destination\": \"/sys/fs/cgroup\",\n\t\t\t\"type\": \"cgroup\",\n\t\t\t\"source\": \"cgroup\",\n\t\t\t\"options\": [\n\t\t\t\t\"nosuid\",\n\t\t\t\t\"noexec\",\n\t\t\t\t\"nodev\",\n\t\t\t\t\"relatime\",\n\t\t\t\t\"ro\"\n\t\t\t]\n\t\t}\n\t],\n\t\"linux\": {\n\t\t\"resources\": {\n\t\t\t\"devices\": [\n\t\t\t\t{\n\t\t\t\t\t\"allow\": false,\n\t\t\t\t\t\"access\": \"rwm\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"namespaces\": [\n\t\t\t{\n\t\t\t\t\"type\": \"pid\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"type\": \"network\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"type\": \"ipc\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"type\": \"uts\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"type\": \"mount\"\n\t\t\t}\n\t\t],\n\t\t\"maskedPaths\": [\n\t\t\t\"/proc/kcore\",\n\t\t\t\"/proc/latency_stats\",\n\t\t\t\"/proc/timer_list\",\n\t\t\t\"/proc/timer_stats\",\n\t\t\t\"/proc/sched_debug\",\n\t\t\t\"/sys/firmware\",\n\t\t\t\"/proc/scsi\"\n\t\t],\n\t\t\"readonlyPaths\": [\n\t\t\t\"/proc/asound\",\n\t\t\t\"/proc/bus\",\n\t\t\t\"/proc/fs\",\n\t\t\t\"/proc/irq\",\n\t\t\t\"/proc/sys\",\n\t\t\t\"/proc/sysrq-trigger\"\n\t\t]\n\t}\n}"
},
{
"path": "tests/release/Makefile",
"content": "# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nWORKFLOW ?= nvidia-docker\n\nDISTRIBUTIONS := ubuntu20.04 ubuntu18.04 centos8 fedora35\n\nIMAGE_TARGETS := $(patsubst %,image-%, $(DISTRIBUTIONS))\nRUN_TARGETS := $(patsubst %,run-%, $(DISTRIBUTIONS))\nRELEASE_TARGETS := $(patsubst %,release-%, $(DISTRIBUTIONS))\nLOCAL_TARGETS := $(patsubst %,local-%, $(DISTRIBUTIONS))\n\n.PHONY: $(IMAGE_TARGETS) $(RUN_TARGETS)\n\nimage-%: DOCKERFILE = docker/$(*)/Dockerfile\n\nimages: $(IMAGE_TARGETS)\n$(IMAGE_TARGETS): image-%: $(DOCKERFILE)\n\tdocker build ${PLATFORM_ARGS} \\\n -t nvidia-container-toolkit-repo-test:$(*) \\\n -f $(DOCKERFILE) \\\n $(shell dirname $(DOCKERFILE))\n\n\n%-ubuntu20.04: ARCH ?= amd64\n%-ubuntu18.04: ARCH ?= amd64\n%-centos8: ARCH ?= x86_64\n%-fedora35: ARCH ?= x86_64\n\nPLATFORM_ARGS = --platform=linux/${ARCH}\n\nRELEASE_TEST_DIR := $(patsubst %/,%,$(dir $(abspath $(lastword $(MAKEFILE_LIST)))))\nPROJECT_ROOT := $(RELEASE_TEST_DIR)/../..\n\nLOCAL_PACKAGE_ROOT := $(PROJECT_ROOT)/dist\n\nlocal-%: DIST = $(*)\nlocal-%: LOCAL_REPO_ARGS = -v $(LOCAL_PACKAGE_ROOT)/$(DIST)/$(ARCH):/local-repository\n$(LOCAL_TARGETS): local-%: run-%\n\nrun-%: DIST = $(*)\n$(RUN_TARGETS): run-%: image-%\n\tdocker run ${PLATFORM_ARGS} --rm -ti \\\n $(LOCAL_REPO_ARGS) \\\n nvidia-container-toolkit-repo-test:$(*)\n\n# Ensure that the local package root exists\n$(RELEASE_TARGETS): release-%: $(LOCAL_PACKAGE_ROOT)/$(*)/$(ARCH)\n\t$(PROJECT_ROOT)/scripts/build-packages.sh $(*)-$(ARCH)\n"
},
{
"path": "tests/release/README.md",
"content": "# Testing Packaging Workflows\n\n## Building the Docker images:\n\n```bash\nmake images\n```\n\nThis assumes that the `nvidia-docker` workflow is being tested and that the test packages have been published to the `elezar.github.io` GitHub pages page. These can be overridden\nusing make variables.\n\nValid values for `workflow` are:\n* `nvidia-docker`\n* `nvidia-container-runtime`\n\nThis follows the instructions for setting up the [`nvidia-docker` repostitory](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#setting-up-nvidia-container-toolkit).\n\n\n## Testing local package changes\n\nRunning:\n```bash\nmake local-ubuntu18.04\n```\nwill build the `ubuntu18.04-amd64` packages for release and launch a docker container with these packages added to a local APT repository.\n\nThe various `apt` workflows can then be tested as if the packages were released to the `libnvidia-container` experimental repository.\n\nThe `local-centos8` make target is available for testing the `centos8-x86_64` workflows as representative of `yum`-based installation workflows.\n\n\n### Example\n\nIn the `centos8`-based container above we see the following `nvidia-docker2` packages available with the `local-repository` disabled:\n\n```bash\n$ yum list --showduplicates nvidia-docker2 | tail -2\nnvidia-docker2.noarch 2.5.0-1 nvidia-docker\nnvidia-docker2.noarch 2.6.0-1 nvidia-docker\n```\n\nInstalling `nvidia-docker2` shows:\n```bash\n$ yum install -y nvidia-docker2\n```\n\ninstalls the following packages:\n```bash\n$ yum list installed | grep nvidia\nlibnvidia-container-tools.x86_64 1.5.1-1 @libnvidia-container\nlibnvidia-container1.x86_64 1.5.1-1 @libnvidia-container\nnvidia-container-runtime.x86_64 3.5.0-1 @nvidia-container-runtime\nnvidia-container-toolkit.x86_64 1.5.1-2 @nvidia-container-runtime\nnvidia-docker2.noarch 2.6.0-1 @nvidia-docker\n```\nNote the repositories where these packages were installed from.\n\nWe now enable the `local-repository` to simulate the new packages being published to the `libnvidia-container` experimental repository and check the available `nvidia-docker2` versions:\n```bash\n$ yum-config-manager --enable local-repository\n$ yum list --showduplicates nvidia-docker2 | tail -2\nnvidia-docker2.noarch 2.6.0-1 nvidia-docker\nnvidia-docker2.noarch 2.6.1-0.1.rc.1 local-repository\n```\nShowing the new version available in the local repository.\n\nRunning:\n```\n$ yum install nvidia-docker2\nLast metadata expiration check: 0:01:15 ago on Fri Sep 24 12:49:20 2021.\nPackage nvidia-docker2-2.6.0-1.noarch is already installed.\nDependencies resolved.\n===============================================================================================================================\n Package Architecture Version Repository Size\n===============================================================================================================================\nUpgrading:\n libnvidia-container-tools x86_64 1.6.0-0.1.rc.1 local-repository 48 k\n libnvidia-container1 x86_64 1.6.0-0.1.rc.1 local-repository 95 k\n nvidia-container-toolkit x86_64 1.6.0-0.1.rc.1 local-repository 1.5 M\n replacing nvidia-container-runtime.x86_64 3.5.0-1\n nvidia-docker2 noarch 2.6.1-0.1.rc.1 local-repository 13 k\n\nTransaction Summary\n===============================================================================================================================\nUpgrade 4 Packages\n\nTotal size: 1.7 M\n```\nShowing that all the components of the stack will be updated with versions from the `local-repository`.\n\nAfter installation the installed packages are shown as:\n```bash\n$ yum list installed | grep nvidia\nlibnvidia-container-tools.x86_64 1.6.0-0.1.rc.1 @local-repository\nlibnvidia-container1.x86_64 1.6.0-0.1.rc.1 @local-repository\nnvidia-container-toolkit.x86_64 1.6.0-0.1.rc.1 @local-repository\nnvidia-docker2.noarch 2.6.1-0.1.rc.1 @local-repository\n```\nShowing that:\n1. All versions have been installed from the same repository\n2. The `nvidia-container-runtime` package was removed as it is no longer required.\n\nThe `nvidia-container-runtime` executable is, however, still present on the system:\n```bash\n# ls -l /usr/bin/nvidia-container-runtime\n-rwxr-xr-x 1 root root 2256280 Sep 24 12:42 /usr/bin/nvidia-container-runtime\n```\n"
},
{
"path": "tests/release/docker/centos8/Dockerfile",
"content": "ARG BASEIMAGE=quay.io/centos/centos:stream8\nFROM ${BASEIMAGE}\n\nRUN yum install -y \\\n yum-utils \\\n ruby-devel \\\n gcc \\\n make \\\n rpm-build \\\n rubygems \\\n createrepo\n\nRUN gem install --no-document fpm\n\n# We create and install a dummy docker package since these dependencies are out of\n# scope for the tests performed here.\nRUN fpm -s empty \\\n -t rpm \\\n --description \"A dummy package for docker-ce_18.06.3.ce-3.el7\" \\\n -n docker-ce --version 18.06.3.ce-3.el7 \\\n -p /tmp/docker.rpm \\\n && \\\n yum localinstall -y /tmp/docker.rpm \\\n && \\\n rm -f /tmp/docker.rpm\n\n\nRUN curl -s -L https://nvidia.github.io/libnvidia-container/stable/rpm/libnvidia-container.repo \\\n | tee /etc/yum.repos.d/nvidia-container-toolkit.repo\n\nCOPY entrypoint.sh /\nCOPY install_repo.sh /\n\nENTRYPOINT [ \"/entrypoint.sh\" ]"
},
{
"path": "tests/release/docker/centos8/entrypoint.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This script is used to build the packages for the components of the NVIDIA\n# Container Stack. These include the nvidia-container-toolkit in this repository\n# as well as the components included in the third_party folder.\n# All required packages are generated in the specified dist folder.\n\n: ${LOCAL_REPO_DIRECTORY:=/local-repository}\nif [[ -d ${LOCAL_REPO_DIRECTORY} ]]; then\n echo \"Setting up local-repository\"\n createrepo \"${LOCAL_REPO_DIRECTORY}\"\n\n cat >/etc/yum.repos.d/local.repo </etc/yum.repos.d/local.repo < /etc/apt/sources.list.d/local.list\n $(cd /local-repository && apt-ftparchive packages . > Packages)\nelif [[ -n ${TEST_REPO} ]]; then\n ./install_repo.sh ${TEST_REPO}\nelse\n echo \"Skipping repo setup\"\nfi\napt-get update\n\nexec bash $@\n"
},
{
"path": "tests/release/docker/ubuntu18.04/install_repo.sh",
"content": "#!/usr/bin/env bash\n\n# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\n# This script is used to build the packages for the components of the NVIDIA\n# Container Stack. These include the nvidia-container-toolkit in this repository\n# as well as the components included in the third_party folder.\n# All required packages are generated in the specified dist folder.\n\ntest_repo=$1\necho \"Setting up TEST repo: ${test_repo}\"\nsed -i -e \"s#nvidia\\.github\\.io/libnvidia-container#${test_repo}/libnvidia-container#g\" /etc/apt/sources.list.d/nvidia-container-toolkit.list\nsed -i -e '/experimental/ s/^#//g' /etc/apt/sources.list.d/nvidia-container-toolkit.list\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/.gitignore",
"content": "_fuzz/"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/.golangci.yml",
"content": "run:\n deadline: 2m\n\nlinters:\n disable-all: true\n enable:\n - misspell\n - govet\n - staticcheck\n - errcheck\n - unparam\n - ineffassign\n - nakedret\n - gocyclo\n - dupl\n - goimports\n - revive\n - gosec\n - gosimple\n - typecheck\n - unused\n\nlinters-settings:\n gofmt:\n simplify: true\n dupl:\n threshold: 600\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/CHANGELOG.md",
"content": "# Changelog\n\n## 3.4.0 (2025-06-27)\n\n### Added\n\n- #268: Added property to Constraints to include prereleases for Check and Validate\n\n### Changed\n\n- #263: Updated Go testing for 1.24, 1.23, and 1.22\n- #269: Updated the error message handling for message case and wrapping errors\n- #266: Restore the ability to have leading 0's when parsing with NewVersion.\n Opt-out of this by setting CoerceNewVersion to false.\n\n### Fixed\n\n- #257: Fixed the CodeQL link (thanks @dmitris)\n- #262: Restored detailed errors when failed to parse with NewVersion. Opt-out\n of this by setting DetailedNewVersionErrors to false for faster performance.\n- #267: Handle pre-releases for an \"and\" group if one constraint includes them\n\n## 3.3.1 (2024-11-19)\n\n### Fixed\n\n- #253: Fix for allowing some version that were invalid\n\n## 3.3.0 (2024-08-27)\n\n### Added\n\n- #238: Add LessThanEqual and GreaterThanEqual functions (thanks @grosser)\n- #213: nil version equality checking (thanks @KnutZuidema)\n\n### Changed\n\n- #241: Simplify StrictNewVersion parsing (thanks @grosser)\n- Testing support up through Go 1.23\n- Minimum version set to 1.21 as this is what's tested now\n- Fuzz testing now supports caching\n\n## 3.2.1 (2023-04-10)\n\n### Changed\n\n- #198: Improved testing around pre-release names\n- #200: Improved code scanning with addition of CodeQL\n- #201: Testing now includes Go 1.20. Go 1.17 has been dropped\n- #202: Migrated Fuzz testing to Go built-in Fuzzing. CI runs daily\n- #203: Docs updated for security details\n\n### Fixed\n\n- #199: Fixed issue with range transformations\n\n## 3.2.0 (2022-11-28)\n\n### Added\n\n- #190: Added text marshaling and unmarshaling\n- #167: Added JSON marshalling for constraints (thanks @SimonTheLeg)\n- #173: Implement encoding.TextMarshaler and encoding.TextUnmarshaler on Version (thanks @MarkRosemaker)\n- #179: Added New() version constructor (thanks @kazhuravlev)\n\n### Changed\n\n- #182/#183: Updated CI testing setup\n\n### Fixed\n\n- #186: Fixing issue where validation of constraint section gave false positives\n- #176: Fix constraints check with *-0 (thanks @mtt0)\n- #181: Fixed Caret operator (^) gives unexpected results when the minor version in constraint is 0 (thanks @arshchimni)\n- #161: Fixed godoc (thanks @afirth)\n\n## 3.1.1 (2020-11-23)\n\n### Fixed\n\n- #158: Fixed issue with generated regex operation order that could cause problem\n\n## 3.1.0 (2020-04-15)\n\n### Added\n\n- #131: Add support for serializing/deserializing SQL (thanks @ryancurrah)\n\n### Changed\n\n- #148: More accurate validation messages on constraints\n\n## 3.0.3 (2019-12-13)\n\n### Fixed\n\n- #141: Fixed issue with <= comparison\n\n## 3.0.2 (2019-11-14)\n\n### Fixed\n\n- #134: Fixed broken constraint checking with ^0.0 (thanks @krmichelos)\n\n## 3.0.1 (2019-09-13)\n\n### Fixed\n\n- #125: Fixes issue with module path for v3\n\n## 3.0.0 (2019-09-12)\n\nThis is a major release of the semver package which includes API changes. The Go\nAPI is compatible with ^1. The Go API was not changed because many people are using\n`go get` without Go modules for their applications and API breaking changes cause\nerrors which we have or would need to support.\n\nThe changes in this release are the handling based on the data passed into the\nfunctions. These are described in the added and changed sections below.\n\n### Added\n\n- StrictNewVersion function. This is similar to NewVersion but will return an\n error if the version passed in is not a strict semantic version. For example,\n 1.2.3 would pass but v1.2.3 or 1.2 would fail because they are not strictly\n speaking semantic versions. This function is faster, performs fewer operations,\n and uses fewer allocations than NewVersion.\n- Fuzzing has been performed on NewVersion, StrictNewVersion, and NewConstraint.\n The Makefile contains the operations used. For more information on you can start\n on Wikipedia at https://en.wikipedia.org/wiki/Fuzzing\n- Now using Go modules\n\n### Changed\n\n- NewVersion has proper prerelease and metadata validation with error messages\n to signal an issue with either of them\n- ^ now operates using a similar set of rules to npm/js and Rust/Cargo. If the\n version is >=1 the ^ ranges works the same as v1. For major versions of 0 the\n rules have changed. The minor version is treated as the stable version unless\n a patch is specified and then it is equivalent to =. One difference from npm/js\n is that prereleases there are only to a specific version (e.g. 1.2.3).\n Prereleases here look over multiple versions and follow semantic version\n ordering rules. This pattern now follows along with the expected and requested\n handling of this packaged by numerous users.\n\n## 1.5.0 (2019-09-11)\n\n### Added\n\n- #103: Add basic fuzzing for `NewVersion()` (thanks @jesse-c)\n\n### Changed\n\n- #82: Clarify wildcard meaning in range constraints and update tests for it (thanks @greysteil)\n- #83: Clarify caret operator range for pre-1.0.0 dependencies (thanks @greysteil)\n- #72: Adding docs comment pointing to vert for a cli\n- #71: Update the docs on pre-release comparator handling\n- #89: Test with new go versions (thanks @thedevsaddam)\n- #87: Added $ to ValidPrerelease for better validation (thanks @jeremycarroll)\n\n### Fixed\n\n- #78: Fix unchecked error in example code (thanks @ravron)\n- #70: Fix the handling of pre-releases and the 0.0.0 release edge case\n- #97: Fixed copyright file for proper display on GitHub\n- #107: Fix handling prerelease when sorting alphanum and num\n- #109: Fixed where Validate sometimes returns wrong message on error\n\n## 1.4.2 (2018-04-10)\n\n### Changed\n\n- #72: Updated the docs to point to vert for a console appliaction\n- #71: Update the docs on pre-release comparator handling\n\n### Fixed\n\n- #70: Fix the handling of pre-releases and the 0.0.0 release edge case\n\n## 1.4.1 (2018-04-02)\n\n### Fixed\n\n- Fixed #64: Fix pre-release precedence issue (thanks @uudashr)\n\n## 1.4.0 (2017-10-04)\n\n### Changed\n\n- #61: Update NewVersion to parse ints with a 64bit int size (thanks @zknill)\n\n## 1.3.1 (2017-07-10)\n\n### Fixed\n\n- Fixed #57: number comparisons in prerelease sometimes inaccurate\n\n## 1.3.0 (2017-05-02)\n\n### Added\n\n- #45: Added json (un)marshaling support (thanks @mh-cbon)\n- Stability marker. See https://masterminds.github.io/stability/\n\n### Fixed\n\n- #51: Fix handling of single digit tilde constraint (thanks @dgodd)\n\n### Changed\n\n- #55: The godoc icon moved from png to svg\n\n## 1.2.3 (2017-04-03)\n\n### Fixed\n\n- #46: Fixed 0.x.x and 0.0.x in constraints being treated as *\n\n## Release 1.2.2 (2016-12-13)\n\n### Fixed\n\n- #34: Fixed issue where hyphen range was not working with pre-release parsing.\n\n## Release 1.2.1 (2016-11-28)\n\n### Fixed\n\n- #24: Fixed edge case issue where constraint \"> 0\" does not handle \"0.0.1-alpha\"\n properly.\n\n## Release 1.2.0 (2016-11-04)\n\n### Added\n\n- #20: Added MustParse function for versions (thanks @adamreese)\n- #15: Added increment methods on versions (thanks @mh-cbon)\n\n### Fixed\n\n- Issue #21: Per the SemVer spec (section 9) a pre-release is unstable and\n might not satisfy the intended compatibility. The change here ignores pre-releases\n on constraint checks (e.g., ~ or ^) when a pre-release is not part of the\n constraint. For example, `^1.2.3` will ignore pre-releases while\n `^1.2.3-alpha` will include them.\n\n## Release 1.1.1 (2016-06-30)\n\n### Changed\n\n- Issue #9: Speed up version comparison performance (thanks @sdboyer)\n- Issue #8: Added benchmarks (thanks @sdboyer)\n- Updated Go Report Card URL to new location\n- Updated Readme to add code snippet formatting (thanks @mh-cbon)\n- Updating tagging to v[SemVer] structure for compatibility with other tools.\n\n## Release 1.1.0 (2016-03-11)\n\n- Issue #2: Implemented validation to provide reasons a versions failed a\n constraint.\n\n## Release 1.0.1 (2015-12-31)\n\n- Fixed #1: * constraint failing on valid versions.\n\n## Release 1.0.0 (2015-10-20)\n\n- Initial release\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/LICENSE.txt",
"content": "Copyright (C) 2014-2019, Matt Butcher and Matt Farina\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/Makefile",
"content": "GOPATH=$(shell go env GOPATH)\nGOLANGCI_LINT=$(GOPATH)/bin/golangci-lint\n\n.PHONY: lint\nlint: $(GOLANGCI_LINT)\n\t@echo \"==> Linting codebase\"\n\t@$(GOLANGCI_LINT) run\n\n.PHONY: test\ntest:\n\t@echo \"==> Running tests\"\n\tGO111MODULE=on go test -v\n\n.PHONY: test-cover\ntest-cover:\n\t@echo \"==> Running Tests with coverage\"\n\tGO111MODULE=on go test -cover .\n\n.PHONY: fuzz\nfuzz:\n\t@echo \"==> Running Fuzz Tests\"\n\tgo env GOCACHE\n\tgo test -fuzz=FuzzNewVersion -fuzztime=15s .\n\tgo test -fuzz=FuzzStrictNewVersion -fuzztime=15s .\n\tgo test -fuzz=FuzzNewConstraint -fuzztime=15s .\n\n$(GOLANGCI_LINT):\n\t# Install golangci-lint. The configuration for it is in the .golangci.yml\n\t# file in the root of the repository\n\techo ${GOPATH}\n\tcurl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(GOPATH)/bin v1.56.2\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/README.md",
"content": "# SemVer\n\nThe `semver` package provides the ability to work with [Semantic Versions](http://semver.org) in Go. Specifically it provides the ability to:\n\n* Parse semantic versions\n* Sort semantic versions\n* Check if a semantic version fits within a set of constraints\n* Optionally work with a `v` prefix\n\n[](https://masterminds.github.io/stability/active.html)\n[](https://github.com/Masterminds/semver/actions)\n[](https://pkg.go.dev/github.com/Masterminds/semver/v3)\n[](https://goreportcard.com/report/github.com/Masterminds/semver)\n\n## Package Versions\n\nNote, import `github.com/Masterminds/semver/v3` to use the latest version.\n\nThere are three major versions fo the `semver` package.\n\n* 3.x.x is the stable and active version. This version is focused on constraint\n compatibility for range handling in other tools from other languages. It has\n a similar API to the v1 releases. The development of this version is on the master\n branch. The documentation for this version is below.\n* 2.x was developed primarily for [dep](https://github.com/golang/dep). There are\n no tagged releases and the development was performed by [@sdboyer](https://github.com/sdboyer).\n There are API breaking changes from v1. This version lives on the [2.x branch](https://github.com/Masterminds/semver/tree/2.x).\n* 1.x.x is the original release. It is no longer maintained. You should use the\n v3 release instead. You can read the documentation for the 1.x.x release\n [here](https://github.com/Masterminds/semver/blob/release-1/README.md).\n\n## Parsing Semantic Versions\n\nThere are two functions that can parse semantic versions. The `StrictNewVersion`\nfunction only parses valid version 2 semantic versions as outlined in the\nspecification. The `NewVersion` function attempts to coerce a version into a\nsemantic version and parse it. For example, if there is a leading v or a version\nlisted without all 3 parts (e.g. `v1.2`) it will attempt to coerce it into a valid\nsemantic version (e.g., 1.2.0). In both cases a `Version` object is returned\nthat can be sorted, compared, and used in constraints.\n\nWhen parsing a version an error is returned if there is an issue parsing the\nversion. For example,\n\n v, err := semver.NewVersion(\"1.2.3-beta.1+build345\")\n\nThe version object has methods to get the parts of the version, compare it to\nother versions, convert the version back into a string, and get the original\nstring. Getting the original string is useful if the semantic version was coerced\ninto a valid form.\n\nThere are package level variables that affect how `NewVersion` handles parsing.\n\n- `CoerceNewVersion` is `true` by default. When set to `true` it coerces non-compliant\n versions into SemVer. For example, allowing a leading 0 in a major, minor, or patch\n part. This enables the use of CalVer in versions even when not compliant with SemVer.\n When set to `false` less coercion work is done.\n- `DetailedNewVersionErrors` provides more detailed errors. It only has an affect when\n `CoerceNewVersion` is set to `false`. When `DetailedNewVersionErrors` is set to `true`\n it can provide some more insight into why a version is invalid. Setting\n `DetailedNewVersionErrors` to `false` is faster on performance but provides less\n detailed error messages if a version fails to parse.\n\n## Sorting Semantic Versions\n\nA set of versions can be sorted using the `sort` package from the standard library.\nFor example,\n\n```go\nraw := []string{\"1.2.3\", \"1.0\", \"1.3\", \"2\", \"0.4.2\",}\nvs := make([]*semver.Version, len(raw))\nfor i, r := range raw {\n v, err := semver.NewVersion(r)\n if err != nil {\n t.Errorf(\"Error parsing version: %s\", err)\n }\n\n vs[i] = v\n}\n\nsort.Sort(semver.Collection(vs))\n```\n\n## Checking Version Constraints\n\nThere are two methods for comparing versions. One uses comparison methods on\n`Version` instances and the other uses `Constraints`. There are some important\ndifferences to notes between these two methods of comparison.\n\n1. When two versions are compared using functions such as `Compare`, `LessThan`,\n and others it will follow the specification and always include pre-releases\n within the comparison. It will provide an answer that is valid with the\n comparison section of the spec at https://semver.org/#spec-item-11\n2. When constraint checking is used for checks or validation it will follow a\n different set of rules that are common for ranges with tools like npm/js\n and Rust/Cargo. This includes considering pre-releases to be invalid if the\n ranges does not include one. If you want to have it include pre-releases a\n simple solution is to include `-0` in your range.\n3. Constraint ranges can have some complex rules including the shorthand use of\n ~ and ^. For more details on those see the options below.\n\nThere are differences between the two methods or checking versions because the\ncomparison methods on `Version` follow the specification while comparison ranges\nare not part of the specification. Different packages and tools have taken it\nupon themselves to come up with range rules. This has resulted in differences.\nFor example, npm/js and Cargo/Rust follow similar patterns while PHP has a\ndifferent pattern for ^. The comparison features in this package follow the\nnpm/js and Cargo/Rust lead because applications using it have followed similar\npatters with their versions.\n\nChecking a version against version constraints is one of the most featureful\nparts of the package.\n\n```go\nc, err := semver.NewConstraint(\">= 1.2.3\")\nif err != nil {\n // Handle constraint not being parsable.\n}\n\nv, err := semver.NewVersion(\"1.3\")\nif err != nil {\n // Handle version not being parsable.\n}\n// Check if the version meets the constraints. The variable a will be true.\na := c.Check(v)\n```\n\n### Basic Comparisons\n\nThere are two elements to the comparisons. First, a comparison string is a list\nof space or comma separated AND comparisons. These are then separated by || (OR)\ncomparisons. For example, `\">= 1.2 < 3.0.0 || >= 4.2.3\"` is looking for a\ncomparison that's greater than or equal to 1.2 and less than 3.0.0 or is\ngreater than or equal to 4.2.3.\n\nThe basic comparisons are:\n\n* `=`: equal (aliased to no operator)\n* `!=`: not equal\n* `>`: greater than\n* `<`: less than\n* `>=`: greater than or equal to\n* `<=`: less than or equal to\n\n### Working With Prerelease Versions\n\nPre-releases, for those not familiar with them, are used for software releases\nprior to stable or generally available releases. Examples of pre-releases include\ndevelopment, alpha, beta, and release candidate releases. A pre-release may be\na version such as `1.2.3-beta.1` while the stable release would be `1.2.3`. In the\norder of precedence, pre-releases come before their associated releases. In this\nexample `1.2.3-beta.1 < 1.2.3`.\n\nAccording to the Semantic Version specification, pre-releases may not be\nAPI compliant with their release counterpart. It says,\n\n> A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version.\n\nSemVer's comparisons using constraints without a pre-release comparator will skip\npre-release versions. For example, `>=1.2.3` will skip pre-releases when looking\nat a list of releases while `>=1.2.3-0` will evaluate and find pre-releases.\n\nThe reason for the `0` as a pre-release version in the example comparison is\nbecause pre-releases can only contain ASCII alphanumerics and hyphens (along with\n`.` separators), per the spec. Sorting happens in ASCII sort order, again per the\nspec. The lowest character is a `0` in ASCII sort order\n(see an [ASCII Table](http://www.asciitable.com/))\n\nUnderstanding ASCII sort ordering is important because A-Z comes before a-z. That\nmeans `>=1.2.3-BETA` will return `1.2.3-alpha`. What you might expect from case\nsensitivity doesn't apply here. This is due to ASCII sort ordering which is what\nthe spec specifies.\n\nThe `Constraints` instance returned from `semver.NewConstraint()` has a property\n`IncludePrerelease` that, when set to true, will return prerelease versions when calls\nto `Check()` and `Validate()` are made.\n\n### Hyphen Range Comparisons\n\nThere are multiple methods to handle ranges and the first is hyphens ranges.\nThese look like:\n\n* `1.2 - 1.4.5` which is equivalent to `>= 1.2 <= 1.4.5`\n* `2.3.4 - 4.5` which is equivalent to `>= 2.3.4 <= 4.5`\n\nNote that `1.2-1.4.5` without whitespace is parsed completely differently; it's\nparsed as a single constraint `1.2.0` with _prerelease_ `1.4.5`.\n\n### Wildcards In Comparisons\n\nThe `x`, `X`, and `*` characters can be used as a wildcard character. This works\nfor all comparison operators. When used on the `=` operator it falls\nback to the patch level comparison (see tilde below). For example,\n\n* `1.2.x` is equivalent to `>= 1.2.0, < 1.3.0`\n* `>= 1.2.x` is equivalent to `>= 1.2.0`\n* `<= 2.x` is equivalent to `< 3`\n* `*` is equivalent to `>= 0.0.0`\n\n### Tilde Range Comparisons (Patch)\n\nThe tilde (`~`) comparison operator is for patch level ranges when a minor\nversion is specified and major level changes when the minor number is missing.\nFor example,\n\n* `~1.2.3` is equivalent to `>= 1.2.3, < 1.3.0`\n* `~1` is equivalent to `>= 1, < 2`\n* `~2.3` is equivalent to `>= 2.3, < 2.4`\n* `~1.2.x` is equivalent to `>= 1.2.0, < 1.3.0`\n* `~1.x` is equivalent to `>= 1, < 2`\n\n### Caret Range Comparisons (Major)\n\nThe caret (`^`) comparison operator is for major level changes once a stable\n(1.0.0) release has occurred. Prior to a 1.0.0 release the minor versions acts\nas the API stability level. This is useful when comparisons of API versions as a\nmajor change is API breaking. For example,\n\n* `^1.2.3` is equivalent to `>= 1.2.3, < 2.0.0`\n* `^1.2.x` is equivalent to `>= 1.2.0, < 2.0.0`\n* `^2.3` is equivalent to `>= 2.3, < 3`\n* `^2.x` is equivalent to `>= 2.0.0, < 3`\n* `^0.2.3` is equivalent to `>=0.2.3 <0.3.0`\n* `^0.2` is equivalent to `>=0.2.0 <0.3.0`\n* `^0.0.3` is equivalent to `>=0.0.3 <0.0.4`\n* `^0.0` is equivalent to `>=0.0.0 <0.1.0`\n* `^0` is equivalent to `>=0.0.0 <1.0.0`\n\n## Validation\n\nIn addition to testing a version against a constraint, a version can be validated\nagainst a constraint. When validation fails a slice of errors containing why a\nversion didn't meet the constraint is returned. For example,\n\n```go\nc, err := semver.NewConstraint(\"<= 1.2.3, >= 1.4\")\nif err != nil {\n // Handle constraint not being parseable.\n}\n\nv, err := semver.NewVersion(\"1.3\")\nif err != nil {\n // Handle version not being parseable.\n}\n\n// Validate a version against a constraint.\na, msgs := c.Validate(v)\n// a is false\nfor _, m := range msgs {\n fmt.Println(m)\n\n // Loops over the errors which would read\n // \"1.3 is greater than 1.2.3\"\n // \"1.3 is less than 1.4\"\n}\n```\n\n## Contribute\n\nIf you find an issue or want to contribute please file an [issue](https://github.com/Masterminds/semver/issues)\nor [create a pull request](https://github.com/Masterminds/semver/pulls).\n\n## Security\n\nSecurity is an important consideration for this project. The project currently\nuses the following tools to help discover security issues:\n\n* [CodeQL](https://codeql.github.com)\n* [gosec](https://github.com/securego/gosec)\n* Daily Fuzz testing\n\nIf you believe you have found a security vulnerability you can privately disclose\nit through the [GitHub security page](https://github.com/Masterminds/semver/security).\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/SECURITY.md",
"content": "# Security Policy\n\n## Supported Versions\n\nThe following versions of semver are currently supported:\n\n| Version | Supported |\n| ------- | ------------------ |\n| 3.x | :white_check_mark: |\n| 2.x | :x: |\n| 1.x | :x: |\n\nFixes are only released for the latest minor version in the form of a patch release.\n\n## Reporting a Vulnerability\n\nYou can privately disclose a vulnerability through GitHubs\n[private vulnerability reporting](https://github.com/Masterminds/semver/security/advisories)\nmechanism.\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/collection.go",
"content": "package semver\n\n// Collection is a collection of Version instances and implements the sort\n// interface. See the sort package for more details.\n// https://golang.org/pkg/sort/\ntype Collection []*Version\n\n// Len returns the length of a collection. The number of Version instances\n// on the slice.\nfunc (c Collection) Len() int {\n\treturn len(c)\n}\n\n// Less is needed for the sort interface to compare two Version objects on the\n// slice. If checks if one is less than the other.\nfunc (c Collection) Less(i, j int) bool {\n\treturn c[i].LessThan(c[j])\n}\n\n// Swap is needed for the sort interface to replace the Version objects\n// at two different positions in the slice.\nfunc (c Collection) Swap(i, j int) {\n\tc[i], c[j] = c[j], c[i]\n}\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/constraints.go",
"content": "package semver\n\nimport (\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\t\"regexp\"\n\t\"strings\"\n)\n\n// Constraints is one or more constraint that a semantic version can be\n// checked against.\ntype Constraints struct {\n\tconstraints [][]*constraint\n\tcontainsPre []bool\n\n\t// IncludePrerelease specifies if pre-releases should be included in\n\t// the results. Note, if a constraint range has a prerelease than\n\t// prereleases will be included for that AND group even if this is\n\t// set to false.\n\tIncludePrerelease bool\n}\n\n// NewConstraint returns a Constraints instance that a Version instance can\n// be checked against. If there is a parse error it will be returned.\nfunc NewConstraint(c string) (*Constraints, error) {\n\n\t// Rewrite - ranges into a comparison operation.\n\tc = rewriteRange(c)\n\n\tors := strings.Split(c, \"||\")\n\tlenors := len(ors)\n\tor := make([][]*constraint, lenors)\n\thasPre := make([]bool, lenors)\n\tfor k, v := range ors {\n\t\t// Validate the segment\n\t\tif !validConstraintRegex.MatchString(v) {\n\t\t\treturn nil, fmt.Errorf(\"improper constraint: %s\", v)\n\t\t}\n\n\t\tcs := findConstraintRegex.FindAllString(v, -1)\n\t\tif cs == nil {\n\t\t\tcs = append(cs, v)\n\t\t}\n\t\tresult := make([]*constraint, len(cs))\n\t\tfor i, s := range cs {\n\t\t\tpc, err := parseConstraint(s)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\n\t\t\t// If one of the constraints has a prerelease record this.\n\t\t\t// This information is used when checking all in an \"and\"\n\t\t\t// group to ensure they all check for prereleases.\n\t\t\tif pc.con.pre != \"\" {\n\t\t\t\thasPre[k] = true\n\t\t\t}\n\n\t\t\tresult[i] = pc\n\t\t}\n\t\tor[k] = result\n\t}\n\n\to := &Constraints{\n\t\tconstraints: or,\n\t\tcontainsPre: hasPre,\n\t}\n\treturn o, nil\n}\n\n// Check tests if a version satisfies the constraints.\nfunc (cs Constraints) Check(v *Version) bool {\n\t// TODO(mattfarina): For v4 of this library consolidate the Check and Validate\n\t// functions as the underlying functions make that possible now.\n\t// loop over the ORs and check the inner ANDs\n\tfor i, o := range cs.constraints {\n\t\tjoy := true\n\t\tfor _, c := range o {\n\t\t\tif check, _ := c.check(v, (cs.IncludePrerelease || cs.containsPre[i])); !check {\n\t\t\t\tjoy = false\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\n\t\tif joy {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n\n// Validate checks if a version satisfies a constraint. If not a slice of\n// reasons for the failure are returned in addition to a bool.\nfunc (cs Constraints) Validate(v *Version) (bool, []error) {\n\t// loop over the ORs and check the inner ANDs\n\tvar e []error\n\n\t// Capture the prerelease message only once. When it happens the first time\n\t// this var is marked\n\tvar prerelesase bool\n\tfor i, o := range cs.constraints {\n\t\tjoy := true\n\t\tfor _, c := range o {\n\t\t\t// Before running the check handle the case there the version is\n\t\t\t// a prerelease and the check is not searching for prereleases.\n\t\t\tif !(cs.IncludePrerelease || cs.containsPre[i]) && v.pre != \"\" {\n\t\t\t\tif !prerelesase {\n\t\t\t\t\tem := fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t\t\t\t\te = append(e, em)\n\t\t\t\t\tprerelesase = true\n\t\t\t\t}\n\t\t\t\tjoy = false\n\n\t\t\t} else {\n\n\t\t\t\tif _, err := c.check(v, (cs.IncludePrerelease || cs.containsPre[i])); err != nil {\n\t\t\t\t\te = append(e, err)\n\t\t\t\t\tjoy = false\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif joy {\n\t\t\treturn true, []error{}\n\t\t}\n\t}\n\n\treturn false, e\n}\n\nfunc (cs Constraints) String() string {\n\tbuf := make([]string, len(cs.constraints))\n\tvar tmp bytes.Buffer\n\n\tfor k, v := range cs.constraints {\n\t\ttmp.Reset()\n\t\tvlen := len(v)\n\t\tfor kk, c := range v {\n\t\t\ttmp.WriteString(c.string())\n\n\t\t\t// Space separate the AND conditions\n\t\t\tif vlen > 1 && kk < vlen-1 {\n\t\t\t\ttmp.WriteString(\" \")\n\t\t\t}\n\t\t}\n\t\tbuf[k] = tmp.String()\n\t}\n\n\treturn strings.Join(buf, \" || \")\n}\n\n// UnmarshalText implements the encoding.TextUnmarshaler interface.\nfunc (cs *Constraints) UnmarshalText(text []byte) error {\n\ttemp, err := NewConstraint(string(text))\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t*cs = *temp\n\n\treturn nil\n}\n\n// MarshalText implements the encoding.TextMarshaler interface.\nfunc (cs Constraints) MarshalText() ([]byte, error) {\n\treturn []byte(cs.String()), nil\n}\n\nvar constraintOps map[string]cfunc\nvar constraintRegex *regexp.Regexp\nvar constraintRangeRegex *regexp.Regexp\n\n// Used to find individual constraints within a multi-constraint string\nvar findConstraintRegex *regexp.Regexp\n\n// Used to validate an segment of ANDs is valid\nvar validConstraintRegex *regexp.Regexp\n\nconst cvRegex string = `v?([0-9|x|X|\\*]+)(\\.[0-9|x|X|\\*]+)?(\\.[0-9|x|X|\\*]+)?` +\n\t`(-([0-9A-Za-z\\-]+(\\.[0-9A-Za-z\\-]+)*))?` +\n\t`(\\+([0-9A-Za-z\\-]+(\\.[0-9A-Za-z\\-]+)*))?`\n\nfunc init() {\n\tconstraintOps = map[string]cfunc{\n\t\t\"\": constraintTildeOrEqual,\n\t\t\"=\": constraintTildeOrEqual,\n\t\t\"!=\": constraintNotEqual,\n\t\t\">\": constraintGreaterThan,\n\t\t\"<\": constraintLessThan,\n\t\t\">=\": constraintGreaterThanEqual,\n\t\t\"=>\": constraintGreaterThanEqual,\n\t\t\"<=\": constraintLessThanEqual,\n\t\t\"=<\": constraintLessThanEqual,\n\t\t\"~\": constraintTilde,\n\t\t\"~>\": constraintTilde,\n\t\t\"^\": constraintCaret,\n\t}\n\n\tops := `=||!=|>|<|>=|=>|<=|=<|~|~>|\\^`\n\n\tconstraintRegex = regexp.MustCompile(fmt.Sprintf(\n\t\t`^\\s*(%s)\\s*(%s)\\s*$`,\n\t\tops,\n\t\tcvRegex))\n\n\tconstraintRangeRegex = regexp.MustCompile(fmt.Sprintf(\n\t\t`\\s*(%s)\\s+-\\s+(%s)\\s*`,\n\t\tcvRegex, cvRegex))\n\n\tfindConstraintRegex = regexp.MustCompile(fmt.Sprintf(\n\t\t`(%s)\\s*(%s)`,\n\t\tops,\n\t\tcvRegex))\n\n\t// The first time a constraint shows up will look slightly different from\n\t// future times it shows up due to a leading space or comma in a given\n\t// string.\n\tvalidConstraintRegex = regexp.MustCompile(fmt.Sprintf(\n\t\t`^(\\s*(%s)\\s*(%s)\\s*)((?:\\s+|,\\s*)(%s)\\s*(%s)\\s*)*$`,\n\t\tops,\n\t\tcvRegex,\n\t\tops,\n\t\tcvRegex))\n}\n\n// An individual constraint\ntype constraint struct {\n\t// The version used in the constraint check. For example, if a constraint\n\t// is '<= 2.0.0' the con a version instance representing 2.0.0.\n\tcon *Version\n\n\t// The original parsed version (e.g., 4.x from != 4.x)\n\torig string\n\n\t// The original operator for the constraint\n\torigfunc string\n\n\t// When an x is used as part of the version (e.g., 1.x)\n\tminorDirty bool\n\tdirty bool\n\tpatchDirty bool\n}\n\n// Check if a version meets the constraint\nfunc (c *constraint) check(v *Version, includePre bool) (bool, error) {\n\treturn constraintOps[c.origfunc](v, c, includePre)\n}\n\n// String prints an individual constraint into a string\nfunc (c *constraint) string() string {\n\treturn c.origfunc + c.orig\n}\n\ntype cfunc func(v *Version, c *constraint, includePre bool) (bool, error)\n\nfunc parseConstraint(c string) (*constraint, error) {\n\tif len(c) > 0 {\n\t\tm := constraintRegex.FindStringSubmatch(c)\n\t\tif m == nil {\n\t\t\treturn nil, fmt.Errorf(\"improper constraint: %s\", c)\n\t\t}\n\n\t\tcs := &constraint{\n\t\t\torig: m[2],\n\t\t\torigfunc: m[1],\n\t\t}\n\n\t\tver := m[2]\n\t\tminorDirty := false\n\t\tpatchDirty := false\n\t\tdirty := false\n\t\tif isX(m[3]) || m[3] == \"\" {\n\t\t\tver = fmt.Sprintf(\"0.0.0%s\", m[6])\n\t\t\tdirty = true\n\t\t} else if isX(strings.TrimPrefix(m[4], \".\")) || m[4] == \"\" {\n\t\t\tminorDirty = true\n\t\t\tdirty = true\n\t\t\tver = fmt.Sprintf(\"%s.0.0%s\", m[3], m[6])\n\t\t} else if isX(strings.TrimPrefix(m[5], \".\")) || m[5] == \"\" {\n\t\t\tdirty = true\n\t\t\tpatchDirty = true\n\t\t\tver = fmt.Sprintf(\"%s%s.0%s\", m[3], m[4], m[6])\n\t\t}\n\n\t\tcon, err := NewVersion(ver)\n\t\tif err != nil {\n\n\t\t\t// The constraintRegex should catch any regex parsing errors. So,\n\t\t\t// we should never get here.\n\t\t\treturn nil, errors.New(\"constraint parser error\")\n\t\t}\n\n\t\tcs.con = con\n\t\tcs.minorDirty = minorDirty\n\t\tcs.patchDirty = patchDirty\n\t\tcs.dirty = dirty\n\n\t\treturn cs, nil\n\t}\n\n\t// The rest is the special case where an empty string was passed in which\n\t// is equivalent to * or >=0.0.0\n\tcon, err := StrictNewVersion(\"0.0.0\")\n\tif err != nil {\n\n\t\t// The constraintRegex should catch any regex parsing errors. So,\n\t\t// we should never get here.\n\t\treturn nil, errors.New(\"constraint parser error\")\n\t}\n\n\tcs := &constraint{\n\t\tcon: con,\n\t\torig: c,\n\t\torigfunc: \"\",\n\t\tminorDirty: false,\n\t\tpatchDirty: false,\n\t\tdirty: true,\n\t}\n\treturn cs, nil\n}\n\n// Constraint functions\nfunc constraintNotEqual(v *Version, c *constraint, includePre bool) (bool, error) {\n\t// The existence of prereleases is checked at the group level and passed in.\n\t// Exit early if the version has a prerelease but those are to be ignored.\n\tif v.Prerelease() != \"\" && !includePre {\n\t\treturn false, fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t}\n\n\tif c.dirty {\n\t\tif c.con.Major() != v.Major() {\n\t\t\treturn true, nil\n\t\t}\n\t\tif c.con.Minor() != v.Minor() && !c.minorDirty {\n\t\t\treturn true, nil\n\t\t} else if c.minorDirty {\n\t\t\treturn false, fmt.Errorf(\"%s is equal to %s\", v, c.orig)\n\t\t} else if c.con.Patch() != v.Patch() && !c.patchDirty {\n\t\t\treturn true, nil\n\t\t} else if c.patchDirty {\n\t\t\t// Need to handle prereleases if present\n\t\t\tif v.Prerelease() != \"\" || c.con.Prerelease() != \"\" {\n\t\t\t\teq := comparePrerelease(v.Prerelease(), c.con.Prerelease()) != 0\n\t\t\t\tif eq {\n\t\t\t\t\treturn true, nil\n\t\t\t\t}\n\t\t\t\treturn false, fmt.Errorf(\"%s is equal to %s\", v, c.orig)\n\t\t\t}\n\t\t\treturn false, fmt.Errorf(\"%s is equal to %s\", v, c.orig)\n\t\t}\n\t}\n\n\teq := v.Equal(c.con)\n\tif eq {\n\t\treturn false, fmt.Errorf(\"%s is equal to %s\", v, c.orig)\n\t}\n\n\treturn true, nil\n}\n\nfunc constraintGreaterThan(v *Version, c *constraint, includePre bool) (bool, error) {\n\n\t// The existence of prereleases is checked at the group level and passed in.\n\t// Exit early if the version has a prerelease but those are to be ignored.\n\tif v.Prerelease() != \"\" && !includePre {\n\t\treturn false, fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t}\n\n\tvar eq bool\n\n\tif !c.dirty {\n\t\teq = v.Compare(c.con) == 1\n\t\tif eq {\n\t\t\treturn true, nil\n\t\t}\n\t\treturn false, fmt.Errorf(\"%s is less than or equal to %s\", v, c.orig)\n\t}\n\n\tif v.Major() > c.con.Major() {\n\t\treturn true, nil\n\t} else if v.Major() < c.con.Major() {\n\t\treturn false, fmt.Errorf(\"%s is less than or equal to %s\", v, c.orig)\n\t} else if c.minorDirty {\n\t\t// This is a range case such as >11. When the version is something like\n\t\t// 11.1.0 is it not > 11. For that we would need 12 or higher\n\t\treturn false, fmt.Errorf(\"%s is less than or equal to %s\", v, c.orig)\n\t} else if c.patchDirty {\n\t\t// This is for ranges such as >11.1. A version of 11.1.1 is not greater\n\t\t// which one of 11.2.1 is greater\n\t\teq = v.Minor() > c.con.Minor()\n\t\tif eq {\n\t\t\treturn true, nil\n\t\t}\n\t\treturn false, fmt.Errorf(\"%s is less than or equal to %s\", v, c.orig)\n\t}\n\n\t// If we have gotten here we are not comparing pre-preleases and can use the\n\t// Compare function to accomplish that.\n\teq = v.Compare(c.con) == 1\n\tif eq {\n\t\treturn true, nil\n\t}\n\treturn false, fmt.Errorf(\"%s is less than or equal to %s\", v, c.orig)\n}\n\nfunc constraintLessThan(v *Version, c *constraint, includePre bool) (bool, error) {\n\t// The existence of prereleases is checked at the group level and passed in.\n\t// Exit early if the version has a prerelease but those are to be ignored.\n\tif v.Prerelease() != \"\" && !includePre {\n\t\treturn false, fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t}\n\n\teq := v.Compare(c.con) < 0\n\tif eq {\n\t\treturn true, nil\n\t}\n\treturn false, fmt.Errorf(\"%s is greater than or equal to %s\", v, c.orig)\n}\n\nfunc constraintGreaterThanEqual(v *Version, c *constraint, includePre bool) (bool, error) {\n\n\t// The existence of prereleases is checked at the group level and passed in.\n\t// Exit early if the version has a prerelease but those are to be ignored.\n\tif v.Prerelease() != \"\" && !includePre {\n\t\treturn false, fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t}\n\n\teq := v.Compare(c.con) >= 0\n\tif eq {\n\t\treturn true, nil\n\t}\n\treturn false, fmt.Errorf(\"%s is less than %s\", v, c.orig)\n}\n\nfunc constraintLessThanEqual(v *Version, c *constraint, includePre bool) (bool, error) {\n\t// The existence of prereleases is checked at the group level and passed in.\n\t// Exit early if the version has a prerelease but those are to be ignored.\n\tif v.Prerelease() != \"\" && !includePre {\n\t\treturn false, fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t}\n\n\tvar eq bool\n\n\tif !c.dirty {\n\t\teq = v.Compare(c.con) <= 0\n\t\tif eq {\n\t\t\treturn true, nil\n\t\t}\n\t\treturn false, fmt.Errorf(\"%s is greater than %s\", v, c.orig)\n\t}\n\n\tif v.Major() > c.con.Major() {\n\t\treturn false, fmt.Errorf(\"%s is greater than %s\", v, c.orig)\n\t} else if v.Major() == c.con.Major() && v.Minor() > c.con.Minor() && !c.minorDirty {\n\t\treturn false, fmt.Errorf(\"%s is greater than %s\", v, c.orig)\n\t}\n\n\treturn true, nil\n}\n\n// ~*, ~>* --> >= 0.0.0 (any)\n// ~2, ~2.x, ~2.x.x, ~>2, ~>2.x ~>2.x.x --> >=2.0.0, <3.0.0\n// ~2.0, ~2.0.x, ~>2.0, ~>2.0.x --> >=2.0.0, <2.1.0\n// ~1.2, ~1.2.x, ~>1.2, ~>1.2.x --> >=1.2.0, <1.3.0\n// ~1.2.3, ~>1.2.3 --> >=1.2.3, <1.3.0\n// ~1.2.0, ~>1.2.0 --> >=1.2.0, <1.3.0\nfunc constraintTilde(v *Version, c *constraint, includePre bool) (bool, error) {\n\t// The existence of prereleases is checked at the group level and passed in.\n\t// Exit early if the version has a prerelease but those are to be ignored.\n\tif v.Prerelease() != \"\" && !includePre {\n\t\treturn false, fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t}\n\n\tif v.LessThan(c.con) {\n\t\treturn false, fmt.Errorf(\"%s is less than %s\", v, c.orig)\n\t}\n\n\t// ~0.0.0 is a special case where all constraints are accepted. It's\n\t// equivalent to >= 0.0.0.\n\tif c.con.Major() == 0 && c.con.Minor() == 0 && c.con.Patch() == 0 &&\n\t\t!c.minorDirty && !c.patchDirty {\n\t\treturn true, nil\n\t}\n\n\tif v.Major() != c.con.Major() {\n\t\treturn false, fmt.Errorf(\"%s does not have same major version as %s\", v, c.orig)\n\t}\n\n\tif v.Minor() != c.con.Minor() && !c.minorDirty {\n\t\treturn false, fmt.Errorf(\"%s does not have same major and minor version as %s\", v, c.orig)\n\t}\n\n\treturn true, nil\n}\n\n// When there is a .x (dirty) status it automatically opts in to ~. Otherwise\n// it's a straight =\nfunc constraintTildeOrEqual(v *Version, c *constraint, includePre bool) (bool, error) {\n\t// The existence of prereleases is checked at the group level and passed in.\n\t// Exit early if the version has a prerelease but those are to be ignored.\n\tif v.Prerelease() != \"\" && !includePre {\n\t\treturn false, fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t}\n\n\tif c.dirty {\n\t\treturn constraintTilde(v, c, includePre)\n\t}\n\n\teq := v.Equal(c.con)\n\tif eq {\n\t\treturn true, nil\n\t}\n\n\treturn false, fmt.Errorf(\"%s is not equal to %s\", v, c.orig)\n}\n\n// ^* --> (any)\n// ^1.2.3 --> >=1.2.3 <2.0.0\n// ^1.2 --> >=1.2.0 <2.0.0\n// ^1 --> >=1.0.0 <2.0.0\n// ^0.2.3 --> >=0.2.3 <0.3.0\n// ^0.2 --> >=0.2.0 <0.3.0\n// ^0.0.3 --> >=0.0.3 <0.0.4\n// ^0.0 --> >=0.0.0 <0.1.0\n// ^0 --> >=0.0.0 <1.0.0\nfunc constraintCaret(v *Version, c *constraint, includePre bool) (bool, error) {\n\t// The existence of prereleases is checked at the group level and passed in.\n\t// Exit early if the version has a prerelease but those are to be ignored.\n\tif v.Prerelease() != \"\" && !includePre {\n\t\treturn false, fmt.Errorf(\"%s is a prerelease version and the constraint is only looking for release versions\", v)\n\t}\n\n\t// This less than handles prereleases\n\tif v.LessThan(c.con) {\n\t\treturn false, fmt.Errorf(\"%s is less than %s\", v, c.orig)\n\t}\n\n\tvar eq bool\n\n\t// ^ when the major > 0 is >=x.y.z < x+1\n\tif c.con.Major() > 0 || c.minorDirty {\n\n\t\t// ^ has to be within a major range for > 0. Everything less than was\n\t\t// filtered out with the LessThan call above. This filters out those\n\t\t// that greater but not within the same major range.\n\t\teq = v.Major() == c.con.Major()\n\t\tif eq {\n\t\t\treturn true, nil\n\t\t}\n\t\treturn false, fmt.Errorf(\"%s does not have same major version as %s\", v, c.orig)\n\t}\n\n\t// ^ when the major is 0 and minor > 0 is >=0.y.z < 0.y+1\n\tif c.con.Major() == 0 && v.Major() > 0 {\n\t\treturn false, fmt.Errorf(\"%s does not have same major version as %s\", v, c.orig)\n\t}\n\t// If the con Minor is > 0 it is not dirty\n\tif c.con.Minor() > 0 || c.patchDirty {\n\t\teq = v.Minor() == c.con.Minor()\n\t\tif eq {\n\t\t\treturn true, nil\n\t\t}\n\t\treturn false, fmt.Errorf(\"%s does not have same minor version as %s. Expected minor versions to match when constraint major version is 0\", v, c.orig)\n\t}\n\t// ^ when the minor is 0 and minor > 0 is =0.0.z\n\tif c.con.Minor() == 0 && v.Minor() > 0 {\n\t\treturn false, fmt.Errorf(\"%s does not have same minor version as %s\", v, c.orig)\n\t}\n\n\t// At this point the major is 0 and the minor is 0 and not dirty. The patch\n\t// is not dirty so we need to check if they are equal. If they are not equal\n\teq = c.con.Patch() == v.Patch()\n\tif eq {\n\t\treturn true, nil\n\t}\n\treturn false, fmt.Errorf(\"%s does not equal %s. Expect version and constraint to equal when major and minor versions are 0\", v, c.orig)\n}\n\nfunc isX(x string) bool {\n\tswitch x {\n\tcase \"x\", \"*\", \"X\":\n\t\treturn true\n\tdefault:\n\t\treturn false\n\t}\n}\n\nfunc rewriteRange(i string) string {\n\tm := constraintRangeRegex.FindAllStringSubmatch(i, -1)\n\tif m == nil {\n\t\treturn i\n\t}\n\to := i\n\tfor _, v := range m {\n\t\tt := fmt.Sprintf(\">= %s, <= %s \", v[1], v[11])\n\t\to = strings.Replace(o, v[0], t, 1)\n\t}\n\n\treturn o\n}\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/doc.go",
"content": "/*\nPackage semver provides the ability to work with Semantic Versions (http://semver.org) in Go.\n\nSpecifically it provides the ability to:\n\n - Parse semantic versions\n - Sort semantic versions\n - Check if a semantic version fits within a set of constraints\n - Optionally work with a `v` prefix\n\n# Parsing Semantic Versions\n\nThere are two functions that can parse semantic versions. The `StrictNewVersion`\nfunction only parses valid version 2 semantic versions as outlined in the\nspecification. The `NewVersion` function attempts to coerce a version into a\nsemantic version and parse it. For example, if there is a leading v or a version\nlisted without all 3 parts (e.g. 1.2) it will attempt to coerce it into a valid\nsemantic version (e.g., 1.2.0). In both cases a `Version` object is returned\nthat can be sorted, compared, and used in constraints.\n\nWhen parsing a version an optional error can be returned if there is an issue\nparsing the version. For example,\n\n\tv, err := semver.NewVersion(\"1.2.3-beta.1+b345\")\n\nThe version object has methods to get the parts of the version, compare it to\nother versions, convert the version back into a string, and get the original\nstring. For more details please see the documentation\nat https://godoc.org/github.com/Masterminds/semver.\n\n# Sorting Semantic Versions\n\nA set of versions can be sorted using the `sort` package from the standard library.\nFor example,\n\n\t raw := []string{\"1.2.3\", \"1.0\", \"1.3\", \"2\", \"0.4.2\",}\n\t vs := make([]*semver.Version, len(raw))\n\t\tfor i, r := range raw {\n\t\t\tv, err := semver.NewVersion(r)\n\t\t\tif err != nil {\n\t\t\t\tt.Errorf(\"Error parsing version: %s\", err)\n\t\t\t}\n\n\t\t\tvs[i] = v\n\t\t}\n\n\t\tsort.Sort(semver.Collection(vs))\n\n# Checking Version Constraints and Comparing Versions\n\nThere are two methods for comparing versions. One uses comparison methods on\n`Version` instances and the other is using Constraints. There are some important\ndifferences to notes between these two methods of comparison.\n\n 1. When two versions are compared using functions such as `Compare`, `LessThan`,\n and others it will follow the specification and always include prereleases\n within the comparison. It will provide an answer valid with the comparison\n spec section at https://semver.org/#spec-item-11\n 2. When constraint checking is used for checks or validation it will follow a\n different set of rules that are common for ranges with tools like npm/js\n and Rust/Cargo. This includes considering prereleases to be invalid if the\n ranges does not include on. If you want to have it include pre-releases a\n simple solution is to include `-0` in your range.\n 3. Constraint ranges can have some complex rules including the shorthard use of\n ~ and ^. For more details on those see the options below.\n\nThere are differences between the two methods or checking versions because the\ncomparison methods on `Version` follow the specification while comparison ranges\nare not part of the specification. Different packages and tools have taken it\nupon themselves to come up with range rules. This has resulted in differences.\nFor example, npm/js and Cargo/Rust follow similar patterns which PHP has a\ndifferent pattern for ^. The comparison features in this package follow the\nnpm/js and Cargo/Rust lead because applications using it have followed similar\npatters with their versions.\n\nChecking a version against version constraints is one of the most featureful\nparts of the package.\n\n\tc, err := semver.NewConstraint(\">= 1.2.3\")\n\tif err != nil {\n\t // Handle constraint not being parsable.\n\t}\n\n\tv, err := semver.NewVersion(\"1.3\")\n\tif err != nil {\n\t // Handle version not being parsable.\n\t}\n\t// Check if the version meets the constraints. The a variable will be true.\n\ta := c.Check(v)\n\n# Basic Comparisons\n\nThere are two elements to the comparisons. First, a comparison string is a list\nof comma or space separated AND comparisons. These are then separated by || (OR)\ncomparisons. For example, `\">= 1.2 < 3.0.0 || >= 4.2.3\"` is looking for a\ncomparison that's greater than or equal to 1.2 and less than 3.0.0 or is\ngreater than or equal to 4.2.3. This can also be written as\n`\">= 1.2, < 3.0.0 || >= 4.2.3\"`\n\nThe basic comparisons are:\n\n - `=`: equal (aliased to no operator)\n - `!=`: not equal\n - `>`: greater than\n - `<`: less than\n - `>=`: greater than or equal to\n - `<=`: less than or equal to\n\n# Hyphen Range Comparisons\n\nThere are multiple methods to handle ranges and the first is hyphens ranges.\nThese look like:\n\n - `1.2 - 1.4.5` which is equivalent to `>= 1.2, <= 1.4.5`\n - `2.3.4 - 4.5` which is equivalent to `>= 2.3.4 <= 4.5`\n\n# Wildcards In Comparisons\n\nThe `x`, `X`, and `*` characters can be used as a wildcard character. This works\nfor all comparison operators. When used on the `=` operator it falls\nback to the tilde operation. For example,\n\n - `1.2.x` is equivalent to `>= 1.2.0 < 1.3.0`\n - `>= 1.2.x` is equivalent to `>= 1.2.0`\n - `<= 2.x` is equivalent to `<= 3`\n - `*` is equivalent to `>= 0.0.0`\n\nTilde Range Comparisons (Patch)\n\nThe tilde (`~`) comparison operator is for patch level ranges when a minor\nversion is specified and major level changes when the minor number is missing.\nFor example,\n\n - `~1.2.3` is equivalent to `>= 1.2.3 < 1.3.0`\n - `~1` is equivalent to `>= 1, < 2`\n - `~2.3` is equivalent to `>= 2.3 < 2.4`\n - `~1.2.x` is equivalent to `>= 1.2.0 < 1.3.0`\n - `~1.x` is equivalent to `>= 1 < 2`\n\nCaret Range Comparisons (Major)\n\nThe caret (`^`) comparison operator is for major level changes once a stable\n(1.0.0) release has occurred. Prior to a 1.0.0 release the minor versions acts\nas the API stability level. This is useful when comparisons of API versions as a\nmajor change is API breaking. For example,\n\n - `^1.2.3` is equivalent to `>= 1.2.3, < 2.0.0`\n - `^1.2.x` is equivalent to `>= 1.2.0, < 2.0.0`\n - `^2.3` is equivalent to `>= 2.3, < 3`\n - `^2.x` is equivalent to `>= 2.0.0, < 3`\n - `^0.2.3` is equivalent to `>=0.2.3 <0.3.0`\n - `^0.2` is equivalent to `>=0.2.0 <0.3.0`\n - `^0.0.3` is equivalent to `>=0.0.3 <0.0.4`\n - `^0.0` is equivalent to `>=0.0.0 <0.1.0`\n - `^0` is equivalent to `>=0.0.0 <1.0.0`\n\n# Validation\n\nIn addition to testing a version against a constraint, a version can be validated\nagainst a constraint. When validation fails a slice of errors containing why a\nversion didn't meet the constraint is returned. For example,\n\n\tc, err := semver.NewConstraint(\"<= 1.2.3, >= 1.4\")\n\tif err != nil {\n\t // Handle constraint not being parseable.\n\t}\n\n\tv, _ := semver.NewVersion(\"1.3\")\n\tif err != nil {\n\t // Handle version not being parseable.\n\t}\n\n\t// Validate a version against a constraint.\n\ta, msgs := c.Validate(v)\n\t// a is false\n\tfor _, m := range msgs {\n\t fmt.Println(m)\n\n\t // Loops over the errors which would read\n\t // \"1.3 is greater than 1.2.3\"\n\t // \"1.3 is less than 1.4\"\n\t}\n*/\npackage semver\n"
},
{
"path": "tests/vendor/github.com/Masterminds/semver/v3/version.go",
"content": "package semver\n\nimport (\n\t\"bytes\"\n\t\"database/sql/driver\"\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"regexp\"\n\t\"strconv\"\n\t\"strings\"\n)\n\n// The compiled version of the regex created at init() is cached here so it\n// only needs to be created once.\nvar versionRegex *regexp.Regexp\nvar looseVersionRegex *regexp.Regexp\n\n// CoerceNewVersion sets if leading 0's are allowd in the version part. Leading 0's are\n// not allowed in a valid semantic version. When set to true, NewVersion will coerce\n// leading 0's into a valid version.\nvar CoerceNewVersion = true\n\n// DetailedNewVersionErrors specifies if detailed errors are returned from the NewVersion\n// function. This is used when CoerceNewVersion is set to false. If set to false\n// ErrInvalidSemVer is returned for an invalid version. This does not apply to\n// StrictNewVersion. Setting this function to false returns errors more quickly.\nvar DetailedNewVersionErrors = true\n\nvar (\n\t// ErrInvalidSemVer is returned a version is found to be invalid when\n\t// being parsed.\n\tErrInvalidSemVer = errors.New(\"invalid semantic version\")\n\n\t// ErrEmptyString is returned when an empty string is passed in for parsing.\n\tErrEmptyString = errors.New(\"version string empty\")\n\n\t// ErrInvalidCharacters is returned when invalid characters are found as\n\t// part of a version\n\tErrInvalidCharacters = errors.New(\"invalid characters in version\")\n\n\t// ErrSegmentStartsZero is returned when a version segment starts with 0.\n\t// This is invalid in SemVer.\n\tErrSegmentStartsZero = errors.New(\"version segment starts with 0\")\n\n\t// ErrInvalidMetadata is returned when the metadata is an invalid format\n\tErrInvalidMetadata = errors.New(\"invalid metadata string\")\n\n\t// ErrInvalidPrerelease is returned when the pre-release is an invalid format\n\tErrInvalidPrerelease = errors.New(\"invalid prerelease string\")\n)\n\n// semVerRegex is the regular expression used to parse a semantic version.\n// This is not the official regex from the semver spec. It has been modified to allow for loose handling\n// where versions like 2.1 are detected.\nconst semVerRegex string = `v?(0|[1-9]\\d*)(?:\\.(0|[1-9]\\d*))?(?:\\.(0|[1-9]\\d*))?` +\n\t`(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?` +\n\t`(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?`\n\n// looseSemVerRegex is a regular expression that lets invalid semver expressions through\n// with enough detail that certain errors can be checked for.\nconst looseSemVerRegex string = `v?([0-9]+)(\\.[0-9]+)?(\\.[0-9]+)?` +\n\t`(-([0-9A-Za-z\\-]+(\\.[0-9A-Za-z\\-]+)*))?` +\n\t`(\\+([0-9A-Za-z\\-]+(\\.[0-9A-Za-z\\-]+)*))?`\n\n// Version represents a single semantic version.\ntype Version struct {\n\tmajor, minor, patch uint64\n\tpre string\n\tmetadata string\n\toriginal string\n}\n\nfunc init() {\n\tversionRegex = regexp.MustCompile(\"^\" + semVerRegex + \"$\")\n\tlooseVersionRegex = regexp.MustCompile(\"^\" + looseSemVerRegex + \"$\")\n}\n\nconst (\n\tnum string = \"0123456789\"\n\tallowed string = \"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-\" + num\n)\n\n// StrictNewVersion parses a given version and returns an instance of Version or\n// an error if unable to parse the version. Only parses valid semantic versions.\n// Performs checking that can find errors within the version.\n// If you want to coerce a version such as 1 or 1.2 and parse it as the 1.x\n// releases of semver did, use the NewVersion() function.\nfunc StrictNewVersion(v string) (*Version, error) {\n\t// Parsing here does not use RegEx in order to increase performance and reduce\n\t// allocations.\n\n\tif len(v) == 0 {\n\t\treturn nil, ErrEmptyString\n\t}\n\n\t// Split the parts into [0]major, [1]minor, and [2]patch,prerelease,build\n\tparts := strings.SplitN(v, \".\", 3)\n\tif len(parts) != 3 {\n\t\treturn nil, ErrInvalidSemVer\n\t}\n\n\tsv := &Version{\n\t\toriginal: v,\n\t}\n\n\t// Extract build metadata\n\tif strings.Contains(parts[2], \"+\") {\n\t\textra := strings.SplitN(parts[2], \"+\", 2)\n\t\tsv.metadata = extra[1]\n\t\tparts[2] = extra[0]\n\t\tif err := validateMetadata(sv.metadata); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\t// Extract build prerelease\n\tif strings.Contains(parts[2], \"-\") {\n\t\textra := strings.SplitN(parts[2], \"-\", 2)\n\t\tsv.pre = extra[1]\n\t\tparts[2] = extra[0]\n\t\tif err := validatePrerelease(sv.pre); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\t// Validate the number segments are valid. This includes only having positive\n\t// numbers and no leading 0's.\n\tfor _, p := range parts {\n\t\tif !containsOnly(p, num) {\n\t\t\treturn nil, ErrInvalidCharacters\n\t\t}\n\n\t\tif len(p) > 1 && p[0] == '0' {\n\t\t\treturn nil, ErrSegmentStartsZero\n\t\t}\n\t}\n\n\t// Extract major, minor, and patch\n\tvar err error\n\tsv.major, err = strconv.ParseUint(parts[0], 10, 64)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tsv.minor, err = strconv.ParseUint(parts[1], 10, 64)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tsv.patch, err = strconv.ParseUint(parts[2], 10, 64)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn sv, nil\n}\n\n// NewVersion parses a given version and returns an instance of Version or\n// an error if unable to parse the version. If the version is SemVer-ish it\n// attempts to convert it to SemVer. If you want to validate it was a strict\n// semantic version at parse time see StrictNewVersion().\nfunc NewVersion(v string) (*Version, error) {\n\tif CoerceNewVersion {\n\t\treturn coerceNewVersion(v)\n\t}\n\tm := versionRegex.FindStringSubmatch(v)\n\tif m == nil {\n\n\t\t// Disabling detailed errors is first so that it is in the fast path.\n\t\tif !DetailedNewVersionErrors {\n\t\t\treturn nil, ErrInvalidSemVer\n\t\t}\n\n\t\t// Check for specific errors with the semver string and return a more detailed\n\t\t// error.\n\t\tm = looseVersionRegex.FindStringSubmatch(v)\n\t\tif m == nil {\n\t\t\treturn nil, ErrInvalidSemVer\n\t\t}\n\t\terr := validateVersion(m)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn nil, ErrInvalidSemVer\n\t}\n\n\tsv := &Version{\n\t\tmetadata: m[5],\n\t\tpre: m[4],\n\t\toriginal: v,\n\t}\n\n\tvar err error\n\tsv.major, err = strconv.ParseUint(m[1], 10, 64)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error parsing version segment: %w\", err)\n\t}\n\n\tif m[2] != \"\" {\n\t\tsv.minor, err = strconv.ParseUint(m[2], 10, 64)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error parsing version segment: %w\", err)\n\t\t}\n\t} else {\n\t\tsv.minor = 0\n\t}\n\n\tif m[3] != \"\" {\n\t\tsv.patch, err = strconv.ParseUint(m[3], 10, 64)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error parsing version segment: %w\", err)\n\t\t}\n\t} else {\n\t\tsv.patch = 0\n\t}\n\n\t// Perform some basic due diligence on the extra parts to ensure they are\n\t// valid.\n\n\tif sv.pre != \"\" {\n\t\tif err = validatePrerelease(sv.pre); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\tif sv.metadata != \"\" {\n\t\tif err = validateMetadata(sv.metadata); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\treturn sv, nil\n}\n\nfunc coerceNewVersion(v string) (*Version, error) {\n\tm := looseVersionRegex.FindStringSubmatch(v)\n\tif m == nil {\n\t\treturn nil, ErrInvalidSemVer\n\t}\n\n\tsv := &Version{\n\t\tmetadata: m[8],\n\t\tpre: m[5],\n\t\toriginal: v,\n\t}\n\n\tvar err error\n\tsv.major, err = strconv.ParseUint(m[1], 10, 64)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"error parsing version segment: %w\", err)\n\t}\n\n\tif m[2] != \"\" {\n\t\tsv.minor, err = strconv.ParseUint(strings.TrimPrefix(m[2], \".\"), 10, 64)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error parsing version segment: %w\", err)\n\t\t}\n\t} else {\n\t\tsv.minor = 0\n\t}\n\n\tif m[3] != \"\" {\n\t\tsv.patch, err = strconv.ParseUint(strings.TrimPrefix(m[3], \".\"), 10, 64)\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"error parsing version segment: %w\", err)\n\t\t}\n\t} else {\n\t\tsv.patch = 0\n\t}\n\n\t// Perform some basic due diligence on the extra parts to ensure they are\n\t// valid.\n\n\tif sv.pre != \"\" {\n\t\tif err = validatePrerelease(sv.pre); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\tif sv.metadata != \"\" {\n\t\tif err = validateMetadata(sv.metadata); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\treturn sv, nil\n}\n\n// New creates a new instance of Version with each of the parts passed in as\n// arguments instead of parsing a version string.\nfunc New(major, minor, patch uint64, pre, metadata string) *Version {\n\tv := Version{\n\t\tmajor: major,\n\t\tminor: minor,\n\t\tpatch: patch,\n\t\tpre: pre,\n\t\tmetadata: metadata,\n\t\toriginal: \"\",\n\t}\n\n\tv.original = v.String()\n\n\treturn &v\n}\n\n// MustParse parses a given version and panics on error.\nfunc MustParse(v string) *Version {\n\tsv, err := NewVersion(v)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treturn sv\n}\n\n// String converts a Version object to a string.\n// Note, if the original version contained a leading v this version will not.\n// See the Original() method to retrieve the original value. Semantic Versions\n// don't contain a leading v per the spec. Instead it's optional on\n// implementation.\nfunc (v Version) String() string {\n\tvar buf bytes.Buffer\n\n\tfmt.Fprintf(&buf, \"%d.%d.%d\", v.major, v.minor, v.patch)\n\tif v.pre != \"\" {\n\t\tfmt.Fprintf(&buf, \"-%s\", v.pre)\n\t}\n\tif v.metadata != \"\" {\n\t\tfmt.Fprintf(&buf, \"+%s\", v.metadata)\n\t}\n\n\treturn buf.String()\n}\n\n// Original returns the original value passed in to be parsed.\nfunc (v *Version) Original() string {\n\treturn v.original\n}\n\n// Major returns the major version.\nfunc (v Version) Major() uint64 {\n\treturn v.major\n}\n\n// Minor returns the minor version.\nfunc (v Version) Minor() uint64 {\n\treturn v.minor\n}\n\n// Patch returns the patch version.\nfunc (v Version) Patch() uint64 {\n\treturn v.patch\n}\n\n// Prerelease returns the pre-release version.\nfunc (v Version) Prerelease() string {\n\treturn v.pre\n}\n\n// Metadata returns the metadata on the version.\nfunc (v Version) Metadata() string {\n\treturn v.metadata\n}\n\n// originalVPrefix returns the original 'v' prefix if any.\nfunc (v Version) originalVPrefix() string {\n\t// Note, only lowercase v is supported as a prefix by the parser.\n\tif v.original != \"\" && v.original[:1] == \"v\" {\n\t\treturn v.original[:1]\n\t}\n\treturn \"\"\n}\n\n// IncPatch produces the next patch version.\n// If the current version does not have prerelease/metadata information,\n// it unsets metadata and prerelease values, increments patch number.\n// If the current version has any of prerelease or metadata information,\n// it unsets both values and keeps current patch value\nfunc (v Version) IncPatch() Version {\n\tvNext := v\n\t// according to http://semver.org/#spec-item-9\n\t// Pre-release versions have a lower precedence than the associated normal version.\n\t// according to http://semver.org/#spec-item-10\n\t// Build metadata SHOULD be ignored when determining version precedence.\n\tif v.pre != \"\" {\n\t\tvNext.metadata = \"\"\n\t\tvNext.pre = \"\"\n\t} else {\n\t\tvNext.metadata = \"\"\n\t\tvNext.pre = \"\"\n\t\tvNext.patch = v.patch + 1\n\t}\n\tvNext.original = v.originalVPrefix() + \"\" + vNext.String()\n\treturn vNext\n}\n\n// IncMinor produces the next minor version.\n// Sets patch to 0.\n// Increments minor number.\n// Unsets metadata.\n// Unsets prerelease status.\nfunc (v Version) IncMinor() Version {\n\tvNext := v\n\tvNext.metadata = \"\"\n\tvNext.pre = \"\"\n\tvNext.patch = 0\n\tvNext.minor = v.minor + 1\n\tvNext.original = v.originalVPrefix() + \"\" + vNext.String()\n\treturn vNext\n}\n\n// IncMajor produces the next major version.\n// Sets patch to 0.\n// Sets minor to 0.\n// Increments major number.\n// Unsets metadata.\n// Unsets prerelease status.\nfunc (v Version) IncMajor() Version {\n\tvNext := v\n\tvNext.metadata = \"\"\n\tvNext.pre = \"\"\n\tvNext.patch = 0\n\tvNext.minor = 0\n\tvNext.major = v.major + 1\n\tvNext.original = v.originalVPrefix() + \"\" + vNext.String()\n\treturn vNext\n}\n\n// SetPrerelease defines the prerelease value.\n// Value must not include the required 'hyphen' prefix.\nfunc (v Version) SetPrerelease(prerelease string) (Version, error) {\n\tvNext := v\n\tif len(prerelease) > 0 {\n\t\tif err := validatePrerelease(prerelease); err != nil {\n\t\t\treturn vNext, err\n\t\t}\n\t}\n\tvNext.pre = prerelease\n\tvNext.original = v.originalVPrefix() + \"\" + vNext.String()\n\treturn vNext, nil\n}\n\n// SetMetadata defines metadata value.\n// Value must not include the required 'plus' prefix.\nfunc (v Version) SetMetadata(metadata string) (Version, error) {\n\tvNext := v\n\tif len(metadata) > 0 {\n\t\tif err := validateMetadata(metadata); err != nil {\n\t\t\treturn vNext, err\n\t\t}\n\t}\n\tvNext.metadata = metadata\n\tvNext.original = v.originalVPrefix() + \"\" + vNext.String()\n\treturn vNext, nil\n}\n\n// LessThan tests if one version is less than another one.\nfunc (v *Version) LessThan(o *Version) bool {\n\treturn v.Compare(o) < 0\n}\n\n// LessThanEqual tests if one version is less or equal than another one.\nfunc (v *Version) LessThanEqual(o *Version) bool {\n\treturn v.Compare(o) <= 0\n}\n\n// GreaterThan tests if one version is greater than another one.\nfunc (v *Version) GreaterThan(o *Version) bool {\n\treturn v.Compare(o) > 0\n}\n\n// GreaterThanEqual tests if one version is greater or equal than another one.\nfunc (v *Version) GreaterThanEqual(o *Version) bool {\n\treturn v.Compare(o) >= 0\n}\n\n// Equal tests if two versions are equal to each other.\n// Note, versions can be equal with different metadata since metadata\n// is not considered part of the comparable version.\nfunc (v *Version) Equal(o *Version) bool {\n\tif v == o {\n\t\treturn true\n\t}\n\tif v == nil || o == nil {\n\t\treturn false\n\t}\n\treturn v.Compare(o) == 0\n}\n\n// Compare compares this version to another one. It returns -1, 0, or 1 if\n// the version smaller, equal, or larger than the other version.\n//\n// Versions are compared by X.Y.Z. Build metadata is ignored. Prerelease is\n// lower than the version without a prerelease. Compare always takes into account\n// prereleases. If you want to work with ranges using typical range syntaxes that\n// skip prereleases if the range is not looking for them use constraints.\nfunc (v *Version) Compare(o *Version) int {\n\t// Compare the major, minor, and patch version for differences. If a\n\t// difference is found return the comparison.\n\tif d := compareSegment(v.Major(), o.Major()); d != 0 {\n\t\treturn d\n\t}\n\tif d := compareSegment(v.Minor(), o.Minor()); d != 0 {\n\t\treturn d\n\t}\n\tif d := compareSegment(v.Patch(), o.Patch()); d != 0 {\n\t\treturn d\n\t}\n\n\t// At this point the major, minor, and patch versions are the same.\n\tps := v.pre\n\tpo := o.Prerelease()\n\n\tif ps == \"\" && po == \"\" {\n\t\treturn 0\n\t}\n\tif ps == \"\" {\n\t\treturn 1\n\t}\n\tif po == \"\" {\n\t\treturn -1\n\t}\n\n\treturn comparePrerelease(ps, po)\n}\n\n// UnmarshalJSON implements JSON.Unmarshaler interface.\nfunc (v *Version) UnmarshalJSON(b []byte) error {\n\tvar s string\n\tif err := json.Unmarshal(b, &s); err != nil {\n\t\treturn err\n\t}\n\ttemp, err := NewVersion(s)\n\tif err != nil {\n\t\treturn err\n\t}\n\tv.major = temp.major\n\tv.minor = temp.minor\n\tv.patch = temp.patch\n\tv.pre = temp.pre\n\tv.metadata = temp.metadata\n\tv.original = temp.original\n\treturn nil\n}\n\n// MarshalJSON implements JSON.Marshaler interface.\nfunc (v Version) MarshalJSON() ([]byte, error) {\n\treturn json.Marshal(v.String())\n}\n\n// UnmarshalText implements the encoding.TextUnmarshaler interface.\nfunc (v *Version) UnmarshalText(text []byte) error {\n\ttemp, err := NewVersion(string(text))\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t*v = *temp\n\n\treturn nil\n}\n\n// MarshalText implements the encoding.TextMarshaler interface.\nfunc (v Version) MarshalText() ([]byte, error) {\n\treturn []byte(v.String()), nil\n}\n\n// Scan implements the SQL.Scanner interface.\nfunc (v *Version) Scan(value interface{}) error {\n\tvar s string\n\ts, _ = value.(string)\n\ttemp, err := NewVersion(s)\n\tif err != nil {\n\t\treturn err\n\t}\n\tv.major = temp.major\n\tv.minor = temp.minor\n\tv.patch = temp.patch\n\tv.pre = temp.pre\n\tv.metadata = temp.metadata\n\tv.original = temp.original\n\treturn nil\n}\n\n// Value implements the Driver.Valuer interface.\nfunc (v Version) Value() (driver.Value, error) {\n\treturn v.String(), nil\n}\n\nfunc compareSegment(v, o uint64) int {\n\tif v < o {\n\t\treturn -1\n\t}\n\tif v > o {\n\t\treturn 1\n\t}\n\n\treturn 0\n}\n\nfunc comparePrerelease(v, o string) int {\n\t// split the prelease versions by their part. The separator, per the spec,\n\t// is a .\n\tsparts := strings.Split(v, \".\")\n\toparts := strings.Split(o, \".\")\n\n\t// Find the longer length of the parts to know how many loop iterations to\n\t// go through.\n\tslen := len(sparts)\n\tolen := len(oparts)\n\n\tl := slen\n\tif olen > slen {\n\t\tl = olen\n\t}\n\n\t// Iterate over each part of the prereleases to compare the differences.\n\tfor i := 0; i < l; i++ {\n\t\t// Since the lentgh of the parts can be different we need to create\n\t\t// a placeholder. This is to avoid out of bounds issues.\n\t\tstemp := \"\"\n\t\tif i < slen {\n\t\t\tstemp = sparts[i]\n\t\t}\n\n\t\totemp := \"\"\n\t\tif i < olen {\n\t\t\totemp = oparts[i]\n\t\t}\n\n\t\td := comparePrePart(stemp, otemp)\n\t\tif d != 0 {\n\t\t\treturn d\n\t\t}\n\t}\n\n\t// Reaching here means two versions are of equal value but have different\n\t// metadata (the part following a +). They are not identical in string form\n\t// but the version comparison finds them to be equal.\n\treturn 0\n}\n\nfunc comparePrePart(s, o string) int {\n\t// Fastpath if they are equal\n\tif s == o {\n\t\treturn 0\n\t}\n\n\t// When s or o are empty we can use the other in an attempt to determine\n\t// the response.\n\tif s == \"\" {\n\t\tif o != \"\" {\n\t\t\treturn -1\n\t\t}\n\t\treturn 1\n\t}\n\n\tif o == \"\" {\n\t\tif s != \"\" {\n\t\t\treturn 1\n\t\t}\n\t\treturn -1\n\t}\n\n\t// When comparing strings \"99\" is greater than \"103\". To handle\n\t// cases like this we need to detect numbers and compare them. According\n\t// to the semver spec, numbers are always positive. If there is a - at the\n\t// start like -99 this is to be evaluated as an alphanum. numbers always\n\t// have precedence over alphanum. Parsing as Uints because negative numbers\n\t// are ignored.\n\n\toi, n1 := strconv.ParseUint(o, 10, 64)\n\tsi, n2 := strconv.ParseUint(s, 10, 64)\n\n\t// The case where both are strings compare the strings\n\tif n1 != nil && n2 != nil {\n\t\tif s > o {\n\t\t\treturn 1\n\t\t}\n\t\treturn -1\n\t} else if n1 != nil {\n\t\t// o is a string and s is a number\n\t\treturn -1\n\t} else if n2 != nil {\n\t\t// s is a string and o is a number\n\t\treturn 1\n\t}\n\t// Both are numbers\n\tif si > oi {\n\t\treturn 1\n\t}\n\treturn -1\n}\n\n// Like strings.ContainsAny but does an only instead of any.\nfunc containsOnly(s string, comp string) bool {\n\treturn strings.IndexFunc(s, func(r rune) bool {\n\t\treturn !strings.ContainsRune(comp, r)\n\t}) == -1\n}\n\n// From the spec, \"Identifiers MUST comprise only\n// ASCII alphanumerics and hyphen [0-9A-Za-z-]. Identifiers MUST NOT be empty.\n// Numeric identifiers MUST NOT include leading zeroes.\". These segments can\n// be dot separated.\nfunc validatePrerelease(p string) error {\n\teparts := strings.Split(p, \".\")\n\tfor _, p := range eparts {\n\t\tif p == \"\" {\n\t\t\treturn ErrInvalidPrerelease\n\t\t} else if containsOnly(p, num) {\n\t\t\tif len(p) > 1 && p[0] == '0' {\n\t\t\t\treturn ErrSegmentStartsZero\n\t\t\t}\n\t\t} else if !containsOnly(p, allowed) {\n\t\t\treturn ErrInvalidPrerelease\n\t\t}\n\t}\n\n\treturn nil\n}\n\n// From the spec, \"Build metadata MAY be denoted by\n// appending a plus sign and a series of dot separated identifiers immediately\n// following the patch or pre-release version. Identifiers MUST comprise only\n// ASCII alphanumerics and hyphen [0-9A-Za-z-]. Identifiers MUST NOT be empty.\"\nfunc validateMetadata(m string) error {\n\teparts := strings.Split(m, \".\")\n\tfor _, p := range eparts {\n\t\tif p == \"\" {\n\t\t\treturn ErrInvalidMetadata\n\t\t} else if !containsOnly(p, allowed) {\n\t\t\treturn ErrInvalidMetadata\n\t\t}\n\t}\n\treturn nil\n}\n\n// validateVersion checks for common validation issues but may not catch all errors\nfunc validateVersion(m []string) error {\n\tvar err error\n\tvar v string\n\tif m[1] != \"\" {\n\t\tif len(m[1]) > 1 && m[1][0] == '0' {\n\t\t\treturn ErrSegmentStartsZero\n\t\t}\n\t\t_, err = strconv.ParseUint(m[1], 10, 64)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"error parsing version segment: %w\", err)\n\t\t}\n\t}\n\n\tif m[2] != \"\" {\n\t\tv = strings.TrimPrefix(m[2], \".\")\n\t\tif len(v) > 1 && v[0] == '0' {\n\t\t\treturn ErrSegmentStartsZero\n\t\t}\n\t\t_, err = strconv.ParseUint(v, 10, 64)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"error parsing version segment: %w\", err)\n\t\t}\n\t}\n\n\tif m[3] != \"\" {\n\t\tv = strings.TrimPrefix(m[3], \".\")\n\t\tif len(v) > 1 && v[0] == '0' {\n\t\t\treturn ErrSegmentStartsZero\n\t\t}\n\t\t_, err = strconv.ParseUint(v, 10, 64)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"error parsing version segment: %w\", err)\n\t\t}\n\t}\n\n\tif m[5] != \"\" {\n\t\tif err = validatePrerelease(m[5]); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\tif m[8] != \"\" {\n\t\tif err = validateMetadata(m[8]); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/.golangci.yaml",
"content": "version: \"2\"\n\nrun:\n timeout: 1m\n tests: true\n\nlinters:\n default: none\n enable: # please keep this alphabetized\n - asasalint\n - asciicheck\n - copyloopvar\n - dupl\n - errcheck\n - forcetypeassert\n - goconst\n - gocritic\n - govet\n - ineffassign\n - misspell\n - musttag\n - revive\n - staticcheck\n - unused\n\nissues:\n max-issues-per-linter: 0\n max-same-issues: 10\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/CHANGELOG.md",
"content": "# CHANGELOG\n\n## v1.0.0-rc1\n\nThis is the first logged release. Major changes (including breaking changes)\nhave occurred since earlier tags.\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/CONTRIBUTING.md",
"content": "# Contributing\n\nLogr is open to pull-requests, provided they fit within the intended scope of\nthe project. Specifically, this library aims to be VERY small and minimalist,\nwith no external dependencies.\n\n## Compatibility\n\nThis project intends to follow [semantic versioning](http://semver.org) and\nis very strict about compatibility. Any proposed changes MUST follow those\nrules.\n\n## Performance\n\nAs a logging library, logr must be as light-weight as possible. Any proposed\ncode change must include results of running the [benchmark](./benchmark)\nbefore and after the change.\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/LICENSE",
"content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"{}\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright {yyyy} {name of copyright owner}\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/README.md",
"content": "# A minimal logging API for Go\n\n[](https://pkg.go.dev/github.com/go-logr/logr)\n[](https://goreportcard.com/report/github.com/go-logr/logr)\n[](https://securityscorecards.dev/viewer/?platform=github.com&org=go-logr&repo=logr)\n\nlogr offers an(other) opinion on how Go programs and libraries can do logging\nwithout becoming coupled to a particular logging implementation. This is not\nan implementation of logging - it is an API. In fact it is two APIs with two\ndifferent sets of users.\n\nThe `Logger` type is intended for application and library authors. It provides\na relatively small API which can be used everywhere you want to emit logs. It\ndefers the actual act of writing logs (to files, to stdout, or whatever) to the\n`LogSink` interface.\n\nThe `LogSink` interface is intended for logging library implementers. It is a\npure interface which can be implemented by logging frameworks to provide the actual logging\nfunctionality.\n\nThis decoupling allows application and library developers to write code in\nterms of `logr.Logger` (which has very low dependency fan-out) while the\nimplementation of logging is managed \"up stack\" (e.g. in or near `main()`.)\nApplication developers can then switch out implementations as necessary.\n\nMany people assert that libraries should not be logging, and as such efforts\nlike this are pointless. Those people are welcome to convince the authors of\nthe tens-of-thousands of libraries that *DO* write logs that they are all\nwrong. In the meantime, logr takes a more practical approach.\n\n## Typical usage\n\nSomewhere, early in an application's life, it will make a decision about which\nlogging library (implementation) it actually wants to use. Something like:\n\n```\n func main() {\n // ... other setup code ...\n\n // Create the \"root\" logger. We have chosen the \"logimpl\" implementation,\n // which takes some initial parameters and returns a logr.Logger.\n logger := logimpl.New(param1, param2)\n\n // ... other setup code ...\n```\n\nMost apps will call into other libraries, create structures to govern the flow,\netc. The `logr.Logger` object can be passed to these other libraries, stored\nin structs, or even used as a package-global variable, if needed. For example:\n\n```\n app := createTheAppObject(logger)\n app.Run()\n```\n\nOutside of this early setup, no other packages need to know about the choice of\nimplementation. They write logs in terms of the `logr.Logger` that they\nreceived:\n\n```\n type appObject struct {\n // ... other fields ...\n logger logr.Logger\n // ... other fields ...\n }\n\n func (app *appObject) Run() {\n app.logger.Info(\"starting up\", \"timestamp\", time.Now())\n\n // ... app code ...\n```\n\n## Background\n\nIf the Go standard library had defined an interface for logging, this project\nprobably would not be needed. Alas, here we are.\n\nWhen the Go developers started developing such an interface with\n[slog](https://github.com/golang/go/issues/56345), they adopted some of the\nlogr design but also left out some parts and changed others:\n\n| Feature | logr | slog |\n|---------|------|------|\n| High-level API | `Logger` (passed by value) | `Logger` (passed by [pointer](https://github.com/golang/go/issues/59126)) |\n| Low-level API | `LogSink` | `Handler` |\n| Stack unwinding | done by `LogSink` | done by `Logger` |\n| Skipping helper functions | `WithCallDepth`, `WithCallStackHelper` | [not supported by Logger](https://github.com/golang/go/issues/59145) |\n| Generating a value for logging on demand | `Marshaler` | `LogValuer` |\n| Log levels | >= 0, higher meaning \"less important\" | positive and negative, with 0 for \"info\" and higher meaning \"more important\" |\n| Error log entries | always logged, don't have a verbosity level | normal log entries with level >= `LevelError` |\n| Passing logger via context | `NewContext`, `FromContext` | no API |\n| Adding a name to a logger | `WithName` | no API |\n| Modify verbosity of log entries in a call chain | `V` | no API |\n| Grouping of key/value pairs | not supported | `WithGroup`, `GroupValue` |\n| Pass context for extracting additional values | no API | API variants like `InfoCtx` |\n\nThe high-level slog API is explicitly meant to be one of many different APIs\nthat can be layered on top of a shared `slog.Handler`. logr is one such\nalternative API, with [interoperability](#slog-interoperability) provided by\nsome conversion functions.\n\n### Inspiration\n\nBefore you consider this package, please read [this blog post by the\ninimitable Dave Cheney][warning-makes-no-sense]. We really appreciate what\nhe has to say, and it largely aligns with our own experiences.\n\n### Differences from Dave's ideas\n\nThe main differences are:\n\n1. Dave basically proposes doing away with the notion of a logging API in favor\nof `fmt.Printf()`. We disagree, especially when you consider things like output\nlocations, timestamps, file and line decorations, and structured logging. This\npackage restricts the logging API to just 2 types of logs: info and error.\n\nInfo logs are things you want to tell the user which are not errors. Error\nlogs are, well, errors. If your code receives an `error` from a subordinate\nfunction call and is logging that `error` *and not returning it*, use error\nlogs.\n\n2. Verbosity-levels on info logs. This gives developers a chance to indicate\narbitrary grades of importance for info logs, without assigning names with\nsemantic meaning such as \"warning\", \"trace\", and \"debug.\" Superficially this\nmay feel very similar, but the primary difference is the lack of semantics.\nBecause verbosity is a numerical value, it's safe to assume that an app running\nwith higher verbosity means more (and less important) logs will be generated.\n\n## Implementations (non-exhaustive)\n\nThere are implementations for the following logging libraries:\n\n- **a function** (can bridge to non-structured libraries): [funcr](https://github.com/go-logr/logr/tree/master/funcr)\n- **a testing.T** (for use in Go tests, with JSON-like output): [testr](https://github.com/go-logr/logr/tree/master/testr)\n- **github.com/google/glog**: [glogr](https://github.com/go-logr/glogr)\n- **k8s.io/klog** (for Kubernetes): [klogr](https://git.k8s.io/klog/klogr)\n- **a testing.T** (with klog-like text output): [ktesting](https://git.k8s.io/klog/ktesting)\n- **go.uber.org/zap**: [zapr](https://github.com/go-logr/zapr)\n- **log** (the Go standard library logger): [stdr](https://github.com/go-logr/stdr)\n- **github.com/sirupsen/logrus**: [logrusr](https://github.com/bombsimon/logrusr)\n- **github.com/wojas/genericr**: [genericr](https://github.com/wojas/genericr) (makes it easy to implement your own backend)\n- **logfmt** (Heroku style [logging](https://www.brandur.org/logfmt)): [logfmtr](https://github.com/iand/logfmtr)\n- **github.com/rs/zerolog**: [zerologr](https://github.com/go-logr/zerologr)\n- **github.com/go-kit/log**: [gokitlogr](https://github.com/tonglil/gokitlogr) (also compatible with github.com/go-kit/kit/log since v0.12.0)\n- **bytes.Buffer** (writing to a buffer): [bufrlogr](https://github.com/tonglil/buflogr) (useful for ensuring values were logged, like during testing)\n\n## slog interoperability\n\nInteroperability goes both ways, using the `logr.Logger` API with a `slog.Handler`\nand using the `slog.Logger` API with a `logr.LogSink`. `FromSlogHandler` and\n`ToSlogHandler` convert between a `logr.Logger` and a `slog.Handler`.\nAs usual, `slog.New` can be used to wrap such a `slog.Handler` in the high-level\nslog API.\n\n### Using a `logr.LogSink` as backend for slog\n\nIdeally, a logr sink implementation should support both logr and slog by\nimplementing both the normal logr interface(s) and `SlogSink`. Because\nof a conflict in the parameters of the common `Enabled` method, it is [not\npossible to implement both slog.Handler and logr.Sink in the same\ntype](https://github.com/golang/go/issues/59110).\n\nIf both are supported, log calls can go from the high-level APIs to the backend\nwithout the need to convert parameters. `FromSlogHandler` and `ToSlogHandler` can\nconvert back and forth without adding additional wrappers, with one exception:\nwhen `Logger.V` was used to adjust the verbosity for a `slog.Handler`, then\n`ToSlogHandler` has to use a wrapper which adjusts the verbosity for future\nlog calls.\n\nSuch an implementation should also support values that implement specific\ninterfaces from both packages for logging (`logr.Marshaler`, `slog.LogValuer`,\n`slog.GroupValue`). logr does not convert those.\n\nNot supporting slog has several drawbacks:\n- Recording source code locations works correctly if the handler gets called\n through `slog.Logger`, but may be wrong in other cases. That's because a\n `logr.Sink` does its own stack unwinding instead of using the program counter\n provided by the high-level API.\n- slog levels <= 0 can be mapped to logr levels by negating the level without a\n loss of information. But all slog levels > 0 (e.g. `slog.LevelWarning` as\n used by `slog.Logger.Warn`) must be mapped to 0 before calling the sink\n because logr does not support \"more important than info\" levels.\n- The slog group concept is supported by prefixing each key in a key/value\n pair with the group names, separated by a dot. For structured output like\n JSON it would be better to group the key/value pairs inside an object.\n- Special slog values and interfaces don't work as expected.\n- The overhead is likely to be higher.\n\nThese drawbacks are severe enough that applications using a mixture of slog and\nlogr should switch to a different backend.\n\n### Using a `slog.Handler` as backend for logr\n\nUsing a plain `slog.Handler` without support for logr works better than the\nother direction:\n- All logr verbosity levels can be mapped 1:1 to their corresponding slog level\n by negating them.\n- Stack unwinding is done by the `SlogSink` and the resulting program\n counter is passed to the `slog.Handler`.\n- Names added via `Logger.WithName` are gathered and recorded in an additional\n attribute with `logger` as key and the names separated by slash as value.\n- `Logger.Error` is turned into a log record with `slog.LevelError` as level\n and an additional attribute with `err` as key, if an error was provided.\n\nThe main drawback is that `logr.Marshaler` will not be supported. Types should\nideally support both `logr.Marshaler` and `slog.Valuer`. If compatibility\nwith logr implementations without slog support is not important, then\n`slog.Valuer` is sufficient.\n\n### Context support for slog\n\nStoring a logger in a `context.Context` is not supported by\nslog. `NewContextWithSlogLogger` and `FromContextAsSlogLogger` can be\nused to fill this gap. They store and retrieve a `slog.Logger` pointer\nunder the same context key that is also used by `NewContext` and\n`FromContext` for `logr.Logger` value.\n\nWhen `NewContextWithSlogLogger` is followed by `FromContext`, the latter will\nautomatically convert the `slog.Logger` to a\n`logr.Logger`. `FromContextAsSlogLogger` does the same for the other direction.\n\nWith this approach, binaries which use either slog or logr are as efficient as\npossible with no unnecessary allocations. This is also why the API stores a\n`slog.Logger` pointer: when storing a `slog.Handler`, creating a `slog.Logger`\non retrieval would need to allocate one.\n\nThe downside is that switching back and forth needs more allocations. Because\nlogr is the API that is already in use by different packages, in particular\nKubernetes, the recommendation is to use the `logr.Logger` API in code which\nuses contextual logging.\n\nAn alternative to adding values to a logger and storing that logger in the\ncontext is to store the values in the context and to configure a logging\nbackend to extract those values when emitting log entries. This only works when\nlog calls are passed the context, which is not supported by the logr API.\n\nWith the slog API, it is possible, but not\nrequired. https://github.com/veqryn/slog-context is a package for slog which\nprovides additional support code for this approach. It also contains wrappers\nfor the context functions in logr, so developers who prefer to not use the logr\nAPIs directly can use those instead and the resulting code will still be\ninteroperable with logr.\n\n## FAQ\n\n### Conceptual\n\n#### Why structured logging?\n\n- **Structured logs are more easily queryable**: Since you've got\n key-value pairs, it's much easier to query your structured logs for\n particular values by filtering on the contents of a particular key --\n think searching request logs for error codes, Kubernetes reconcilers for\n the name and namespace of the reconciled object, etc.\n\n- **Structured logging makes it easier to have cross-referenceable logs**:\n Similarly to searchability, if you maintain conventions around your\n keys, it becomes easy to gather all log lines related to a particular\n concept.\n\n- **Structured logs allow better dimensions of filtering**: if you have\n structure to your logs, you've got more precise control over how much\n information is logged -- you might choose in a particular configuration\n to log certain keys but not others, only log lines where a certain key\n matches a certain value, etc., instead of just having v-levels and names\n to key off of.\n\n- **Structured logs better represent structured data**: sometimes, the\n data that you want to log is inherently structured (think tuple-link\n objects.) Structured logs allow you to preserve that structure when\n outputting.\n\n#### Why V-levels?\n\n**V-levels give operators an easy way to control the chattiness of log\noperations**. V-levels provide a way for a given package to distinguish\nthe relative importance or verbosity of a given log message. Then, if\na particular logger or package is logging too many messages, the user\nof the package can simply change the v-levels for that library.\n\n#### Why not named levels, like Info/Warning/Error?\n\nRead [Dave Cheney's post][warning-makes-no-sense]. Then read [Differences\nfrom Dave's ideas](#differences-from-daves-ideas).\n\n#### Why not allow format strings, too?\n\n**Format strings negate many of the benefits of structured logs**:\n\n- They're not easily searchable without resorting to fuzzy searching,\n regular expressions, etc.\n\n- They don't store structured data well, since contents are flattened into\n a string.\n\n- They're not cross-referenceable.\n\n- They don't compress easily, since the message is not constant.\n\n(Unless you turn positional parameters into key-value pairs with numerical\nkeys, at which point you've gotten key-value logging with meaningless\nkeys.)\n\n### Practical\n\n#### Why key-value pairs, and not a map?\n\nKey-value pairs are *much* easier to optimize, especially around\nallocations. Zap (a structured logger that inspired logr's interface) has\n[performance measurements](https://github.com/uber-go/zap#performance)\nthat show this quite nicely.\n\nWhile the interface ends up being a little less obvious, you get\npotentially better performance, plus avoid making users type\n`map[string]string{}` every time they want to log.\n\n#### What if my V-levels differ between libraries?\n\nThat's fine. Control your V-levels on a per-logger basis, and use the\n`WithName` method to pass different loggers to different libraries.\n\nGenerally, you should take care to ensure that you have relatively\nconsistent V-levels within a given logger, however, as this makes deciding\non what verbosity of logs to request easier.\n\n#### But I really want to use a format string!\n\nThat's not actually a question. Assuming your question is \"how do\nI convert my mental model of logging with format strings to logging with\nconstant messages\":\n\n1. Figure out what the error actually is, as you'd write in a TL;DR style,\n and use that as a message.\n\n2. For every place you'd write a format specifier, look to the word before\n it, and add that as a key value pair.\n\nFor instance, consider the following examples (all taken from spots in the\nKubernetes codebase):\n\n- `klog.V(4).Infof(\"Client is returning errors: code %v, error %v\",\n responseCode, err)` becomes `logger.Error(err, \"client returned an\n error\", \"code\", responseCode)`\n\n- `klog.V(4).Infof(\"Got a Retry-After %ds response for attempt %d to %v\",\n seconds, retries, url)` becomes `logger.V(4).Info(\"got a retry-after\n response when requesting url\", \"attempt\", retries, \"after\n seconds\", seconds, \"url\", url)`\n\nIf you *really* must use a format string, use it in a key's value, and\ncall `fmt.Sprintf` yourself. For instance: `log.Printf(\"unable to\nreflect over type %T\")` becomes `logger.Info(\"unable to reflect over\ntype\", \"type\", fmt.Sprintf(\"%T\"))`. In general though, the cases where\nthis is necessary should be few and far between.\n\n#### How do I choose my V-levels?\n\nThis is basically the only hard constraint: increase V-levels to denote\nmore verbose or more debug-y logs.\n\nOtherwise, you can start out with `0` as \"you always want to see this\",\n`1` as \"common logging that you might *possibly* want to turn off\", and\n`10` as \"I would like to performance-test your log collection stack.\"\n\nThen gradually choose levels in between as you need them, working your way\ndown from 10 (for debug and trace style logs) and up from 1 (for chattier\ninfo-type logs). For reference, slog pre-defines -4 for debug logs\n(corresponds to 4 in logr), which matches what is\n[recommended for Kubernetes](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#what-method-to-use).\n\n#### How do I choose my keys?\n\nKeys are fairly flexible, and can hold more or less any string\nvalue. For best compatibility with implementations and consistency\nwith existing code in other projects, there are a few conventions you\nshould consider.\n\n- Make your keys human-readable.\n- Constant keys are generally a good idea.\n- Be consistent across your codebase.\n- Keys should naturally match parts of the message string.\n- Use lower case for simple keys and\n [lowerCamelCase](https://en.wiktionary.org/wiki/lowerCamelCase) for\n more complex ones. Kubernetes is one example of a project that has\n [adopted that\n convention](https://github.com/kubernetes/community/blob/HEAD/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#name-arguments).\n\nWhile key names are mostly unrestricted (and spaces are acceptable),\nit's generally a good idea to stick to printable ascii characters, or at\nleast match the general character set of your log lines.\n\n#### Why should keys be constant values?\n\nThe point of structured logging is to make later log processing easier. Your\nkeys are, effectively, the schema of each log message. If you use different\nkeys across instances of the same log line, you will make your structured logs\nmuch harder to use. `Sprintf()` is for values, not for keys!\n\n#### Why is this not a pure interface?\n\nThe Logger type is implemented as a struct in order to allow the Go compiler to\noptimize things like high-V `Info` logs that are not triggered. Not all of\nthese implementations are implemented yet, but this structure was suggested as\na way to ensure they *can* be implemented. All of the real work is behind the\n`LogSink` interface.\n\n[warning-makes-no-sense]: http://dave.cheney.net/2015/11/05/lets-talk-about-logging\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/SECURITY.md",
"content": "# Security Policy\n\nIf you have discovered a security vulnerability in this project, please report it\nprivately. **Do not disclose it as a public issue.** This gives us time to work with you\nto fix the issue before public exposure, reducing the chance that the exploit will be\nused before a patch is released.\n\nYou may submit the report in the following ways:\n\n- send an email to go-logr-security@googlegroups.com\n- send us a [private vulnerability report](https://github.com/go-logr/logr/security/advisories/new)\n\nPlease provide the following information in your report:\n\n- A description of the vulnerability and its impact\n- How to reproduce the issue\n\nWe ask that you give us 90 days to work on a fix before public exposure.\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/context.go",
"content": "/*\nCopyright 2023 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\npackage logr\n\n// contextKey is how we find Loggers in a context.Context. With Go < 1.21,\n// the value is always a Logger value. With Go >= 1.21, the value can be a\n// Logger value or a slog.Logger pointer.\ntype contextKey struct{}\n\n// notFoundError exists to carry an IsNotFound method.\ntype notFoundError struct{}\n\nfunc (notFoundError) Error() string {\n\treturn \"no logr.Logger was present\"\n}\n\nfunc (notFoundError) IsNotFound() bool {\n\treturn true\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/context_noslog.go",
"content": "//go:build !go1.21\n// +build !go1.21\n\n/*\nCopyright 2019 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\npackage logr\n\nimport (\n\t\"context\"\n)\n\n// FromContext returns a Logger from ctx or an error if no Logger is found.\nfunc FromContext(ctx context.Context) (Logger, error) {\n\tif v, ok := ctx.Value(contextKey{}).(Logger); ok {\n\t\treturn v, nil\n\t}\n\n\treturn Logger{}, notFoundError{}\n}\n\n// FromContextOrDiscard returns a Logger from ctx. If no Logger is found, this\n// returns a Logger that discards all log messages.\nfunc FromContextOrDiscard(ctx context.Context) Logger {\n\tif v, ok := ctx.Value(contextKey{}).(Logger); ok {\n\t\treturn v\n\t}\n\n\treturn Discard()\n}\n\n// NewContext returns a new Context, derived from ctx, which carries the\n// provided Logger.\nfunc NewContext(ctx context.Context, logger Logger) context.Context {\n\treturn context.WithValue(ctx, contextKey{}, logger)\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/context_slog.go",
"content": "//go:build go1.21\n// +build go1.21\n\n/*\nCopyright 2019 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\npackage logr\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log/slog\"\n)\n\n// FromContext returns a Logger from ctx or an error if no Logger is found.\nfunc FromContext(ctx context.Context) (Logger, error) {\n\tv := ctx.Value(contextKey{})\n\tif v == nil {\n\t\treturn Logger{}, notFoundError{}\n\t}\n\n\tswitch v := v.(type) {\n\tcase Logger:\n\t\treturn v, nil\n\tcase *slog.Logger:\n\t\treturn FromSlogHandler(v.Handler()), nil\n\tdefault:\n\t\t// Not reached.\n\t\tpanic(fmt.Sprintf(\"unexpected value type for logr context key: %T\", v))\n\t}\n}\n\n// FromContextAsSlogLogger returns a slog.Logger from ctx or nil if no such Logger is found.\nfunc FromContextAsSlogLogger(ctx context.Context) *slog.Logger {\n\tv := ctx.Value(contextKey{})\n\tif v == nil {\n\t\treturn nil\n\t}\n\n\tswitch v := v.(type) {\n\tcase Logger:\n\t\treturn slog.New(ToSlogHandler(v))\n\tcase *slog.Logger:\n\t\treturn v\n\tdefault:\n\t\t// Not reached.\n\t\tpanic(fmt.Sprintf(\"unexpected value type for logr context key: %T\", v))\n\t}\n}\n\n// FromContextOrDiscard returns a Logger from ctx. If no Logger is found, this\n// returns a Logger that discards all log messages.\nfunc FromContextOrDiscard(ctx context.Context) Logger {\n\tif logger, err := FromContext(ctx); err == nil {\n\t\treturn logger\n\t}\n\treturn Discard()\n}\n\n// NewContext returns a new Context, derived from ctx, which carries the\n// provided Logger.\nfunc NewContext(ctx context.Context, logger Logger) context.Context {\n\treturn context.WithValue(ctx, contextKey{}, logger)\n}\n\n// NewContextWithSlogLogger returns a new Context, derived from ctx, which carries the\n// provided slog.Logger.\nfunc NewContextWithSlogLogger(ctx context.Context, logger *slog.Logger) context.Context {\n\treturn context.WithValue(ctx, contextKey{}, logger)\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/discard.go",
"content": "/*\nCopyright 2020 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\npackage logr\n\n// Discard returns a Logger that discards all messages logged to it. It can be\n// used whenever the caller is not interested in the logs. Logger instances\n// produced by this function always compare as equal.\nfunc Discard() Logger {\n\treturn New(nil)\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/funcr/funcr.go",
"content": "/*\nCopyright 2021 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n// Package funcr implements formatting of structured log messages and\n// optionally captures the call site and timestamp.\n//\n// The simplest way to use it is via its implementation of a\n// github.com/go-logr/logr.LogSink with output through an arbitrary\n// \"write\" function. See New and NewJSON for details.\n//\n// # Custom LogSinks\n//\n// For users who need more control, a funcr.Formatter can be embedded inside\n// your own custom LogSink implementation. This is useful when the LogSink\n// needs to implement additional methods, for example.\n//\n// # Formatting\n//\n// This will respect logr.Marshaler, fmt.Stringer, and error interfaces for\n// values which are being logged. When rendering a struct, funcr will use Go's\n// standard JSON tags (all except \"string\").\npackage funcr\n\nimport (\n\t\"bytes\"\n\t\"encoding\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"path/filepath\"\n\t\"reflect\"\n\t\"runtime\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n\n\t\"github.com/go-logr/logr\"\n)\n\n// New returns a logr.Logger which is implemented by an arbitrary function.\nfunc New(fn func(prefix, args string), opts Options) logr.Logger {\n\treturn logr.New(newSink(fn, NewFormatter(opts)))\n}\n\n// NewJSON returns a logr.Logger which is implemented by an arbitrary function\n// and produces JSON output.\nfunc NewJSON(fn func(obj string), opts Options) logr.Logger {\n\tfnWrapper := func(_, obj string) {\n\t\tfn(obj)\n\t}\n\treturn logr.New(newSink(fnWrapper, NewFormatterJSON(opts)))\n}\n\n// Underlier exposes access to the underlying logging function. Since\n// callers only have a logr.Logger, they have to know which\n// implementation is in use, so this interface is less of an\n// abstraction and more of a way to test type conversion.\ntype Underlier interface {\n\tGetUnderlying() func(prefix, args string)\n}\n\nfunc newSink(fn func(prefix, args string), formatter Formatter) logr.LogSink {\n\tl := &fnlogger{\n\t\tFormatter: formatter,\n\t\twrite: fn,\n\t}\n\t// For skipping fnlogger.Info and fnlogger.Error.\n\tl.AddCallDepth(1) // via Formatter\n\treturn l\n}\n\n// Options carries parameters which influence the way logs are generated.\ntype Options struct {\n\t// LogCaller tells funcr to add a \"caller\" key to some or all log lines.\n\t// This has some overhead, so some users might not want it.\n\tLogCaller MessageClass\n\n\t// LogCallerFunc tells funcr to also log the calling function name. This\n\t// has no effect if caller logging is not enabled (see Options.LogCaller).\n\tLogCallerFunc bool\n\n\t// LogTimestamp tells funcr to add a \"ts\" key to log lines. This has some\n\t// overhead, so some users might not want it.\n\tLogTimestamp bool\n\n\t// TimestampFormat tells funcr how to render timestamps when LogTimestamp\n\t// is enabled. If not specified, a default format will be used. For more\n\t// details, see docs for Go's time.Layout.\n\tTimestampFormat string\n\n\t// LogInfoLevel tells funcr what key to use to log the info level.\n\t// If not specified, the info level will be logged as \"level\".\n\t// If this is set to \"\", the info level will not be logged at all.\n\tLogInfoLevel *string\n\n\t// Verbosity tells funcr which V logs to produce. Higher values enable\n\t// more logs. Info logs at or below this level will be written, while logs\n\t// above this level will be discarded.\n\tVerbosity int\n\n\t// RenderBuiltinsHook allows users to mutate the list of key-value pairs\n\t// while a log line is being rendered. The kvList argument follows logr\n\t// conventions - each pair of slice elements is comprised of a string key\n\t// and an arbitrary value (verified and sanitized before calling this\n\t// hook). The value returned must follow the same conventions. This hook\n\t// can be used to audit or modify logged data. For example, you might want\n\t// to prefix all of funcr's built-in keys with some string. This hook is\n\t// only called for built-in (provided by funcr itself) key-value pairs.\n\t// Equivalent hooks are offered for key-value pairs saved via\n\t// logr.Logger.WithValues or Formatter.AddValues (see RenderValuesHook) and\n\t// for user-provided pairs (see RenderArgsHook).\n\tRenderBuiltinsHook func(kvList []any) []any\n\n\t// RenderValuesHook is the same as RenderBuiltinsHook, except that it is\n\t// only called for key-value pairs saved via logr.Logger.WithValues. See\n\t// RenderBuiltinsHook for more details.\n\tRenderValuesHook func(kvList []any) []any\n\n\t// RenderArgsHook is the same as RenderBuiltinsHook, except that it is only\n\t// called for key-value pairs passed directly to Info and Error. See\n\t// RenderBuiltinsHook for more details.\n\tRenderArgsHook func(kvList []any) []any\n\n\t// MaxLogDepth tells funcr how many levels of nested fields (e.g. a struct\n\t// that contains a struct, etc.) it may log. Every time it finds a struct,\n\t// slice, array, or map the depth is increased by one. When the maximum is\n\t// reached, the value will be converted to a string indicating that the max\n\t// depth has been exceeded. If this field is not specified, a default\n\t// value will be used.\n\tMaxLogDepth int\n}\n\n// MessageClass indicates which category or categories of messages to consider.\ntype MessageClass int\n\nconst (\n\t// None ignores all message classes.\n\tNone MessageClass = iota\n\t// All considers all message classes.\n\tAll\n\t// Info only considers info messages.\n\tInfo\n\t// Error only considers error messages.\n\tError\n)\n\n// fnlogger inherits some of its LogSink implementation from Formatter\n// and just needs to add some glue code.\ntype fnlogger struct {\n\tFormatter\n\twrite func(prefix, args string)\n}\n\nfunc (l fnlogger) WithName(name string) logr.LogSink {\n\tl.AddName(name) // via Formatter\n\treturn &l\n}\n\nfunc (l fnlogger) WithValues(kvList ...any) logr.LogSink {\n\tl.AddValues(kvList) // via Formatter\n\treturn &l\n}\n\nfunc (l fnlogger) WithCallDepth(depth int) logr.LogSink {\n\tl.AddCallDepth(depth) // via Formatter\n\treturn &l\n}\n\nfunc (l fnlogger) Info(level int, msg string, kvList ...any) {\n\tprefix, args := l.FormatInfo(level, msg, kvList)\n\tl.write(prefix, args)\n}\n\nfunc (l fnlogger) Error(err error, msg string, kvList ...any) {\n\tprefix, args := l.FormatError(err, msg, kvList)\n\tl.write(prefix, args)\n}\n\nfunc (l fnlogger) GetUnderlying() func(prefix, args string) {\n\treturn l.write\n}\n\n// Assert conformance to the interfaces.\nvar _ logr.LogSink = &fnlogger{}\nvar _ logr.CallDepthLogSink = &fnlogger{}\nvar _ Underlier = &fnlogger{}\n\n// NewFormatter constructs a Formatter which emits a JSON-like key=value format.\nfunc NewFormatter(opts Options) Formatter {\n\treturn newFormatter(opts, outputKeyValue)\n}\n\n// NewFormatterJSON constructs a Formatter which emits strict JSON.\nfunc NewFormatterJSON(opts Options) Formatter {\n\treturn newFormatter(opts, outputJSON)\n}\n\n// Defaults for Options.\nconst defaultTimestampFormat = \"2006-01-02 15:04:05.000000\"\nconst defaultMaxLogDepth = 16\n\nfunc newFormatter(opts Options, outfmt outputFormat) Formatter {\n\tif opts.TimestampFormat == \"\" {\n\t\topts.TimestampFormat = defaultTimestampFormat\n\t}\n\tif opts.MaxLogDepth == 0 {\n\t\topts.MaxLogDepth = defaultMaxLogDepth\n\t}\n\tif opts.LogInfoLevel == nil {\n\t\topts.LogInfoLevel = new(string)\n\t\t*opts.LogInfoLevel = \"level\"\n\t}\n\tf := Formatter{\n\t\toutputFormat: outfmt,\n\t\tprefix: \"\",\n\t\tvalues: nil,\n\t\tdepth: 0,\n\t\topts: &opts,\n\t}\n\treturn f\n}\n\n// Formatter is an opaque struct which can be embedded in a LogSink\n// implementation. It should be constructed with NewFormatter. Some of\n// its methods directly implement logr.LogSink.\ntype Formatter struct {\n\toutputFormat outputFormat\n\tprefix string\n\tvalues []any\n\tvaluesStr string\n\tdepth int\n\topts *Options\n\tgroupName string // for slog groups\n\tgroups []groupDef\n}\n\n// outputFormat indicates which outputFormat to use.\ntype outputFormat int\n\nconst (\n\t// outputKeyValue emits a JSON-like key=value format, but not strict JSON.\n\toutputKeyValue outputFormat = iota\n\t// outputJSON emits strict JSON.\n\toutputJSON\n)\n\n// groupDef represents a saved group. The values may be empty, but we don't\n// know if we need to render the group until the final record is rendered.\ntype groupDef struct {\n\tname string\n\tvalues string\n}\n\n// PseudoStruct is a list of key-value pairs that gets logged as a struct.\ntype PseudoStruct []any\n\n// render produces a log line, ready to use.\nfunc (f Formatter) render(builtins, args []any) string {\n\t// Empirically bytes.Buffer is faster than strings.Builder for this.\n\tbuf := bytes.NewBuffer(make([]byte, 0, 1024))\n\n\tif f.outputFormat == outputJSON {\n\t\tbuf.WriteByte('{') // for the whole record\n\t}\n\n\t// Render builtins\n\tvals := builtins\n\tif hook := f.opts.RenderBuiltinsHook; hook != nil {\n\t\tvals = hook(f.sanitize(vals))\n\t}\n\tf.flatten(buf, vals, false) // keys are ours, no need to escape\n\tcontinuing := len(builtins) > 0\n\n\t// Turn the inner-most group into a string\n\targsStr := func() string {\n\t\tbuf := bytes.NewBuffer(make([]byte, 0, 1024))\n\n\t\tvals = args\n\t\tif hook := f.opts.RenderArgsHook; hook != nil {\n\t\t\tvals = hook(f.sanitize(vals))\n\t\t}\n\t\tf.flatten(buf, vals, true) // escape user-provided keys\n\n\t\treturn buf.String()\n\t}()\n\n\t// Render the stack of groups from the inside out.\n\tbodyStr := f.renderGroup(f.groupName, f.valuesStr, argsStr)\n\tfor i := len(f.groups) - 1; i >= 0; i-- {\n\t\tgrp := &f.groups[i]\n\t\tif grp.values == \"\" && bodyStr == \"\" {\n\t\t\t// no contents, so we must elide the whole group\n\t\t\tcontinue\n\t\t}\n\t\tbodyStr = f.renderGroup(grp.name, grp.values, bodyStr)\n\t}\n\n\tif bodyStr != \"\" {\n\t\tif continuing {\n\t\t\tbuf.WriteByte(f.comma())\n\t\t}\n\t\tbuf.WriteString(bodyStr)\n\t}\n\n\tif f.outputFormat == outputJSON {\n\t\tbuf.WriteByte('}') // for the whole record\n\t}\n\n\treturn buf.String()\n}\n\n// renderGroup returns a string representation of the named group with rendered\n// values and args. If the name is empty, this will return the values and args,\n// joined. If the name is not empty, this will return a single key-value pair,\n// where the value is a grouping of the values and args. If the values and\n// args are both empty, this will return an empty string, even if the name was\n// specified.\nfunc (f Formatter) renderGroup(name string, values string, args string) string {\n\tbuf := bytes.NewBuffer(make([]byte, 0, 1024))\n\n\tneedClosingBrace := false\n\tif name != \"\" && (values != \"\" || args != \"\") {\n\t\tbuf.WriteString(f.quoted(name, true)) // escape user-provided keys\n\t\tbuf.WriteByte(f.colon())\n\t\tbuf.WriteByte('{')\n\t\tneedClosingBrace = true\n\t}\n\n\tcontinuing := false\n\tif values != \"\" {\n\t\tbuf.WriteString(values)\n\t\tcontinuing = true\n\t}\n\n\tif args != \"\" {\n\t\tif continuing {\n\t\t\tbuf.WriteByte(f.comma())\n\t\t}\n\t\tbuf.WriteString(args)\n\t}\n\n\tif needClosingBrace {\n\t\tbuf.WriteByte('}')\n\t}\n\n\treturn buf.String()\n}\n\n// flatten renders a list of key-value pairs into a buffer. If escapeKeys is\n// true, the keys are assumed to have non-JSON-compatible characters in them\n// and must be evaluated for escapes.\n//\n// This function returns a potentially modified version of kvList, which\n// ensures that there is a value for every key (adding a value if needed) and\n// that each key is a string (substituting a key if needed).\nfunc (f Formatter) flatten(buf *bytes.Buffer, kvList []any, escapeKeys bool) []any {\n\t// This logic overlaps with sanitize() but saves one type-cast per key,\n\t// which can be measurable.\n\tif len(kvList)%2 != 0 {\n\t\tkvList = append(kvList, noValue)\n\t}\n\tcopied := false\n\tfor i := 0; i < len(kvList); i += 2 {\n\t\tk, ok := kvList[i].(string)\n\t\tif !ok {\n\t\t\tif !copied {\n\t\t\t\tnewList := make([]any, len(kvList))\n\t\t\t\tcopy(newList, kvList)\n\t\t\t\tkvList = newList\n\t\t\t\tcopied = true\n\t\t\t}\n\t\t\tk = f.nonStringKey(kvList[i])\n\t\t\tkvList[i] = k\n\t\t}\n\t\tv := kvList[i+1]\n\n\t\tif i > 0 {\n\t\t\tif f.outputFormat == outputJSON {\n\t\t\t\tbuf.WriteByte(f.comma())\n\t\t\t} else {\n\t\t\t\t// In theory the format could be something we don't understand. In\n\t\t\t\t// practice, we control it, so it won't be.\n\t\t\t\tbuf.WriteByte(' ')\n\t\t\t}\n\t\t}\n\n\t\tbuf.WriteString(f.quoted(k, escapeKeys))\n\t\tbuf.WriteByte(f.colon())\n\t\tbuf.WriteString(f.pretty(v))\n\t}\n\treturn kvList\n}\n\nfunc (f Formatter) quoted(str string, escape bool) string {\n\tif escape {\n\t\treturn prettyString(str)\n\t}\n\t// this is faster\n\treturn `\"` + str + `\"`\n}\n\nfunc (f Formatter) comma() byte {\n\tif f.outputFormat == outputJSON {\n\t\treturn ','\n\t}\n\treturn ' '\n}\n\nfunc (f Formatter) colon() byte {\n\tif f.outputFormat == outputJSON {\n\t\treturn ':'\n\t}\n\treturn '='\n}\n\nfunc (f Formatter) pretty(value any) string {\n\treturn f.prettyWithFlags(value, 0, 0)\n}\n\nconst (\n\tflagRawStruct = 0x1 // do not print braces on structs\n)\n\n// TODO: This is not fast. Most of the overhead goes here.\nfunc (f Formatter) prettyWithFlags(value any, flags uint32, depth int) string {\n\tif depth > f.opts.MaxLogDepth {\n\t\treturn `\"\"`\n\t}\n\n\t// Handle types that take full control of logging.\n\tif v, ok := value.(logr.Marshaler); ok {\n\t\t// Replace the value with what the type wants to get logged.\n\t\t// That then gets handled below via reflection.\n\t\tvalue = invokeMarshaler(v)\n\t}\n\n\t// Handle types that want to format themselves.\n\tswitch v := value.(type) {\n\tcase fmt.Stringer:\n\t\tvalue = invokeStringer(v)\n\tcase error:\n\t\tvalue = invokeError(v)\n\t}\n\n\t// Handling the most common types without reflect is a small perf win.\n\tswitch v := value.(type) {\n\tcase bool:\n\t\treturn strconv.FormatBool(v)\n\tcase string:\n\t\treturn prettyString(v)\n\tcase int:\n\t\treturn strconv.FormatInt(int64(v), 10)\n\tcase int8:\n\t\treturn strconv.FormatInt(int64(v), 10)\n\tcase int16:\n\t\treturn strconv.FormatInt(int64(v), 10)\n\tcase int32:\n\t\treturn strconv.FormatInt(int64(v), 10)\n\tcase int64:\n\t\treturn strconv.FormatInt(int64(v), 10)\n\tcase uint:\n\t\treturn strconv.FormatUint(uint64(v), 10)\n\tcase uint8:\n\t\treturn strconv.FormatUint(uint64(v), 10)\n\tcase uint16:\n\t\treturn strconv.FormatUint(uint64(v), 10)\n\tcase uint32:\n\t\treturn strconv.FormatUint(uint64(v), 10)\n\tcase uint64:\n\t\treturn strconv.FormatUint(v, 10)\n\tcase uintptr:\n\t\treturn strconv.FormatUint(uint64(v), 10)\n\tcase float32:\n\t\treturn strconv.FormatFloat(float64(v), 'f', -1, 32)\n\tcase float64:\n\t\treturn strconv.FormatFloat(v, 'f', -1, 64)\n\tcase complex64:\n\t\treturn `\"` + strconv.FormatComplex(complex128(v), 'f', -1, 64) + `\"`\n\tcase complex128:\n\t\treturn `\"` + strconv.FormatComplex(v, 'f', -1, 128) + `\"`\n\tcase PseudoStruct:\n\t\tbuf := bytes.NewBuffer(make([]byte, 0, 1024))\n\t\tv = f.sanitize(v)\n\t\tif flags&flagRawStruct == 0 {\n\t\t\tbuf.WriteByte('{')\n\t\t}\n\t\tfor i := 0; i < len(v); i += 2 {\n\t\t\tif i > 0 {\n\t\t\t\tbuf.WriteByte(f.comma())\n\t\t\t}\n\t\t\tk, _ := v[i].(string) // sanitize() above means no need to check success\n\t\t\t// arbitrary keys might need escaping\n\t\t\tbuf.WriteString(prettyString(k))\n\t\t\tbuf.WriteByte(f.colon())\n\t\t\tbuf.WriteString(f.prettyWithFlags(v[i+1], 0, depth+1))\n\t\t}\n\t\tif flags&flagRawStruct == 0 {\n\t\t\tbuf.WriteByte('}')\n\t\t}\n\t\treturn buf.String()\n\t}\n\n\tbuf := bytes.NewBuffer(make([]byte, 0, 256))\n\tt := reflect.TypeOf(value)\n\tif t == nil {\n\t\treturn \"null\"\n\t}\n\tv := reflect.ValueOf(value)\n\tswitch t.Kind() {\n\tcase reflect.Bool:\n\t\treturn strconv.FormatBool(v.Bool())\n\tcase reflect.String:\n\t\treturn prettyString(v.String())\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn strconv.FormatInt(int64(v.Int()), 10)\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\treturn strconv.FormatUint(uint64(v.Uint()), 10)\n\tcase reflect.Float32:\n\t\treturn strconv.FormatFloat(float64(v.Float()), 'f', -1, 32)\n\tcase reflect.Float64:\n\t\treturn strconv.FormatFloat(v.Float(), 'f', -1, 64)\n\tcase reflect.Complex64:\n\t\treturn `\"` + strconv.FormatComplex(complex128(v.Complex()), 'f', -1, 64) + `\"`\n\tcase reflect.Complex128:\n\t\treturn `\"` + strconv.FormatComplex(v.Complex(), 'f', -1, 128) + `\"`\n\tcase reflect.Struct:\n\t\tif flags&flagRawStruct == 0 {\n\t\t\tbuf.WriteByte('{')\n\t\t}\n\t\tprintComma := false // testing i>0 is not enough because of JSON omitted fields\n\t\tfor i := 0; i < t.NumField(); i++ {\n\t\t\tfld := t.Field(i)\n\t\t\tif fld.PkgPath != \"\" {\n\t\t\t\t// reflect says this field is only defined for non-exported fields.\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif !v.Field(i).CanInterface() {\n\t\t\t\t// reflect isn't clear exactly what this means, but we can't use it.\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tname := \"\"\n\t\t\tomitempty := false\n\t\t\tif tag, found := fld.Tag.Lookup(\"json\"); found {\n\t\t\t\tif tag == \"-\" {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tif comma := strings.Index(tag, \",\"); comma != -1 {\n\t\t\t\t\tif n := tag[:comma]; n != \"\" {\n\t\t\t\t\t\tname = n\n\t\t\t\t\t}\n\t\t\t\t\trest := tag[comma:]\n\t\t\t\t\tif strings.Contains(rest, \",omitempty,\") || strings.HasSuffix(rest, \",omitempty\") {\n\t\t\t\t\t\tomitempty = true\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\tname = tag\n\t\t\t\t}\n\t\t\t}\n\t\t\tif omitempty && isEmpty(v.Field(i)) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif printComma {\n\t\t\t\tbuf.WriteByte(f.comma())\n\t\t\t}\n\t\t\tprintComma = true // if we got here, we are rendering a field\n\t\t\tif fld.Anonymous && fld.Type.Kind() == reflect.Struct && name == \"\" {\n\t\t\t\tbuf.WriteString(f.prettyWithFlags(v.Field(i).Interface(), flags|flagRawStruct, depth+1))\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif name == \"\" {\n\t\t\t\tname = fld.Name\n\t\t\t}\n\t\t\t// field names can't contain characters which need escaping\n\t\t\tbuf.WriteString(f.quoted(name, false))\n\t\t\tbuf.WriteByte(f.colon())\n\t\t\tbuf.WriteString(f.prettyWithFlags(v.Field(i).Interface(), 0, depth+1))\n\t\t}\n\t\tif flags&flagRawStruct == 0 {\n\t\t\tbuf.WriteByte('}')\n\t\t}\n\t\treturn buf.String()\n\tcase reflect.Slice, reflect.Array:\n\t\t// If this is outputing as JSON make sure this isn't really a json.RawMessage.\n\t\t// If so just emit \"as-is\" and don't pretty it as that will just print\n\t\t// it as [X,Y,Z,...] which isn't terribly useful vs the string form you really want.\n\t\tif f.outputFormat == outputJSON {\n\t\t\tif rm, ok := value.(json.RawMessage); ok {\n\t\t\t\t// If it's empty make sure we emit an empty value as the array style would below.\n\t\t\t\tif len(rm) > 0 {\n\t\t\t\t\tbuf.Write(rm)\n\t\t\t\t} else {\n\t\t\t\t\tbuf.WriteString(\"null\")\n\t\t\t\t}\n\t\t\t\treturn buf.String()\n\t\t\t}\n\t\t}\n\t\tbuf.WriteByte('[')\n\t\tfor i := 0; i < v.Len(); i++ {\n\t\t\tif i > 0 {\n\t\t\t\tbuf.WriteByte(f.comma())\n\t\t\t}\n\t\t\te := v.Index(i)\n\t\t\tbuf.WriteString(f.prettyWithFlags(e.Interface(), 0, depth+1))\n\t\t}\n\t\tbuf.WriteByte(']')\n\t\treturn buf.String()\n\tcase reflect.Map:\n\t\tbuf.WriteByte('{')\n\t\t// This does not sort the map keys, for best perf.\n\t\tit := v.MapRange()\n\t\ti := 0\n\t\tfor it.Next() {\n\t\t\tif i > 0 {\n\t\t\t\tbuf.WriteByte(f.comma())\n\t\t\t}\n\t\t\t// If a map key supports TextMarshaler, use it.\n\t\t\tkeystr := \"\"\n\t\t\tif m, ok := it.Key().Interface().(encoding.TextMarshaler); ok {\n\t\t\t\ttxt, err := m.MarshalText()\n\t\t\t\tif err != nil {\n\t\t\t\t\tkeystr = fmt.Sprintf(\"\", err.Error())\n\t\t\t\t} else {\n\t\t\t\t\tkeystr = string(txt)\n\t\t\t\t}\n\t\t\t\tkeystr = prettyString(keystr)\n\t\t\t} else {\n\t\t\t\t// prettyWithFlags will produce already-escaped values\n\t\t\t\tkeystr = f.prettyWithFlags(it.Key().Interface(), 0, depth+1)\n\t\t\t\tif t.Key().Kind() != reflect.String {\n\t\t\t\t\t// JSON only does string keys. Unlike Go's standard JSON, we'll\n\t\t\t\t\t// convert just about anything to a string.\n\t\t\t\t\tkeystr = prettyString(keystr)\n\t\t\t\t}\n\t\t\t}\n\t\t\tbuf.WriteString(keystr)\n\t\t\tbuf.WriteByte(f.colon())\n\t\t\tbuf.WriteString(f.prettyWithFlags(it.Value().Interface(), 0, depth+1))\n\t\t\ti++\n\t\t}\n\t\tbuf.WriteByte('}')\n\t\treturn buf.String()\n\tcase reflect.Ptr, reflect.Interface:\n\t\tif v.IsNil() {\n\t\t\treturn \"null\"\n\t\t}\n\t\treturn f.prettyWithFlags(v.Elem().Interface(), 0, depth)\n\t}\n\treturn fmt.Sprintf(`\"\"`, t.Kind().String())\n}\n\nfunc prettyString(s string) string {\n\t// Avoid escaping (which does allocations) if we can.\n\tif needsEscape(s) {\n\t\treturn strconv.Quote(s)\n\t}\n\tb := bytes.NewBuffer(make([]byte, 0, 1024))\n\tb.WriteByte('\"')\n\tb.WriteString(s)\n\tb.WriteByte('\"')\n\treturn b.String()\n}\n\n// needsEscape determines whether the input string needs to be escaped or not,\n// without doing any allocations.\nfunc needsEscape(s string) bool {\n\tfor _, r := range s {\n\t\tif !strconv.IsPrint(r) || r == '\\\\' || r == '\"' {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc isEmpty(v reflect.Value) bool {\n\tswitch v.Kind() {\n\tcase reflect.Array, reflect.Map, reflect.Slice, reflect.String:\n\t\treturn v.Len() == 0\n\tcase reflect.Bool:\n\t\treturn !v.Bool()\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn v.Int() == 0\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\treturn v.Uint() == 0\n\tcase reflect.Float32, reflect.Float64:\n\t\treturn v.Float() == 0\n\tcase reflect.Complex64, reflect.Complex128:\n\t\treturn v.Complex() == 0\n\tcase reflect.Interface, reflect.Ptr:\n\t\treturn v.IsNil()\n\t}\n\treturn false\n}\n\nfunc invokeMarshaler(m logr.Marshaler) (ret any) {\n\tdefer func() {\n\t\tif r := recover(); r != nil {\n\t\t\tret = fmt.Sprintf(\"\", r)\n\t\t}\n\t}()\n\treturn m.MarshalLog()\n}\n\nfunc invokeStringer(s fmt.Stringer) (ret string) {\n\tdefer func() {\n\t\tif r := recover(); r != nil {\n\t\t\tret = fmt.Sprintf(\"\", r)\n\t\t}\n\t}()\n\treturn s.String()\n}\n\nfunc invokeError(e error) (ret string) {\n\tdefer func() {\n\t\tif r := recover(); r != nil {\n\t\t\tret = fmt.Sprintf(\"\", r)\n\t\t}\n\t}()\n\treturn e.Error()\n}\n\n// Caller represents the original call site for a log line, after considering\n// logr.Logger.WithCallDepth and logr.Logger.WithCallStackHelper. The File and\n// Line fields will always be provided, while the Func field is optional.\n// Users can set the render hook fields in Options to examine logged key-value\n// pairs, one of which will be {\"caller\", Caller} if the Options.LogCaller\n// field is enabled for the given MessageClass.\ntype Caller struct {\n\t// File is the basename of the file for this call site.\n\tFile string `json:\"file\"`\n\t// Line is the line number in the file for this call site.\n\tLine int `json:\"line\"`\n\t// Func is the function name for this call site, or empty if\n\t// Options.LogCallerFunc is not enabled.\n\tFunc string `json:\"function,omitempty\"`\n}\n\nfunc (f Formatter) caller() Caller {\n\t// +1 for this frame, +1 for Info/Error.\n\tpc, file, line, ok := runtime.Caller(f.depth + 2)\n\tif !ok {\n\t\treturn Caller{\"\", 0, \"\"}\n\t}\n\tfn := \"\"\n\tif f.opts.LogCallerFunc {\n\t\tif fp := runtime.FuncForPC(pc); fp != nil {\n\t\t\tfn = fp.Name()\n\t\t}\n\t}\n\n\treturn Caller{filepath.Base(file), line, fn}\n}\n\nconst noValue = \"\"\n\nfunc (f Formatter) nonStringKey(v any) string {\n\treturn fmt.Sprintf(\"\", f.snippet(v))\n}\n\n// snippet produces a short snippet string of an arbitrary value.\nfunc (f Formatter) snippet(v any) string {\n\tconst snipLen = 16\n\n\tsnip := f.pretty(v)\n\tif len(snip) > snipLen {\n\t\tsnip = snip[:snipLen]\n\t}\n\treturn snip\n}\n\n// sanitize ensures that a list of key-value pairs has a value for every key\n// (adding a value if needed) and that each key is a string (substituting a key\n// if needed).\nfunc (f Formatter) sanitize(kvList []any) []any {\n\tif len(kvList)%2 != 0 {\n\t\tkvList = append(kvList, noValue)\n\t}\n\tfor i := 0; i < len(kvList); i += 2 {\n\t\t_, ok := kvList[i].(string)\n\t\tif !ok {\n\t\t\tkvList[i] = f.nonStringKey(kvList[i])\n\t\t}\n\t}\n\treturn kvList\n}\n\n// startGroup opens a new group scope (basically a sub-struct), which locks all\n// the current saved values and starts them anew. This is needed to satisfy\n// slog.\nfunc (f *Formatter) startGroup(name string) {\n\t// Unnamed groups are just inlined.\n\tif name == \"\" {\n\t\treturn\n\t}\n\n\tn := len(f.groups)\n\tf.groups = append(f.groups[:n:n], groupDef{f.groupName, f.valuesStr})\n\n\t// Start collecting new values.\n\tf.groupName = name\n\tf.valuesStr = \"\"\n\tf.values = nil\n}\n\n// Init configures this Formatter from runtime info, such as the call depth\n// imposed by logr itself.\n// Note that this receiver is a pointer, so depth can be saved.\nfunc (f *Formatter) Init(info logr.RuntimeInfo) {\n\tf.depth += info.CallDepth\n}\n\n// Enabled checks whether an info message at the given level should be logged.\nfunc (f Formatter) Enabled(level int) bool {\n\treturn level <= f.opts.Verbosity\n}\n\n// GetDepth returns the current depth of this Formatter. This is useful for\n// implementations which do their own caller attribution.\nfunc (f Formatter) GetDepth() int {\n\treturn f.depth\n}\n\n// FormatInfo renders an Info log message into strings. The prefix will be\n// empty when no names were set (via AddNames), or when the output is\n// configured for JSON.\nfunc (f Formatter) FormatInfo(level int, msg string, kvList []any) (prefix, argsStr string) {\n\targs := make([]any, 0, 64) // using a constant here impacts perf\n\tprefix = f.prefix\n\tif f.outputFormat == outputJSON {\n\t\targs = append(args, \"logger\", prefix)\n\t\tprefix = \"\"\n\t}\n\tif f.opts.LogTimestamp {\n\t\targs = append(args, \"ts\", time.Now().Format(f.opts.TimestampFormat))\n\t}\n\tif policy := f.opts.LogCaller; policy == All || policy == Info {\n\t\targs = append(args, \"caller\", f.caller())\n\t}\n\tif key := *f.opts.LogInfoLevel; key != \"\" {\n\t\targs = append(args, key, level)\n\t}\n\targs = append(args, \"msg\", msg)\n\treturn prefix, f.render(args, kvList)\n}\n\n// FormatError renders an Error log message into strings. The prefix will be\n// empty when no names were set (via AddNames), or when the output is\n// configured for JSON.\nfunc (f Formatter) FormatError(err error, msg string, kvList []any) (prefix, argsStr string) {\n\targs := make([]any, 0, 64) // using a constant here impacts perf\n\tprefix = f.prefix\n\tif f.outputFormat == outputJSON {\n\t\targs = append(args, \"logger\", prefix)\n\t\tprefix = \"\"\n\t}\n\tif f.opts.LogTimestamp {\n\t\targs = append(args, \"ts\", time.Now().Format(f.opts.TimestampFormat))\n\t}\n\tif policy := f.opts.LogCaller; policy == All || policy == Error {\n\t\targs = append(args, \"caller\", f.caller())\n\t}\n\targs = append(args, \"msg\", msg)\n\tvar loggableErr any\n\tif err != nil {\n\t\tloggableErr = err.Error()\n\t}\n\targs = append(args, \"error\", loggableErr)\n\treturn prefix, f.render(args, kvList)\n}\n\n// AddName appends the specified name. funcr uses '/' characters to separate\n// name elements. Callers should not pass '/' in the provided name string, but\n// this library does not actually enforce that.\nfunc (f *Formatter) AddName(name string) {\n\tif len(f.prefix) > 0 {\n\t\tf.prefix += \"/\"\n\t}\n\tf.prefix += name\n}\n\n// AddValues adds key-value pairs to the set of saved values to be logged with\n// each log line.\nfunc (f *Formatter) AddValues(kvList []any) {\n\t// Three slice args forces a copy.\n\tn := len(f.values)\n\tf.values = append(f.values[:n:n], kvList...)\n\n\tvals := f.values\n\tif hook := f.opts.RenderValuesHook; hook != nil {\n\t\tvals = hook(f.sanitize(vals))\n\t}\n\n\t// Pre-render values, so we don't have to do it on each Info/Error call.\n\tbuf := bytes.NewBuffer(make([]byte, 0, 1024))\n\tf.flatten(buf, vals, true) // escape user-provided keys\n\tf.valuesStr = buf.String()\n}\n\n// AddCallDepth increases the number of stack-frames to skip when attributing\n// the log line to a file and line.\nfunc (f *Formatter) AddCallDepth(depth int) {\n\tf.depth += depth\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/funcr/slogsink.go",
"content": "//go:build go1.21\n// +build go1.21\n\n/*\nCopyright 2023 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\npackage funcr\n\nimport (\n\t\"context\"\n\t\"log/slog\"\n\n\t\"github.com/go-logr/logr\"\n)\n\nvar _ logr.SlogSink = &fnlogger{}\n\nconst extraSlogSinkDepth = 3 // 2 for slog, 1 for SlogSink\n\nfunc (l fnlogger) Handle(_ context.Context, record slog.Record) error {\n\tkvList := make([]any, 0, 2*record.NumAttrs())\n\trecord.Attrs(func(attr slog.Attr) bool {\n\t\tkvList = attrToKVs(attr, kvList)\n\t\treturn true\n\t})\n\n\tif record.Level >= slog.LevelError {\n\t\tl.WithCallDepth(extraSlogSinkDepth).Error(nil, record.Message, kvList...)\n\t} else {\n\t\tlevel := l.levelFromSlog(record.Level)\n\t\tl.WithCallDepth(extraSlogSinkDepth).Info(level, record.Message, kvList...)\n\t}\n\treturn nil\n}\n\nfunc (l fnlogger) WithAttrs(attrs []slog.Attr) logr.SlogSink {\n\tkvList := make([]any, 0, 2*len(attrs))\n\tfor _, attr := range attrs {\n\t\tkvList = attrToKVs(attr, kvList)\n\t}\n\tl.AddValues(kvList)\n\treturn &l\n}\n\nfunc (l fnlogger) WithGroup(name string) logr.SlogSink {\n\tl.startGroup(name)\n\treturn &l\n}\n\n// attrToKVs appends a slog.Attr to a logr-style kvList. It handle slog Groups\n// and other details of slog.\nfunc attrToKVs(attr slog.Attr, kvList []any) []any {\n\tattrVal := attr.Value.Resolve()\n\tif attrVal.Kind() == slog.KindGroup {\n\t\tgroupVal := attrVal.Group()\n\t\tgrpKVs := make([]any, 0, 2*len(groupVal))\n\t\tfor _, attr := range groupVal {\n\t\t\tgrpKVs = attrToKVs(attr, grpKVs)\n\t\t}\n\t\tif attr.Key == \"\" {\n\t\t\t// slog says we have to inline these\n\t\t\tkvList = append(kvList, grpKVs...)\n\t\t} else {\n\t\t\tkvList = append(kvList, attr.Key, PseudoStruct(grpKVs))\n\t\t}\n\t} else if attr.Key != \"\" {\n\t\tkvList = append(kvList, attr.Key, attrVal.Any())\n\t}\n\n\treturn kvList\n}\n\n// levelFromSlog adjusts the level by the logger's verbosity and negates it.\n// It ensures that the result is >= 0. This is necessary because the result is\n// passed to a LogSink and that API did not historically document whether\n// levels could be negative or what that meant.\n//\n// Some example usage:\n//\n//\tlogrV0 := getMyLogger()\n//\tlogrV2 := logrV0.V(2)\n//\tslogV2 := slog.New(logr.ToSlogHandler(logrV2))\n//\tslogV2.Debug(\"msg\") // =~ logrV2.V(4) =~ logrV0.V(6)\n//\tslogV2.Info(\"msg\") // =~ logrV2.V(0) =~ logrV0.V(2)\n//\tslogv2.Warn(\"msg\") // =~ logrV2.V(-4) =~ logrV0.V(0)\nfunc (l fnlogger) levelFromSlog(level slog.Level) int {\n\tresult := -level\n\tif result < 0 {\n\t\tresult = 0 // because LogSink doesn't expect negative V levels\n\t}\n\treturn int(result)\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/logr.go",
"content": "/*\nCopyright 2019 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n// This design derives from Dave Cheney's blog:\n// http://dave.cheney.net/2015/11/05/lets-talk-about-logging\n\n// Package logr defines a general-purpose logging API and abstract interfaces\n// to back that API. Packages in the Go ecosystem can depend on this package,\n// while callers can implement logging with whatever backend is appropriate.\n//\n// # Usage\n//\n// Logging is done using a Logger instance. Logger is a concrete type with\n// methods, which defers the actual logging to a LogSink interface. The main\n// methods of Logger are Info() and Error(). Arguments to Info() and Error()\n// are key/value pairs rather than printf-style formatted strings, emphasizing\n// \"structured logging\".\n//\n// With Go's standard log package, we might write:\n//\n//\tlog.Printf(\"setting target value %s\", targetValue)\n//\n// With logr's structured logging, we'd write:\n//\n//\tlogger.Info(\"setting target\", \"value\", targetValue)\n//\n// Errors are much the same. Instead of:\n//\n//\tlog.Printf(\"failed to open the pod bay door for user %s: %v\", user, err)\n//\n// We'd write:\n//\n//\tlogger.Error(err, \"failed to open the pod bay door\", \"user\", user)\n//\n// Info() and Error() are very similar, but they are separate methods so that\n// LogSink implementations can choose to do things like attach additional\n// information (such as stack traces) on calls to Error(). Error() messages are\n// always logged, regardless of the current verbosity. If there is no error\n// instance available, passing nil is valid.\n//\n// # Verbosity\n//\n// Often we want to log information only when the application in \"verbose\n// mode\". To write log lines that are more verbose, Logger has a V() method.\n// The higher the V-level of a log line, the less critical it is considered.\n// Log-lines with V-levels that are not enabled (as per the LogSink) will not\n// be written. Level V(0) is the default, and logger.V(0).Info() has the same\n// meaning as logger.Info(). Negative V-levels have the same meaning as V(0).\n// Error messages do not have a verbosity level and are always logged.\n//\n// Where we might have written:\n//\n//\tif flVerbose >= 2 {\n//\t log.Printf(\"an unusual thing happened\")\n//\t}\n//\n// We can write:\n//\n//\tlogger.V(2).Info(\"an unusual thing happened\")\n//\n// # Logger Names\n//\n// Logger instances can have name strings so that all messages logged through\n// that instance have additional context. For example, you might want to add\n// a subsystem name:\n//\n//\tlogger.WithName(\"compactor\").Info(\"started\", \"time\", time.Now())\n//\n// The WithName() method returns a new Logger, which can be passed to\n// constructors or other functions for further use. Repeated use of WithName()\n// will accumulate name \"segments\". These name segments will be joined in some\n// way by the LogSink implementation. It is strongly recommended that name\n// segments contain simple identifiers (letters, digits, and hyphen), and do\n// not contain characters that could muddle the log output or confuse the\n// joining operation (e.g. whitespace, commas, periods, slashes, brackets,\n// quotes, etc).\n//\n// # Saved Values\n//\n// Logger instances can store any number of key/value pairs, which will be\n// logged alongside all messages logged through that instance. For example,\n// you might want to create a Logger instance per managed object:\n//\n// With the standard log package, we might write:\n//\n//\tlog.Printf(\"decided to set field foo to value %q for object %s/%s\",\n//\t targetValue, object.Namespace, object.Name)\n//\n// With logr we'd write:\n//\n//\t// Elsewhere: set up the logger to log the object name.\n//\tobj.logger = mainLogger.WithValues(\n//\t \"name\", obj.name, \"namespace\", obj.namespace)\n//\n//\t// later on...\n//\tobj.logger.Info(\"setting foo\", \"value\", targetValue)\n//\n// # Best Practices\n//\n// Logger has very few hard rules, with the goal that LogSink implementations\n// might have a lot of freedom to differentiate. There are, however, some\n// things to consider.\n//\n// The log message consists of a constant message attached to the log line.\n// This should generally be a simple description of what's occurring, and should\n// never be a format string. Variable information can then be attached using\n// named values.\n//\n// Keys are arbitrary strings, but should generally be constant values. Values\n// may be any Go value, but how the value is formatted is determined by the\n// LogSink implementation.\n//\n// Logger instances are meant to be passed around by value. Code that receives\n// such a value can call its methods without having to check whether the\n// instance is ready for use.\n//\n// The zero logger (= Logger{}) is identical to Discard() and discards all log\n// entries. Code that receives a Logger by value can simply call it, the methods\n// will never crash. For cases where passing a logger is optional, a pointer to Logger\n// should be used.\n//\n// # Key Naming Conventions\n//\n// Keys are not strictly required to conform to any specification or regex, but\n// it is recommended that they:\n// - be human-readable and meaningful (not auto-generated or simple ordinals)\n// - be constant (not dependent on input data)\n// - contain only printable characters\n// - not contain whitespace or punctuation\n// - use lower case for simple keys and lowerCamelCase for more complex ones\n//\n// These guidelines help ensure that log data is processed properly regardless\n// of the log implementation. For example, log implementations will try to\n// output JSON data or will store data for later database (e.g. SQL) queries.\n//\n// While users are generally free to use key names of their choice, it's\n// generally best to avoid using the following keys, as they're frequently used\n// by implementations:\n// - \"caller\": the calling information (file/line) of a particular log line\n// - \"error\": the underlying error value in the `Error` method\n// - \"level\": the log level\n// - \"logger\": the name of the associated logger\n// - \"msg\": the log message\n// - \"stacktrace\": the stack trace associated with a particular log line or\n// error (often from the `Error` message)\n// - \"ts\": the timestamp for a log line\n//\n// Implementations are encouraged to make use of these keys to represent the\n// above concepts, when necessary (for example, in a pure-JSON output form, it\n// would be necessary to represent at least message and timestamp as ordinary\n// named values).\n//\n// # Break Glass\n//\n// Implementations may choose to give callers access to the underlying\n// logging implementation. The recommended pattern for this is:\n//\n//\t// Underlier exposes access to the underlying logging implementation.\n//\t// Since callers only have a logr.Logger, they have to know which\n//\t// implementation is in use, so this interface is less of an abstraction\n//\t// and more of way to test type conversion.\n//\ttype Underlier interface {\n//\t GetUnderlying() \n//\t}\n//\n// Logger grants access to the sink to enable type assertions like this:\n//\n//\tfunc DoSomethingWithImpl(log logr.Logger) {\n//\t if underlier, ok := log.GetSink().(impl.Underlier); ok {\n//\t implLogger := underlier.GetUnderlying()\n//\t ...\n//\t }\n//\t}\n//\n// Custom `With*` functions can be implemented by copying the complete\n// Logger struct and replacing the sink in the copy:\n//\n//\t// WithFooBar changes the foobar parameter in the log sink and returns a\n//\t// new logger with that modified sink. It does nothing for loggers where\n//\t// the sink doesn't support that parameter.\n//\tfunc WithFoobar(log logr.Logger, foobar int) logr.Logger {\n//\t if foobarLogSink, ok := log.GetSink().(FoobarSink); ok {\n//\t log = log.WithSink(foobarLogSink.WithFooBar(foobar))\n//\t }\n//\t return log\n//\t}\n//\n// Don't use New to construct a new Logger with a LogSink retrieved from an\n// existing Logger. Source code attribution might not work correctly and\n// unexported fields in Logger get lost.\n//\n// Beware that the same LogSink instance may be shared by different logger\n// instances. Calling functions that modify the LogSink will affect all of\n// those.\npackage logr\n\n// New returns a new Logger instance. This is primarily used by libraries\n// implementing LogSink, rather than end users. Passing a nil sink will create\n// a Logger which discards all log lines.\nfunc New(sink LogSink) Logger {\n\tlogger := Logger{}\n\tlogger.setSink(sink)\n\tif sink != nil {\n\t\tsink.Init(runtimeInfo)\n\t}\n\treturn logger\n}\n\n// setSink stores the sink and updates any related fields. It mutates the\n// logger and thus is only safe to use for loggers that are not currently being\n// used concurrently.\nfunc (l *Logger) setSink(sink LogSink) {\n\tl.sink = sink\n}\n\n// GetSink returns the stored sink.\nfunc (l Logger) GetSink() LogSink {\n\treturn l.sink\n}\n\n// WithSink returns a copy of the logger with the new sink.\nfunc (l Logger) WithSink(sink LogSink) Logger {\n\tl.setSink(sink)\n\treturn l\n}\n\n// Logger is an interface to an abstract logging implementation. This is a\n// concrete type for performance reasons, but all the real work is passed on to\n// a LogSink. Implementations of LogSink should provide their own constructors\n// that return Logger, not LogSink.\n//\n// The underlying sink can be accessed through GetSink and be modified through\n// WithSink. This enables the implementation of custom extensions (see \"Break\n// Glass\" in the package documentation). Normally the sink should be used only\n// indirectly.\ntype Logger struct {\n\tsink LogSink\n\tlevel int\n}\n\n// Enabled tests whether this Logger is enabled. For example, commandline\n// flags might be used to set the logging verbosity and disable some info logs.\nfunc (l Logger) Enabled() bool {\n\t// Some implementations of LogSink look at the caller in Enabled (e.g.\n\t// different verbosity levels per package or file), but we only pass one\n\t// CallDepth in (via Init). This means that all calls from Logger to the\n\t// LogSink's Enabled, Info, and Error methods must have the same number of\n\t// frames. In other words, Logger methods can't call other Logger methods\n\t// which call these LogSink methods unless we do it the same in all paths.\n\treturn l.sink != nil && l.sink.Enabled(l.level)\n}\n\n// Info logs a non-error message with the given key/value pairs as context.\n//\n// The msg argument should be used to add some constant description to the log\n// line. The key/value pairs can then be used to add additional variable\n// information. The key/value pairs must alternate string keys and arbitrary\n// values.\nfunc (l Logger) Info(msg string, keysAndValues ...any) {\n\tif l.sink == nil {\n\t\treturn\n\t}\n\tif l.sink.Enabled(l.level) { // see comment in Enabled\n\t\tif withHelper, ok := l.sink.(CallStackHelperLogSink); ok {\n\t\t\twithHelper.GetCallStackHelper()()\n\t\t}\n\t\tl.sink.Info(l.level, msg, keysAndValues...)\n\t}\n}\n\n// Error logs an error, with the given message and key/value pairs as context.\n// It functions similarly to Info, but may have unique behavior, and should be\n// preferred for logging errors (see the package documentations for more\n// information). The log message will always be emitted, regardless of\n// verbosity level.\n//\n// The msg argument should be used to add context to any underlying error,\n// while the err argument should be used to attach the actual error that\n// triggered this log line, if present. The err parameter is optional\n// and nil may be passed instead of an error instance.\nfunc (l Logger) Error(err error, msg string, keysAndValues ...any) {\n\tif l.sink == nil {\n\t\treturn\n\t}\n\tif withHelper, ok := l.sink.(CallStackHelperLogSink); ok {\n\t\twithHelper.GetCallStackHelper()()\n\t}\n\tl.sink.Error(err, msg, keysAndValues...)\n}\n\n// V returns a new Logger instance for a specific verbosity level, relative to\n// this Logger. In other words, V-levels are additive. A higher verbosity\n// level means a log message is less important. Negative V-levels are treated\n// as 0.\nfunc (l Logger) V(level int) Logger {\n\tif l.sink == nil {\n\t\treturn l\n\t}\n\tif level < 0 {\n\t\tlevel = 0\n\t}\n\tl.level += level\n\treturn l\n}\n\n// GetV returns the verbosity level of the logger. If the logger's LogSink is\n// nil as in the Discard logger, this will always return 0.\nfunc (l Logger) GetV() int {\n\t// 0 if l.sink nil because of the if check in V above.\n\treturn l.level\n}\n\n// WithValues returns a new Logger instance with additional key/value pairs.\n// See Info for documentation on how key/value pairs work.\nfunc (l Logger) WithValues(keysAndValues ...any) Logger {\n\tif l.sink == nil {\n\t\treturn l\n\t}\n\tl.setSink(l.sink.WithValues(keysAndValues...))\n\treturn l\n}\n\n// WithName returns a new Logger instance with the specified name element added\n// to the Logger's name. Successive calls with WithName append additional\n// suffixes to the Logger's name. It's strongly recommended that name segments\n// contain only letters, digits, and hyphens (see the package documentation for\n// more information).\nfunc (l Logger) WithName(name string) Logger {\n\tif l.sink == nil {\n\t\treturn l\n\t}\n\tl.setSink(l.sink.WithName(name))\n\treturn l\n}\n\n// WithCallDepth returns a Logger instance that offsets the call stack by the\n// specified number of frames when logging call site information, if possible.\n// This is useful for users who have helper functions between the \"real\" call\n// site and the actual calls to Logger methods. If depth is 0 the attribution\n// should be to the direct caller of this function. If depth is 1 the\n// attribution should skip 1 call frame, and so on. Successive calls to this\n// are additive.\n//\n// If the underlying log implementation supports a WithCallDepth(int) method,\n// it will be called and the result returned. If the implementation does not\n// support CallDepthLogSink, the original Logger will be returned.\n//\n// To skip one level, WithCallStackHelper() should be used instead of\n// WithCallDepth(1) because it works with implementions that support the\n// CallDepthLogSink and/or CallStackHelperLogSink interfaces.\nfunc (l Logger) WithCallDepth(depth int) Logger {\n\tif l.sink == nil {\n\t\treturn l\n\t}\n\tif withCallDepth, ok := l.sink.(CallDepthLogSink); ok {\n\t\tl.setSink(withCallDepth.WithCallDepth(depth))\n\t}\n\treturn l\n}\n\n// WithCallStackHelper returns a new Logger instance that skips the direct\n// caller when logging call site information, if possible. This is useful for\n// users who have helper functions between the \"real\" call site and the actual\n// calls to Logger methods and want to support loggers which depend on marking\n// each individual helper function, like loggers based on testing.T.\n//\n// In addition to using that new logger instance, callers also must call the\n// returned function.\n//\n// If the underlying log implementation supports a WithCallDepth(int) method,\n// WithCallDepth(1) will be called to produce a new logger. If it supports a\n// WithCallStackHelper() method, that will be also called. If the\n// implementation does not support either of these, the original Logger will be\n// returned.\nfunc (l Logger) WithCallStackHelper() (func(), Logger) {\n\tif l.sink == nil {\n\t\treturn func() {}, l\n\t}\n\tvar helper func()\n\tif withCallDepth, ok := l.sink.(CallDepthLogSink); ok {\n\t\tl.setSink(withCallDepth.WithCallDepth(1))\n\t}\n\tif withHelper, ok := l.sink.(CallStackHelperLogSink); ok {\n\t\thelper = withHelper.GetCallStackHelper()\n\t} else {\n\t\thelper = func() {}\n\t}\n\treturn helper, l\n}\n\n// IsZero returns true if this logger is an uninitialized zero value\nfunc (l Logger) IsZero() bool {\n\treturn l.sink == nil\n}\n\n// RuntimeInfo holds information that the logr \"core\" library knows which\n// LogSinks might want to know.\ntype RuntimeInfo struct {\n\t// CallDepth is the number of call frames the logr library adds between the\n\t// end-user and the LogSink. LogSink implementations which choose to print\n\t// the original logging site (e.g. file & line) should climb this many\n\t// additional frames to find it.\n\tCallDepth int\n}\n\n// runtimeInfo is a static global. It must not be changed at run time.\nvar runtimeInfo = RuntimeInfo{\n\tCallDepth: 1,\n}\n\n// LogSink represents a logging implementation. End-users will generally not\n// interact with this type.\ntype LogSink interface {\n\t// Init receives optional information about the logr library for LogSink\n\t// implementations that need it.\n\tInit(info RuntimeInfo)\n\n\t// Enabled tests whether this LogSink is enabled at the specified V-level.\n\t// For example, commandline flags might be used to set the logging\n\t// verbosity and disable some info logs.\n\tEnabled(level int) bool\n\n\t// Info logs a non-error message with the given key/value pairs as context.\n\t// The level argument is provided for optional logging. This method will\n\t// only be called when Enabled(level) is true. See Logger.Info for more\n\t// details.\n\tInfo(level int, msg string, keysAndValues ...any)\n\n\t// Error logs an error, with the given message and key/value pairs as\n\t// context. See Logger.Error for more details.\n\tError(err error, msg string, keysAndValues ...any)\n\n\t// WithValues returns a new LogSink with additional key/value pairs. See\n\t// Logger.WithValues for more details.\n\tWithValues(keysAndValues ...any) LogSink\n\n\t// WithName returns a new LogSink with the specified name appended. See\n\t// Logger.WithName for more details.\n\tWithName(name string) LogSink\n}\n\n// CallDepthLogSink represents a LogSink that knows how to climb the call stack\n// to identify the original call site and can offset the depth by a specified\n// number of frames. This is useful for users who have helper functions\n// between the \"real\" call site and the actual calls to Logger methods.\n// Implementations that log information about the call site (such as file,\n// function, or line) would otherwise log information about the intermediate\n// helper functions.\n//\n// This is an optional interface and implementations are not required to\n// support it.\ntype CallDepthLogSink interface {\n\t// WithCallDepth returns a LogSink that will offset the call\n\t// stack by the specified number of frames when logging call\n\t// site information.\n\t//\n\t// If depth is 0, the LogSink should skip exactly the number\n\t// of call frames defined in RuntimeInfo.CallDepth when Info\n\t// or Error are called, i.e. the attribution should be to the\n\t// direct caller of Logger.Info or Logger.Error.\n\t//\n\t// If depth is 1 the attribution should skip 1 call frame, and so on.\n\t// Successive calls to this are additive.\n\tWithCallDepth(depth int) LogSink\n}\n\n// CallStackHelperLogSink represents a LogSink that knows how to climb\n// the call stack to identify the original call site and can skip\n// intermediate helper functions if they mark themselves as\n// helper. Go's testing package uses that approach.\n//\n// This is useful for users who have helper functions between the\n// \"real\" call site and the actual calls to Logger methods.\n// Implementations that log information about the call site (such as\n// file, function, or line) would otherwise log information about the\n// intermediate helper functions.\n//\n// This is an optional interface and implementations are not required\n// to support it. Implementations that choose to support this must not\n// simply implement it as WithCallDepth(1), because\n// Logger.WithCallStackHelper will call both methods if they are\n// present. This should only be implemented for LogSinks that actually\n// need it, as with testing.T.\ntype CallStackHelperLogSink interface {\n\t// GetCallStackHelper returns a function that must be called\n\t// to mark the direct caller as helper function when logging\n\t// call site information.\n\tGetCallStackHelper() func()\n}\n\n// Marshaler is an optional interface that logged values may choose to\n// implement. Loggers with structured output, such as JSON, should\n// log the object return by the MarshalLog method instead of the\n// original value.\ntype Marshaler interface {\n\t// MarshalLog can be used to:\n\t// - ensure that structs are not logged as strings when the original\n\t// value has a String method: return a different type without a\n\t// String method\n\t// - select which fields of a complex type should get logged:\n\t// return a simpler struct with fewer fields\n\t// - log unexported fields: return a different struct\n\t// with exported fields\n\t//\n\t// It may return any value of any type.\n\tMarshalLog() any\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/sloghandler.go",
"content": "//go:build go1.21\n// +build go1.21\n\n/*\nCopyright 2023 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\npackage logr\n\nimport (\n\t\"context\"\n\t\"log/slog\"\n)\n\ntype slogHandler struct {\n\t// May be nil, in which case all logs get discarded.\n\tsink LogSink\n\t// Non-nil if sink is non-nil and implements SlogSink.\n\tslogSink SlogSink\n\n\t// groupPrefix collects values from WithGroup calls. It gets added as\n\t// prefix to value keys when handling a log record.\n\tgroupPrefix string\n\n\t// levelBias can be set when constructing the handler to influence the\n\t// slog.Level of log records. A positive levelBias reduces the\n\t// slog.Level value. slog has no API to influence this value after the\n\t// handler got created, so it can only be set indirectly through\n\t// Logger.V.\n\tlevelBias slog.Level\n}\n\nvar _ slog.Handler = &slogHandler{}\n\n// groupSeparator is used to concatenate WithGroup names and attribute keys.\nconst groupSeparator = \".\"\n\n// GetLevel is used for black box unit testing.\nfunc (l *slogHandler) GetLevel() slog.Level {\n\treturn l.levelBias\n}\n\nfunc (l *slogHandler) Enabled(_ context.Context, level slog.Level) bool {\n\treturn l.sink != nil && (level >= slog.LevelError || l.sink.Enabled(l.levelFromSlog(level)))\n}\n\nfunc (l *slogHandler) Handle(ctx context.Context, record slog.Record) error {\n\tif l.slogSink != nil {\n\t\t// Only adjust verbosity level of log entries < slog.LevelError.\n\t\tif record.Level < slog.LevelError {\n\t\t\trecord.Level -= l.levelBias\n\t\t}\n\t\treturn l.slogSink.Handle(ctx, record)\n\t}\n\n\t// No need to check for nil sink here because Handle will only be called\n\t// when Enabled returned true.\n\n\tkvList := make([]any, 0, 2*record.NumAttrs())\n\trecord.Attrs(func(attr slog.Attr) bool {\n\t\tkvList = attrToKVs(attr, l.groupPrefix, kvList)\n\t\treturn true\n\t})\n\tif record.Level >= slog.LevelError {\n\t\tl.sinkWithCallDepth().Error(nil, record.Message, kvList...)\n\t} else {\n\t\tlevel := l.levelFromSlog(record.Level)\n\t\tl.sinkWithCallDepth().Info(level, record.Message, kvList...)\n\t}\n\treturn nil\n}\n\n// sinkWithCallDepth adjusts the stack unwinding so that when Error or Info\n// are called by Handle, code in slog gets skipped.\n//\n// This offset currently (Go 1.21.0) works for calls through\n// slog.New(ToSlogHandler(...)). There's no guarantee that the call\n// chain won't change. Wrapping the handler will also break unwinding. It's\n// still better than not adjusting at all....\n//\n// This cannot be done when constructing the handler because FromSlogHandler needs\n// access to the original sink without this adjustment. A second copy would\n// work, but then WithAttrs would have to be called for both of them.\nfunc (l *slogHandler) sinkWithCallDepth() LogSink {\n\tif sink, ok := l.sink.(CallDepthLogSink); ok {\n\t\treturn sink.WithCallDepth(2)\n\t}\n\treturn l.sink\n}\n\nfunc (l *slogHandler) WithAttrs(attrs []slog.Attr) slog.Handler {\n\tif l.sink == nil || len(attrs) == 0 {\n\t\treturn l\n\t}\n\n\tclone := *l\n\tif l.slogSink != nil {\n\t\tclone.slogSink = l.slogSink.WithAttrs(attrs)\n\t\tclone.sink = clone.slogSink\n\t} else {\n\t\tkvList := make([]any, 0, 2*len(attrs))\n\t\tfor _, attr := range attrs {\n\t\t\tkvList = attrToKVs(attr, l.groupPrefix, kvList)\n\t\t}\n\t\tclone.sink = l.sink.WithValues(kvList...)\n\t}\n\treturn &clone\n}\n\nfunc (l *slogHandler) WithGroup(name string) slog.Handler {\n\tif l.sink == nil {\n\t\treturn l\n\t}\n\tif name == \"\" {\n\t\t// slog says to inline empty groups\n\t\treturn l\n\t}\n\tclone := *l\n\tif l.slogSink != nil {\n\t\tclone.slogSink = l.slogSink.WithGroup(name)\n\t\tclone.sink = clone.slogSink\n\t} else {\n\t\tclone.groupPrefix = addPrefix(clone.groupPrefix, name)\n\t}\n\treturn &clone\n}\n\n// attrToKVs appends a slog.Attr to a logr-style kvList. It handle slog Groups\n// and other details of slog.\nfunc attrToKVs(attr slog.Attr, groupPrefix string, kvList []any) []any {\n\tattrVal := attr.Value.Resolve()\n\tif attrVal.Kind() == slog.KindGroup {\n\t\tgroupVal := attrVal.Group()\n\t\tgrpKVs := make([]any, 0, 2*len(groupVal))\n\t\tprefix := groupPrefix\n\t\tif attr.Key != \"\" {\n\t\t\tprefix = addPrefix(groupPrefix, attr.Key)\n\t\t}\n\t\tfor _, attr := range groupVal {\n\t\t\tgrpKVs = attrToKVs(attr, prefix, grpKVs)\n\t\t}\n\t\tkvList = append(kvList, grpKVs...)\n\t} else if attr.Key != \"\" {\n\t\tkvList = append(kvList, addPrefix(groupPrefix, attr.Key), attrVal.Any())\n\t}\n\n\treturn kvList\n}\n\nfunc addPrefix(prefix, name string) string {\n\tif prefix == \"\" {\n\t\treturn name\n\t}\n\tif name == \"\" {\n\t\treturn prefix\n\t}\n\treturn prefix + groupSeparator + name\n}\n\n// levelFromSlog adjusts the level by the logger's verbosity and negates it.\n// It ensures that the result is >= 0. This is necessary because the result is\n// passed to a LogSink and that API did not historically document whether\n// levels could be negative or what that meant.\n//\n// Some example usage:\n//\n//\tlogrV0 := getMyLogger()\n//\tlogrV2 := logrV0.V(2)\n//\tslogV2 := slog.New(logr.ToSlogHandler(logrV2))\n//\tslogV2.Debug(\"msg\") // =~ logrV2.V(4) =~ logrV0.V(6)\n//\tslogV2.Info(\"msg\") // =~ logrV2.V(0) =~ logrV0.V(2)\n//\tslogv2.Warn(\"msg\") // =~ logrV2.V(-4) =~ logrV0.V(0)\nfunc (l *slogHandler) levelFromSlog(level slog.Level) int {\n\tresult := -level\n\tresult += l.levelBias // in case the original Logger had a V level\n\tif result < 0 {\n\t\tresult = 0 // because LogSink doesn't expect negative V levels\n\t}\n\treturn int(result)\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/slogr.go",
"content": "//go:build go1.21\n// +build go1.21\n\n/*\nCopyright 2023 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\npackage logr\n\nimport (\n\t\"context\"\n\t\"log/slog\"\n)\n\n// FromSlogHandler returns a Logger which writes to the slog.Handler.\n//\n// The logr verbosity level is mapped to slog levels such that V(0) becomes\n// slog.LevelInfo and V(4) becomes slog.LevelDebug.\nfunc FromSlogHandler(handler slog.Handler) Logger {\n\tif handler, ok := handler.(*slogHandler); ok {\n\t\tif handler.sink == nil {\n\t\t\treturn Discard()\n\t\t}\n\t\treturn New(handler.sink).V(int(handler.levelBias))\n\t}\n\treturn New(&slogSink{handler: handler})\n}\n\n// ToSlogHandler returns a slog.Handler which writes to the same sink as the Logger.\n//\n// The returned logger writes all records with level >= slog.LevelError as\n// error log entries with LogSink.Error, regardless of the verbosity level of\n// the Logger:\n//\n//\tlogger := \n//\tslog.New(ToSlogHandler(logger.V(10))).Error(...) -> logSink.Error(...)\n//\n// The level of all other records gets reduced by the verbosity\n// level of the Logger and the result is negated. If it happens\n// to be negative, then it gets replaced by zero because a LogSink\n// is not expected to handled negative levels:\n//\n//\tslog.New(ToSlogHandler(logger)).Debug(...) -> logger.GetSink().Info(level=4, ...)\n//\tslog.New(ToSlogHandler(logger)).Warning(...) -> logger.GetSink().Info(level=0, ...)\n//\tslog.New(ToSlogHandler(logger)).Info(...) -> logger.GetSink().Info(level=0, ...)\n//\tslog.New(ToSlogHandler(logger.V(4))).Info(...) -> logger.GetSink().Info(level=4, ...)\nfunc ToSlogHandler(logger Logger) slog.Handler {\n\tif sink, ok := logger.GetSink().(*slogSink); ok && logger.GetV() == 0 {\n\t\treturn sink.handler\n\t}\n\n\thandler := &slogHandler{sink: logger.GetSink(), levelBias: slog.Level(logger.GetV())}\n\tif slogSink, ok := handler.sink.(SlogSink); ok {\n\t\thandler.slogSink = slogSink\n\t}\n\treturn handler\n}\n\n// SlogSink is an optional interface that a LogSink can implement to support\n// logging through the slog.Logger or slog.Handler APIs better. It then should\n// also support special slog values like slog.Group. When used as a\n// slog.Handler, the advantages are:\n//\n// - stack unwinding gets avoided in favor of logging the pre-recorded PC,\n// as intended by slog\n// - proper grouping of key/value pairs via WithGroup\n// - verbosity levels > slog.LevelInfo can be recorded\n// - less overhead\n//\n// Both APIs (Logger and slog.Logger/Handler) then are supported equally\n// well. Developers can pick whatever API suits them better and/or mix\n// packages which use either API in the same binary with a common logging\n// implementation.\n//\n// This interface is necessary because the type implementing the LogSink\n// interface cannot also implement the slog.Handler interface due to the\n// different prototype of the common Enabled method.\n//\n// An implementation could support both interfaces in two different types, but then\n// additional interfaces would be needed to convert between those types in FromSlogHandler\n// and ToSlogHandler.\ntype SlogSink interface {\n\tLogSink\n\n\tHandle(ctx context.Context, record slog.Record) error\n\tWithAttrs(attrs []slog.Attr) SlogSink\n\tWithGroup(name string) SlogSink\n}\n"
},
{
"path": "tests/vendor/github.com/go-logr/logr/slogsink.go",
"content": "//go:build go1.21\n// +build go1.21\n\n/*\nCopyright 2023 The logr Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\npackage logr\n\nimport (\n\t\"context\"\n\t\"log/slog\"\n\t\"runtime\"\n\t\"time\"\n)\n\nvar (\n\t_ LogSink = &slogSink{}\n\t_ CallDepthLogSink = &slogSink{}\n\t_ Underlier = &slogSink{}\n)\n\n// Underlier is implemented by the LogSink returned by NewFromLogHandler.\ntype Underlier interface {\n\t// GetUnderlying returns the Handler used by the LogSink.\n\tGetUnderlying() slog.Handler\n}\n\nconst (\n\t// nameKey is used to log the `WithName` values as an additional attribute.\n\tnameKey = \"logger\"\n\n\t// errKey is used to log the error parameter of Error as an additional attribute.\n\terrKey = \"err\"\n)\n\ntype slogSink struct {\n\tcallDepth int\n\tname string\n\thandler slog.Handler\n}\n\nfunc (l *slogSink) Init(info RuntimeInfo) {\n\tl.callDepth = info.CallDepth\n}\n\nfunc (l *slogSink) GetUnderlying() slog.Handler {\n\treturn l.handler\n}\n\nfunc (l *slogSink) WithCallDepth(depth int) LogSink {\n\tnewLogger := *l\n\tnewLogger.callDepth += depth\n\treturn &newLogger\n}\n\nfunc (l *slogSink) Enabled(level int) bool {\n\treturn l.handler.Enabled(context.Background(), slog.Level(-level))\n}\n\nfunc (l *slogSink) Info(level int, msg string, kvList ...interface{}) {\n\tl.log(nil, msg, slog.Level(-level), kvList...)\n}\n\nfunc (l *slogSink) Error(err error, msg string, kvList ...interface{}) {\n\tl.log(err, msg, slog.LevelError, kvList...)\n}\n\nfunc (l *slogSink) log(err error, msg string, level slog.Level, kvList ...interface{}) {\n\tvar pcs [1]uintptr\n\t// skip runtime.Callers, this function, Info/Error, and all helper functions above that.\n\truntime.Callers(3+l.callDepth, pcs[:])\n\n\trecord := slog.NewRecord(time.Now(), level, msg, pcs[0])\n\tif l.name != \"\" {\n\t\trecord.AddAttrs(slog.String(nameKey, l.name))\n\t}\n\tif err != nil {\n\t\trecord.AddAttrs(slog.Any(errKey, err))\n\t}\n\trecord.Add(kvList...)\n\t_ = l.handler.Handle(context.Background(), record)\n}\n\nfunc (l slogSink) WithName(name string) LogSink {\n\tif l.name != \"\" {\n\t\tl.name += \"/\"\n\t}\n\tl.name += name\n\treturn &l\n}\n\nfunc (l slogSink) WithValues(kvList ...interface{}) LogSink {\n\tl.handler = l.handler.WithAttrs(kvListToAttrs(kvList...))\n\treturn &l\n}\n\nfunc kvListToAttrs(kvList ...interface{}) []slog.Attr {\n\t// We don't need the record itself, only its Add method.\n\trecord := slog.NewRecord(time.Time{}, 0, \"\", 0)\n\trecord.Add(kvList...)\n\tattrs := make([]slog.Attr, 0, record.NumAttrs())\n\trecord.Attrs(func(attr slog.Attr) bool {\n\t\tattrs = append(attrs, attr)\n\t\treturn true\n\t})\n\treturn attrs\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/LICENSE",
"content": "Copyright (c) 2017 The Go Authors. All rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n * Redistributions of source code must retain the above copyright\nnotice, this list of conditions and the following disclaimer.\n * Redistributions in binary form must reproduce the above\ncopyright notice, this list of conditions and the following disclaimer\nin the documentation and/or other materials provided with the\ndistribution.\n * Neither the name of Google Inc. nor the names of its\ncontributors may be used to endorse or promote products derived from\nthis software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\nLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\nDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\nTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/compare.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package cmp determines equality of values.\n//\n// This package is intended to be a more powerful and safer alternative to\n// [reflect.DeepEqual] for comparing whether two values are semantically equal.\n// It is intended to only be used in tests, as performance is not a goal and\n// it may panic if it cannot compare the values. Its propensity towards\n// panicking means that its unsuitable for production environments where a\n// spurious panic may be fatal.\n//\n// The primary features of cmp are:\n//\n// - When the default behavior of equality does not suit the test's needs,\n// custom equality functions can override the equality operation.\n// For example, an equality function may report floats as equal so long as\n// they are within some tolerance of each other.\n//\n// - Types with an Equal method (e.g., [time.Time.Equal]) may use that method\n// to determine equality. This allows package authors to determine\n// the equality operation for the types that they define.\n//\n// - If no custom equality functions are used and no Equal method is defined,\n// equality is determined by recursively comparing the primitive kinds on\n// both values, much like [reflect.DeepEqual]. Unlike [reflect.DeepEqual],\n// unexported fields are not compared by default; they result in panics\n// unless suppressed by using an [Ignore] option\n// (see [github.com/google/go-cmp/cmp/cmpopts.IgnoreUnexported])\n// or explicitly compared using the [Exporter] option.\npackage cmp\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\t\"strings\"\n\n\t\"github.com/google/go-cmp/cmp/internal/diff\"\n\t\"github.com/google/go-cmp/cmp/internal/function\"\n\t\"github.com/google/go-cmp/cmp/internal/value\"\n)\n\n// TODO(≥go1.18): Use any instead of interface{}.\n\n// Equal reports whether x and y are equal by recursively applying the\n// following rules in the given order to x and y and all of their sub-values:\n//\n// - Let S be the set of all [Ignore], [Transformer], and [Comparer] options that\n// remain after applying all path filters, value filters, and type filters.\n// If at least one [Ignore] exists in S, then the comparison is ignored.\n// If the number of [Transformer] and [Comparer] options in S is non-zero,\n// then Equal panics because it is ambiguous which option to use.\n// If S contains a single [Transformer], then use that to transform\n// the current values and recursively call Equal on the output values.\n// If S contains a single [Comparer], then use that to compare the current values.\n// Otherwise, evaluation proceeds to the next rule.\n//\n// - If the values have an Equal method of the form \"(T) Equal(T) bool\" or\n// \"(T) Equal(I) bool\" where T is assignable to I, then use the result of\n// x.Equal(y) even if x or y is nil. Otherwise, no such method exists and\n// evaluation proceeds to the next rule.\n//\n// - Lastly, try to compare x and y based on their basic kinds.\n// Simple kinds like booleans, integers, floats, complex numbers, strings,\n// and channels are compared using the equivalent of the == operator in Go.\n// Functions are only equal if they are both nil, otherwise they are unequal.\n//\n// Structs are equal if recursively calling Equal on all fields report equal.\n// If a struct contains unexported fields, Equal panics unless an [Ignore] option\n// (e.g., [github.com/google/go-cmp/cmp/cmpopts.IgnoreUnexported]) ignores that field\n// or the [Exporter] option explicitly permits comparing the unexported field.\n//\n// Slices are equal if they are both nil or both non-nil, where recursively\n// calling Equal on all non-ignored slice or array elements report equal.\n// Empty non-nil slices and nil slices are not equal; to equate empty slices,\n// consider using [github.com/google/go-cmp/cmp/cmpopts.EquateEmpty].\n//\n// Maps are equal if they are both nil or both non-nil, where recursively\n// calling Equal on all non-ignored map entries report equal.\n// Map keys are equal according to the == operator.\n// To use custom comparisons for map keys, consider using\n// [github.com/google/go-cmp/cmp/cmpopts.SortMaps].\n// Empty non-nil maps and nil maps are not equal; to equate empty maps,\n// consider using [github.com/google/go-cmp/cmp/cmpopts.EquateEmpty].\n//\n// Pointers and interfaces are equal if they are both nil or both non-nil,\n// where they have the same underlying concrete type and recursively\n// calling Equal on the underlying values reports equal.\n//\n// Before recursing into a pointer, slice element, or map, the current path\n// is checked to detect whether the address has already been visited.\n// If there is a cycle, then the pointed at values are considered equal\n// only if both addresses were previously visited in the same path step.\nfunc Equal(x, y interface{}, opts ...Option) bool {\n\ts := newState(opts)\n\ts.compareAny(rootStep(x, y))\n\treturn s.result.Equal()\n}\n\n// Diff returns a human-readable report of the differences between two values:\n// y - x. It returns an empty string if and only if Equal returns true for the\n// same input values and options.\n//\n// The output is displayed as a literal in pseudo-Go syntax.\n// At the start of each line, a \"-\" prefix indicates an element removed from x,\n// a \"+\" prefix to indicates an element added from y, and the lack of a prefix\n// indicates an element common to both x and y. If possible, the output\n// uses fmt.Stringer.String or error.Error methods to produce more humanly\n// readable outputs. In such cases, the string is prefixed with either an\n// 's' or 'e' character, respectively, to indicate that the method was called.\n//\n// Do not depend on this output being stable. If you need the ability to\n// programmatically interpret the difference, consider using a custom Reporter.\nfunc Diff(x, y interface{}, opts ...Option) string {\n\ts := newState(opts)\n\n\t// Optimization: If there are no other reporters, we can optimize for the\n\t// common case where the result is equal (and thus no reported difference).\n\t// This avoids the expensive construction of a difference tree.\n\tif len(s.reporters) == 0 {\n\t\ts.compareAny(rootStep(x, y))\n\t\tif s.result.Equal() {\n\t\t\treturn \"\"\n\t\t}\n\t\ts.result = diff.Result{} // Reset results\n\t}\n\n\tr := new(defaultReporter)\n\ts.reporters = append(s.reporters, reporter{r})\n\ts.compareAny(rootStep(x, y))\n\td := r.String()\n\tif (d == \"\") != s.result.Equal() {\n\t\tpanic(\"inconsistent difference and equality results\")\n\t}\n\treturn d\n}\n\n// rootStep constructs the first path step. If x and y have differing types,\n// then they are stored within an empty interface type.\nfunc rootStep(x, y interface{}) PathStep {\n\tvx := reflect.ValueOf(x)\n\tvy := reflect.ValueOf(y)\n\n\t// If the inputs are different types, auto-wrap them in an empty interface\n\t// so that they have the same parent type.\n\tvar t reflect.Type\n\tif !vx.IsValid() || !vy.IsValid() || vx.Type() != vy.Type() {\n\t\tt = anyType\n\t\tif vx.IsValid() {\n\t\t\tvvx := reflect.New(t).Elem()\n\t\t\tvvx.Set(vx)\n\t\t\tvx = vvx\n\t\t}\n\t\tif vy.IsValid() {\n\t\t\tvvy := reflect.New(t).Elem()\n\t\t\tvvy.Set(vy)\n\t\t\tvy = vvy\n\t\t}\n\t} else {\n\t\tt = vx.Type()\n\t}\n\n\treturn &pathStep{t, vx, vy}\n}\n\ntype state struct {\n\t// These fields represent the \"comparison state\".\n\t// Calling statelessCompare must not result in observable changes to these.\n\tresult diff.Result // The current result of comparison\n\tcurPath Path // The current path in the value tree\n\tcurPtrs pointerPath // The current set of visited pointers\n\treporters []reporter // Optional reporters\n\n\t// recChecker checks for infinite cycles applying the same set of\n\t// transformers upon the output of itself.\n\trecChecker recChecker\n\n\t// dynChecker triggers pseudo-random checks for option correctness.\n\t// It is safe for statelessCompare to mutate this value.\n\tdynChecker dynChecker\n\n\t// These fields, once set by processOption, will not change.\n\texporters []exporter // List of exporters for structs with unexported fields\n\topts Options // List of all fundamental and filter options\n}\n\nfunc newState(opts []Option) *state {\n\t// Always ensure a validator option exists to validate the inputs.\n\ts := &state{opts: Options{validator{}}}\n\ts.curPtrs.Init()\n\ts.processOption(Options(opts))\n\treturn s\n}\n\nfunc (s *state) processOption(opt Option) {\n\tswitch opt := opt.(type) {\n\tcase nil:\n\tcase Options:\n\t\tfor _, o := range opt {\n\t\t\ts.processOption(o)\n\t\t}\n\tcase coreOption:\n\t\ttype filtered interface {\n\t\t\tisFiltered() bool\n\t\t}\n\t\tif fopt, ok := opt.(filtered); ok && !fopt.isFiltered() {\n\t\t\tpanic(fmt.Sprintf(\"cannot use an unfiltered option: %v\", opt))\n\t\t}\n\t\ts.opts = append(s.opts, opt)\n\tcase exporter:\n\t\ts.exporters = append(s.exporters, opt)\n\tcase reporter:\n\t\ts.reporters = append(s.reporters, opt)\n\tdefault:\n\t\tpanic(fmt.Sprintf(\"unknown option %T\", opt))\n\t}\n}\n\n// statelessCompare compares two values and returns the result.\n// This function is stateless in that it does not alter the current result,\n// or output to any registered reporters.\nfunc (s *state) statelessCompare(step PathStep) diff.Result {\n\t// We do not save and restore curPath and curPtrs because all of the\n\t// compareX methods should properly push and pop from them.\n\t// It is an implementation bug if the contents of the paths differ from\n\t// when calling this function to when returning from it.\n\n\toldResult, oldReporters := s.result, s.reporters\n\ts.result = diff.Result{} // Reset result\n\ts.reporters = nil // Remove reporters to avoid spurious printouts\n\ts.compareAny(step)\n\tres := s.result\n\ts.result, s.reporters = oldResult, oldReporters\n\treturn res\n}\n\nfunc (s *state) compareAny(step PathStep) {\n\t// Update the path stack.\n\ts.curPath.push(step)\n\tdefer s.curPath.pop()\n\tfor _, r := range s.reporters {\n\t\tr.PushStep(step)\n\t\tdefer r.PopStep()\n\t}\n\ts.recChecker.Check(s.curPath)\n\n\t// Cycle-detection for slice elements (see NOTE in compareSlice).\n\tt := step.Type()\n\tvx, vy := step.Values()\n\tif si, ok := step.(SliceIndex); ok && si.isSlice && vx.IsValid() && vy.IsValid() {\n\t\tpx, py := vx.Addr(), vy.Addr()\n\t\tif eq, visited := s.curPtrs.Push(px, py); visited {\n\t\t\ts.report(eq, reportByCycle)\n\t\t\treturn\n\t\t}\n\t\tdefer s.curPtrs.Pop(px, py)\n\t}\n\n\t// Rule 1: Check whether an option applies on this node in the value tree.\n\tif s.tryOptions(t, vx, vy) {\n\t\treturn\n\t}\n\n\t// Rule 2: Check whether the type has a valid Equal method.\n\tif s.tryMethod(t, vx, vy) {\n\t\treturn\n\t}\n\n\t// Rule 3: Compare based on the underlying kind.\n\tswitch t.Kind() {\n\tcase reflect.Bool:\n\t\ts.report(vx.Bool() == vy.Bool(), 0)\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\ts.report(vx.Int() == vy.Int(), 0)\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\ts.report(vx.Uint() == vy.Uint(), 0)\n\tcase reflect.Float32, reflect.Float64:\n\t\ts.report(vx.Float() == vy.Float(), 0)\n\tcase reflect.Complex64, reflect.Complex128:\n\t\ts.report(vx.Complex() == vy.Complex(), 0)\n\tcase reflect.String:\n\t\ts.report(vx.String() == vy.String(), 0)\n\tcase reflect.Chan, reflect.UnsafePointer:\n\t\ts.report(vx.Pointer() == vy.Pointer(), 0)\n\tcase reflect.Func:\n\t\ts.report(vx.IsNil() && vy.IsNil(), 0)\n\tcase reflect.Struct:\n\t\ts.compareStruct(t, vx, vy)\n\tcase reflect.Slice, reflect.Array:\n\t\ts.compareSlice(t, vx, vy)\n\tcase reflect.Map:\n\t\ts.compareMap(t, vx, vy)\n\tcase reflect.Ptr:\n\t\ts.comparePtr(t, vx, vy)\n\tcase reflect.Interface:\n\t\ts.compareInterface(t, vx, vy)\n\tdefault:\n\t\tpanic(fmt.Sprintf(\"%v kind not handled\", t.Kind()))\n\t}\n}\n\nfunc (s *state) tryOptions(t reflect.Type, vx, vy reflect.Value) bool {\n\t// Evaluate all filters and apply the remaining options.\n\tif opt := s.opts.filter(s, t, vx, vy); opt != nil {\n\t\topt.apply(s, vx, vy)\n\t\treturn true\n\t}\n\treturn false\n}\n\nfunc (s *state) tryMethod(t reflect.Type, vx, vy reflect.Value) bool {\n\t// Check if this type even has an Equal method.\n\tm, ok := t.MethodByName(\"Equal\")\n\tif !ok || !function.IsType(m.Type, function.EqualAssignable) {\n\t\treturn false\n\t}\n\n\teq := s.callTTBFunc(m.Func, vx, vy)\n\ts.report(eq, reportByMethod)\n\treturn true\n}\n\nfunc (s *state) callTRFunc(f, v reflect.Value, step Transform) reflect.Value {\n\tif !s.dynChecker.Next() {\n\t\treturn f.Call([]reflect.Value{v})[0]\n\t}\n\n\t// Run the function twice and ensure that we get the same results back.\n\t// We run in goroutines so that the race detector (if enabled) can detect\n\t// unsafe mutations to the input.\n\tc := make(chan reflect.Value)\n\tgo detectRaces(c, f, v)\n\tgot := <-c\n\twant := f.Call([]reflect.Value{v})[0]\n\tif step.vx, step.vy = got, want; !s.statelessCompare(step).Equal() {\n\t\t// To avoid false-positives with non-reflexive equality operations,\n\t\t// we sanity check whether a value is equal to itself.\n\t\tif step.vx, step.vy = want, want; !s.statelessCompare(step).Equal() {\n\t\t\treturn want\n\t\t}\n\t\tpanic(fmt.Sprintf(\"non-deterministic function detected: %s\", function.NameOf(f)))\n\t}\n\treturn want\n}\n\nfunc (s *state) callTTBFunc(f, x, y reflect.Value) bool {\n\tif !s.dynChecker.Next() {\n\t\treturn f.Call([]reflect.Value{x, y})[0].Bool()\n\t}\n\n\t// Swapping the input arguments is sufficient to check that\n\t// f is symmetric and deterministic.\n\t// We run in goroutines so that the race detector (if enabled) can detect\n\t// unsafe mutations to the input.\n\tc := make(chan reflect.Value)\n\tgo detectRaces(c, f, y, x)\n\tgot := <-c\n\twant := f.Call([]reflect.Value{x, y})[0].Bool()\n\tif !got.IsValid() || got.Bool() != want {\n\t\tpanic(fmt.Sprintf(\"non-deterministic or non-symmetric function detected: %s\", function.NameOf(f)))\n\t}\n\treturn want\n}\n\nfunc detectRaces(c chan<- reflect.Value, f reflect.Value, vs ...reflect.Value) {\n\tvar ret reflect.Value\n\tdefer func() {\n\t\trecover() // Ignore panics, let the other call to f panic instead\n\t\tc <- ret\n\t}()\n\tret = f.Call(vs)[0]\n}\n\nfunc (s *state) compareStruct(t reflect.Type, vx, vy reflect.Value) {\n\tvar addr bool\n\tvar vax, vay reflect.Value // Addressable versions of vx and vy\n\n\tvar mayForce, mayForceInit bool\n\tstep := StructField{&structField{}}\n\tfor i := 0; i < t.NumField(); i++ {\n\t\tstep.typ = t.Field(i).Type\n\t\tstep.vx = vx.Field(i)\n\t\tstep.vy = vy.Field(i)\n\t\tstep.name = t.Field(i).Name\n\t\tstep.idx = i\n\t\tstep.unexported = !isExported(step.name)\n\t\tif step.unexported {\n\t\t\tif step.name == \"_\" {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\t// Defer checking of unexported fields until later to give an\n\t\t\t// Ignore a chance to ignore the field.\n\t\t\tif !vax.IsValid() || !vay.IsValid() {\n\t\t\t\t// For retrieveUnexportedField to work, the parent struct must\n\t\t\t\t// be addressable. Create a new copy of the values if\n\t\t\t\t// necessary to make them addressable.\n\t\t\t\taddr = vx.CanAddr() || vy.CanAddr()\n\t\t\t\tvax = makeAddressable(vx)\n\t\t\t\tvay = makeAddressable(vy)\n\t\t\t}\n\t\t\tif !mayForceInit {\n\t\t\t\tfor _, xf := range s.exporters {\n\t\t\t\t\tmayForce = mayForce || xf(t)\n\t\t\t\t}\n\t\t\t\tmayForceInit = true\n\t\t\t}\n\t\t\tstep.mayForce = mayForce\n\t\t\tstep.paddr = addr\n\t\t\tstep.pvx = vax\n\t\t\tstep.pvy = vay\n\t\t\tstep.field = t.Field(i)\n\t\t}\n\t\ts.compareAny(step)\n\t}\n}\n\nfunc (s *state) compareSlice(t reflect.Type, vx, vy reflect.Value) {\n\tisSlice := t.Kind() == reflect.Slice\n\tif isSlice && (vx.IsNil() || vy.IsNil()) {\n\t\ts.report(vx.IsNil() && vy.IsNil(), 0)\n\t\treturn\n\t}\n\n\t// NOTE: It is incorrect to call curPtrs.Push on the slice header pointer\n\t// since slices represents a list of pointers, rather than a single pointer.\n\t// The pointer checking logic must be handled on a per-element basis\n\t// in compareAny.\n\t//\n\t// A slice header (see reflect.SliceHeader) in Go is a tuple of a starting\n\t// pointer P, a length N, and a capacity C. Supposing each slice element has\n\t// a memory size of M, then the slice is equivalent to the list of pointers:\n\t//\t[P+i*M for i in range(N)]\n\t//\n\t// For example, v[:0] and v[:1] are slices with the same starting pointer,\n\t// but they are clearly different values. Using the slice pointer alone\n\t// violates the assumption that equal pointers implies equal values.\n\n\tstep := SliceIndex{&sliceIndex{pathStep: pathStep{typ: t.Elem()}, isSlice: isSlice}}\n\twithIndexes := func(ix, iy int) SliceIndex {\n\t\tif ix >= 0 {\n\t\t\tstep.vx, step.xkey = vx.Index(ix), ix\n\t\t} else {\n\t\t\tstep.vx, step.xkey = reflect.Value{}, -1\n\t\t}\n\t\tif iy >= 0 {\n\t\t\tstep.vy, step.ykey = vy.Index(iy), iy\n\t\t} else {\n\t\t\tstep.vy, step.ykey = reflect.Value{}, -1\n\t\t}\n\t\treturn step\n\t}\n\n\t// Ignore options are able to ignore missing elements in a slice.\n\t// However, detecting these reliably requires an optimal differencing\n\t// algorithm, for which diff.Difference is not.\n\t//\n\t// Instead, we first iterate through both slices to detect which elements\n\t// would be ignored if standing alone. The index of non-discarded elements\n\t// are stored in a separate slice, which diffing is then performed on.\n\tvar indexesX, indexesY []int\n\tvar ignoredX, ignoredY []bool\n\tfor ix := 0; ix < vx.Len(); ix++ {\n\t\tignored := s.statelessCompare(withIndexes(ix, -1)).NumDiff == 0\n\t\tif !ignored {\n\t\t\tindexesX = append(indexesX, ix)\n\t\t}\n\t\tignoredX = append(ignoredX, ignored)\n\t}\n\tfor iy := 0; iy < vy.Len(); iy++ {\n\t\tignored := s.statelessCompare(withIndexes(-1, iy)).NumDiff == 0\n\t\tif !ignored {\n\t\t\tindexesY = append(indexesY, iy)\n\t\t}\n\t\tignoredY = append(ignoredY, ignored)\n\t}\n\n\t// Compute an edit-script for slices vx and vy (excluding ignored elements).\n\tedits := diff.Difference(len(indexesX), len(indexesY), func(ix, iy int) diff.Result {\n\t\treturn s.statelessCompare(withIndexes(indexesX[ix], indexesY[iy]))\n\t})\n\n\t// Replay the ignore-scripts and the edit-script.\n\tvar ix, iy int\n\tfor ix < vx.Len() || iy < vy.Len() {\n\t\tvar e diff.EditType\n\t\tswitch {\n\t\tcase ix < len(ignoredX) && ignoredX[ix]:\n\t\t\te = diff.UniqueX\n\t\tcase iy < len(ignoredY) && ignoredY[iy]:\n\t\t\te = diff.UniqueY\n\t\tdefault:\n\t\t\te, edits = edits[0], edits[1:]\n\t\t}\n\t\tswitch e {\n\t\tcase diff.UniqueX:\n\t\t\ts.compareAny(withIndexes(ix, -1))\n\t\t\tix++\n\t\tcase diff.UniqueY:\n\t\t\ts.compareAny(withIndexes(-1, iy))\n\t\t\tiy++\n\t\tdefault:\n\t\t\ts.compareAny(withIndexes(ix, iy))\n\t\t\tix++\n\t\t\tiy++\n\t\t}\n\t}\n}\n\nfunc (s *state) compareMap(t reflect.Type, vx, vy reflect.Value) {\n\tif vx.IsNil() || vy.IsNil() {\n\t\ts.report(vx.IsNil() && vy.IsNil(), 0)\n\t\treturn\n\t}\n\n\t// Cycle-detection for maps.\n\tif eq, visited := s.curPtrs.Push(vx, vy); visited {\n\t\ts.report(eq, reportByCycle)\n\t\treturn\n\t}\n\tdefer s.curPtrs.Pop(vx, vy)\n\n\t// We combine and sort the two map keys so that we can perform the\n\t// comparisons in a deterministic order.\n\tstep := MapIndex{&mapIndex{pathStep: pathStep{typ: t.Elem()}}}\n\tfor _, k := range value.SortKeys(append(vx.MapKeys(), vy.MapKeys()...)) {\n\t\tstep.vx = vx.MapIndex(k)\n\t\tstep.vy = vy.MapIndex(k)\n\t\tstep.key = k\n\t\tif !step.vx.IsValid() && !step.vy.IsValid() {\n\t\t\t// It is possible for both vx and vy to be invalid if the\n\t\t\t// key contained a NaN value in it.\n\t\t\t//\n\t\t\t// Even with the ability to retrieve NaN keys in Go 1.12,\n\t\t\t// there still isn't a sensible way to compare the values since\n\t\t\t// a NaN key may map to multiple unordered values.\n\t\t\t// The most reasonable way to compare NaNs would be to compare the\n\t\t\t// set of values. However, this is impossible to do efficiently\n\t\t\t// since set equality is provably an O(n^2) operation given only\n\t\t\t// an Equal function. If we had a Less function or Hash function,\n\t\t\t// this could be done in O(n*log(n)) or O(n), respectively.\n\t\t\t//\n\t\t\t// Rather than adding complex logic to deal with NaNs, make it\n\t\t\t// the user's responsibility to compare such obscure maps.\n\t\t\tconst help = \"consider providing a Comparer to compare the map\"\n\t\t\tpanic(fmt.Sprintf(\"%#v has map key with NaNs\\n%s\", s.curPath, help))\n\t\t}\n\t\ts.compareAny(step)\n\t}\n}\n\nfunc (s *state) comparePtr(t reflect.Type, vx, vy reflect.Value) {\n\tif vx.IsNil() || vy.IsNil() {\n\t\ts.report(vx.IsNil() && vy.IsNil(), 0)\n\t\treturn\n\t}\n\n\t// Cycle-detection for pointers.\n\tif eq, visited := s.curPtrs.Push(vx, vy); visited {\n\t\ts.report(eq, reportByCycle)\n\t\treturn\n\t}\n\tdefer s.curPtrs.Pop(vx, vy)\n\n\tvx, vy = vx.Elem(), vy.Elem()\n\ts.compareAny(Indirect{&indirect{pathStep{t.Elem(), vx, vy}}})\n}\n\nfunc (s *state) compareInterface(t reflect.Type, vx, vy reflect.Value) {\n\tif vx.IsNil() || vy.IsNil() {\n\t\ts.report(vx.IsNil() && vy.IsNil(), 0)\n\t\treturn\n\t}\n\tvx, vy = vx.Elem(), vy.Elem()\n\tif vx.Type() != vy.Type() {\n\t\ts.report(false, 0)\n\t\treturn\n\t}\n\ts.compareAny(TypeAssertion{&typeAssertion{pathStep{vx.Type(), vx, vy}}})\n}\n\nfunc (s *state) report(eq bool, rf resultFlags) {\n\tif rf&reportByIgnore == 0 {\n\t\tif eq {\n\t\t\ts.result.NumSame++\n\t\t\trf |= reportEqual\n\t\t} else {\n\t\t\ts.result.NumDiff++\n\t\t\trf |= reportUnequal\n\t\t}\n\t}\n\tfor _, r := range s.reporters {\n\t\tr.Report(Result{flags: rf})\n\t}\n}\n\n// recChecker tracks the state needed to periodically perform checks that\n// user provided transformers are not stuck in an infinitely recursive cycle.\ntype recChecker struct{ next int }\n\n// Check scans the Path for any recursive transformers and panics when any\n// recursive transformers are detected. Note that the presence of a\n// recursive Transformer does not necessarily imply an infinite cycle.\n// As such, this check only activates after some minimal number of path steps.\nfunc (rc *recChecker) Check(p Path) {\n\tconst minLen = 1 << 16\n\tif rc.next == 0 {\n\t\trc.next = minLen\n\t}\n\tif len(p) < rc.next {\n\t\treturn\n\t}\n\trc.next <<= 1\n\n\t// Check whether the same transformer has appeared at least twice.\n\tvar ss []string\n\tm := map[Option]int{}\n\tfor _, ps := range p {\n\t\tif t, ok := ps.(Transform); ok {\n\t\t\tt := t.Option()\n\t\t\tif m[t] == 1 { // Transformer was used exactly once before\n\t\t\t\ttf := t.(*transformer).fnc.Type()\n\t\t\t\tss = append(ss, fmt.Sprintf(\"%v: %v => %v\", t, tf.In(0), tf.Out(0)))\n\t\t\t}\n\t\t\tm[t]++\n\t\t}\n\t}\n\tif len(ss) > 0 {\n\t\tconst warning = \"recursive set of Transformers detected\"\n\t\tconst help = \"consider using cmpopts.AcyclicTransformer\"\n\t\tset := strings.Join(ss, \"\\n\\t\")\n\t\tpanic(fmt.Sprintf(\"%s:\\n\\t%s\\n%s\", warning, set, help))\n\t}\n}\n\n// dynChecker tracks the state needed to periodically perform checks that\n// user provided functions are symmetric and deterministic.\n// The zero value is safe for immediate use.\ntype dynChecker struct{ curr, next int }\n\n// Next increments the state and reports whether a check should be performed.\n//\n// Checks occur every Nth function call, where N is a triangular number:\n//\n//\t0 1 3 6 10 15 21 28 36 45 55 66 78 91 105 120 136 153 171 190 ...\n//\n// See https://en.wikipedia.org/wiki/Triangular_number\n//\n// This sequence ensures that the cost of checks drops significantly as\n// the number of functions calls grows larger.\nfunc (dc *dynChecker) Next() bool {\n\tok := dc.curr == dc.next\n\tif ok {\n\t\tdc.curr = 0\n\t\tdc.next++\n\t}\n\tdc.curr++\n\treturn ok\n}\n\n// makeAddressable returns a value that is always addressable.\n// It returns the input verbatim if it is already addressable,\n// otherwise it creates a new value and returns an addressable copy.\nfunc makeAddressable(v reflect.Value) reflect.Value {\n\tif v.CanAddr() {\n\t\treturn v\n\t}\n\tvc := reflect.New(v.Type()).Elem()\n\tvc.Set(v)\n\treturn vc\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/export.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport (\n\t\"reflect\"\n\t\"unsafe\"\n)\n\n// retrieveUnexportedField uses unsafe to forcibly retrieve any field from\n// a struct such that the value has read-write permissions.\n//\n// The parent struct, v, must be addressable, while f must be a StructField\n// describing the field to retrieve. If addr is false,\n// then the returned value will be shallowed copied to be non-addressable.\nfunc retrieveUnexportedField(v reflect.Value, f reflect.StructField, addr bool) reflect.Value {\n\tve := reflect.NewAt(f.Type, unsafe.Pointer(uintptr(unsafe.Pointer(v.UnsafeAddr()))+f.Offset)).Elem()\n\tif !addr {\n\t\t// A field is addressable if and only if the struct is addressable.\n\t\t// If the original parent value was not addressable, shallow copy the\n\t\t// value to make it non-addressable to avoid leaking an implementation\n\t\t// detail of how forcibly exporting a field works.\n\t\tif ve.Kind() == reflect.Interface && ve.IsNil() {\n\t\t\treturn reflect.Zero(f.Type)\n\t\t}\n\t\treturn reflect.ValueOf(ve.Interface()).Convert(f.Type)\n\t}\n\treturn ve\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/internal/diff/debug_disable.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build !cmp_debug\n// +build !cmp_debug\n\npackage diff\n\nvar debug debugger\n\ntype debugger struct{}\n\nfunc (debugger) Begin(_, _ int, f EqualFunc, _, _ *EditScript) EqualFunc {\n\treturn f\n}\nfunc (debugger) Update() {}\nfunc (debugger) Finish() {}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/internal/diff/debug_enable.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build cmp_debug\n// +build cmp_debug\n\npackage diff\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"sync\"\n\t\"time\"\n)\n\n// The algorithm can be seen running in real-time by enabling debugging:\n//\tgo test -tags=cmp_debug -v\n//\n// Example output:\n//\t=== RUN TestDifference/#34\n//\t┌───────────────────────────────┐\n//\t│ \\ · · · · · · · · · · · · · · │\n//\t│ · # · · · · · · · · · · · · · │\n//\t│ · \\ · · · · · · · · · · · · · │\n//\t│ · · \\ · · · · · · · · · · · · │\n//\t│ · · · X # · · · · · · · · · · │\n//\t│ · · · # \\ · · · · · · · · · · │\n//\t│ · · · · · # # · · · · · · · · │\n//\t│ · · · · · # \\ · · · · · · · · │\n//\t│ · · · · · · · \\ · · · · · · · │\n//\t│ · · · · · · · · \\ · · · · · · │\n//\t│ · · · · · · · · · \\ · · · · · │\n//\t│ · · · · · · · · · · \\ · · # · │\n//\t│ · · · · · · · · · · · \\ # # · │\n//\t│ · · · · · · · · · · · # # # · │\n//\t│ · · · · · · · · · · # # # # · │\n//\t│ · · · · · · · · · # # # # # · │\n//\t│ · · · · · · · · · · · · · · \\ │\n//\t└───────────────────────────────┘\n//\t[.Y..M.XY......YXYXY.|]\n//\n// The grid represents the edit-graph where the horizontal axis represents\n// list X and the vertical axis represents list Y. The start of the two lists\n// is the top-left, while the ends are the bottom-right. The '·' represents\n// an unexplored node in the graph. The '\\' indicates that the two symbols\n// from list X and Y are equal. The 'X' indicates that two symbols are similar\n// (but not exactly equal) to each other. The '#' indicates that the two symbols\n// are different (and not similar). The algorithm traverses this graph trying to\n// make the paths starting in the top-left and the bottom-right connect.\n//\n// The series of '.', 'X', 'Y', and 'M' characters at the bottom represents\n// the currently established path from the forward and reverse searches,\n// separated by a '|' character.\n\nconst (\n\tupdateDelay = 100 * time.Millisecond\n\tfinishDelay = 500 * time.Millisecond\n\tansiTerminal = true // ANSI escape codes used to move terminal cursor\n)\n\nvar debug debugger\n\ntype debugger struct {\n\tsync.Mutex\n\tp1, p2 EditScript\n\tfwdPath, revPath *EditScript\n\tgrid []byte\n\tlines int\n}\n\nfunc (dbg *debugger) Begin(nx, ny int, f EqualFunc, p1, p2 *EditScript) EqualFunc {\n\tdbg.Lock()\n\tdbg.fwdPath, dbg.revPath = p1, p2\n\ttop := \"┌─\" + strings.Repeat(\"──\", nx) + \"┐\\n\"\n\trow := \"│ \" + strings.Repeat(\"· \", nx) + \"│\\n\"\n\tbtm := \"└─\" + strings.Repeat(\"──\", nx) + \"┘\\n\"\n\tdbg.grid = []byte(top + strings.Repeat(row, ny) + btm)\n\tdbg.lines = strings.Count(dbg.String(), \"\\n\")\n\tfmt.Print(dbg)\n\n\t// Wrap the EqualFunc so that we can intercept each result.\n\treturn func(ix, iy int) (r Result) {\n\t\tcell := dbg.grid[len(top)+iy*len(row):][len(\"│ \")+len(\"· \")*ix:][:len(\"·\")]\n\t\tfor i := range cell {\n\t\t\tcell[i] = 0 // Zero out the multiple bytes of UTF-8 middle-dot\n\t\t}\n\t\tswitch r = f(ix, iy); {\n\t\tcase r.Equal():\n\t\t\tcell[0] = '\\\\'\n\t\tcase r.Similar():\n\t\t\tcell[0] = 'X'\n\t\tdefault:\n\t\t\tcell[0] = '#'\n\t\t}\n\t\treturn\n\t}\n}\n\nfunc (dbg *debugger) Update() {\n\tdbg.print(updateDelay)\n}\n\nfunc (dbg *debugger) Finish() {\n\tdbg.print(finishDelay)\n\tdbg.Unlock()\n}\n\nfunc (dbg *debugger) String() string {\n\tdbg.p1, dbg.p2 = *dbg.fwdPath, dbg.p2[:0]\n\tfor i := len(*dbg.revPath) - 1; i >= 0; i-- {\n\t\tdbg.p2 = append(dbg.p2, (*dbg.revPath)[i])\n\t}\n\treturn fmt.Sprintf(\"%s[%v|%v]\\n\\n\", dbg.grid, dbg.p1, dbg.p2)\n}\n\nfunc (dbg *debugger) print(d time.Duration) {\n\tif ansiTerminal {\n\t\tfmt.Printf(\"\\x1b[%dA\", dbg.lines) // Reset terminal cursor\n\t}\n\tfmt.Print(dbg)\n\ttime.Sleep(d)\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/internal/diff/diff.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package diff implements an algorithm for producing edit-scripts.\n// The edit-script is a sequence of operations needed to transform one list\n// of symbols into another (or vice-versa). The edits allowed are insertions,\n// deletions, and modifications. The summation of all edits is called the\n// Levenshtein distance as this problem is well-known in computer science.\n//\n// This package prioritizes performance over accuracy. That is, the run time\n// is more important than obtaining a minimal Levenshtein distance.\npackage diff\n\nimport (\n\t\"math/rand\"\n\t\"time\"\n\n\t\"github.com/google/go-cmp/cmp/internal/flags\"\n)\n\n// EditType represents a single operation within an edit-script.\ntype EditType uint8\n\nconst (\n\t// Identity indicates that a symbol pair is identical in both list X and Y.\n\tIdentity EditType = iota\n\t// UniqueX indicates that a symbol only exists in X and not Y.\n\tUniqueX\n\t// UniqueY indicates that a symbol only exists in Y and not X.\n\tUniqueY\n\t// Modified indicates that a symbol pair is a modification of each other.\n\tModified\n)\n\n// EditScript represents the series of differences between two lists.\ntype EditScript []EditType\n\n// String returns a human-readable string representing the edit-script where\n// Identity, UniqueX, UniqueY, and Modified are represented by the\n// '.', 'X', 'Y', and 'M' characters, respectively.\nfunc (es EditScript) String() string {\n\tb := make([]byte, len(es))\n\tfor i, e := range es {\n\t\tswitch e {\n\t\tcase Identity:\n\t\t\tb[i] = '.'\n\t\tcase UniqueX:\n\t\t\tb[i] = 'X'\n\t\tcase UniqueY:\n\t\t\tb[i] = 'Y'\n\t\tcase Modified:\n\t\t\tb[i] = 'M'\n\t\tdefault:\n\t\t\tpanic(\"invalid edit-type\")\n\t\t}\n\t}\n\treturn string(b)\n}\n\n// stats returns a histogram of the number of each type of edit operation.\nfunc (es EditScript) stats() (s struct{ NI, NX, NY, NM int }) {\n\tfor _, e := range es {\n\t\tswitch e {\n\t\tcase Identity:\n\t\t\ts.NI++\n\t\tcase UniqueX:\n\t\t\ts.NX++\n\t\tcase UniqueY:\n\t\t\ts.NY++\n\t\tcase Modified:\n\t\t\ts.NM++\n\t\tdefault:\n\t\t\tpanic(\"invalid edit-type\")\n\t\t}\n\t}\n\treturn\n}\n\n// Dist is the Levenshtein distance and is guaranteed to be 0 if and only if\n// lists X and Y are equal.\nfunc (es EditScript) Dist() int { return len(es) - es.stats().NI }\n\n// LenX is the length of the X list.\nfunc (es EditScript) LenX() int { return len(es) - es.stats().NY }\n\n// LenY is the length of the Y list.\nfunc (es EditScript) LenY() int { return len(es) - es.stats().NX }\n\n// EqualFunc reports whether the symbols at indexes ix and iy are equal.\n// When called by Difference, the index is guaranteed to be within nx and ny.\ntype EqualFunc func(ix int, iy int) Result\n\n// Result is the result of comparison.\n// NumSame is the number of sub-elements that are equal.\n// NumDiff is the number of sub-elements that are not equal.\ntype Result struct{ NumSame, NumDiff int }\n\n// BoolResult returns a Result that is either Equal or not Equal.\nfunc BoolResult(b bool) Result {\n\tif b {\n\t\treturn Result{NumSame: 1} // Equal, Similar\n\t} else {\n\t\treturn Result{NumDiff: 2} // Not Equal, not Similar\n\t}\n}\n\n// Equal indicates whether the symbols are equal. Two symbols are equal\n// if and only if NumDiff == 0. If Equal, then they are also Similar.\nfunc (r Result) Equal() bool { return r.NumDiff == 0 }\n\n// Similar indicates whether two symbols are similar and may be represented\n// by using the Modified type. As a special case, we consider binary comparisons\n// (i.e., those that return Result{1, 0} or Result{0, 1}) to be similar.\n//\n// The exact ratio of NumSame to NumDiff to determine similarity may change.\nfunc (r Result) Similar() bool {\n\t// Use NumSame+1 to offset NumSame so that binary comparisons are similar.\n\treturn r.NumSame+1 >= r.NumDiff\n}\n\nvar randBool = rand.New(rand.NewSource(time.Now().Unix())).Intn(2) == 0\n\n// Difference reports whether two lists of lengths nx and ny are equal\n// given the definition of equality provided as f.\n//\n// This function returns an edit-script, which is a sequence of operations\n// needed to convert one list into the other. The following invariants for\n// the edit-script are maintained:\n// - eq == (es.Dist()==0)\n// - nx == es.LenX()\n// - ny == es.LenY()\n//\n// This algorithm is not guaranteed to be an optimal solution (i.e., one that\n// produces an edit-script with a minimal Levenshtein distance). This algorithm\n// favors performance over optimality. The exact output is not guaranteed to\n// be stable and may change over time.\nfunc Difference(nx, ny int, f EqualFunc) (es EditScript) {\n\t// This algorithm is based on traversing what is known as an \"edit-graph\".\n\t// See Figure 1 from \"An O(ND) Difference Algorithm and Its Variations\"\n\t// by Eugene W. Myers. Since D can be as large as N itself, this is\n\t// effectively O(N^2). Unlike the algorithm from that paper, we are not\n\t// interested in the optimal path, but at least some \"decent\" path.\n\t//\n\t// For example, let X and Y be lists of symbols:\n\t//\tX = [A B C A B B A]\n\t//\tY = [C B A B A C]\n\t//\n\t// The edit-graph can be drawn as the following:\n\t//\t A B C A B B A\n\t//\t ┌─────────────┐\n\t//\tC │_|_|\\|_|_|_|_│ 0\n\t//\tB │_|\\|_|_|\\|\\|_│ 1\n\t//\tA │\\|_|_|\\|_|_|\\│ 2\n\t//\tB │_|\\|_|_|\\|\\|_│ 3\n\t//\tA │\\|_|_|\\|_|_|\\│ 4\n\t//\tC │ | |\\| | | | │ 5\n\t//\t └─────────────┘ 6\n\t//\t 0 1 2 3 4 5 6 7\n\t//\n\t// List X is written along the horizontal axis, while list Y is written\n\t// along the vertical axis. At any point on this grid, if the symbol in\n\t// list X matches the corresponding symbol in list Y, then a '\\' is drawn.\n\t// The goal of any minimal edit-script algorithm is to find a path from the\n\t// top-left corner to the bottom-right corner, while traveling through the\n\t// fewest horizontal or vertical edges.\n\t// A horizontal edge is equivalent to inserting a symbol from list X.\n\t// A vertical edge is equivalent to inserting a symbol from list Y.\n\t// A diagonal edge is equivalent to a matching symbol between both X and Y.\n\n\t// Invariants:\n\t// - 0 ≤ fwdPath.X ≤ (fwdFrontier.X, revFrontier.X) ≤ revPath.X ≤ nx\n\t// - 0 ≤ fwdPath.Y ≤ (fwdFrontier.Y, revFrontier.Y) ≤ revPath.Y ≤ ny\n\t//\n\t// In general:\n\t// - fwdFrontier.X < revFrontier.X\n\t// - fwdFrontier.Y < revFrontier.Y\n\t//\n\t// Unless, it is time for the algorithm to terminate.\n\tfwdPath := path{+1, point{0, 0}, make(EditScript, 0, (nx+ny)/2)}\n\trevPath := path{-1, point{nx, ny}, make(EditScript, 0)}\n\tfwdFrontier := fwdPath.point // Forward search frontier\n\trevFrontier := revPath.point // Reverse search frontier\n\n\t// Search budget bounds the cost of searching for better paths.\n\t// The longest sequence of non-matching symbols that can be tolerated is\n\t// approximately the square-root of the search budget.\n\tsearchBudget := 4 * (nx + ny) // O(n)\n\n\t// Running the tests with the \"cmp_debug\" build tag prints a visualization\n\t// of the algorithm running in real-time. This is educational for\n\t// understanding how the algorithm works. See debug_enable.go.\n\tf = debug.Begin(nx, ny, f, &fwdPath.es, &revPath.es)\n\n\t// The algorithm below is a greedy, meet-in-the-middle algorithm for\n\t// computing sub-optimal edit-scripts between two lists.\n\t//\n\t// The algorithm is approximately as follows:\n\t// - Searching for differences switches back-and-forth between\n\t// a search that starts at the beginning (the top-left corner), and\n\t// a search that starts at the end (the bottom-right corner).\n\t// The goal of the search is connect with the search\n\t// from the opposite corner.\n\t// - As we search, we build a path in a greedy manner,\n\t// where the first match seen is added to the path (this is sub-optimal,\n\t// but provides a decent result in practice). When matches are found,\n\t// we try the next pair of symbols in the lists and follow all matches\n\t// as far as possible.\n\t// - When searching for matches, we search along a diagonal going through\n\t// through the \"frontier\" point. If no matches are found,\n\t// we advance the frontier towards the opposite corner.\n\t// - This algorithm terminates when either the X coordinates or the\n\t// Y coordinates of the forward and reverse frontier points ever intersect.\n\n\t// This algorithm is correct even if searching only in the forward direction\n\t// or in the reverse direction. We do both because it is commonly observed\n\t// that two lists commonly differ because elements were added to the front\n\t// or end of the other list.\n\t//\n\t// Non-deterministically start with either the forward or reverse direction\n\t// to introduce some deliberate instability so that we have the flexibility\n\t// to change this algorithm in the future.\n\tif flags.Deterministic || randBool {\n\t\tgoto forwardSearch\n\t} else {\n\t\tgoto reverseSearch\n\t}\n\nforwardSearch:\n\t{\n\t\t// Forward search from the beginning.\n\t\tif fwdFrontier.X >= revFrontier.X || fwdFrontier.Y >= revFrontier.Y || searchBudget == 0 {\n\t\t\tgoto finishSearch\n\t\t}\n\t\tfor stop1, stop2, i := false, false, 0; !(stop1 && stop2) && searchBudget > 0; i++ {\n\t\t\t// Search in a diagonal pattern for a match.\n\t\t\tz := zigzag(i)\n\t\t\tp := point{fwdFrontier.X + z, fwdFrontier.Y - z}\n\t\t\tswitch {\n\t\t\tcase p.X >= revPath.X || p.Y < fwdPath.Y:\n\t\t\t\tstop1 = true // Hit top-right corner\n\t\t\tcase p.Y >= revPath.Y || p.X < fwdPath.X:\n\t\t\t\tstop2 = true // Hit bottom-left corner\n\t\t\tcase f(p.X, p.Y).Equal():\n\t\t\t\t// Match found, so connect the path to this point.\n\t\t\t\tfwdPath.connect(p, f)\n\t\t\t\tfwdPath.append(Identity)\n\t\t\t\t// Follow sequence of matches as far as possible.\n\t\t\t\tfor fwdPath.X < revPath.X && fwdPath.Y < revPath.Y {\n\t\t\t\t\tif !f(fwdPath.X, fwdPath.Y).Equal() {\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t\tfwdPath.append(Identity)\n\t\t\t\t}\n\t\t\t\tfwdFrontier = fwdPath.point\n\t\t\t\tstop1, stop2 = true, true\n\t\t\tdefault:\n\t\t\t\tsearchBudget-- // Match not found\n\t\t\t}\n\t\t\tdebug.Update()\n\t\t}\n\t\t// Advance the frontier towards reverse point.\n\t\tif revPath.X-fwdFrontier.X >= revPath.Y-fwdFrontier.Y {\n\t\t\tfwdFrontier.X++\n\t\t} else {\n\t\t\tfwdFrontier.Y++\n\t\t}\n\t\tgoto reverseSearch\n\t}\n\nreverseSearch:\n\t{\n\t\t// Reverse search from the end.\n\t\tif fwdFrontier.X >= revFrontier.X || fwdFrontier.Y >= revFrontier.Y || searchBudget == 0 {\n\t\t\tgoto finishSearch\n\t\t}\n\t\tfor stop1, stop2, i := false, false, 0; !(stop1 && stop2) && searchBudget > 0; i++ {\n\t\t\t// Search in a diagonal pattern for a match.\n\t\t\tz := zigzag(i)\n\t\t\tp := point{revFrontier.X - z, revFrontier.Y + z}\n\t\t\tswitch {\n\t\t\tcase fwdPath.X >= p.X || revPath.Y < p.Y:\n\t\t\t\tstop1 = true // Hit bottom-left corner\n\t\t\tcase fwdPath.Y >= p.Y || revPath.X < p.X:\n\t\t\t\tstop2 = true // Hit top-right corner\n\t\t\tcase f(p.X-1, p.Y-1).Equal():\n\t\t\t\t// Match found, so connect the path to this point.\n\t\t\t\trevPath.connect(p, f)\n\t\t\t\trevPath.append(Identity)\n\t\t\t\t// Follow sequence of matches as far as possible.\n\t\t\t\tfor fwdPath.X < revPath.X && fwdPath.Y < revPath.Y {\n\t\t\t\t\tif !f(revPath.X-1, revPath.Y-1).Equal() {\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t\trevPath.append(Identity)\n\t\t\t\t}\n\t\t\t\trevFrontier = revPath.point\n\t\t\t\tstop1, stop2 = true, true\n\t\t\tdefault:\n\t\t\t\tsearchBudget-- // Match not found\n\t\t\t}\n\t\t\tdebug.Update()\n\t\t}\n\t\t// Advance the frontier towards forward point.\n\t\tif revFrontier.X-fwdPath.X >= revFrontier.Y-fwdPath.Y {\n\t\t\trevFrontier.X--\n\t\t} else {\n\t\t\trevFrontier.Y--\n\t\t}\n\t\tgoto forwardSearch\n\t}\n\nfinishSearch:\n\t// Join the forward and reverse paths and then append the reverse path.\n\tfwdPath.connect(revPath.point, f)\n\tfor i := len(revPath.es) - 1; i >= 0; i-- {\n\t\tt := revPath.es[i]\n\t\trevPath.es = revPath.es[:i]\n\t\tfwdPath.append(t)\n\t}\n\tdebug.Finish()\n\treturn fwdPath.es\n}\n\ntype path struct {\n\tdir int // +1 if forward, -1 if reverse\n\tpoint // Leading point of the EditScript path\n\tes EditScript\n}\n\n// connect appends any necessary Identity, Modified, UniqueX, or UniqueY types\n// to the edit-script to connect p.point to dst.\nfunc (p *path) connect(dst point, f EqualFunc) {\n\tif p.dir > 0 {\n\t\t// Connect in forward direction.\n\t\tfor dst.X > p.X && dst.Y > p.Y {\n\t\t\tswitch r := f(p.X, p.Y); {\n\t\t\tcase r.Equal():\n\t\t\t\tp.append(Identity)\n\t\t\tcase r.Similar():\n\t\t\t\tp.append(Modified)\n\t\t\tcase dst.X-p.X >= dst.Y-p.Y:\n\t\t\t\tp.append(UniqueX)\n\t\t\tdefault:\n\t\t\t\tp.append(UniqueY)\n\t\t\t}\n\t\t}\n\t\tfor dst.X > p.X {\n\t\t\tp.append(UniqueX)\n\t\t}\n\t\tfor dst.Y > p.Y {\n\t\t\tp.append(UniqueY)\n\t\t}\n\t} else {\n\t\t// Connect in reverse direction.\n\t\tfor p.X > dst.X && p.Y > dst.Y {\n\t\t\tswitch r := f(p.X-1, p.Y-1); {\n\t\t\tcase r.Equal():\n\t\t\t\tp.append(Identity)\n\t\t\tcase r.Similar():\n\t\t\t\tp.append(Modified)\n\t\t\tcase p.Y-dst.Y >= p.X-dst.X:\n\t\t\t\tp.append(UniqueY)\n\t\t\tdefault:\n\t\t\t\tp.append(UniqueX)\n\t\t\t}\n\t\t}\n\t\tfor p.X > dst.X {\n\t\t\tp.append(UniqueX)\n\t\t}\n\t\tfor p.Y > dst.Y {\n\t\t\tp.append(UniqueY)\n\t\t}\n\t}\n}\n\nfunc (p *path) append(t EditType) {\n\tp.es = append(p.es, t)\n\tswitch t {\n\tcase Identity, Modified:\n\t\tp.add(p.dir, p.dir)\n\tcase UniqueX:\n\t\tp.add(p.dir, 0)\n\tcase UniqueY:\n\t\tp.add(0, p.dir)\n\t}\n\tdebug.Update()\n}\n\ntype point struct{ X, Y int }\n\nfunc (p *point) add(dx, dy int) { p.X += dx; p.Y += dy }\n\n// zigzag maps a consecutive sequence of integers to a zig-zag sequence.\n//\n//\t[0 1 2 3 4 5 ...] => [0 -1 +1 -2 +2 ...]\nfunc zigzag(x int) int {\n\tif x&1 != 0 {\n\t\tx = ^x\n\t}\n\treturn x >> 1\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/internal/flags/flags.go",
"content": "// Copyright 2019, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage flags\n\n// Deterministic controls whether the output of Diff should be deterministic.\n// This is only used for testing.\nvar Deterministic bool\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/internal/function/func.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package function provides functionality for identifying function types.\npackage function\n\nimport (\n\t\"reflect\"\n\t\"regexp\"\n\t\"runtime\"\n\t\"strings\"\n)\n\ntype funcType int\n\nconst (\n\t_ funcType = iota\n\n\ttbFunc // func(T) bool\n\tttbFunc // func(T, T) bool\n\tttiFunc // func(T, T) int\n\ttrbFunc // func(T, R) bool\n\ttibFunc // func(T, I) bool\n\ttrFunc // func(T) R\n\n\tEqual = ttbFunc // func(T, T) bool\n\tEqualAssignable = tibFunc // func(T, I) bool; encapsulates func(T, T) bool\n\tTransformer = trFunc // func(T) R\n\tValueFilter = ttbFunc // func(T, T) bool\n\tLess = ttbFunc // func(T, T) bool\n\tCompare = ttiFunc // func(T, T) int\n\tValuePredicate = tbFunc // func(T) bool\n\tKeyValuePredicate = trbFunc // func(T, R) bool\n)\n\nvar boolType = reflect.TypeOf(true)\nvar intType = reflect.TypeOf(0)\n\n// IsType reports whether the reflect.Type is of the specified function type.\nfunc IsType(t reflect.Type, ft funcType) bool {\n\tif t == nil || t.Kind() != reflect.Func || t.IsVariadic() {\n\t\treturn false\n\t}\n\tni, no := t.NumIn(), t.NumOut()\n\tswitch ft {\n\tcase tbFunc: // func(T) bool\n\t\tif ni == 1 && no == 1 && t.Out(0) == boolType {\n\t\t\treturn true\n\t\t}\n\tcase ttbFunc: // func(T, T) bool\n\t\tif ni == 2 && no == 1 && t.In(0) == t.In(1) && t.Out(0) == boolType {\n\t\t\treturn true\n\t\t}\n\tcase ttiFunc: // func(T, T) int\n\t\tif ni == 2 && no == 1 && t.In(0) == t.In(1) && t.Out(0) == intType {\n\t\t\treturn true\n\t\t}\n\tcase trbFunc: // func(T, R) bool\n\t\tif ni == 2 && no == 1 && t.Out(0) == boolType {\n\t\t\treturn true\n\t\t}\n\tcase tibFunc: // func(T, I) bool\n\t\tif ni == 2 && no == 1 && t.In(0).AssignableTo(t.In(1)) && t.Out(0) == boolType {\n\t\t\treturn true\n\t\t}\n\tcase trFunc: // func(T) R\n\t\tif ni == 1 && no == 1 {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nvar lastIdentRx = regexp.MustCompile(`[_\\p{L}][_\\p{L}\\p{N}]*$`)\n\n// NameOf returns the name of the function value.\nfunc NameOf(v reflect.Value) string {\n\tfnc := runtime.FuncForPC(v.Pointer())\n\tif fnc == nil {\n\t\treturn \"\"\n\t}\n\tfullName := fnc.Name() // e.g., \"long/path/name/mypkg.(*MyType).(long/path/name/mypkg.myMethod)-fm\"\n\n\t// Method closures have a \"-fm\" suffix.\n\tfullName = strings.TrimSuffix(fullName, \"-fm\")\n\n\tvar name string\n\tfor len(fullName) > 0 {\n\t\tinParen := strings.HasSuffix(fullName, \")\")\n\t\tfullName = strings.TrimSuffix(fullName, \")\")\n\n\t\ts := lastIdentRx.FindString(fullName)\n\t\tif s == \"\" {\n\t\t\tbreak\n\t\t}\n\t\tname = s + \".\" + name\n\t\tfullName = strings.TrimSuffix(fullName, s)\n\n\t\tif i := strings.LastIndexByte(fullName, '('); inParen && i >= 0 {\n\t\t\tfullName = fullName[:i]\n\t\t}\n\t\tfullName = strings.TrimSuffix(fullName, \".\")\n\t}\n\treturn strings.TrimSuffix(name, \".\")\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/internal/value/name.go",
"content": "// Copyright 2020, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage value\n\nimport (\n\t\"reflect\"\n\t\"strconv\"\n)\n\nvar anyType = reflect.TypeOf((*interface{})(nil)).Elem()\n\n// TypeString is nearly identical to reflect.Type.String,\n// but has an additional option to specify that full type names be used.\nfunc TypeString(t reflect.Type, qualified bool) string {\n\treturn string(appendTypeName(nil, t, qualified, false))\n}\n\nfunc appendTypeName(b []byte, t reflect.Type, qualified, elideFunc bool) []byte {\n\t// BUG: Go reflection provides no way to disambiguate two named types\n\t// of the same name and within the same package,\n\t// but declared within the namespace of different functions.\n\n\t// Use the \"any\" alias instead of \"interface{}\" for better readability.\n\tif t == anyType {\n\t\treturn append(b, \"any\"...)\n\t}\n\n\t// Named type.\n\tif t.Name() != \"\" {\n\t\tif qualified && t.PkgPath() != \"\" {\n\t\t\tb = append(b, '\"')\n\t\t\tb = append(b, t.PkgPath()...)\n\t\t\tb = append(b, '\"')\n\t\t\tb = append(b, '.')\n\t\t\tb = append(b, t.Name()...)\n\t\t} else {\n\t\t\tb = append(b, t.String()...)\n\t\t}\n\t\treturn b\n\t}\n\n\t// Unnamed type.\n\tswitch k := t.Kind(); k {\n\tcase reflect.Bool, reflect.String, reflect.UnsafePointer,\n\t\treflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64,\n\t\treflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr,\n\t\treflect.Float32, reflect.Float64, reflect.Complex64, reflect.Complex128:\n\t\tb = append(b, k.String()...)\n\tcase reflect.Chan:\n\t\tif t.ChanDir() == reflect.RecvDir {\n\t\t\tb = append(b, \"<-\"...)\n\t\t}\n\t\tb = append(b, \"chan\"...)\n\t\tif t.ChanDir() == reflect.SendDir {\n\t\t\tb = append(b, \"<-\"...)\n\t\t}\n\t\tb = append(b, ' ')\n\t\tb = appendTypeName(b, t.Elem(), qualified, false)\n\tcase reflect.Func:\n\t\tif !elideFunc {\n\t\t\tb = append(b, \"func\"...)\n\t\t}\n\t\tb = append(b, '(')\n\t\tfor i := 0; i < t.NumIn(); i++ {\n\t\t\tif i > 0 {\n\t\t\t\tb = append(b, \", \"...)\n\t\t\t}\n\t\t\tif i == t.NumIn()-1 && t.IsVariadic() {\n\t\t\t\tb = append(b, \"...\"...)\n\t\t\t\tb = appendTypeName(b, t.In(i).Elem(), qualified, false)\n\t\t\t} else {\n\t\t\t\tb = appendTypeName(b, t.In(i), qualified, false)\n\t\t\t}\n\t\t}\n\t\tb = append(b, ')')\n\t\tswitch t.NumOut() {\n\t\tcase 0:\n\t\t\t// Do nothing\n\t\tcase 1:\n\t\t\tb = append(b, ' ')\n\t\t\tb = appendTypeName(b, t.Out(0), qualified, false)\n\t\tdefault:\n\t\t\tb = append(b, \" (\"...)\n\t\t\tfor i := 0; i < t.NumOut(); i++ {\n\t\t\t\tif i > 0 {\n\t\t\t\t\tb = append(b, \", \"...)\n\t\t\t\t}\n\t\t\t\tb = appendTypeName(b, t.Out(i), qualified, false)\n\t\t\t}\n\t\t\tb = append(b, ')')\n\t\t}\n\tcase reflect.Struct:\n\t\tb = append(b, \"struct{ \"...)\n\t\tfor i := 0; i < t.NumField(); i++ {\n\t\t\tif i > 0 {\n\t\t\t\tb = append(b, \"; \"...)\n\t\t\t}\n\t\t\tsf := t.Field(i)\n\t\t\tif !sf.Anonymous {\n\t\t\t\tif qualified && sf.PkgPath != \"\" {\n\t\t\t\t\tb = append(b, '\"')\n\t\t\t\t\tb = append(b, sf.PkgPath...)\n\t\t\t\t\tb = append(b, '\"')\n\t\t\t\t\tb = append(b, '.')\n\t\t\t\t}\n\t\t\t\tb = append(b, sf.Name...)\n\t\t\t\tb = append(b, ' ')\n\t\t\t}\n\t\t\tb = appendTypeName(b, sf.Type, qualified, false)\n\t\t\tif sf.Tag != \"\" {\n\t\t\t\tb = append(b, ' ')\n\t\t\t\tb = strconv.AppendQuote(b, string(sf.Tag))\n\t\t\t}\n\t\t}\n\t\tif b[len(b)-1] == ' ' {\n\t\t\tb = b[:len(b)-1]\n\t\t} else {\n\t\t\tb = append(b, ' ')\n\t\t}\n\t\tb = append(b, '}')\n\tcase reflect.Slice, reflect.Array:\n\t\tb = append(b, '[')\n\t\tif k == reflect.Array {\n\t\t\tb = strconv.AppendUint(b, uint64(t.Len()), 10)\n\t\t}\n\t\tb = append(b, ']')\n\t\tb = appendTypeName(b, t.Elem(), qualified, false)\n\tcase reflect.Map:\n\t\tb = append(b, \"map[\"...)\n\t\tb = appendTypeName(b, t.Key(), qualified, false)\n\t\tb = append(b, ']')\n\t\tb = appendTypeName(b, t.Elem(), qualified, false)\n\tcase reflect.Ptr:\n\t\tb = append(b, '*')\n\t\tb = appendTypeName(b, t.Elem(), qualified, false)\n\tcase reflect.Interface:\n\t\tb = append(b, \"interface{ \"...)\n\t\tfor i := 0; i < t.NumMethod(); i++ {\n\t\t\tif i > 0 {\n\t\t\t\tb = append(b, \"; \"...)\n\t\t\t}\n\t\t\tm := t.Method(i)\n\t\t\tif qualified && m.PkgPath != \"\" {\n\t\t\t\tb = append(b, '\"')\n\t\t\t\tb = append(b, m.PkgPath...)\n\t\t\t\tb = append(b, '\"')\n\t\t\t\tb = append(b, '.')\n\t\t\t}\n\t\t\tb = append(b, m.Name...)\n\t\t\tb = appendTypeName(b, m.Type, qualified, true)\n\t\t}\n\t\tif b[len(b)-1] == ' ' {\n\t\t\tb = b[:len(b)-1]\n\t\t} else {\n\t\t\tb = append(b, ' ')\n\t\t}\n\t\tb = append(b, '}')\n\tdefault:\n\t\tpanic(\"invalid kind: \" + k.String())\n\t}\n\treturn b\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/internal/value/pointer.go",
"content": "// Copyright 2018, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage value\n\nimport (\n\t\"reflect\"\n\t\"unsafe\"\n)\n\n// Pointer is an opaque typed pointer and is guaranteed to be comparable.\ntype Pointer struct {\n\tp unsafe.Pointer\n\tt reflect.Type\n}\n\n// PointerOf returns a Pointer from v, which must be a\n// reflect.Ptr, reflect.Slice, or reflect.Map.\nfunc PointerOf(v reflect.Value) Pointer {\n\t// The proper representation of a pointer is unsafe.Pointer,\n\t// which is necessary if the GC ever uses a moving collector.\n\treturn Pointer{unsafe.Pointer(v.Pointer()), v.Type()}\n}\n\n// IsNil reports whether the pointer is nil.\nfunc (p Pointer) IsNil() bool {\n\treturn p.p == nil\n}\n\n// Uintptr returns the pointer as a uintptr.\nfunc (p Pointer) Uintptr() uintptr {\n\treturn uintptr(p.p)\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/internal/value/sort.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage value\n\nimport (\n\t\"fmt\"\n\t\"math\"\n\t\"reflect\"\n\t\"sort\"\n)\n\n// SortKeys sorts a list of map keys, deduplicating keys if necessary.\n// The type of each value must be comparable.\nfunc SortKeys(vs []reflect.Value) []reflect.Value {\n\tif len(vs) == 0 {\n\t\treturn vs\n\t}\n\n\t// Sort the map keys.\n\tsort.SliceStable(vs, func(i, j int) bool { return isLess(vs[i], vs[j]) })\n\n\t// Deduplicate keys (fails for NaNs).\n\tvs2 := vs[:1]\n\tfor _, v := range vs[1:] {\n\t\tif isLess(vs2[len(vs2)-1], v) {\n\t\t\tvs2 = append(vs2, v)\n\t\t}\n\t}\n\treturn vs2\n}\n\n// isLess is a generic function for sorting arbitrary map keys.\n// The inputs must be of the same type and must be comparable.\nfunc isLess(x, y reflect.Value) bool {\n\tswitch x.Type().Kind() {\n\tcase reflect.Bool:\n\t\treturn !x.Bool() && y.Bool()\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn x.Int() < y.Int()\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\treturn x.Uint() < y.Uint()\n\tcase reflect.Float32, reflect.Float64:\n\t\t// NOTE: This does not sort -0 as less than +0\n\t\t// since Go maps treat -0 and +0 as equal keys.\n\t\tfx, fy := x.Float(), y.Float()\n\t\treturn fx < fy || math.IsNaN(fx) && !math.IsNaN(fy)\n\tcase reflect.Complex64, reflect.Complex128:\n\t\tcx, cy := x.Complex(), y.Complex()\n\t\trx, ix, ry, iy := real(cx), imag(cx), real(cy), imag(cy)\n\t\tif rx == ry || (math.IsNaN(rx) && math.IsNaN(ry)) {\n\t\t\treturn ix < iy || math.IsNaN(ix) && !math.IsNaN(iy)\n\t\t}\n\t\treturn rx < ry || math.IsNaN(rx) && !math.IsNaN(ry)\n\tcase reflect.Ptr, reflect.UnsafePointer, reflect.Chan:\n\t\treturn x.Pointer() < y.Pointer()\n\tcase reflect.String:\n\t\treturn x.String() < y.String()\n\tcase reflect.Array:\n\t\tfor i := 0; i < x.Len(); i++ {\n\t\t\tif isLess(x.Index(i), y.Index(i)) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t\tif isLess(y.Index(i), x.Index(i)) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\treturn false\n\tcase reflect.Struct:\n\t\tfor i := 0; i < x.NumField(); i++ {\n\t\t\tif isLess(x.Field(i), y.Field(i)) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t\tif isLess(y.Field(i), x.Field(i)) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\treturn false\n\tcase reflect.Interface:\n\t\tvx, vy := x.Elem(), y.Elem()\n\t\tif !vx.IsValid() || !vy.IsValid() {\n\t\t\treturn !vx.IsValid() && vy.IsValid()\n\t\t}\n\t\ttx, ty := vx.Type(), vy.Type()\n\t\tif tx == ty {\n\t\t\treturn isLess(x.Elem(), y.Elem())\n\t\t}\n\t\tif tx.Kind() != ty.Kind() {\n\t\t\treturn vx.Kind() < vy.Kind()\n\t\t}\n\t\tif tx.String() != ty.String() {\n\t\t\treturn tx.String() < ty.String()\n\t\t}\n\t\tif tx.PkgPath() != ty.PkgPath() {\n\t\t\treturn tx.PkgPath() < ty.PkgPath()\n\t\t}\n\t\t// This can happen in rare situations, so we fallback to just comparing\n\t\t// the unique pointer for a reflect.Type. This guarantees deterministic\n\t\t// ordering within a program, but it is obviously not stable.\n\t\treturn reflect.ValueOf(vx.Type()).Pointer() < reflect.ValueOf(vy.Type()).Pointer()\n\tdefault:\n\t\t// Must be Func, Map, or Slice; which are not comparable.\n\t\tpanic(fmt.Sprintf(\"%T is not comparable\", x.Type()))\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/options.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\t\"regexp\"\n\t\"strings\"\n\n\t\"github.com/google/go-cmp/cmp/internal/function\"\n)\n\n// Option configures for specific behavior of [Equal] and [Diff]. In particular,\n// the fundamental Option functions ([Ignore], [Transformer], and [Comparer]),\n// configure how equality is determined.\n//\n// The fundamental options may be composed with filters ([FilterPath] and\n// [FilterValues]) to control the scope over which they are applied.\n//\n// The [github.com/google/go-cmp/cmp/cmpopts] package provides helper functions\n// for creating options that may be used with [Equal] and [Diff].\ntype Option interface {\n\t// filter applies all filters and returns the option that remains.\n\t// Each option may only read s.curPath and call s.callTTBFunc.\n\t//\n\t// An Options is returned only if multiple comparers or transformers\n\t// can apply simultaneously and will only contain values of those types\n\t// or sub-Options containing values of those types.\n\tfilter(s *state, t reflect.Type, vx, vy reflect.Value) applicableOption\n}\n\n// applicableOption represents the following types:\n//\n//\tFundamental: ignore | validator | *comparer | *transformer\n//\tGrouping: Options\ntype applicableOption interface {\n\tOption\n\n\t// apply executes the option, which may mutate s or panic.\n\tapply(s *state, vx, vy reflect.Value)\n}\n\n// coreOption represents the following types:\n//\n//\tFundamental: ignore | validator | *comparer | *transformer\n//\tFilters: *pathFilter | *valuesFilter\ntype coreOption interface {\n\tOption\n\tisCore()\n}\n\ntype core struct{}\n\nfunc (core) isCore() {}\n\n// Options is a list of [Option] values that also satisfies the [Option] interface.\n// Helper comparison packages may return an Options value when packing multiple\n// [Option] values into a single [Option]. When this package processes an Options,\n// it will be implicitly expanded into a flat list.\n//\n// Applying a filter on an Options is equivalent to applying that same filter\n// on all individual options held within.\ntype Options []Option\n\nfunc (opts Options) filter(s *state, t reflect.Type, vx, vy reflect.Value) (out applicableOption) {\n\tfor _, opt := range opts {\n\t\tswitch opt := opt.filter(s, t, vx, vy); opt.(type) {\n\t\tcase ignore:\n\t\t\treturn ignore{} // Only ignore can short-circuit evaluation\n\t\tcase validator:\n\t\t\tout = validator{} // Takes precedence over comparer or transformer\n\t\tcase *comparer, *transformer, Options:\n\t\t\tswitch out.(type) {\n\t\t\tcase nil:\n\t\t\t\tout = opt\n\t\t\tcase validator:\n\t\t\t\t// Keep validator\n\t\t\tcase *comparer, *transformer, Options:\n\t\t\t\tout = Options{out, opt} // Conflicting comparers or transformers\n\t\t\t}\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (opts Options) apply(s *state, _, _ reflect.Value) {\n\tconst warning = \"ambiguous set of applicable options\"\n\tconst help = \"consider using filters to ensure at most one Comparer or Transformer may apply\"\n\tvar ss []string\n\tfor _, opt := range flattenOptions(nil, opts) {\n\t\tss = append(ss, fmt.Sprint(opt))\n\t}\n\tset := strings.Join(ss, \"\\n\\t\")\n\tpanic(fmt.Sprintf(\"%s at %#v:\\n\\t%s\\n%s\", warning, s.curPath, set, help))\n}\n\nfunc (opts Options) String() string {\n\tvar ss []string\n\tfor _, opt := range opts {\n\t\tss = append(ss, fmt.Sprint(opt))\n\t}\n\treturn fmt.Sprintf(\"Options{%s}\", strings.Join(ss, \", \"))\n}\n\n// FilterPath returns a new [Option] where opt is only evaluated if filter f\n// returns true for the current [Path] in the value tree.\n//\n// This filter is called even if a slice element or map entry is missing and\n// provides an opportunity to ignore such cases. The filter function must be\n// symmetric such that the filter result is identical regardless of whether the\n// missing value is from x or y.\n//\n// The option passed in may be an [Ignore], [Transformer], [Comparer], [Options], or\n// a previously filtered [Option].\nfunc FilterPath(f func(Path) bool, opt Option) Option {\n\tif f == nil {\n\t\tpanic(\"invalid path filter function\")\n\t}\n\tif opt := normalizeOption(opt); opt != nil {\n\t\treturn &pathFilter{fnc: f, opt: opt}\n\t}\n\treturn nil\n}\n\ntype pathFilter struct {\n\tcore\n\tfnc func(Path) bool\n\topt Option\n}\n\nfunc (f pathFilter) filter(s *state, t reflect.Type, vx, vy reflect.Value) applicableOption {\n\tif f.fnc(s.curPath) {\n\t\treturn f.opt.filter(s, t, vx, vy)\n\t}\n\treturn nil\n}\n\nfunc (f pathFilter) String() string {\n\treturn fmt.Sprintf(\"FilterPath(%s, %v)\", function.NameOf(reflect.ValueOf(f.fnc)), f.opt)\n}\n\n// FilterValues returns a new [Option] where opt is only evaluated if filter f,\n// which is a function of the form \"func(T, T) bool\", returns true for the\n// current pair of values being compared. If either value is invalid or\n// the type of the values is not assignable to T, then this filter implicitly\n// returns false.\n//\n// The filter function must be\n// symmetric (i.e., agnostic to the order of the inputs) and\n// deterministic (i.e., produces the same result when given the same inputs).\n// If T is an interface, it is possible that f is called with two values with\n// different concrete types that both implement T.\n//\n// The option passed in may be an [Ignore], [Transformer], [Comparer], [Options], or\n// a previously filtered [Option].\nfunc FilterValues(f interface{}, opt Option) Option {\n\tv := reflect.ValueOf(f)\n\tif !function.IsType(v.Type(), function.ValueFilter) || v.IsNil() {\n\t\tpanic(fmt.Sprintf(\"invalid values filter function: %T\", f))\n\t}\n\tif opt := normalizeOption(opt); opt != nil {\n\t\tvf := &valuesFilter{fnc: v, opt: opt}\n\t\tif ti := v.Type().In(0); ti.Kind() != reflect.Interface || ti.NumMethod() > 0 {\n\t\t\tvf.typ = ti\n\t\t}\n\t\treturn vf\n\t}\n\treturn nil\n}\n\ntype valuesFilter struct {\n\tcore\n\ttyp reflect.Type // T\n\tfnc reflect.Value // func(T, T) bool\n\topt Option\n}\n\nfunc (f valuesFilter) filter(s *state, t reflect.Type, vx, vy reflect.Value) applicableOption {\n\tif !vx.IsValid() || !vx.CanInterface() || !vy.IsValid() || !vy.CanInterface() {\n\t\treturn nil\n\t}\n\tif (f.typ == nil || t.AssignableTo(f.typ)) && s.callTTBFunc(f.fnc, vx, vy) {\n\t\treturn f.opt.filter(s, t, vx, vy)\n\t}\n\treturn nil\n}\n\nfunc (f valuesFilter) String() string {\n\treturn fmt.Sprintf(\"FilterValues(%s, %v)\", function.NameOf(f.fnc), f.opt)\n}\n\n// Ignore is an [Option] that causes all comparisons to be ignored.\n// This value is intended to be combined with [FilterPath] or [FilterValues].\n// It is an error to pass an unfiltered Ignore option to [Equal].\nfunc Ignore() Option { return ignore{} }\n\ntype ignore struct{ core }\n\nfunc (ignore) isFiltered() bool { return false }\nfunc (ignore) filter(_ *state, _ reflect.Type, _, _ reflect.Value) applicableOption { return ignore{} }\nfunc (ignore) apply(s *state, _, _ reflect.Value) { s.report(true, reportByIgnore) }\nfunc (ignore) String() string { return \"Ignore()\" }\n\n// validator is a sentinel Option type to indicate that some options could not\n// be evaluated due to unexported fields, missing slice elements, or\n// missing map entries. Both values are validator only for unexported fields.\ntype validator struct{ core }\n\nfunc (validator) filter(_ *state, _ reflect.Type, vx, vy reflect.Value) applicableOption {\n\tif !vx.IsValid() || !vy.IsValid() {\n\t\treturn validator{}\n\t}\n\tif !vx.CanInterface() || !vy.CanInterface() {\n\t\treturn validator{}\n\t}\n\treturn nil\n}\nfunc (validator) apply(s *state, vx, vy reflect.Value) {\n\t// Implies missing slice element or map entry.\n\tif !vx.IsValid() || !vy.IsValid() {\n\t\ts.report(vx.IsValid() == vy.IsValid(), 0)\n\t\treturn\n\t}\n\n\t// Unable to Interface implies unexported field without visibility access.\n\tif !vx.CanInterface() || !vy.CanInterface() {\n\t\thelp := \"consider using a custom Comparer; if you control the implementation of type, you can also consider using an Exporter, AllowUnexported, or cmpopts.IgnoreUnexported\"\n\t\tvar name string\n\t\tif t := s.curPath.Index(-2).Type(); t.Name() != \"\" {\n\t\t\t// Named type with unexported fields.\n\t\t\tname = fmt.Sprintf(\"%q.%v\", t.PkgPath(), t.Name()) // e.g., \"path/to/package\".MyType\n\t\t\tisProtoMessage := func(t reflect.Type) bool {\n\t\t\t\tm, ok := reflect.PointerTo(t).MethodByName(\"ProtoReflect\")\n\t\t\t\treturn ok && m.Type.NumIn() == 1 && m.Type.NumOut() == 1 &&\n\t\t\t\t\tm.Type.Out(0).PkgPath() == \"google.golang.org/protobuf/reflect/protoreflect\" &&\n\t\t\t\t\tm.Type.Out(0).Name() == \"Message\"\n\t\t\t}\n\t\t\tif isProtoMessage(t) {\n\t\t\t\thelp = `consider using \"google.golang.org/protobuf/testing/protocmp\".Transform to compare proto.Message types`\n\t\t\t} else if _, ok := reflect.New(t).Interface().(error); ok {\n\t\t\t\thelp = \"consider using cmpopts.EquateErrors to compare error values\"\n\t\t\t} else if t.Comparable() {\n\t\t\t\thelp = \"consider using cmpopts.EquateComparable to compare comparable Go types\"\n\t\t\t}\n\t\t} else {\n\t\t\t// Unnamed type with unexported fields. Derive PkgPath from field.\n\t\t\tvar pkgPath string\n\t\t\tfor i := 0; i < t.NumField() && pkgPath == \"\"; i++ {\n\t\t\t\tpkgPath = t.Field(i).PkgPath\n\t\t\t}\n\t\t\tname = fmt.Sprintf(\"%q.(%v)\", pkgPath, t.String()) // e.g., \"path/to/package\".(struct { a int })\n\t\t}\n\t\tpanic(fmt.Sprintf(\"cannot handle unexported field at %#v:\\n\\t%v\\n%s\", s.curPath, name, help))\n\t}\n\n\tpanic(\"not reachable\")\n}\n\n// identRx represents a valid identifier according to the Go specification.\nconst identRx = `[_\\p{L}][_\\p{L}\\p{N}]*`\n\nvar identsRx = regexp.MustCompile(`^` + identRx + `(\\.` + identRx + `)*$`)\n\n// Transformer returns an [Option] that applies a transformation function that\n// converts values of a certain type into that of another.\n//\n// The transformer f must be a function \"func(T) R\" that converts values of\n// type T to those of type R and is implicitly filtered to input values\n// assignable to T. The transformer must not mutate T in any way.\n//\n// To help prevent some cases of infinite recursive cycles applying the\n// same transform to the output of itself (e.g., in the case where the\n// input and output types are the same), an implicit filter is added such that\n// a transformer is applicable only if that exact transformer is not already\n// in the tail of the [Path] since the last non-[Transform] step.\n// For situations where the implicit filter is still insufficient,\n// consider using [github.com/google/go-cmp/cmp/cmpopts.AcyclicTransformer],\n// which adds a filter to prevent the transformer from\n// being recursively applied upon itself.\n//\n// The name is a user provided label that is used as the [Transform.Name] in the\n// transformation [PathStep] (and eventually shown in the [Diff] output).\n// The name must be a valid identifier or qualified identifier in Go syntax.\n// If empty, an arbitrary name is used.\nfunc Transformer(name string, f interface{}) Option {\n\tv := reflect.ValueOf(f)\n\tif !function.IsType(v.Type(), function.Transformer) || v.IsNil() {\n\t\tpanic(fmt.Sprintf(\"invalid transformer function: %T\", f))\n\t}\n\tif name == \"\" {\n\t\tname = function.NameOf(v)\n\t\tif !identsRx.MatchString(name) {\n\t\t\tname = \"λ\" // Lambda-symbol as placeholder name\n\t\t}\n\t} else if !identsRx.MatchString(name) {\n\t\tpanic(fmt.Sprintf(\"invalid name: %q\", name))\n\t}\n\ttr := &transformer{name: name, fnc: reflect.ValueOf(f)}\n\tif ti := v.Type().In(0); ti.Kind() != reflect.Interface || ti.NumMethod() > 0 {\n\t\ttr.typ = ti\n\t}\n\treturn tr\n}\n\ntype transformer struct {\n\tcore\n\tname string\n\ttyp reflect.Type // T\n\tfnc reflect.Value // func(T) R\n}\n\nfunc (tr *transformer) isFiltered() bool { return tr.typ != nil }\n\nfunc (tr *transformer) filter(s *state, t reflect.Type, _, _ reflect.Value) applicableOption {\n\tfor i := len(s.curPath) - 1; i >= 0; i-- {\n\t\tif t, ok := s.curPath[i].(Transform); !ok {\n\t\t\tbreak // Hit most recent non-Transform step\n\t\t} else if tr == t.trans {\n\t\t\treturn nil // Cannot directly use same Transform\n\t\t}\n\t}\n\tif tr.typ == nil || t.AssignableTo(tr.typ) {\n\t\treturn tr\n\t}\n\treturn nil\n}\n\nfunc (tr *transformer) apply(s *state, vx, vy reflect.Value) {\n\tstep := Transform{&transform{pathStep{typ: tr.fnc.Type().Out(0)}, tr}}\n\tvvx := s.callTRFunc(tr.fnc, vx, step)\n\tvvy := s.callTRFunc(tr.fnc, vy, step)\n\tstep.vx, step.vy = vvx, vvy\n\ts.compareAny(step)\n}\n\nfunc (tr transformer) String() string {\n\treturn fmt.Sprintf(\"Transformer(%s, %s)\", tr.name, function.NameOf(tr.fnc))\n}\n\n// Comparer returns an [Option] that determines whether two values are equal\n// to each other.\n//\n// The comparer f must be a function \"func(T, T) bool\" and is implicitly\n// filtered to input values assignable to T. If T is an interface, it is\n// possible that f is called with two values of different concrete types that\n// both implement T.\n//\n// The equality function must be:\n// - Symmetric: equal(x, y) == equal(y, x)\n// - Deterministic: equal(x, y) == equal(x, y)\n// - Pure: equal(x, y) does not modify x or y\nfunc Comparer(f interface{}) Option {\n\tv := reflect.ValueOf(f)\n\tif !function.IsType(v.Type(), function.Equal) || v.IsNil() {\n\t\tpanic(fmt.Sprintf(\"invalid comparer function: %T\", f))\n\t}\n\tcm := &comparer{fnc: v}\n\tif ti := v.Type().In(0); ti.Kind() != reflect.Interface || ti.NumMethod() > 0 {\n\t\tcm.typ = ti\n\t}\n\treturn cm\n}\n\ntype comparer struct {\n\tcore\n\ttyp reflect.Type // T\n\tfnc reflect.Value // func(T, T) bool\n}\n\nfunc (cm *comparer) isFiltered() bool { return cm.typ != nil }\n\nfunc (cm *comparer) filter(_ *state, t reflect.Type, _, _ reflect.Value) applicableOption {\n\tif cm.typ == nil || t.AssignableTo(cm.typ) {\n\t\treturn cm\n\t}\n\treturn nil\n}\n\nfunc (cm *comparer) apply(s *state, vx, vy reflect.Value) {\n\teq := s.callTTBFunc(cm.fnc, vx, vy)\n\ts.report(eq, reportByFunc)\n}\n\nfunc (cm comparer) String() string {\n\treturn fmt.Sprintf(\"Comparer(%s)\", function.NameOf(cm.fnc))\n}\n\n// Exporter returns an [Option] that specifies whether [Equal] is allowed to\n// introspect into the unexported fields of certain struct types.\n//\n// Users of this option must understand that comparing on unexported fields\n// from external packages is not safe since changes in the internal\n// implementation of some external package may cause the result of [Equal]\n// to unexpectedly change. However, it may be valid to use this option on types\n// defined in an internal package where the semantic meaning of an unexported\n// field is in the control of the user.\n//\n// In many cases, a custom [Comparer] should be used instead that defines\n// equality as a function of the public API of a type rather than the underlying\n// unexported implementation.\n//\n// For example, the [reflect.Type] documentation defines equality to be determined\n// by the == operator on the interface (essentially performing a shallow pointer\n// comparison) and most attempts to compare *[regexp.Regexp] types are interested\n// in only checking that the regular expression strings are equal.\n// Both of these are accomplished using [Comparer] options:\n//\n//\tComparer(func(x, y reflect.Type) bool { return x == y })\n//\tComparer(func(x, y *regexp.Regexp) bool { return x.String() == y.String() })\n//\n// In other cases, the [github.com/google/go-cmp/cmp/cmpopts.IgnoreUnexported]\n// option can be used to ignore all unexported fields on specified struct types.\nfunc Exporter(f func(reflect.Type) bool) Option {\n\treturn exporter(f)\n}\n\ntype exporter func(reflect.Type) bool\n\nfunc (exporter) filter(_ *state, _ reflect.Type, _, _ reflect.Value) applicableOption {\n\tpanic(\"not implemented\")\n}\n\n// AllowUnexported returns an [Option] that allows [Equal] to forcibly introspect\n// unexported fields of the specified struct types.\n//\n// See [Exporter] for the proper use of this option.\nfunc AllowUnexported(types ...interface{}) Option {\n\tm := make(map[reflect.Type]bool)\n\tfor _, typ := range types {\n\t\tt := reflect.TypeOf(typ)\n\t\tif t.Kind() != reflect.Struct {\n\t\t\tpanic(fmt.Sprintf(\"invalid struct type: %T\", typ))\n\t\t}\n\t\tm[t] = true\n\t}\n\treturn exporter(func(t reflect.Type) bool { return m[t] })\n}\n\n// Result represents the comparison result for a single node and\n// is provided by cmp when calling Report (see [Reporter]).\ntype Result struct {\n\t_ [0]func() // Make Result incomparable\n\tflags resultFlags\n}\n\n// Equal reports whether the node was determined to be equal or not.\n// As a special case, ignored nodes are considered equal.\nfunc (r Result) Equal() bool {\n\treturn r.flags&(reportEqual|reportByIgnore) != 0\n}\n\n// ByIgnore reports whether the node is equal because it was ignored.\n// This never reports true if [Result.Equal] reports false.\nfunc (r Result) ByIgnore() bool {\n\treturn r.flags&reportByIgnore != 0\n}\n\n// ByMethod reports whether the Equal method determined equality.\nfunc (r Result) ByMethod() bool {\n\treturn r.flags&reportByMethod != 0\n}\n\n// ByFunc reports whether a [Comparer] function determined equality.\nfunc (r Result) ByFunc() bool {\n\treturn r.flags&reportByFunc != 0\n}\n\n// ByCycle reports whether a reference cycle was detected.\nfunc (r Result) ByCycle() bool {\n\treturn r.flags&reportByCycle != 0\n}\n\ntype resultFlags uint\n\nconst (\n\t_ resultFlags = (1 << iota) / 2\n\n\treportEqual\n\treportUnequal\n\treportByIgnore\n\treportByMethod\n\treportByFunc\n\treportByCycle\n)\n\n// Reporter is an [Option] that can be passed to [Equal]. When [Equal] traverses\n// the value trees, it calls PushStep as it descends into each node in the\n// tree and PopStep as it ascend out of the node. The leaves of the tree are\n// either compared (determined to be equal or not equal) or ignored and reported\n// as such by calling the Report method.\nfunc Reporter(r interface {\n\t// PushStep is called when a tree-traversal operation is performed.\n\t// The PathStep itself is only valid until the step is popped.\n\t// The PathStep.Values are valid for the duration of the entire traversal\n\t// and must not be mutated.\n\t//\n\t// Equal always calls PushStep at the start to provide an operation-less\n\t// PathStep used to report the root values.\n\t//\n\t// Within a slice, the exact set of inserted, removed, or modified elements\n\t// is unspecified and may change in future implementations.\n\t// The entries of a map are iterated through in an unspecified order.\n\tPushStep(PathStep)\n\n\t// Report is called exactly once on leaf nodes to report whether the\n\t// comparison identified the node as equal, unequal, or ignored.\n\t// A leaf node is one that is immediately preceded by and followed by\n\t// a pair of PushStep and PopStep calls.\n\tReport(Result)\n\n\t// PopStep ascends back up the value tree.\n\t// There is always a matching pop call for every push call.\n\tPopStep()\n}) Option {\n\treturn reporter{r}\n}\n\ntype reporter struct{ reporterIface }\ntype reporterIface interface {\n\tPushStep(PathStep)\n\tReport(Result)\n\tPopStep()\n}\n\nfunc (reporter) filter(_ *state, _ reflect.Type, _, _ reflect.Value) applicableOption {\n\tpanic(\"not implemented\")\n}\n\n// normalizeOption normalizes the input options such that all Options groups\n// are flattened and groups with a single element are reduced to that element.\n// Only coreOptions and Options containing coreOptions are allowed.\nfunc normalizeOption(src Option) Option {\n\tswitch opts := flattenOptions(nil, Options{src}); len(opts) {\n\tcase 0:\n\t\treturn nil\n\tcase 1:\n\t\treturn opts[0]\n\tdefault:\n\t\treturn opts\n\t}\n}\n\n// flattenOptions copies all options in src to dst as a flat list.\n// Only coreOptions and Options containing coreOptions are allowed.\nfunc flattenOptions(dst, src Options) Options {\n\tfor _, opt := range src {\n\t\tswitch opt := opt.(type) {\n\t\tcase nil:\n\t\t\tcontinue\n\t\tcase Options:\n\t\t\tdst = flattenOptions(dst, opt)\n\t\tcase coreOption:\n\t\t\tdst = append(dst, opt)\n\t\tdefault:\n\t\t\tpanic(fmt.Sprintf(\"invalid option type: %T\", opt))\n\t\t}\n\t}\n\treturn dst\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/path.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\t\"strings\"\n\t\"unicode\"\n\t\"unicode/utf8\"\n\n\t\"github.com/google/go-cmp/cmp/internal/value\"\n)\n\n// Path is a list of [PathStep] describing the sequence of operations to get\n// from some root type to the current position in the value tree.\n// The first Path element is always an operation-less [PathStep] that exists\n// simply to identify the initial type.\n//\n// When traversing structs with embedded structs, the embedded struct will\n// always be accessed as a field before traversing the fields of the\n// embedded struct themselves. That is, an exported field from the\n// embedded struct will never be accessed directly from the parent struct.\ntype Path []PathStep\n\n// PathStep is a union-type for specific operations to traverse\n// a value's tree structure. Users of this package never need to implement\n// these types as values of this type will be returned by this package.\n//\n// Implementations of this interface:\n// - [StructField]\n// - [SliceIndex]\n// - [MapIndex]\n// - [Indirect]\n// - [TypeAssertion]\n// - [Transform]\ntype PathStep interface {\n\tString() string\n\n\t// Type is the resulting type after performing the path step.\n\tType() reflect.Type\n\n\t// Values is the resulting values after performing the path step.\n\t// The type of each valid value is guaranteed to be identical to Type.\n\t//\n\t// In some cases, one or both may be invalid or have restrictions:\n\t// - For StructField, both are not interface-able if the current field\n\t// is unexported and the struct type is not explicitly permitted by\n\t// an Exporter to traverse unexported fields.\n\t// - For SliceIndex, one may be invalid if an element is missing from\n\t// either the x or y slice.\n\t// - For MapIndex, one may be invalid if an entry is missing from\n\t// either the x or y map.\n\t//\n\t// The provided values must not be mutated.\n\tValues() (vx, vy reflect.Value)\n}\n\nvar (\n\t_ PathStep = StructField{}\n\t_ PathStep = SliceIndex{}\n\t_ PathStep = MapIndex{}\n\t_ PathStep = Indirect{}\n\t_ PathStep = TypeAssertion{}\n\t_ PathStep = Transform{}\n)\n\nfunc (pa *Path) push(s PathStep) {\n\t*pa = append(*pa, s)\n}\n\nfunc (pa *Path) pop() {\n\t*pa = (*pa)[:len(*pa)-1]\n}\n\n// Last returns the last [PathStep] in the Path.\n// If the path is empty, this returns a non-nil [PathStep]\n// that reports a nil [PathStep.Type].\nfunc (pa Path) Last() PathStep {\n\treturn pa.Index(-1)\n}\n\n// Index returns the ith step in the Path and supports negative indexing.\n// A negative index starts counting from the tail of the Path such that -1\n// refers to the last step, -2 refers to the second-to-last step, and so on.\n// If index is invalid, this returns a non-nil [PathStep]\n// that reports a nil [PathStep.Type].\nfunc (pa Path) Index(i int) PathStep {\n\tif i < 0 {\n\t\ti = len(pa) + i\n\t}\n\tif i < 0 || i >= len(pa) {\n\t\treturn pathStep{}\n\t}\n\treturn pa[i]\n}\n\n// String returns the simplified path to a node.\n// The simplified path only contains struct field accesses.\n//\n// For example:\n//\n//\tMyMap.MySlices.MyField\nfunc (pa Path) String() string {\n\tvar ss []string\n\tfor _, s := range pa {\n\t\tif _, ok := s.(StructField); ok {\n\t\t\tss = append(ss, s.String())\n\t\t}\n\t}\n\treturn strings.TrimPrefix(strings.Join(ss, \"\"), \".\")\n}\n\n// GoString returns the path to a specific node using Go syntax.\n//\n// For example:\n//\n//\t(*root.MyMap[\"key\"].(*mypkg.MyStruct).MySlices)[2][3].MyField\nfunc (pa Path) GoString() string {\n\tvar ssPre, ssPost []string\n\tvar numIndirect int\n\tfor i, s := range pa {\n\t\tvar nextStep PathStep\n\t\tif i+1 < len(pa) {\n\t\t\tnextStep = pa[i+1]\n\t\t}\n\t\tswitch s := s.(type) {\n\t\tcase Indirect:\n\t\t\tnumIndirect++\n\t\t\tpPre, pPost := \"(\", \")\"\n\t\t\tswitch nextStep.(type) {\n\t\t\tcase Indirect:\n\t\t\t\tcontinue // Next step is indirection, so let them batch up\n\t\t\tcase StructField:\n\t\t\t\tnumIndirect-- // Automatic indirection on struct fields\n\t\t\tcase nil:\n\t\t\t\tpPre, pPost = \"\", \"\" // Last step; no need for parenthesis\n\t\t\t}\n\t\t\tif numIndirect > 0 {\n\t\t\t\tssPre = append(ssPre, pPre+strings.Repeat(\"*\", numIndirect))\n\t\t\t\tssPost = append(ssPost, pPost)\n\t\t\t}\n\t\t\tnumIndirect = 0\n\t\t\tcontinue\n\t\tcase Transform:\n\t\t\tssPre = append(ssPre, s.trans.name+\"(\")\n\t\t\tssPost = append(ssPost, \")\")\n\t\t\tcontinue\n\t\t}\n\t\tssPost = append(ssPost, s.String())\n\t}\n\tfor i, j := 0, len(ssPre)-1; i < j; i, j = i+1, j-1 {\n\t\tssPre[i], ssPre[j] = ssPre[j], ssPre[i]\n\t}\n\treturn strings.Join(ssPre, \"\") + strings.Join(ssPost, \"\")\n}\n\ntype pathStep struct {\n\ttyp reflect.Type\n\tvx, vy reflect.Value\n}\n\nfunc (ps pathStep) Type() reflect.Type { return ps.typ }\nfunc (ps pathStep) Values() (vx, vy reflect.Value) { return ps.vx, ps.vy }\nfunc (ps pathStep) String() string {\n\tif ps.typ == nil {\n\t\treturn \"\"\n\t}\n\ts := value.TypeString(ps.typ, false)\n\tif s == \"\" || strings.ContainsAny(s, \"{}\\n\") {\n\t\treturn \"root\" // Type too simple or complex to print\n\t}\n\treturn fmt.Sprintf(\"{%s}\", s)\n}\n\n// StructField is a [PathStep] that represents a struct field access\n// on a field called [StructField.Name].\ntype StructField struct{ *structField }\ntype structField struct {\n\tpathStep\n\tname string\n\tidx int\n\n\t// These fields are used for forcibly accessing an unexported field.\n\t// pvx, pvy, and field are only valid if unexported is true.\n\tunexported bool\n\tmayForce bool // Forcibly allow visibility\n\tpaddr bool // Was parent addressable?\n\tpvx, pvy reflect.Value // Parent values (always addressable)\n\tfield reflect.StructField // Field information\n}\n\nfunc (sf StructField) Type() reflect.Type { return sf.typ }\nfunc (sf StructField) Values() (vx, vy reflect.Value) {\n\tif !sf.unexported {\n\t\treturn sf.vx, sf.vy // CanInterface reports true\n\t}\n\n\t// Forcibly obtain read-write access to an unexported struct field.\n\tif sf.mayForce {\n\t\tvx = retrieveUnexportedField(sf.pvx, sf.field, sf.paddr)\n\t\tvy = retrieveUnexportedField(sf.pvy, sf.field, sf.paddr)\n\t\treturn vx, vy // CanInterface reports true\n\t}\n\treturn sf.vx, sf.vy // CanInterface reports false\n}\nfunc (sf StructField) String() string { return fmt.Sprintf(\".%s\", sf.name) }\n\n// Name is the field name.\nfunc (sf StructField) Name() string { return sf.name }\n\n// Index is the index of the field in the parent struct type.\n// See [reflect.Type.Field].\nfunc (sf StructField) Index() int { return sf.idx }\n\n// SliceIndex is a [PathStep] that represents an index operation on\n// a slice or array at some index [SliceIndex.Key].\ntype SliceIndex struct{ *sliceIndex }\ntype sliceIndex struct {\n\tpathStep\n\txkey, ykey int\n\tisSlice bool // False for reflect.Array\n}\n\nfunc (si SliceIndex) Type() reflect.Type { return si.typ }\nfunc (si SliceIndex) Values() (vx, vy reflect.Value) { return si.vx, si.vy }\nfunc (si SliceIndex) String() string {\n\tswitch {\n\tcase si.xkey == si.ykey:\n\t\treturn fmt.Sprintf(\"[%d]\", si.xkey)\n\tcase si.ykey == -1:\n\t\t// [5->?] means \"I don't know where X[5] went\"\n\t\treturn fmt.Sprintf(\"[%d->?]\", si.xkey)\n\tcase si.xkey == -1:\n\t\t// [?->3] means \"I don't know where Y[3] came from\"\n\t\treturn fmt.Sprintf(\"[?->%d]\", si.ykey)\n\tdefault:\n\t\t// [5->3] means \"X[5] moved to Y[3]\"\n\t\treturn fmt.Sprintf(\"[%d->%d]\", si.xkey, si.ykey)\n\t}\n}\n\n// Key is the index key; it may return -1 if in a split state\nfunc (si SliceIndex) Key() int {\n\tif si.xkey != si.ykey {\n\t\treturn -1\n\t}\n\treturn si.xkey\n}\n\n// SplitKeys are the indexes for indexing into slices in the\n// x and y values, respectively. These indexes may differ due to the\n// insertion or removal of an element in one of the slices, causing\n// all of the indexes to be shifted. If an index is -1, then that\n// indicates that the element does not exist in the associated slice.\n//\n// [SliceIndex.Key] is guaranteed to return -1 if and only if the indexes\n// returned by SplitKeys are not the same. SplitKeys will never return -1 for\n// both indexes.\nfunc (si SliceIndex) SplitKeys() (ix, iy int) { return si.xkey, si.ykey }\n\n// MapIndex is a [PathStep] that represents an index operation on a map at some index Key.\ntype MapIndex struct{ *mapIndex }\ntype mapIndex struct {\n\tpathStep\n\tkey reflect.Value\n}\n\nfunc (mi MapIndex) Type() reflect.Type { return mi.typ }\nfunc (mi MapIndex) Values() (vx, vy reflect.Value) { return mi.vx, mi.vy }\nfunc (mi MapIndex) String() string { return fmt.Sprintf(\"[%#v]\", mi.key) }\n\n// Key is the value of the map key.\nfunc (mi MapIndex) Key() reflect.Value { return mi.key }\n\n// Indirect is a [PathStep] that represents pointer indirection on the parent type.\ntype Indirect struct{ *indirect }\ntype indirect struct {\n\tpathStep\n}\n\nfunc (in Indirect) Type() reflect.Type { return in.typ }\nfunc (in Indirect) Values() (vx, vy reflect.Value) { return in.vx, in.vy }\nfunc (in Indirect) String() string { return \"*\" }\n\n// TypeAssertion is a [PathStep] that represents a type assertion on an interface.\ntype TypeAssertion struct{ *typeAssertion }\ntype typeAssertion struct {\n\tpathStep\n}\n\nfunc (ta TypeAssertion) Type() reflect.Type { return ta.typ }\nfunc (ta TypeAssertion) Values() (vx, vy reflect.Value) { return ta.vx, ta.vy }\nfunc (ta TypeAssertion) String() string { return fmt.Sprintf(\".(%v)\", value.TypeString(ta.typ, false)) }\n\n// Transform is a [PathStep] that represents a transformation\n// from the parent type to the current type.\ntype Transform struct{ *transform }\ntype transform struct {\n\tpathStep\n\ttrans *transformer\n}\n\nfunc (tf Transform) Type() reflect.Type { return tf.typ }\nfunc (tf Transform) Values() (vx, vy reflect.Value) { return tf.vx, tf.vy }\nfunc (tf Transform) String() string { return fmt.Sprintf(\"%s()\", tf.trans.name) }\n\n// Name is the name of the [Transformer].\nfunc (tf Transform) Name() string { return tf.trans.name }\n\n// Func is the function pointer to the transformer function.\nfunc (tf Transform) Func() reflect.Value { return tf.trans.fnc }\n\n// Option returns the originally constructed [Transformer] option.\n// The == operator can be used to detect the exact option used.\nfunc (tf Transform) Option() Option { return tf.trans }\n\n// pointerPath represents a dual-stack of pointers encountered when\n// recursively traversing the x and y values. This data structure supports\n// detection of cycles and determining whether the cycles are equal.\n// In Go, cycles can occur via pointers, slices, and maps.\n//\n// The pointerPath uses a map to represent a stack; where descension into a\n// pointer pushes the address onto the stack, and ascension from a pointer\n// pops the address from the stack. Thus, when traversing into a pointer from\n// reflect.Ptr, reflect.Slice element, or reflect.Map, we can detect cycles\n// by checking whether the pointer has already been visited. The cycle detection\n// uses a separate stack for the x and y values.\n//\n// If a cycle is detected we need to determine whether the two pointers\n// should be considered equal. The definition of equality chosen by Equal\n// requires two graphs to have the same structure. To determine this, both the\n// x and y values must have a cycle where the previous pointers were also\n// encountered together as a pair.\n//\n// Semantically, this is equivalent to augmenting Indirect, SliceIndex, and\n// MapIndex with pointer information for the x and y values.\n// Suppose px and py are two pointers to compare, we then search the\n// Path for whether px was ever encountered in the Path history of x, and\n// similarly so with py. If either side has a cycle, the comparison is only\n// equal if both px and py have a cycle resulting from the same PathStep.\n//\n// Using a map as a stack is more performant as we can perform cycle detection\n// in O(1) instead of O(N) where N is len(Path).\ntype pointerPath struct {\n\t// mx is keyed by x pointers, where the value is the associated y pointer.\n\tmx map[value.Pointer]value.Pointer\n\t// my is keyed by y pointers, where the value is the associated x pointer.\n\tmy map[value.Pointer]value.Pointer\n}\n\nfunc (p *pointerPath) Init() {\n\tp.mx = make(map[value.Pointer]value.Pointer)\n\tp.my = make(map[value.Pointer]value.Pointer)\n}\n\n// Push indicates intent to descend into pointers vx and vy where\n// visited reports whether either has been seen before. If visited before,\n// equal reports whether both pointers were encountered together.\n// Pop must be called if and only if the pointers were never visited.\n//\n// The pointers vx and vy must be a reflect.Ptr, reflect.Slice, or reflect.Map\n// and be non-nil.\nfunc (p pointerPath) Push(vx, vy reflect.Value) (equal, visited bool) {\n\tpx := value.PointerOf(vx)\n\tpy := value.PointerOf(vy)\n\t_, ok1 := p.mx[px]\n\t_, ok2 := p.my[py]\n\tif ok1 || ok2 {\n\t\tequal = p.mx[px] == py && p.my[py] == px // Pointers paired together\n\t\treturn equal, true\n\t}\n\tp.mx[px] = py\n\tp.my[py] = px\n\treturn false, false\n}\n\n// Pop ascends from pointers vx and vy.\nfunc (p pointerPath) Pop(vx, vy reflect.Value) {\n\tdelete(p.mx, value.PointerOf(vx))\n\tdelete(p.my, value.PointerOf(vy))\n}\n\n// isExported reports whether the identifier is exported.\nfunc isExported(id string) bool {\n\tr, _ := utf8.DecodeRuneInString(id)\n\treturn unicode.IsUpper(r)\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/report.go",
"content": "// Copyright 2017, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\n// defaultReporter implements the reporter interface.\n//\n// As Equal serially calls the PushStep, Report, and PopStep methods, the\n// defaultReporter constructs a tree-based representation of the compared value\n// and the result of each comparison (see valueNode).\n//\n// When the String method is called, the FormatDiff method transforms the\n// valueNode tree into a textNode tree, which is a tree-based representation\n// of the textual output (see textNode).\n//\n// Lastly, the textNode.String method produces the final report as a string.\ntype defaultReporter struct {\n\troot *valueNode\n\tcurr *valueNode\n}\n\nfunc (r *defaultReporter) PushStep(ps PathStep) {\n\tr.curr = r.curr.PushStep(ps)\n\tif r.root == nil {\n\t\tr.root = r.curr\n\t}\n}\nfunc (r *defaultReporter) Report(rs Result) {\n\tr.curr.Report(rs)\n}\nfunc (r *defaultReporter) PopStep() {\n\tr.curr = r.curr.PopStep()\n}\n\n// String provides a full report of the differences detected as a structured\n// literal in pseudo-Go syntax. String may only be called after the entire tree\n// has been traversed.\nfunc (r *defaultReporter) String() string {\n\tassert(r.root != nil && r.curr == nil)\n\tif r.root.NumDiff == 0 {\n\t\treturn \"\"\n\t}\n\tptrs := new(pointerReferences)\n\ttext := formatOptions{}.FormatDiff(r.root, ptrs)\n\tresolveReferences(text)\n\treturn text.String()\n}\n\nfunc assert(ok bool) {\n\tif !ok {\n\t\tpanic(\"assertion failure\")\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/report_compare.go",
"content": "// Copyright 2019, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n)\n\n// numContextRecords is the number of surrounding equal records to print.\nconst numContextRecords = 2\n\ntype diffMode byte\n\nconst (\n\tdiffUnknown diffMode = 0\n\tdiffIdentical diffMode = ' '\n\tdiffRemoved diffMode = '-'\n\tdiffInserted diffMode = '+'\n)\n\ntype typeMode int\n\nconst (\n\t// emitType always prints the type.\n\temitType typeMode = iota\n\t// elideType never prints the type.\n\telideType\n\t// autoType prints the type only for composite kinds\n\t// (i.e., structs, slices, arrays, and maps).\n\tautoType\n)\n\ntype formatOptions struct {\n\t// DiffMode controls the output mode of FormatDiff.\n\t//\n\t// If diffUnknown, then produce a diff of the x and y values.\n\t// If diffIdentical, then emit values as if they were equal.\n\t// If diffRemoved, then only emit x values (ignoring y values).\n\t// If diffInserted, then only emit y values (ignoring x values).\n\tDiffMode diffMode\n\n\t// TypeMode controls whether to print the type for the current node.\n\t//\n\t// As a general rule of thumb, we always print the type of the next node\n\t// after an interface, and always elide the type of the next node after\n\t// a slice or map node.\n\tTypeMode typeMode\n\n\t// formatValueOptions are options specific to printing reflect.Values.\n\tformatValueOptions\n}\n\nfunc (opts formatOptions) WithDiffMode(d diffMode) formatOptions {\n\topts.DiffMode = d\n\treturn opts\n}\nfunc (opts formatOptions) WithTypeMode(t typeMode) formatOptions {\n\topts.TypeMode = t\n\treturn opts\n}\nfunc (opts formatOptions) WithVerbosity(level int) formatOptions {\n\topts.VerbosityLevel = level\n\topts.LimitVerbosity = true\n\treturn opts\n}\nfunc (opts formatOptions) verbosity() uint {\n\tswitch {\n\tcase opts.VerbosityLevel < 0:\n\t\treturn 0\n\tcase opts.VerbosityLevel > 16:\n\t\treturn 16 // some reasonable maximum to avoid shift overflow\n\tdefault:\n\t\treturn uint(opts.VerbosityLevel)\n\t}\n}\n\nconst maxVerbosityPreset = 6\n\n// verbosityPreset modifies the verbosity settings given an index\n// between 0 and maxVerbosityPreset, inclusive.\nfunc verbosityPreset(opts formatOptions, i int) formatOptions {\n\topts.VerbosityLevel = int(opts.verbosity()) + 2*i\n\tif i > 0 {\n\t\topts.AvoidStringer = true\n\t}\n\tif i >= maxVerbosityPreset {\n\t\topts.PrintAddresses = true\n\t\topts.QualifiedNames = true\n\t}\n\treturn opts\n}\n\n// FormatDiff converts a valueNode tree into a textNode tree, where the later\n// is a textual representation of the differences detected in the former.\nfunc (opts formatOptions) FormatDiff(v *valueNode, ptrs *pointerReferences) (out textNode) {\n\tif opts.DiffMode == diffIdentical {\n\t\topts = opts.WithVerbosity(1)\n\t} else if opts.verbosity() < 3 {\n\t\topts = opts.WithVerbosity(3)\n\t}\n\n\t// Check whether we have specialized formatting for this node.\n\t// This is not necessary, but helpful for producing more readable outputs.\n\tif opts.CanFormatDiffSlice(v) {\n\t\treturn opts.FormatDiffSlice(v)\n\t}\n\n\tvar parentKind reflect.Kind\n\tif v.parent != nil && v.parent.TransformerName == \"\" {\n\t\tparentKind = v.parent.Type.Kind()\n\t}\n\n\t// For leaf nodes, format the value based on the reflect.Values alone.\n\t// As a special case, treat equal []byte as a leaf nodes.\n\tisBytes := v.Type.Kind() == reflect.Slice && v.Type.Elem() == byteType\n\tisEqualBytes := isBytes && v.NumDiff+v.NumIgnored+v.NumTransformed == 0\n\tif v.MaxDepth == 0 || isEqualBytes {\n\t\tswitch opts.DiffMode {\n\t\tcase diffUnknown, diffIdentical:\n\t\t\t// Format Equal.\n\t\t\tif v.NumDiff == 0 {\n\t\t\t\toutx := opts.FormatValue(v.ValueX, parentKind, ptrs)\n\t\t\t\touty := opts.FormatValue(v.ValueY, parentKind, ptrs)\n\t\t\t\tif v.NumIgnored > 0 && v.NumSame == 0 {\n\t\t\t\t\treturn textEllipsis\n\t\t\t\t} else if outx.Len() < outy.Len() {\n\t\t\t\t\treturn outx\n\t\t\t\t} else {\n\t\t\t\t\treturn outy\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Format unequal.\n\t\t\tassert(opts.DiffMode == diffUnknown)\n\t\t\tvar list textList\n\t\t\toutx := opts.WithTypeMode(elideType).FormatValue(v.ValueX, parentKind, ptrs)\n\t\t\touty := opts.WithTypeMode(elideType).FormatValue(v.ValueY, parentKind, ptrs)\n\t\t\tfor i := 0; i <= maxVerbosityPreset && outx != nil && outy != nil && outx.Equal(outy); i++ {\n\t\t\t\topts2 := verbosityPreset(opts, i).WithTypeMode(elideType)\n\t\t\t\toutx = opts2.FormatValue(v.ValueX, parentKind, ptrs)\n\t\t\t\touty = opts2.FormatValue(v.ValueY, parentKind, ptrs)\n\t\t\t}\n\t\t\tif outx != nil {\n\t\t\t\tlist = append(list, textRecord{Diff: '-', Value: outx})\n\t\t\t}\n\t\t\tif outy != nil {\n\t\t\t\tlist = append(list, textRecord{Diff: '+', Value: outy})\n\t\t\t}\n\t\t\treturn opts.WithTypeMode(emitType).FormatType(v.Type, list)\n\t\tcase diffRemoved:\n\t\t\treturn opts.FormatValue(v.ValueX, parentKind, ptrs)\n\t\tcase diffInserted:\n\t\t\treturn opts.FormatValue(v.ValueY, parentKind, ptrs)\n\t\tdefault:\n\t\t\tpanic(\"invalid diff mode\")\n\t\t}\n\t}\n\n\t// Register slice element to support cycle detection.\n\tif parentKind == reflect.Slice {\n\t\tptrRefs := ptrs.PushPair(v.ValueX, v.ValueY, opts.DiffMode, true)\n\t\tdefer ptrs.Pop()\n\t\tdefer func() { out = wrapTrunkReferences(ptrRefs, out) }()\n\t}\n\n\t// Descend into the child value node.\n\tif v.TransformerName != \"\" {\n\t\tout := opts.WithTypeMode(emitType).FormatDiff(v.Value, ptrs)\n\t\tout = &textWrap{Prefix: \"Inverse(\" + v.TransformerName + \", \", Value: out, Suffix: \")\"}\n\t\treturn opts.FormatType(v.Type, out)\n\t} else {\n\t\tswitch k := v.Type.Kind(); k {\n\t\tcase reflect.Struct, reflect.Array, reflect.Slice:\n\t\t\tout = opts.formatDiffList(v.Records, k, ptrs)\n\t\t\tout = opts.FormatType(v.Type, out)\n\t\tcase reflect.Map:\n\t\t\t// Register map to support cycle detection.\n\t\t\tptrRefs := ptrs.PushPair(v.ValueX, v.ValueY, opts.DiffMode, false)\n\t\t\tdefer ptrs.Pop()\n\n\t\t\tout = opts.formatDiffList(v.Records, k, ptrs)\n\t\t\tout = wrapTrunkReferences(ptrRefs, out)\n\t\t\tout = opts.FormatType(v.Type, out)\n\t\tcase reflect.Ptr:\n\t\t\t// Register pointer to support cycle detection.\n\t\t\tptrRefs := ptrs.PushPair(v.ValueX, v.ValueY, opts.DiffMode, false)\n\t\t\tdefer ptrs.Pop()\n\n\t\t\tout = opts.FormatDiff(v.Value, ptrs)\n\t\t\tout = wrapTrunkReferences(ptrRefs, out)\n\t\t\tout = &textWrap{Prefix: \"&\", Value: out}\n\t\tcase reflect.Interface:\n\t\t\tout = opts.WithTypeMode(emitType).FormatDiff(v.Value, ptrs)\n\t\tdefault:\n\t\t\tpanic(fmt.Sprintf(\"%v cannot have children\", k))\n\t\t}\n\t\treturn out\n\t}\n}\n\nfunc (opts formatOptions) formatDiffList(recs []reportRecord, k reflect.Kind, ptrs *pointerReferences) textNode {\n\t// Derive record name based on the data structure kind.\n\tvar name string\n\tvar formatKey func(reflect.Value) string\n\tswitch k {\n\tcase reflect.Struct:\n\t\tname = \"field\"\n\t\topts = opts.WithTypeMode(autoType)\n\t\tformatKey = func(v reflect.Value) string { return v.String() }\n\tcase reflect.Slice, reflect.Array:\n\t\tname = \"element\"\n\t\topts = opts.WithTypeMode(elideType)\n\t\tformatKey = func(reflect.Value) string { return \"\" }\n\tcase reflect.Map:\n\t\tname = \"entry\"\n\t\topts = opts.WithTypeMode(elideType)\n\t\tformatKey = func(v reflect.Value) string { return formatMapKey(v, false, ptrs) }\n\t}\n\n\tmaxLen := -1\n\tif opts.LimitVerbosity {\n\t\tif opts.DiffMode == diffIdentical {\n\t\t\tmaxLen = ((1 << opts.verbosity()) >> 1) << 2 // 0, 4, 8, 16, 32, etc...\n\t\t} else {\n\t\t\tmaxLen = (1 << opts.verbosity()) << 1 // 2, 4, 8, 16, 32, 64, etc...\n\t\t}\n\t\topts.VerbosityLevel--\n\t}\n\n\t// Handle unification.\n\tswitch opts.DiffMode {\n\tcase diffIdentical, diffRemoved, diffInserted:\n\t\tvar list textList\n\t\tvar deferredEllipsis bool // Add final \"...\" to indicate records were dropped\n\t\tfor _, r := range recs {\n\t\t\tif len(list) == maxLen {\n\t\t\t\tdeferredEllipsis = true\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\t// Elide struct fields that are zero value.\n\t\t\tif k == reflect.Struct {\n\t\t\t\tvar isZero bool\n\t\t\t\tswitch opts.DiffMode {\n\t\t\t\tcase diffIdentical:\n\t\t\t\t\tisZero = r.Value.ValueX.IsZero() || r.Value.ValueY.IsZero()\n\t\t\t\tcase diffRemoved:\n\t\t\t\t\tisZero = r.Value.ValueX.IsZero()\n\t\t\t\tcase diffInserted:\n\t\t\t\t\tisZero = r.Value.ValueY.IsZero()\n\t\t\t\t}\n\t\t\t\tif isZero {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t}\n\t\t\t// Elide ignored nodes.\n\t\t\tif r.Value.NumIgnored > 0 && r.Value.NumSame+r.Value.NumDiff == 0 {\n\t\t\t\tdeferredEllipsis = !(k == reflect.Slice || k == reflect.Array)\n\t\t\t\tif !deferredEllipsis {\n\t\t\t\t\tlist.AppendEllipsis(diffStats{})\n\t\t\t\t}\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif out := opts.FormatDiff(r.Value, ptrs); out != nil {\n\t\t\t\tlist = append(list, textRecord{Key: formatKey(r.Key), Value: out})\n\t\t\t}\n\t\t}\n\t\tif deferredEllipsis {\n\t\t\tlist.AppendEllipsis(diffStats{})\n\t\t}\n\t\treturn &textWrap{Prefix: \"{\", Value: list, Suffix: \"}\"}\n\tcase diffUnknown:\n\tdefault:\n\t\tpanic(\"invalid diff mode\")\n\t}\n\n\t// Handle differencing.\n\tvar numDiffs int\n\tvar list textList\n\tvar keys []reflect.Value // invariant: len(list) == len(keys)\n\tgroups := coalesceAdjacentRecords(name, recs)\n\tmaxGroup := diffStats{Name: name}\n\tfor i, ds := range groups {\n\t\tif maxLen >= 0 && numDiffs >= maxLen {\n\t\t\tmaxGroup = maxGroup.Append(ds)\n\t\t\tcontinue\n\t\t}\n\n\t\t// Handle equal records.\n\t\tif ds.NumDiff() == 0 {\n\t\t\t// Compute the number of leading and trailing records to print.\n\t\t\tvar numLo, numHi int\n\t\t\tnumEqual := ds.NumIgnored + ds.NumIdentical\n\t\t\tfor numLo < numContextRecords && numLo+numHi < numEqual && i != 0 {\n\t\t\t\tif r := recs[numLo].Value; r.NumIgnored > 0 && r.NumSame+r.NumDiff == 0 {\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tnumLo++\n\t\t\t}\n\t\t\tfor numHi < numContextRecords && numLo+numHi < numEqual && i != len(groups)-1 {\n\t\t\t\tif r := recs[numEqual-numHi-1].Value; r.NumIgnored > 0 && r.NumSame+r.NumDiff == 0 {\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tnumHi++\n\t\t\t}\n\t\t\tif numEqual-(numLo+numHi) == 1 && ds.NumIgnored == 0 {\n\t\t\t\tnumHi++ // Avoid pointless coalescing of a single equal record\n\t\t\t}\n\n\t\t\t// Format the equal values.\n\t\t\tfor _, r := range recs[:numLo] {\n\t\t\t\tout := opts.WithDiffMode(diffIdentical).FormatDiff(r.Value, ptrs)\n\t\t\t\tlist = append(list, textRecord{Key: formatKey(r.Key), Value: out})\n\t\t\t\tkeys = append(keys, r.Key)\n\t\t\t}\n\t\t\tif numEqual > numLo+numHi {\n\t\t\t\tds.NumIdentical -= numLo + numHi\n\t\t\t\tlist.AppendEllipsis(ds)\n\t\t\t\tfor len(keys) < len(list) {\n\t\t\t\t\tkeys = append(keys, reflect.Value{})\n\t\t\t\t}\n\t\t\t}\n\t\t\tfor _, r := range recs[numEqual-numHi : numEqual] {\n\t\t\t\tout := opts.WithDiffMode(diffIdentical).FormatDiff(r.Value, ptrs)\n\t\t\t\tlist = append(list, textRecord{Key: formatKey(r.Key), Value: out})\n\t\t\t\tkeys = append(keys, r.Key)\n\t\t\t}\n\t\t\trecs = recs[numEqual:]\n\t\t\tcontinue\n\t\t}\n\n\t\t// Handle unequal records.\n\t\tfor _, r := range recs[:ds.NumDiff()] {\n\t\t\tswitch {\n\t\t\tcase opts.CanFormatDiffSlice(r.Value):\n\t\t\t\tout := opts.FormatDiffSlice(r.Value)\n\t\t\t\tlist = append(list, textRecord{Key: formatKey(r.Key), Value: out})\n\t\t\t\tkeys = append(keys, r.Key)\n\t\t\tcase r.Value.NumChildren == r.Value.MaxDepth:\n\t\t\t\toutx := opts.WithDiffMode(diffRemoved).FormatDiff(r.Value, ptrs)\n\t\t\t\touty := opts.WithDiffMode(diffInserted).FormatDiff(r.Value, ptrs)\n\t\t\t\tfor i := 0; i <= maxVerbosityPreset && outx != nil && outy != nil && outx.Equal(outy); i++ {\n\t\t\t\t\topts2 := verbosityPreset(opts, i)\n\t\t\t\t\toutx = opts2.WithDiffMode(diffRemoved).FormatDiff(r.Value, ptrs)\n\t\t\t\t\touty = opts2.WithDiffMode(diffInserted).FormatDiff(r.Value, ptrs)\n\t\t\t\t}\n\t\t\t\tif outx != nil {\n\t\t\t\t\tlist = append(list, textRecord{Diff: diffRemoved, Key: formatKey(r.Key), Value: outx})\n\t\t\t\t\tkeys = append(keys, r.Key)\n\t\t\t\t}\n\t\t\t\tif outy != nil {\n\t\t\t\t\tlist = append(list, textRecord{Diff: diffInserted, Key: formatKey(r.Key), Value: outy})\n\t\t\t\t\tkeys = append(keys, r.Key)\n\t\t\t\t}\n\t\t\tdefault:\n\t\t\t\tout := opts.FormatDiff(r.Value, ptrs)\n\t\t\t\tlist = append(list, textRecord{Key: formatKey(r.Key), Value: out})\n\t\t\t\tkeys = append(keys, r.Key)\n\t\t\t}\n\t\t}\n\t\trecs = recs[ds.NumDiff():]\n\t\tnumDiffs += ds.NumDiff()\n\t}\n\tif maxGroup.IsZero() {\n\t\tassert(len(recs) == 0)\n\t} else {\n\t\tlist.AppendEllipsis(maxGroup)\n\t\tfor len(keys) < len(list) {\n\t\t\tkeys = append(keys, reflect.Value{})\n\t\t}\n\t}\n\tassert(len(list) == len(keys))\n\n\t// For maps, the default formatting logic uses fmt.Stringer which may\n\t// produce ambiguous output. Avoid calling String to disambiguate.\n\tif k == reflect.Map {\n\t\tvar ambiguous bool\n\t\tseenKeys := map[string]reflect.Value{}\n\t\tfor i, currKey := range keys {\n\t\t\tif currKey.IsValid() {\n\t\t\t\tstrKey := list[i].Key\n\t\t\t\tprevKey, seen := seenKeys[strKey]\n\t\t\t\tif seen && prevKey.CanInterface() && currKey.CanInterface() {\n\t\t\t\t\tambiguous = prevKey.Interface() != currKey.Interface()\n\t\t\t\t\tif ambiguous {\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tseenKeys[strKey] = currKey\n\t\t\t}\n\t\t}\n\t\tif ambiguous {\n\t\t\tfor i, k := range keys {\n\t\t\t\tif k.IsValid() {\n\t\t\t\t\tlist[i].Key = formatMapKey(k, true, ptrs)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn &textWrap{Prefix: \"{\", Value: list, Suffix: \"}\"}\n}\n\n// coalesceAdjacentRecords coalesces the list of records into groups of\n// adjacent equal, or unequal counts.\nfunc coalesceAdjacentRecords(name string, recs []reportRecord) (groups []diffStats) {\n\tvar prevCase int // Arbitrary index into which case last occurred\n\tlastStats := func(i int) *diffStats {\n\t\tif prevCase != i {\n\t\t\tgroups = append(groups, diffStats{Name: name})\n\t\t\tprevCase = i\n\t\t}\n\t\treturn &groups[len(groups)-1]\n\t}\n\tfor _, r := range recs {\n\t\tswitch rv := r.Value; {\n\t\tcase rv.NumIgnored > 0 && rv.NumSame+rv.NumDiff == 0:\n\t\t\tlastStats(1).NumIgnored++\n\t\tcase rv.NumDiff == 0:\n\t\t\tlastStats(1).NumIdentical++\n\t\tcase rv.NumDiff > 0 && !rv.ValueY.IsValid():\n\t\t\tlastStats(2).NumRemoved++\n\t\tcase rv.NumDiff > 0 && !rv.ValueX.IsValid():\n\t\t\tlastStats(2).NumInserted++\n\t\tdefault:\n\t\t\tlastStats(2).NumModified++\n\t\t}\n\t}\n\treturn groups\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/report_references.go",
"content": "// Copyright 2020, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\t\"strings\"\n\n\t\"github.com/google/go-cmp/cmp/internal/flags\"\n\t\"github.com/google/go-cmp/cmp/internal/value\"\n)\n\nconst (\n\tpointerDelimPrefix = \"⟪\"\n\tpointerDelimSuffix = \"⟫\"\n)\n\n// formatPointer prints the address of the pointer.\nfunc formatPointer(p value.Pointer, withDelims bool) string {\n\tv := p.Uintptr()\n\tif flags.Deterministic {\n\t\tv = 0xdeadf00f // Only used for stable testing purposes\n\t}\n\tif withDelims {\n\t\treturn pointerDelimPrefix + formatHex(uint64(v)) + pointerDelimSuffix\n\t}\n\treturn formatHex(uint64(v))\n}\n\n// pointerReferences is a stack of pointers visited so far.\ntype pointerReferences [][2]value.Pointer\n\nfunc (ps *pointerReferences) PushPair(vx, vy reflect.Value, d diffMode, deref bool) (pp [2]value.Pointer) {\n\tif deref && vx.IsValid() {\n\t\tvx = vx.Addr()\n\t}\n\tif deref && vy.IsValid() {\n\t\tvy = vy.Addr()\n\t}\n\tswitch d {\n\tcase diffUnknown, diffIdentical:\n\t\tpp = [2]value.Pointer{value.PointerOf(vx), value.PointerOf(vy)}\n\tcase diffRemoved:\n\t\tpp = [2]value.Pointer{value.PointerOf(vx), value.Pointer{}}\n\tcase diffInserted:\n\t\tpp = [2]value.Pointer{value.Pointer{}, value.PointerOf(vy)}\n\t}\n\t*ps = append(*ps, pp)\n\treturn pp\n}\n\nfunc (ps *pointerReferences) Push(v reflect.Value) (p value.Pointer, seen bool) {\n\tp = value.PointerOf(v)\n\tfor _, pp := range *ps {\n\t\tif p == pp[0] || p == pp[1] {\n\t\t\treturn p, true\n\t\t}\n\t}\n\t*ps = append(*ps, [2]value.Pointer{p, p})\n\treturn p, false\n}\n\nfunc (ps *pointerReferences) Pop() {\n\t*ps = (*ps)[:len(*ps)-1]\n}\n\n// trunkReferences is metadata for a textNode indicating that the sub-tree\n// represents the value for either pointer in a pair of references.\ntype trunkReferences struct{ pp [2]value.Pointer }\n\n// trunkReference is metadata for a textNode indicating that the sub-tree\n// represents the value for the given pointer reference.\ntype trunkReference struct{ p value.Pointer }\n\n// leafReference is metadata for a textNode indicating that the value is\n// truncated as it refers to another part of the tree (i.e., a trunk).\ntype leafReference struct{ p value.Pointer }\n\nfunc wrapTrunkReferences(pp [2]value.Pointer, s textNode) textNode {\n\tswitch {\n\tcase pp[0].IsNil():\n\t\treturn &textWrap{Value: s, Metadata: trunkReference{pp[1]}}\n\tcase pp[1].IsNil():\n\t\treturn &textWrap{Value: s, Metadata: trunkReference{pp[0]}}\n\tcase pp[0] == pp[1]:\n\t\treturn &textWrap{Value: s, Metadata: trunkReference{pp[0]}}\n\tdefault:\n\t\treturn &textWrap{Value: s, Metadata: trunkReferences{pp}}\n\t}\n}\nfunc wrapTrunkReference(p value.Pointer, printAddress bool, s textNode) textNode {\n\tvar prefix string\n\tif printAddress {\n\t\tprefix = formatPointer(p, true)\n\t}\n\treturn &textWrap{Prefix: prefix, Value: s, Metadata: trunkReference{p}}\n}\nfunc makeLeafReference(p value.Pointer, printAddress bool) textNode {\n\tout := &textWrap{Prefix: \"(\", Value: textEllipsis, Suffix: \")\"}\n\tvar prefix string\n\tif printAddress {\n\t\tprefix = formatPointer(p, true)\n\t}\n\treturn &textWrap{Prefix: prefix, Value: out, Metadata: leafReference{p}}\n}\n\n// resolveReferences walks the textNode tree searching for any leaf reference\n// metadata and resolves each against the corresponding trunk references.\n// Since pointer addresses in memory are not particularly readable to the user,\n// it replaces each pointer value with an arbitrary and unique reference ID.\nfunc resolveReferences(s textNode) {\n\tvar walkNodes func(textNode, func(textNode))\n\twalkNodes = func(s textNode, f func(textNode)) {\n\t\tf(s)\n\t\tswitch s := s.(type) {\n\t\tcase *textWrap:\n\t\t\twalkNodes(s.Value, f)\n\t\tcase textList:\n\t\t\tfor _, r := range s {\n\t\t\t\twalkNodes(r.Value, f)\n\t\t\t}\n\t\t}\n\t}\n\n\t// Collect all trunks and leaves with reference metadata.\n\tvar trunks, leaves []*textWrap\n\twalkNodes(s, func(s textNode) {\n\t\tif s, ok := s.(*textWrap); ok {\n\t\t\tswitch s.Metadata.(type) {\n\t\t\tcase leafReference:\n\t\t\t\tleaves = append(leaves, s)\n\t\t\tcase trunkReference, trunkReferences:\n\t\t\t\ttrunks = append(trunks, s)\n\t\t\t}\n\t\t}\n\t})\n\n\t// No leaf references to resolve.\n\tif len(leaves) == 0 {\n\t\treturn\n\t}\n\n\t// Collect the set of all leaf references to resolve.\n\tleafPtrs := make(map[value.Pointer]bool)\n\tfor _, leaf := range leaves {\n\t\tleafPtrs[leaf.Metadata.(leafReference).p] = true\n\t}\n\n\t// Collect the set of trunk pointers that are always paired together.\n\t// This allows us to assign a single ID to both pointers for brevity.\n\t// If a pointer in a pair ever occurs by itself or as a different pair,\n\t// then the pair is broken.\n\tpairedTrunkPtrs := make(map[value.Pointer]value.Pointer)\n\tunpair := func(p value.Pointer) {\n\t\tif !pairedTrunkPtrs[p].IsNil() {\n\t\t\tpairedTrunkPtrs[pairedTrunkPtrs[p]] = value.Pointer{} // invalidate other half\n\t\t}\n\t\tpairedTrunkPtrs[p] = value.Pointer{} // invalidate this half\n\t}\n\tfor _, trunk := range trunks {\n\t\tswitch p := trunk.Metadata.(type) {\n\t\tcase trunkReference:\n\t\t\tunpair(p.p) // standalone pointer cannot be part of a pair\n\t\tcase trunkReferences:\n\t\t\tp0, ok0 := pairedTrunkPtrs[p.pp[0]]\n\t\t\tp1, ok1 := pairedTrunkPtrs[p.pp[1]]\n\t\t\tswitch {\n\t\t\tcase !ok0 && !ok1:\n\t\t\t\t// Register the newly seen pair.\n\t\t\t\tpairedTrunkPtrs[p.pp[0]] = p.pp[1]\n\t\t\t\tpairedTrunkPtrs[p.pp[1]] = p.pp[0]\n\t\t\tcase ok0 && ok1 && p0 == p.pp[1] && p1 == p.pp[0]:\n\t\t\t\t// Exact pair already seen; do nothing.\n\t\t\tdefault:\n\t\t\t\t// Pair conflicts with some other pair; break all pairs.\n\t\t\t\tunpair(p.pp[0])\n\t\t\t\tunpair(p.pp[1])\n\t\t\t}\n\t\t}\n\t}\n\n\t// Correlate each pointer referenced by leaves to a unique identifier,\n\t// and print the IDs for each trunk that matches those pointers.\n\tvar nextID uint\n\tptrIDs := make(map[value.Pointer]uint)\n\tnewID := func() uint {\n\t\tid := nextID\n\t\tnextID++\n\t\treturn id\n\t}\n\tfor _, trunk := range trunks {\n\t\tswitch p := trunk.Metadata.(type) {\n\t\tcase trunkReference:\n\t\t\tif print := leafPtrs[p.p]; print {\n\t\t\t\tid, ok := ptrIDs[p.p]\n\t\t\t\tif !ok {\n\t\t\t\t\tid = newID()\n\t\t\t\t\tptrIDs[p.p] = id\n\t\t\t\t}\n\t\t\t\ttrunk.Prefix = updateReferencePrefix(trunk.Prefix, formatReference(id))\n\t\t\t}\n\t\tcase trunkReferences:\n\t\t\tprint0 := leafPtrs[p.pp[0]]\n\t\t\tprint1 := leafPtrs[p.pp[1]]\n\t\t\tif print0 || print1 {\n\t\t\t\tid0, ok0 := ptrIDs[p.pp[0]]\n\t\t\t\tid1, ok1 := ptrIDs[p.pp[1]]\n\t\t\t\tisPair := pairedTrunkPtrs[p.pp[0]] == p.pp[1] && pairedTrunkPtrs[p.pp[1]] == p.pp[0]\n\t\t\t\tif isPair {\n\t\t\t\t\tvar id uint\n\t\t\t\t\tassert(ok0 == ok1) // must be seen together or not at all\n\t\t\t\t\tif ok0 {\n\t\t\t\t\t\tassert(id0 == id1) // must have the same ID\n\t\t\t\t\t\tid = id0\n\t\t\t\t\t} else {\n\t\t\t\t\t\tid = newID()\n\t\t\t\t\t\tptrIDs[p.pp[0]] = id\n\t\t\t\t\t\tptrIDs[p.pp[1]] = id\n\t\t\t\t\t}\n\t\t\t\t\ttrunk.Prefix = updateReferencePrefix(trunk.Prefix, formatReference(id))\n\t\t\t\t} else {\n\t\t\t\t\tif print0 && !ok0 {\n\t\t\t\t\t\tid0 = newID()\n\t\t\t\t\t\tptrIDs[p.pp[0]] = id0\n\t\t\t\t\t}\n\t\t\t\t\tif print1 && !ok1 {\n\t\t\t\t\t\tid1 = newID()\n\t\t\t\t\t\tptrIDs[p.pp[1]] = id1\n\t\t\t\t\t}\n\t\t\t\t\tswitch {\n\t\t\t\t\tcase print0 && print1:\n\t\t\t\t\t\ttrunk.Prefix = updateReferencePrefix(trunk.Prefix, formatReference(id0)+\",\"+formatReference(id1))\n\t\t\t\t\tcase print0:\n\t\t\t\t\t\ttrunk.Prefix = updateReferencePrefix(trunk.Prefix, formatReference(id0))\n\t\t\t\t\tcase print1:\n\t\t\t\t\t\ttrunk.Prefix = updateReferencePrefix(trunk.Prefix, formatReference(id1))\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Update all leaf references with the unique identifier.\n\tfor _, leaf := range leaves {\n\t\tif id, ok := ptrIDs[leaf.Metadata.(leafReference).p]; ok {\n\t\t\tleaf.Prefix = updateReferencePrefix(leaf.Prefix, formatReference(id))\n\t\t}\n\t}\n}\n\nfunc formatReference(id uint) string {\n\treturn fmt.Sprintf(\"ref#%d\", id)\n}\n\nfunc updateReferencePrefix(prefix, ref string) string {\n\tif prefix == \"\" {\n\t\treturn pointerDelimPrefix + ref + pointerDelimSuffix\n\t}\n\tsuffix := strings.TrimPrefix(prefix, pointerDelimPrefix)\n\treturn pointerDelimPrefix + ref + \": \" + suffix\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/report_reflect.go",
"content": "// Copyright 2019, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"reflect\"\n\t\"strconv\"\n\t\"strings\"\n\t\"unicode\"\n\t\"unicode/utf8\"\n\n\t\"github.com/google/go-cmp/cmp/internal/value\"\n)\n\nvar (\n\tanyType = reflect.TypeOf((*interface{})(nil)).Elem()\n\tstringType = reflect.TypeOf((*string)(nil)).Elem()\n\tbytesType = reflect.TypeOf((*[]byte)(nil)).Elem()\n\tbyteType = reflect.TypeOf((*byte)(nil)).Elem()\n)\n\ntype formatValueOptions struct {\n\t// AvoidStringer controls whether to avoid calling custom stringer\n\t// methods like error.Error or fmt.Stringer.String.\n\tAvoidStringer bool\n\n\t// PrintAddresses controls whether to print the address of all pointers,\n\t// slice elements, and maps.\n\tPrintAddresses bool\n\n\t// QualifiedNames controls whether FormatType uses the fully qualified name\n\t// (including the full package path as opposed to just the package name).\n\tQualifiedNames bool\n\n\t// VerbosityLevel controls the amount of output to produce.\n\t// A higher value produces more output. A value of zero or lower produces\n\t// no output (represented using an ellipsis).\n\t// If LimitVerbosity is false, then the level is treated as infinite.\n\tVerbosityLevel int\n\n\t// LimitVerbosity specifies that formatting should respect VerbosityLevel.\n\tLimitVerbosity bool\n}\n\n// FormatType prints the type as if it were wrapping s.\n// This may return s as-is depending on the current type and TypeMode mode.\nfunc (opts formatOptions) FormatType(t reflect.Type, s textNode) textNode {\n\t// Check whether to emit the type or not.\n\tswitch opts.TypeMode {\n\tcase autoType:\n\t\tswitch t.Kind() {\n\t\tcase reflect.Struct, reflect.Slice, reflect.Array, reflect.Map:\n\t\t\tif s.Equal(textNil) {\n\t\t\t\treturn s\n\t\t\t}\n\t\tdefault:\n\t\t\treturn s\n\t\t}\n\t\tif opts.DiffMode == diffIdentical {\n\t\t\treturn s // elide type for identical nodes\n\t\t}\n\tcase elideType:\n\t\treturn s\n\t}\n\n\t// Determine the type label, applying special handling for unnamed types.\n\ttypeName := value.TypeString(t, opts.QualifiedNames)\n\tif t.Name() == \"\" {\n\t\t// According to Go grammar, certain type literals contain symbols that\n\t\t// do not strongly bind to the next lexicographical token (e.g., *T).\n\t\tswitch t.Kind() {\n\t\tcase reflect.Chan, reflect.Func, reflect.Ptr:\n\t\t\ttypeName = \"(\" + typeName + \")\"\n\t\t}\n\t}\n\treturn &textWrap{Prefix: typeName, Value: wrapParens(s)}\n}\n\n// wrapParens wraps s with a set of parenthesis, but avoids it if the\n// wrapped node itself is already surrounded by a pair of parenthesis or braces.\n// It handles unwrapping one level of pointer-reference nodes.\nfunc wrapParens(s textNode) textNode {\n\tvar refNode *textWrap\n\tif s2, ok := s.(*textWrap); ok {\n\t\t// Unwrap a single pointer reference node.\n\t\tswitch s2.Metadata.(type) {\n\t\tcase leafReference, trunkReference, trunkReferences:\n\t\t\trefNode = s2\n\t\t\tif s3, ok := refNode.Value.(*textWrap); ok {\n\t\t\t\ts2 = s3\n\t\t\t}\n\t\t}\n\n\t\t// Already has delimiters that make parenthesis unnecessary.\n\t\thasParens := strings.HasPrefix(s2.Prefix, \"(\") && strings.HasSuffix(s2.Suffix, \")\")\n\t\thasBraces := strings.HasPrefix(s2.Prefix, \"{\") && strings.HasSuffix(s2.Suffix, \"}\")\n\t\tif hasParens || hasBraces {\n\t\t\treturn s\n\t\t}\n\t}\n\tif refNode != nil {\n\t\trefNode.Value = &textWrap{Prefix: \"(\", Value: refNode.Value, Suffix: \")\"}\n\t\treturn s\n\t}\n\treturn &textWrap{Prefix: \"(\", Value: s, Suffix: \")\"}\n}\n\n// FormatValue prints the reflect.Value, taking extra care to avoid descending\n// into pointers already in ptrs. As pointers are visited, ptrs is also updated.\nfunc (opts formatOptions) FormatValue(v reflect.Value, parentKind reflect.Kind, ptrs *pointerReferences) (out textNode) {\n\tif !v.IsValid() {\n\t\treturn nil\n\t}\n\tt := v.Type()\n\n\t// Check slice element for cycles.\n\tif parentKind == reflect.Slice {\n\t\tptrRef, visited := ptrs.Push(v.Addr())\n\t\tif visited {\n\t\t\treturn makeLeafReference(ptrRef, false)\n\t\t}\n\t\tdefer ptrs.Pop()\n\t\tdefer func() { out = wrapTrunkReference(ptrRef, false, out) }()\n\t}\n\n\t// Check whether there is an Error or String method to call.\n\tif !opts.AvoidStringer && v.CanInterface() {\n\t\t// Avoid calling Error or String methods on nil receivers since many\n\t\t// implementations crash when doing so.\n\t\tif (t.Kind() != reflect.Ptr && t.Kind() != reflect.Interface) || !v.IsNil() {\n\t\t\tvar prefix, strVal string\n\t\t\tfunc() {\n\t\t\t\t// Swallow and ignore any panics from String or Error.\n\t\t\t\tdefer func() { recover() }()\n\t\t\t\tswitch v := v.Interface().(type) {\n\t\t\t\tcase error:\n\t\t\t\t\tstrVal = v.Error()\n\t\t\t\t\tprefix = \"e\"\n\t\t\t\tcase fmt.Stringer:\n\t\t\t\t\tstrVal = v.String()\n\t\t\t\t\tprefix = \"s\"\n\t\t\t\t}\n\t\t\t}()\n\t\t\tif prefix != \"\" {\n\t\t\t\treturn opts.formatString(prefix, strVal)\n\t\t\t}\n\t\t}\n\t}\n\n\t// Check whether to explicitly wrap the result with the type.\n\tvar skipType bool\n\tdefer func() {\n\t\tif !skipType {\n\t\t\tout = opts.FormatType(t, out)\n\t\t}\n\t}()\n\n\tswitch t.Kind() {\n\tcase reflect.Bool:\n\t\treturn textLine(fmt.Sprint(v.Bool()))\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn textLine(fmt.Sprint(v.Int()))\n\tcase reflect.Uint, reflect.Uint16, reflect.Uint32, reflect.Uint64:\n\t\treturn textLine(fmt.Sprint(v.Uint()))\n\tcase reflect.Uint8:\n\t\tif parentKind == reflect.Slice || parentKind == reflect.Array {\n\t\t\treturn textLine(formatHex(v.Uint()))\n\t\t}\n\t\treturn textLine(fmt.Sprint(v.Uint()))\n\tcase reflect.Uintptr:\n\t\treturn textLine(formatHex(v.Uint()))\n\tcase reflect.Float32, reflect.Float64:\n\t\treturn textLine(fmt.Sprint(v.Float()))\n\tcase reflect.Complex64, reflect.Complex128:\n\t\treturn textLine(fmt.Sprint(v.Complex()))\n\tcase reflect.String:\n\t\treturn opts.formatString(\"\", v.String())\n\tcase reflect.UnsafePointer, reflect.Chan, reflect.Func:\n\t\treturn textLine(formatPointer(value.PointerOf(v), true))\n\tcase reflect.Struct:\n\t\tvar list textList\n\t\tv := makeAddressable(v) // needed for retrieveUnexportedField\n\t\tmaxLen := v.NumField()\n\t\tif opts.LimitVerbosity {\n\t\t\tmaxLen = ((1 << opts.verbosity()) >> 1) << 2 // 0, 4, 8, 16, 32, etc...\n\t\t\topts.VerbosityLevel--\n\t\t}\n\t\tfor i := 0; i < v.NumField(); i++ {\n\t\t\tvv := v.Field(i)\n\t\t\tif vv.IsZero() {\n\t\t\t\tcontinue // Elide fields with zero values\n\t\t\t}\n\t\t\tif len(list) == maxLen {\n\t\t\t\tlist.AppendEllipsis(diffStats{})\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tsf := t.Field(i)\n\t\t\tif !isExported(sf.Name) {\n\t\t\t\tvv = retrieveUnexportedField(v, sf, true)\n\t\t\t}\n\t\t\ts := opts.WithTypeMode(autoType).FormatValue(vv, t.Kind(), ptrs)\n\t\t\tlist = append(list, textRecord{Key: sf.Name, Value: s})\n\t\t}\n\t\treturn &textWrap{Prefix: \"{\", Value: list, Suffix: \"}\"}\n\tcase reflect.Slice:\n\t\tif v.IsNil() {\n\t\t\treturn textNil\n\t\t}\n\n\t\t// Check whether this is a []byte of text data.\n\t\tif t.Elem() == byteType {\n\t\t\tb := v.Bytes()\n\t\t\tisPrintSpace := func(r rune) bool { return unicode.IsPrint(r) || unicode.IsSpace(r) }\n\t\t\tif len(b) > 0 && utf8.Valid(b) && len(bytes.TrimFunc(b, isPrintSpace)) == 0 {\n\t\t\t\tout = opts.formatString(\"\", string(b))\n\t\t\t\tskipType = true\n\t\t\t\treturn opts.FormatType(t, out)\n\t\t\t}\n\t\t}\n\n\t\tfallthrough\n\tcase reflect.Array:\n\t\tmaxLen := v.Len()\n\t\tif opts.LimitVerbosity {\n\t\t\tmaxLen = ((1 << opts.verbosity()) >> 1) << 2 // 0, 4, 8, 16, 32, etc...\n\t\t\topts.VerbosityLevel--\n\t\t}\n\t\tvar list textList\n\t\tfor i := 0; i < v.Len(); i++ {\n\t\t\tif len(list) == maxLen {\n\t\t\t\tlist.AppendEllipsis(diffStats{})\n\t\t\t\tbreak\n\t\t\t}\n\t\t\ts := opts.WithTypeMode(elideType).FormatValue(v.Index(i), t.Kind(), ptrs)\n\t\t\tlist = append(list, textRecord{Value: s})\n\t\t}\n\n\t\tout = &textWrap{Prefix: \"{\", Value: list, Suffix: \"}\"}\n\t\tif t.Kind() == reflect.Slice && opts.PrintAddresses {\n\t\t\theader := fmt.Sprintf(\"ptr:%v, len:%d, cap:%d\", formatPointer(value.PointerOf(v), false), v.Len(), v.Cap())\n\t\t\tout = &textWrap{Prefix: pointerDelimPrefix + header + pointerDelimSuffix, Value: out}\n\t\t}\n\t\treturn out\n\tcase reflect.Map:\n\t\tif v.IsNil() {\n\t\t\treturn textNil\n\t\t}\n\n\t\t// Check pointer for cycles.\n\t\tptrRef, visited := ptrs.Push(v)\n\t\tif visited {\n\t\t\treturn makeLeafReference(ptrRef, opts.PrintAddresses)\n\t\t}\n\t\tdefer ptrs.Pop()\n\n\t\tmaxLen := v.Len()\n\t\tif opts.LimitVerbosity {\n\t\t\tmaxLen = ((1 << opts.verbosity()) >> 1) << 2 // 0, 4, 8, 16, 32, etc...\n\t\t\topts.VerbosityLevel--\n\t\t}\n\t\tvar list textList\n\t\tfor _, k := range value.SortKeys(v.MapKeys()) {\n\t\t\tif len(list) == maxLen {\n\t\t\t\tlist.AppendEllipsis(diffStats{})\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tsk := formatMapKey(k, false, ptrs)\n\t\t\tsv := opts.WithTypeMode(elideType).FormatValue(v.MapIndex(k), t.Kind(), ptrs)\n\t\t\tlist = append(list, textRecord{Key: sk, Value: sv})\n\t\t}\n\n\t\tout = &textWrap{Prefix: \"{\", Value: list, Suffix: \"}\"}\n\t\tout = wrapTrunkReference(ptrRef, opts.PrintAddresses, out)\n\t\treturn out\n\tcase reflect.Ptr:\n\t\tif v.IsNil() {\n\t\t\treturn textNil\n\t\t}\n\n\t\t// Check pointer for cycles.\n\t\tptrRef, visited := ptrs.Push(v)\n\t\tif visited {\n\t\t\tout = makeLeafReference(ptrRef, opts.PrintAddresses)\n\t\t\treturn &textWrap{Prefix: \"&\", Value: out}\n\t\t}\n\t\tdefer ptrs.Pop()\n\n\t\t// Skip the name only if this is an unnamed pointer type.\n\t\t// Otherwise taking the address of a value does not reproduce\n\t\t// the named pointer type.\n\t\tif v.Type().Name() == \"\" {\n\t\t\tskipType = true // Let the underlying value print the type instead\n\t\t}\n\t\tout = opts.FormatValue(v.Elem(), t.Kind(), ptrs)\n\t\tout = wrapTrunkReference(ptrRef, opts.PrintAddresses, out)\n\t\tout = &textWrap{Prefix: \"&\", Value: out}\n\t\treturn out\n\tcase reflect.Interface:\n\t\tif v.IsNil() {\n\t\t\treturn textNil\n\t\t}\n\t\t// Interfaces accept different concrete types,\n\t\t// so configure the underlying value to explicitly print the type.\n\t\treturn opts.WithTypeMode(emitType).FormatValue(v.Elem(), t.Kind(), ptrs)\n\tdefault:\n\t\tpanic(fmt.Sprintf(\"%v kind not handled\", v.Kind()))\n\t}\n}\n\nfunc (opts formatOptions) formatString(prefix, s string) textNode {\n\tmaxLen := len(s)\n\tmaxLines := strings.Count(s, \"\\n\") + 1\n\tif opts.LimitVerbosity {\n\t\tmaxLen = (1 << opts.verbosity()) << 5 // 32, 64, 128, 256, etc...\n\t\tmaxLines = (1 << opts.verbosity()) << 2 // 4, 8, 16, 32, 64, etc...\n\t}\n\n\t// For multiline strings, use the triple-quote syntax,\n\t// but only use it when printing removed or inserted nodes since\n\t// we only want the extra verbosity for those cases.\n\tlines := strings.Split(strings.TrimSuffix(s, \"\\n\"), \"\\n\")\n\tisTripleQuoted := len(lines) >= 4 && (opts.DiffMode == '-' || opts.DiffMode == '+')\n\tfor i := 0; i < len(lines) && isTripleQuoted; i++ {\n\t\tlines[i] = strings.TrimPrefix(strings.TrimSuffix(lines[i], \"\\r\"), \"\\r\") // trim leading/trailing carriage returns for legacy Windows endline support\n\t\tisPrintable := func(r rune) bool {\n\t\t\treturn unicode.IsPrint(r) || r == '\\t' // specially treat tab as printable\n\t\t}\n\t\tline := lines[i]\n\t\tisTripleQuoted = !strings.HasPrefix(strings.TrimPrefix(line, prefix), `\"\"\"`) && !strings.HasPrefix(line, \"...\") && strings.TrimFunc(line, isPrintable) == \"\" && len(line) <= maxLen\n\t}\n\tif isTripleQuoted {\n\t\tvar list textList\n\t\tlist = append(list, textRecord{Diff: opts.DiffMode, Value: textLine(prefix + `\"\"\"`), ElideComma: true})\n\t\tfor i, line := range lines {\n\t\t\tif numElided := len(lines) - i; i == maxLines-1 && numElided > 1 {\n\t\t\t\tcomment := commentString(fmt.Sprintf(\"%d elided lines\", numElided))\n\t\t\t\tlist = append(list, textRecord{Diff: opts.DiffMode, Value: textEllipsis, ElideComma: true, Comment: comment})\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tlist = append(list, textRecord{Diff: opts.DiffMode, Value: textLine(line), ElideComma: true})\n\t\t}\n\t\tlist = append(list, textRecord{Diff: opts.DiffMode, Value: textLine(prefix + `\"\"\"`), ElideComma: true})\n\t\treturn &textWrap{Prefix: \"(\", Value: list, Suffix: \")\"}\n\t}\n\n\t// Format the string as a single-line quoted string.\n\tif len(s) > maxLen+len(textEllipsis) {\n\t\treturn textLine(prefix + formatString(s[:maxLen]) + string(textEllipsis))\n\t}\n\treturn textLine(prefix + formatString(s))\n}\n\n// formatMapKey formats v as if it were a map key.\n// The result is guaranteed to be a single line.\nfunc formatMapKey(v reflect.Value, disambiguate bool, ptrs *pointerReferences) string {\n\tvar opts formatOptions\n\topts.DiffMode = diffIdentical\n\topts.TypeMode = elideType\n\topts.PrintAddresses = disambiguate\n\topts.AvoidStringer = disambiguate\n\topts.QualifiedNames = disambiguate\n\topts.VerbosityLevel = maxVerbosityPreset\n\topts.LimitVerbosity = true\n\ts := opts.FormatValue(v, reflect.Map, ptrs).String()\n\treturn strings.TrimSpace(s)\n}\n\n// formatString prints s as a double-quoted or backtick-quoted string.\nfunc formatString(s string) string {\n\t// Use quoted string if it the same length as a raw string literal.\n\t// Otherwise, attempt to use the raw string form.\n\tqs := strconv.Quote(s)\n\tif len(qs) == 1+len(s)+1 {\n\t\treturn qs\n\t}\n\n\t// Disallow newlines to ensure output is a single line.\n\t// Only allow printable runes for readability purposes.\n\trawInvalid := func(r rune) bool {\n\t\treturn r == '`' || r == '\\n' || !(unicode.IsPrint(r) || r == '\\t')\n\t}\n\tif utf8.ValidString(s) && strings.IndexFunc(s, rawInvalid) < 0 {\n\t\treturn \"`\" + s + \"`\"\n\t}\n\treturn qs\n}\n\n// formatHex prints u as a hexadecimal integer in Go notation.\nfunc formatHex(u uint64) string {\n\tvar f string\n\tswitch {\n\tcase u <= 0xff:\n\t\tf = \"0x%02x\"\n\tcase u <= 0xffff:\n\t\tf = \"0x%04x\"\n\tcase u <= 0xffffff:\n\t\tf = \"0x%06x\"\n\tcase u <= 0xffffffff:\n\t\tf = \"0x%08x\"\n\tcase u <= 0xffffffffff:\n\t\tf = \"0x%010x\"\n\tcase u <= 0xffffffffffff:\n\t\tf = \"0x%012x\"\n\tcase u <= 0xffffffffffffff:\n\t\tf = \"0x%014x\"\n\tcase u <= 0xffffffffffffffff:\n\t\tf = \"0x%016x\"\n\t}\n\treturn fmt.Sprintf(f, u)\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/report_slices.go",
"content": "// Copyright 2019, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"math\"\n\t\"reflect\"\n\t\"strconv\"\n\t\"strings\"\n\t\"unicode\"\n\t\"unicode/utf8\"\n\n\t\"github.com/google/go-cmp/cmp/internal/diff\"\n)\n\n// CanFormatDiffSlice reports whether we support custom formatting for nodes\n// that are slices of primitive kinds or strings.\nfunc (opts formatOptions) CanFormatDiffSlice(v *valueNode) bool {\n\tswitch {\n\tcase opts.DiffMode != diffUnknown:\n\t\treturn false // Must be formatting in diff mode\n\tcase v.NumDiff == 0:\n\t\treturn false // No differences detected\n\tcase !v.ValueX.IsValid() || !v.ValueY.IsValid():\n\t\treturn false // Both values must be valid\n\tcase v.NumIgnored > 0:\n\t\treturn false // Some ignore option was used\n\tcase v.NumTransformed > 0:\n\t\treturn false // Some transform option was used\n\tcase v.NumCompared > 1:\n\t\treturn false // More than one comparison was used\n\tcase v.NumCompared == 1 && v.Type.Name() != \"\":\n\t\t// The need for cmp to check applicability of options on every element\n\t\t// in a slice is a significant performance detriment for large []byte.\n\t\t// The workaround is to specify Comparer(bytes.Equal),\n\t\t// which enables cmp to compare []byte more efficiently.\n\t\t// If they differ, we still want to provide batched diffing.\n\t\t// The logic disallows named types since they tend to have their own\n\t\t// String method, with nicer formatting than what this provides.\n\t\treturn false\n\t}\n\n\t// Check whether this is an interface with the same concrete types.\n\tt := v.Type\n\tvx, vy := v.ValueX, v.ValueY\n\tif t.Kind() == reflect.Interface && !vx.IsNil() && !vy.IsNil() && vx.Elem().Type() == vy.Elem().Type() {\n\t\tvx, vy = vx.Elem(), vy.Elem()\n\t\tt = vx.Type()\n\t}\n\n\t// Check whether we provide specialized diffing for this type.\n\tswitch t.Kind() {\n\tcase reflect.String:\n\tcase reflect.Array, reflect.Slice:\n\t\t// Only slices of primitive types have specialized handling.\n\t\tswitch t.Elem().Kind() {\n\t\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64,\n\t\t\treflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr,\n\t\t\treflect.Bool, reflect.Float32, reflect.Float64, reflect.Complex64, reflect.Complex128:\n\t\tdefault:\n\t\t\treturn false\n\t\t}\n\n\t\t// Both slice values have to be non-empty.\n\t\tif t.Kind() == reflect.Slice && (vx.Len() == 0 || vy.Len() == 0) {\n\t\t\treturn false\n\t\t}\n\n\t\t// If a sufficient number of elements already differ,\n\t\t// use specialized formatting even if length requirement is not met.\n\t\tif v.NumDiff > v.NumSame {\n\t\t\treturn true\n\t\t}\n\tdefault:\n\t\treturn false\n\t}\n\n\t// Use specialized string diffing for longer slices or strings.\n\tconst minLength = 32\n\treturn vx.Len() >= minLength && vy.Len() >= minLength\n}\n\n// FormatDiffSlice prints a diff for the slices (or strings) represented by v.\n// This provides custom-tailored logic to make printing of differences in\n// textual strings and slices of primitive kinds more readable.\nfunc (opts formatOptions) FormatDiffSlice(v *valueNode) textNode {\n\tassert(opts.DiffMode == diffUnknown)\n\tt, vx, vy := v.Type, v.ValueX, v.ValueY\n\tif t.Kind() == reflect.Interface {\n\t\tvx, vy = vx.Elem(), vy.Elem()\n\t\tt = vx.Type()\n\t\topts = opts.WithTypeMode(emitType)\n\t}\n\n\t// Auto-detect the type of the data.\n\tvar sx, sy string\n\tvar ssx, ssy []string\n\tvar isString, isMostlyText, isPureLinedText, isBinary bool\n\tswitch {\n\tcase t.Kind() == reflect.String:\n\t\tsx, sy = vx.String(), vy.String()\n\t\tisString = true\n\tcase t.Kind() == reflect.Slice && t.Elem() == byteType:\n\t\tsx, sy = string(vx.Bytes()), string(vy.Bytes())\n\t\tisString = true\n\tcase t.Kind() == reflect.Array:\n\t\t// Arrays need to be addressable for slice operations to work.\n\t\tvx2, vy2 := reflect.New(t).Elem(), reflect.New(t).Elem()\n\t\tvx2.Set(vx)\n\t\tvy2.Set(vy)\n\t\tvx, vy = vx2, vy2\n\t}\n\tif isString {\n\t\tvar numTotalRunes, numValidRunes, numLines, lastLineIdx, maxLineLen int\n\t\tfor i, r := range sx + sy {\n\t\t\tnumTotalRunes++\n\t\t\tif (unicode.IsPrint(r) || unicode.IsSpace(r)) && r != utf8.RuneError {\n\t\t\t\tnumValidRunes++\n\t\t\t}\n\t\t\tif r == '\\n' {\n\t\t\t\tif maxLineLen < i-lastLineIdx {\n\t\t\t\t\tmaxLineLen = i - lastLineIdx\n\t\t\t\t}\n\t\t\t\tlastLineIdx = i + 1\n\t\t\t\tnumLines++\n\t\t\t}\n\t\t}\n\t\tisPureText := numValidRunes == numTotalRunes\n\t\tisMostlyText = float64(numValidRunes) > math.Floor(0.90*float64(numTotalRunes))\n\t\tisPureLinedText = isPureText && numLines >= 4 && maxLineLen <= 1024\n\t\tisBinary = !isMostlyText\n\n\t\t// Avoid diffing by lines if it produces a significantly more complex\n\t\t// edit script than diffing by bytes.\n\t\tif isPureLinedText {\n\t\t\tssx = strings.Split(sx, \"\\n\")\n\t\t\tssy = strings.Split(sy, \"\\n\")\n\t\t\tesLines := diff.Difference(len(ssx), len(ssy), func(ix, iy int) diff.Result {\n\t\t\t\treturn diff.BoolResult(ssx[ix] == ssy[iy])\n\t\t\t})\n\t\t\tesBytes := diff.Difference(len(sx), len(sy), func(ix, iy int) diff.Result {\n\t\t\t\treturn diff.BoolResult(sx[ix] == sy[iy])\n\t\t\t})\n\t\t\tefficiencyLines := float64(esLines.Dist()) / float64(len(esLines))\n\t\t\tefficiencyBytes := float64(esBytes.Dist()) / float64(len(esBytes))\n\t\t\tquotedLength := len(strconv.Quote(sx + sy))\n\t\t\tunquotedLength := len(sx) + len(sy)\n\t\t\tescapeExpansionRatio := float64(quotedLength) / float64(unquotedLength)\n\t\t\tisPureLinedText = efficiencyLines < 4*efficiencyBytes || escapeExpansionRatio > 1.1\n\t\t}\n\t}\n\n\t// Format the string into printable records.\n\tvar list textList\n\tvar delim string\n\tswitch {\n\t// If the text appears to be multi-lined text,\n\t// then perform differencing across individual lines.\n\tcase isPureLinedText:\n\t\tlist = opts.formatDiffSlice(\n\t\t\treflect.ValueOf(ssx), reflect.ValueOf(ssy), 1, \"line\",\n\t\t\tfunc(v reflect.Value, d diffMode) textRecord {\n\t\t\t\ts := formatString(v.Index(0).String())\n\t\t\t\treturn textRecord{Diff: d, Value: textLine(s)}\n\t\t\t},\n\t\t)\n\t\tdelim = \"\\n\"\n\n\t\t// If possible, use a custom triple-quote (\"\"\") syntax for printing\n\t\t// differences in a string literal. This format is more readable,\n\t\t// but has edge-cases where differences are visually indistinguishable.\n\t\t// This format is avoided under the following conditions:\n\t\t// - A line starts with `\"\"\"`\n\t\t// - A line starts with \"...\"\n\t\t// - A line contains non-printable characters\n\t\t// - Adjacent different lines differ only by whitespace\n\t\t//\n\t\t// For example:\n\t\t//\n\t\t//\t\t\"\"\"\n\t\t//\t\t... // 3 identical lines\n\t\t//\t\tfoo\n\t\t//\t\tbar\n\t\t//\t-\tbaz\n\t\t//\t+\tBAZ\n\t\t//\t\t\"\"\"\n\t\tisTripleQuoted := true\n\t\tprevRemoveLines := map[string]bool{}\n\t\tprevInsertLines := map[string]bool{}\n\t\tvar list2 textList\n\t\tlist2 = append(list2, textRecord{Value: textLine(`\"\"\"`), ElideComma: true})\n\t\tfor _, r := range list {\n\t\t\tif !r.Value.Equal(textEllipsis) {\n\t\t\t\tline, _ := strconv.Unquote(string(r.Value.(textLine)))\n\t\t\t\tline = strings.TrimPrefix(strings.TrimSuffix(line, \"\\r\"), \"\\r\") // trim leading/trailing carriage returns for legacy Windows endline support\n\t\t\t\tnormLine := strings.Map(func(r rune) rune {\n\t\t\t\t\tif unicode.IsSpace(r) {\n\t\t\t\t\t\treturn -1 // drop whitespace to avoid visually indistinguishable output\n\t\t\t\t\t}\n\t\t\t\t\treturn r\n\t\t\t\t}, line)\n\t\t\t\tisPrintable := func(r rune) bool {\n\t\t\t\t\treturn unicode.IsPrint(r) || r == '\\t' // specially treat tab as printable\n\t\t\t\t}\n\t\t\t\tisTripleQuoted = !strings.HasPrefix(line, `\"\"\"`) && !strings.HasPrefix(line, \"...\") && strings.TrimFunc(line, isPrintable) == \"\"\n\t\t\t\tswitch r.Diff {\n\t\t\t\tcase diffRemoved:\n\t\t\t\t\tisTripleQuoted = isTripleQuoted && !prevInsertLines[normLine]\n\t\t\t\t\tprevRemoveLines[normLine] = true\n\t\t\t\tcase diffInserted:\n\t\t\t\t\tisTripleQuoted = isTripleQuoted && !prevRemoveLines[normLine]\n\t\t\t\t\tprevInsertLines[normLine] = true\n\t\t\t\t}\n\t\t\t\tif !isTripleQuoted {\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tr.Value = textLine(line)\n\t\t\t\tr.ElideComma = true\n\t\t\t}\n\t\t\tif !(r.Diff == diffRemoved || r.Diff == diffInserted) { // start a new non-adjacent difference group\n\t\t\t\tprevRemoveLines = map[string]bool{}\n\t\t\t\tprevInsertLines = map[string]bool{}\n\t\t\t}\n\t\t\tlist2 = append(list2, r)\n\t\t}\n\t\tif r := list2[len(list2)-1]; r.Diff == diffIdentical && len(r.Value.(textLine)) == 0 {\n\t\t\tlist2 = list2[:len(list2)-1] // elide single empty line at the end\n\t\t}\n\t\tlist2 = append(list2, textRecord{Value: textLine(`\"\"\"`), ElideComma: true})\n\t\tif isTripleQuoted {\n\t\t\tvar out textNode = &textWrap{Prefix: \"(\", Value: list2, Suffix: \")\"}\n\t\t\tswitch t.Kind() {\n\t\t\tcase reflect.String:\n\t\t\t\tif t != stringType {\n\t\t\t\t\tout = opts.FormatType(t, out)\n\t\t\t\t}\n\t\t\tcase reflect.Slice:\n\t\t\t\t// Always emit type for slices since the triple-quote syntax\n\t\t\t\t// looks like a string (not a slice).\n\t\t\t\topts = opts.WithTypeMode(emitType)\n\t\t\t\tout = opts.FormatType(t, out)\n\t\t\t}\n\t\t\treturn out\n\t\t}\n\n\t// If the text appears to be single-lined text,\n\t// then perform differencing in approximately fixed-sized chunks.\n\t// The output is printed as quoted strings.\n\tcase isMostlyText:\n\t\tlist = opts.formatDiffSlice(\n\t\t\treflect.ValueOf(sx), reflect.ValueOf(sy), 64, \"byte\",\n\t\t\tfunc(v reflect.Value, d diffMode) textRecord {\n\t\t\t\ts := formatString(v.String())\n\t\t\t\treturn textRecord{Diff: d, Value: textLine(s)}\n\t\t\t},\n\t\t)\n\n\t// If the text appears to be binary data,\n\t// then perform differencing in approximately fixed-sized chunks.\n\t// The output is inspired by hexdump.\n\tcase isBinary:\n\t\tlist = opts.formatDiffSlice(\n\t\t\treflect.ValueOf(sx), reflect.ValueOf(sy), 16, \"byte\",\n\t\t\tfunc(v reflect.Value, d diffMode) textRecord {\n\t\t\t\tvar ss []string\n\t\t\t\tfor i := 0; i < v.Len(); i++ {\n\t\t\t\t\tss = append(ss, formatHex(v.Index(i).Uint()))\n\t\t\t\t}\n\t\t\t\ts := strings.Join(ss, \", \")\n\t\t\t\tcomment := commentString(fmt.Sprintf(\"%c|%v|\", d, formatASCII(v.String())))\n\t\t\t\treturn textRecord{Diff: d, Value: textLine(s), Comment: comment}\n\t\t\t},\n\t\t)\n\n\t// For all other slices of primitive types,\n\t// then perform differencing in approximately fixed-sized chunks.\n\t// The size of each chunk depends on the width of the element kind.\n\tdefault:\n\t\tvar chunkSize int\n\t\tif t.Elem().Kind() == reflect.Bool {\n\t\t\tchunkSize = 16\n\t\t} else {\n\t\t\tswitch t.Elem().Bits() {\n\t\t\tcase 8:\n\t\t\t\tchunkSize = 16\n\t\t\tcase 16:\n\t\t\t\tchunkSize = 12\n\t\t\tcase 32:\n\t\t\t\tchunkSize = 8\n\t\t\tdefault:\n\t\t\t\tchunkSize = 8\n\t\t\t}\n\t\t}\n\t\tlist = opts.formatDiffSlice(\n\t\t\tvx, vy, chunkSize, t.Elem().Kind().String(),\n\t\t\tfunc(v reflect.Value, d diffMode) textRecord {\n\t\t\t\tvar ss []string\n\t\t\t\tfor i := 0; i < v.Len(); i++ {\n\t\t\t\t\tswitch t.Elem().Kind() {\n\t\t\t\t\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\t\t\t\t\tss = append(ss, fmt.Sprint(v.Index(i).Int()))\n\t\t\t\t\tcase reflect.Uint, reflect.Uint16, reflect.Uint32, reflect.Uint64:\n\t\t\t\t\t\tss = append(ss, fmt.Sprint(v.Index(i).Uint()))\n\t\t\t\t\tcase reflect.Uint8, reflect.Uintptr:\n\t\t\t\t\t\tss = append(ss, formatHex(v.Index(i).Uint()))\n\t\t\t\t\tcase reflect.Bool, reflect.Float32, reflect.Float64, reflect.Complex64, reflect.Complex128:\n\t\t\t\t\t\tss = append(ss, fmt.Sprint(v.Index(i).Interface()))\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\ts := strings.Join(ss, \", \")\n\t\t\t\treturn textRecord{Diff: d, Value: textLine(s)}\n\t\t\t},\n\t\t)\n\t}\n\n\t// Wrap the output with appropriate type information.\n\tvar out textNode = &textWrap{Prefix: \"{\", Value: list, Suffix: \"}\"}\n\tif !isMostlyText {\n\t\t// The \"{...}\" byte-sequence literal is not valid Go syntax for strings.\n\t\t// Emit the type for extra clarity (e.g. \"string{...}\").\n\t\tif t.Kind() == reflect.String {\n\t\t\topts = opts.WithTypeMode(emitType)\n\t\t}\n\t\treturn opts.FormatType(t, out)\n\t}\n\tswitch t.Kind() {\n\tcase reflect.String:\n\t\tout = &textWrap{Prefix: \"strings.Join(\", Value: out, Suffix: fmt.Sprintf(\", %q)\", delim)}\n\t\tif t != stringType {\n\t\t\tout = opts.FormatType(t, out)\n\t\t}\n\tcase reflect.Slice:\n\t\tout = &textWrap{Prefix: \"bytes.Join(\", Value: out, Suffix: fmt.Sprintf(\", %q)\", delim)}\n\t\tif t != bytesType {\n\t\t\tout = opts.FormatType(t, out)\n\t\t}\n\t}\n\treturn out\n}\n\n// formatASCII formats s as an ASCII string.\n// This is useful for printing binary strings in a semi-legible way.\nfunc formatASCII(s string) string {\n\tb := bytes.Repeat([]byte{'.'}, len(s))\n\tfor i := 0; i < len(s); i++ {\n\t\tif ' ' <= s[i] && s[i] <= '~' {\n\t\t\tb[i] = s[i]\n\t\t}\n\t}\n\treturn string(b)\n}\n\nfunc (opts formatOptions) formatDiffSlice(\n\tvx, vy reflect.Value, chunkSize int, name string,\n\tmakeRec func(reflect.Value, diffMode) textRecord,\n) (list textList) {\n\teq := func(ix, iy int) bool {\n\t\treturn vx.Index(ix).Interface() == vy.Index(iy).Interface()\n\t}\n\tes := diff.Difference(vx.Len(), vy.Len(), func(ix, iy int) diff.Result {\n\t\treturn diff.BoolResult(eq(ix, iy))\n\t})\n\n\tappendChunks := func(v reflect.Value, d diffMode) int {\n\t\tn0 := v.Len()\n\t\tfor v.Len() > 0 {\n\t\t\tn := chunkSize\n\t\t\tif n > v.Len() {\n\t\t\t\tn = v.Len()\n\t\t\t}\n\t\t\tlist = append(list, makeRec(v.Slice(0, n), d))\n\t\t\tv = v.Slice(n, v.Len())\n\t\t}\n\t\treturn n0 - v.Len()\n\t}\n\n\tvar numDiffs int\n\tmaxLen := -1\n\tif opts.LimitVerbosity {\n\t\tmaxLen = (1 << opts.verbosity()) << 2 // 4, 8, 16, 32, 64, etc...\n\t\topts.VerbosityLevel--\n\t}\n\n\tgroups := coalesceAdjacentEdits(name, es)\n\tgroups = coalesceInterveningIdentical(groups, chunkSize/4)\n\tgroups = cleanupSurroundingIdentical(groups, eq)\n\tmaxGroup := diffStats{Name: name}\n\tfor i, ds := range groups {\n\t\tif maxLen >= 0 && numDiffs >= maxLen {\n\t\t\tmaxGroup = maxGroup.Append(ds)\n\t\t\tcontinue\n\t\t}\n\n\t\t// Print equal.\n\t\tif ds.NumDiff() == 0 {\n\t\t\t// Compute the number of leading and trailing equal bytes to print.\n\t\t\tvar numLo, numHi int\n\t\t\tnumEqual := ds.NumIgnored + ds.NumIdentical\n\t\t\tfor numLo < chunkSize*numContextRecords && numLo+numHi < numEqual && i != 0 {\n\t\t\t\tnumLo++\n\t\t\t}\n\t\t\tfor numHi < chunkSize*numContextRecords && numLo+numHi < numEqual && i != len(groups)-1 {\n\t\t\t\tnumHi++\n\t\t\t}\n\t\t\tif numEqual-(numLo+numHi) <= chunkSize && ds.NumIgnored == 0 {\n\t\t\t\tnumHi = numEqual - numLo // Avoid pointless coalescing of single equal row\n\t\t\t}\n\n\t\t\t// Print the equal bytes.\n\t\t\tappendChunks(vx.Slice(0, numLo), diffIdentical)\n\t\t\tif numEqual > numLo+numHi {\n\t\t\t\tds.NumIdentical -= numLo + numHi\n\t\t\t\tlist.AppendEllipsis(ds)\n\t\t\t}\n\t\t\tappendChunks(vx.Slice(numEqual-numHi, numEqual), diffIdentical)\n\t\t\tvx = vx.Slice(numEqual, vx.Len())\n\t\t\tvy = vy.Slice(numEqual, vy.Len())\n\t\t\tcontinue\n\t\t}\n\n\t\t// Print unequal.\n\t\tlen0 := len(list)\n\t\tnx := appendChunks(vx.Slice(0, ds.NumIdentical+ds.NumRemoved+ds.NumModified), diffRemoved)\n\t\tvx = vx.Slice(nx, vx.Len())\n\t\tny := appendChunks(vy.Slice(0, ds.NumIdentical+ds.NumInserted+ds.NumModified), diffInserted)\n\t\tvy = vy.Slice(ny, vy.Len())\n\t\tnumDiffs += len(list) - len0\n\t}\n\tif maxGroup.IsZero() {\n\t\tassert(vx.Len() == 0 && vy.Len() == 0)\n\t} else {\n\t\tlist.AppendEllipsis(maxGroup)\n\t}\n\treturn list\n}\n\n// coalesceAdjacentEdits coalesces the list of edits into groups of adjacent\n// equal or unequal counts.\n//\n// Example:\n//\n//\tInput: \"..XXY...Y\"\n//\tOutput: [\n//\t\t{NumIdentical: 2},\n//\t\t{NumRemoved: 2, NumInserted 1},\n//\t\t{NumIdentical: 3},\n//\t\t{NumInserted: 1},\n//\t]\nfunc coalesceAdjacentEdits(name string, es diff.EditScript) (groups []diffStats) {\n\tvar prevMode byte\n\tlastStats := func(mode byte) *diffStats {\n\t\tif prevMode != mode {\n\t\t\tgroups = append(groups, diffStats{Name: name})\n\t\t\tprevMode = mode\n\t\t}\n\t\treturn &groups[len(groups)-1]\n\t}\n\tfor _, e := range es {\n\t\tswitch e {\n\t\tcase diff.Identity:\n\t\t\tlastStats('=').NumIdentical++\n\t\tcase diff.UniqueX:\n\t\t\tlastStats('!').NumRemoved++\n\t\tcase diff.UniqueY:\n\t\t\tlastStats('!').NumInserted++\n\t\tcase diff.Modified:\n\t\t\tlastStats('!').NumModified++\n\t\t}\n\t}\n\treturn groups\n}\n\n// coalesceInterveningIdentical coalesces sufficiently short (<= windowSize)\n// equal groups into adjacent unequal groups that currently result in a\n// dual inserted/removed printout. This acts as a high-pass filter to smooth\n// out high-frequency changes within the windowSize.\n//\n// Example:\n//\n//\tWindowSize: 16,\n//\tInput: [\n//\t\t{NumIdentical: 61}, // group 0\n//\t\t{NumRemoved: 3, NumInserted: 1}, // group 1\n//\t\t{NumIdentical: 6}, // ├── coalesce\n//\t\t{NumInserted: 2}, // ├── coalesce\n//\t\t{NumIdentical: 1}, // ├── coalesce\n//\t\t{NumRemoved: 9}, // └── coalesce\n//\t\t{NumIdentical: 64}, // group 2\n//\t\t{NumRemoved: 3, NumInserted: 1}, // group 3\n//\t\t{NumIdentical: 6}, // ├── coalesce\n//\t\t{NumInserted: 2}, // ├── coalesce\n//\t\t{NumIdentical: 1}, // ├── coalesce\n//\t\t{NumRemoved: 7}, // ├── coalesce\n//\t\t{NumIdentical: 1}, // ├── coalesce\n//\t\t{NumRemoved: 2}, // └── coalesce\n//\t\t{NumIdentical: 63}, // group 4\n//\t]\n//\tOutput: [\n//\t\t{NumIdentical: 61},\n//\t\t{NumIdentical: 7, NumRemoved: 12, NumInserted: 3},\n//\t\t{NumIdentical: 64},\n//\t\t{NumIdentical: 8, NumRemoved: 12, NumInserted: 3},\n//\t\t{NumIdentical: 63},\n//\t]\nfunc coalesceInterveningIdentical(groups []diffStats, windowSize int) []diffStats {\n\tgroups, groupsOrig := groups[:0], groups\n\tfor i, ds := range groupsOrig {\n\t\tif len(groups) >= 2 && ds.NumDiff() > 0 {\n\t\t\tprev := &groups[len(groups)-2] // Unequal group\n\t\t\tcurr := &groups[len(groups)-1] // Equal group\n\t\t\tnext := &groupsOrig[i] // Unequal group\n\t\t\thadX, hadY := prev.NumRemoved > 0, prev.NumInserted > 0\n\t\t\thasX, hasY := next.NumRemoved > 0, next.NumInserted > 0\n\t\t\tif ((hadX || hasX) && (hadY || hasY)) && curr.NumIdentical <= windowSize {\n\t\t\t\t*prev = prev.Append(*curr).Append(*next)\n\t\t\t\tgroups = groups[:len(groups)-1] // Truncate off equal group\n\t\t\t\tcontinue\n\t\t\t}\n\t\t}\n\t\tgroups = append(groups, ds)\n\t}\n\treturn groups\n}\n\n// cleanupSurroundingIdentical scans through all unequal groups, and\n// moves any leading sequence of equal elements to the preceding equal group and\n// moves and trailing sequence of equal elements to the succeeding equal group.\n//\n// This is necessary since coalesceInterveningIdentical may coalesce edit groups\n// together such that leading/trailing spans of equal elements becomes possible.\n// Note that this can occur even with an optimal diffing algorithm.\n//\n// Example:\n//\n//\tInput: [\n//\t\t{NumIdentical: 61},\n//\t\t{NumIdentical: 1 , NumRemoved: 11, NumInserted: 2}, // assume 3 leading identical elements\n//\t\t{NumIdentical: 67},\n//\t\t{NumIdentical: 7, NumRemoved: 12, NumInserted: 3}, // assume 10 trailing identical elements\n//\t\t{NumIdentical: 54},\n//\t]\n//\tOutput: [\n//\t\t{NumIdentical: 64}, // incremented by 3\n//\t\t{NumRemoved: 9},\n//\t\t{NumIdentical: 67},\n//\t\t{NumRemoved: 9},\n//\t\t{NumIdentical: 64}, // incremented by 10\n//\t]\nfunc cleanupSurroundingIdentical(groups []diffStats, eq func(i, j int) bool) []diffStats {\n\tvar ix, iy int // indexes into sequence x and y\n\tfor i, ds := range groups {\n\t\t// Handle equal group.\n\t\tif ds.NumDiff() == 0 {\n\t\t\tix += ds.NumIdentical\n\t\t\tiy += ds.NumIdentical\n\t\t\tcontinue\n\t\t}\n\n\t\t// Handle unequal group.\n\t\tnx := ds.NumIdentical + ds.NumRemoved + ds.NumModified\n\t\tny := ds.NumIdentical + ds.NumInserted + ds.NumModified\n\t\tvar numLeadingIdentical, numTrailingIdentical int\n\t\tfor j := 0; j < nx && j < ny && eq(ix+j, iy+j); j++ {\n\t\t\tnumLeadingIdentical++\n\t\t}\n\t\tfor j := 0; j < nx && j < ny && eq(ix+nx-1-j, iy+ny-1-j); j++ {\n\t\t\tnumTrailingIdentical++\n\t\t}\n\t\tif numIdentical := numLeadingIdentical + numTrailingIdentical; numIdentical > 0 {\n\t\t\tif numLeadingIdentical > 0 {\n\t\t\t\t// Remove leading identical span from this group and\n\t\t\t\t// insert it into the preceding group.\n\t\t\t\tif i-1 >= 0 {\n\t\t\t\t\tgroups[i-1].NumIdentical += numLeadingIdentical\n\t\t\t\t} else {\n\t\t\t\t\t// No preceding group exists, so prepend a new group,\n\t\t\t\t\t// but do so after we finish iterating over all groups.\n\t\t\t\t\tdefer func() {\n\t\t\t\t\t\tgroups = append([]diffStats{{Name: groups[0].Name, NumIdentical: numLeadingIdentical}}, groups...)\n\t\t\t\t\t}()\n\t\t\t\t}\n\t\t\t\t// Increment indexes since the preceding group would have handled this.\n\t\t\t\tix += numLeadingIdentical\n\t\t\t\tiy += numLeadingIdentical\n\t\t\t}\n\t\t\tif numTrailingIdentical > 0 {\n\t\t\t\t// Remove trailing identical span from this group and\n\t\t\t\t// insert it into the succeeding group.\n\t\t\t\tif i+1 < len(groups) {\n\t\t\t\t\tgroups[i+1].NumIdentical += numTrailingIdentical\n\t\t\t\t} else {\n\t\t\t\t\t// No succeeding group exists, so append a new group,\n\t\t\t\t\t// but do so after we finish iterating over all groups.\n\t\t\t\t\tdefer func() {\n\t\t\t\t\t\tgroups = append(groups, diffStats{Name: groups[len(groups)-1].Name, NumIdentical: numTrailingIdentical})\n\t\t\t\t\t}()\n\t\t\t\t}\n\t\t\t\t// Do not increment indexes since the succeeding group will handle this.\n\t\t\t}\n\n\t\t\t// Update this group since some identical elements were removed.\n\t\t\tnx -= numIdentical\n\t\t\tny -= numIdentical\n\t\t\tgroups[i] = diffStats{Name: ds.Name, NumRemoved: nx, NumInserted: ny}\n\t\t}\n\t\tix += nx\n\t\tiy += ny\n\t}\n\treturn groups\n}\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/report_text.go",
"content": "// Copyright 2019, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"math/rand\"\n\t\"strings\"\n\t\"time\"\n\t\"unicode/utf8\"\n\n\t\"github.com/google/go-cmp/cmp/internal/flags\"\n)\n\nvar randBool = rand.New(rand.NewSource(time.Now().Unix())).Intn(2) == 0\n\nconst maxColumnLength = 80\n\ntype indentMode int\n\nfunc (n indentMode) appendIndent(b []byte, d diffMode) []byte {\n\t// The output of Diff is documented as being unstable to provide future\n\t// flexibility in changing the output for more humanly readable reports.\n\t// This logic intentionally introduces instability to the exact output\n\t// so that users can detect accidental reliance on stability early on,\n\t// rather than much later when an actual change to the format occurs.\n\tif flags.Deterministic || randBool {\n\t\t// Use regular spaces (U+0020).\n\t\tswitch d {\n\t\tcase diffUnknown, diffIdentical:\n\t\t\tb = append(b, \" \"...)\n\t\tcase diffRemoved:\n\t\t\tb = append(b, \"- \"...)\n\t\tcase diffInserted:\n\t\t\tb = append(b, \"+ \"...)\n\t\t}\n\t} else {\n\t\t// Use non-breaking spaces (U+00a0).\n\t\tswitch d {\n\t\tcase diffUnknown, diffIdentical:\n\t\t\tb = append(b, \" \"...)\n\t\tcase diffRemoved:\n\t\t\tb = append(b, \"- \"...)\n\t\tcase diffInserted:\n\t\t\tb = append(b, \"+ \"...)\n\t\t}\n\t}\n\treturn repeatCount(n).appendChar(b, '\\t')\n}\n\ntype repeatCount int\n\nfunc (n repeatCount) appendChar(b []byte, c byte) []byte {\n\tfor ; n > 0; n-- {\n\t\tb = append(b, c)\n\t}\n\treturn b\n}\n\n// textNode is a simplified tree-based representation of structured text.\n// Possible node types are textWrap, textList, or textLine.\ntype textNode interface {\n\t// Len reports the length in bytes of a single-line version of the tree.\n\t// Nested textRecord.Diff and textRecord.Comment fields are ignored.\n\tLen() int\n\t// Equal reports whether the two trees are structurally identical.\n\t// Nested textRecord.Diff and textRecord.Comment fields are compared.\n\tEqual(textNode) bool\n\t// String returns the string representation of the text tree.\n\t// It is not guaranteed that len(x.String()) == x.Len(),\n\t// nor that x.String() == y.String() implies that x.Equal(y).\n\tString() string\n\n\t// formatCompactTo formats the contents of the tree as a single-line string\n\t// to the provided buffer. Any nested textRecord.Diff and textRecord.Comment\n\t// fields are ignored.\n\t//\n\t// However, not all nodes in the tree should be collapsed as a single-line.\n\t// If a node can be collapsed as a single-line, it is replaced by a textLine\n\t// node. Since the top-level node cannot replace itself, this also returns\n\t// the current node itself.\n\t//\n\t// This does not mutate the receiver.\n\tformatCompactTo([]byte, diffMode) ([]byte, textNode)\n\t// formatExpandedTo formats the contents of the tree as a multi-line string\n\t// to the provided buffer. In order for column alignment to operate well,\n\t// formatCompactTo must be called before calling formatExpandedTo.\n\tformatExpandedTo([]byte, diffMode, indentMode) []byte\n}\n\n// textWrap is a wrapper that concatenates a prefix and/or a suffix\n// to the underlying node.\ntype textWrap struct {\n\tPrefix string // e.g., \"bytes.Buffer{\"\n\tValue textNode // textWrap | textList | textLine\n\tSuffix string // e.g., \"}\"\n\tMetadata interface{} // arbitrary metadata; has no effect on formatting\n}\n\nfunc (s *textWrap) Len() int {\n\treturn len(s.Prefix) + s.Value.Len() + len(s.Suffix)\n}\nfunc (s1 *textWrap) Equal(s2 textNode) bool {\n\tif s2, ok := s2.(*textWrap); ok {\n\t\treturn s1.Prefix == s2.Prefix && s1.Value.Equal(s2.Value) && s1.Suffix == s2.Suffix\n\t}\n\treturn false\n}\nfunc (s *textWrap) String() string {\n\tvar d diffMode\n\tvar n indentMode\n\t_, s2 := s.formatCompactTo(nil, d)\n\tb := n.appendIndent(nil, d) // Leading indent\n\tb = s2.formatExpandedTo(b, d, n) // Main body\n\tb = append(b, '\\n') // Trailing newline\n\treturn string(b)\n}\nfunc (s *textWrap) formatCompactTo(b []byte, d diffMode) ([]byte, textNode) {\n\tn0 := len(b) // Original buffer length\n\tb = append(b, s.Prefix...)\n\tb, s.Value = s.Value.formatCompactTo(b, d)\n\tb = append(b, s.Suffix...)\n\tif _, ok := s.Value.(textLine); ok {\n\t\treturn b, textLine(b[n0:])\n\t}\n\treturn b, s\n}\nfunc (s *textWrap) formatExpandedTo(b []byte, d diffMode, n indentMode) []byte {\n\tb = append(b, s.Prefix...)\n\tb = s.Value.formatExpandedTo(b, d, n)\n\tb = append(b, s.Suffix...)\n\treturn b\n}\n\n// textList is a comma-separated list of textWrap or textLine nodes.\n// The list may be formatted as multi-lines or single-line at the discretion\n// of the textList.formatCompactTo method.\ntype textList []textRecord\ntype textRecord struct {\n\tDiff diffMode // e.g., 0 or '-' or '+'\n\tKey string // e.g., \"MyField\"\n\tValue textNode // textWrap | textLine\n\tElideComma bool // avoid trailing comma\n\tComment fmt.Stringer // e.g., \"6 identical fields\"\n}\n\n// AppendEllipsis appends a new ellipsis node to the list if none already\n// exists at the end. If cs is non-zero it coalesces the statistics with the\n// previous diffStats.\nfunc (s *textList) AppendEllipsis(ds diffStats) {\n\thasStats := !ds.IsZero()\n\tif len(*s) == 0 || !(*s)[len(*s)-1].Value.Equal(textEllipsis) {\n\t\tif hasStats {\n\t\t\t*s = append(*s, textRecord{Value: textEllipsis, ElideComma: true, Comment: ds})\n\t\t} else {\n\t\t\t*s = append(*s, textRecord{Value: textEllipsis, ElideComma: true})\n\t\t}\n\t\treturn\n\t}\n\tif hasStats {\n\t\t(*s)[len(*s)-1].Comment = (*s)[len(*s)-1].Comment.(diffStats).Append(ds)\n\t}\n}\n\nfunc (s textList) Len() (n int) {\n\tfor i, r := range s {\n\t\tn += len(r.Key)\n\t\tif r.Key != \"\" {\n\t\t\tn += len(\": \")\n\t\t}\n\t\tn += r.Value.Len()\n\t\tif i < len(s)-1 {\n\t\t\tn += len(\", \")\n\t\t}\n\t}\n\treturn n\n}\n\nfunc (s1 textList) Equal(s2 textNode) bool {\n\tif s2, ok := s2.(textList); ok {\n\t\tif len(s1) != len(s2) {\n\t\t\treturn false\n\t\t}\n\t\tfor i := range s1 {\n\t\t\tr1, r2 := s1[i], s2[i]\n\t\t\tif !(r1.Diff == r2.Diff && r1.Key == r2.Key && r1.Value.Equal(r2.Value) && r1.Comment == r2.Comment) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\treturn true\n\t}\n\treturn false\n}\n\nfunc (s textList) String() string {\n\treturn (&textWrap{Prefix: \"{\", Value: s, Suffix: \"}\"}).String()\n}\n\nfunc (s textList) formatCompactTo(b []byte, d diffMode) ([]byte, textNode) {\n\ts = append(textList(nil), s...) // Avoid mutating original\n\n\t// Determine whether we can collapse this list as a single line.\n\tn0 := len(b) // Original buffer length\n\tvar multiLine bool\n\tfor i, r := range s {\n\t\tif r.Diff == diffInserted || r.Diff == diffRemoved {\n\t\t\tmultiLine = true\n\t\t}\n\t\tb = append(b, r.Key...)\n\t\tif r.Key != \"\" {\n\t\t\tb = append(b, \": \"...)\n\t\t}\n\t\tb, s[i].Value = r.Value.formatCompactTo(b, d|r.Diff)\n\t\tif _, ok := s[i].Value.(textLine); !ok {\n\t\t\tmultiLine = true\n\t\t}\n\t\tif r.Comment != nil {\n\t\t\tmultiLine = true\n\t\t}\n\t\tif i < len(s)-1 {\n\t\t\tb = append(b, \", \"...)\n\t\t}\n\t}\n\t// Force multi-lined output when printing a removed/inserted node that\n\t// is sufficiently long.\n\tif (d == diffInserted || d == diffRemoved) && len(b[n0:]) > maxColumnLength {\n\t\tmultiLine = true\n\t}\n\tif !multiLine {\n\t\treturn b, textLine(b[n0:])\n\t}\n\treturn b, s\n}\n\nfunc (s textList) formatExpandedTo(b []byte, d diffMode, n indentMode) []byte {\n\talignKeyLens := s.alignLens(\n\t\tfunc(r textRecord) bool {\n\t\t\t_, isLine := r.Value.(textLine)\n\t\t\treturn r.Key == \"\" || !isLine\n\t\t},\n\t\tfunc(r textRecord) int { return utf8.RuneCountInString(r.Key) },\n\t)\n\talignValueLens := s.alignLens(\n\t\tfunc(r textRecord) bool {\n\t\t\t_, isLine := r.Value.(textLine)\n\t\t\treturn !isLine || r.Value.Equal(textEllipsis) || r.Comment == nil\n\t\t},\n\t\tfunc(r textRecord) int { return utf8.RuneCount(r.Value.(textLine)) },\n\t)\n\n\t// Format lists of simple lists in a batched form.\n\t// If the list is sequence of only textLine values,\n\t// then batch multiple values on a single line.\n\tvar isSimple bool\n\tfor _, r := range s {\n\t\t_, isLine := r.Value.(textLine)\n\t\tisSimple = r.Diff == 0 && r.Key == \"\" && isLine && r.Comment == nil\n\t\tif !isSimple {\n\t\t\tbreak\n\t\t}\n\t}\n\tif isSimple {\n\t\tn++\n\t\tvar batch []byte\n\t\temitBatch := func() {\n\t\t\tif len(batch) > 0 {\n\t\t\t\tb = n.appendIndent(append(b, '\\n'), d)\n\t\t\t\tb = append(b, bytes.TrimRight(batch, \" \")...)\n\t\t\t\tbatch = batch[:0]\n\t\t\t}\n\t\t}\n\t\tfor _, r := range s {\n\t\t\tline := r.Value.(textLine)\n\t\t\tif len(batch)+len(line)+len(\", \") > maxColumnLength {\n\t\t\t\temitBatch()\n\t\t\t}\n\t\t\tbatch = append(batch, line...)\n\t\t\tbatch = append(batch, \", \"...)\n\t\t}\n\t\temitBatch()\n\t\tn--\n\t\treturn n.appendIndent(append(b, '\\n'), d)\n\t}\n\n\t// Format the list as a multi-lined output.\n\tn++\n\tfor i, r := range s {\n\t\tb = n.appendIndent(append(b, '\\n'), d|r.Diff)\n\t\tif r.Key != \"\" {\n\t\t\tb = append(b, r.Key+\": \"...)\n\t\t}\n\t\tb = alignKeyLens[i].appendChar(b, ' ')\n\n\t\tb = r.Value.formatExpandedTo(b, d|r.Diff, n)\n\t\tif !r.ElideComma {\n\t\t\tb = append(b, ',')\n\t\t}\n\t\tb = alignValueLens[i].appendChar(b, ' ')\n\n\t\tif r.Comment != nil {\n\t\t\tb = append(b, \" // \"+r.Comment.String()...)\n\t\t}\n\t}\n\tn--\n\n\treturn n.appendIndent(append(b, '\\n'), d)\n}\n\nfunc (s textList) alignLens(\n\tskipFunc func(textRecord) bool,\n\tlenFunc func(textRecord) int,\n) []repeatCount {\n\tvar startIdx, endIdx, maxLen int\n\tlens := make([]repeatCount, len(s))\n\tfor i, r := range s {\n\t\tif skipFunc(r) {\n\t\t\tfor j := startIdx; j < endIdx && j < len(s); j++ {\n\t\t\t\tlens[j] = repeatCount(maxLen - lenFunc(s[j]))\n\t\t\t}\n\t\t\tstartIdx, endIdx, maxLen = i+1, i+1, 0\n\t\t} else {\n\t\t\tif maxLen < lenFunc(r) {\n\t\t\t\tmaxLen = lenFunc(r)\n\t\t\t}\n\t\t\tendIdx = i + 1\n\t\t}\n\t}\n\tfor j := startIdx; j < endIdx && j < len(s); j++ {\n\t\tlens[j] = repeatCount(maxLen - lenFunc(s[j]))\n\t}\n\treturn lens\n}\n\n// textLine is a single-line segment of text and is always a leaf node\n// in the textNode tree.\ntype textLine []byte\n\nvar (\n\ttextNil = textLine(\"nil\")\n\ttextEllipsis = textLine(\"...\")\n)\n\nfunc (s textLine) Len() int {\n\treturn len(s)\n}\nfunc (s1 textLine) Equal(s2 textNode) bool {\n\tif s2, ok := s2.(textLine); ok {\n\t\treturn bytes.Equal([]byte(s1), []byte(s2))\n\t}\n\treturn false\n}\nfunc (s textLine) String() string {\n\treturn string(s)\n}\nfunc (s textLine) formatCompactTo(b []byte, d diffMode) ([]byte, textNode) {\n\treturn append(b, s...), s\n}\nfunc (s textLine) formatExpandedTo(b []byte, _ diffMode, _ indentMode) []byte {\n\treturn append(b, s...)\n}\n\ntype diffStats struct {\n\tName string\n\tNumIgnored int\n\tNumIdentical int\n\tNumRemoved int\n\tNumInserted int\n\tNumModified int\n}\n\nfunc (s diffStats) IsZero() bool {\n\ts.Name = \"\"\n\treturn s == diffStats{}\n}\n\nfunc (s diffStats) NumDiff() int {\n\treturn s.NumRemoved + s.NumInserted + s.NumModified\n}\n\nfunc (s diffStats) Append(ds diffStats) diffStats {\n\tassert(s.Name == ds.Name)\n\ts.NumIgnored += ds.NumIgnored\n\ts.NumIdentical += ds.NumIdentical\n\ts.NumRemoved += ds.NumRemoved\n\ts.NumInserted += ds.NumInserted\n\ts.NumModified += ds.NumModified\n\treturn s\n}\n\n// String prints a humanly-readable summary of coalesced records.\n//\n// Example:\n//\n//\tdiffStats{Name: \"Field\", NumIgnored: 5}.String() => \"5 ignored fields\"\nfunc (s diffStats) String() string {\n\tvar ss []string\n\tvar sum int\n\tlabels := [...]string{\"ignored\", \"identical\", \"removed\", \"inserted\", \"modified\"}\n\tcounts := [...]int{s.NumIgnored, s.NumIdentical, s.NumRemoved, s.NumInserted, s.NumModified}\n\tfor i, n := range counts {\n\t\tif n > 0 {\n\t\t\tss = append(ss, fmt.Sprintf(\"%d %v\", n, labels[i]))\n\t\t}\n\t\tsum += n\n\t}\n\n\t// Pluralize the name (adjusting for some obscure English grammar rules).\n\tname := s.Name\n\tif sum > 1 {\n\t\tname += \"s\"\n\t\tif strings.HasSuffix(name, \"ys\") {\n\t\t\tname = name[:len(name)-2] + \"ies\" // e.g., \"entrys\" => \"entries\"\n\t\t}\n\t}\n\n\t// Format the list according to English grammar (with Oxford comma).\n\tswitch n := len(ss); n {\n\tcase 0:\n\t\treturn \"\"\n\tcase 1, 2:\n\t\treturn strings.Join(ss, \" and \") + \" \" + name\n\tdefault:\n\t\treturn strings.Join(ss[:n-1], \", \") + \", and \" + ss[n-1] + \" \" + name\n\t}\n}\n\ntype commentString string\n\nfunc (s commentString) String() string { return string(s) }\n"
},
{
"path": "tests/vendor/github.com/google/go-cmp/cmp/report_value.go",
"content": "// Copyright 2019, The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage cmp\n\nimport \"reflect\"\n\n// valueNode represents a single node within a report, which is a\n// structured representation of the value tree, containing information\n// regarding which nodes are equal or not.\ntype valueNode struct {\n\tparent *valueNode\n\n\tType reflect.Type\n\tValueX reflect.Value\n\tValueY reflect.Value\n\n\t// NumSame is the number of leaf nodes that are equal.\n\t// All descendants are equal only if NumDiff is 0.\n\tNumSame int\n\t// NumDiff is the number of leaf nodes that are not equal.\n\tNumDiff int\n\t// NumIgnored is the number of leaf nodes that are ignored.\n\tNumIgnored int\n\t// NumCompared is the number of leaf nodes that were compared\n\t// using an Equal method or Comparer function.\n\tNumCompared int\n\t// NumTransformed is the number of non-leaf nodes that were transformed.\n\tNumTransformed int\n\t// NumChildren is the number of transitive descendants of this node.\n\t// This counts from zero; thus, leaf nodes have no descendants.\n\tNumChildren int\n\t// MaxDepth is the maximum depth of the tree. This counts from zero;\n\t// thus, leaf nodes have a depth of zero.\n\tMaxDepth int\n\n\t// Records is a list of struct fields, slice elements, or map entries.\n\tRecords []reportRecord // If populated, implies Value is not populated\n\n\t// Value is the result of a transformation, pointer indirect, of\n\t// type assertion.\n\tValue *valueNode // If populated, implies Records is not populated\n\n\t// TransformerName is the name of the transformer.\n\tTransformerName string // If non-empty, implies Value is populated\n}\ntype reportRecord struct {\n\tKey reflect.Value // Invalid for slice element\n\tValue *valueNode\n}\n\nfunc (parent *valueNode) PushStep(ps PathStep) (child *valueNode) {\n\tvx, vy := ps.Values()\n\tchild = &valueNode{parent: parent, Type: ps.Type(), ValueX: vx, ValueY: vy}\n\tswitch s := ps.(type) {\n\tcase StructField:\n\t\tassert(parent.Value == nil)\n\t\tparent.Records = append(parent.Records, reportRecord{Key: reflect.ValueOf(s.Name()), Value: child})\n\tcase SliceIndex:\n\t\tassert(parent.Value == nil)\n\t\tparent.Records = append(parent.Records, reportRecord{Value: child})\n\tcase MapIndex:\n\t\tassert(parent.Value == nil)\n\t\tparent.Records = append(parent.Records, reportRecord{Key: s.Key(), Value: child})\n\tcase Indirect:\n\t\tassert(parent.Value == nil && parent.Records == nil)\n\t\tparent.Value = child\n\tcase TypeAssertion:\n\t\tassert(parent.Value == nil && parent.Records == nil)\n\t\tparent.Value = child\n\tcase Transform:\n\t\tassert(parent.Value == nil && parent.Records == nil)\n\t\tparent.Value = child\n\t\tparent.TransformerName = s.Name()\n\t\tparent.NumTransformed++\n\tdefault:\n\t\tassert(parent == nil) // Must be the root step\n\t}\n\treturn child\n}\n\nfunc (r *valueNode) Report(rs Result) {\n\tassert(r.MaxDepth == 0) // May only be called on leaf nodes\n\n\tif rs.ByIgnore() {\n\t\tr.NumIgnored++\n\t} else {\n\t\tif rs.Equal() {\n\t\t\tr.NumSame++\n\t\t} else {\n\t\t\tr.NumDiff++\n\t\t}\n\t}\n\tassert(r.NumSame+r.NumDiff+r.NumIgnored == 1)\n\n\tif rs.ByMethod() {\n\t\tr.NumCompared++\n\t}\n\tif rs.ByFunc() {\n\t\tr.NumCompared++\n\t}\n\tassert(r.NumCompared <= 1)\n}\n\nfunc (child *valueNode) PopStep() (parent *valueNode) {\n\tif child.parent == nil {\n\t\treturn nil\n\t}\n\tparent = child.parent\n\tparent.NumSame += child.NumSame\n\tparent.NumDiff += child.NumDiff\n\tparent.NumIgnored += child.NumIgnored\n\tparent.NumCompared += child.NumCompared\n\tparent.NumTransformed += child.NumTransformed\n\tparent.NumChildren += child.NumChildren + 1\n\tif parent.MaxDepth < child.MaxDepth+1 {\n\t\tparent.MaxDepth = child.MaxDepth + 1\n\t}\n\treturn parent\n}\n"
},
{
"path": "tests/vendor/github.com/google/pprof/AUTHORS",
"content": "# This is the official list of pprof authors for copyright purposes.\n# This file is distinct from the CONTRIBUTORS files.\n# See the latter for an explanation.\n# Names should be added to this file as:\n# Name or Organization \n# The email address is not required for organizations.\nGoogle Inc."
},
{
"path": "tests/vendor/github.com/google/pprof/CONTRIBUTORS",
"content": "# People who have agreed to one of the CLAs and can contribute patches.\n# The AUTHORS file lists the copyright holders; this file\n# lists people. For example, Google employees are listed here\n# but not in AUTHORS, because Google holds the copyright.\n#\n# https://developers.google.com/open-source/cla/individual\n# https://developers.google.com/open-source/cla/corporate\n#\n# Names should be added to this file as:\n# Name \nRaul Silvera \nTipp Moseley \nHyoun Kyu Cho \nMartin Spier \nTaco de Wolff \nAndrew Hunter \n"
},
{
"path": "tests/vendor/github.com/google/pprof/LICENSE",
"content": "\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/encode.go",
"content": "// Copyright 2014 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage profile\n\nimport (\n\t\"errors\"\n\t\"sort\"\n\t\"strings\"\n)\n\nfunc (p *Profile) decoder() []decoder {\n\treturn profileDecoder\n}\n\n// preEncode populates the unexported fields to be used by encode\n// (with suffix X) from the corresponding exported fields. The\n// exported fields are cleared up to facilitate testing.\nfunc (p *Profile) preEncode() {\n\tstrings := make(map[string]int)\n\taddString(strings, \"\")\n\n\tfor _, st := range p.SampleType {\n\t\tst.typeX = addString(strings, st.Type)\n\t\tst.unitX = addString(strings, st.Unit)\n\t}\n\n\tfor _, s := range p.Sample {\n\t\ts.labelX = nil\n\t\tvar keys []string\n\t\tfor k := range s.Label {\n\t\t\tkeys = append(keys, k)\n\t\t}\n\t\tsort.Strings(keys)\n\t\tfor _, k := range keys {\n\t\t\tvs := s.Label[k]\n\t\t\tfor _, v := range vs {\n\t\t\t\ts.labelX = append(s.labelX,\n\t\t\t\t\tlabel{\n\t\t\t\t\t\tkeyX: addString(strings, k),\n\t\t\t\t\t\tstrX: addString(strings, v),\n\t\t\t\t\t},\n\t\t\t\t)\n\t\t\t}\n\t\t}\n\t\tvar numKeys []string\n\t\tfor k := range s.NumLabel {\n\t\t\tnumKeys = append(numKeys, k)\n\t\t}\n\t\tsort.Strings(numKeys)\n\t\tfor _, k := range numKeys {\n\t\t\tkeyX := addString(strings, k)\n\t\t\tvs := s.NumLabel[k]\n\t\t\tunits := s.NumUnit[k]\n\t\t\tfor i, v := range vs {\n\t\t\t\tvar unitX int64\n\t\t\t\tif len(units) != 0 {\n\t\t\t\t\tunitX = addString(strings, units[i])\n\t\t\t\t}\n\t\t\t\ts.labelX = append(s.labelX,\n\t\t\t\t\tlabel{\n\t\t\t\t\t\tkeyX: keyX,\n\t\t\t\t\t\tnumX: v,\n\t\t\t\t\t\tunitX: unitX,\n\t\t\t\t\t},\n\t\t\t\t)\n\t\t\t}\n\t\t}\n\t\ts.locationIDX = make([]uint64, len(s.Location))\n\t\tfor i, loc := range s.Location {\n\t\t\ts.locationIDX[i] = loc.ID\n\t\t}\n\t}\n\n\tfor _, m := range p.Mapping {\n\t\tm.fileX = addString(strings, m.File)\n\t\tm.buildIDX = addString(strings, m.BuildID)\n\t}\n\n\tfor _, l := range p.Location {\n\t\tfor i, ln := range l.Line {\n\t\t\tif ln.Function != nil {\n\t\t\t\tl.Line[i].functionIDX = ln.Function.ID\n\t\t\t} else {\n\t\t\t\tl.Line[i].functionIDX = 0\n\t\t\t}\n\t\t}\n\t\tif l.Mapping != nil {\n\t\t\tl.mappingIDX = l.Mapping.ID\n\t\t} else {\n\t\t\tl.mappingIDX = 0\n\t\t}\n\t}\n\tfor _, f := range p.Function {\n\t\tf.nameX = addString(strings, f.Name)\n\t\tf.systemNameX = addString(strings, f.SystemName)\n\t\tf.filenameX = addString(strings, f.Filename)\n\t}\n\n\tp.dropFramesX = addString(strings, p.DropFrames)\n\tp.keepFramesX = addString(strings, p.KeepFrames)\n\n\tif pt := p.PeriodType; pt != nil {\n\t\tpt.typeX = addString(strings, pt.Type)\n\t\tpt.unitX = addString(strings, pt.Unit)\n\t}\n\n\tp.commentX = nil\n\tfor _, c := range p.Comments {\n\t\tp.commentX = append(p.commentX, addString(strings, c))\n\t}\n\n\tp.defaultSampleTypeX = addString(strings, p.DefaultSampleType)\n\tp.docURLX = addString(strings, p.DocURL)\n\n\tp.stringTable = make([]string, len(strings))\n\tfor s, i := range strings {\n\t\tp.stringTable[i] = s\n\t}\n}\n\nfunc (p *Profile) encode(b *buffer) {\n\tfor _, x := range p.SampleType {\n\t\tencodeMessage(b, 1, x)\n\t}\n\tfor _, x := range p.Sample {\n\t\tencodeMessage(b, 2, x)\n\t}\n\tfor _, x := range p.Mapping {\n\t\tencodeMessage(b, 3, x)\n\t}\n\tfor _, x := range p.Location {\n\t\tencodeMessage(b, 4, x)\n\t}\n\tfor _, x := range p.Function {\n\t\tencodeMessage(b, 5, x)\n\t}\n\tencodeStrings(b, 6, p.stringTable)\n\tencodeInt64Opt(b, 7, p.dropFramesX)\n\tencodeInt64Opt(b, 8, p.keepFramesX)\n\tencodeInt64Opt(b, 9, p.TimeNanos)\n\tencodeInt64Opt(b, 10, p.DurationNanos)\n\tif pt := p.PeriodType; pt != nil && (pt.typeX != 0 || pt.unitX != 0) {\n\t\tencodeMessage(b, 11, p.PeriodType)\n\t}\n\tencodeInt64Opt(b, 12, p.Period)\n\tencodeInt64s(b, 13, p.commentX)\n\tencodeInt64(b, 14, p.defaultSampleTypeX)\n\tencodeInt64Opt(b, 15, p.docURLX)\n}\n\nvar profileDecoder = []decoder{\n\tnil, // 0\n\t// repeated ValueType sample_type = 1\n\tfunc(b *buffer, m message) error {\n\t\tx := new(ValueType)\n\t\tpp := m.(*Profile)\n\t\tpp.SampleType = append(pp.SampleType, x)\n\t\treturn decodeMessage(b, x)\n\t},\n\t// repeated Sample sample = 2\n\tfunc(b *buffer, m message) error {\n\t\tx := new(Sample)\n\t\tpp := m.(*Profile)\n\t\tpp.Sample = append(pp.Sample, x)\n\t\treturn decodeMessage(b, x)\n\t},\n\t// repeated Mapping mapping = 3\n\tfunc(b *buffer, m message) error {\n\t\tx := new(Mapping)\n\t\tpp := m.(*Profile)\n\t\tpp.Mapping = append(pp.Mapping, x)\n\t\treturn decodeMessage(b, x)\n\t},\n\t// repeated Location location = 4\n\tfunc(b *buffer, m message) error {\n\t\tx := new(Location)\n\t\tx.Line = b.tmpLines[:0] // Use shared space temporarily\n\t\tpp := m.(*Profile)\n\t\tpp.Location = append(pp.Location, x)\n\t\terr := decodeMessage(b, x)\n\t\tb.tmpLines = x.Line[:0]\n\t\t// Copy to shrink size and detach from shared space.\n\t\tx.Line = append([]Line(nil), x.Line...)\n\t\treturn err\n\t},\n\t// repeated Function function = 5\n\tfunc(b *buffer, m message) error {\n\t\tx := new(Function)\n\t\tpp := m.(*Profile)\n\t\tpp.Function = append(pp.Function, x)\n\t\treturn decodeMessage(b, x)\n\t},\n\t// repeated string string_table = 6\n\tfunc(b *buffer, m message) error {\n\t\terr := decodeStrings(b, &m.(*Profile).stringTable)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif m.(*Profile).stringTable[0] != \"\" {\n\t\t\treturn errors.New(\"string_table[0] must be ''\")\n\t\t}\n\t\treturn nil\n\t},\n\t// int64 drop_frames = 7\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Profile).dropFramesX) },\n\t// int64 keep_frames = 8\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Profile).keepFramesX) },\n\t// int64 time_nanos = 9\n\tfunc(b *buffer, m message) error {\n\t\tif m.(*Profile).TimeNanos != 0 {\n\t\t\treturn errConcatProfile\n\t\t}\n\t\treturn decodeInt64(b, &m.(*Profile).TimeNanos)\n\t},\n\t// int64 duration_nanos = 10\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Profile).DurationNanos) },\n\t// ValueType period_type = 11\n\tfunc(b *buffer, m message) error {\n\t\tx := new(ValueType)\n\t\tpp := m.(*Profile)\n\t\tpp.PeriodType = x\n\t\treturn decodeMessage(b, x)\n\t},\n\t// int64 period = 12\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Profile).Period) },\n\t// repeated int64 comment = 13\n\tfunc(b *buffer, m message) error { return decodeInt64s(b, &m.(*Profile).commentX) },\n\t// int64 defaultSampleType = 14\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Profile).defaultSampleTypeX) },\n\t// string doc_link = 15;\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Profile).docURLX) },\n}\n\n// postDecode takes the unexported fields populated by decode (with\n// suffix X) and populates the corresponding exported fields.\n// The unexported fields are cleared up to facilitate testing.\nfunc (p *Profile) postDecode() error {\n\tvar err error\n\tmappings := make(map[uint64]*Mapping, len(p.Mapping))\n\tmappingIds := make([]*Mapping, len(p.Mapping)+1)\n\tfor _, m := range p.Mapping {\n\t\tm.File, err = getString(p.stringTable, &m.fileX, err)\n\t\tm.BuildID, err = getString(p.stringTable, &m.buildIDX, err)\n\t\tif m.ID < uint64(len(mappingIds)) {\n\t\t\tmappingIds[m.ID] = m\n\t\t} else {\n\t\t\tmappings[m.ID] = m\n\t\t}\n\n\t\t// If this a main linux kernel mapping with a relocation symbol suffix\n\t\t// (\"[kernel.kallsyms]_text\"), extract said suffix.\n\t\t// It is fairly hacky to handle at this level, but the alternatives appear even worse.\n\t\tconst prefix = \"[kernel.kallsyms]\"\n\t\tif strings.HasPrefix(m.File, prefix) {\n\t\t\tm.KernelRelocationSymbol = m.File[len(prefix):]\n\t\t}\n\t}\n\n\tfunctions := make(map[uint64]*Function, len(p.Function))\n\tfunctionIds := make([]*Function, len(p.Function)+1)\n\tfor _, f := range p.Function {\n\t\tf.Name, err = getString(p.stringTable, &f.nameX, err)\n\t\tf.SystemName, err = getString(p.stringTable, &f.systemNameX, err)\n\t\tf.Filename, err = getString(p.stringTable, &f.filenameX, err)\n\t\tif f.ID < uint64(len(functionIds)) {\n\t\t\tfunctionIds[f.ID] = f\n\t\t} else {\n\t\t\tfunctions[f.ID] = f\n\t\t}\n\t}\n\n\tlocations := make(map[uint64]*Location, len(p.Location))\n\tlocationIds := make([]*Location, len(p.Location)+1)\n\tfor _, l := range p.Location {\n\t\tif id := l.mappingIDX; id < uint64(len(mappingIds)) {\n\t\t\tl.Mapping = mappingIds[id]\n\t\t} else {\n\t\t\tl.Mapping = mappings[id]\n\t\t}\n\t\tl.mappingIDX = 0\n\t\tfor i, ln := range l.Line {\n\t\t\tif id := ln.functionIDX; id != 0 {\n\t\t\t\tl.Line[i].functionIDX = 0\n\t\t\t\tif id < uint64(len(functionIds)) {\n\t\t\t\t\tl.Line[i].Function = functionIds[id]\n\t\t\t\t} else {\n\t\t\t\t\tl.Line[i].Function = functions[id]\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif l.ID < uint64(len(locationIds)) {\n\t\t\tlocationIds[l.ID] = l\n\t\t} else {\n\t\t\tlocations[l.ID] = l\n\t\t}\n\t}\n\n\tfor _, st := range p.SampleType {\n\t\tst.Type, err = getString(p.stringTable, &st.typeX, err)\n\t\tst.Unit, err = getString(p.stringTable, &st.unitX, err)\n\t}\n\n\t// Pre-allocate space for all locations.\n\tnumLocations := 0\n\tfor _, s := range p.Sample {\n\t\tnumLocations += len(s.locationIDX)\n\t}\n\tlocBuffer := make([]*Location, numLocations)\n\n\tfor _, s := range p.Sample {\n\t\tif len(s.labelX) > 0 {\n\t\t\tlabels := make(map[string][]string, len(s.labelX))\n\t\t\tnumLabels := make(map[string][]int64, len(s.labelX))\n\t\t\tnumUnits := make(map[string][]string, len(s.labelX))\n\t\t\tfor _, l := range s.labelX {\n\t\t\t\tvar key, value string\n\t\t\t\tkey, err = getString(p.stringTable, &l.keyX, err)\n\t\t\t\tif l.strX != 0 {\n\t\t\t\t\tvalue, err = getString(p.stringTable, &l.strX, err)\n\t\t\t\t\tlabels[key] = append(labels[key], value)\n\t\t\t\t} else if l.numX != 0 || l.unitX != 0 {\n\t\t\t\t\tnumValues := numLabels[key]\n\t\t\t\t\tunits := numUnits[key]\n\t\t\t\t\tif l.unitX != 0 {\n\t\t\t\t\t\tvar unit string\n\t\t\t\t\t\tunit, err = getString(p.stringTable, &l.unitX, err)\n\t\t\t\t\t\tunits = padStringArray(units, len(numValues))\n\t\t\t\t\t\tnumUnits[key] = append(units, unit)\n\t\t\t\t\t}\n\t\t\t\t\tnumLabels[key] = append(numLabels[key], l.numX)\n\t\t\t\t}\n\t\t\t}\n\t\t\tif len(labels) > 0 {\n\t\t\t\ts.Label = labels\n\t\t\t}\n\t\t\tif len(numLabels) > 0 {\n\t\t\t\ts.NumLabel = numLabels\n\t\t\t\tfor key, units := range numUnits {\n\t\t\t\t\tif len(units) > 0 {\n\t\t\t\t\t\tnumUnits[key] = padStringArray(units, len(numLabels[key]))\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\ts.NumUnit = numUnits\n\t\t\t}\n\t\t}\n\n\t\ts.Location = locBuffer[:len(s.locationIDX)]\n\t\tlocBuffer = locBuffer[len(s.locationIDX):]\n\t\tfor i, lid := range s.locationIDX {\n\t\t\tif lid < uint64(len(locationIds)) {\n\t\t\t\ts.Location[i] = locationIds[lid]\n\t\t\t} else {\n\t\t\t\ts.Location[i] = locations[lid]\n\t\t\t}\n\t\t}\n\t\ts.locationIDX = nil\n\t}\n\n\tp.DropFrames, err = getString(p.stringTable, &p.dropFramesX, err)\n\tp.KeepFrames, err = getString(p.stringTable, &p.keepFramesX, err)\n\n\tif pt := p.PeriodType; pt == nil {\n\t\tp.PeriodType = &ValueType{}\n\t}\n\n\tif pt := p.PeriodType; pt != nil {\n\t\tpt.Type, err = getString(p.stringTable, &pt.typeX, err)\n\t\tpt.Unit, err = getString(p.stringTable, &pt.unitX, err)\n\t}\n\n\tfor _, i := range p.commentX {\n\t\tvar c string\n\t\tc, err = getString(p.stringTable, &i, err)\n\t\tp.Comments = append(p.Comments, c)\n\t}\n\n\tp.commentX = nil\n\tp.DefaultSampleType, err = getString(p.stringTable, &p.defaultSampleTypeX, err)\n\tp.DocURL, err = getString(p.stringTable, &p.docURLX, err)\n\tp.stringTable = nil\n\treturn err\n}\n\n// padStringArray pads arr with enough empty strings to make arr\n// length l when arr's length is less than l.\nfunc padStringArray(arr []string, l int) []string {\n\tif l <= len(arr) {\n\t\treturn arr\n\t}\n\treturn append(arr, make([]string, l-len(arr))...)\n}\n\nfunc (p *ValueType) decoder() []decoder {\n\treturn valueTypeDecoder\n}\n\nfunc (p *ValueType) encode(b *buffer) {\n\tencodeInt64Opt(b, 1, p.typeX)\n\tencodeInt64Opt(b, 2, p.unitX)\n}\n\nvar valueTypeDecoder = []decoder{\n\tnil, // 0\n\t// optional int64 type = 1\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*ValueType).typeX) },\n\t// optional int64 unit = 2\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*ValueType).unitX) },\n}\n\nfunc (p *Sample) decoder() []decoder {\n\treturn sampleDecoder\n}\n\nfunc (p *Sample) encode(b *buffer) {\n\tencodeUint64s(b, 1, p.locationIDX)\n\tencodeInt64s(b, 2, p.Value)\n\tfor _, x := range p.labelX {\n\t\tencodeMessage(b, 3, x)\n\t}\n}\n\nvar sampleDecoder = []decoder{\n\tnil, // 0\n\t// repeated uint64 location = 1\n\tfunc(b *buffer, m message) error { return decodeUint64s(b, &m.(*Sample).locationIDX) },\n\t// repeated int64 value = 2\n\tfunc(b *buffer, m message) error { return decodeInt64s(b, &m.(*Sample).Value) },\n\t// repeated Label label = 3\n\tfunc(b *buffer, m message) error {\n\t\ts := m.(*Sample)\n\t\tn := len(s.labelX)\n\t\ts.labelX = append(s.labelX, label{})\n\t\treturn decodeMessage(b, &s.labelX[n])\n\t},\n}\n\nfunc (p label) decoder() []decoder {\n\treturn labelDecoder\n}\n\nfunc (p label) encode(b *buffer) {\n\tencodeInt64Opt(b, 1, p.keyX)\n\tencodeInt64Opt(b, 2, p.strX)\n\tencodeInt64Opt(b, 3, p.numX)\n\tencodeInt64Opt(b, 4, p.unitX)\n}\n\nvar labelDecoder = []decoder{\n\tnil, // 0\n\t// optional int64 key = 1\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*label).keyX) },\n\t// optional int64 str = 2\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*label).strX) },\n\t// optional int64 num = 3\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*label).numX) },\n\t// optional int64 num = 4\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*label).unitX) },\n}\n\nfunc (p *Mapping) decoder() []decoder {\n\treturn mappingDecoder\n}\n\nfunc (p *Mapping) encode(b *buffer) {\n\tencodeUint64Opt(b, 1, p.ID)\n\tencodeUint64Opt(b, 2, p.Start)\n\tencodeUint64Opt(b, 3, p.Limit)\n\tencodeUint64Opt(b, 4, p.Offset)\n\tencodeInt64Opt(b, 5, p.fileX)\n\tencodeInt64Opt(b, 6, p.buildIDX)\n\tencodeBoolOpt(b, 7, p.HasFunctions)\n\tencodeBoolOpt(b, 8, p.HasFilenames)\n\tencodeBoolOpt(b, 9, p.HasLineNumbers)\n\tencodeBoolOpt(b, 10, p.HasInlineFrames)\n}\n\nvar mappingDecoder = []decoder{\n\tnil, // 0\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Mapping).ID) }, // optional uint64 id = 1\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Mapping).Start) }, // optional uint64 memory_offset = 2\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Mapping).Limit) }, // optional uint64 memory_limit = 3\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Mapping).Offset) }, // optional uint64 file_offset = 4\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Mapping).fileX) }, // optional int64 filename = 5\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Mapping).buildIDX) }, // optional int64 build_id = 6\n\tfunc(b *buffer, m message) error { return decodeBool(b, &m.(*Mapping).HasFunctions) }, // optional bool has_functions = 7\n\tfunc(b *buffer, m message) error { return decodeBool(b, &m.(*Mapping).HasFilenames) }, // optional bool has_filenames = 8\n\tfunc(b *buffer, m message) error { return decodeBool(b, &m.(*Mapping).HasLineNumbers) }, // optional bool has_line_numbers = 9\n\tfunc(b *buffer, m message) error { return decodeBool(b, &m.(*Mapping).HasInlineFrames) }, // optional bool has_inline_frames = 10\n}\n\nfunc (p *Location) decoder() []decoder {\n\treturn locationDecoder\n}\n\nfunc (p *Location) encode(b *buffer) {\n\tencodeUint64Opt(b, 1, p.ID)\n\tencodeUint64Opt(b, 2, p.mappingIDX)\n\tencodeUint64Opt(b, 3, p.Address)\n\tfor i := range p.Line {\n\t\tencodeMessage(b, 4, &p.Line[i])\n\t}\n\tencodeBoolOpt(b, 5, p.IsFolded)\n}\n\nvar locationDecoder = []decoder{\n\tnil, // 0\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Location).ID) }, // optional uint64 id = 1;\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Location).mappingIDX) }, // optional uint64 mapping_id = 2;\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Location).Address) }, // optional uint64 address = 3;\n\tfunc(b *buffer, m message) error { // repeated Line line = 4\n\t\tpp := m.(*Location)\n\t\tn := len(pp.Line)\n\t\tpp.Line = append(pp.Line, Line{})\n\t\treturn decodeMessage(b, &pp.Line[n])\n\t},\n\tfunc(b *buffer, m message) error { return decodeBool(b, &m.(*Location).IsFolded) }, // optional bool is_folded = 5;\n}\n\nfunc (p *Line) decoder() []decoder {\n\treturn lineDecoder\n}\n\nfunc (p *Line) encode(b *buffer) {\n\tencodeUint64Opt(b, 1, p.functionIDX)\n\tencodeInt64Opt(b, 2, p.Line)\n\tencodeInt64Opt(b, 3, p.Column)\n}\n\nvar lineDecoder = []decoder{\n\tnil, // 0\n\t// optional uint64 function_id = 1\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Line).functionIDX) },\n\t// optional int64 line = 2\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Line).Line) },\n\t// optional int64 column = 3\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Line).Column) },\n}\n\nfunc (p *Function) decoder() []decoder {\n\treturn functionDecoder\n}\n\nfunc (p *Function) encode(b *buffer) {\n\tencodeUint64Opt(b, 1, p.ID)\n\tencodeInt64Opt(b, 2, p.nameX)\n\tencodeInt64Opt(b, 3, p.systemNameX)\n\tencodeInt64Opt(b, 4, p.filenameX)\n\tencodeInt64Opt(b, 5, p.StartLine)\n}\n\nvar functionDecoder = []decoder{\n\tnil, // 0\n\t// optional uint64 id = 1\n\tfunc(b *buffer, m message) error { return decodeUint64(b, &m.(*Function).ID) },\n\t// optional int64 function_name = 2\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Function).nameX) },\n\t// optional int64 function_system_name = 3\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Function).systemNameX) },\n\t// repeated int64 filename = 4\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Function).filenameX) },\n\t// optional int64 start_line = 5\n\tfunc(b *buffer, m message) error { return decodeInt64(b, &m.(*Function).StartLine) },\n}\n\nfunc addString(strings map[string]int, s string) int64 {\n\ti, ok := strings[s]\n\tif !ok {\n\t\ti = len(strings)\n\t\tstrings[s] = i\n\t}\n\treturn int64(i)\n}\n\nfunc getString(strings []string, strng *int64, err error) (string, error) {\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\ts := int(*strng)\n\tif s < 0 || s >= len(strings) {\n\t\treturn \"\", errMalformed\n\t}\n\t*strng = 0\n\treturn strings[s], nil\n}\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/filter.go",
"content": "// Copyright 2014 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage profile\n\n// Implements methods to filter samples from profiles.\n\nimport \"regexp\"\n\n// FilterSamplesByName filters the samples in a profile and only keeps\n// samples where at least one frame matches focus but none match ignore.\n// Returns true is the corresponding regexp matched at least one sample.\nfunc (p *Profile) FilterSamplesByName(focus, ignore, hide, show *regexp.Regexp) (fm, im, hm, hnm bool) {\n\tif focus == nil && ignore == nil && hide == nil && show == nil {\n\t\tfm = true // Missing focus implies a match\n\t\treturn\n\t}\n\tfocusOrIgnore := make(map[uint64]bool)\n\thidden := make(map[uint64]bool)\n\tfor _, l := range p.Location {\n\t\tif ignore != nil && l.matchesName(ignore) {\n\t\t\tim = true\n\t\t\tfocusOrIgnore[l.ID] = false\n\t\t} else if focus == nil || l.matchesName(focus) {\n\t\t\tfm = true\n\t\t\tfocusOrIgnore[l.ID] = true\n\t\t}\n\n\t\tif hide != nil && l.matchesName(hide) {\n\t\t\thm = true\n\t\t\tl.Line = l.unmatchedLines(hide)\n\t\t\tif len(l.Line) == 0 {\n\t\t\t\thidden[l.ID] = true\n\t\t\t}\n\t\t}\n\t\tif show != nil {\n\t\t\tl.Line = l.matchedLines(show)\n\t\t\tif len(l.Line) == 0 {\n\t\t\t\thidden[l.ID] = true\n\t\t\t} else {\n\t\t\t\thnm = true\n\t\t\t}\n\t\t}\n\t}\n\n\ts := make([]*Sample, 0, len(p.Sample))\n\tfor _, sample := range p.Sample {\n\t\tif focusedAndNotIgnored(sample.Location, focusOrIgnore) {\n\t\t\tif len(hidden) > 0 {\n\t\t\t\tvar locs []*Location\n\t\t\t\tfor _, loc := range sample.Location {\n\t\t\t\t\tif !hidden[loc.ID] {\n\t\t\t\t\t\tlocs = append(locs, loc)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif len(locs) == 0 {\n\t\t\t\t\t// Remove sample with no locations (by not adding it to s).\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tsample.Location = locs\n\t\t\t}\n\t\t\ts = append(s, sample)\n\t\t}\n\t}\n\tp.Sample = s\n\n\treturn\n}\n\n// ShowFrom drops all stack frames above the highest matching frame and returns\n// whether a match was found. If showFrom is nil it returns false and does not\n// modify the profile.\n//\n// Example: consider a sample with frames [A, B, C, B], where A is the root.\n// ShowFrom(nil) returns false and has frames [A, B, C, B].\n// ShowFrom(A) returns true and has frames [A, B, C, B].\n// ShowFrom(B) returns true and has frames [B, C, B].\n// ShowFrom(C) returns true and has frames [C, B].\n// ShowFrom(D) returns false and drops the sample because no frames remain.\nfunc (p *Profile) ShowFrom(showFrom *regexp.Regexp) (matched bool) {\n\tif showFrom == nil {\n\t\treturn false\n\t}\n\t// showFromLocs stores location IDs that matched ShowFrom.\n\tshowFromLocs := make(map[uint64]bool)\n\t// Apply to locations.\n\tfor _, loc := range p.Location {\n\t\tif filterShowFromLocation(loc, showFrom) {\n\t\t\tshowFromLocs[loc.ID] = true\n\t\t\tmatched = true\n\t\t}\n\t}\n\t// For all samples, strip locations after the highest matching one.\n\ts := make([]*Sample, 0, len(p.Sample))\n\tfor _, sample := range p.Sample {\n\t\tfor i := len(sample.Location) - 1; i >= 0; i-- {\n\t\t\tif showFromLocs[sample.Location[i].ID] {\n\t\t\t\tsample.Location = sample.Location[:i+1]\n\t\t\t\ts = append(s, sample)\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\tp.Sample = s\n\treturn matched\n}\n\n// filterShowFromLocation tests a showFrom regex against a location, removes\n// lines after the last match and returns whether a match was found. If the\n// mapping is matched, then all lines are kept.\nfunc filterShowFromLocation(loc *Location, showFrom *regexp.Regexp) bool {\n\tif m := loc.Mapping; m != nil && showFrom.MatchString(m.File) {\n\t\treturn true\n\t}\n\tif i := loc.lastMatchedLineIndex(showFrom); i >= 0 {\n\t\tloc.Line = loc.Line[:i+1]\n\t\treturn true\n\t}\n\treturn false\n}\n\n// lastMatchedLineIndex returns the index of the last line that matches a regex,\n// or -1 if no match is found.\nfunc (loc *Location) lastMatchedLineIndex(re *regexp.Regexp) int {\n\tfor i := len(loc.Line) - 1; i >= 0; i-- {\n\t\tif fn := loc.Line[i].Function; fn != nil {\n\t\t\tif re.MatchString(fn.Name) || re.MatchString(fn.Filename) {\n\t\t\t\treturn i\n\t\t\t}\n\t\t}\n\t}\n\treturn -1\n}\n\n// FilterTagsByName filters the tags in a profile and only keeps\n// tags that match show and not hide.\nfunc (p *Profile) FilterTagsByName(show, hide *regexp.Regexp) (sm, hm bool) {\n\tmatchRemove := func(name string) bool {\n\t\tmatchShow := show == nil || show.MatchString(name)\n\t\tmatchHide := hide != nil && hide.MatchString(name)\n\n\t\tif matchShow {\n\t\t\tsm = true\n\t\t}\n\t\tif matchHide {\n\t\t\thm = true\n\t\t}\n\t\treturn !matchShow || matchHide\n\t}\n\tfor _, s := range p.Sample {\n\t\tfor lab := range s.Label {\n\t\t\tif matchRemove(lab) {\n\t\t\t\tdelete(s.Label, lab)\n\t\t\t}\n\t\t}\n\t\tfor lab := range s.NumLabel {\n\t\t\tif matchRemove(lab) {\n\t\t\t\tdelete(s.NumLabel, lab)\n\t\t\t}\n\t\t}\n\t}\n\treturn\n}\n\n// matchesName returns whether the location matches the regular\n// expression. It checks any available function names, file names, and\n// mapping object filename.\nfunc (loc *Location) matchesName(re *regexp.Regexp) bool {\n\tfor _, ln := range loc.Line {\n\t\tif fn := ln.Function; fn != nil {\n\t\t\tif re.MatchString(fn.Name) || re.MatchString(fn.Filename) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t}\n\tif m := loc.Mapping; m != nil && re.MatchString(m.File) {\n\t\treturn true\n\t}\n\treturn false\n}\n\n// unmatchedLines returns the lines in the location that do not match\n// the regular expression.\nfunc (loc *Location) unmatchedLines(re *regexp.Regexp) []Line {\n\tif m := loc.Mapping; m != nil && re.MatchString(m.File) {\n\t\treturn nil\n\t}\n\tvar lines []Line\n\tfor _, ln := range loc.Line {\n\t\tif fn := ln.Function; fn != nil {\n\t\t\tif re.MatchString(fn.Name) || re.MatchString(fn.Filename) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t}\n\t\tlines = append(lines, ln)\n\t}\n\treturn lines\n}\n\n// matchedLines returns the lines in the location that match\n// the regular expression.\nfunc (loc *Location) matchedLines(re *regexp.Regexp) []Line {\n\tif m := loc.Mapping; m != nil && re.MatchString(m.File) {\n\t\treturn loc.Line\n\t}\n\tvar lines []Line\n\tfor _, ln := range loc.Line {\n\t\tif fn := ln.Function; fn != nil {\n\t\t\tif !re.MatchString(fn.Name) && !re.MatchString(fn.Filename) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t}\n\t\tlines = append(lines, ln)\n\t}\n\treturn lines\n}\n\n// focusedAndNotIgnored looks up a slice of ids against a map of\n// focused/ignored locations. The map only contains locations that are\n// explicitly focused or ignored. Returns whether there is at least\n// one focused location but no ignored locations.\nfunc focusedAndNotIgnored(locs []*Location, m map[uint64]bool) bool {\n\tvar f bool\n\tfor _, loc := range locs {\n\t\tif focus, focusOrIgnore := m[loc.ID]; focusOrIgnore {\n\t\t\tif focus {\n\t\t\t\t// Found focused location. Must keep searching in case there\n\t\t\t\t// is an ignored one as well.\n\t\t\t\tf = true\n\t\t\t} else {\n\t\t\t\t// Found ignored location. Can return false right away.\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t}\n\treturn f\n}\n\n// TagMatch selects tags for filtering\ntype TagMatch func(s *Sample) bool\n\n// FilterSamplesByTag removes all samples from the profile, except\n// those that match focus and do not match the ignore regular\n// expression.\nfunc (p *Profile) FilterSamplesByTag(focus, ignore TagMatch) (fm, im bool) {\n\tsamples := make([]*Sample, 0, len(p.Sample))\n\tfor _, s := range p.Sample {\n\t\tfocused, ignored := true, false\n\t\tif focus != nil {\n\t\t\tfocused = focus(s)\n\t\t}\n\t\tif ignore != nil {\n\t\t\tignored = ignore(s)\n\t\t}\n\t\tfm = fm || focused\n\t\tim = im || ignored\n\t\tif focused && !ignored {\n\t\t\tsamples = append(samples, s)\n\t\t}\n\t}\n\tp.Sample = samples\n\treturn\n}\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/index.go",
"content": "// Copyright 2016 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage profile\n\nimport (\n\t\"fmt\"\n\t\"strconv\"\n\t\"strings\"\n)\n\n// SampleIndexByName returns the appropriate index for a value of sample index.\n// If numeric, it returns the number, otherwise it looks up the text in the\n// profile sample types.\nfunc (p *Profile) SampleIndexByName(sampleIndex string) (int, error) {\n\tif sampleIndex == \"\" {\n\t\tif dst := p.DefaultSampleType; dst != \"\" {\n\t\t\tfor i, t := range sampleTypes(p) {\n\t\t\t\tif t == dst {\n\t\t\t\t\treturn i, nil\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\t// By default select the last sample value\n\t\treturn len(p.SampleType) - 1, nil\n\t}\n\tif i, err := strconv.Atoi(sampleIndex); err == nil {\n\t\tif i < 0 || i >= len(p.SampleType) {\n\t\t\treturn 0, fmt.Errorf(\"sample_index %s is outside the range [0..%d]\", sampleIndex, len(p.SampleType)-1)\n\t\t}\n\t\treturn i, nil\n\t}\n\n\t// Remove the inuse_ prefix to support legacy pprof options\n\t// \"inuse_space\" and \"inuse_objects\" for profiles containing types\n\t// \"space\" and \"objects\".\n\tnoInuse := strings.TrimPrefix(sampleIndex, \"inuse_\")\n\tfor i, t := range p.SampleType {\n\t\tif t.Type == sampleIndex || t.Type == noInuse {\n\t\t\treturn i, nil\n\t\t}\n\t}\n\n\treturn 0, fmt.Errorf(\"sample_index %q must be one of: %v\", sampleIndex, sampleTypes(p))\n}\n\nfunc sampleTypes(p *Profile) []string {\n\ttypes := make([]string, len(p.SampleType))\n\tfor i, t := range p.SampleType {\n\t\ttypes[i] = t.Type\n\t}\n\treturn types\n}\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/legacy_java_profile.go",
"content": "// Copyright 2014 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// This file implements parsers to convert java legacy profiles into\n// the profile.proto format.\n\npackage profile\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"strconv\"\n\t\"strings\"\n)\n\nvar (\n\tattributeRx = regexp.MustCompile(`([\\w ]+)=([\\w ]+)`)\n\tjavaSampleRx = regexp.MustCompile(` *(\\d+) +(\\d+) +@ +([ x0-9a-f]*)`)\n\tjavaLocationRx = regexp.MustCompile(`^\\s*0x([[:xdigit:]]+)\\s+(.*)\\s*$`)\n\tjavaLocationFileLineRx = regexp.MustCompile(`^(.*)\\s+\\((.+):(-?[[:digit:]]+)\\)$`)\n\tjavaLocationPathRx = regexp.MustCompile(`^(.*)\\s+\\((.*)\\)$`)\n)\n\n// javaCPUProfile returns a new Profile from profilez data.\n// b is the profile bytes after the header, period is the profiling\n// period, and parse is a function to parse 8-byte chunks from the\n// profile in its native endianness.\nfunc javaCPUProfile(b []byte, period int64, parse func(b []byte) (uint64, []byte)) (*Profile, error) {\n\tp := &Profile{\n\t\tPeriod: period * 1000,\n\t\tPeriodType: &ValueType{Type: \"cpu\", Unit: \"nanoseconds\"},\n\t\tSampleType: []*ValueType{{Type: \"samples\", Unit: \"count\"}, {Type: \"cpu\", Unit: \"nanoseconds\"}},\n\t}\n\tvar err error\n\tvar locs map[uint64]*Location\n\tif b, locs, err = parseCPUSamples(b, parse, false, p); err != nil {\n\t\treturn nil, err\n\t}\n\n\tif err = parseJavaLocations(b, locs, p); err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Strip out addresses for better merge.\n\tif err = p.Aggregate(true, true, true, true, false, false); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn p, nil\n}\n\n// parseJavaProfile returns a new profile from heapz or contentionz\n// data. b is the profile bytes after the header.\nfunc parseJavaProfile(b []byte) (*Profile, error) {\n\th := bytes.SplitAfterN(b, []byte(\"\\n\"), 2)\n\tif len(h) < 2 {\n\t\treturn nil, errUnrecognized\n\t}\n\n\tp := &Profile{\n\t\tPeriodType: &ValueType{},\n\t}\n\theader := string(bytes.TrimSpace(h[0]))\n\n\tvar err error\n\tvar pType string\n\tswitch header {\n\tcase \"--- heapz 1 ---\":\n\t\tpType = \"heap\"\n\tcase \"--- contentionz 1 ---\":\n\t\tpType = \"contention\"\n\tdefault:\n\t\treturn nil, errUnrecognized\n\t}\n\n\tif b, err = parseJavaHeader(pType, h[1], p); err != nil {\n\t\treturn nil, err\n\t}\n\tvar locs map[uint64]*Location\n\tif b, locs, err = parseJavaSamples(pType, b, p); err != nil {\n\t\treturn nil, err\n\t}\n\tif err = parseJavaLocations(b, locs, p); err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Strip out addresses for better merge.\n\tif err = p.Aggregate(true, true, true, true, false, false); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn p, nil\n}\n\n// parseJavaHeader parses the attribute section on a java profile and\n// populates a profile. Returns the remainder of the buffer after all\n// attributes.\nfunc parseJavaHeader(pType string, b []byte, p *Profile) ([]byte, error) {\n\tnextNewLine := bytes.IndexByte(b, byte('\\n'))\n\tfor nextNewLine != -1 {\n\t\tline := string(bytes.TrimSpace(b[0:nextNewLine]))\n\t\tif line != \"\" {\n\t\t\th := attributeRx.FindStringSubmatch(line)\n\t\t\tif h == nil {\n\t\t\t\t// Not a valid attribute, exit.\n\t\t\t\treturn b, nil\n\t\t\t}\n\n\t\t\tattribute, value := strings.TrimSpace(h[1]), strings.TrimSpace(h[2])\n\t\t\tvar err error\n\t\t\tswitch pType + \"/\" + attribute {\n\t\t\tcase \"heap/format\", \"cpu/format\", \"contention/format\":\n\t\t\t\tif value != \"java\" {\n\t\t\t\t\treturn nil, errUnrecognized\n\t\t\t\t}\n\t\t\tcase \"heap/resolution\":\n\t\t\t\tp.SampleType = []*ValueType{\n\t\t\t\t\t{Type: \"inuse_objects\", Unit: \"count\"},\n\t\t\t\t\t{Type: \"inuse_space\", Unit: value},\n\t\t\t\t}\n\t\t\tcase \"contention/resolution\":\n\t\t\t\tp.SampleType = []*ValueType{\n\t\t\t\t\t{Type: \"contentions\", Unit: \"count\"},\n\t\t\t\t\t{Type: \"delay\", Unit: value},\n\t\t\t\t}\n\t\t\tcase \"contention/sampling period\":\n\t\t\t\tp.PeriodType = &ValueType{\n\t\t\t\t\tType: \"contentions\", Unit: \"count\",\n\t\t\t\t}\n\t\t\t\tif p.Period, err = strconv.ParseInt(value, 0, 64); err != nil {\n\t\t\t\t\treturn nil, fmt.Errorf(\"failed to parse attribute %s: %v\", line, err)\n\t\t\t\t}\n\t\t\tcase \"contention/ms since reset\":\n\t\t\t\tmillis, err := strconv.ParseInt(value, 0, 64)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn nil, fmt.Errorf(\"failed to parse attribute %s: %v\", line, err)\n\t\t\t\t}\n\t\t\t\tp.DurationNanos = millis * 1000 * 1000\n\t\t\tdefault:\n\t\t\t\treturn nil, errUnrecognized\n\t\t\t}\n\t\t}\n\t\t// Grab next line.\n\t\tb = b[nextNewLine+1:]\n\t\tnextNewLine = bytes.IndexByte(b, byte('\\n'))\n\t}\n\treturn b, nil\n}\n\n// parseJavaSamples parses the samples from a java profile and\n// populates the Samples in a profile. Returns the remainder of the\n// buffer after the samples.\nfunc parseJavaSamples(pType string, b []byte, p *Profile) ([]byte, map[uint64]*Location, error) {\n\tnextNewLine := bytes.IndexByte(b, byte('\\n'))\n\tlocs := make(map[uint64]*Location)\n\tfor nextNewLine != -1 {\n\t\tline := string(bytes.TrimSpace(b[0:nextNewLine]))\n\t\tif line != \"\" {\n\t\t\tsample := javaSampleRx.FindStringSubmatch(line)\n\t\t\tif sample == nil {\n\t\t\t\t// Not a valid sample, exit.\n\t\t\t\treturn b, locs, nil\n\t\t\t}\n\n\t\t\t// Java profiles have data/fields inverted compared to other\n\t\t\t// profile types.\n\t\t\tvar err error\n\t\t\tvalue1, value2, value3 := sample[2], sample[1], sample[3]\n\t\t\taddrs, err := parseHexAddresses(value3)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, nil, fmt.Errorf(\"malformed sample: %s: %v\", line, err)\n\t\t\t}\n\n\t\t\tvar sloc []*Location\n\t\t\tfor _, addr := range addrs {\n\t\t\t\tloc := locs[addr]\n\t\t\t\tif locs[addr] == nil {\n\t\t\t\t\tloc = &Location{\n\t\t\t\t\t\tAddress: addr,\n\t\t\t\t\t}\n\t\t\t\t\tp.Location = append(p.Location, loc)\n\t\t\t\t\tlocs[addr] = loc\n\t\t\t\t}\n\t\t\t\tsloc = append(sloc, loc)\n\t\t\t}\n\t\t\ts := &Sample{\n\t\t\t\tValue: make([]int64, 2),\n\t\t\t\tLocation: sloc,\n\t\t\t}\n\n\t\t\tif s.Value[0], err = strconv.ParseInt(value1, 0, 64); err != nil {\n\t\t\t\treturn nil, nil, fmt.Errorf(\"parsing sample %s: %v\", line, err)\n\t\t\t}\n\t\t\tif s.Value[1], err = strconv.ParseInt(value2, 0, 64); err != nil {\n\t\t\t\treturn nil, nil, fmt.Errorf(\"parsing sample %s: %v\", line, err)\n\t\t\t}\n\n\t\t\tswitch pType {\n\t\t\tcase \"heap\":\n\t\t\t\tconst javaHeapzSamplingRate = 524288 // 512K\n\t\t\t\tif s.Value[0] == 0 {\n\t\t\t\t\treturn nil, nil, fmt.Errorf(\"parsing sample %s: second value must be non-zero\", line)\n\t\t\t\t}\n\t\t\t\ts.NumLabel = map[string][]int64{\"bytes\": {s.Value[1] / s.Value[0]}}\n\t\t\t\ts.Value[0], s.Value[1] = scaleHeapSample(s.Value[0], s.Value[1], javaHeapzSamplingRate)\n\t\t\tcase \"contention\":\n\t\t\t\tif period := p.Period; period != 0 {\n\t\t\t\t\ts.Value[0] = s.Value[0] * p.Period\n\t\t\t\t\ts.Value[1] = s.Value[1] * p.Period\n\t\t\t\t}\n\t\t\t}\n\t\t\tp.Sample = append(p.Sample, s)\n\t\t}\n\t\t// Grab next line.\n\t\tb = b[nextNewLine+1:]\n\t\tnextNewLine = bytes.IndexByte(b, byte('\\n'))\n\t}\n\treturn b, locs, nil\n}\n\n// parseJavaLocations parses the location information in a java\n// profile and populates the Locations in a profile. It uses the\n// location addresses from the profile as both the ID of each\n// location.\nfunc parseJavaLocations(b []byte, locs map[uint64]*Location, p *Profile) error {\n\tr := bytes.NewBuffer(b)\n\tfns := make(map[string]*Function)\n\tfor {\n\t\tline, err := r.ReadString('\\n')\n\t\tif err != nil {\n\t\t\tif err != io.EOF {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tif line == \"\" {\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\n\t\tif line = strings.TrimSpace(line); line == \"\" {\n\t\t\tcontinue\n\t\t}\n\n\t\tjloc := javaLocationRx.FindStringSubmatch(line)\n\t\tif len(jloc) != 3 {\n\t\t\tcontinue\n\t\t}\n\t\taddr, err := strconv.ParseUint(jloc[1], 16, 64)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"parsing sample %s: %v\", line, err)\n\t\t}\n\t\tloc := locs[addr]\n\t\tif loc == nil {\n\t\t\t// Unused/unseen\n\t\t\tcontinue\n\t\t}\n\t\tvar lineFunc, lineFile string\n\t\tvar lineNo int64\n\n\t\tif fileLine := javaLocationFileLineRx.FindStringSubmatch(jloc[2]); len(fileLine) == 4 {\n\t\t\t// Found a line of the form: \"function (file:line)\"\n\t\t\tlineFunc, lineFile = fileLine[1], fileLine[2]\n\t\t\tif n, err := strconv.ParseInt(fileLine[3], 10, 64); err == nil && n > 0 {\n\t\t\t\tlineNo = n\n\t\t\t}\n\t\t} else if filePath := javaLocationPathRx.FindStringSubmatch(jloc[2]); len(filePath) == 3 {\n\t\t\t// If there's not a file:line, it's a shared library path.\n\t\t\t// The path isn't interesting, so just give the .so.\n\t\t\tlineFunc, lineFile = filePath[1], filepath.Base(filePath[2])\n\t\t} else if strings.Contains(jloc[2], \"generated stub/JIT\") {\n\t\t\tlineFunc = \"STUB\"\n\t\t} else {\n\t\t\t// Treat whole line as the function name. This is used by the\n\t\t\t// java agent for internal states such as \"GC\" or \"VM\".\n\t\t\tlineFunc = jloc[2]\n\t\t}\n\t\tfn := fns[lineFunc]\n\n\t\tif fn == nil {\n\t\t\tfn = &Function{\n\t\t\t\tName: lineFunc,\n\t\t\t\tSystemName: lineFunc,\n\t\t\t\tFilename: lineFile,\n\t\t\t}\n\t\t\tfns[lineFunc] = fn\n\t\t\tp.Function = append(p.Function, fn)\n\t\t}\n\t\tloc.Line = []Line{\n\t\t\t{\n\t\t\t\tFunction: fn,\n\t\t\t\tLine: lineNo,\n\t\t\t},\n\t\t}\n\t\tloc.Address = 0\n\t}\n\n\tp.remapLocationIDs()\n\tp.remapFunctionIDs()\n\tp.remapMappingIDs()\n\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/legacy_profile.go",
"content": "// Copyright 2014 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// This file implements parsers to convert legacy profiles into the\n// profile.proto format.\n\npackage profile\n\nimport (\n\t\"bufio\"\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"math\"\n\t\"regexp\"\n\t\"strconv\"\n\t\"strings\"\n)\n\nvar (\n\tcountStartRE = regexp.MustCompile(`\\A(\\S+) profile: total \\d+\\z`)\n\tcountRE = regexp.MustCompile(`\\A(\\d+) @(( 0x[0-9a-f]+)+)\\z`)\n\n\theapHeaderRE = regexp.MustCompile(`heap profile: *(\\d+): *(\\d+) *\\[ *(\\d+): *(\\d+) *\\] *@ *(heap[_a-z0-9]*)/?(\\d*)`)\n\theapSampleRE = regexp.MustCompile(`(-?\\d+): *(-?\\d+) *\\[ *(\\d+): *(\\d+) *] @([ x0-9a-f]*)`)\n\n\tcontentionSampleRE = regexp.MustCompile(`(\\d+) *(\\d+) @([ x0-9a-f]*)`)\n\n\thexNumberRE = regexp.MustCompile(`0x[0-9a-f]+`)\n\n\tgrowthHeaderRE = regexp.MustCompile(`heap profile: *(\\d+): *(\\d+) *\\[ *(\\d+): *(\\d+) *\\] @ growthz?`)\n\n\tfragmentationHeaderRE = regexp.MustCompile(`heap profile: *(\\d+): *(\\d+) *\\[ *(\\d+): *(\\d+) *\\] @ fragmentationz?`)\n\n\tthreadzStartRE = regexp.MustCompile(`--- threadz \\d+ ---`)\n\tthreadStartRE = regexp.MustCompile(`--- Thread ([[:xdigit:]]+) \\(name: (.*)/(\\d+)\\) stack: ---`)\n\n\t// Regular expressions to parse process mappings. Support the format used by Linux /proc/.../maps and other tools.\n\t// Recommended format:\n\t// Start End object file name offset(optional) linker build id\n\t// 0x40000-0x80000 /path/to/binary (@FF00) abc123456\n\tspaceDigits = `\\s+[[:digit:]]+`\n\thexPair = `\\s+[[:xdigit:]]+:[[:xdigit:]]+`\n\toSpace = `\\s*`\n\t// Capturing expressions.\n\tcHex = `(?:0x)?([[:xdigit:]]+)`\n\tcHexRange = `\\s*` + cHex + `[\\s-]?` + oSpace + cHex + `:?`\n\tcSpaceString = `(?:\\s+(\\S+))?`\n\tcSpaceHex = `(?:\\s+([[:xdigit:]]+))?`\n\tcSpaceAtOffset = `(?:\\s+\\(@([[:xdigit:]]+)\\))?`\n\tcPerm = `(?:\\s+([-rwxp]+))?`\n\n\tprocMapsRE = regexp.MustCompile(`^` + cHexRange + cPerm + cSpaceHex + hexPair + spaceDigits + cSpaceString)\n\tbriefMapsRE = regexp.MustCompile(`^` + cHexRange + cPerm + cSpaceString + cSpaceAtOffset + cSpaceHex)\n\n\t// Regular expression to parse log data, of the form:\n\t// ... file:line] msg...\n\tlogInfoRE = regexp.MustCompile(`^[^\\[\\]]+:[0-9]+]\\s`)\n)\n\nfunc isSpaceOrComment(line string) bool {\n\ttrimmed := strings.TrimSpace(line)\n\treturn len(trimmed) == 0 || trimmed[0] == '#'\n}\n\n// parseGoCount parses a Go count profile (e.g., threadcreate or\n// goroutine) and returns a new Profile.\nfunc parseGoCount(b []byte) (*Profile, error) {\n\ts := bufio.NewScanner(bytes.NewBuffer(b))\n\t// Skip comments at the beginning of the file.\n\tfor s.Scan() && isSpaceOrComment(s.Text()) {\n\t}\n\tif err := s.Err(); err != nil {\n\t\treturn nil, err\n\t}\n\tm := countStartRE.FindStringSubmatch(s.Text())\n\tif m == nil {\n\t\treturn nil, errUnrecognized\n\t}\n\tprofileType := m[1]\n\tp := &Profile{\n\t\tPeriodType: &ValueType{Type: profileType, Unit: \"count\"},\n\t\tPeriod: 1,\n\t\tSampleType: []*ValueType{{Type: profileType, Unit: \"count\"}},\n\t}\n\tlocations := make(map[uint64]*Location)\n\tfor s.Scan() {\n\t\tline := s.Text()\n\t\tif isSpaceOrComment(line) {\n\t\t\tcontinue\n\t\t}\n\t\tif strings.HasPrefix(line, \"---\") {\n\t\t\tbreak\n\t\t}\n\t\tm := countRE.FindStringSubmatch(line)\n\t\tif m == nil {\n\t\t\treturn nil, errMalformed\n\t\t}\n\t\tn, err := strconv.ParseInt(m[1], 0, 64)\n\t\tif err != nil {\n\t\t\treturn nil, errMalformed\n\t\t}\n\t\tfields := strings.Fields(m[2])\n\t\tlocs := make([]*Location, 0, len(fields))\n\t\tfor _, stk := range fields {\n\t\t\taddr, err := strconv.ParseUint(stk, 0, 64)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, errMalformed\n\t\t\t}\n\t\t\t// Adjust all frames by -1 to land on top of the call instruction.\n\t\t\taddr--\n\t\t\tloc := locations[addr]\n\t\t\tif loc == nil {\n\t\t\t\tloc = &Location{\n\t\t\t\t\tAddress: addr,\n\t\t\t\t}\n\t\t\t\tlocations[addr] = loc\n\t\t\t\tp.Location = append(p.Location, loc)\n\t\t\t}\n\t\t\tlocs = append(locs, loc)\n\t\t}\n\t\tp.Sample = append(p.Sample, &Sample{\n\t\t\tLocation: locs,\n\t\t\tValue: []int64{n},\n\t\t})\n\t}\n\tif err := s.Err(); err != nil {\n\t\treturn nil, err\n\t}\n\n\tif err := parseAdditionalSections(s, p); err != nil {\n\t\treturn nil, err\n\t}\n\treturn p, nil\n}\n\n// remapLocationIDs ensures there is a location for each address\n// referenced by a sample, and remaps the samples to point to the new\n// location ids.\nfunc (p *Profile) remapLocationIDs() {\n\tseen := make(map[*Location]bool, len(p.Location))\n\tvar locs []*Location\n\n\tfor _, s := range p.Sample {\n\t\tfor _, l := range s.Location {\n\t\t\tif seen[l] {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tl.ID = uint64(len(locs) + 1)\n\t\t\tlocs = append(locs, l)\n\t\t\tseen[l] = true\n\t\t}\n\t}\n\tp.Location = locs\n}\n\nfunc (p *Profile) remapFunctionIDs() {\n\tseen := make(map[*Function]bool, len(p.Function))\n\tvar fns []*Function\n\n\tfor _, l := range p.Location {\n\t\tfor _, ln := range l.Line {\n\t\t\tfn := ln.Function\n\t\t\tif fn == nil || seen[fn] {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tfn.ID = uint64(len(fns) + 1)\n\t\t\tfns = append(fns, fn)\n\t\t\tseen[fn] = true\n\t\t}\n\t}\n\tp.Function = fns\n}\n\n// remapMappingIDs matches location addresses with existing mappings\n// and updates them appropriately. This is O(N*M), if this ever shows\n// up as a bottleneck, evaluate sorting the mappings and doing a\n// binary search, which would make it O(N*log(M)).\nfunc (p *Profile) remapMappingIDs() {\n\t// Some profile handlers will incorrectly set regions for the main\n\t// executable if its section is remapped. Fix them through heuristics.\n\n\tif len(p.Mapping) > 0 {\n\t\t// Remove the initial mapping if named '/anon_hugepage' and has a\n\t\t// consecutive adjacent mapping.\n\t\tif m := p.Mapping[0]; strings.HasPrefix(m.File, \"/anon_hugepage\") {\n\t\t\tif len(p.Mapping) > 1 && m.Limit == p.Mapping[1].Start {\n\t\t\t\tp.Mapping = p.Mapping[1:]\n\t\t\t}\n\t\t}\n\t}\n\n\t// Subtract the offset from the start of the main mapping if it\n\t// ends up at a recognizable start address.\n\tif len(p.Mapping) > 0 {\n\t\tconst expectedStart = 0x400000\n\t\tif m := p.Mapping[0]; m.Start-m.Offset == expectedStart {\n\t\t\tm.Start = expectedStart\n\t\t\tm.Offset = 0\n\t\t}\n\t}\n\n\t// Associate each location with an address to the corresponding\n\t// mapping. Create fake mapping if a suitable one isn't found.\n\tvar fake *Mapping\nnextLocation:\n\tfor _, l := range p.Location {\n\t\ta := l.Address\n\t\tif l.Mapping != nil || a == 0 {\n\t\t\tcontinue\n\t\t}\n\t\tfor _, m := range p.Mapping {\n\t\t\tif m.Start <= a && a < m.Limit {\n\t\t\t\tl.Mapping = m\n\t\t\t\tcontinue nextLocation\n\t\t\t}\n\t\t}\n\t\t// Work around legacy handlers failing to encode the first\n\t\t// part of mappings split into adjacent ranges.\n\t\tfor _, m := range p.Mapping {\n\t\t\tif m.Offset != 0 && m.Start-m.Offset <= a && a < m.Start {\n\t\t\t\tm.Start -= m.Offset\n\t\t\t\tm.Offset = 0\n\t\t\t\tl.Mapping = m\n\t\t\t\tcontinue nextLocation\n\t\t\t}\n\t\t}\n\t\t// If there is still no mapping, create a fake one.\n\t\t// This is important for the Go legacy handler, which produced\n\t\t// no mappings.\n\t\tif fake == nil {\n\t\t\tfake = &Mapping{\n\t\t\t\tID: 1,\n\t\t\t\tLimit: ^uint64(0),\n\t\t\t}\n\t\t\tp.Mapping = append(p.Mapping, fake)\n\t\t}\n\t\tl.Mapping = fake\n\t}\n\n\t// Reset all mapping IDs.\n\tfor i, m := range p.Mapping {\n\t\tm.ID = uint64(i + 1)\n\t}\n}\n\nvar cpuInts = []func([]byte) (uint64, []byte){\n\tget32l,\n\tget32b,\n\tget64l,\n\tget64b,\n}\n\nfunc get32l(b []byte) (uint64, []byte) {\n\tif len(b) < 4 {\n\t\treturn 0, nil\n\t}\n\treturn uint64(b[0]) | uint64(b[1])<<8 | uint64(b[2])<<16 | uint64(b[3])<<24, b[4:]\n}\n\nfunc get32b(b []byte) (uint64, []byte) {\n\tif len(b) < 4 {\n\t\treturn 0, nil\n\t}\n\treturn uint64(b[3]) | uint64(b[2])<<8 | uint64(b[1])<<16 | uint64(b[0])<<24, b[4:]\n}\n\nfunc get64l(b []byte) (uint64, []byte) {\n\tif len(b) < 8 {\n\t\treturn 0, nil\n\t}\n\treturn uint64(b[0]) | uint64(b[1])<<8 | uint64(b[2])<<16 | uint64(b[3])<<24 | uint64(b[4])<<32 | uint64(b[5])<<40 | uint64(b[6])<<48 | uint64(b[7])<<56, b[8:]\n}\n\nfunc get64b(b []byte) (uint64, []byte) {\n\tif len(b) < 8 {\n\t\treturn 0, nil\n\t}\n\treturn uint64(b[7]) | uint64(b[6])<<8 | uint64(b[5])<<16 | uint64(b[4])<<24 | uint64(b[3])<<32 | uint64(b[2])<<40 | uint64(b[1])<<48 | uint64(b[0])<<56, b[8:]\n}\n\n// parseCPU parses a profilez legacy profile and returns a newly\n// populated Profile.\n//\n// The general format for profilez samples is a sequence of words in\n// binary format. The first words are a header with the following data:\n//\n//\t1st word -- 0\n//\t2nd word -- 3\n//\t3rd word -- 0 if a c++ application, 1 if a java application.\n//\t4th word -- Sampling period (in microseconds).\n//\t5th word -- Padding.\nfunc parseCPU(b []byte) (*Profile, error) {\n\tvar parse func([]byte) (uint64, []byte)\n\tvar n1, n2, n3, n4, n5 uint64\n\tfor _, parse = range cpuInts {\n\t\tvar tmp []byte\n\t\tn1, tmp = parse(b)\n\t\tn2, tmp = parse(tmp)\n\t\tn3, tmp = parse(tmp)\n\t\tn4, tmp = parse(tmp)\n\t\tn5, tmp = parse(tmp)\n\n\t\tif tmp != nil && n1 == 0 && n2 == 3 && n3 == 0 && n4 > 0 && n5 == 0 {\n\t\t\tb = tmp\n\t\t\treturn cpuProfile(b, int64(n4), parse)\n\t\t}\n\t\tif tmp != nil && n1 == 0 && n2 == 3 && n3 == 1 && n4 > 0 && n5 == 0 {\n\t\t\tb = tmp\n\t\t\treturn javaCPUProfile(b, int64(n4), parse)\n\t\t}\n\t}\n\treturn nil, errUnrecognized\n}\n\n// cpuProfile returns a new Profile from C++ profilez data.\n// b is the profile bytes after the header, period is the profiling\n// period, and parse is a function to parse 8-byte chunks from the\n// profile in its native endianness.\nfunc cpuProfile(b []byte, period int64, parse func(b []byte) (uint64, []byte)) (*Profile, error) {\n\tp := &Profile{\n\t\tPeriod: period * 1000,\n\t\tPeriodType: &ValueType{Type: \"cpu\", Unit: \"nanoseconds\"},\n\t\tSampleType: []*ValueType{\n\t\t\t{Type: \"samples\", Unit: \"count\"},\n\t\t\t{Type: \"cpu\", Unit: \"nanoseconds\"},\n\t\t},\n\t}\n\tvar err error\n\tif b, _, err = parseCPUSamples(b, parse, true, p); err != nil {\n\t\treturn nil, err\n\t}\n\n\t// If *most* samples have the same second-to-the-bottom frame, it\n\t// strongly suggests that it is an uninteresting artifact of\n\t// measurement -- a stack frame pushed by the signal handler. The\n\t// bottom frame is always correct as it is picked up from the signal\n\t// structure, not the stack. Check if this is the case and if so,\n\t// remove.\n\n\t// Remove up to two frames.\n\tmaxiter := 2\n\t// Allow one different sample for this many samples with the same\n\t// second-to-last frame.\n\tsimilarSamples := 32\n\tmargin := len(p.Sample) / similarSamples\n\n\tfor iter := 0; iter < maxiter; iter++ {\n\t\taddr1 := make(map[uint64]int)\n\t\tfor _, s := range p.Sample {\n\t\t\tif len(s.Location) > 1 {\n\t\t\t\ta := s.Location[1].Address\n\t\t\t\taddr1[a] = addr1[a] + 1\n\t\t\t}\n\t\t}\n\n\t\tfor id1, count := range addr1 {\n\t\t\tif count >= len(p.Sample)-margin {\n\t\t\t\t// Found uninteresting frame, strip it out from all samples\n\t\t\t\tfor _, s := range p.Sample {\n\t\t\t\t\tif len(s.Location) > 1 && s.Location[1].Address == id1 {\n\t\t\t\t\t\ts.Location = append(s.Location[:1], s.Location[2:]...)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\n\tif err := p.ParseMemoryMap(bytes.NewBuffer(b)); err != nil {\n\t\treturn nil, err\n\t}\n\n\tcleanupDuplicateLocations(p)\n\treturn p, nil\n}\n\nfunc cleanupDuplicateLocations(p *Profile) {\n\t// The profile handler may duplicate the leaf frame, because it gets\n\t// its address both from stack unwinding and from the signal\n\t// context. Detect this and delete the duplicate, which has been\n\t// adjusted by -1. The leaf address should not be adjusted as it is\n\t// not a call.\n\tfor _, s := range p.Sample {\n\t\tif len(s.Location) > 1 && s.Location[0].Address == s.Location[1].Address+1 {\n\t\t\ts.Location = append(s.Location[:1], s.Location[2:]...)\n\t\t}\n\t}\n}\n\n// parseCPUSamples parses a collection of profilez samples from a\n// profile.\n//\n// profilez samples are a repeated sequence of stack frames of the\n// form:\n//\n//\t1st word -- The number of times this stack was encountered.\n//\t2nd word -- The size of the stack (StackSize).\n//\t3rd word -- The first address on the stack.\n//\t...\n//\tStackSize + 2 -- The last address on the stack\n//\n// The last stack trace is of the form:\n//\n//\t1st word -- 0\n//\t2nd word -- 1\n//\t3rd word -- 0\n//\n// Addresses from stack traces may point to the next instruction after\n// each call. Optionally adjust by -1 to land somewhere on the actual\n// call (except for the leaf, which is not a call).\nfunc parseCPUSamples(b []byte, parse func(b []byte) (uint64, []byte), adjust bool, p *Profile) ([]byte, map[uint64]*Location, error) {\n\tlocs := make(map[uint64]*Location)\n\tfor len(b) > 0 {\n\t\tvar count, nstk uint64\n\t\tcount, b = parse(b)\n\t\tnstk, b = parse(b)\n\t\tif b == nil || nstk > uint64(len(b)/4) {\n\t\t\treturn nil, nil, errUnrecognized\n\t\t}\n\t\tvar sloc []*Location\n\t\taddrs := make([]uint64, nstk)\n\t\tfor i := 0; i < int(nstk); i++ {\n\t\t\taddrs[i], b = parse(b)\n\t\t}\n\n\t\tif count == 0 && nstk == 1 && addrs[0] == 0 {\n\t\t\t// End of data marker\n\t\t\tbreak\n\t\t}\n\t\tfor i, addr := range addrs {\n\t\t\tif adjust && i > 0 {\n\t\t\t\taddr--\n\t\t\t}\n\t\t\tloc := locs[addr]\n\t\t\tif loc == nil {\n\t\t\t\tloc = &Location{\n\t\t\t\t\tAddress: addr,\n\t\t\t\t}\n\t\t\t\tlocs[addr] = loc\n\t\t\t\tp.Location = append(p.Location, loc)\n\t\t\t}\n\t\t\tsloc = append(sloc, loc)\n\t\t}\n\t\tp.Sample = append(p.Sample,\n\t\t\t&Sample{\n\t\t\t\tValue: []int64{int64(count), int64(count) * p.Period},\n\t\t\t\tLocation: sloc,\n\t\t\t})\n\t}\n\t// Reached the end without finding the EOD marker.\n\treturn b, locs, nil\n}\n\n// parseHeap parses a heapz legacy or a growthz profile and\n// returns a newly populated Profile.\nfunc parseHeap(b []byte) (p *Profile, err error) {\n\ts := bufio.NewScanner(bytes.NewBuffer(b))\n\tif !s.Scan() {\n\t\tif err := s.Err(); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn nil, errUnrecognized\n\t}\n\tp = &Profile{}\n\n\tsampling := \"\"\n\thasAlloc := false\n\n\tline := s.Text()\n\tp.PeriodType = &ValueType{Type: \"space\", Unit: \"bytes\"}\n\tif header := heapHeaderRE.FindStringSubmatch(line); header != nil {\n\t\tsampling, p.Period, hasAlloc, err = parseHeapHeader(line)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t} else if header = growthHeaderRE.FindStringSubmatch(line); header != nil {\n\t\tp.Period = 1\n\t} else if header = fragmentationHeaderRE.FindStringSubmatch(line); header != nil {\n\t\tp.Period = 1\n\t} else {\n\t\treturn nil, errUnrecognized\n\t}\n\n\tif hasAlloc {\n\t\t// Put alloc before inuse so that default pprof selection\n\t\t// will prefer inuse_space.\n\t\tp.SampleType = []*ValueType{\n\t\t\t{Type: \"alloc_objects\", Unit: \"count\"},\n\t\t\t{Type: \"alloc_space\", Unit: \"bytes\"},\n\t\t\t{Type: \"inuse_objects\", Unit: \"count\"},\n\t\t\t{Type: \"inuse_space\", Unit: \"bytes\"},\n\t\t}\n\t} else {\n\t\tp.SampleType = []*ValueType{\n\t\t\t{Type: \"objects\", Unit: \"count\"},\n\t\t\t{Type: \"space\", Unit: \"bytes\"},\n\t\t}\n\t}\n\n\tlocs := make(map[uint64]*Location)\n\tfor s.Scan() {\n\t\tline := strings.TrimSpace(s.Text())\n\n\t\tif isSpaceOrComment(line) {\n\t\t\tcontinue\n\t\t}\n\n\t\tif isMemoryMapSentinel(line) {\n\t\t\tbreak\n\t\t}\n\n\t\tvalue, blocksize, addrs, err := parseHeapSample(line, p.Period, sampling, hasAlloc)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tvar sloc []*Location\n\t\tfor _, addr := range addrs {\n\t\t\t// Addresses from stack traces point to the next instruction after\n\t\t\t// each call. Adjust by -1 to land somewhere on the actual call.\n\t\t\taddr--\n\t\t\tloc := locs[addr]\n\t\t\tif locs[addr] == nil {\n\t\t\t\tloc = &Location{\n\t\t\t\t\tAddress: addr,\n\t\t\t\t}\n\t\t\t\tp.Location = append(p.Location, loc)\n\t\t\t\tlocs[addr] = loc\n\t\t\t}\n\t\t\tsloc = append(sloc, loc)\n\t\t}\n\n\t\tp.Sample = append(p.Sample, &Sample{\n\t\t\tValue: value,\n\t\t\tLocation: sloc,\n\t\t\tNumLabel: map[string][]int64{\"bytes\": {blocksize}},\n\t\t})\n\t}\n\tif err := s.Err(); err != nil {\n\t\treturn nil, err\n\t}\n\tif err := parseAdditionalSections(s, p); err != nil {\n\t\treturn nil, err\n\t}\n\treturn p, nil\n}\n\nfunc parseHeapHeader(line string) (sampling string, period int64, hasAlloc bool, err error) {\n\theader := heapHeaderRE.FindStringSubmatch(line)\n\tif header == nil {\n\t\treturn \"\", 0, false, errUnrecognized\n\t}\n\n\tif len(header[6]) > 0 {\n\t\tif period, err = strconv.ParseInt(header[6], 10, 64); err != nil {\n\t\t\treturn \"\", 0, false, errUnrecognized\n\t\t}\n\t}\n\n\tif (header[3] != header[1] && header[3] != \"0\") || (header[4] != header[2] && header[4] != \"0\") {\n\t\thasAlloc = true\n\t}\n\n\tswitch header[5] {\n\tcase \"heapz_v2\", \"heap_v2\":\n\t\treturn \"v2\", period, hasAlloc, nil\n\tcase \"heapprofile\":\n\t\treturn \"\", 1, hasAlloc, nil\n\tcase \"heap\":\n\t\treturn \"v2\", period / 2, hasAlloc, nil\n\tdefault:\n\t\treturn \"\", 0, false, errUnrecognized\n\t}\n}\n\n// parseHeapSample parses a single row from a heap profile into a new Sample.\nfunc parseHeapSample(line string, rate int64, sampling string, includeAlloc bool) (value []int64, blocksize int64, addrs []uint64, err error) {\n\tsampleData := heapSampleRE.FindStringSubmatch(line)\n\tif len(sampleData) != 6 {\n\t\treturn nil, 0, nil, fmt.Errorf(\"unexpected number of sample values: got %d, want 6\", len(sampleData))\n\t}\n\n\t// This is a local-scoped helper function to avoid needing to pass\n\t// around rate, sampling and many return parameters.\n\taddValues := func(countString, sizeString string, label string) error {\n\t\tcount, err := strconv.ParseInt(countString, 10, 64)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"malformed sample: %s: %v\", line, err)\n\t\t}\n\t\tsize, err := strconv.ParseInt(sizeString, 10, 64)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"malformed sample: %s: %v\", line, err)\n\t\t}\n\t\tif count == 0 && size != 0 {\n\t\t\treturn fmt.Errorf(\"%s count was 0 but %s bytes was %d\", label, label, size)\n\t\t}\n\t\tif count != 0 {\n\t\t\tblocksize = size / count\n\t\t\tif sampling == \"v2\" {\n\t\t\t\tcount, size = scaleHeapSample(count, size, rate)\n\t\t\t}\n\t\t}\n\t\tvalue = append(value, count, size)\n\t\treturn nil\n\t}\n\n\tif includeAlloc {\n\t\tif err := addValues(sampleData[3], sampleData[4], \"allocation\"); err != nil {\n\t\t\treturn nil, 0, nil, err\n\t\t}\n\t}\n\n\tif err := addValues(sampleData[1], sampleData[2], \"inuse\"); err != nil {\n\t\treturn nil, 0, nil, err\n\t}\n\n\taddrs, err = parseHexAddresses(sampleData[5])\n\tif err != nil {\n\t\treturn nil, 0, nil, fmt.Errorf(\"malformed sample: %s: %v\", line, err)\n\t}\n\n\treturn value, blocksize, addrs, nil\n}\n\n// parseHexAddresses extracts hex numbers from a string, attempts to convert\n// each to an unsigned 64-bit number and returns the resulting numbers as a\n// slice, or an error if the string contains hex numbers which are too large to\n// handle (which means a malformed profile).\nfunc parseHexAddresses(s string) ([]uint64, error) {\n\thexStrings := hexNumberRE.FindAllString(s, -1)\n\tvar addrs []uint64\n\tfor _, s := range hexStrings {\n\t\tif addr, err := strconv.ParseUint(s, 0, 64); err == nil {\n\t\t\taddrs = append(addrs, addr)\n\t\t} else {\n\t\t\treturn nil, fmt.Errorf(\"failed to parse as hex 64-bit number: %s\", s)\n\t\t}\n\t}\n\treturn addrs, nil\n}\n\n// scaleHeapSample adjusts the data from a heapz Sample to\n// account for its probability of appearing in the collected\n// data. heapz profiles are a sampling of the memory allocations\n// requests in a program. We estimate the unsampled value by dividing\n// each collected sample by its probability of appearing in the\n// profile. heapz v2 profiles rely on a poisson process to determine\n// which samples to collect, based on the desired average collection\n// rate R. The probability of a sample of size S to appear in that\n// profile is 1-exp(-S/R).\nfunc scaleHeapSample(count, size, rate int64) (int64, int64) {\n\tif count == 0 || size == 0 {\n\t\treturn 0, 0\n\t}\n\n\tif rate <= 1 {\n\t\t// if rate==1 all samples were collected so no adjustment is needed.\n\t\t// if rate<1 treat as unknown and skip scaling.\n\t\treturn count, size\n\t}\n\n\tavgSize := float64(size) / float64(count)\n\tscale := 1 / (1 - math.Exp(-avgSize/float64(rate)))\n\n\treturn int64(float64(count) * scale), int64(float64(size) * scale)\n}\n\n// parseContention parses a mutex or contention profile. There are 2 cases:\n// \"--- contentionz \" for legacy C++ profiles (and backwards compatibility)\n// \"--- mutex:\" or \"--- contention:\" for profiles generated by the Go runtime.\nfunc parseContention(b []byte) (*Profile, error) {\n\ts := bufio.NewScanner(bytes.NewBuffer(b))\n\tif !s.Scan() {\n\t\tif err := s.Err(); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn nil, errUnrecognized\n\t}\n\n\tswitch l := s.Text(); {\n\tcase strings.HasPrefix(l, \"--- contentionz \"):\n\tcase strings.HasPrefix(l, \"--- mutex:\"):\n\tcase strings.HasPrefix(l, \"--- contention:\"):\n\tdefault:\n\t\treturn nil, errUnrecognized\n\t}\n\n\tp := &Profile{\n\t\tPeriodType: &ValueType{Type: \"contentions\", Unit: \"count\"},\n\t\tPeriod: 1,\n\t\tSampleType: []*ValueType{\n\t\t\t{Type: \"contentions\", Unit: \"count\"},\n\t\t\t{Type: \"delay\", Unit: \"nanoseconds\"},\n\t\t},\n\t}\n\n\tvar cpuHz int64\n\t// Parse text of the form \"attribute = value\" before the samples.\n\tconst delimiter = \"=\"\n\tfor s.Scan() {\n\t\tline := s.Text()\n\t\tif line = strings.TrimSpace(line); isSpaceOrComment(line) {\n\t\t\tcontinue\n\t\t}\n\t\tif strings.HasPrefix(line, \"---\") {\n\t\t\tbreak\n\t\t}\n\t\tattr := strings.SplitN(line, delimiter, 2)\n\t\tif len(attr) != 2 {\n\t\t\tbreak\n\t\t}\n\t\tkey, val := strings.TrimSpace(attr[0]), strings.TrimSpace(attr[1])\n\t\tvar err error\n\t\tswitch key {\n\t\tcase \"cycles/second\":\n\t\t\tif cpuHz, err = strconv.ParseInt(val, 0, 64); err != nil {\n\t\t\t\treturn nil, errUnrecognized\n\t\t\t}\n\t\tcase \"sampling period\":\n\t\t\tif p.Period, err = strconv.ParseInt(val, 0, 64); err != nil {\n\t\t\t\treturn nil, errUnrecognized\n\t\t\t}\n\t\tcase \"ms since reset\":\n\t\t\tms, err := strconv.ParseInt(val, 0, 64)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, errUnrecognized\n\t\t\t}\n\t\t\tp.DurationNanos = ms * 1000 * 1000\n\t\tcase \"format\":\n\t\t\t// CPP contentionz profiles don't have format.\n\t\t\treturn nil, errUnrecognized\n\t\tcase \"resolution\":\n\t\t\t// CPP contentionz profiles don't have resolution.\n\t\t\treturn nil, errUnrecognized\n\t\tcase \"discarded samples\":\n\t\tdefault:\n\t\t\treturn nil, errUnrecognized\n\t\t}\n\t}\n\tif err := s.Err(); err != nil {\n\t\treturn nil, err\n\t}\n\n\tlocs := make(map[uint64]*Location)\n\tfor {\n\t\tline := strings.TrimSpace(s.Text())\n\t\tif strings.HasPrefix(line, \"---\") {\n\t\t\tbreak\n\t\t}\n\t\tif !isSpaceOrComment(line) {\n\t\t\tvalue, addrs, err := parseContentionSample(line, p.Period, cpuHz)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tvar sloc []*Location\n\t\t\tfor _, addr := range addrs {\n\t\t\t\t// Addresses from stack traces point to the next instruction after\n\t\t\t\t// each call. Adjust by -1 to land somewhere on the actual call.\n\t\t\t\taddr--\n\t\t\t\tloc := locs[addr]\n\t\t\t\tif locs[addr] == nil {\n\t\t\t\t\tloc = &Location{\n\t\t\t\t\t\tAddress: addr,\n\t\t\t\t\t}\n\t\t\t\t\tp.Location = append(p.Location, loc)\n\t\t\t\t\tlocs[addr] = loc\n\t\t\t\t}\n\t\t\t\tsloc = append(sloc, loc)\n\t\t\t}\n\t\t\tp.Sample = append(p.Sample, &Sample{\n\t\t\t\tValue: value,\n\t\t\t\tLocation: sloc,\n\t\t\t})\n\t\t}\n\t\tif !s.Scan() {\n\t\t\tbreak\n\t\t}\n\t}\n\tif err := s.Err(); err != nil {\n\t\treturn nil, err\n\t}\n\n\tif err := parseAdditionalSections(s, p); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn p, nil\n}\n\n// parseContentionSample parses a single row from a contention profile\n// into a new Sample.\nfunc parseContentionSample(line string, period, cpuHz int64) (value []int64, addrs []uint64, err error) {\n\tsampleData := contentionSampleRE.FindStringSubmatch(line)\n\tif sampleData == nil {\n\t\treturn nil, nil, errUnrecognized\n\t}\n\n\tv1, err := strconv.ParseInt(sampleData[1], 10, 64)\n\tif err != nil {\n\t\treturn nil, nil, fmt.Errorf(\"malformed sample: %s: %v\", line, err)\n\t}\n\tv2, err := strconv.ParseInt(sampleData[2], 10, 64)\n\tif err != nil {\n\t\treturn nil, nil, fmt.Errorf(\"malformed sample: %s: %v\", line, err)\n\t}\n\n\t// Unsample values if period and cpuHz are available.\n\t// - Delays are scaled to cycles and then to nanoseconds.\n\t// - Contentions are scaled to cycles.\n\tif period > 0 {\n\t\tif cpuHz > 0 {\n\t\t\tcpuGHz := float64(cpuHz) / 1e9\n\t\t\tv1 = int64(float64(v1) * float64(period) / cpuGHz)\n\t\t}\n\t\tv2 = v2 * period\n\t}\n\n\tvalue = []int64{v2, v1}\n\taddrs, err = parseHexAddresses(sampleData[3])\n\tif err != nil {\n\t\treturn nil, nil, fmt.Errorf(\"malformed sample: %s: %v\", line, err)\n\t}\n\n\treturn value, addrs, nil\n}\n\n// parseThread parses a Threadz profile and returns a new Profile.\nfunc parseThread(b []byte) (*Profile, error) {\n\ts := bufio.NewScanner(bytes.NewBuffer(b))\n\t// Skip past comments and empty lines seeking a real header.\n\tfor s.Scan() && isSpaceOrComment(s.Text()) {\n\t}\n\n\tline := s.Text()\n\tif m := threadzStartRE.FindStringSubmatch(line); m != nil {\n\t\t// Advance over initial comments until first stack trace.\n\t\tfor s.Scan() {\n\t\t\tif line = s.Text(); isMemoryMapSentinel(line) || strings.HasPrefix(line, \"-\") {\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t} else if t := threadStartRE.FindStringSubmatch(line); len(t) != 4 {\n\t\treturn nil, errUnrecognized\n\t}\n\n\tp := &Profile{\n\t\tSampleType: []*ValueType{{Type: \"thread\", Unit: \"count\"}},\n\t\tPeriodType: &ValueType{Type: \"thread\", Unit: \"count\"},\n\t\tPeriod: 1,\n\t}\n\n\tlocs := make(map[uint64]*Location)\n\t// Recognize each thread and populate profile samples.\n\tfor !isMemoryMapSentinel(line) {\n\t\tif strings.HasPrefix(line, \"---- no stack trace for\") {\n\t\t\tbreak\n\t\t}\n\t\tif t := threadStartRE.FindStringSubmatch(line); len(t) != 4 {\n\t\t\treturn nil, errUnrecognized\n\t\t}\n\n\t\tvar addrs []uint64\n\t\tvar err error\n\t\tline, addrs, err = parseThreadSample(s)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif len(addrs) == 0 {\n\t\t\t// We got a --same as previous threads--. Bump counters.\n\t\t\tif len(p.Sample) > 0 {\n\t\t\t\ts := p.Sample[len(p.Sample)-1]\n\t\t\t\ts.Value[0]++\n\t\t\t}\n\t\t\tcontinue\n\t\t}\n\n\t\tvar sloc []*Location\n\t\tfor i, addr := range addrs {\n\t\t\t// Addresses from stack traces point to the next instruction after\n\t\t\t// each call. Adjust by -1 to land somewhere on the actual call\n\t\t\t// (except for the leaf, which is not a call).\n\t\t\tif i > 0 {\n\t\t\t\taddr--\n\t\t\t}\n\t\t\tloc := locs[addr]\n\t\t\tif locs[addr] == nil {\n\t\t\t\tloc = &Location{\n\t\t\t\t\tAddress: addr,\n\t\t\t\t}\n\t\t\t\tp.Location = append(p.Location, loc)\n\t\t\t\tlocs[addr] = loc\n\t\t\t}\n\t\t\tsloc = append(sloc, loc)\n\t\t}\n\n\t\tp.Sample = append(p.Sample, &Sample{\n\t\t\tValue: []int64{1},\n\t\t\tLocation: sloc,\n\t\t})\n\t}\n\n\tif err := parseAdditionalSections(s, p); err != nil {\n\t\treturn nil, err\n\t}\n\n\tcleanupDuplicateLocations(p)\n\treturn p, nil\n}\n\n// parseThreadSample parses a symbolized or unsymbolized stack trace.\n// Returns the first line after the traceback, the sample (or nil if\n// it hits a 'same-as-previous' marker) and an error.\nfunc parseThreadSample(s *bufio.Scanner) (nextl string, addrs []uint64, err error) {\n\tvar line string\n\tsameAsPrevious := false\n\tfor s.Scan() {\n\t\tline = strings.TrimSpace(s.Text())\n\t\tif line == \"\" {\n\t\t\tcontinue\n\t\t}\n\n\t\tif strings.HasPrefix(line, \"---\") {\n\t\t\tbreak\n\t\t}\n\t\tif strings.Contains(line, \"same as previous thread\") {\n\t\t\tsameAsPrevious = true\n\t\t\tcontinue\n\t\t}\n\n\t\tcurAddrs, err := parseHexAddresses(line)\n\t\tif err != nil {\n\t\t\treturn \"\", nil, fmt.Errorf(\"malformed sample: %s: %v\", line, err)\n\t\t}\n\t\taddrs = append(addrs, curAddrs...)\n\t}\n\tif err := s.Err(); err != nil {\n\t\treturn \"\", nil, err\n\t}\n\tif sameAsPrevious {\n\t\treturn line, nil, nil\n\t}\n\treturn line, addrs, nil\n}\n\n// parseAdditionalSections parses any additional sections in the\n// profile, ignoring any unrecognized sections.\nfunc parseAdditionalSections(s *bufio.Scanner, p *Profile) error {\n\tfor !isMemoryMapSentinel(s.Text()) && s.Scan() {\n\t}\n\tif err := s.Err(); err != nil {\n\t\treturn err\n\t}\n\treturn p.ParseMemoryMapFromScanner(s)\n}\n\n// ParseProcMaps parses a memory map in the format of /proc/self/maps.\n// ParseMemoryMap should be called after setting on a profile to\n// associate locations to the corresponding mapping based on their\n// address.\nfunc ParseProcMaps(rd io.Reader) ([]*Mapping, error) {\n\ts := bufio.NewScanner(rd)\n\treturn parseProcMapsFromScanner(s)\n}\n\nfunc parseProcMapsFromScanner(s *bufio.Scanner) ([]*Mapping, error) {\n\tvar mapping []*Mapping\n\n\tvar attrs []string\n\tconst delimiter = \"=\"\n\tr := strings.NewReplacer()\n\tfor s.Scan() {\n\t\tline := r.Replace(removeLoggingInfo(s.Text()))\n\t\tm, err := parseMappingEntry(line)\n\t\tif err != nil {\n\t\t\tif err == errUnrecognized {\n\t\t\t\t// Recognize assignments of the form: attr=value, and replace\n\t\t\t\t// $attr with value on subsequent mappings.\n\t\t\t\tif attr := strings.SplitN(line, delimiter, 2); len(attr) == 2 {\n\t\t\t\t\tattrs = append(attrs, \"$\"+strings.TrimSpace(attr[0]), strings.TrimSpace(attr[1]))\n\t\t\t\t\tr = strings.NewReplacer(attrs...)\n\t\t\t\t}\n\t\t\t\t// Ignore any unrecognized entries\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\treturn nil, err\n\t\t}\n\t\tif m == nil {\n\t\t\tcontinue\n\t\t}\n\t\tmapping = append(mapping, m)\n\t}\n\tif err := s.Err(); err != nil {\n\t\treturn nil, err\n\t}\n\treturn mapping, nil\n}\n\n// removeLoggingInfo detects and removes log prefix entries generated\n// by the glog package. If no logging prefix is detected, the string\n// is returned unmodified.\nfunc removeLoggingInfo(line string) string {\n\tif match := logInfoRE.FindStringIndex(line); match != nil {\n\t\treturn line[match[1]:]\n\t}\n\treturn line\n}\n\n// ParseMemoryMap parses a memory map in the format of\n// /proc/self/maps, and overrides the mappings in the current profile.\n// It renumbers the samples and locations in the profile correspondingly.\nfunc (p *Profile) ParseMemoryMap(rd io.Reader) error {\n\treturn p.ParseMemoryMapFromScanner(bufio.NewScanner(rd))\n}\n\n// ParseMemoryMapFromScanner parses a memory map in the format of\n// /proc/self/maps or a variety of legacy format, and overrides the\n// mappings in the current profile. It renumbers the samples and\n// locations in the profile correspondingly.\nfunc (p *Profile) ParseMemoryMapFromScanner(s *bufio.Scanner) error {\n\tmapping, err := parseProcMapsFromScanner(s)\n\tif err != nil {\n\t\treturn err\n\t}\n\tp.Mapping = append(p.Mapping, mapping...)\n\tp.massageMappings()\n\tp.remapLocationIDs()\n\tp.remapFunctionIDs()\n\tp.remapMappingIDs()\n\treturn nil\n}\n\nfunc parseMappingEntry(l string) (*Mapping, error) {\n\tvar start, end, perm, file, offset, buildID string\n\tif me := procMapsRE.FindStringSubmatch(l); len(me) == 6 {\n\t\tstart, end, perm, offset, file = me[1], me[2], me[3], me[4], me[5]\n\t} else if me := briefMapsRE.FindStringSubmatch(l); len(me) == 7 {\n\t\tstart, end, perm, file, offset, buildID = me[1], me[2], me[3], me[4], me[5], me[6]\n\t} else {\n\t\treturn nil, errUnrecognized\n\t}\n\n\tvar err error\n\tmapping := &Mapping{\n\t\tFile: file,\n\t\tBuildID: buildID,\n\t}\n\tif perm != \"\" && !strings.Contains(perm, \"x\") {\n\t\t// Skip non-executable entries.\n\t\treturn nil, nil\n\t}\n\tif mapping.Start, err = strconv.ParseUint(start, 16, 64); err != nil {\n\t\treturn nil, errUnrecognized\n\t}\n\tif mapping.Limit, err = strconv.ParseUint(end, 16, 64); err != nil {\n\t\treturn nil, errUnrecognized\n\t}\n\tif offset != \"\" {\n\t\tif mapping.Offset, err = strconv.ParseUint(offset, 16, 64); err != nil {\n\t\t\treturn nil, errUnrecognized\n\t\t}\n\t}\n\treturn mapping, nil\n}\n\nvar memoryMapSentinels = []string{\n\t\"--- Memory map: ---\",\n\t\"MAPPED_LIBRARIES:\",\n}\n\n// isMemoryMapSentinel returns true if the string contains one of the\n// known sentinels for memory map information.\nfunc isMemoryMapSentinel(line string) bool {\n\tfor _, s := range memoryMapSentinels {\n\t\tif strings.Contains(line, s) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (p *Profile) addLegacyFrameInfo() {\n\tswitch {\n\tcase isProfileType(p, heapzSampleTypes):\n\t\tp.DropFrames, p.KeepFrames = allocRxStr, allocSkipRxStr\n\tcase isProfileType(p, contentionzSampleTypes):\n\t\tp.DropFrames, p.KeepFrames = lockRxStr, \"\"\n\tdefault:\n\t\tp.DropFrames, p.KeepFrames = cpuProfilerRxStr, \"\"\n\t}\n}\n\nvar heapzSampleTypes = [][]string{\n\t{\"allocations\", \"size\"}, // early Go pprof profiles\n\t{\"objects\", \"space\"},\n\t{\"inuse_objects\", \"inuse_space\"},\n\t{\"alloc_objects\", \"alloc_space\"},\n\t{\"alloc_objects\", \"alloc_space\", \"inuse_objects\", \"inuse_space\"}, // Go pprof legacy profiles\n}\nvar contentionzSampleTypes = [][]string{\n\t{\"contentions\", \"delay\"},\n}\n\nfunc isProfileType(p *Profile, types [][]string) bool {\n\tst := p.SampleType\nnextType:\n\tfor _, t := range types {\n\t\tif len(st) != len(t) {\n\t\t\tcontinue\n\t\t}\n\n\t\tfor i := range st {\n\t\t\tif st[i].Type != t[i] {\n\t\t\t\tcontinue nextType\n\t\t\t}\n\t\t}\n\t\treturn true\n\t}\n\treturn false\n}\n\nvar allocRxStr = strings.Join([]string{\n\t// POSIX entry points.\n\t`calloc`,\n\t`cfree`,\n\t`malloc`,\n\t`free`,\n\t`memalign`,\n\t`do_memalign`,\n\t`(__)?posix_memalign`,\n\t`pvalloc`,\n\t`valloc`,\n\t`realloc`,\n\n\t// TC malloc.\n\t`tcmalloc::.*`,\n\t`tc_calloc`,\n\t`tc_cfree`,\n\t`tc_malloc`,\n\t`tc_free`,\n\t`tc_memalign`,\n\t`tc_posix_memalign`,\n\t`tc_pvalloc`,\n\t`tc_valloc`,\n\t`tc_realloc`,\n\t`tc_new`,\n\t`tc_delete`,\n\t`tc_newarray`,\n\t`tc_deletearray`,\n\t`tc_new_nothrow`,\n\t`tc_newarray_nothrow`,\n\n\t// Memory-allocation routines on OS X.\n\t`malloc_zone_malloc`,\n\t`malloc_zone_calloc`,\n\t`malloc_zone_valloc`,\n\t`malloc_zone_realloc`,\n\t`malloc_zone_memalign`,\n\t`malloc_zone_free`,\n\n\t// Go runtime\n\t`runtime\\..*`,\n\n\t// Other misc. memory allocation routines\n\t`BaseArena::.*`,\n\t`(::)?do_malloc_no_errno`,\n\t`(::)?do_malloc_pages`,\n\t`(::)?do_malloc`,\n\t`DoSampledAllocation`,\n\t`MallocedMemBlock::MallocedMemBlock`,\n\t`_M_allocate`,\n\t`__builtin_(vec_)?delete`,\n\t`__builtin_(vec_)?new`,\n\t`__gnu_cxx::new_allocator::allocate`,\n\t`__libc_malloc`,\n\t`__malloc_alloc_template::allocate`,\n\t`allocate`,\n\t`cpp_alloc`,\n\t`operator new(\\[\\])?`,\n\t`simple_alloc::allocate`,\n}, `|`)\n\nvar allocSkipRxStr = strings.Join([]string{\n\t// Preserve Go runtime frames that appear in the middle/bottom of\n\t// the stack.\n\t`runtime\\.panic`,\n\t`runtime\\.reflectcall`,\n\t`runtime\\.call[0-9]*`,\n}, `|`)\n\nvar cpuProfilerRxStr = strings.Join([]string{\n\t`ProfileData::Add`,\n\t`ProfileData::prof_handler`,\n\t`CpuProfiler::prof_handler`,\n\t`__pthread_sighandler`,\n\t`__restore`,\n}, `|`)\n\nvar lockRxStr = strings.Join([]string{\n\t`RecordLockProfileData`,\n\t`(base::)?RecordLockProfileData.*`,\n\t`(base::)?SubmitMutexProfileData.*`,\n\t`(base::)?SubmitSpinLockProfileData.*`,\n\t`(base::Mutex::)?AwaitCommon.*`,\n\t`(base::Mutex::)?Unlock.*`,\n\t`(base::Mutex::)?UnlockSlow.*`,\n\t`(base::Mutex::)?ReaderUnlock.*`,\n\t`(base::MutexLock::)?~MutexLock.*`,\n\t`(Mutex::)?AwaitCommon.*`,\n\t`(Mutex::)?Unlock.*`,\n\t`(Mutex::)?UnlockSlow.*`,\n\t`(Mutex::)?ReaderUnlock.*`,\n\t`(MutexLock::)?~MutexLock.*`,\n\t`(SpinLock::)?Unlock.*`,\n\t`(SpinLock::)?SlowUnlock.*`,\n\t`(SpinLockHolder::)?~SpinLockHolder.*`,\n}, `|`)\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/merge.go",
"content": "// Copyright 2014 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage profile\n\nimport (\n\t\"encoding/binary\"\n\t\"fmt\"\n\t\"slices\"\n\t\"sort\"\n\t\"strconv\"\n\t\"strings\"\n)\n\n// Compact performs garbage collection on a profile to remove any\n// unreferenced fields. This is useful to reduce the size of a profile\n// after samples or locations have been removed.\nfunc (p *Profile) Compact() *Profile {\n\tp, _ = Merge([]*Profile{p})\n\treturn p\n}\n\n// Merge merges all the profiles in profs into a single Profile.\n// Returns a new profile independent of the input profiles. The merged\n// profile is compacted to eliminate unused samples, locations,\n// functions and mappings. Profiles must have identical profile sample\n// and period types or the merge will fail. profile.Period of the\n// resulting profile will be the maximum of all profiles, and\n// profile.TimeNanos will be the earliest nonzero one. Merges are\n// associative with the caveat of the first profile having some\n// specialization in how headers are combined. There may be other\n// subtleties now or in the future regarding associativity.\nfunc Merge(srcs []*Profile) (*Profile, error) {\n\tif len(srcs) == 0 {\n\t\treturn nil, fmt.Errorf(\"no profiles to merge\")\n\t}\n\tp, err := combineHeaders(srcs)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tpm := &profileMerger{\n\t\tp: p,\n\t\tsamples: make(map[sampleKey]*Sample, len(srcs[0].Sample)),\n\t\tlocations: make(map[locationKey]*Location, len(srcs[0].Location)),\n\t\tfunctions: make(map[functionKey]*Function, len(srcs[0].Function)),\n\t\tmappings: make(map[mappingKey]*Mapping, len(srcs[0].Mapping)),\n\t}\n\n\tfor _, src := range srcs {\n\t\t// Clear the profile-specific hash tables\n\t\tpm.locationsByID = makeLocationIDMap(len(src.Location))\n\t\tpm.functionsByID = make(map[uint64]*Function, len(src.Function))\n\t\tpm.mappingsByID = make(map[uint64]mapInfo, len(src.Mapping))\n\n\t\tif len(pm.mappings) == 0 && len(src.Mapping) > 0 {\n\t\t\t// The Mapping list has the property that the first mapping\n\t\t\t// represents the main binary. Take the first Mapping we see,\n\t\t\t// otherwise the operations below will add mappings in an\n\t\t\t// arbitrary order.\n\t\t\tpm.mapMapping(src.Mapping[0])\n\t\t}\n\n\t\tfor _, s := range src.Sample {\n\t\t\tif !isZeroSample(s) {\n\t\t\t\tpm.mapSample(s)\n\t\t\t}\n\t\t}\n\t}\n\n\tif slices.ContainsFunc(p.Sample, isZeroSample) {\n\t\t// If there are any zero samples, re-merge the profile to GC\n\t\t// them.\n\t\treturn Merge([]*Profile{p})\n\t}\n\n\treturn p, nil\n}\n\n// Normalize normalizes the source profile by multiplying each value in profile by the\n// ratio of the sum of the base profile's values of that sample type to the sum of the\n// source profile's value of that sample type.\nfunc (p *Profile) Normalize(pb *Profile) error {\n\n\tif err := p.compatible(pb); err != nil {\n\t\treturn err\n\t}\n\n\tbaseVals := make([]int64, len(p.SampleType))\n\tfor _, s := range pb.Sample {\n\t\tfor i, v := range s.Value {\n\t\t\tbaseVals[i] += v\n\t\t}\n\t}\n\n\tsrcVals := make([]int64, len(p.SampleType))\n\tfor _, s := range p.Sample {\n\t\tfor i, v := range s.Value {\n\t\t\tsrcVals[i] += v\n\t\t}\n\t}\n\n\tnormScale := make([]float64, len(baseVals))\n\tfor i := range baseVals {\n\t\tif srcVals[i] == 0 {\n\t\t\tnormScale[i] = 0.0\n\t\t} else {\n\t\t\tnormScale[i] = float64(baseVals[i]) / float64(srcVals[i])\n\t\t}\n\t}\n\tp.ScaleN(normScale)\n\treturn nil\n}\n\nfunc isZeroSample(s *Sample) bool {\n\tfor _, v := range s.Value {\n\t\tif v != 0 {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\ntype profileMerger struct {\n\tp *Profile\n\n\t// Memoization tables within a profile.\n\tlocationsByID locationIDMap\n\tfunctionsByID map[uint64]*Function\n\tmappingsByID map[uint64]mapInfo\n\n\t// Memoization tables for profile entities.\n\tsamples map[sampleKey]*Sample\n\tlocations map[locationKey]*Location\n\tfunctions map[functionKey]*Function\n\tmappings map[mappingKey]*Mapping\n}\n\ntype mapInfo struct {\n\tm *Mapping\n\toffset int64\n}\n\nfunc (pm *profileMerger) mapSample(src *Sample) *Sample {\n\t// Check memoization table\n\tk := pm.sampleKey(src)\n\tif ss, ok := pm.samples[k]; ok {\n\t\tfor i, v := range src.Value {\n\t\t\tss.Value[i] += v\n\t\t}\n\t\treturn ss\n\t}\n\n\t// Make new sample.\n\ts := &Sample{\n\t\tLocation: make([]*Location, len(src.Location)),\n\t\tValue: make([]int64, len(src.Value)),\n\t\tLabel: make(map[string][]string, len(src.Label)),\n\t\tNumLabel: make(map[string][]int64, len(src.NumLabel)),\n\t\tNumUnit: make(map[string][]string, len(src.NumLabel)),\n\t}\n\tfor i, l := range src.Location {\n\t\ts.Location[i] = pm.mapLocation(l)\n\t}\n\tfor k, v := range src.Label {\n\t\tvv := make([]string, len(v))\n\t\tcopy(vv, v)\n\t\ts.Label[k] = vv\n\t}\n\tfor k, v := range src.NumLabel {\n\t\tu := src.NumUnit[k]\n\t\tvv := make([]int64, len(v))\n\t\tuu := make([]string, len(u))\n\t\tcopy(vv, v)\n\t\tcopy(uu, u)\n\t\ts.NumLabel[k] = vv\n\t\ts.NumUnit[k] = uu\n\t}\n\tcopy(s.Value, src.Value)\n\tpm.samples[k] = s\n\tpm.p.Sample = append(pm.p.Sample, s)\n\treturn s\n}\n\nfunc (pm *profileMerger) sampleKey(sample *Sample) sampleKey {\n\t// Accumulate contents into a string.\n\tvar buf strings.Builder\n\tbuf.Grow(64) // Heuristic to avoid extra allocs\n\n\t// encode a number\n\tputNumber := func(v uint64) {\n\t\tvar num [binary.MaxVarintLen64]byte\n\t\tn := binary.PutUvarint(num[:], v)\n\t\tbuf.Write(num[:n])\n\t}\n\n\t// encode a string prefixed with its length.\n\tputDelimitedString := func(s string) {\n\t\tputNumber(uint64(len(s)))\n\t\tbuf.WriteString(s)\n\t}\n\n\tfor _, l := range sample.Location {\n\t\t// Get the location in the merged profile, which may have a different ID.\n\t\tif loc := pm.mapLocation(l); loc != nil {\n\t\t\tputNumber(loc.ID)\n\t\t}\n\t}\n\tputNumber(0) // Delimiter\n\n\tfor _, l := range sortedKeys1(sample.Label) {\n\t\tputDelimitedString(l)\n\t\tvalues := sample.Label[l]\n\t\tputNumber(uint64(len(values)))\n\t\tfor _, v := range values {\n\t\t\tputDelimitedString(v)\n\t\t}\n\t}\n\n\tfor _, l := range sortedKeys2(sample.NumLabel) {\n\t\tputDelimitedString(l)\n\t\tvalues := sample.NumLabel[l]\n\t\tputNumber(uint64(len(values)))\n\t\tfor _, v := range values {\n\t\t\tputNumber(uint64(v))\n\t\t}\n\t\tunits := sample.NumUnit[l]\n\t\tputNumber(uint64(len(units)))\n\t\tfor _, v := range units {\n\t\t\tputDelimitedString(v)\n\t\t}\n\t}\n\n\treturn sampleKey(buf.String())\n}\n\ntype sampleKey string\n\n// sortedKeys1 returns the sorted keys found in a string->[]string map.\n//\n// Note: this is currently non-generic since github pprof runs golint,\n// which does not support generics. When that issue is fixed, it can\n// be merged with sortedKeys2 and made into a generic function.\nfunc sortedKeys1(m map[string][]string) []string {\n\tif len(m) == 0 {\n\t\treturn nil\n\t}\n\tkeys := make([]string, 0, len(m))\n\tfor k := range m {\n\t\tkeys = append(keys, k)\n\t}\n\tsort.Strings(keys)\n\treturn keys\n}\n\n// sortedKeys2 returns the sorted keys found in a string->[]int64 map.\n//\n// Note: this is currently non-generic since github pprof runs golint,\n// which does not support generics. When that issue is fixed, it can\n// be merged with sortedKeys1 and made into a generic function.\nfunc sortedKeys2(m map[string][]int64) []string {\n\tif len(m) == 0 {\n\t\treturn nil\n\t}\n\tkeys := make([]string, 0, len(m))\n\tfor k := range m {\n\t\tkeys = append(keys, k)\n\t}\n\tsort.Strings(keys)\n\treturn keys\n}\n\nfunc (pm *profileMerger) mapLocation(src *Location) *Location {\n\tif src == nil {\n\t\treturn nil\n\t}\n\n\tif l := pm.locationsByID.get(src.ID); l != nil {\n\t\treturn l\n\t}\n\n\tmi := pm.mapMapping(src.Mapping)\n\tl := &Location{\n\t\tID: uint64(len(pm.p.Location) + 1),\n\t\tMapping: mi.m,\n\t\tAddress: uint64(int64(src.Address) + mi.offset),\n\t\tLine: make([]Line, len(src.Line)),\n\t\tIsFolded: src.IsFolded,\n\t}\n\tfor i, ln := range src.Line {\n\t\tl.Line[i] = pm.mapLine(ln)\n\t}\n\t// Check memoization table. Must be done on the remapped location to\n\t// account for the remapped mapping ID.\n\tk := l.key()\n\tif ll, ok := pm.locations[k]; ok {\n\t\tpm.locationsByID.set(src.ID, ll)\n\t\treturn ll\n\t}\n\tpm.locationsByID.set(src.ID, l)\n\tpm.locations[k] = l\n\tpm.p.Location = append(pm.p.Location, l)\n\treturn l\n}\n\n// key generates locationKey to be used as a key for maps.\nfunc (l *Location) key() locationKey {\n\tkey := locationKey{\n\t\taddr: l.Address,\n\t\tisFolded: l.IsFolded,\n\t}\n\tif l.Mapping != nil {\n\t\t// Normalizes address to handle address space randomization.\n\t\tkey.addr -= l.Mapping.Start\n\t\tkey.mappingID = l.Mapping.ID\n\t}\n\tlines := make([]string, len(l.Line)*3)\n\tfor i, line := range l.Line {\n\t\tif line.Function != nil {\n\t\t\tlines[i*2] = strconv.FormatUint(line.Function.ID, 16)\n\t\t}\n\t\tlines[i*2+1] = strconv.FormatInt(line.Line, 16)\n\t\tlines[i*2+2] = strconv.FormatInt(line.Column, 16)\n\t}\n\tkey.lines = strings.Join(lines, \"|\")\n\treturn key\n}\n\ntype locationKey struct {\n\taddr, mappingID uint64\n\tlines string\n\tisFolded bool\n}\n\nfunc (pm *profileMerger) mapMapping(src *Mapping) mapInfo {\n\tif src == nil {\n\t\treturn mapInfo{}\n\t}\n\n\tif mi, ok := pm.mappingsByID[src.ID]; ok {\n\t\treturn mi\n\t}\n\n\t// Check memoization tables.\n\tmk := src.key()\n\tif m, ok := pm.mappings[mk]; ok {\n\t\tmi := mapInfo{m, int64(m.Start) - int64(src.Start)}\n\t\tpm.mappingsByID[src.ID] = mi\n\t\treturn mi\n\t}\n\tm := &Mapping{\n\t\tID: uint64(len(pm.p.Mapping) + 1),\n\t\tStart: src.Start,\n\t\tLimit: src.Limit,\n\t\tOffset: src.Offset,\n\t\tFile: src.File,\n\t\tKernelRelocationSymbol: src.KernelRelocationSymbol,\n\t\tBuildID: src.BuildID,\n\t\tHasFunctions: src.HasFunctions,\n\t\tHasFilenames: src.HasFilenames,\n\t\tHasLineNumbers: src.HasLineNumbers,\n\t\tHasInlineFrames: src.HasInlineFrames,\n\t}\n\tpm.p.Mapping = append(pm.p.Mapping, m)\n\n\t// Update memoization tables.\n\tpm.mappings[mk] = m\n\tmi := mapInfo{m, 0}\n\tpm.mappingsByID[src.ID] = mi\n\treturn mi\n}\n\n// key generates encoded strings of Mapping to be used as a key for\n// maps.\nfunc (m *Mapping) key() mappingKey {\n\t// Normalize addresses to handle address space randomization.\n\t// Round up to next 4K boundary to avoid minor discrepancies.\n\tconst mapsizeRounding = 0x1000\n\n\tsize := m.Limit - m.Start\n\tsize = size + mapsizeRounding - 1\n\tsize = size - (size % mapsizeRounding)\n\tkey := mappingKey{\n\t\tsize: size,\n\t\toffset: m.Offset,\n\t}\n\n\tswitch {\n\tcase m.BuildID != \"\":\n\t\tkey.buildIDOrFile = m.BuildID\n\tcase m.File != \"\":\n\t\tkey.buildIDOrFile = m.File\n\tdefault:\n\t\t// A mapping containing neither build ID nor file name is a fake mapping. A\n\t\t// key with empty buildIDOrFile is used for fake mappings so that they are\n\t\t// treated as the same mapping during merging.\n\t}\n\treturn key\n}\n\ntype mappingKey struct {\n\tsize, offset uint64\n\tbuildIDOrFile string\n}\n\nfunc (pm *profileMerger) mapLine(src Line) Line {\n\tln := Line{\n\t\tFunction: pm.mapFunction(src.Function),\n\t\tLine: src.Line,\n\t\tColumn: src.Column,\n\t}\n\treturn ln\n}\n\nfunc (pm *profileMerger) mapFunction(src *Function) *Function {\n\tif src == nil {\n\t\treturn nil\n\t}\n\tif f, ok := pm.functionsByID[src.ID]; ok {\n\t\treturn f\n\t}\n\tk := src.key()\n\tif f, ok := pm.functions[k]; ok {\n\t\tpm.functionsByID[src.ID] = f\n\t\treturn f\n\t}\n\tf := &Function{\n\t\tID: uint64(len(pm.p.Function) + 1),\n\t\tName: src.Name,\n\t\tSystemName: src.SystemName,\n\t\tFilename: src.Filename,\n\t\tStartLine: src.StartLine,\n\t}\n\tpm.functions[k] = f\n\tpm.functionsByID[src.ID] = f\n\tpm.p.Function = append(pm.p.Function, f)\n\treturn f\n}\n\n// key generates a struct to be used as a key for maps.\nfunc (f *Function) key() functionKey {\n\treturn functionKey{\n\t\tf.StartLine,\n\t\tf.Name,\n\t\tf.SystemName,\n\t\tf.Filename,\n\t}\n}\n\ntype functionKey struct {\n\tstartLine int64\n\tname, systemName, fileName string\n}\n\n// combineHeaders checks that all profiles can be merged and returns\n// their combined profile.\nfunc combineHeaders(srcs []*Profile) (*Profile, error) {\n\tfor _, s := range srcs[1:] {\n\t\tif err := srcs[0].compatible(s); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\tvar timeNanos, durationNanos, period int64\n\tvar comments []string\n\tseenComments := map[string]bool{}\n\tvar docURL string\n\tvar defaultSampleType string\n\tfor _, s := range srcs {\n\t\tif timeNanos == 0 || s.TimeNanos < timeNanos {\n\t\t\ttimeNanos = s.TimeNanos\n\t\t}\n\t\tdurationNanos += s.DurationNanos\n\t\tif period == 0 || period < s.Period {\n\t\t\tperiod = s.Period\n\t\t}\n\t\tfor _, c := range s.Comments {\n\t\t\tif seen := seenComments[c]; !seen {\n\t\t\t\tcomments = append(comments, c)\n\t\t\t\tseenComments[c] = true\n\t\t\t}\n\t\t}\n\t\tif defaultSampleType == \"\" {\n\t\t\tdefaultSampleType = s.DefaultSampleType\n\t\t}\n\t\tif docURL == \"\" {\n\t\t\tdocURL = s.DocURL\n\t\t}\n\t}\n\n\tp := &Profile{\n\t\tSampleType: make([]*ValueType, len(srcs[0].SampleType)),\n\n\t\tDropFrames: srcs[0].DropFrames,\n\t\tKeepFrames: srcs[0].KeepFrames,\n\n\t\tTimeNanos: timeNanos,\n\t\tDurationNanos: durationNanos,\n\t\tPeriodType: srcs[0].PeriodType,\n\t\tPeriod: period,\n\n\t\tComments: comments,\n\t\tDefaultSampleType: defaultSampleType,\n\t\tDocURL: docURL,\n\t}\n\tcopy(p.SampleType, srcs[0].SampleType)\n\treturn p, nil\n}\n\n// compatible determines if two profiles can be compared/merged.\n// returns nil if the profiles are compatible; otherwise an error with\n// details on the incompatibility.\nfunc (p *Profile) compatible(pb *Profile) error {\n\tif !equalValueType(p.PeriodType, pb.PeriodType) {\n\t\treturn fmt.Errorf(\"incompatible period types %v and %v\", p.PeriodType, pb.PeriodType)\n\t}\n\n\tif len(p.SampleType) != len(pb.SampleType) {\n\t\treturn fmt.Errorf(\"incompatible sample types %v and %v\", p.SampleType, pb.SampleType)\n\t}\n\n\tfor i := range p.SampleType {\n\t\tif !equalValueType(p.SampleType[i], pb.SampleType[i]) {\n\t\t\treturn fmt.Errorf(\"incompatible sample types %v and %v\", p.SampleType, pb.SampleType)\n\t\t}\n\t}\n\treturn nil\n}\n\n// equalValueType returns true if the two value types are semantically\n// equal. It ignores the internal fields used during encode/decode.\nfunc equalValueType(st1, st2 *ValueType) bool {\n\treturn st1.Type == st2.Type && st1.Unit == st2.Unit\n}\n\n// locationIDMap is like a map[uint64]*Location, but provides efficiency for\n// ids that are densely numbered, which is often the case.\ntype locationIDMap struct {\n\tdense []*Location // indexed by id for id < len(dense)\n\tsparse map[uint64]*Location // indexed by id for id >= len(dense)\n}\n\nfunc makeLocationIDMap(n int) locationIDMap {\n\treturn locationIDMap{\n\t\tdense: make([]*Location, n),\n\t\tsparse: map[uint64]*Location{},\n\t}\n}\n\nfunc (lm locationIDMap) get(id uint64) *Location {\n\tif id < uint64(len(lm.dense)) {\n\t\treturn lm.dense[int(id)]\n\t}\n\treturn lm.sparse[id]\n}\n\nfunc (lm locationIDMap) set(id uint64, loc *Location) {\n\tif id < uint64(len(lm.dense)) {\n\t\tlm.dense[id] = loc\n\t\treturn\n\t}\n\tlm.sparse[id] = loc\n}\n\n// CompatibilizeSampleTypes makes profiles compatible to be compared/merged. It\n// keeps sample types that appear in all profiles only and drops/reorders the\n// sample types as necessary.\n//\n// In the case of sample types order is not the same for given profiles the\n// order is derived from the first profile.\n//\n// Profiles are modified in-place.\n//\n// It returns an error if the sample type's intersection is empty.\nfunc CompatibilizeSampleTypes(ps []*Profile) error {\n\tsTypes := commonSampleTypes(ps)\n\tif len(sTypes) == 0 {\n\t\treturn fmt.Errorf(\"profiles have empty common sample type list\")\n\t}\n\tfor _, p := range ps {\n\t\tif err := compatibilizeSampleTypes(p, sTypes); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\n// commonSampleTypes returns sample types that appear in all profiles in the\n// order how they ordered in the first profile.\nfunc commonSampleTypes(ps []*Profile) []string {\n\tif len(ps) == 0 {\n\t\treturn nil\n\t}\n\tsTypes := map[string]int{}\n\tfor _, p := range ps {\n\t\tfor _, st := range p.SampleType {\n\t\t\tsTypes[st.Type]++\n\t\t}\n\t}\n\tvar res []string\n\tfor _, st := range ps[0].SampleType {\n\t\tif sTypes[st.Type] == len(ps) {\n\t\t\tres = append(res, st.Type)\n\t\t}\n\t}\n\treturn res\n}\n\n// compatibilizeSampleTypes drops sample types that are not present in sTypes\n// list and reorder them if needed.\n//\n// It sets DefaultSampleType to sType[0] if it is not in sType list.\n//\n// It assumes that all sample types from the sTypes list are present in the\n// given profile otherwise it returns an error.\nfunc compatibilizeSampleTypes(p *Profile, sTypes []string) error {\n\tif len(sTypes) == 0 {\n\t\treturn fmt.Errorf(\"sample type list is empty\")\n\t}\n\tdefaultSampleType := sTypes[0]\n\treMap, needToModify := make([]int, len(sTypes)), false\n\tfor i, st := range sTypes {\n\t\tif st == p.DefaultSampleType {\n\t\t\tdefaultSampleType = p.DefaultSampleType\n\t\t}\n\t\tidx := searchValueType(p.SampleType, st)\n\t\tif idx < 0 {\n\t\t\treturn fmt.Errorf(\"%q sample type is not found in profile\", st)\n\t\t}\n\t\treMap[i] = idx\n\t\tif idx != i {\n\t\t\tneedToModify = true\n\t\t}\n\t}\n\tif !needToModify && len(sTypes) == len(p.SampleType) {\n\t\treturn nil\n\t}\n\tp.DefaultSampleType = defaultSampleType\n\toldSampleTypes := p.SampleType\n\tp.SampleType = make([]*ValueType, len(sTypes))\n\tfor i, idx := range reMap {\n\t\tp.SampleType[i] = oldSampleTypes[idx]\n\t}\n\tvalues := make([]int64, len(sTypes))\n\tfor _, s := range p.Sample {\n\t\tfor i, idx := range reMap {\n\t\t\tvalues[i] = s.Value[idx]\n\t\t}\n\t\ts.Value = s.Value[:len(values)]\n\t\tcopy(s.Value, values)\n\t}\n\treturn nil\n}\n\nfunc searchValueType(vts []*ValueType, s string) int {\n\tfor i, vt := range vts {\n\t\tif vt.Type == s {\n\t\t\treturn i\n\t\t}\n\t}\n\treturn -1\n}\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/profile.go",
"content": "// Copyright 2014 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// Package profile provides a representation of profile.proto and\n// methods to encode/decode profiles in this format.\npackage profile\n\nimport (\n\t\"bytes\"\n\t\"compress/gzip\"\n\t\"fmt\"\n\t\"io\"\n\t\"math\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"slices\"\n\t\"sort\"\n\t\"strings\"\n\t\"sync\"\n\t\"time\"\n)\n\n// Profile is an in-memory representation of profile.proto.\ntype Profile struct {\n\tSampleType []*ValueType\n\tDefaultSampleType string\n\tSample []*Sample\n\tMapping []*Mapping\n\tLocation []*Location\n\tFunction []*Function\n\tComments []string\n\tDocURL string\n\n\tDropFrames string\n\tKeepFrames string\n\n\tTimeNanos int64\n\tDurationNanos int64\n\tPeriodType *ValueType\n\tPeriod int64\n\n\t// The following fields are modified during encoding and copying,\n\t// so are protected by a Mutex.\n\tencodeMu sync.Mutex\n\n\tcommentX []int64\n\tdocURLX int64\n\tdropFramesX int64\n\tkeepFramesX int64\n\tstringTable []string\n\tdefaultSampleTypeX int64\n}\n\n// ValueType corresponds to Profile.ValueType\ntype ValueType struct {\n\tType string // cpu, wall, inuse_space, etc\n\tUnit string // seconds, nanoseconds, bytes, etc\n\n\ttypeX int64\n\tunitX int64\n}\n\n// Sample corresponds to Profile.Sample\ntype Sample struct {\n\tLocation []*Location\n\tValue []int64\n\t// Label is a per-label-key map to values for string labels.\n\t//\n\t// In general, having multiple values for the given label key is strongly\n\t// discouraged - see docs for the sample label field in profile.proto. The\n\t// main reason this unlikely state is tracked here is to make the\n\t// decoding->encoding roundtrip not lossy. But we expect that the value\n\t// slices present in this map are always of length 1.\n\tLabel map[string][]string\n\t// NumLabel is a per-label-key map to values for numeric labels. See a note\n\t// above on handling multiple values for a label.\n\tNumLabel map[string][]int64\n\t// NumUnit is a per-label-key map to the unit names of corresponding numeric\n\t// label values. The unit info may be missing even if the label is in\n\t// NumLabel, see the docs in profile.proto for details. When the value is\n\t// slice is present and not nil, its length must be equal to the length of\n\t// the corresponding value slice in NumLabel.\n\tNumUnit map[string][]string\n\n\tlocationIDX []uint64\n\tlabelX []label\n}\n\n// label corresponds to Profile.Label\ntype label struct {\n\tkeyX int64\n\t// Exactly one of the two following values must be set\n\tstrX int64\n\tnumX int64 // Integer value for this label\n\t// can be set if numX has value\n\tunitX int64\n}\n\n// Mapping corresponds to Profile.Mapping\ntype Mapping struct {\n\tID uint64\n\tStart uint64\n\tLimit uint64\n\tOffset uint64\n\tFile string\n\tBuildID string\n\tHasFunctions bool\n\tHasFilenames bool\n\tHasLineNumbers bool\n\tHasInlineFrames bool\n\n\tfileX int64\n\tbuildIDX int64\n\n\t// Name of the kernel relocation symbol (\"_text\" or \"_stext\"), extracted from File.\n\t// For linux kernel mappings generated by some tools, correct symbolization depends\n\t// on knowing which of the two possible relocation symbols was used for `Start`.\n\t// This is given to us as a suffix in `File` (e.g. \"[kernel.kallsyms]_stext\").\n\t//\n\t// Note, this public field is not persisted in the proto. For the purposes of\n\t// copying / merging / hashing profiles, it is considered subsumed by `File`.\n\tKernelRelocationSymbol string\n}\n\n// Location corresponds to Profile.Location\ntype Location struct {\n\tID uint64\n\tMapping *Mapping\n\tAddress uint64\n\tLine []Line\n\tIsFolded bool\n\n\tmappingIDX uint64\n}\n\n// Line corresponds to Profile.Line\ntype Line struct {\n\tFunction *Function\n\tLine int64\n\tColumn int64\n\n\tfunctionIDX uint64\n}\n\n// Function corresponds to Profile.Function\ntype Function struct {\n\tID uint64\n\tName string\n\tSystemName string\n\tFilename string\n\tStartLine int64\n\n\tnameX int64\n\tsystemNameX int64\n\tfilenameX int64\n}\n\n// Parse parses a profile and checks for its validity. The input\n// may be a gzip-compressed encoded protobuf or one of many legacy\n// profile formats which may be unsupported in the future.\nfunc Parse(r io.Reader) (*Profile, error) {\n\tdata, err := io.ReadAll(r)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn ParseData(data)\n}\n\n// ParseData parses a profile from a buffer and checks for its\n// validity.\nfunc ParseData(data []byte) (*Profile, error) {\n\tvar p *Profile\n\tvar err error\n\tif len(data) >= 2 && data[0] == 0x1f && data[1] == 0x8b {\n\t\tgz, err := gzip.NewReader(bytes.NewBuffer(data))\n\t\tif err == nil {\n\t\t\tdata, err = io.ReadAll(gz)\n\t\t}\n\t\tif err != nil {\n\t\t\treturn nil, fmt.Errorf(\"decompressing profile: %v\", err)\n\t\t}\n\t}\n\tif p, err = ParseUncompressed(data); err != nil && err != errNoData && err != errConcatProfile {\n\t\tp, err = parseLegacy(data)\n\t}\n\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"parsing profile: %v\", err)\n\t}\n\n\tif err := p.CheckValid(); err != nil {\n\t\treturn nil, fmt.Errorf(\"malformed profile: %v\", err)\n\t}\n\treturn p, nil\n}\n\nvar errUnrecognized = fmt.Errorf(\"unrecognized profile format\")\nvar errMalformed = fmt.Errorf(\"malformed profile format\")\nvar errNoData = fmt.Errorf(\"empty input file\")\nvar errConcatProfile = fmt.Errorf(\"concatenated profiles detected\")\n\nfunc parseLegacy(data []byte) (*Profile, error) {\n\tparsers := []func([]byte) (*Profile, error){\n\t\tparseCPU,\n\t\tparseHeap,\n\t\tparseGoCount, // goroutine, threadcreate\n\t\tparseThread,\n\t\tparseContention,\n\t\tparseJavaProfile,\n\t}\n\n\tfor _, parser := range parsers {\n\t\tp, err := parser(data)\n\t\tif err == nil {\n\t\t\tp.addLegacyFrameInfo()\n\t\t\treturn p, nil\n\t\t}\n\t\tif err != errUnrecognized {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\treturn nil, errUnrecognized\n}\n\n// ParseUncompressed parses an uncompressed protobuf into a profile.\nfunc ParseUncompressed(data []byte) (*Profile, error) {\n\tif len(data) == 0 {\n\t\treturn nil, errNoData\n\t}\n\tp := &Profile{}\n\tif err := unmarshal(data, p); err != nil {\n\t\treturn nil, err\n\t}\n\n\tif err := p.postDecode(); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn p, nil\n}\n\nvar libRx = regexp.MustCompile(`([.]so$|[.]so[._][0-9]+)`)\n\n// massageMappings applies heuristic-based changes to the profile\n// mappings to account for quirks of some environments.\nfunc (p *Profile) massageMappings() {\n\t// Merge adjacent regions with matching names, checking that the offsets match\n\tif len(p.Mapping) > 1 {\n\t\tmappings := []*Mapping{p.Mapping[0]}\n\t\tfor _, m := range p.Mapping[1:] {\n\t\t\tlm := mappings[len(mappings)-1]\n\t\t\tif adjacent(lm, m) {\n\t\t\t\tlm.Limit = m.Limit\n\t\t\t\tif m.File != \"\" {\n\t\t\t\t\tlm.File = m.File\n\t\t\t\t}\n\t\t\t\tif m.BuildID != \"\" {\n\t\t\t\t\tlm.BuildID = m.BuildID\n\t\t\t\t}\n\t\t\t\tp.updateLocationMapping(m, lm)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tmappings = append(mappings, m)\n\t\t}\n\t\tp.Mapping = mappings\n\t}\n\n\t// Use heuristics to identify main binary and move it to the top of the list of mappings\n\tfor i, m := range p.Mapping {\n\t\tfile := strings.TrimSpace(strings.ReplaceAll(m.File, \"(deleted)\", \"\"))\n\t\tif len(file) == 0 {\n\t\t\tcontinue\n\t\t}\n\t\tif len(libRx.FindStringSubmatch(file)) > 0 {\n\t\t\tcontinue\n\t\t}\n\t\tif file[0] == '[' {\n\t\t\tcontinue\n\t\t}\n\t\t// Swap what we guess is main to position 0.\n\t\tp.Mapping[0], p.Mapping[i] = p.Mapping[i], p.Mapping[0]\n\t\tbreak\n\t}\n\n\t// Keep the mapping IDs neatly sorted\n\tfor i, m := range p.Mapping {\n\t\tm.ID = uint64(i + 1)\n\t}\n}\n\n// adjacent returns whether two mapping entries represent the same\n// mapping that has been split into two. Check that their addresses are adjacent,\n// and if the offsets match, if they are available.\nfunc adjacent(m1, m2 *Mapping) bool {\n\tif m1.File != \"\" && m2.File != \"\" {\n\t\tif m1.File != m2.File {\n\t\t\treturn false\n\t\t}\n\t}\n\tif m1.BuildID != \"\" && m2.BuildID != \"\" {\n\t\tif m1.BuildID != m2.BuildID {\n\t\t\treturn false\n\t\t}\n\t}\n\tif m1.Limit != m2.Start {\n\t\treturn false\n\t}\n\tif m1.Offset != 0 && m2.Offset != 0 {\n\t\toffset := m1.Offset + (m1.Limit - m1.Start)\n\t\tif offset != m2.Offset {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\nfunc (p *Profile) updateLocationMapping(from, to *Mapping) {\n\tfor _, l := range p.Location {\n\t\tif l.Mapping == from {\n\t\t\tl.Mapping = to\n\t\t}\n\t}\n}\n\nfunc serialize(p *Profile) []byte {\n\tp.encodeMu.Lock()\n\tp.preEncode()\n\tb := marshal(p)\n\tp.encodeMu.Unlock()\n\treturn b\n}\n\n// Write writes the profile as a gzip-compressed marshaled protobuf.\nfunc (p *Profile) Write(w io.Writer) error {\n\tzw := gzip.NewWriter(w)\n\tdefer zw.Close()\n\t_, err := zw.Write(serialize(p))\n\treturn err\n}\n\n// WriteUncompressed writes the profile as a marshaled protobuf.\nfunc (p *Profile) WriteUncompressed(w io.Writer) error {\n\t_, err := w.Write(serialize(p))\n\treturn err\n}\n\n// CheckValid tests whether the profile is valid. Checks include, but are\n// not limited to:\n// - len(Profile.Sample[n].value) == len(Profile.value_unit)\n// - Sample.id has a corresponding Profile.Location\nfunc (p *Profile) CheckValid() error {\n\t// Check that sample values are consistent\n\tsampleLen := len(p.SampleType)\n\tif sampleLen == 0 && len(p.Sample) != 0 {\n\t\treturn fmt.Errorf(\"missing sample type information\")\n\t}\n\tfor _, s := range p.Sample {\n\t\tif s == nil {\n\t\t\treturn fmt.Errorf(\"profile has nil sample\")\n\t\t}\n\t\tif len(s.Value) != sampleLen {\n\t\t\treturn fmt.Errorf(\"mismatch: sample has %d values vs. %d types\", len(s.Value), len(p.SampleType))\n\t\t}\n\t\tfor _, l := range s.Location {\n\t\t\tif l == nil {\n\t\t\t\treturn fmt.Errorf(\"sample has nil location\")\n\t\t\t}\n\t\t}\n\t}\n\n\t// Check that all mappings/locations/functions are in the tables\n\t// Check that there are no duplicate ids\n\tmappings := make(map[uint64]*Mapping, len(p.Mapping))\n\tfor _, m := range p.Mapping {\n\t\tif m == nil {\n\t\t\treturn fmt.Errorf(\"profile has nil mapping\")\n\t\t}\n\t\tif m.ID == 0 {\n\t\t\treturn fmt.Errorf(\"found mapping with reserved ID=0\")\n\t\t}\n\t\tif mappings[m.ID] != nil {\n\t\t\treturn fmt.Errorf(\"multiple mappings with same id: %d\", m.ID)\n\t\t}\n\t\tmappings[m.ID] = m\n\t}\n\tfunctions := make(map[uint64]*Function, len(p.Function))\n\tfor _, f := range p.Function {\n\t\tif f == nil {\n\t\t\treturn fmt.Errorf(\"profile has nil function\")\n\t\t}\n\t\tif f.ID == 0 {\n\t\t\treturn fmt.Errorf(\"found function with reserved ID=0\")\n\t\t}\n\t\tif functions[f.ID] != nil {\n\t\t\treturn fmt.Errorf(\"multiple functions with same id: %d\", f.ID)\n\t\t}\n\t\tfunctions[f.ID] = f\n\t}\n\tlocations := make(map[uint64]*Location, len(p.Location))\n\tfor _, l := range p.Location {\n\t\tif l == nil {\n\t\t\treturn fmt.Errorf(\"profile has nil location\")\n\t\t}\n\t\tif l.ID == 0 {\n\t\t\treturn fmt.Errorf(\"found location with reserved id=0\")\n\t\t}\n\t\tif locations[l.ID] != nil {\n\t\t\treturn fmt.Errorf(\"multiple locations with same id: %d\", l.ID)\n\t\t}\n\t\tlocations[l.ID] = l\n\t\tif m := l.Mapping; m != nil {\n\t\t\tif m.ID == 0 || mappings[m.ID] != m {\n\t\t\t\treturn fmt.Errorf(\"inconsistent mapping %p: %d\", m, m.ID)\n\t\t\t}\n\t\t}\n\t\tfor _, ln := range l.Line {\n\t\t\tf := ln.Function\n\t\t\tif f == nil {\n\t\t\t\treturn fmt.Errorf(\"location id: %d has a line with nil function\", l.ID)\n\t\t\t}\n\t\t\tif f.ID == 0 || functions[f.ID] != f {\n\t\t\t\treturn fmt.Errorf(\"inconsistent function %p: %d\", f, f.ID)\n\t\t\t}\n\t\t}\n\t}\n\treturn nil\n}\n\n// Aggregate merges the locations in the profile into equivalence\n// classes preserving the request attributes. It also updates the\n// samples to point to the merged locations.\nfunc (p *Profile) Aggregate(inlineFrame, function, filename, linenumber, columnnumber, address bool) error {\n\tfor _, m := range p.Mapping {\n\t\tm.HasInlineFrames = m.HasInlineFrames && inlineFrame\n\t\tm.HasFunctions = m.HasFunctions && function\n\t\tm.HasFilenames = m.HasFilenames && filename\n\t\tm.HasLineNumbers = m.HasLineNumbers && linenumber\n\t}\n\n\t// Aggregate functions\n\tif !function || !filename {\n\t\tfor _, f := range p.Function {\n\t\t\tif !function {\n\t\t\t\tf.Name = \"\"\n\t\t\t\tf.SystemName = \"\"\n\t\t\t}\n\t\t\tif !filename {\n\t\t\t\tf.Filename = \"\"\n\t\t\t}\n\t\t}\n\t}\n\n\t// Aggregate locations\n\tif !inlineFrame || !address || !linenumber || !columnnumber {\n\t\tfor _, l := range p.Location {\n\t\t\tif !inlineFrame && len(l.Line) > 1 {\n\t\t\t\tl.Line = l.Line[len(l.Line)-1:]\n\t\t\t}\n\t\t\tif !linenumber {\n\t\t\t\tfor i := range l.Line {\n\t\t\t\t\tl.Line[i].Line = 0\n\t\t\t\t\tl.Line[i].Column = 0\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !columnnumber {\n\t\t\t\tfor i := range l.Line {\n\t\t\t\t\tl.Line[i].Column = 0\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !address {\n\t\t\t\tl.Address = 0\n\t\t\t}\n\t\t}\n\t}\n\n\treturn p.CheckValid()\n}\n\n// NumLabelUnits returns a map of numeric label keys to the units\n// associated with those keys and a map of those keys to any units\n// that were encountered but not used.\n// Unit for a given key is the first encountered unit for that key. If multiple\n// units are encountered for values paired with a particular key, then the first\n// unit encountered is used and all other units are returned in sorted order\n// in map of ignored units.\n// If no units are encountered for a particular key, the unit is then inferred\n// based on the key.\nfunc (p *Profile) NumLabelUnits() (map[string]string, map[string][]string) {\n\tnumLabelUnits := map[string]string{}\n\tignoredUnits := map[string]map[string]bool{}\n\tencounteredKeys := map[string]bool{}\n\n\t// Determine units based on numeric tags for each sample.\n\tfor _, s := range p.Sample {\n\t\tfor k := range s.NumLabel {\n\t\t\tencounteredKeys[k] = true\n\t\t\tfor _, unit := range s.NumUnit[k] {\n\t\t\t\tif unit == \"\" {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tif wantUnit, ok := numLabelUnits[k]; !ok {\n\t\t\t\t\tnumLabelUnits[k] = unit\n\t\t\t\t} else if wantUnit != unit {\n\t\t\t\t\tif v, ok := ignoredUnits[k]; ok {\n\t\t\t\t\t\tv[unit] = true\n\t\t\t\t\t} else {\n\t\t\t\t\t\tignoredUnits[k] = map[string]bool{unit: true}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\t// Infer units for keys without any units associated with\n\t// numeric tag values.\n\tfor key := range encounteredKeys {\n\t\tunit := numLabelUnits[key]\n\t\tif unit == \"\" {\n\t\t\tswitch key {\n\t\t\tcase \"alignment\", \"request\":\n\t\t\t\tnumLabelUnits[key] = \"bytes\"\n\t\t\tdefault:\n\t\t\t\tnumLabelUnits[key] = key\n\t\t\t}\n\t\t}\n\t}\n\n\t// Copy ignored units into more readable format\n\tunitsIgnored := make(map[string][]string, len(ignoredUnits))\n\tfor key, values := range ignoredUnits {\n\t\tunits := make([]string, len(values))\n\t\ti := 0\n\t\tfor unit := range values {\n\t\t\tunits[i] = unit\n\t\t\ti++\n\t\t}\n\t\tsort.Strings(units)\n\t\tunitsIgnored[key] = units\n\t}\n\n\treturn numLabelUnits, unitsIgnored\n}\n\n// String dumps a text representation of a profile. Intended mainly\n// for debugging purposes.\nfunc (p *Profile) String() string {\n\tss := make([]string, 0, len(p.Comments)+len(p.Sample)+len(p.Mapping)+len(p.Location))\n\tfor _, c := range p.Comments {\n\t\tss = append(ss, \"Comment: \"+c)\n\t}\n\tif url := p.DocURL; url != \"\" {\n\t\tss = append(ss, fmt.Sprintf(\"Doc: %s\", url))\n\t}\n\tif pt := p.PeriodType; pt != nil {\n\t\tss = append(ss, fmt.Sprintf(\"PeriodType: %s %s\", pt.Type, pt.Unit))\n\t}\n\tss = append(ss, fmt.Sprintf(\"Period: %d\", p.Period))\n\tif p.TimeNanos != 0 {\n\t\tss = append(ss, fmt.Sprintf(\"Time: %v\", time.Unix(0, p.TimeNanos)))\n\t}\n\tif p.DurationNanos != 0 {\n\t\tss = append(ss, fmt.Sprintf(\"Duration: %.4v\", time.Duration(p.DurationNanos)))\n\t}\n\n\tss = append(ss, \"Samples:\")\n\tvar sh1 string\n\tfor _, s := range p.SampleType {\n\t\tdflt := \"\"\n\t\tif s.Type == p.DefaultSampleType {\n\t\t\tdflt = \"[dflt]\"\n\t\t}\n\t\tsh1 = sh1 + fmt.Sprintf(\"%s/%s%s \", s.Type, s.Unit, dflt)\n\t}\n\tss = append(ss, strings.TrimSpace(sh1))\n\tfor _, s := range p.Sample {\n\t\tss = append(ss, s.string())\n\t}\n\n\tss = append(ss, \"Locations\")\n\tfor _, l := range p.Location {\n\t\tss = append(ss, l.string())\n\t}\n\n\tss = append(ss, \"Mappings\")\n\tfor _, m := range p.Mapping {\n\t\tss = append(ss, m.string())\n\t}\n\n\treturn strings.Join(ss, \"\\n\") + \"\\n\"\n}\n\n// string dumps a text representation of a mapping. Intended mainly\n// for debugging purposes.\nfunc (m *Mapping) string() string {\n\tbits := \"\"\n\tif m.HasFunctions {\n\t\tbits = bits + \"[FN]\"\n\t}\n\tif m.HasFilenames {\n\t\tbits = bits + \"[FL]\"\n\t}\n\tif m.HasLineNumbers {\n\t\tbits = bits + \"[LN]\"\n\t}\n\tif m.HasInlineFrames {\n\t\tbits = bits + \"[IN]\"\n\t}\n\treturn fmt.Sprintf(\"%d: %#x/%#x/%#x %s %s %s\",\n\t\tm.ID,\n\t\tm.Start, m.Limit, m.Offset,\n\t\tm.File,\n\t\tm.BuildID,\n\t\tbits)\n}\n\n// string dumps a text representation of a location. Intended mainly\n// for debugging purposes.\nfunc (l *Location) string() string {\n\tss := []string{}\n\tlocStr := fmt.Sprintf(\"%6d: %#x \", l.ID, l.Address)\n\tif m := l.Mapping; m != nil {\n\t\tlocStr = locStr + fmt.Sprintf(\"M=%d \", m.ID)\n\t}\n\tif l.IsFolded {\n\t\tlocStr = locStr + \"[F] \"\n\t}\n\tif len(l.Line) == 0 {\n\t\tss = append(ss, locStr)\n\t}\n\tfor li := range l.Line {\n\t\tlnStr := \"??\"\n\t\tif fn := l.Line[li].Function; fn != nil {\n\t\t\tlnStr = fmt.Sprintf(\"%s %s:%d:%d s=%d\",\n\t\t\t\tfn.Name,\n\t\t\t\tfn.Filename,\n\t\t\t\tl.Line[li].Line,\n\t\t\t\tl.Line[li].Column,\n\t\t\t\tfn.StartLine)\n\t\t\tif fn.Name != fn.SystemName {\n\t\t\t\tlnStr = lnStr + \"(\" + fn.SystemName + \")\"\n\t\t\t}\n\t\t}\n\t\tss = append(ss, locStr+lnStr)\n\t\t// Do not print location details past the first line\n\t\tlocStr = \" \"\n\t}\n\treturn strings.Join(ss, \"\\n\")\n}\n\n// string dumps a text representation of a sample. Intended mainly\n// for debugging purposes.\nfunc (s *Sample) string() string {\n\tss := []string{}\n\tvar sv string\n\tfor _, v := range s.Value {\n\t\tsv = fmt.Sprintf(\"%s %10d\", sv, v)\n\t}\n\tsv = sv + \": \"\n\tfor _, l := range s.Location {\n\t\tsv = sv + fmt.Sprintf(\"%d \", l.ID)\n\t}\n\tss = append(ss, sv)\n\tconst labelHeader = \" \"\n\tif len(s.Label) > 0 {\n\t\tss = append(ss, labelHeader+labelsToString(s.Label))\n\t}\n\tif len(s.NumLabel) > 0 {\n\t\tss = append(ss, labelHeader+numLabelsToString(s.NumLabel, s.NumUnit))\n\t}\n\treturn strings.Join(ss, \"\\n\")\n}\n\n// labelsToString returns a string representation of a\n// map representing labels.\nfunc labelsToString(labels map[string][]string) string {\n\tls := []string{}\n\tfor k, v := range labels {\n\t\tls = append(ls, fmt.Sprintf(\"%s:%v\", k, v))\n\t}\n\tsort.Strings(ls)\n\treturn strings.Join(ls, \" \")\n}\n\n// numLabelsToString returns a string representation of a map\n// representing numeric labels.\nfunc numLabelsToString(numLabels map[string][]int64, numUnits map[string][]string) string {\n\tls := []string{}\n\tfor k, v := range numLabels {\n\t\tunits := numUnits[k]\n\t\tvar labelString string\n\t\tif len(units) == len(v) {\n\t\t\tvalues := make([]string, len(v))\n\t\t\tfor i, vv := range v {\n\t\t\t\tvalues[i] = fmt.Sprintf(\"%d %s\", vv, units[i])\n\t\t\t}\n\t\t\tlabelString = fmt.Sprintf(\"%s:%v\", k, values)\n\t\t} else {\n\t\t\tlabelString = fmt.Sprintf(\"%s:%v\", k, v)\n\t\t}\n\t\tls = append(ls, labelString)\n\t}\n\tsort.Strings(ls)\n\treturn strings.Join(ls, \" \")\n}\n\n// SetLabel sets the specified key to the specified value for all samples in the\n// profile.\nfunc (p *Profile) SetLabel(key string, value []string) {\n\tfor _, sample := range p.Sample {\n\t\tif sample.Label == nil {\n\t\t\tsample.Label = map[string][]string{key: value}\n\t\t} else {\n\t\t\tsample.Label[key] = value\n\t\t}\n\t}\n}\n\n// RemoveLabel removes all labels associated with the specified key for all\n// samples in the profile.\nfunc (p *Profile) RemoveLabel(key string) {\n\tfor _, sample := range p.Sample {\n\t\tdelete(sample.Label, key)\n\t}\n}\n\n// HasLabel returns true if a sample has a label with indicated key and value.\nfunc (s *Sample) HasLabel(key, value string) bool {\n\treturn slices.Contains(s.Label[key], value)\n}\n\n// SetNumLabel sets the specified key to the specified value for all samples in the\n// profile. \"unit\" is a slice that describes the units that each corresponding member\n// of \"values\" is measured in (e.g. bytes or seconds). If there is no relevant\n// unit for a given value, that member of \"unit\" should be the empty string.\n// \"unit\" must either have the same length as \"value\", or be nil.\nfunc (p *Profile) SetNumLabel(key string, value []int64, unit []string) {\n\tfor _, sample := range p.Sample {\n\t\tif sample.NumLabel == nil {\n\t\t\tsample.NumLabel = map[string][]int64{key: value}\n\t\t} else {\n\t\t\tsample.NumLabel[key] = value\n\t\t}\n\t\tif sample.NumUnit == nil {\n\t\t\tsample.NumUnit = map[string][]string{key: unit}\n\t\t} else {\n\t\t\tsample.NumUnit[key] = unit\n\t\t}\n\t}\n}\n\n// RemoveNumLabel removes all numerical labels associated with the specified key for all\n// samples in the profile.\nfunc (p *Profile) RemoveNumLabel(key string) {\n\tfor _, sample := range p.Sample {\n\t\tdelete(sample.NumLabel, key)\n\t\tdelete(sample.NumUnit, key)\n\t}\n}\n\n// DiffBaseSample returns true if a sample belongs to the diff base and false\n// otherwise.\nfunc (s *Sample) DiffBaseSample() bool {\n\treturn s.HasLabel(\"pprof::base\", \"true\")\n}\n\n// Scale multiplies all sample values in a profile by a constant and keeps\n// only samples that have at least one non-zero value.\nfunc (p *Profile) Scale(ratio float64) {\n\tif ratio == 1 {\n\t\treturn\n\t}\n\tratios := make([]float64, len(p.SampleType))\n\tfor i := range p.SampleType {\n\t\tratios[i] = ratio\n\t}\n\tp.ScaleN(ratios)\n}\n\n// ScaleN multiplies each sample values in a sample by a different amount\n// and keeps only samples that have at least one non-zero value.\nfunc (p *Profile) ScaleN(ratios []float64) error {\n\tif len(p.SampleType) != len(ratios) {\n\t\treturn fmt.Errorf(\"mismatched scale ratios, got %d, want %d\", len(ratios), len(p.SampleType))\n\t}\n\tallOnes := true\n\tfor _, r := range ratios {\n\t\tif r != 1 {\n\t\t\tallOnes = false\n\t\t\tbreak\n\t\t}\n\t}\n\tif allOnes {\n\t\treturn nil\n\t}\n\tfillIdx := 0\n\tfor _, s := range p.Sample {\n\t\tkeepSample := false\n\t\tfor i, v := range s.Value {\n\t\t\tif ratios[i] != 1 {\n\t\t\t\tval := int64(math.Round(float64(v) * ratios[i]))\n\t\t\t\ts.Value[i] = val\n\t\t\t\tkeepSample = keepSample || val != 0\n\t\t\t}\n\t\t}\n\t\tif keepSample {\n\t\t\tp.Sample[fillIdx] = s\n\t\t\tfillIdx++\n\t\t}\n\t}\n\tp.Sample = p.Sample[:fillIdx]\n\treturn nil\n}\n\n// HasFunctions determines if all locations in this profile have\n// symbolized function information.\nfunc (p *Profile) HasFunctions() bool {\n\tfor _, l := range p.Location {\n\t\tif l.Mapping != nil && !l.Mapping.HasFunctions {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\n// HasFileLines determines if all locations in this profile have\n// symbolized file and line number information.\nfunc (p *Profile) HasFileLines() bool {\n\tfor _, l := range p.Location {\n\t\tif l.Mapping != nil && (!l.Mapping.HasFilenames || !l.Mapping.HasLineNumbers) {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\n// Unsymbolizable returns true if a mapping points to a binary for which\n// locations can't be symbolized in principle, at least now. Examples are\n// \"[vdso]\", \"[vsyscall]\" and some others, see the code.\nfunc (m *Mapping) Unsymbolizable() bool {\n\tname := filepath.Base(m.File)\n\tswitch {\n\tcase strings.HasPrefix(name, \"[\"):\n\tcase strings.HasPrefix(name, \"linux-vdso\"):\n\tcase strings.HasPrefix(m.File, \"/dev/dri/\"):\n\tcase m.File == \"//anon\":\n\tcase m.File == \"\":\n\tcase strings.HasPrefix(m.File, \"/memfd:\"):\n\tdefault:\n\t\treturn false\n\t}\n\treturn true\n}\n\n// Copy makes a fully independent copy of a profile.\nfunc (p *Profile) Copy() *Profile {\n\tpp := &Profile{}\n\tif err := unmarshal(serialize(p), pp); err != nil {\n\t\tpanic(err)\n\t}\n\tif err := pp.postDecode(); err != nil {\n\t\tpanic(err)\n\t}\n\n\treturn pp\n}\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/proto.go",
"content": "// Copyright 2014 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// This file is a simple protocol buffer encoder and decoder.\n// The format is described at\n// https://developers.google.com/protocol-buffers/docs/encoding\n//\n// A protocol message must implement the message interface:\n// decoder() []decoder\n// encode(*buffer)\n//\n// The decode method returns a slice indexed by field number that gives the\n// function to decode that field.\n// The encode method encodes its receiver into the given buffer.\n//\n// The two methods are simple enough to be implemented by hand rather than\n// by using a protocol compiler.\n//\n// See profile.go for examples of messages implementing this interface.\n//\n// There is no support for groups, message sets, or \"has\" bits.\n\npackage profile\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"slices\"\n)\n\ntype buffer struct {\n\tfield int // field tag\n\ttyp int // proto wire type code for field\n\tu64 uint64\n\tdata []byte\n\ttmp [16]byte\n\ttmpLines []Line // temporary storage used while decoding \"repeated Line\".\n}\n\ntype decoder func(*buffer, message) error\n\ntype message interface {\n\tdecoder() []decoder\n\tencode(*buffer)\n}\n\nfunc marshal(m message) []byte {\n\tvar b buffer\n\tm.encode(&b)\n\treturn b.data\n}\n\nfunc encodeVarint(b *buffer, x uint64) {\n\tfor x >= 128 {\n\t\tb.data = append(b.data, byte(x)|0x80)\n\t\tx >>= 7\n\t}\n\tb.data = append(b.data, byte(x))\n}\n\nfunc encodeLength(b *buffer, tag int, len int) {\n\tencodeVarint(b, uint64(tag)<<3|2)\n\tencodeVarint(b, uint64(len))\n}\n\nfunc encodeUint64(b *buffer, tag int, x uint64) {\n\t// append varint to b.data\n\tencodeVarint(b, uint64(tag)<<3)\n\tencodeVarint(b, x)\n}\n\nfunc encodeUint64s(b *buffer, tag int, x []uint64) {\n\tif len(x) > 2 {\n\t\t// Use packed encoding\n\t\tn1 := len(b.data)\n\t\tfor _, u := range x {\n\t\t\tencodeVarint(b, u)\n\t\t}\n\t\tn2 := len(b.data)\n\t\tencodeLength(b, tag, n2-n1)\n\t\tn3 := len(b.data)\n\t\tcopy(b.tmp[:], b.data[n2:n3])\n\t\tcopy(b.data[n1+(n3-n2):], b.data[n1:n2])\n\t\tcopy(b.data[n1:], b.tmp[:n3-n2])\n\t\treturn\n\t}\n\tfor _, u := range x {\n\t\tencodeUint64(b, tag, u)\n\t}\n}\n\nfunc encodeUint64Opt(b *buffer, tag int, x uint64) {\n\tif x == 0 {\n\t\treturn\n\t}\n\tencodeUint64(b, tag, x)\n}\n\nfunc encodeInt64(b *buffer, tag int, x int64) {\n\tu := uint64(x)\n\tencodeUint64(b, tag, u)\n}\n\nfunc encodeInt64s(b *buffer, tag int, x []int64) {\n\tif len(x) > 2 {\n\t\t// Use packed encoding\n\t\tn1 := len(b.data)\n\t\tfor _, u := range x {\n\t\t\tencodeVarint(b, uint64(u))\n\t\t}\n\t\tn2 := len(b.data)\n\t\tencodeLength(b, tag, n2-n1)\n\t\tn3 := len(b.data)\n\t\tcopy(b.tmp[:], b.data[n2:n3])\n\t\tcopy(b.data[n1+(n3-n2):], b.data[n1:n2])\n\t\tcopy(b.data[n1:], b.tmp[:n3-n2])\n\t\treturn\n\t}\n\tfor _, u := range x {\n\t\tencodeInt64(b, tag, u)\n\t}\n}\n\nfunc encodeInt64Opt(b *buffer, tag int, x int64) {\n\tif x == 0 {\n\t\treturn\n\t}\n\tencodeInt64(b, tag, x)\n}\n\nfunc encodeString(b *buffer, tag int, x string) {\n\tencodeLength(b, tag, len(x))\n\tb.data = append(b.data, x...)\n}\n\nfunc encodeStrings(b *buffer, tag int, x []string) {\n\tfor _, s := range x {\n\t\tencodeString(b, tag, s)\n\t}\n}\n\nfunc encodeBool(b *buffer, tag int, x bool) {\n\tif x {\n\t\tencodeUint64(b, tag, 1)\n\t} else {\n\t\tencodeUint64(b, tag, 0)\n\t}\n}\n\nfunc encodeBoolOpt(b *buffer, tag int, x bool) {\n\tif x {\n\t\tencodeBool(b, tag, x)\n\t}\n}\n\nfunc encodeMessage(b *buffer, tag int, m message) {\n\tn1 := len(b.data)\n\tm.encode(b)\n\tn2 := len(b.data)\n\tencodeLength(b, tag, n2-n1)\n\tn3 := len(b.data)\n\tcopy(b.tmp[:], b.data[n2:n3])\n\tcopy(b.data[n1+(n3-n2):], b.data[n1:n2])\n\tcopy(b.data[n1:], b.tmp[:n3-n2])\n}\n\nfunc unmarshal(data []byte, m message) (err error) {\n\tb := buffer{data: data, typ: 2}\n\treturn decodeMessage(&b, m)\n}\n\nfunc le64(p []byte) uint64 {\n\treturn uint64(p[0]) | uint64(p[1])<<8 | uint64(p[2])<<16 | uint64(p[3])<<24 | uint64(p[4])<<32 | uint64(p[5])<<40 | uint64(p[6])<<48 | uint64(p[7])<<56\n}\n\nfunc le32(p []byte) uint32 {\n\treturn uint32(p[0]) | uint32(p[1])<<8 | uint32(p[2])<<16 | uint32(p[3])<<24\n}\n\nfunc peekNumVarints(data []byte) (numVarints int) {\n\tfor ; len(data) > 0; numVarints++ {\n\t\tvar err error\n\t\tif _, data, err = decodeVarint(data); err != nil {\n\t\t\tbreak\n\t\t}\n\t}\n\treturn numVarints\n}\n\nfunc decodeVarint(data []byte) (uint64, []byte, error) {\n\tvar u uint64\n\tfor i := 0; ; i++ {\n\t\tif i >= 10 || i >= len(data) {\n\t\t\treturn 0, nil, errors.New(\"bad varint\")\n\t\t}\n\t\tu |= uint64(data[i]&0x7F) << uint(7*i)\n\t\tif data[i]&0x80 == 0 {\n\t\t\treturn u, data[i+1:], nil\n\t\t}\n\t}\n}\n\nfunc decodeField(b *buffer, data []byte) ([]byte, error) {\n\tx, data, err := decodeVarint(data)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tb.field = int(x >> 3)\n\tb.typ = int(x & 7)\n\tb.data = nil\n\tb.u64 = 0\n\tswitch b.typ {\n\tcase 0:\n\t\tb.u64, data, err = decodeVarint(data)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\tcase 1:\n\t\tif len(data) < 8 {\n\t\t\treturn nil, errors.New(\"not enough data\")\n\t\t}\n\t\tb.u64 = le64(data[:8])\n\t\tdata = data[8:]\n\tcase 2:\n\t\tvar n uint64\n\t\tn, data, err = decodeVarint(data)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif n > uint64(len(data)) {\n\t\t\treturn nil, errors.New(\"too much data\")\n\t\t}\n\t\tb.data = data[:n]\n\t\tdata = data[n:]\n\tcase 5:\n\t\tif len(data) < 4 {\n\t\t\treturn nil, errors.New(\"not enough data\")\n\t\t}\n\t\tb.u64 = uint64(le32(data[:4]))\n\t\tdata = data[4:]\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"unknown wire type: %d\", b.typ)\n\t}\n\n\treturn data, nil\n}\n\nfunc checkType(b *buffer, typ int) error {\n\tif b.typ != typ {\n\t\treturn errors.New(\"type mismatch\")\n\t}\n\treturn nil\n}\n\nfunc decodeMessage(b *buffer, m message) error {\n\tif err := checkType(b, 2); err != nil {\n\t\treturn err\n\t}\n\tdec := m.decoder()\n\tdata := b.data\n\tfor len(data) > 0 {\n\t\t// pull varint field# + type\n\t\tvar err error\n\t\tdata, err = decodeField(b, data)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif b.field >= len(dec) || dec[b.field] == nil {\n\t\t\tcontinue\n\t\t}\n\t\tif err := dec[b.field](b, m); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc decodeInt64(b *buffer, x *int64) error {\n\tif err := checkType(b, 0); err != nil {\n\t\treturn err\n\t}\n\t*x = int64(b.u64)\n\treturn nil\n}\n\nfunc decodeInt64s(b *buffer, x *[]int64) error {\n\tif b.typ == 2 {\n\t\t// Packed encoding\n\t\tdataLen := peekNumVarints(b.data)\n\t\t*x = slices.Grow(*x, dataLen)\n\n\t\tdata := b.data\n\t\tfor len(data) > 0 {\n\t\t\tvar u uint64\n\t\t\tvar err error\n\n\t\t\tif u, data, err = decodeVarint(data); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\t*x = append(*x, int64(u))\n\t\t}\n\t\treturn nil\n\t}\n\tvar i int64\n\tif err := decodeInt64(b, &i); err != nil {\n\t\treturn err\n\t}\n\t*x = append(*x, i)\n\treturn nil\n}\n\nfunc decodeUint64(b *buffer, x *uint64) error {\n\tif err := checkType(b, 0); err != nil {\n\t\treturn err\n\t}\n\t*x = b.u64\n\treturn nil\n}\n\nfunc decodeUint64s(b *buffer, x *[]uint64) error {\n\tif b.typ == 2 {\n\t\t// Packed encoding\n\t\tdataLen := peekNumVarints(b.data)\n\t\t*x = slices.Grow(*x, dataLen)\n\n\t\tdata := b.data\n\t\tfor len(data) > 0 {\n\t\t\tvar u uint64\n\t\t\tvar err error\n\n\t\t\tif u, data, err = decodeVarint(data); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\t*x = append(*x, u)\n\t\t}\n\t\treturn nil\n\t}\n\tvar u uint64\n\tif err := decodeUint64(b, &u); err != nil {\n\t\treturn err\n\t}\n\t*x = append(*x, u)\n\treturn nil\n}\n\nfunc decodeString(b *buffer, x *string) error {\n\tif err := checkType(b, 2); err != nil {\n\t\treturn err\n\t}\n\t*x = string(b.data)\n\treturn nil\n}\n\nfunc decodeStrings(b *buffer, x *[]string) error {\n\tvar s string\n\tif err := decodeString(b, &s); err != nil {\n\t\treturn err\n\t}\n\t*x = append(*x, s)\n\treturn nil\n}\n\nfunc decodeBool(b *buffer, x *bool) error {\n\tif err := checkType(b, 0); err != nil {\n\t\treturn err\n\t}\n\tif int64(b.u64) == 0 {\n\t\t*x = false\n\t} else {\n\t\t*x = true\n\t}\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/github.com/google/pprof/profile/prune.go",
"content": "// Copyright 2014 Google Inc. All Rights Reserved.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// Implements methods to remove frames from profiles.\n\npackage profile\n\nimport (\n\t\"fmt\"\n\t\"regexp\"\n\t\"slices\"\n\t\"strings\"\n)\n\nvar (\n\treservedNames = []string{\"(anonymous namespace)\", \"operator()\"}\n\tbracketRx = func() *regexp.Regexp {\n\t\tvar quotedNames []string\n\t\tfor _, name := range append(reservedNames, \"(\") {\n\t\t\tquotedNames = append(quotedNames, regexp.QuoteMeta(name))\n\t\t}\n\t\treturn regexp.MustCompile(strings.Join(quotedNames, \"|\"))\n\t}()\n)\n\n// simplifyFunc does some primitive simplification of function names.\nfunc simplifyFunc(f string) string {\n\t// Account for leading '.' on the PPC ELF v1 ABI.\n\tfuncName := strings.TrimPrefix(f, \".\")\n\t// Account for unsimplified names -- try to remove the argument list by trimming\n\t// starting from the first '(', but skipping reserved names that have '('.\n\tfor _, ind := range bracketRx.FindAllStringSubmatchIndex(funcName, -1) {\n\t\tfoundReserved := slices.Contains(reservedNames, funcName[ind[0]:ind[1]])\n\t\tif !foundReserved {\n\t\t\tfuncName = funcName[:ind[0]]\n\t\t\tbreak\n\t\t}\n\t}\n\treturn funcName\n}\n\n// Prune removes all nodes beneath a node matching dropRx, and not\n// matching keepRx. If the root node of a Sample matches, the sample\n// will have an empty stack.\nfunc (p *Profile) Prune(dropRx, keepRx *regexp.Regexp) {\n\tprune := make(map[uint64]bool)\n\tpruneBeneath := make(map[uint64]bool)\n\n\t// simplifyFunc can be expensive, so cache results.\n\t// Note that the same function name can be encountered many times due\n\t// different lines and addresses in the same function.\n\tpruneCache := map[string]bool{} // Map from function to whether or not to prune\n\tpruneFromHere := func(s string) bool {\n\t\tif r, ok := pruneCache[s]; ok {\n\t\t\treturn r\n\t\t}\n\t\tfuncName := simplifyFunc(s)\n\t\tif dropRx.MatchString(funcName) {\n\t\t\tif keepRx == nil || !keepRx.MatchString(funcName) {\n\t\t\t\tpruneCache[s] = true\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t\tpruneCache[s] = false\n\t\treturn false\n\t}\n\n\tfor _, loc := range p.Location {\n\t\tvar i int\n\t\tfor i = len(loc.Line) - 1; i >= 0; i-- {\n\t\t\tif fn := loc.Line[i].Function; fn != nil && fn.Name != \"\" {\n\t\t\t\tif pruneFromHere(fn.Name) {\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif i >= 0 {\n\t\t\t// Found matching entry to prune.\n\t\t\tpruneBeneath[loc.ID] = true\n\n\t\t\t// Remove the matching location.\n\t\t\tif i == len(loc.Line)-1 {\n\t\t\t\t// Matched the top entry: prune the whole location.\n\t\t\t\tprune[loc.ID] = true\n\t\t\t} else {\n\t\t\t\tloc.Line = loc.Line[i+1:]\n\t\t\t}\n\t\t}\n\t}\n\n\t// Prune locs from each Sample\n\tfor _, sample := range p.Sample {\n\t\t// Scan from the root to the leaves to find the prune location.\n\t\t// Do not prune frames before the first user frame, to avoid\n\t\t// pruning everything.\n\t\tfoundUser := false\n\t\tfor i := len(sample.Location) - 1; i >= 0; i-- {\n\t\t\tid := sample.Location[i].ID\n\t\t\tif !prune[id] && !pruneBeneath[id] {\n\t\t\t\tfoundUser = true\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif !foundUser {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif prune[id] {\n\t\t\t\tsample.Location = sample.Location[i+1:]\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tif pruneBeneath[id] {\n\t\t\t\tsample.Location = sample.Location[i:]\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n}\n\n// RemoveUninteresting prunes and elides profiles using built-in\n// tables of uninteresting function names.\nfunc (p *Profile) RemoveUninteresting() error {\n\tvar keep, drop *regexp.Regexp\n\tvar err error\n\n\tif p.DropFrames != \"\" {\n\t\tif drop, err = regexp.Compile(\"^(\" + p.DropFrames + \")$\"); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to compile regexp %s: %v\", p.DropFrames, err)\n\t\t}\n\t\tif p.KeepFrames != \"\" {\n\t\t\tif keep, err = regexp.Compile(\"^(\" + p.KeepFrames + \")$\"); err != nil {\n\t\t\t\treturn fmt.Errorf(\"failed to compile regexp %s: %v\", p.KeepFrames, err)\n\t\t\t}\n\t\t}\n\t\tp.Prune(drop, keep)\n\t}\n\treturn nil\n}\n\n// PruneFrom removes all nodes beneath the lowest node matching dropRx, not including itself.\n//\n// Please see the example below to understand this method as well as\n// the difference from Prune method.\n//\n// A sample contains Location of [A,B,C,B,D] where D is the top frame and there's no inline.\n//\n// PruneFrom(A) returns [A,B,C,B,D] because there's no node beneath A.\n// Prune(A, nil) returns [B,C,B,D] by removing A itself.\n//\n// PruneFrom(B) returns [B,C,B,D] by removing all nodes beneath the first B when scanning from the bottom.\n// Prune(B, nil) returns [D] because a matching node is found by scanning from the root.\nfunc (p *Profile) PruneFrom(dropRx *regexp.Regexp) {\n\tpruneBeneath := make(map[uint64]bool)\n\n\tfor _, loc := range p.Location {\n\t\tfor i := 0; i < len(loc.Line); i++ {\n\t\t\tif fn := loc.Line[i].Function; fn != nil && fn.Name != \"\" {\n\t\t\t\tfuncName := simplifyFunc(fn.Name)\n\t\t\t\tif dropRx.MatchString(funcName) {\n\t\t\t\t\t// Found matching entry to prune.\n\t\t\t\t\tpruneBeneath[loc.ID] = true\n\t\t\t\t\tloc.Line = loc.Line[i:]\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// Prune locs from each Sample\n\tfor _, sample := range p.Sample {\n\t\t// Scan from the bottom leaf to the root to find the prune location.\n\t\tfor i, loc := range sample.Location {\n\t\t\tif pruneBeneath[loc.ID] {\n\t\t\t\tsample.Location = sample.Location[i:]\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/.gitignore",
"content": ".DS_Store\nTODO\ntmp/**/*\n*.coverprofile\n.vscode\n.idea/\n*.log\n*.test"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/CHANGELOG.md",
"content": "## 2.28.1\n\nUpdate all dependencies. This auto-updated the required version of Go to 1.24, consistent with the fact that Go 1.23 has been out of support for almost six months.\n\n## 2.28.0\n\nGinkgo's SemVer filter now supports filtering multiple components by SemVer version:\n\n```go\nIt(\"should work in a specific version range (1.0.0, 2.0.0) and third-party dependency redis in [8.0.0, ~)\", SemVerConstraint(\">= 3.2.0\"), ComponentSemVerConstraint(\"redis\", \">= 8.0.0\") func() {\n // This test will only run when version is between 1.0.0 (exclusive) and 2.0.0 (exclusive) and redis version is >= 8.0.0\n})\n```\n\ncan be filtered in or out with an invocation like:\n\n```bash\nginkgo --sem-ver-filter=\"2.1.1, redis=8.2.0\"\n```\n\nHuge thanks to @Icarus9913 for working on this!\n\n## 2.27.5\n\n### Fixes\nDon't make a new formatter for each GinkgoT(); that's just silly and uses precious memory\n\n## 2.27.4\n\n### Fixes\n- CurrentTreeConstructionNodeReport: fix for nested container nodes [59bc751]\n\n## 2.27.3\n\n### Fixes\nreport exit result in case of failure [1c9f356]\nfix data race [ece19c8]\n\n## 2.27.2\n\n### Fixes\n- inline automaxprocs to simplify dependencies; this will be removed when Go 1.26 comes out [a69113a]\n\n### Maintenance\n- Fix syntax errors and typo [a99c6e0]\n- Fix paragraph position error [f993df5]\n\n## 2.27.1\n\n### Fixes\n- Fix Ginkgo Reporter slice-bounds panic [606c1cb]\n- Bug Fix: Add GinkoTBWrapper.Attr() and GinkoTBWrapper.Output() [a6463b3]\n\n## 2.27.0\n\n### Features\n\n#### Transforming Nodes during Tree Construction\n\nThis release adds support for `NodeArgsTransformer`s that can be registered with `AddTreeConstructionNodeArgsTransformer`.\n\nThese are called during the tree construction phase as nodes are constructed and can modify the node strings and decorators. This enables frameworks built on top of Ginkgo to modify Ginkgo nodes and enforce conventions.\n\nLearn more [here](https://onsi.github.io/ginkgo/#advanced-transforming-node-arguments-during-tree-construction).\n\n#### Spec Prioritization\n\nA new `SpecPriority(int)` decorator has been added. Ginkgo will honor priority when ordering specs, ensuring that higher priority specs start running before lower priority specs\n\nLearn more [here](https://onsi.github.io/ginkgo/#prioritizing-specs).\n\n### Maintenance\n- Bump rexml from 3.4.0 to 3.4.2 in /docs (#1595) [1333dae]\n- Bump github.com/gkampitakis/go-snaps from 0.5.14 to 0.5.15 (#1600) [17ae63e]\n\n## 2.26.0\n\n### Features\n\nGinkgo can now generate json-formatted reports that are compatible with the `go test` json format. Use `ginkgo --gojson-report=report.go.json`. This is not intended to be a replacement for Ginkgo's native json format which is more information rich and better models Ginkgo's test structure semantics.\n\n## 2.25.3\n\n### Fixes\n\n- emit --github-output group only for progress report itself [f01aed1]\n\n## 2.25.2\n\n### Fixes\nAdd github output group for progress report content\n\n### Maintenance\nBump Gomega\n\n## 2.25.1\n\n### Fixes\n- fix(types): ignore nameless nodes on FullText() [10866d3]\n- chore: fix some CodeQL warnings [2e42cff]\n\n## 2.25.0\n\n### `AroundNode`\n\nThis release introduces a new decorator to support more complex spec setup usecases.\n\n`AroundNode` registers a function that runs before each individual node. This is considered a more advanced decorator.\n\nPlease read the [docs](https://onsi.github.io/ginkgo/#advanced-around-node) for more information and some examples.\n\nAllowed signatures:\n\n- `AroundNode(func())` - `func` will be called before the node is run.\n- `AroundNode(func(ctx context.Context) context.Context)` - `func` can wrap the passed in context and return a new one which will be passed on to the node.\n- `AroundNode(func(ctx context.Context, body func(ctx context.Context)))` - `ctx` is the context for the node and `body` is a function that must be called to run the node. This gives you complete control over what runs before and after the node.\n\nMultiple `AroundNode` decorators can be applied to a single node and they will run in the order they are applied.\n\nUnlike setup nodes like `BeforeEach` and `DeferCleanup`, `AroundNode` is guaranteed to run in the same goroutine as the decorated node. This is necessary when working with lower-level libraries that must run on a single thread (you can call `runtime.LockOSThread()` in the `AroundNode` to ensure that the node runs on a single thread).\n\nSince `AroundNode` allows you to modify the context you can also use `AroundNode` to implement shared setup that attaches values to the context.\n\nIf applied to a container, `AroundNode` will run before every node in the container. Including setup nodes like `BeforeEach` and `DeferCleanup`.\n\n`AroundNode` can also be applied to `RunSpecs` to run before every node in the suite. This opens up new mechanisms for instrumenting individual nodes across an entire suite.\n\n## 2.24.0\n\n### Features\n\nSpecs can now be decorated with (e.g.) `SemVerConstraint(\"2.1.0\")` and `ginkgo --sem-ver-filter=\"2.1.1\"` will only run constrained specs that match the requested version. Learn more in the docs [here](https://onsi.github.io/ginkgo/#spec-semantic-version-filtering)! Thanks to @Icarus9913 for the PR.\n\n### Fixes\n\n- remove -o from run command [3f5d379]. fixes [#1582](https://github.com/onsi/ginkgo/issues/1582)\n\n### Maintenance\n\nNumerous dependency bumps and documentation fixes\n\n## 2.23.4\n\nPrior to this release Ginkgo would compute the incorrect number of available CPUs when running with `-p` in a linux container. Thanks to @emirot for the fix!\n\n### Features\n- Add automaxprocs for using CPUQuota [2b9c428]\n\n### Fixes\n- clarify gotchas about -vet flag [1f59d07]\n\n### Maintenance\n- bump dependencies [2d134d5]\n\n## 2.23.3\n\n### Fixes\n\n- allow `-` as a standalone argument [cfcc1a5]\n- Bug Fix: Add GinkoTBWrapper.Chdir() and GinkoTBWrapper.Context() [feaf292]\n- ignore exit code for symbol test on linux [88e2282]\n\n## 2.23.2\n\n🎉🎉🎉\n\nAt long last, some long-standing performance gaps between `ginkgo` and `go test` have been resolved!\n\nGinkgo operates by running `go test -c` to generate test binaries, and then running those binaries. It turns out that the compilation step of `go test -c` is slower than `go test`'s compilation step because `go test` strips out debug symbols (`ldflags=-w`) whereas `go test -c` does not.\n\nGinkgo now passes the appropriate `ldflags` to `go test -c` when running specs to strip out symbols. This is only done when it is safe to do so and symbols are preferred when profiling is enabled and when `ginkgo build` is called explicitly.\n\nThis, coupled, with the [instructions for disabling XProtect on MacOS](https://onsi.github.io/ginkgo/#if-you-are-running-on-macos) yields a much better performance experience with Ginkgo.\n\n## 2.23.1\n\n## 🚨 For users on MacOS 🚨\n\nA long-standing Ginkgo performance issue on MacOS seems to be due to mac's antimalware XProtect. You can follow the instructions [here](https://onsi.github.io/ginkgo/#if-you-are-running-on-macos) to disable it in your terminal. Doing so sped up Ginkgo's own test suite from 1m8s to 47s.\n\n### Fixes\n\nGinkgo's CLI is now a bit clearer if you pass flags in incorrectly:\n\n- make it clearer that you need to pass a filename to the various profile flags, not an absolute directory [a0e52ff]\n- emit an error and exit if the ginkgo invocation includes flags after positional arguments [b799d8d]\n\nThis might cause existing CI builds to fail. If so then it's likely that your CI build was misconfigured and should be corrected. Open an issue if you need help.\n\n## 2.23.0\n\nGinkgo 2.23.0 adds a handful of methods to `GinkgoT()` to make it compatible with the `testing.TB` interface in Go 1.24. `GinkgoT().Context()`, in particular, is a useful shorthand for generating a new context that will clean itself up in a `DeferCleanup()`. This has subtle behavior differences from the golang implementation but should make sense in a Ginkgo... um... context.\n\n### Features\n- bump to go 1.24.0 - support new testing.TB methods and add a test to cover testing.TB regressions [37a511b]\n\n### Fixes\n- fix edge case where build -o is pointing at an explicit file, not a directory [7556a86]\n- Fix binary paths when precompiling multiple suites. [4df06c6]\n\n### Maintenance\n- Fix: Correct Markdown list rendering in MIGRATING_TO_V2.md [cbcf39a]\n- docs: fix test workflow badge (#1512) [9b261ff]\n- Bump golang.org/x/net in /integration/_fixtures/version_mismatch_fixture (#1516) [00f19c8]\n- Bump golang.org/x/tools from 0.28.0 to 0.30.0 (#1515) [e98a4df]\n- Bump activesupport from 6.0.6.1 to 6.1.7.5 in /docs (#1504) [60cc4e2]\n- Bump github-pages from 231 to 232 in /docs (#1447) [fea6f2d]\n- Bump rexml from 3.2.8 to 3.3.9 in /docs (#1497) [31d7813]\n- Bump webrick from 1.8.1 to 1.9.1 in /docs (#1501) [fc3bbd6]\n- Code linting (#1500) [aee0d56]\n- change interface{} to any (#1502) [809a710]\n\n## 2.22.2\n\n### Maintenance\n- Bump github.com/onsi/gomega from 1.36.1 to 1.36.2 (#1499) [cc553ce]\n- Bump golang.org/x/crypto (#1498) [2170370]\n- Bump golang.org/x/net from 0.32.0 to 0.33.0 (#1496) [a96c44f]\n\n## 2.22.1\n\n### Fixes\nFix CSV encoding\n- Update tests [aab3da6]\n- Properly encode CSV rows [c09df39]\n- Add test case for proper csv escaping [96a80fc]\n- Add meta-test [43dad69]\n\n### Maintenance\n- ensure *.test files are gitignored so we don't accidentally commit compiled tests again [c88c634]\n- remove golang.org/x/net/context in favour of stdlib context [4df44bf]\n\n## 2.22.0\n\n### Features\n- Add label to serial nodes [0fcaa08]\n\nThis allows serial tests to be filtered using the `label-filter`\n\n### Maintenance\nVarious doc fixes\n\n## 2.21.0\n\n\n ### Features\n - add support for GINKGO_TIME_FORMAT [a69eb39]\n - add GINKGO_NO_COLOR to disable colors via environment variables [bcab9c8]\n\n ### Fixes\n - increase threshold in timeline matcher [e548367]\n - Fix the document by replacing `SpecsThatWillBeRun` with `SpecsThatWillRun`\n [c2c4d3c]\n\n ### Maintenance\n - bump various dependencies [7e65a00]\n\n## 2.20.2\n\nRequire Go 1.22+\n\n### Maintenance\n- bump go to v1.22 [a671816]\n\n## 2.20.1\n\n### Fixes\n- make BeSpecEvent duration matcher more forgiving [d6f9640]\n\n## 2.20.0\n\n### Features\n- Add buildvcs flag [be5ab95]\n\n### Maintenance\n- Add update-deps to makefile [d303d14]\n- bump all dependencies [7a50221]\n\n## 2.19.1\n\n### Fixes\n- update supported platforms for race conditions [63c8c30]\n- [build] Allow custom name for binaries. [ff41e27]\n\n### Maintenance\n- bump gomega [76f4e0c]\n- Bump rexml from 3.2.6 to 3.2.8 in /docs (#1417) [b69c00d]\n- Bump golang.org/x/sys from 0.20.0 to 0.21.0 (#1425) [f097741]\n\n## 2.19.0\n\n### Features\n\n[Label Sets](https://onsi.github.io/ginkgo/#label-sets) allow for more expressive and flexible label filtering.\n\n## 2.18.0\n\n### Features\n- Add --slience-skips and --force-newlines [f010b65]\n- fail when no tests were run and --fail-on-empty was set [d80eebe]\n\n### Fixes\n- Fix table entry context edge case [42013d6]\n\n### Maintenance\n- Bump golang.org/x/tools from 0.20.0 to 0.21.0 (#1406) [fcf1fd7]\n- Bump github.com/onsi/gomega from 1.33.0 to 1.33.1 (#1399) [8bb14fd]\n- Bump golang.org/x/net from 0.24.0 to 0.25.0 (#1407) [04bfad7]\n\n## 2.17.3\n\n### Fixes\n`ginkgo watch` now ignores hidden files [bde6e00]\n\n## 2.17.2\n\n### Fixes\n- fix: close files [32259c8]\n- fix github output log level for skipped specs [780e7a3]\n\n### Maintenance\n- Bump github.com/google/pprof [d91fe4e]\n- Bump github.com/go-task/slim-sprig to v3 [8cb662e]\n- Bump golang.org/x/net in /integration/_fixtures/version_mismatch_fixture (#1391) [3134422]\n- Bump github-pages from 230 to 231 in /docs (#1384) [eca81b4]\n- Bump golang.org/x/tools from 0.19.0 to 0.20.0 (#1383) [760def8]\n- Bump golang.org/x/net from 0.23.0 to 0.24.0 (#1381) [4ce33f4]\n- Fix test for gomega version bump [f2fcd97]\n- Bump github.com/onsi/gomega from 1.30.0 to 1.33.0 (#1390) [fd622d2]\n- Bump golang.org/x/tools from 0.17.0 to 0.19.0 (#1368) [5474a26]\n- Bump github-pages from 229 to 230 in /docs (#1359) [e6d1170]\n- Bump google.golang.org/protobuf from 1.28.0 to 1.33.0 (#1374) [7f447b2]\n- Bump golang.org/x/net from 0.20.0 to 0.23.0 (#1380) [f15239a]\n\n## 2.17.1\n\n### Fixes\n- If the user sets --seed=0, make sure all parallel nodes get the same seed [af0330d]\n\n## 2.17.0\n\n### Features\n\n- add `--github-output` for nicer output in github actions [e8a2056]\n\n### Maintenance\n\n- fix typo in core_dsl.go [977bc6f]\n- Fix typo in docs [e297e7b]\n\n## 2.16.0\n\n### Features\n- add SpecContext to reporting nodes\n\n### Fixes\n- merge coverages instead of combining them (#1329) (#1340) [23f0cc5]\n- core_dsl: disable Getwd() with environment variable (#1357) [cd418b7]\n\n### Maintenance\n- docs/index.md: Typo [2cebe8d]\n- fix docs [06de431]\n- chore: test with Go 1.22 (#1352) [898cba9]\n- Bump golang.org/x/tools from 0.16.1 to 0.17.0 (#1336) [17ae120]\n- Bump golang.org/x/sys from 0.15.0 to 0.16.0 (#1327) [5a179ed]\n- Bump github.com/go-logr/logr from 1.3.0 to 1.4.1 (#1321) [a1e6b69]\n- Bump github-pages and jekyll-feed in /docs (#1351) [d52951d]\n- Fix docs for handling failures in goroutines (#1339) [4471b2e]\n\n## 2.15.0\n\n### Features\n\n- JUnit reports now interpret Label(owner:X) and set owner to X. [8f3bd70]\n- include cancellation reason when cancelling spec context [96e915c]\n\n### Fixes\n\n- emit output of failed go tool cover invocation so users can try to debug things for themselves [c245d09]\n- fix outline when using nodot in ginkgo v2 [dca77c8]\n- Document areas where GinkgoT() behaves differently from testing.T [dbaf18f]\n- bugfix(docs): use Unsetenv instead of Clearenv (#1337) [6f67a14]\n\n### Maintenance\n\n- Bump to go 1.20 [4fcd0b3]\n\n## 2.14.0\n\n### Features\nYou can now use `GinkgoTB()` when you need an instance of `testing.TB` to pass to a library.\n\nPrior to this release table testing only supported generating individual `It`s for each test entry. `DescribeTableSubtree` extends table testing support to entire testing subtrees - under the hood `DescrieTableSubtree` generates a new container for each entry and invokes your function to fill our the container. See the [docs](https://onsi.github.io/ginkgo/#generating-subtree-tables) to learn more.\n\n- Introduce DescribeTableSubtree [65ec56d]\n- add GinkgoTB() to docs [4a2c832]\n- Add GinkgoTB() function (#1333) [92b6744]\n\n### Fixes\n- Fix typo in internal/suite.go (#1332) [beb9507]\n- Fix typo in docs/index.md (#1319) [4ac3a13]\n- allow wasm to compile with ginkgo present (#1311) [b2e5bc5]\n\n### Maintenance\n- Bump golang.org/x/tools from 0.16.0 to 0.16.1 (#1316) [465a8ec]\n- Bump actions/setup-go from 4 to 5 (#1313) [eab0e40]\n- Bump github/codeql-action from 2 to 3 (#1317) [fbf9724]\n- Bump golang.org/x/crypto (#1318) [3ee80ee]\n- Bump golang.org/x/tools from 0.14.0 to 0.16.0 (#1306) [123e1d5]\n- Bump github.com/onsi/gomega from 1.29.0 to 1.30.0 (#1297) [558f6e0]\n- Bump golang.org/x/net from 0.17.0 to 0.19.0 (#1307) [84ff7f3]\n\n## 2.13.2\n\n### Fixes\n- Fix file handler leak (#1309) [e2e81c8]\n- Avoid allocations with `(*regexp.Regexp).MatchString` (#1302) [3b2a2a7]\n\n## 2.13.1\n\n### Fixes\n- # 1296 fix(precompiled test guite): exec bit check omitted on Windows (#1301) [26eea01]\n\n### Maintenance\n- Bump github.com/go-logr/logr from 1.2.4 to 1.3.0 (#1291) [7161a9d]\n- Bump golang.org/x/sys from 0.13.0 to 0.14.0 (#1295) [7fc7b10]\n- Bump golang.org/x/tools from 0.12.0 to 0.14.0 (#1282) [74bbd65]\n- Bump github.com/onsi/gomega from 1.27.10 to 1.29.0 (#1290) [9373633]\n- Bump golang.org/x/net in /integration/_fixtures/version_mismatch_fixture (#1286) [6e3cf65]\n\n## 2.13.0\n\n### Features\n\nAdd PreviewSpect() to enable programmatic preview access to the suite report (fixes #1225)\n\n## 2.12.1\n\n### Fixes\n- Print logr prefix if it exists (#1275) [90d4846]\n\n### Maintenance\n- Bump actions/checkout from 3 to 4 (#1271) [555f543]\n- Bump golang.org/x/sys from 0.11.0 to 0.12.0 (#1270) [d867b7d]\n\n## 2.12.0\n\n### Features\n\n- feat: allow MustPassRepeatedly decorator to be set at suite level (#1266) [05de518]\n\n### Fixes\n\n- fix-errors-in-readme (#1244) [27c2f5d]\n\n### Maintenance\n\nVarious chores/dependency bumps.\n\n## 2.11.0\n\nIn prior versions of Ginkgo specs the CLI filter flags (e.g. `--focus`, `--label-filter`) would _override_ any programmatic focus. This behavior has proved surprising and confusing in at least the following ways:\n\n- users cannot combine programmatic filters and CLI filters to more efficiently select subsets of tests\n- CLI filters can override programmatic focus on CI systems resulting in an exit code of 0 despite the presence of (incorrectly!) committed focused specs.\n\nGoing forward Ginkgo will AND all programmatic and CLI filters. Moreover, the presence of any programmatic focused tests will always result in a non-zero exit code.\n\nThis change is technically a change in Ginkgo's external contract and may require some users to make changes to successfully adopt. Specifically: it's possible some users were intentionally using CLI filters to override programmatic focus. If this is you please open an issue so we can explore solutions to the underlying problem you are trying to solve.\n\n### Fixes\n- Programmatic focus is no longer overwrriten by CLI filters [d6bba86]\n\n### Maintenance\n- Bump github.com/onsi/gomega from 1.27.7 to 1.27.8 (#1218) [4a70a38]\n- Bump golang.org/x/sys from 0.8.0 to 0.9.0 (#1219) [97eda4d]\n\n## 2.10.0\n\n### Features\n- feat(ginkgo/generators): add --tags flag (#1216) [a782a77]\n adds a new --tags flag to ginkgo generate\n\n### Fixes\n- Fix broken link of MIGRATING_TO_V2.md (#1217) [548d78e]\n\n### Maintenance\n- Bump golang.org/x/tools from 0.9.1 to 0.9.3 (#1215) [2b76a5e]\n\n## 2.9.7\n\n### Fixes\n- fix race when multiple defercleanups are called in goroutines [07fc3a0]\n\n## 2.9.6\n\n### Fixes\n- fix: create parent directory before report files (#1212) [0ac65de]\n\n### Maintenance\n- Bump github.com/onsi/gomega from 1.27.6 to 1.27.7 (#1202) [3e39231]\n\n## 2.9.5\n\n### Fixes\n- ensure the correct deterministic sort order is produced when ordered specs are generated by a helper function [7fa0b6b]\n\n### Maintenance\n- fix generators link (#1200) [9f9d8b9]\n- Bump golang.org/x/tools from 0.8.0 to 0.9.1 (#1196) [150e3f2]\n- fix spelling err in docs (#1199) [0013b1a]\n- Bump golang.org/x/sys from 0.7.0 to 0.8.0 (#1193) [9e9e3e5]\n\n## 2.9.4\n\n### Fixes\n- fix hang with ginkgo -p (#1192) [15d4bdc] - this addresses a _long_ standing issue related to Ginkgo hanging when a child process spawned by the test does not exit.\n\n- fix: fail fast may cause Serial spec or cleanup Node interrupted (#1178) [8dea88b] - prior to this there was a small gap in which specs on other processes might start even if one process has tried to abort the suite.\n\n\n### Maintenance\n- Document run order when multiple setup nodes are at the same nesting level [903be81]\n\n## 2.9.3\n\n### Features\n- Add RenderTimeline to GinkgoT() [c0c77b6]\n\n### Fixes\n- update Measure deprecation message. fixes #1176 [227c662]\n- add newlines to GinkgoLogr (#1170) (#1171) [0de0e7c]\n\n### Maintenance\n- Bump commonmarker from 0.23.8 to 0.23.9 in /docs (#1183) [8b925ab]\n- Bump nokogiri from 1.14.1 to 1.14.3 in /docs (#1184) [e3795a4]\n- Bump golang.org/x/tools from 0.7.0 to 0.8.0 (#1182) [b453793]\n- Bump actions/setup-go from 3 to 4 (#1164) [73ed75b]\n- Bump github.com/onsi/gomega from 1.27.4 to 1.27.6 (#1173) [0a2bc64]\n- Bump github.com/go-logr/logr from 1.2.3 to 1.2.4 (#1174) [f41c557]\n- Bump golang.org/x/sys from 0.6.0 to 0.7.0 (#1179) [8e423e5]\n\n## 2.9.2\n\n### Maintenance\n- Bump github.com/go-task/slim-sprig (#1167) [3fcc5bf]\n- Bump github.com/onsi/gomega from 1.27.3 to 1.27.4 (#1163) [6143ffe]\n\n## 2.9.1\n\n### Fixes\nThis release fixes a longstanding issue where `ginkgo -coverpkg=./...` would not work. This is now resolved and fixes [#1161](https://github.com/onsi/ginkgo/issues/1161) and [#995](https://github.com/onsi/ginkgo/issues/995)\n- Support -coverpkg=./... [26ca1b5]\n- document coverpkg a bit more clearly [fc44c3b]\n\n### Maintenance\n- bump various dependencies\n- Improve Documentation and fix typo (#1158) [93de676]\n\n## 2.9.0\n\n### Features\n- AttachProgressReporter is an experimental feature that allows users to provide arbitrary information when a ProgressReport is requested [28801fe]\n\n- GinkgoT() has been expanded to include several Ginkgo-specific methods [2bd5a3b]\n\n The intent is to enable the development of third-party libraries that integrate deeply with Ginkgo using `GinkgoT()` to access Ginkgo's functionality.\n\n## 2.8.4\n\n### Features\n- Add OmitSuiteSetupNodes to JunitReportConfig (#1147) [979fbc2]\n- Add a reference to ginkgolinter in docs.index.md (#1143) [8432589]\n\n### Fixes\n- rename tools hack to see if it fixes things for downstream users [a8bb39a]\n\n### Maintenance\n- Bump golang.org/x/text (#1144) [41b2a8a]\n- Bump github.com/onsi/gomega from 1.27.0 to 1.27.1 (#1142) [7c4f583]\n\n## 2.8.3\n\nReleased to fix security issue in golang.org/x/net dependency\n\n### Maintenance\n\n- Bump golang.org/x/net from 0.6.0 to 0.7.0 (#1141) [fc1a02e]\n- remove tools.go hack from documentation [0718693]\n\n## 2.8.2\n\nGinkgo now includes a `tools.go` file in the root directory of the `ginkgo` package. This should allow modules that simply `go get github.com/onsi/ginkgo/v2` to also pull in the CLI dependencies. This obviates the need for consumers of Ginkgo to have their own `tools.go` file and makes it simpler to ensure that the version of the `ginkgo` CLI being used matches the version of the library. You can simply run `go run github.com/onsi/ginkgo/v2/ginkgo` to run the version of the cli associated with your package go.mod.\n\n### Maintenance\n\n- Bump github.com/onsi/gomega from 1.26.0 to 1.27.0 (#1139) [5767b0a]\n- Fix minor typos (#1138) [e1e9723]\n- Fix link in V2 Migration Guide (#1137) [a588f60]\n\n## 2.8.1\n\n### Fixes\n- lock around default report output to avoid triggering the race detector when calling By from goroutines [2d5075a]\n- don't run ReportEntries through sprintf [febbe38]\n\n### Maintenance\n- Bump golang.org/x/tools from 0.5.0 to 0.6.0 (#1135) [11a4860]\n- test: update matrix for Go 1.20 (#1130) [4890a62]\n- Bump golang.org/x/sys from 0.4.0 to 0.5.0 (#1133) [a774638]\n- Bump github.com/onsi/gomega from 1.25.0 to 1.26.0 (#1120) [3f233bd]\n- Bump github-pages from 227 to 228 in /docs (#1131) [f9b8649]\n- Bump activesupport from 6.0.6 to 6.0.6.1 in /docs (#1127) [6f8c042]\n- Update index.md with instructions on how to upgrade Ginkgo [833a75e]\n\n## 2.8.0\n\n### Features\n\n- Introduce GinkgoHelper() to track and exclude helper functions from potential CodeLocations [e19f556]\n\nModeled after `testing.T.Helper()`. Now, rather than write code like:\n\n```go\nfunc helper(model Model) {\n Expect(model).WithOffset(1).To(BeValid())\n Expect(model.SerialNumber).WithOffset(1).To(MatchRegexp(/[a-f0-9]*/))\n}\n```\n\nyou can stop tracking offsets (which makes nesting composing helpers nearly impossible) and simply write:\n\n```go\nfunc helper(model Model) {\n GinkgoHelper()\n Expect(model).To(BeValid())\n Expect(model.SerialNumber).To(MatchRegexp(/[a-f0-9]*/))\n}\n```\n\n- Introduce GinkgoLabelFilter() and Label().MatchesLabelFilter() to make it possible to programmatically match filters (fixes #1119) [2f6597c]\n\nYou can now write code like this:\n\n```go\nBeforeSuite(func() {\n\tif Label(\"slow\").MatchesLabelFilter(GinkgoLabelFilter()) {\n\t\t// do slow setup\n\t}\n\n\tif Label(\"fast\").MatchesLabelFilter(GinkgoLabelFilter()) {\n\t\t// do fast setup\n\t}\n})\n```\n\nto programmatically check whether a given set of labels will match the configured `--label-filter`.\n\n### Maintenance\n\n- Bump webrick from 1.7.0 to 1.8.1 in /docs (#1125) [ea4966e]\n- cdeql: add ruby language (#1124) [9dd275b]\n- dependabot: add bundler package-ecosystem for docs (#1123) [14e7bdd]\n\n## 2.7.1\n\n### Fixes\n- Bring back SuiteConfig.EmitSpecProgress to avoid compilation issue for consumers that set it manually [d2a1cb0]\n\n### Maintenance\n- Bump github.com/onsi/gomega from 1.24.2 to 1.25.0 (#1118) [cafece6]\n- Bump golang.org/x/tools from 0.4.0 to 0.5.0 (#1111) [eda66c2]\n- Bump golang.org/x/sys from 0.3.0 to 0.4.0 (#1112) [ac5ccaa]\n- Bump github.com/onsi/gomega from 1.24.1 to 1.24.2 (#1097) [eee6480]\n\n## 2.7.0\n\n### Features\n- Introduce ContinueOnFailure for Ordered containers [e0123ca] - Ordered containers that are also decorated with ContinueOnFailure will not stop running specs after the first spec fails.\n- Support for bootstrap commands to use custom data for templates (#1110) [7a2b242]\n- Support for labels and pending decorator in ginkgo outline output (#1113) [e6e3b98]\n- Color aliases for custom color support (#1101) [49fab7a]\n\n### Fixes\n- correctly ensure deterministic spec order, even if specs are generated by iterating over a map [89dda20]\n- Fix a bug where timedout specs were not correctly treated as failures when determining whether or not to run AfterAlls in an Ordered container.\n- Ensure go test coverprofile outputs to the expected location (#1105) [b0bd77b]\n\n## 2.6.1\n\n### Features\n- Override formatter colors from envvars - this is a new feature but an alternative approach involving config files might be taken in the future (#1095) [60240d1]\n\n### Fixes\n- GinkgoRecover now supports ignoring panics that match a specific, hidden, interface [301f3e2]\n\n### Maintenance\n- Bump github.com/onsi/gomega from 1.24.0 to 1.24.1 (#1077) [3643823]\n- Bump golang.org/x/tools from 0.2.0 to 0.4.0 (#1090) [f9f856e]\n- Bump nokogiri from 1.13.9 to 1.13.10 in /docs (#1091) [0d7087e]\n\n## 2.6.0\n\n### Features\n- `ReportBeforeSuite` provides access to the suite report before the suite begins.\n- Add junit config option for omitting leafnodetype (#1088) [956e6d2]\n- Add support to customize junit report config to omit spec labels (#1087) [de44005]\n\n### Fixes\n- Fix stack trace pruning so that it has a chance of working on windows [2165648]\n\n## 2.5.1\n\n### Fixes\n- skipped tests only show as 'S' when running with -v [3ab38ae]\n- Fix typo in docs/index.md (#1082) [55fc58d]\n- Fix typo in docs/index.md (#1081) [8a14f1f]\n- Fix link notation in docs/index.md (#1080) [2669612]\n- Fix typo in `--progress` deprecation message (#1076) [b4b7edc]\n\n### Maintenance\n- chore: Included githubactions in the dependabot config (#976) [baea341]\n- Bump golang.org/x/sys from 0.1.0 to 0.2.0 (#1075) [9646297]\n\n## 2.5.0\n\n### Ginkgo output now includes a timeline-view of the spec\n\nThis commit changes Ginkgo's default output. Spec details are now\npresented as a **timeline** that includes events that occur during the spec\nlifecycle interleaved with any GinkgoWriter content. This makes is much easier\nto understand the flow of a spec and where a given failure occurs.\n\nThe --progress, --slow-spec-threshold, --always-emit-ginkgo-writer flags\nand the SuppressProgressReporting decorator have all been deprecated. Instead\nthe existing -v and -vv flags better capture the level of verbosity to display. However,\na new --show-node-events flag is added to include node `> Enter` and `< Exit` events\nin the spec timeline.\n\nIn addition, JUnit reports now include the timeline (rendered with -vv) and custom JUnit\nreports can be configured and generated using\n`GenerateJUnitReportWithConfig(report types.Report, dst string, config JunitReportConfig)`\n\nCode should continue to work unchanged with this version of Ginkgo - however if you have tooling that\nwas relying on the specific output format of Ginkgo you _may_ run into issues. Ginkgo's console output is not guaranteed to be stable for tooling and automation purposes. You should, instead, use Ginkgo's JSON format\nto build tooling on top of as it has stronger guarantees to be stable from version to version.\n\n### Features\n- Provide details about which timeout expired [0f2fa27]\n\n### Fixes\n- Add Support Policy to docs [c70867a]\n\n### Maintenance\n- Bump github.com/onsi/gomega from 1.22.1 to 1.23.0 (#1070) [bb3b4e2]\n\n## 2.4.0\n\n### Features\n\n- DeferCleanup supports functions with multiple-return values [5e33c75]\n- Add GinkgoLogr (#1067) [bf78c28]\n- Introduction of 'MustPassRepeatedly' decorator (#1051) [047c02f]\n\n### Fixes\n- correcting some typos (#1064) [1403d3c]\n- fix flaky internal_integration interrupt specs [2105ba3]\n- Correct busted link in README [be6b5b9]\n\n### Maintenance\n- Bump actions/checkout from 2 to 3 (#1062) [8a2f483]\n- Bump golang.org/x/tools from 0.1.12 to 0.2.0 (#1065) [529c4e8]\n- Bump github/codeql-action from 1 to 2 (#1061) [da09146]\n- Bump actions/setup-go from 2 to 3 (#1060) [918040d]\n- Bump github.com/onsi/gomega from 1.22.0 to 1.22.1 (#1053) [2098e4d]\n- Bump nokogiri from 1.13.8 to 1.13.9 in /docs (#1066) [1d74122]\n- Add GHA to dependabot config [4442772]\n\n## 2.3.1\n\n## Fixes\nSeveral users were invoking `ginkgo` by installing the latest version of the cli via `go install github.com/onsi/ginkgo/v2/ginkgo@latest`. When 2.3.0 was released this resulted in an influx of issues as CI systems failed due to a change in the internal contract between the Ginkgo CLI and the Ginkgo library. Ginkgo only supports running the same version of the library as the cli (which is why both are packaged in the same repository).\n\nWith this patch release, the ginkgo CLI can now identify a version mismatch and emit a helpful error message.\n\n- Ginkgo cli can identify version mismatches and emit a helpful error message [bc4ae2f]\n- further emphasize that a version match is required when running Ginkgo on CI and/or locally [2691dd8]\n\n### Maintenance\n- bump gomega to v1.22.0 [822a937]\n\n## 2.3.0\n\n### Interruptible Nodes and Timeouts\n\nGinkgo now supports per-node and per-spec timeouts on interruptible nodes. Check out the [documentation for all the details](https://onsi.github.io/ginkgo/#spec-timeouts-and-interruptible-nodes) but the gist is you can now write specs like this:\n\n```go\nIt(\"is interruptible\", func(ctx SpecContext) { // or context.Context instead of SpecContext, both are valid.\n // do things until `ctx.Done()` is closed, for example:\n req, err := http.NewRequestWithContext(ctx, \"POST\", \"/build-widgets\", nil)\n Expect(err).NotTo(HaveOccured())\n _, err := http.DefaultClient.Do(req)\n Expect(err).NotTo(HaveOccured())\n\n Eventually(client.WidgetCount).WithContext(ctx).Should(Equal(17))\n}, NodeTimeout(time.Second*20), GracePeriod(5*time.Second))\n```\n\nand have Ginkgo ensure that the node completes before the timeout elapses. If it does elapse, or if an external interrupt is received (e.g. `^C`) then Ginkgo will cancel the context and wait for the Grace Period for the node to exit before proceeding with any cleanup nodes associated with the spec. The `ctx` provided by Ginkgo can also be passed down to Gomega's `Eventually` to have all assertions within the node governed by a single deadline.\n\n### Features\n\n- Ginkgo now records any additional failures that occur during the cleanup of a failed spec. In prior versions this information was quietly discarded, but the introduction of a more rigorous approach to timeouts and interruptions allows Ginkgo to better track subsequent failures.\n- `SpecContext` also provides a mechanism for third-party libraries to provide additional information when a Progress Report is generated. Gomega uses this to provide the current state of an `Eventually().WithContext()` assertion when a Progress Report is requested.\n- DescribeTable now exits with an error if it is not passed any Entries [a4c9865]\n\n## Fixes\n- fixes crashes on newer Ruby 3 installations by upgrading github-pages gem dependency [92c88d5]\n- Make the outline command able to use the DSL import [1be2427]\n\n## Maintenance\n- chore(docs): delete no meaning d [57c373c]\n- chore(docs): Fix hyperlinks [30526d5]\n- chore(docs): fix code blocks without language settings [cf611c4]\n- fix intra-doc link [b541bcb]\n\n## 2.2.0\n\n### Generate real-time Progress Reports [f91377c]\n\nGinkgo can now generate Progress Reports to point users at the current running line of code (including a preview of the actual source code) and a best guess at the most relevant subroutines.\n\nThese Progress Reports allow users to debug stuck or slow tests without exiting the Ginkgo process. A Progress Report can be generated at any time by sending Ginkgo a `SIGINFO` (`^T` on MacOS/BSD) or `SIGUSR1`.\n\nIn addition, the user can specify `--poll-progress-after` and `--poll-progress-interval` to have Ginkgo start periodically emitting progress reports if a given node takes too long. These can be overriden/set on a per-node basis with the `PollProgressAfter` and `PollProgressInterval` decorators.\n\nProgress Reports are emitted to stdout, and also stored in the machine-redable report formats that Ginkgo supports.\n\nGinkgo also uses this progress reporting infrastructure under the hood when handling timeouts and interrupts. This yields much more focused, useful, and informative stack traces than previously.\n\n### Features\n- `BeforeSuite`, `AfterSuite`, `SynchronizedBeforeSuite`, `SynchronizedAfterSuite`, and `ReportAfterSuite` now support (the relevant subset of) decorators. These can be passed in _after_ the callback functions that are usually passed into these nodes.\n\n As a result the **signature of these methods has changed** and now includes a trailing `args ...any`. For most users simply using the DSL, this change is transparent. However if you were assigning one of these functions to a custom variable (or passing it around) then your code may need to change to reflect the new signature.\n\n### Maintenance\n- Modernize the invocation of Ginkgo in github actions [0ffde58]\n- Update reocmmended CI settings in docs [896bbb9]\n- Speed up unnecessarily slow integration test [6d3a90e]\n\n## 2.1.6\n\n### Fixes\n- Add `SuppressProgressReporting` decorator to turn off --progress announcements for a given node [dfef62a]\n- chore: remove duplicate word in comments [7373214]\n\n## 2.1.5\n\n### Fixes\n- drop -mod=mod instructions; fixes #1026 [6ad7138]\n- Ensure `CurrentSpecReport` and `AddReportEntry` are thread-safe [817c09b]\n- remove stale importmap gcflags flag test [3cd8b93]\n- Always emit spec summary [5cf23e2] - even when only one spec has failed\n- Fix ReportAfterSuite usage in docs [b1864ad]\n- fixed typo (#997) [219cc00]\n- TrimRight is not designed to trim Suffix [71ebb74]\n- refactor: replace strings.Replace with strings.ReplaceAll (#978) [143d208]\n- fix syntax in examples (#975) [b69554f]\n\n### Maintenance\n- Bump github.com/onsi/gomega from 1.20.0 to 1.20.1 (#1027) [e5dfce4]\n- Bump tzinfo from 1.2.9 to 1.2.10 in /docs (#1006) [7ae91c4]\n- Bump github.com/onsi/gomega from 1.19.0 to 1.20.0 (#1005) [e87a85a]\n- test: add new Go 1.19 to test matrix (#1014) [bbefe12]\n- Bump golang.org/x/tools from 0.1.11 to 0.1.12 (#1012) [9327906]\n- Bump golang.org/x/tools from 0.1.10 to 0.1.11 (#993) [f44af96]\n- Bump nokogiri from 1.13.3 to 1.13.6 in /docs (#981) [ef336aa]\n\n## 2.1.4\n\n### Fixes\n- Numerous documentation typos\n- Prepend `when` when using `When` (this behavior was in 1.x but unintentionally lost during the 2.0 rewrite) [efce903]\n- improve error message when a parallel process fails to report back [a7bd1fe]\n- guard against concurrent map writes in DeprecationTracker [0976569]\n- Invoke reporting nodes during dry-run (fixes #956 and #935) [aae4480]\n- Fix ginkgo import circle [f779385]\n\n## 2.1.3\n\nSee [https://onsi.github.io/ginkgo/MIGRATING_TO_V2](https://onsi.github.io/ginkgo/MIGRATING_TO_V2) for details on V2.\n\n### Fixes\n- Calling By in a container node now emits a useful error. [ff12cee]\n\n## 2.1.2\n\n### Fixes\n\n- Track location of focused specs correctly in `ginkgo unfocus` [a612ff1]\n- Profiling suites with focused specs no longer generates an erroneous failure message [8fbfa02]\n- Several documentation typos fixed. Big thanks to everyone who helped catch them and report/fix them!\n\n## 2.1.1\n\nSee [https://onsi.github.io/ginkgo/MIGRATING_TO_V2](https://onsi.github.io/ginkgo/MIGRATING_TO_V2) for details on V2.\n\n### Fixes\n- Suites that only import the new dsl packages are now correctly identified as Ginkgo suites [ec17e17]\n\n## 2.1.0\n\nSee [https://onsi.github.io/ginkgo/MIGRATING_TO_V2](https://onsi.github.io/ginkgo/MIGRATING_TO_V2) for details on V2.\n\n2.1.0 is a minor release with a few tweaks:\n\n- Introduce new DSL packages to enable users to pick-and-choose which portions of the DSL to dot-import. [90868e2] More details [here](https://onsi.github.io/ginkgo/#alternatives-to-dot-importing-ginkgo).\n- Add error check for invalid/nil parameters to DescribeTable [6f8577e]\n- Myriad docs typos fixed (thanks everyone!) [718542a, ecb7098, 146654c, a8f9913, 6bdffde, 03dcd7e]\n\n## 2.0.0\n\nSee [https://onsi.github.io/ginkgo/MIGRATING_TO_V2](https://onsi.github.io/ginkgo/MIGRATING_TO_V2)\n\n## 1.16.5\n\nGinkgo 2.0 now has a Release Candidate. 1.16.5 advertises the existence of the RC.\n1.16.5 deprecates GinkgoParallelNode in favor of GinkgoParallelProcess\n\nYou can silence the RC advertisement by setting an `ACK_GINKGO_RC=true` environment variable or creating a file in your home directory called `.ack-ginkgo-rc`\n\n## 1.16.4\n\n### Fixes\n1.16.4 retracts 1.16.3. There are no code changes. The 1.16.3 tag was associated with the wrong commit and an attempt to change it after-the-fact has proven problematic. 1.16.4 retracts 1.16.3 in Ginkgo's go.mod and creates a new, correctly tagged, release.\n\n## 1.16.3\n\n### Features\n- Measure is now deprecated and emits a deprecation warning.\n\n## 1.16.2\n\n### Fixes\n- Deprecations can be suppressed by setting an `ACK_GINKGO_DEPRECATIONS=` environment variable.\n\n## 1.16.1\n\n### Fixes\n- Suppress --stream deprecation warning on windows (#793)\n\n## 1.16.0\n\n### Features\n- Advertise Ginkgo 2.0. Introduce deprecations. [9ef1913]\n - Update README.md to advertise that Ginkgo 2.0 is coming.\n - Backport the 2.0 DeprecationTracker and start alerting users\n about upcoming deprecations.\n\n- Add slim-sprig template functions to bootstrap/generate (#775) [9162b86]\n\n- Fix accidental reference to 1488 (#784) [9fb7fe4]\n\n## 1.15.2\n\n### Fixes\n- ignore blank `-focus` and `-skip` flags (#780) [e90a4a0]\n\n## 1.15.1\n\n### Fixes\n- reporters/junit: Use `system-out` element instead of `passed` (#769) [9eda305]\n\n## 1.15.0\n\n### Features\n- Adds 'outline' command to print the outline of specs/containers in a file (#754) [071c369] [6803cc3] [935b538] [06744e8] [0c40583]\n- Add support for using template to generate tests (#752) [efb9e69]\n- Add a Chinese Doc #755 (#756) [5207632]\n- cli: allow multiple -focus and -skip flags (#736) [9a782fb]\n\n### Fixes\n- Add _internal to filename of tests created with internal flag (#751) [43c12da]\n\n## 1.14.2\n\n### Fixes\n- correct handling windows backslash in import path (#721) [97f3d51]\n- Add additional methods to GinkgoT() to improve compatibility with the testing.TB interface [b5fe44d]\n\n## 1.14.1\n\n### Fixes\n- Discard exported method declaration when running ginkgo bootstrap (#558) [f4b0240]\n\n## 1.14.0\n\n### Features\n- Defer running top-level container nodes until RunSpecs is called [d44dedf]\n- [Document Ginkgo lifecycle](http://onsi.github.io/ginkgo/#understanding-ginkgos-lifecycle)\n- Add `extensions/globals` package (#692) [3295c8f] - this can be helpful in contexts where you are test-driving your test-generation code (see [#692](https://github.com/onsi/ginkgo/pull/692))\n- Print Skip reason in JUnit reporter if one was provided [820dfab]\n\n## 1.13.0\n\n### Features\n- Add a version of table.Entry that allows dumping the entry parameters. (#689) [21eaef2]\n\n### Fixes\n- Ensure integration tests pass in an environment sans GOPATH [606fba2]\n- Add books package (#568) [fc0e44e]\n- doc(readme): installation via \"tools package\" (#677) [83bb20e]\n- Solve the undefined: unix.Dup2 compile error on mips64le (#680) [0624f75]\n- Import package without dot (#687) [6321024]\n- Fix integration tests to stop require GOPATH (#686) [a912ec5]\n\n## 1.12.3\n\n### Fixes\n- Print correct code location of failing table test (#666) [c6d7afb]\n\n## 1.12.2\n\n### Fixes\n- Update dependencies [ea4a036]\n\n## 1.12.1\n\n### Fixes\n- Make unfocus (\"blur\") much faster (#674) [8b18061]\n- Fix typo (#673) [7fdcbe8]\n- Test against 1.14 and remove 1.12 [d5c2ad6]\n- Test if a coverprofile content is empty before checking its latest character (#670) [14d9fa2]\n- replace tail package with maintained one. this fixes go get errors (#667) [4ba33d4]\n- improve ginkgo performance - makes progress on #644 [a14f98e]\n- fix convert integration tests [1f8ba69]\n- fix typo successful -> successful (#663) [1ea49cf]\n- Fix invalid link (#658) [b886136]\n- convert utility : Include comments from source (#657) [1077c6d]\n- Explain what BDD means [d79e7fb]\n- skip race detector test on unsupported platform (#642) [f8ab89d]\n- Use Dup2 from golang.org/x/sys/unix instead of syscallDup (#638) [5d53c55]\n- Fix missing newline in combined coverage file (#641) [6a07ea2]\n- check if a spec is run before returning SpecSummary (#645) [8850000]\n\n## 1.12.0\n\n### Features\n- Add module definition (#630) [78916ab]\n\n## 1.11.0\n\n### Features\n- Add syscall for riscv64 architecture [f66e896]\n- teamcity reporter: output location of test failure as well as test definition (#626) [9869142]\n- teamcity reporter: output newline after every service message (#625) [3cfa02d]\n- Add support for go module when running `generate` command (#578) [9c89e3f]\n\n## 1.10.3\n\n### Fixes\n- Set go_import_path in travis.yml to allow internal packages in forks (#607) [3b721db]\n- Add integration test [d90e0dc]\n- Fix coverage files combining [e5dde8c]\n- A new CLI option: -ginkgo.reportFile (#601) [034fd25]\n\n## 1.10.2\n\n### Fixes\n- speed up table entry generateIt() (#609) [5049dc5]\n- Fix. Write errors to stderr instead of stdout (#610) [7bb3091]\n\n## 1.10.1\n\n### Fixes\n- stack backtrace: fix skipping (#600) [2a4c0bd]\n\n## 1.10.0\n\n### Fixes\n- stack backtrace: fix alignment and skipping [66915d6]\n- fix typo in documentation [8f97b93]\n\n## 1.9.0\n\n### Features\n- Option to print output into report, when tests have passed [0545415]\n\n### Fixes\n- Fixed typos in comments [0ecbc58]\n- gofmt code [a7f8bfb]\n- Simplify code [7454d00]\n- Simplify concatenation, incrementation and function assignment [4825557]\n- Avoid unnecessary conversions [9d9403c]\n- JUnit: include more detailed information about panic [19cca4b]\n- Print help to stdout when the user asks for help [4cb7441]\n\n\n## 1.8.0\n\n### New Features\n- allow config of the vet flag for `go test` (#562) [3cd45fa]\n- Support projects using go modules [d56ee76]\n\n### Fixes and Minor Improvements\n- chore(godoc): fixes typos in Measurement funcs [dbaca8e]\n- Optimize focus to avoid allocations [f493786]\n- Ensure generated test file names are underscored [505cc35]\n\n## 1.7.0\n\n### New Features\n- Add JustAfterEach (#484) [0d4f080]\n\n### Fixes\n- Correctly round suite time in junit reporter [2445fc1]\n- Avoid using -i argument to go test for Golang 1.10+ [46bbc26]\n\n## 1.6.0\n\n### New Features\n- add --debug flag to emit node output to files (#499) [39febac]\n\n### Fixes\n- fix: for `go vet` to pass [69338ec]\n- docs: fix for contributing instructions [7004cb1]\n- consolidate and streamline contribution docs (#494) [d848015]\n- Make generated Junit file compatible with \"Maven Surefire\" (#488) [e51bee6]\n- all: gofmt [000d317]\n- Increase eventually timeout to 30s [c73579c]\n- Clarify asynchronous test behavior [294d8f4]\n- Travis badge should only show master [26d2143]\n\n## 1.5.0 5/10/2018\n\n### New Features\n- Supports go v1.10 (#443, #446, #451) [e873237, 468e89e, e37dbfe, a37f4c0, c0b857d, bca5260, 4177ca8]\n- Add a When() synonym for Context() (#386) [747514b, 7484dad, 7354a07, dd826c8]\n- Re-add noisySkippings flag [652e15c]\n- Allow coverage to be displayed for focused specs (#367) [11459a8]\n- Handle -outputdir flag (#364) [228e3a8]\n- Handle -coverprofile flag (#355) [43392d5]\n\n### Fixes\n- When using custom reporters register the custom reporters *before* the default reporter. This allows users to see the output of any print statements in their customer reporters. (#365) [8382b23]\n- When running a test and calculating the coverage using the `-coverprofile` and `-outputdir` flags, Ginkgo fails with an error if the directory does not exist. This is due to an [issue in go 1.10](https://github.com/golang/go/issues/24588) (#446) [b36a6e0]\n- `unfocus` command ignores vendor folder (#459) [e5e551c, c556e43, a3b6351, 9a820dd]\n- Ignore packages whose tests are all ignored by go (#456) [7430ca7, 6d8be98]\n- Increase the threshold when checking time measurements (#455) [2f714bf, 68f622c]\n- Fix race condition in coverage tests (#423) [a5a8ff7, ab9c08b]\n- Add an extra new line after reporting spec run completion for test2json [874520d]\n- added name name field to junit reported testsuite [ae61c63]\n- Do not set the run time of a spec when the dryRun flag is used (#438) [457e2d9, ba8e856]\n- Process FWhen and FSpecify when unfocusing (#434) [9008c7b, ee65bd, df87dfe]\n- Synchronies the access to the state of specs to avoid race conditions (#430) [7d481bc, ae6829d]\n- Added Duration on GinkgoTestDescription (#383) [5f49dad, 528417e, 0747408, 329d7ed]\n- Fix Ginkgo stack trace on failure for Specify (#415) [b977ede, 65ca40e, 6c46eb8]\n- Update README with Go 1.6+, Golang -> Go (#409) [17f6b97, bc14b66, 20d1598]\n- Use fmt.Errorf instead of errors.New(fmt.Sprintf (#401) [a299f56, 44e2eaa]\n- Imports in generated code should follow conventions (#398) [0bec0b0, e8536d8]\n- Prevent data race error when Recording a benchmark value from multiple go routines (#390) [c0c4881, 7a241e9]\n- Replace GOPATH in Environment [4b883f0]\n\n\n## 1.4.0 7/16/2017\n\n- `ginkgo` now provides a hint if you accidentally forget to run `ginkgo bootstrap` to generate a `*_suite_test.go` file that actually invokes the Ginkgo test runner. [#345](https://github.com/onsi/ginkgo/pull/345)\n- thanks to improvements in `go test -c` `ginkgo` no longer needs to fix Go's compilation output to ensure compilation errors are expressed relative to the CWD. [#357]\n- `ginkgo watch -watchRegExp=...` allows you to specify a custom regular expression to watch. Only files matching the regular expression are watched for changes (the default is `\\.go$`) [#356]\n- `ginkgo` now always emits compilation output. Previously, only failed compilation output was printed out. [#277]\n- `ginkgo -requireSuite` now fails the test run if there are `*_test.go` files but `go test` fails to detect any tests. Typically this means you forgot to run `ginkgo bootstrap` to generate a suite file. [#344]\n- `ginkgo -timeout=DURATION` allows you to adjust the timeout for the entire test suite (default is 24 hours) [#248]\n\n## 1.3.0 3/28/2017\n\nImprovements:\n\n- Significantly improved parallel test distribution. Now instead of pre-sharding test cases across workers (which can result in idle workers and poor test performance) Ginkgo uses a shared queue to keep all workers busy until all tests are complete. This improves test-time performance and consistency.\n- `Skip(message)` can be used to skip the current test.\n- Added `extensions/table` - a Ginkgo DSL for [Table Driven Tests](http://onsi.github.io/ginkgo/#table-driven-tests)\n- Add `GinkgoRandomSeed()` - shorthand for `config.GinkgoConfig.RandomSeed`\n- Support for retrying flaky tests with `--flakeAttempts`\n- `ginkgo ./...` now recurses as you'd expect\n- Added `Specify` a synonym for `It`\n- Support colorise on Windows\n- Broader support for various go compilation flags in the `ginkgo` CLI\n\nBug Fixes:\n\n- Ginkgo tests now fail when you `panic(nil)` (#167)\n\n## 1.2.0 5/31/2015\n\nImprovements\n\n- `ginkgo -coverpkg` calls down to `go test -coverpkg` (#160)\n- `ginkgo -afterSuiteHook COMMAND` invokes the passed-in `COMMAND` after a test suite completes (#152)\n- Relaxed requirement for Go 1.4+. `ginkgo` now works with Go v1.3+ (#166)\n\n## 1.2.0-beta\n\nGinkgo now requires Go 1.4+\n\nImprovements:\n\n- Call reporters in reverse order when announcing spec completion -- allows custom reporters to emit output before the default reporter does.\n- Improved focus behavior. Now, this:\n\n ```golang\n FDescribe(\"Some describe\", func() {\n It(\"A\", func() {})\n\n FIt(\"B\", func() {})\n })\n ```\n\n will run `B` but *not* `A`. This tends to be a common usage pattern when in the thick of writing and debugging tests.\n- When `SIGINT` is received, Ginkgo will emit the contents of the `GinkgoWriter` before running the `AfterSuite`. Useful for debugging stuck tests.\n- When `--progress` is set, Ginkgo will write test progress (in particular, Ginkgo will say when it is about to run a BeforeEach, AfterEach, It, etc...) to the `GinkgoWriter`. This is useful for debugging stuck tests and tests that generate many logs.\n- Improved output when an error occurs in a setup or teardown block.\n- When `--dryRun` is set, Ginkgo will walk the spec tree and emit to its reporter *without* actually running anything. Best paired with `-v` to understand which specs will run in which order.\n- Add `By` to help document long `It`s. `By` simply writes to the `GinkgoWriter`.\n- Add support for precompiled tests:\n - `ginkgo build ` will now compile the package, producing a file named `package.test`\n - The compiled `package.test` file can be run directly. This runs the tests in series.\n - To run precompiled tests in parallel, you can run: `ginkgo -p package.test`\n- Support `bootstrap`ping and `generate`ing [Agouti](http://agouti.org) specs.\n- `ginkgo generate` and `ginkgo bootstrap` now honor the package name already defined in a given directory\n- The `ginkgo` CLI ignores `SIGQUIT`. Prevents its stack dump from interlacing with the underlying test suite's stack dump.\n- The `ginkgo` CLI now compiles tests into a temporary directory instead of the package directory. This necessitates upgrading to Go v1.4+.\n- `ginkgo -notify` now works on Linux\n\nBug Fixes:\n\n- If --skipPackages is used and all packages are skipped, Ginkgo should exit 0.\n- Fix tempfile leak when running in parallel\n- Fix incorrect failure message when a panic occurs during a parallel test run\n- Fixed an issue where a pending test within a focused context (or a focused test within a pending context) would skip all other tests.\n- Be more consistent about handling SIGTERM as well as SIGINT\n- When interrupted while concurrently compiling test suites in the background, Ginkgo now cleans up the compiled artifacts.\n- Fixed a long standing bug where `ginkgo -p` would hang if a process spawned by one of the Ginkgo parallel nodes does not exit. (Hooray!)\n\n## 1.1.0 (8/2/2014)\n\nNo changes, just dropping the beta.\n\n## 1.1.0-beta (7/22/2014)\nNew Features:\n\n- `ginkgo watch` now monitors packages *and their dependencies* for changes. The depth of the dependency tree can be modified with the `-depth` flag.\n- Test suites with a programmatic focus (`FIt`, `FDescribe`, etc...) exit with non-zero status code, even when they pass. This allows CI systems to detect accidental commits of focused test suites.\n- `ginkgo -p` runs the testsuite in parallel with an auto-detected number of nodes.\n- `ginkgo -tags=TAG_LIST` passes a list of tags down to the `go build` command.\n- `ginkgo --failFast` aborts the test suite after the first failure.\n- `ginkgo generate file_1 file_2` can take multiple file arguments.\n- Ginkgo now summarizes any spec failures that occurred at the end of the test run.\n- `ginkgo --randomizeSuites` will run tests *suites* in random order using the generated/passed-in seed.\n\nImprovements:\n\n- `ginkgo -skipPackage` now takes a comma-separated list of strings. If the *relative path* to a package matches one of the entries in the comma-separated list, that package is skipped.\n- `ginkgo --untilItFails` no longer recompiles between attempts.\n- Ginkgo now panics when a runnable node (`It`, `BeforeEach`, `JustBeforeEach`, `AfterEach`, `Measure`) is nested within another runnable node. This is always a mistake. Any test suites that panic because of this change should be fixed.\n\nBug Fixes:\n\n- `ginkgo boostrap` and `ginkgo generate` no longer fail when dealing with `hyphen-separated-packages`.\n- parallel specs are now better distributed across nodes - fixed a crashing bug where (for example) distributing 11 tests across 7 nodes would panic\n\n## 1.0.0 (5/24/2014)\nNew Features:\n\n- Add `GinkgoParallelNode()` - shorthand for `config.GinkgoConfig.ParallelNode`\n\nImprovements:\n\n- When compilation fails, the compilation output is rewritten to present a correct *relative* path. Allows ⌘-clicking in iTerm open the file in your text editor.\n- `--untilItFails` and `ginkgo watch` now generate new random seeds between test runs, unless a particular random seed is specified.\n\nBug Fixes:\n\n- `-cover` now generates a correctly combined coverprofile when running with in parallel with multiple `-node`s.\n- Print out the contents of the `GinkgoWriter` when `BeforeSuite` or `AfterSuite` fail.\n- Fix all remaining race conditions in Ginkgo's test suite.\n\n## 1.0.0-beta (4/14/2014)\nBreaking changes:\n\n- `thirdparty/gomocktestreporter` is gone. Use `GinkgoT()` instead\n- Modified the Reporter interface\n- `watch` is now a subcommand, not a flag.\n\nDSL changes:\n\n- `BeforeSuite` and `AfterSuite` for setting up and tearing down test suites.\n- `AfterSuite` is triggered on interrupt (`^C`) as well as exit.\n- `SynchronizedBeforeSuite` and `SynchronizedAfterSuite` for setting up and tearing down singleton resources across parallel nodes.\n\nCLI changes:\n\n- `watch` is now a subcommand, not a flag\n- `--nodot` flag can be passed to `ginkgo generate` and `ginkgo bootstrap` to avoid dot imports. This explicitly imports all exported identifiers in Ginkgo and Gomega. Refreshing this list can be done by running `ginkgo nodot`\n- Additional arguments can be passed to specs. Pass them after the `--` separator\n- `--skipPackage` flag takes a regexp and ignores any packages with package names passing said regexp.\n- `--trace` flag prints out full stack traces when errors occur, not just the line at which the error occurs.\n\nMisc:\n\n- Start using semantic versioning\n- Start maintaining changelog\n\nMajor refactor:\n\n- Pull out Ginkgo's internal to `internal`\n- Rename `example` everywhere to `spec`\n- Much more!\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/CONTRIBUTING.md",
"content": "# Contributing to Ginkgo\n\nYour contributions to Ginkgo are essential for its long-term maintenance and improvement.\n\n- Please **open an issue first** - describe what problem you are trying to solve and give the community a forum for input and feedback ahead of investing time in writing code!\n- Ensure adequate test coverage:\n - When adding to the Ginkgo library, add unit and/or integration tests (under the `integration` folder).\n - When adding to the Ginkgo CLI, note that there are very few unit tests. Please add an integration test.\n- Run `make` or:\n - Install ginkgo locally via `go install ./...`\n - Make sure all the tests succeed via `ginkgo -r -p`\n - Vet your changes via `go vet ./...`\n- Update the documentation. Ginkgo uses `godoc` comments and documentation in `docs/index.md`. You can run `bundle && bundle exec jekyll serve` in the `docs` directory to preview your changes.\n\nThanks for supporting Ginkgo!\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/LICENSE",
"content": "Copyright (c) 2013-2014 Onsi Fakhouri\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/Makefile",
"content": "# default task since it's first\n.PHONY: all\nall: vet test\n\n.PHONY: test\ntest:\n\tgo run github.com/onsi/ginkgo/v2/ginkgo -r -p -randomize-all -keep-going\n\n.PHONY: vet\nvet:\n\tgo vet ./...\n\n.PHONY: update-deps\nupdate-deps:\n\tgo get -u ./...\n\tgo mod tidy"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/README.md",
"content": "\n\n[](https://github.com/onsi/ginkgo/actions?query=workflow%3Atest+branch%3Amaster) | [Ginkgo Docs](https://onsi.github.io/ginkgo/)\n\n---\n\n# Ginkgo\n\nGinkgo is a mature testing framework for Go designed to help you write expressive specs. Ginkgo builds on top of Go's `testing` foundation and is complemented by the [Gomega](https://github.com/onsi/gomega) matcher library. Together, Ginkgo and Gomega let you express the intent behind your specs clearly:\n\n```go\nimport (\n . \"github.com/onsi/ginkgo/v2\"\n . \"github.com/onsi/gomega\"\n ...\n)\n\nvar _ = Describe(\"Checking books out of the library\", Label(\"library\"), func() {\n var library *libraries.Library\n var book *books.Book\n var valjean *users.User\n BeforeEach(func() {\n library = libraries.NewClient()\n book = &books.Book{\n Title: \"Les Miserables\",\n Author: \"Victor Hugo\",\n }\n valjean = users.NewUser(\"Jean Valjean\")\n })\n\n When(\"the library has the book in question\", func() {\n BeforeEach(func(ctx SpecContext) {\n Expect(library.Store(ctx, book)).To(Succeed())\n })\n\n Context(\"and the book is available\", func() {\n It(\"lends it to the reader\", func(ctx SpecContext) {\n Expect(valjean.Checkout(ctx, library, \"Les Miserables\")).To(Succeed())\n Expect(valjean.Books()).To(ContainElement(book))\n Expect(library.UserWithBook(ctx, book)).To(Equal(valjean))\n }, SpecTimeout(time.Second * 5))\n })\n\n Context(\"but the book has already been checked out\", func() {\n var javert *users.User\n BeforeEach(func(ctx SpecContext) {\n javert = users.NewUser(\"Javert\")\n Expect(javert.Checkout(ctx, library, \"Les Miserables\")).To(Succeed())\n })\n\n It(\"tells the user\", func(ctx SpecContext) {\n err := valjean.Checkout(ctx, library, \"Les Miserables\")\n Expect(err).To(MatchError(\"Les Miserables is currently checked out\"))\n }, SpecTimeout(time.Second * 5))\n\n It(\"lets the user place a hold and get notified later\", func(ctx SpecContext) {\n Expect(valjean.Hold(ctx, library, \"Les Miserables\")).To(Succeed())\n Expect(valjean.Holds(ctx)).To(ContainElement(book))\n\n By(\"when Javert returns the book\")\n Expect(javert.Return(ctx, library, book)).To(Succeed())\n\n By(\"it eventually informs Valjean\")\n notification := \"Les Miserables is ready for pick up\"\n Eventually(ctx, valjean.Notifications).Should(ContainElement(notification))\n\n Expect(valjean.Checkout(ctx, library, \"Les Miserables\")).To(Succeed())\n Expect(valjean.Books(ctx)).To(ContainElement(book))\n Expect(valjean.Holds(ctx)).To(BeEmpty())\n }, SpecTimeout(time.Second * 10))\n }) \n })\n\n When(\"the library does not have the book in question\", func() {\n It(\"tells the reader the book is unavailable\", func(ctx SpecContext) {\n err := valjean.Checkout(ctx, library, \"Les Miserables\")\n Expect(err).To(MatchError(\"Les Miserables is not in the library catalog\"))\n }, SpecTimeout(time.Second * 5))\n })\n})\n```\n\nJump to the [docs](https://onsi.github.io/ginkgo/) to learn more. It's easy to [bootstrap](https://onsi.github.io/ginkgo/#bootstrapping-a-suite) and start writing your [first specs](https://onsi.github.io/ginkgo/#adding-specs-to-a-suite).\n\nIf you have a question, comment, bug report, feature request, etc. please open a [GitHub issue](https://github.com/onsi/ginkgo/issues/new), or visit the [Ginkgo Slack channel](https://app.slack.com/client/T029RQSE6/CQQ50BBNW).\n\n## Capabilities\n\nWhether writing basic unit specs, complex integration specs, or even performance specs - Ginkgo gives you an expressive Domain-Specific Language (DSL) that will be familiar to users coming from frameworks such as [Quick](https://github.com/Quick/Quick), [RSpec](https://rspec.info), [Jasmine](https://jasmine.github.io), and [Busted](https://lunarmodules.github.io/busted/). This style of testing is sometimes referred to as \"Behavior-Driven Development\" (BDD) though Ginkgo's utility extends beyond acceptance-level testing.\n\nWith Ginkgo's DSL you can use nestable [`Describe`, `Context` and `When` container nodes](https://onsi.github.io/ginkgo/#organizing-specs-with-container-nodes) to help you organize your specs. [`BeforeEach` and `AfterEach` setup nodes](https://onsi.github.io/ginkgo/#extracting-common-setup-beforeeach) for setup and cleanup. [`It` and `Specify` subject nodes](https://onsi.github.io/ginkgo/#spec-subjects-it) that hold your assertions. [`BeforeSuite` and `AfterSuite` nodes](https://onsi.github.io/ginkgo/#suite-setup-and-cleanup-beforesuite-and-aftersuite) to prep for and cleanup after a suite... and [much more!](https://onsi.github.io/ginkgo/#writing-specs).\n\nAt runtime, Ginkgo can run your specs in reproducibly [random order](https://onsi.github.io/ginkgo/#spec-randomization) and has sophisticated support for [spec parallelization](https://onsi.github.io/ginkgo/#spec-parallelization). In fact, running specs in parallel is as easy as\n\n```bash\nginkgo -p\n```\n\nBy following [established patterns for writing parallel specs](https://onsi.github.io/ginkgo/#patterns-for-parallel-integration-specs) you can build even large, complex integration suites that parallelize cleanly and run performantly. And you don't have to worry about your spec suite hanging or leaving a mess behind - Ginkgo provides a per-node `context.Context` and the capability to interrupt the spec after a set period of time - and then clean up.\n\nAs your suites grow Ginkgo helps you keep your specs organized with [labels](https://onsi.github.io/ginkgo/#spec-labels) and lets you easily run [subsets of specs](https://onsi.github.io/ginkgo/#filtering-specs), either [programmatically](https://onsi.github.io/ginkgo/#focused-specs) or on the [command line](https://onsi.github.io/ginkgo/#combining-filters). And Ginkgo's reporting infrastructure generates machine-readable output in a [variety of formats](https://onsi.github.io/ginkgo/#generating-machine-readable-reports) _and_ allows you to build your own [custom reporting infrastructure](https://onsi.github.io/ginkgo/#generating-reports-programmatically).\n\nGinkgo ships with `ginkgo`, a [command line tool](https://onsi.github.io/ginkgo/#ginkgo-cli-overview) with support for generating, running, filtering, and profiling Ginkgo suites. You can even have Ginkgo automatically run your specs when it detects a change with `ginkgo watch`, enabling rapid feedback loops during test-driven development.\n\nAnd that's just Ginkgo! [Gomega](https://onsi.github.io/gomega/) brings a rich, mature, family of [assertions and matchers](https://onsi.github.io/gomega/#provided-matchers) to your suites. With Gomega you can easily mix [synchronous and asynchronous assertions](https://onsi.github.io/ginkgo/#patterns-for-asynchronous-testing) in your specs. You can even build your own set of expressive domain-specific matchers quickly and easily by composing Gomega's [existing building blocks](https://onsi.github.io/ginkgo/#building-custom-matchers).\n\nHappy Testing!\n\n## License\n\nGinkgo is MIT-Licensed\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md)\n\n## Sponsors\n\nSponsors commit to a [sponsorship](https://github.com/sponsors/onsi) for a year. If you're an organization that makes use of Ginkgo please consider becoming a sponsor!\n\n
\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/RELEASING.md",
"content": "A Ginkgo release is a tagged git sha and a GitHub release. To cut a release:\n\n1. Ensure CHANGELOG.md is up to date.\n - Use \n ```bash\n LAST_VERSION=$(git tag --sort=version:refname | tail -n1)\n CHANGES=$(git log --pretty=format:'- %s [%h]' HEAD...$LAST_VERSION)\n echo -e \"## NEXT\\n\\n$CHANGES\\n\\n### Features\\n\\n### Fixes\\n\\n### Maintenance\\n\\n$(cat CHANGELOG.md)\" > CHANGELOG.md\n ```\n to update the changelog\n - Categorize the changes into\n - Breaking Changes (requires a major version)\n - New Features (minor version)\n - Fixes (fix version)\n - Maintenance (which in general should not be mentioned in `CHANGELOG.md` as they have no user impact)\n1. Update `VERSION` in `types/version.go`\n1. Commit, push, and release:\n ```\n git commit -m \"vM.m.p\"\n git push\n gh release create \"vM.m.p\"\n git fetch --tags origin master\n ```"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/config/deprecated.go",
"content": "package config\n\n// GinkgoConfigType has been deprecated and its equivalent now lives in\n// the types package. You can no longer access Ginkgo configuration from the config\n// package. Instead use the DSL's GinkgoConfiguration() function to get copies of the\n// current configuration\n//\n// GinkgoConfigType is still here so custom V1 reporters do not result in a compilation error\n// It will be removed in a future minor release of Ginkgo\ntype GinkgoConfigType = DeprecatedGinkgoConfigType\ntype DeprecatedGinkgoConfigType struct {\n\tRandomSeed int64\n\tRandomizeAllSpecs bool\n\tRegexScansFilePath bool\n\tFocusStrings []string\n\tSkipStrings []string\n\tSkipMeasurements bool\n\tFailOnPending bool\n\tFailFast bool\n\tFlakeAttempts int\n\tEmitSpecProgress bool\n\tDryRun bool\n\tDebugParallel bool\n\n\tParallelNode int\n\tParallelTotal int\n\tSyncHost string\n\tStreamHost string\n}\n\n// DefaultReporterConfigType has been deprecated and its equivalent now lives in\n// the types package. You can no longer access Ginkgo configuration from the config\n// package. Instead use the DSL's GinkgoConfiguration() function to get copies of the\n// current configuration\n//\n// DefaultReporterConfigType is still here so custom V1 reporters do not result in a compilation error\n// It will be removed in a future minor release of Ginkgo\ntype DefaultReporterConfigType = DeprecatedDefaultReporterConfigType\ntype DeprecatedDefaultReporterConfigType struct {\n\tNoColor bool\n\tSlowSpecThreshold float64\n\tNoisyPendings bool\n\tNoisySkippings bool\n\tSuccinct bool\n\tVerbose bool\n\tFullTrace bool\n\tReportPassed bool\n\tReportFile string\n}\n\n// Sadly there is no way to gracefully deprecate access to these global config variables.\n// Users who need access to Ginkgo's configuration should use the DSL's GinkgoConfiguration() method\n// These new unwieldy type names exist to give users a hint when they try to compile and the compilation fails\ntype GinkgoConfigIsNoLongerAccessibleFromTheConfigPackageUseTheDSLsGinkgoConfigurationFunctionInstead struct{}\n\n// Sadly there is no way to gracefully deprecate access to these global config variables.\n// Users who need access to Ginkgo's configuration should use the DSL's GinkgoConfiguration() method\n// These new unwieldy type names exist to give users a hint when they try to compile and the compilation fails\nvar GinkgoConfig = GinkgoConfigIsNoLongerAccessibleFromTheConfigPackageUseTheDSLsGinkgoConfigurationFunctionInstead{}\n\n// Sadly there is no way to gracefully deprecate access to these global config variables.\n// Users who need access to Ginkgo's configuration should use the DSL's GinkgoConfiguration() method\n// These new unwieldy type names exist to give users a hint when they try to compile and the compilation fails\ntype DefaultReporterConfigIsNoLongerAccessibleFromTheConfigPackageUseTheDSLsGinkgoConfigurationFunctionInstead struct{}\n\n// Sadly there is no way to gracefully deprecate access to these global config variables.\n// Users who need access to Ginkgo's configuration should use the DSL's GinkgoConfiguration() method\n// These new unwieldy type names exist to give users a hint when they try to compile and the compilation fails\nvar DefaultReporterConfig = DefaultReporterConfigIsNoLongerAccessibleFromTheConfigPackageUseTheDSLsGinkgoConfigurationFunctionInstead{}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/core_dsl.go",
"content": "/*\nGinkgo is a testing framework for Go designed to help you write expressive tests.\nhttps://github.com/onsi/ginkgo\nMIT-Licensed\n\nThe godoc documentation outlines Ginkgo's API. Since Ginkgo is a Domain-Specific Language it is important to\nbuild a mental model for Ginkgo - the narrative documentation at https://onsi.github.io/ginkgo/ is designed to help you do that.\nYou should start there - even a brief skim will be helpful. At minimum you should skim through the https://onsi.github.io/ginkgo/#getting-started chapter.\n\nGinkgo's is best paired with the Gomega matcher library: https://github.com/onsi/gomega\n\nYou can run Ginkgo specs with go test - however we recommend using the ginkgo cli. It enables functionality\nthat go test does not (especially running suites in parallel). You can learn more at https://onsi.github.io/ginkgo/#ginkgo-cli-overview\nor by running 'ginkgo help'.\n*/\npackage ginkgo\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"slices\"\n\t\"strings\"\n\n\t\"github.com/go-logr/logr\"\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/internal\"\n\t\"github.com/onsi/ginkgo/v2/internal/global\"\n\t\"github.com/onsi/ginkgo/v2/internal/interrupt_handler\"\n\t\"github.com/onsi/ginkgo/v2/internal/parallel_support\"\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nconst GINKGO_VERSION = types.VERSION\n\nvar flagSet types.GinkgoFlagSet\nvar deprecationTracker = types.NewDeprecationTracker()\nvar suiteConfig = types.NewDefaultSuiteConfig()\nvar reporterConfig = types.NewDefaultReporterConfig()\nvar suiteDidRun = false\nvar outputInterceptor internal.OutputInterceptor\nvar client parallel_support.Client\n\nfunc init() {\n\tvar err error\n\tflagSet, err = types.BuildTestSuiteFlagSet(&suiteConfig, &reporterConfig)\n\texitIfErr(err)\n\twriter := internal.NewWriter(os.Stdout)\n\tGinkgoWriter = writer\n\tGinkgoLogr = internal.GinkgoLogrFunc(writer)\n}\n\nfunc exitIfErr(err error) {\n\tif err != nil {\n\t\tif outputInterceptor != nil {\n\t\t\toutputInterceptor.Shutdown()\n\t\t}\n\t\tif client != nil {\n\t\t\tclient.Close()\n\t\t}\n\t\tfmt.Fprintln(formatter.ColorableStdErr, err.Error())\n\t\tos.Exit(1)\n\t}\n}\n\nfunc exitIfErrors(errors []error) {\n\tif len(errors) > 0 {\n\t\tif outputInterceptor != nil {\n\t\t\toutputInterceptor.Shutdown()\n\t\t}\n\t\tif client != nil {\n\t\t\tclient.Close()\n\t\t}\n\t\tfor _, err := range errors {\n\t\t\tfmt.Fprintln(formatter.ColorableStdErr, err.Error())\n\t\t}\n\t\tos.Exit(1)\n\t}\n}\n\n// The interface implemented by GinkgoWriter\ntype GinkgoWriterInterface interface {\n\tio.Writer\n\n\tPrint(a ...any)\n\tPrintf(format string, a ...any)\n\tPrintln(a ...any)\n\n\tTeeTo(writer io.Writer)\n\tClearTeeWriters()\n}\n\n/*\nSpecContext is the context object passed into nodes that are subject to a timeout or need to be notified of an interrupt. It implements the standard context.Context interface but also contains additional helpers to provide an extensibility point for Ginkgo. (As an example, Gomega's Eventually can use the methods defined on SpecContext to provide deeper integration with Ginkgo).\n\nYou can do anything with SpecContext that you do with a typical context.Context including wrapping it with any of the context.With* methods.\n\nGinkgo will cancel the SpecContext when a node is interrupted (e.g. by the user sending an interrupt signal) or when a node has exceeded its allowed run-time. Note, however, that even in cases where a node has a deadline, SpecContext will not return a deadline via .Deadline(). This is because Ginkgo does not use a WithDeadline() context to model node deadlines as Ginkgo needs control over the precise timing of the context cancellation to ensure it can provide an accurate progress report at the moment of cancellation.\n*/\ntype SpecContext = internal.SpecContext\n\n/*\nGinkgoWriter implements a GinkgoWriterInterface and io.Writer\n\nWhen running in verbose mode (ginkgo -v) any writes to GinkgoWriter will be immediately printed\nto stdout. Otherwise, GinkgoWriter will buffer any writes produced during the current test and flush them to screen\nonly if the current test fails.\n\nGinkgoWriter also provides convenience Print, Printf and Println methods and allows you to tee to a custom writer via GinkgoWriter.TeeTo(writer).\nWrites to GinkgoWriter are immediately sent to any registered TeeTo() writers. You can unregister all TeeTo() Writers with GinkgoWriter.ClearTeeWriters()\n\nYou can learn more at https://onsi.github.io/ginkgo/#logging-output\n*/\nvar GinkgoWriter GinkgoWriterInterface\n\n/*\nGinkgoLogr is a logr.Logger that writes to GinkgoWriter\n*/\nvar GinkgoLogr logr.Logger\n\n// The interface by which Ginkgo receives *testing.T\ntype GinkgoTestingT interface {\n\tFail()\n}\n\n/*\nGinkgoConfiguration returns the configuration of the current suite.\n\nThe first return value is the SuiteConfig which controls aspects of how the suite runs,\nthe second return value is the ReporterConfig which controls aspects of how Ginkgo's default\nreporter emits output.\n\nMutating the returned configurations has no effect. To reconfigure Ginkgo programmatically you need\nto pass in your mutated copies into RunSpecs().\n\nYou can learn more at https://onsi.github.io/ginkgo/#overriding-ginkgos-command-line-configuration-in-the-suite\n*/\nfunc GinkgoConfiguration() (types.SuiteConfig, types.ReporterConfig) {\n\treturn suiteConfig, reporterConfig\n}\n\n/*\nGinkgoRandomSeed returns the seed used to randomize spec execution order. It is\nuseful for seeding your own pseudorandom number generators to ensure\nconsistent executions from run to run, where your tests contain variability (for\nexample, when selecting random spec data).\n\nYou can learn more at https://onsi.github.io/ginkgo/#spec-randomization\n*/\nfunc GinkgoRandomSeed() int64 {\n\treturn suiteConfig.RandomSeed\n}\n\n/*\nGinkgoParallelProcess returns the parallel process number for the current ginkgo process\nThe process number is 1-indexed. You can use GinkgoParallelProcess() to shard access to shared\nresources across your suites. You can learn more about patterns for sharding at https://onsi.github.io/ginkgo/#patterns-for-parallel-integration-specs\n\nFor more on how specs are parallelized in Ginkgo, see http://onsi.github.io/ginkgo/#spec-parallelization\n*/\nfunc GinkgoParallelProcess() int {\n\treturn suiteConfig.ParallelProcess\n}\n\n/*\nGinkgoHelper marks the function it's called in as a test helper. When a failure occurs inside a helper function, Ginkgo will skip the helper when analyzing the stack trace to identify where the failure occurred.\n\nThis is an alternative, simpler, mechanism to passing in a skip offset when calling Fail or using Gomega.\n*/\nfunc GinkgoHelper() {\n\ttypes.MarkAsHelper(1)\n}\n\n/*\nGinkgoLabelFilter() returns the label filter configured for this suite via `--label-filter`.\n\nYou can use this to manually check if a set of labels would satisfy the filter via:\n\n\tif (Label(\"cat\", \"dog\").MatchesLabelFilter(GinkgoLabelFilter())) {\n\t\t//...\n\t}\n*/\nfunc GinkgoLabelFilter() string {\n\tsuiteConfig, _ := GinkgoConfiguration()\n\treturn suiteConfig.LabelFilter\n}\n\n/*\nGinkgoSemVerFilter() returns the semantic version filter configured for this suite via `--sem-ver-filter`.\n\nYou can use this to manually check if a set of semantic version constraints would satisfy the filter via:\n\n\tif (SemVerConstraint(\"> 2.6.0\", \"< 2.8.0\").MatchesSemVerFilter(GinkgoSemVerFilter())) {\n\t\t//...\n\t}\n*/\nfunc GinkgoSemVerFilter() string {\n\tsuiteConfig, _ := GinkgoConfiguration()\n\treturn suiteConfig.SemVerFilter\n}\n\n/*\nPauseOutputInterception() pauses Ginkgo's output interception. This is only relevant\nwhen running in parallel and output to stdout/stderr is being intercepted. You generally\ndon't need to call this function - however there are cases when Ginkgo's output interception\nmechanisms can interfere with external processes launched by the test process.\n\nIn particular, if an external process is launched that has cmd.Stdout/cmd.Stderr set to os.Stdout/os.Stderr\nthen Ginkgo's output interceptor will hang. To circumvent this, set cmd.Stdout/cmd.Stderr to GinkgoWriter.\nIf, for some reason, you aren't able to do that, you can PauseOutputInterception() before starting the process\nthen ResumeOutputInterception() after starting it.\n\nNote that PauseOutputInterception() does not cause stdout writes to print to the console -\nthis simply stops intercepting and storing stdout writes to an internal buffer.\n*/\nfunc PauseOutputInterception() {\n\tif outputInterceptor == nil {\n\t\treturn\n\t}\n\toutputInterceptor.PauseIntercepting()\n}\n\n// ResumeOutputInterception() - see docs for PauseOutputInterception()\nfunc ResumeOutputInterception() {\n\tif outputInterceptor == nil {\n\t\treturn\n\t}\n\toutputInterceptor.ResumeIntercepting()\n}\n\n/*\nRunSpecs is the entry point for the Ginkgo spec runner.\n\nYou must call this within a Golang testing TestX(t *testing.T) function.\nIf you bootstrapped your suite with \"ginkgo bootstrap\" this is already\ndone for you.\n\nGinkgo is typically configured via command-line flags. This configuration\ncan be overridden, however, and passed into RunSpecs as optional arguments:\n\n\tfunc TestMySuite(t *testing.T) {\n\t\tRegisterFailHandler(gomega.Fail)\n\t\t// fetch the current config\n\t\tsuiteConfig, reporterConfig := GinkgoConfiguration()\n\t\t// adjust it\n\t\tsuiteConfig.SkipStrings = []string{\"NEVER-RUN\"}\n\t\treporterConfig.FullTrace = true\n\t\t// pass it in to RunSpecs\n\t\tRunSpecs(t, \"My Suite\", suiteConfig, reporterConfig)\n\t}\n\nNote that some configuration changes can lead to undefined behavior. For example,\nyou should not change ParallelProcess or ParallelTotal as the Ginkgo CLI is responsible\nfor setting these and orchestrating parallel specs across the parallel processes. See http://onsi.github.io/ginkgo/#spec-parallelization\nfor more on how specs are parallelized in Ginkgo.\n\nYou can also pass suite-level Label() decorators to RunSpecs. The passed-in labels will apply to all specs in the suite.\n*/\nfunc RunSpecs(t GinkgoTestingT, description string, args ...any) bool {\n\tif suiteDidRun {\n\t\texitIfErr(types.GinkgoErrors.RerunningSuite())\n\t}\n\tsuiteDidRun = true\n\terr := global.PushClone()\n\tif err != nil {\n\t\texitIfErr(err)\n\t}\n\tdefer global.PopClone()\n\n\tsuiteLabels, suiteSemVerConstraints, suiteComponentSemVerConstraints, suiteAroundNodes := extractSuiteConfiguration(args)\n\n\tvar reporter reporters.Reporter\n\tif suiteConfig.ParallelTotal == 1 {\n\t\treporter = reporters.NewDefaultReporter(reporterConfig, formatter.ColorableStdOut)\n\t\toutputInterceptor = internal.NoopOutputInterceptor{}\n\t\tclient = nil\n\t} else {\n\t\treporter = reporters.NoopReporter{}\n\t\tswitch strings.ToLower(suiteConfig.OutputInterceptorMode) {\n\t\tcase \"swap\":\n\t\t\toutputInterceptor = internal.NewOSGlobalReassigningOutputInterceptor()\n\t\tcase \"none\":\n\t\t\toutputInterceptor = internal.NoopOutputInterceptor{}\n\t\tdefault:\n\t\t\toutputInterceptor = internal.NewOutputInterceptor()\n\t\t}\n\t\tclient = parallel_support.NewClient(suiteConfig.ParallelHost)\n\t\tif !client.Connect() {\n\t\t\tclient = nil\n\t\t\texitIfErr(types.GinkgoErrors.UnreachableParallelHost(suiteConfig.ParallelHost))\n\t\t}\n\t\tdefer client.Close()\n\t}\n\n\twriter := GinkgoWriter.(*internal.Writer)\n\tif reporterConfig.Verbosity().GTE(types.VerbosityLevelVerbose) && suiteConfig.ParallelTotal == 1 {\n\t\twriter.SetMode(internal.WriterModeStreamAndBuffer)\n\t} else {\n\t\twriter.SetMode(internal.WriterModeBufferOnly)\n\t}\n\n\tif reporterConfig.WillGenerateReport() {\n\t\tregisterReportAfterSuiteNodeForAutogeneratedReports(reporterConfig)\n\t}\n\n\terr = global.Suite.BuildTree()\n\texitIfErr(err)\n\tsuitePath, err := getwd()\n\texitIfErr(err)\n\tsuitePath, err = filepath.Abs(suitePath)\n\texitIfErr(err)\n\n\tpassed, hasFocusedTests := global.Suite.Run(description, suiteLabels, suiteSemVerConstraints, suiteComponentSemVerConstraints, suiteAroundNodes, suitePath, global.Failer, reporter, writer, outputInterceptor, interrupt_handler.NewInterruptHandler(client), client, internal.RegisterForProgressSignal, suiteConfig)\n\toutputInterceptor.Shutdown()\n\n\tflagSet.ValidateDeprecations(deprecationTracker)\n\tif deprecationTracker.DidTrackDeprecations() {\n\t\tfmt.Fprintln(formatter.ColorableStdErr, deprecationTracker.DeprecationsReport())\n\t}\n\n\tif !passed {\n\t\tt.Fail()\n\t}\n\n\tif passed && hasFocusedTests && strings.TrimSpace(os.Getenv(\"GINKGO_EDITOR_INTEGRATION\")) == \"\" {\n\t\tfmt.Println(\"PASS | FOCUSED\")\n\t\tos.Exit(types.GINKGO_FOCUS_EXIT_CODE)\n\t}\n\treturn passed\n}\n\nfunc extractSuiteConfiguration(args []any) (Labels, SemVerConstraints, ComponentSemVerConstraints, types.AroundNodes) {\n\tsuiteLabels := Labels{}\n\tsuiteSemVerConstraints := SemVerConstraints{}\n\tsuiteComponentSemVerConstraints := ComponentSemVerConstraints{}\n\taroundNodes := types.AroundNodes{}\n\tconfigErrors := []error{}\n\tfor _, arg := range args {\n\t\tswitch arg := arg.(type) {\n\t\tcase types.SuiteConfig:\n\t\t\tsuiteConfig = arg\n\t\tcase types.ReporterConfig:\n\t\t\treporterConfig = arg\n\t\tcase Labels:\n\t\t\tsuiteLabels = append(suiteLabels, arg...)\n\t\tcase SemVerConstraints:\n\t\t\tsuiteSemVerConstraints = append(suiteSemVerConstraints, arg...)\n\t\tcase ComponentSemVerConstraints:\n\t\t\tfor component, constraints := range arg {\n\t\t\t\tsuiteComponentSemVerConstraints[component] = append(suiteComponentSemVerConstraints[component], constraints...)\n\t\t\t\tsuiteComponentSemVerConstraints[component] = slices.Compact(suiteComponentSemVerConstraints[component])\n\t\t\t}\n\t\tcase types.AroundNodeDecorator:\n\t\t\taroundNodes = append(aroundNodes, arg)\n\t\tdefault:\n\t\t\tconfigErrors = append(configErrors, types.GinkgoErrors.UnknownTypePassedToRunSpecs(arg))\n\t\t}\n\t}\n\texitIfErrors(configErrors)\n\n\tconfigErrors = types.VetConfig(flagSet, suiteConfig, reporterConfig)\n\tif len(configErrors) > 0 {\n\t\tfmt.Fprint(formatter.ColorableStdErr, formatter.F(\"{{red}}Ginkgo detected configuration issues:{{/}}\\n\"))\n\t\tfor _, err := range configErrors {\n\t\t\tfmt.Fprint(formatter.ColorableStdErr, err.Error())\n\t\t}\n\t\tos.Exit(1)\n\t}\n\n\treturn suiteLabels, suiteSemVerConstraints, suiteComponentSemVerConstraints, aroundNodes\n}\n\nfunc getwd() (string, error) {\n\tif !strings.EqualFold(os.Getenv(\"GINKGO_PRESERVE_CACHE\"), \"true\") {\n\t\t// Getwd calls os.Getenv(\"PWD\"), which breaks test caching if the cache\n\t\t// is shared between two different directories with the same test code.\n\t\treturn os.Getwd()\n\t}\n\treturn \"\", nil\n}\n\n/*\nPreviewSpecs walks the testing tree and produces a report without actually invoking the specs.\nSee http://onsi.github.io/ginkgo/#previewing-specs for more information.\n*/\nfunc PreviewSpecs(description string, args ...any) Report {\n\terr := global.PushClone()\n\tif err != nil {\n\t\texitIfErr(err)\n\t}\n\tdefer global.PopClone()\n\n\tsuiteLabels, suiteSemVerConstraints, suiteComponentSemVerConstraints, suiteAroundNodes := extractSuiteConfiguration(args)\n\tpriorDryRun, priorParallelTotal, priorParallelProcess := suiteConfig.DryRun, suiteConfig.ParallelTotal, suiteConfig.ParallelProcess\n\tsuiteConfig.DryRun, suiteConfig.ParallelTotal, suiteConfig.ParallelProcess = true, 1, 1\n\tdefer func() {\n\t\tsuiteConfig.DryRun, suiteConfig.ParallelTotal, suiteConfig.ParallelProcess = priorDryRun, priorParallelTotal, priorParallelProcess\n\t}()\n\treporter := reporters.NoopReporter{}\n\toutputInterceptor = internal.NoopOutputInterceptor{}\n\tclient = nil\n\twriter := GinkgoWriter.(*internal.Writer)\n\n\terr = global.Suite.BuildTree()\n\texitIfErr(err)\n\tsuitePath, err := getwd()\n\texitIfErr(err)\n\tsuitePath, err = filepath.Abs(suitePath)\n\texitIfErr(err)\n\n\tglobal.Suite.Run(description, suiteLabels, suiteSemVerConstraints, suiteComponentSemVerConstraints, suiteAroundNodes, suitePath, global.Failer, reporter, writer, outputInterceptor, interrupt_handler.NewInterruptHandler(client), client, internal.RegisterForProgressSignal, suiteConfig)\n\n\treturn global.Suite.GetPreviewReport()\n}\n\n/*\nSkip instructs Ginkgo to skip the current spec\n\nYou can call Skip in any Setup or Subject node closure.\n\nFor more on how to filter specs in Ginkgo see https://onsi.github.io/ginkgo/#filtering-specs\n*/\nfunc Skip(message string, callerSkip ...int) {\n\tskip := 0\n\tif len(callerSkip) > 0 {\n\t\tskip = callerSkip[0]\n\t}\n\tcl := types.NewCodeLocationWithStackTrace(skip + 1)\n\tglobal.Failer.Skip(message, cl)\n\tpanic(types.GinkgoErrors.UncaughtGinkgoPanic(cl))\n}\n\n/*\nFail notifies Ginkgo that the current spec has failed. (Gomega will call Fail for you automatically when an assertion fails.)\n\nUnder the hood, Fail panics to end execution of the current spec. Ginkgo will catch this panic and proceed with\nthe subsequent spec. If you call Fail, or make an assertion, within a goroutine launched by your spec you must\nadd defer GinkgoRecover() to the goroutine to catch the panic emitted by Fail.\n\nYou can call Fail in any Setup or Subject node closure.\n\nYou can learn more about how Ginkgo manages failures here: https://onsi.github.io/ginkgo/#mental-model-how-ginkgo-handles-failure\n*/\nfunc Fail(message string, callerSkip ...int) {\n\tskip := 0\n\tif len(callerSkip) > 0 {\n\t\tskip = callerSkip[0]\n\t}\n\n\tcl := types.NewCodeLocationWithStackTrace(skip + 1)\n\tglobal.Failer.Fail(message, cl)\n\tpanic(types.GinkgoErrors.UncaughtGinkgoPanic(cl))\n}\n\n/*\nAbortSuite instructs Ginkgo to fail the current spec and skip all subsequent specs, thereby aborting the suite.\n\nYou can call AbortSuite in any Setup or Subject node closure.\n\nYou can learn more about how Ginkgo handles suite interruptions here: https://onsi.github.io/ginkgo/#interrupting-aborting-and-timing-out-suites\n*/\nfunc AbortSuite(message string, callerSkip ...int) {\n\tskip := 0\n\tif len(callerSkip) > 0 {\n\t\tskip = callerSkip[0]\n\t}\n\n\tcl := types.NewCodeLocationWithStackTrace(skip + 1)\n\tglobal.Failer.AbortSuite(message, cl)\n\tpanic(types.GinkgoErrors.UncaughtGinkgoPanic(cl))\n}\n\n/*\nignorablePanic is used by Gomega to signal to GinkgoRecover that Goemga is handling\nthe error associated with this panic. It i used when Eventually/Consistently are passed a func(g Gomega) and the resulting function launches a goroutines that makes a failed assertion. That failed assertion is registered by Gomega and then panics. Ordinarily the panic is captured by Gomega. In the case of a goroutine Gomega can't capture the panic - so we piggy back on GinkgoRecover so users have a single defer GinkgoRecover() pattern to follow. To do that we need to tell Ginkgo to ignore this panic and not register it as a panic on the global Failer.\n*/\ntype ignorablePanic interface{ GinkgoRecoverShouldIgnoreThisPanic() }\n\n/*\nGinkgoRecover should be deferred at the top of any spawned goroutine that (may) call `Fail`\nSince Gomega assertions call fail, you should throw a `defer GinkgoRecover()` at the top of any goroutine that\ncalls out to Gomega\n\nHere's why: Ginkgo's `Fail` method records the failure and then panics to prevent\nfurther assertions from running. This panic must be recovered. Normally, Ginkgo recovers the panic for you,\nhowever if a panic originates on a goroutine *launched* from one of your specs there's no\nway for Ginkgo to rescue the panic. To do this, you must remember to `defer GinkgoRecover()` at the top of such a goroutine.\n\nYou can learn more about how Ginkgo manages failures here: https://onsi.github.io/ginkgo/#mental-model-how-ginkgo-handles-failure\n*/\nfunc GinkgoRecover() {\n\te := recover()\n\tif e != nil {\n\t\tif _, ok := e.(ignorablePanic); ok {\n\t\t\treturn\n\t\t}\n\t\tglobal.Failer.Panic(types.NewCodeLocationWithStackTrace(1), e)\n\t}\n}\n\n// pushNode is used by the various test construction DSL methods to push nodes onto the suite\n// it handles returned errors, emits a detailed error message to help the user learn what they may have done wrong, then exits\nfunc pushNode(node internal.Node, errors []error) bool {\n\texitIfErrors(errors)\n\texitIfErr(global.Suite.PushNode(node))\n\treturn true\n}\n\n// NodeArgsTransformer is a hook which is called by the test construction DSL methods\n// before creating the new node. If it returns any error, the test suite\n// prints those errors and exits. The text and arguments can be modified,\n// which includes directly changing the args slice that is passed in.\n// Arguments have been flattened already, i.e. none of the entries in args is another []any.\n// The result may be nested.\n//\n// The node type is provided for information and remains the same.\n//\n// The offset is valid for calling NewLocation directly in the\n// implementation of TransformNodeArgs to find the location where\n// the Ginkgo DSL function is called. An additional offset supplied\n// by the caller via args is already included.\n//\n// A NodeArgsTransformer can be registered with AddTreeConstructionNodeArgsTransformer.\ntype NodeArgsTransformer func(nodeType types.NodeType, offset Offset, text string, args []any) (string, []any, []error)\n\n// AddTreeConstructionNodeArgsTransformer registers a NodeArgsTransformer.\n// Only nodes which get created after registering a NodeArgsTransformer\n// are transformed by it. The returned function can be called to\n// unregister the transformer.\n//\n// Both may only be called during the construction phase.\n//\n// If there is more than one registered transformer, then the most\n// recently added ones get called first.\nfunc AddTreeConstructionNodeArgsTransformer(transformer NodeArgsTransformer) func() {\n\t// This conversion could be avoided with a type alias, but type aliases make\n\t// developer documentation less useful.\n\treturn internal.AddTreeConstructionNodeArgsTransformer(internal.NodeArgsTransformer(transformer))\n}\n\n/*\nDescribe nodes are Container nodes that allow you to organize your specs. A Describe node's closure can contain any number of\nSetup nodes (e.g. BeforeEach, AfterEach, JustBeforeEach), and Subject nodes (i.e. It).\n\nContext and When nodes are aliases for Describe - use whichever gives your suite a better narrative flow. It is idomatic\nto Describe the behavior of an object or function and, within that Describe, outline a number of Contexts and Whens.\n\nYou can learn more at https://onsi.github.io/ginkgo/#organizing-specs-with-container-nodes\nIn addition, container nodes can be decorated with a variety of decorators. You can learn more here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nfunc Describe(text string, args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeContainer, text, args...)))\n}\n\n/*\nFDescribe focuses specs within the Describe block.\n*/\nfunc FDescribe(text string, args ...any) bool {\n\targs = append(args, internal.Focus)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeContainer, text, args...)))\n}\n\n/*\nPDescribe marks specs within the Describe block as pending.\n*/\nfunc PDescribe(text string, args ...any) bool {\n\targs = append(args, internal.Pending)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeContainer, text, args...)))\n}\n\n/*\nXDescribe marks specs within the Describe block as pending.\n\nXDescribe is an alias for PDescribe\n*/\nvar XDescribe = PDescribe\n\n/* Context is an alias for Describe - it generates the exact same kind of Container node */\nvar Context, FContext, PContext, XContext = Describe, FDescribe, PDescribe, XDescribe\n\n/* When is an alias for Describe - it generates the exact same kind of Container node with \"when \" as prefix for the text. */\nfunc When(text string, args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeContainer, \"when \"+text, args...)))\n}\n\n/* When is an alias for Describe - it generates the exact same kind of Container node with \"when \" as prefix for the text. */\nfunc FWhen(text string, args ...any) bool {\n\targs = append(args, internal.Focus)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeContainer, \"when \"+text, args...)))\n}\n\n/* When is an alias for Describe - it generates the exact same kind of Container node */\nfunc PWhen(text string, args ...any) bool {\n\targs = append(args, internal.Pending)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeContainer, \"when \"+text, args...)))\n}\n\nvar XWhen = PWhen\n\n/*\nIt nodes are Subject nodes that contain your spec code and assertions.\n\nEach It node corresponds to an individual Ginkgo spec. You cannot nest any other Ginkgo nodes within an It node's closure.\n\nYou can pass It nodes bare functions (func() {}) or functions that receive a SpecContext or context.Context: func(ctx SpecContext) {} and func (ctx context.Context) {}. If the function takes a context then the It is deemed interruptible and Ginkgo will cancel the context in the event of a timeout (configured via the SpecTimeout() or NodeTimeout() decorators) or of an interrupt signal.\n\nYou can learn more at https://onsi.github.io/ginkgo/#spec-subjects-it\nIn addition, subject nodes can be decorated with a variety of decorators. You can learn more here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nfunc It(text string, args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeIt, text, args...)))\n}\n\n/*\nFIt allows you to focus an individual It.\n*/\nfunc FIt(text string, args ...any) bool {\n\targs = append(args, internal.Focus)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeIt, text, args...)))\n}\n\n/*\nPIt allows you to mark an individual It as pending.\n*/\nfunc PIt(text string, args ...any) bool {\n\targs = append(args, internal.Pending)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeIt, text, args...)))\n}\n\n/*\nXIt allows you to mark an individual It as pending.\n\nXIt is an alias for PIt\n*/\nvar XIt = PIt\n\n/*\nSpecify is an alias for It - it can allow for more natural wording in some context.\n*/\nvar Specify, FSpecify, PSpecify, XSpecify = It, FIt, PIt, XIt\n\n/*\nBy allows you to better document complex Specs.\n\nGenerally you should try to keep your Its short and to the point. This is not always possible, however,\nespecially in the context of integration tests that capture complex or lengthy workflows.\n\nBy allows you to document such flows. By may be called within a Setup or Subject node (It, BeforeEach, etc...)\nand will simply log the passed in text to the GinkgoWriter. If By is handed a function it will immediately run the function.\n\nBy will also generate and attach a ReportEntry to the spec. This will ensure that By annotations appear in Ginkgo's machine-readable reports.\n\nNote that By does not generate a new Ginkgo node - rather it is simply syntactic sugar around GinkgoWriter and AddReportEntry\nYou can learn more about By here: https://onsi.github.io/ginkgo/#documenting-complex-specs-by\n*/\nfunc By(text string, callback ...func()) {\n\texitIfErr(global.Suite.By(text, callback...))\n}\n\n/*\nBeforeSuite nodes are suite-level Setup nodes that run just once before any specs are run.\nWhen running in parallel, each parallel process will call BeforeSuite.\n\nYou may only register *one* BeforeSuite handler per test suite. You typically do so in your bootstrap file at the top level.\n\nBeforeSuite can take a func() body, or an interruptible func(SpecContext)/func(context.Context) body.\n\nYou cannot nest any other Ginkgo nodes within a BeforeSuite node's closure.\nYou can learn more here: https://onsi.github.io/ginkgo/#suite-setup-and-cleanup-beforesuite-and-aftersuite\n*/\nfunc BeforeSuite(body any, args ...any) bool {\n\tcombinedArgs := []any{body}\n\tcombinedArgs = append(combinedArgs, args...)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeBeforeSuite, \"\", combinedArgs...)))\n}\n\n/*\nAfterSuite nodes are suite-level Setup nodes run after all specs have finished - regardless of whether specs have passed or failed.\nAfterSuite node closures always run, even if Ginkgo receives an interrupt signal (^C), in order to ensure cleanup occurs.\n\nWhen running in parallel, each parallel process will call AfterSuite.\n\nYou may only register *one* AfterSuite handler per test suite. You typically do so in your bootstrap file at the top level.\n\nAfterSuite can take a func() body, or an interruptible func(SpecContext)/func(context.Context) body.\n\nYou cannot nest any other Ginkgo nodes within an AfterSuite node's closure.\nYou can learn more here: https://onsi.github.io/ginkgo/#suite-setup-and-cleanup-beforesuite-and-aftersuite\n*/\nfunc AfterSuite(body any, args ...any) bool {\n\tcombinedArgs := []any{body}\n\tcombinedArgs = append(combinedArgs, args...)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeAfterSuite, \"\", combinedArgs...)))\n}\n\n/*\nSynchronizedBeforeSuite nodes allow you to perform some of the suite setup just once - on parallel process #1 - and then pass information\nfrom that setup to the rest of the suite setup on all processes. This is useful for performing expensive or singleton setup once, then passing\ninformation from that setup to all parallel processes.\n\nSynchronizedBeforeSuite accomplishes this by taking *two* function arguments and passing data between them.\nThe first function is only run on parallel process #1. The second is run on all processes, but *only* after the first function completes successfully. The functions have the following signatures:\n\nThe first function (which only runs on process #1) can have any of the following the signatures:\n\n\tfunc()\n\tfunc(ctx context.Context)\n\tfunc(ctx SpecContext)\n\tfunc() []byte\n\tfunc(ctx context.Context) []byte\n\tfunc(ctx SpecContext) []byte\n\nThe byte array returned by the first function (if present) is then passed to the second function, which can have any of the following signature:\n\n\tfunc()\n\tfunc(ctx context.Context)\n\tfunc(ctx SpecContext)\n\tfunc(data []byte)\n\tfunc(ctx context.Context, data []byte)\n\tfunc(ctx SpecContext, data []byte)\n\nIf either function receives a context.Context/SpecContext it is considered interruptible.\n\nYou cannot nest any other Ginkgo nodes within an SynchronizedBeforeSuite node's closure.\nYou can learn more, and see some examples, here: https://onsi.github.io/ginkgo/#parallel-suite-setup-and-cleanup-synchronizedbeforesuite-and-synchronizedaftersuite\n*/\nfunc SynchronizedBeforeSuite(process1Body any, allProcessBody any, args ...any) bool {\n\tcombinedArgs := []any{process1Body, allProcessBody}\n\tcombinedArgs = append(combinedArgs, args...)\n\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeSynchronizedBeforeSuite, \"\", combinedArgs...)))\n}\n\n/*\nSynchronizedAfterSuite nodes complement the SynchronizedBeforeSuite nodes in solving the problem of splitting clean up into a piece that runs on all processes\nand a piece that must only run once - on process #1.\n\nSynchronizedAfterSuite accomplishes this by taking *two* function arguments. The first runs on all processes. The second runs only on parallel process #1\nand *only* after all other processes have finished and exited. This ensures that process #1, and any resources it is managing, remain alive until\nall other processes are finished. These two functions can be bare functions (func()) or interruptible (func(context.Context)/func(SpecContext))\n\nNote that you can also use DeferCleanup() in SynchronizedBeforeSuite to accomplish similar results.\n\nYou cannot nest any other Ginkgo nodes within an SynchronizedAfterSuite node's closure.\nYou can learn more, and see some examples, here: https://onsi.github.io/ginkgo/#parallel-suite-setup-and-cleanup-synchronizedbeforesuite-and-synchronizedaftersuite\n*/\nfunc SynchronizedAfterSuite(allProcessBody any, process1Body any, args ...any) bool {\n\tcombinedArgs := []any{allProcessBody, process1Body}\n\tcombinedArgs = append(combinedArgs, args...)\n\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeSynchronizedAfterSuite, \"\", combinedArgs...)))\n}\n\n/*\nBeforeEach nodes are Setup nodes whose closures run before It node closures. When multiple BeforeEach nodes\nare defined in nested Container nodes the outermost BeforeEach node closures are run first.\n\nBeforeEach can take a func() body, or an interruptible func(SpecContext)/func(context.Context) body.\n\nYou cannot nest any other Ginkgo nodes within a BeforeEach node's closure.\nYou can learn more here: https://onsi.github.io/ginkgo/#extracting-common-setup-beforeeach\n*/\nfunc BeforeEach(args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeBeforeEach, \"\", args...)))\n}\n\n/*\nJustBeforeEach nodes are similar to BeforeEach nodes, however they are guaranteed to run *after* all BeforeEach node closures - just before the It node closure.\nThis can allow you to separate configuration from creation of resources for a spec.\n\nJustBeforeEach can take a func() body, or an interruptible func(SpecContext)/func(context.Context) body.\n\nYou cannot nest any other Ginkgo nodes within a JustBeforeEach node's closure.\nYou can learn more and see some examples here: https://onsi.github.io/ginkgo/#separating-creation-and-configuration-justbeforeeach\n*/\nfunc JustBeforeEach(args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeJustBeforeEach, \"\", args...)))\n}\n\n/*\nAfterEach nodes are Setup nodes whose closures run after It node closures. When multiple AfterEach nodes\nare defined in nested Container nodes the innermost AfterEach node closures are run first.\n\nNote that you can also use DeferCleanup() in other Setup or Subject nodes to accomplish similar results.\n\nAfterEach can take a func() body, or an interruptible func(SpecContext)/func(context.Context) body.\n\nYou cannot nest any other Ginkgo nodes within an AfterEach node's closure.\nYou can learn more here: https://onsi.github.io/ginkgo/#spec-cleanup-aftereach-and-defercleanup\n*/\nfunc AfterEach(args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeAfterEach, \"\", args...)))\n}\n\n/*\nJustAfterEach nodes are similar to AfterEach nodes, however they are guaranteed to run *before* all AfterEach node closures - just after the It node closure. This can allow you to separate diagnostics collection from teardown for a spec.\n\nJustAfterEach can take a func() body, or an interruptible func(SpecContext)/func(context.Context) body.\n\nYou cannot nest any other Ginkgo nodes within a JustAfterEach node's closure.\nYou can learn more and see some examples here: https://onsi.github.io/ginkgo/#separating-diagnostics-collection-and-teardown-justaftereach\n*/\nfunc JustAfterEach(args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeJustAfterEach, \"\", args...)))\n}\n\n/*\nBeforeAll nodes are Setup nodes that can occur inside Ordered containers. They run just once before any specs in the Ordered container run.\n\nMultiple BeforeAll nodes can be defined in a given Ordered container however they cannot be nested inside any other container.\n\nBeforeAll can take a func() body, or an interruptible func(SpecContext)/func(context.Context) body.\n\nYou cannot nest any other Ginkgo nodes within a BeforeAll node's closure.\nYou can learn more about Ordered Containers at: https://onsi.github.io/ginkgo/#ordered-containers\nAnd you can learn more about BeforeAll at: https://onsi.github.io/ginkgo/#setup-in-ordered-containers-beforeall-and-afterall\n*/\nfunc BeforeAll(args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeBeforeAll, \"\", args...)))\n}\n\n/*\nAfterAll nodes are Setup nodes that can occur inside Ordered containers. They run just once after all specs in the Ordered container have run.\n\nMultiple AfterAll nodes can be defined in a given Ordered container however they cannot be nested inside any other container.\n\nNote that you can also use DeferCleanup() in a BeforeAll node to accomplish similar behavior.\n\nAfterAll can take a func() body, or an interruptible func(SpecContext)/func(context.Context) body.\n\nYou cannot nest any other Ginkgo nodes within an AfterAll node's closure.\nYou can learn more about Ordered Containers at: https://onsi.github.io/ginkgo/#ordered-containers\nAnd you can learn more about AfterAll at: https://onsi.github.io/ginkgo/#setup-in-ordered-containers-beforeall-and-afterall\n*/\nfunc AfterAll(args ...any) bool {\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeAfterAll, \"\", args...)))\n}\n\n/*\nDeferCleanup can be called within any Setup or Subject node to register a cleanup callback that Ginkgo will call at the appropriate time to cleanup after the spec.\n\nDeferCleanup can be passed:\n1. A function that takes no arguments and returns no values.\n2. A function that returns multiple values. `DeferCleanup` will ignore all these return values except for the last one. If this last return value is a non-nil error `DeferCleanup` will fail the spec).\n3. A function that takes a context.Context or SpecContext (and optionally returns multiple values). The resulting cleanup node is deemed interruptible and the passed-in context will be cancelled in the event of a timeout or interrupt.\n4. A function that takes arguments (and optionally returns multiple values) followed by a list of arguments to pass to the function.\n5. A function that takes SpecContext and a list of arguments (and optionally returns multiple values) followed by a list of arguments to pass to the function.\n\nFor example:\n\n\tBeforeEach(func() {\n\t DeferCleanup(os.Setenv, \"FOO\", os.GetEnv(\"FOO\"))\n\t os.Setenv(\"FOO\", \"BAR\")\n\t})\n\nwill register a cleanup handler that will set the environment variable \"FOO\" to its current value (obtained by os.GetEnv(\"FOO\")) after the spec runs and then sets the environment variable \"FOO\" to \"BAR\" for the current spec.\n\nSimilarly:\n\n\tBeforeEach(func() {\n\t DeferCleanup(func(ctx SpecContext, path) {\n\t \treq, err := http.NewRequestWithContext(ctx, \"POST\", path, nil)\n\t \tExpect(err).NotTo(HaveOccured())\n\t \t_, err := http.DefaultClient.Do(req)\n\t \tExpect(err).NotTo(HaveOccured())\n\t }, \"example.com/cleanup\", NodeTimeout(time.Second*3))\n\t})\n\nwill register a cleanup handler that will have three seconds to successfully complete a request to the specified path. Note that we do not specify a context in the list of arguments passed to DeferCleanup - only in the signature of the function we pass in. Ginkgo will detect the requested context and supply a SpecContext when it invokes the cleanup node. If you want to pass in your own context in addition to the Ginkgo-provided SpecContext you must specify the SpecContext as the first argument (e.g. func(ctx SpecContext, otherCtx context.Context)).\n\nWhen DeferCleanup is called in BeforeEach, JustBeforeEach, It, AfterEach, or JustAfterEach the registered callback will be invoked when the spec completes (i.e. it will behave like an AfterEach node)\nWhen DeferCleanup is called in BeforeAll or AfterAll the registered callback will be invoked when the ordered container completes (i.e. it will behave like an AfterAll node)\nWhen DeferCleanup is called in BeforeSuite, SynchronizedBeforeSuite, AfterSuite, or SynchronizedAfterSuite the registered callback will be invoked when the suite completes (i.e. it will behave like an AfterSuite node)\n\nNote that DeferCleanup does not represent a node but rather dynamically generates the appropriate type of cleanup node based on the context in which it is called. As such you must call DeferCleanup within a Setup or Subject node, and not within a Container node.\nYou can learn more about DeferCleanup here: https://onsi.github.io/ginkgo/#cleaning-up-our-cleanup-code-defercleanup\n*/\nfunc DeferCleanup(args ...any) {\n\tfail := func(message string, cl types.CodeLocation) {\n\t\tglobal.Failer.Fail(message, cl)\n\t}\n\tpushNode(internal.NewCleanupNode(deprecationTracker, fail, args...))\n}\n\n/*\nAttachProgressReporter allows you to register a function that will be called whenever Ginkgo generates a Progress Report. The contents returned by the function will be included in the report.\n\n**This is an experimental feature and the public-facing interface may change in a future minor version of Ginkgo**\n\nProgress Reports are generated:\n- whenever the user explicitly requests one (via `SIGINFO` or `SIGUSR1`)\n- on nodes decorated with PollProgressAfter\n- on suites run with --poll-progress-after\n- whenever a test times out\n\nGinkgo uses Progress Reports to convey the current state of the test suite, including any running goroutines. By attaching a progress reporter you are able to supplement these reports with additional information.\n\n# AttachProgressReporter returns a function that can be called to detach the progress reporter\n\nYou can learn more about AttachProgressReporter here: https://onsi.github.io/ginkgo/#attaching-additional-information-to-progress-reports\n*/\nfunc AttachProgressReporter(reporter func() string) func() {\n\treturn global.Suite.AttachProgressReporter(reporter)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/decorator_dsl.go",
"content": "package ginkgo\n\nimport (\n\t\"github.com/onsi/ginkgo/v2/internal\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n/*\nOffset(uint) is a decorator that allows you to change the stack-frame offset used when computing the line number of the node in question.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#the-offset-decorator\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\ntype Offset = internal.Offset\n\n/*\nFlakeAttempts(uint N) is a decorator that allows you to mark individual specs or spec containers as flaky. Ginkgo will run them up to `N` times until they pass.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#the-flakeattempts-decorator\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\ntype FlakeAttempts = internal.FlakeAttempts\n\n/*\nMustPassRepeatedly(uint N) is a decorator that allows you to repeat the execution of individual specs or spec containers. Ginkgo will run them up to `N` times until they fail.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#the-mustpassrepeatedly-decorator\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\ntype MustPassRepeatedly = internal.MustPassRepeatedly\n\n/*\nFocus is a decorator that allows you to mark a spec or container as focused. Identical to FIt and FDescribe.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#filtering-specs\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nconst Focus = internal.Focus\n\n/*\nPending is a decorator that allows you to mark a spec or container as pending. Identical to PIt and PDescribe.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#filtering-specs\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nconst Pending = internal.Pending\n\n/*\nSerial is a decorator that allows you to mark a spec or container as serial. These specs will never run in parallel with other specs.\nSpecs in ordered containers cannot be marked as serial - mark the ordered container instead.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#serial-specs\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nconst Serial = internal.Serial\n\n/*\nOrdered is a decorator that allows you to mark a container as ordered. Specs in the container will always run in the order they appear.\nThey will never be randomized and they will never run in parallel with one another, though they may run in parallel with other specs.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#ordered-containers\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nconst Ordered = internal.Ordered\n\n/*\nContinueOnFailure is a decorator that allows you to mark an Ordered container to continue running specs even if failures occur. Ordinarily an ordered container will stop running specs after the first failure occurs. Note that if a BeforeAll or a BeforeEach/JustBeforeEach annotated with OncePerOrdered fails then no specs will run as the precondition for the Ordered container will consider to be failed.\n\nContinueOnFailure only applies to the outermost Ordered container. Attempting to place ContinueOnFailure in a nested container will result in an error.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#ordered-containers\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nconst ContinueOnFailure = internal.ContinueOnFailure\n\n/*\nOncePerOrdered is a decorator that allows you to mark outer BeforeEach, AfterEach, JustBeforeEach, and JustAfterEach setup nodes to run once\nper ordered context. Normally these setup nodes run around each individual spec, with OncePerOrdered they will run once around the set of specs in an ordered container.\nThe behavior for non-Ordered containers/specs is unchanged.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#setup-around-ordered-containers-the-onceperordered-decorator\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nconst OncePerOrdered = internal.OncePerOrdered\n\n/*\nLabel decorates specs with Labels. Multiple labels can be passed to Label and these can be arbitrary strings but must not include the following characters: \"&|!,()/\".\nLabels can be applied to container and subject nodes, but not setup nodes. You can provide multiple Labels to a given node and a spec's labels is the union of all labels in its node hierarchy.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#spec-labels\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nfunc Label(labels ...string) Labels {\n\treturn Labels(labels)\n}\n\n/*\nLabels are the type for spec Label decorators. Use Label(...) to construct Labels.\nYou can learn more here: https://onsi.github.io/ginkgo/#spec-labels\n*/\ntype Labels = internal.Labels\n\n/*\nSemVerConstraint decorates specs with SemVerConstraints. Multiple semantic version constraints can be passed to SemVerConstraint and these strings must follow the semantic version constraint rules.\nSemVerConstraints can be applied to container and subject nodes, but not setup nodes. You can provide multiple SemVerConstraints to a given node and a spec's semantic version constraints is the union of all semantic version constraints in its node hierarchy.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#spec-semantic-version-filtering\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nfunc SemVerConstraint(semVerConstraints ...string) SemVerConstraints {\n\treturn SemVerConstraints(semVerConstraints)\n}\n\n/*\nSemVerConstraints are the type for spec SemVerConstraint decorators. Use SemVerConstraint(...) to construct SemVerConstraints.\nYou can learn more here: https://onsi.github.io/ginkgo/#spec-semantic-version-filtering\n*/\ntype SemVerConstraints = internal.SemVerConstraints\n\n/*\nComponentSemVerConstraint decorates specs with ComponentSemVerConstraints. Multiple components semantic version constraints can be passed to ComponentSemVerConstraint and the component can't be empy, also the version strings must follow the semantic version constraint rules.\nComponentSemVerConstraints can be applied to container and subject nodes, but not setup nodes. You can provide multiple ComponentSemVerConstraints to a given node and a spec's component semantic version constraints is the union of all component semantic version constraints in its node hierarchy.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#spec-semantic-version-filtering\nYou can learn more about decorators here: https://onsi.github.io/ginkgo/#decorator-reference\n*/\nfunc ComponentSemVerConstraint(component string, semVerConstraints ...string) ComponentSemVerConstraints {\n\tcomponentSemVerConstraints := ComponentSemVerConstraints{\n\t\tcomponent: semVerConstraints,\n\t}\n\n\treturn componentSemVerConstraints\n}\n\n/*\nComponentSemVerConstraints are the type for spec ComponentSemVerConstraint decorators. Use ComponentSemVerConstraint(...) to construct ComponentSemVerConstraints.\nYou can learn more here: https://onsi.github.io/ginkgo/#spec-semantic-version-filtering\n*/\ntype ComponentSemVerConstraints = internal.ComponentSemVerConstraints\n\n/*\nPollProgressAfter allows you to override the configured value for --poll-progress-after for a particular node.\n\nGinkgo will start emitting node progress if the node is still running after a duration of PollProgressAfter. This allows you to get quicker feedback about the state of a long-running spec.\n*/\ntype PollProgressAfter = internal.PollProgressAfter\n\n/*\nPollProgressInterval allows you to override the configured value for --poll-progress-interval for a particular node.\n\nOnce a node has been running for longer than PollProgressAfter Ginkgo will emit node progress periodically at an interval of PollProgresInterval.\n*/\ntype PollProgressInterval = internal.PollProgressInterval\n\n/*\nNodeTimeout allows you to specify a timeout for an indivdiual node. The node cannot be a container and must be interruptible (i.e. it must be passed a function that accepts a SpecContext or context.Context).\n\nIf the node does not exit within the specified NodeTimeout its context will be cancelled. The node wil then have a period of time controlled by the GracePeriod decorator (or global --grace-period command-line argument) to exit. If the node does not exit within GracePeriod Ginkgo will leak the node and proceed to any clean-up nodes associated with the current spec.\n*/\ntype NodeTimeout = internal.NodeTimeout\n\n/*\nSpecTimeout allows you to specify a timeout for an indivdiual spec. SpecTimeout can only decorate interruptible It nodes.\n\nAll nodes associated with the It node will need to complete before the SpecTimeout has elapsed. Individual nodes (e.g. BeforeEach) may be decorated with different NodeTimeouts - but these can only serve to provide a more stringent deadline for the node in question; they cannot extend the deadline past the SpecTimeout.\n\nIf the spec does not complete within the specified SpecTimeout the currently running node will have its context cancelled. The node wil then have a period of time controlled by that node's GracePeriod decorator (or global --grace-period command-line argument) to exit. If the node does not exit within GracePeriod Ginkgo will leak the node and proceed to any clean-up nodes associated with the current spec.\n*/\ntype SpecTimeout = internal.SpecTimeout\n\n/*\nGracePeriod denotes the period of time Ginkgo will wait for an interruptible node to exit once an interruption (whether due to a timeout or a user-invoked signal) has occurred. If both the global --grace-period cli flag and a GracePeriod decorator are specified the value in the decorator will take precedence.\n\nNodes that do not finish within a GracePeriod will be leaked and Ginkgo will proceed to run subsequent nodes. In the event of a timeout, such leaks will be reported to the user.\n*/\ntype GracePeriod = internal.GracePeriod\n\n/*\nSpecPriority allows you to assign a priority to a spec or container.\n\nSpecs with higher priority will be scheduled to run before specs with lower priority. The default priority is 0 and negative priorities are allowed.\n*/\ntype SpecPriority = internal.SpecPriority\n\n/*\nSuppressProgressReporting is a decorator that allows you to disable progress reporting of a particular node. This is useful if `ginkgo -v -progress` is generating too much noise; particularly\nif you have a `ReportAfterEach` node that is running for every skipped spec and is generating lots of progress reports.\n*/\nconst SuppressProgressReporting = internal.SuppressProgressReporting\n\n/*\nAroundNode registers a function that runs before each individual node. This is considered a more advanced decorator.\n\nPlease read the [docs](https://onsi.github.io/ginkgo/#advanced-around-node) for more information.\n\nAllowed signatures:\n\n- AroundNode(func()) - func will be called before the node is run.\n- AroundNode(func(ctx context.Context) context.Context) - func can wrap the passed in context and return a new one which will be passed on to the node.\n- AroundNode(func(ctx context.Context, body func(ctx context.Context))) - ctx is the context for the node and body is a function that must be called to run the node. This gives you complete control over what runs before and after the node.\n\nMultiple AroundNode decorators can be applied to a single node and they will run in the order they are applied.\n\nUnlike setup nodes like BeforeEach and DeferCleanup, AroundNode is guaranteed to run in the same goroutine as the decorated node. This is necessary when working with lower-level libraries that must run on a single thread (you can call runtime.LockOSThread() in the AroundNode to ensure that the node runs on a single thread).\n\nSince AroundNode allows you to modify the context you can also use AroundNode to implement shared setup that attaches values to the context. You must return a context that inherits from the passed in context.\n\nIf applied to a container, AroundNode will run before every node in the container. Including setup nodes like BeforeEach and DeferCleanup.\n\nAroundNode can also be applied to RunSpecs to run before every node in the suite.\n*/\nfunc AroundNode[F types.AroundNodeAllowedFuncs](f F) types.AroundNodeDecorator {\n\treturn types.AroundNode(f, types.NewCodeLocation(1))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/deprecated_dsl.go",
"content": "package ginkgo\n\nimport (\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/internal\"\n\t\"github.com/onsi/ginkgo/v2/internal/global\"\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n/*\nDeprecated: Done Channel for asynchronous testing\n\nThe Done channel pattern is no longer supported in Ginkgo 2.0.\nSee here for better patterns for asynchronous testing: https://onsi.github.io/ginkgo/#patterns-for-asynchronous-testing\n\nFor a migration guide see: https://onsi.github.io/ginkgo/MIGRATING_TO_V2#removed-async-testing\n*/\ntype Done = internal.Done\n\n/*\nDeprecated: Custom Ginkgo test reporters are deprecated in Ginkgo 2.0.\n\nUse Ginkgo's reporting nodes instead and 2.0 reporting infrastructure instead. You can learn more here: https://onsi.github.io/ginkgo/#reporting-infrastructure\nFor a migration guide see: https://onsi.github.io/ginkgo/MIGRATING_TO_V2#removed-custom-reporters\n*/\ntype Reporter = reporters.DeprecatedReporter\n\n/*\nDeprecated: Custom Reporters have been removed in Ginkgo 2.0. RunSpecsWithDefaultAndCustomReporters will simply call RunSpecs()\n\nUse Ginkgo's reporting nodes instead and 2.0 reporting infrastructure instead. You can learn more here: https://onsi.github.io/ginkgo/#reporting-infrastructure\nFor a migration guide see: https://onsi.github.io/ginkgo/MIGRATING_TO_V2#removed-custom-reporters\n*/\nfunc RunSpecsWithDefaultAndCustomReporters(t GinkgoTestingT, description string, _ []Reporter) bool {\n\tdeprecationTracker.TrackDeprecation(types.Deprecations.CustomReporter())\n\treturn RunSpecs(t, description)\n}\n\n/*\nDeprecated: Custom Reporters have been removed in Ginkgo 2.0. RunSpecsWithCustomReporters will simply call RunSpecs()\n\nUse Ginkgo's reporting nodes instead and 2.0 reporting infrastructure instead. You can learn more here: https://onsi.github.io/ginkgo/#reporting-infrastructure\nFor a migration guide see: https://onsi.github.io/ginkgo/MIGRATING_TO_V2#removed-custom-reporters\n*/\nfunc RunSpecsWithCustomReporters(t GinkgoTestingT, description string, _ []Reporter) bool {\n\tdeprecationTracker.TrackDeprecation(types.Deprecations.CustomReporter())\n\treturn RunSpecs(t, description)\n}\n\n/*\nDeprecated: GinkgoTestDescription has been replaced with SpecReport.\n\nUse CurrentSpecReport() instead.\nYou can learn more here: https://onsi.github.io/ginkgo/#getting-a-report-for-the-current-spec\nThe SpecReport type is documented here: https://pkg.go.dev/github.com/onsi/ginkgo/v2/types#SpecReport\n*/\ntype DeprecatedGinkgoTestDescription struct {\n\tFullTestText string\n\tComponentTexts []string\n\tTestText string\n\n\tFileName string\n\tLineNumber int\n\n\tFailed bool\n\tDuration time.Duration\n}\ntype GinkgoTestDescription = DeprecatedGinkgoTestDescription\n\n/*\nDeprecated: CurrentGinkgoTestDescription has been replaced with CurrentSpecReport.\n\nUse CurrentSpecReport() instead.\nYou can learn more here: https://onsi.github.io/ginkgo/#getting-a-report-for-the-current-spec\nThe SpecReport type is documented here: https://pkg.go.dev/github.com/onsi/ginkgo/v2/types#SpecReport\n*/\nfunc CurrentGinkgoTestDescription() DeprecatedGinkgoTestDescription {\n\tdeprecationTracker.TrackDeprecation(\n\t\ttypes.Deprecations.CurrentGinkgoTestDescription(),\n\t\ttypes.NewCodeLocation(1),\n\t)\n\treport := global.Suite.CurrentSpecReport()\n\tif report.State == types.SpecStateInvalid {\n\t\treturn GinkgoTestDescription{}\n\t}\n\tcomponentTexts := []string{}\n\tcomponentTexts = append(componentTexts, report.ContainerHierarchyTexts...)\n\tcomponentTexts = append(componentTexts, report.LeafNodeText)\n\n\treturn DeprecatedGinkgoTestDescription{\n\t\tComponentTexts: componentTexts,\n\t\tFullTestText: report.FullText(),\n\t\tTestText: report.LeafNodeText,\n\t\tFileName: report.LeafNodeLocation.FileName,\n\t\tLineNumber: report.LeafNodeLocation.LineNumber,\n\t\tFailed: report.State.Is(types.SpecStateFailureStates),\n\t\tDuration: report.RunTime,\n\t}\n}\n\n/*\nDeprecated: GinkgoParallelNode() has been renamed to GinkgoParallelProcess()\n*/\nfunc GinkgoParallelNode() int {\n\tdeprecationTracker.TrackDeprecation(\n\t\ttypes.Deprecations.ParallelNode(),\n\t\ttypes.NewCodeLocation(1),\n\t)\n\treturn GinkgoParallelProcess()\n}\n\n/*\nDeprecated: Benchmarker has been removed from Ginkgo 2.0\n\nUse Gomega's gmeasure package instead.\nYou can learn more here: https://onsi.github.io/ginkgo/#benchmarking-code\n*/\ntype Benchmarker interface {\n\tTime(name string, body func(), info ...any) (elapsedTime time.Duration)\n\tRecordValue(name string, value float64, info ...any)\n\tRecordValueWithPrecision(name string, value float64, units string, precision int, info ...any)\n}\n\n/*\nDeprecated: Measure() has been removed from Ginkgo 2.0\n\nUse Gomega's gmeasure package instead.\nYou can learn more here: https://onsi.github.io/ginkgo/#benchmarking-code\n*/\nfunc Measure(_ ...any) bool {\n\tdeprecationTracker.TrackDeprecation(types.Deprecations.Measure(), types.NewCodeLocation(1))\n\treturn true\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/formatter/colorable_others.go",
"content": "// +build !windows\n\n/*\nThese packages are used for colorize on Windows and contributed by mattn.jp@gmail.com\n\n * go-colorable: \n * go-isatty: \n\nThe MIT License (MIT)\n\nCopyright (c) 2016 Yasuhiro Matsumoto\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n*/\n\npackage formatter\n\nimport (\n\t\"io\"\n\t\"os\"\n)\n\nfunc newColorable(file *os.File) io.Writer {\n\treturn file\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/formatter/colorable_windows.go",
"content": "/*\nThese packages are used for colorize on Windows and contributed by mattn.jp@gmail.com\n\n * go-colorable: \n * go-isatty: \n\nThe MIT License (MIT)\n\nCopyright (c) 2016 Yasuhiro Matsumoto\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n*/\n\npackage formatter\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"math\"\n\t\"os\"\n\t\"strconv\"\n\t\"strings\"\n\t\"syscall\"\n\t\"unsafe\"\n)\n\nvar (\n\tkernel32 = syscall.NewLazyDLL(\"kernel32.dll\")\n\tprocGetConsoleScreenBufferInfo = kernel32.NewProc(\"GetConsoleScreenBufferInfo\")\n\tprocSetConsoleTextAttribute = kernel32.NewProc(\"SetConsoleTextAttribute\")\n\tprocSetConsoleCursorPosition = kernel32.NewProc(\"SetConsoleCursorPosition\")\n\tprocFillConsoleOutputCharacter = kernel32.NewProc(\"FillConsoleOutputCharacterW\")\n\tprocFillConsoleOutputAttribute = kernel32.NewProc(\"FillConsoleOutputAttribute\")\n\tprocGetConsoleMode = kernel32.NewProc(\"GetConsoleMode\")\n)\n\nfunc isTerminal(fd uintptr) bool {\n\tvar st uint32\n\tr, _, e := syscall.Syscall(procGetConsoleMode.Addr(), 2, fd, uintptr(unsafe.Pointer(&st)), 0)\n\treturn r != 0 && e == 0\n}\n\nconst (\n\tforegroundBlue = 0x1\n\tforegroundGreen = 0x2\n\tforegroundRed = 0x4\n\tforegroundIntensity = 0x8\n\tforegroundMask = (foregroundRed | foregroundBlue | foregroundGreen | foregroundIntensity)\n\tbackgroundBlue = 0x10\n\tbackgroundGreen = 0x20\n\tbackgroundRed = 0x40\n\tbackgroundIntensity = 0x80\n\tbackgroundMask = (backgroundRed | backgroundBlue | backgroundGreen | backgroundIntensity)\n)\n\ntype wchar uint16\ntype short int16\ntype dword uint32\ntype word uint16\n\ntype coord struct {\n\tx short\n\ty short\n}\n\ntype smallRect struct {\n\tleft short\n\ttop short\n\tright short\n\tbottom short\n}\n\ntype consoleScreenBufferInfo struct {\n\tsize coord\n\tcursorPosition coord\n\tattributes word\n\twindow smallRect\n\tmaximumWindowSize coord\n}\n\ntype writer struct {\n\tout io.Writer\n\thandle syscall.Handle\n\tlastbuf bytes.Buffer\n\toldattr word\n}\n\nfunc newColorable(file *os.File) io.Writer {\n\tif file == nil {\n\t\tpanic(\"nil passed instead of *os.File to NewColorable()\")\n\t}\n\n\tif isTerminal(file.Fd()) {\n\t\tvar csbi consoleScreenBufferInfo\n\t\thandle := syscall.Handle(file.Fd())\n\t\tprocGetConsoleScreenBufferInfo.Call(uintptr(handle), uintptr(unsafe.Pointer(&csbi)))\n\t\treturn &writer{out: file, handle: handle, oldattr: csbi.attributes}\n\t} else {\n\t\treturn file\n\t}\n}\n\nvar color256 = map[int]int{\n\t0: 0x000000,\n\t1: 0x800000,\n\t2: 0x008000,\n\t3: 0x808000,\n\t4: 0x000080,\n\t5: 0x800080,\n\t6: 0x008080,\n\t7: 0xc0c0c0,\n\t8: 0x808080,\n\t9: 0xff0000,\n\t10: 0x00ff00,\n\t11: 0xffff00,\n\t12: 0x0000ff,\n\t13: 0xff00ff,\n\t14: 0x00ffff,\n\t15: 0xffffff,\n\t16: 0x000000,\n\t17: 0x00005f,\n\t18: 0x000087,\n\t19: 0x0000af,\n\t20: 0x0000d7,\n\t21: 0x0000ff,\n\t22: 0x005f00,\n\t23: 0x005f5f,\n\t24: 0x005f87,\n\t25: 0x005faf,\n\t26: 0x005fd7,\n\t27: 0x005fff,\n\t28: 0x008700,\n\t29: 0x00875f,\n\t30: 0x008787,\n\t31: 0x0087af,\n\t32: 0x0087d7,\n\t33: 0x0087ff,\n\t34: 0x00af00,\n\t35: 0x00af5f,\n\t36: 0x00af87,\n\t37: 0x00afaf,\n\t38: 0x00afd7,\n\t39: 0x00afff,\n\t40: 0x00d700,\n\t41: 0x00d75f,\n\t42: 0x00d787,\n\t43: 0x00d7af,\n\t44: 0x00d7d7,\n\t45: 0x00d7ff,\n\t46: 0x00ff00,\n\t47: 0x00ff5f,\n\t48: 0x00ff87,\n\t49: 0x00ffaf,\n\t50: 0x00ffd7,\n\t51: 0x00ffff,\n\t52: 0x5f0000,\n\t53: 0x5f005f,\n\t54: 0x5f0087,\n\t55: 0x5f00af,\n\t56: 0x5f00d7,\n\t57: 0x5f00ff,\n\t58: 0x5f5f00,\n\t59: 0x5f5f5f,\n\t60: 0x5f5f87,\n\t61: 0x5f5faf,\n\t62: 0x5f5fd7,\n\t63: 0x5f5fff,\n\t64: 0x5f8700,\n\t65: 0x5f875f,\n\t66: 0x5f8787,\n\t67: 0x5f87af,\n\t68: 0x5f87d7,\n\t69: 0x5f87ff,\n\t70: 0x5faf00,\n\t71: 0x5faf5f,\n\t72: 0x5faf87,\n\t73: 0x5fafaf,\n\t74: 0x5fafd7,\n\t75: 0x5fafff,\n\t76: 0x5fd700,\n\t77: 0x5fd75f,\n\t78: 0x5fd787,\n\t79: 0x5fd7af,\n\t80: 0x5fd7d7,\n\t81: 0x5fd7ff,\n\t82: 0x5fff00,\n\t83: 0x5fff5f,\n\t84: 0x5fff87,\n\t85: 0x5fffaf,\n\t86: 0x5fffd7,\n\t87: 0x5fffff,\n\t88: 0x870000,\n\t89: 0x87005f,\n\t90: 0x870087,\n\t91: 0x8700af,\n\t92: 0x8700d7,\n\t93: 0x8700ff,\n\t94: 0x875f00,\n\t95: 0x875f5f,\n\t96: 0x875f87,\n\t97: 0x875faf,\n\t98: 0x875fd7,\n\t99: 0x875fff,\n\t100: 0x878700,\n\t101: 0x87875f,\n\t102: 0x878787,\n\t103: 0x8787af,\n\t104: 0x8787d7,\n\t105: 0x8787ff,\n\t106: 0x87af00,\n\t107: 0x87af5f,\n\t108: 0x87af87,\n\t109: 0x87afaf,\n\t110: 0x87afd7,\n\t111: 0x87afff,\n\t112: 0x87d700,\n\t113: 0x87d75f,\n\t114: 0x87d787,\n\t115: 0x87d7af,\n\t116: 0x87d7d7,\n\t117: 0x87d7ff,\n\t118: 0x87ff00,\n\t119: 0x87ff5f,\n\t120: 0x87ff87,\n\t121: 0x87ffaf,\n\t122: 0x87ffd7,\n\t123: 0x87ffff,\n\t124: 0xaf0000,\n\t125: 0xaf005f,\n\t126: 0xaf0087,\n\t127: 0xaf00af,\n\t128: 0xaf00d7,\n\t129: 0xaf00ff,\n\t130: 0xaf5f00,\n\t131: 0xaf5f5f,\n\t132: 0xaf5f87,\n\t133: 0xaf5faf,\n\t134: 0xaf5fd7,\n\t135: 0xaf5fff,\n\t136: 0xaf8700,\n\t137: 0xaf875f,\n\t138: 0xaf8787,\n\t139: 0xaf87af,\n\t140: 0xaf87d7,\n\t141: 0xaf87ff,\n\t142: 0xafaf00,\n\t143: 0xafaf5f,\n\t144: 0xafaf87,\n\t145: 0xafafaf,\n\t146: 0xafafd7,\n\t147: 0xafafff,\n\t148: 0xafd700,\n\t149: 0xafd75f,\n\t150: 0xafd787,\n\t151: 0xafd7af,\n\t152: 0xafd7d7,\n\t153: 0xafd7ff,\n\t154: 0xafff00,\n\t155: 0xafff5f,\n\t156: 0xafff87,\n\t157: 0xafffaf,\n\t158: 0xafffd7,\n\t159: 0xafffff,\n\t160: 0xd70000,\n\t161: 0xd7005f,\n\t162: 0xd70087,\n\t163: 0xd700af,\n\t164: 0xd700d7,\n\t165: 0xd700ff,\n\t166: 0xd75f00,\n\t167: 0xd75f5f,\n\t168: 0xd75f87,\n\t169: 0xd75faf,\n\t170: 0xd75fd7,\n\t171: 0xd75fff,\n\t172: 0xd78700,\n\t173: 0xd7875f,\n\t174: 0xd78787,\n\t175: 0xd787af,\n\t176: 0xd787d7,\n\t177: 0xd787ff,\n\t178: 0xd7af00,\n\t179: 0xd7af5f,\n\t180: 0xd7af87,\n\t181: 0xd7afaf,\n\t182: 0xd7afd7,\n\t183: 0xd7afff,\n\t184: 0xd7d700,\n\t185: 0xd7d75f,\n\t186: 0xd7d787,\n\t187: 0xd7d7af,\n\t188: 0xd7d7d7,\n\t189: 0xd7d7ff,\n\t190: 0xd7ff00,\n\t191: 0xd7ff5f,\n\t192: 0xd7ff87,\n\t193: 0xd7ffaf,\n\t194: 0xd7ffd7,\n\t195: 0xd7ffff,\n\t196: 0xff0000,\n\t197: 0xff005f,\n\t198: 0xff0087,\n\t199: 0xff00af,\n\t200: 0xff00d7,\n\t201: 0xff00ff,\n\t202: 0xff5f00,\n\t203: 0xff5f5f,\n\t204: 0xff5f87,\n\t205: 0xff5faf,\n\t206: 0xff5fd7,\n\t207: 0xff5fff,\n\t208: 0xff8700,\n\t209: 0xff875f,\n\t210: 0xff8787,\n\t211: 0xff87af,\n\t212: 0xff87d7,\n\t213: 0xff87ff,\n\t214: 0xffaf00,\n\t215: 0xffaf5f,\n\t216: 0xffaf87,\n\t217: 0xffafaf,\n\t218: 0xffafd7,\n\t219: 0xffafff,\n\t220: 0xffd700,\n\t221: 0xffd75f,\n\t222: 0xffd787,\n\t223: 0xffd7af,\n\t224: 0xffd7d7,\n\t225: 0xffd7ff,\n\t226: 0xffff00,\n\t227: 0xffff5f,\n\t228: 0xffff87,\n\t229: 0xffffaf,\n\t230: 0xffffd7,\n\t231: 0xffffff,\n\t232: 0x080808,\n\t233: 0x121212,\n\t234: 0x1c1c1c,\n\t235: 0x262626,\n\t236: 0x303030,\n\t237: 0x3a3a3a,\n\t238: 0x444444,\n\t239: 0x4e4e4e,\n\t240: 0x585858,\n\t241: 0x626262,\n\t242: 0x6c6c6c,\n\t243: 0x767676,\n\t244: 0x808080,\n\t245: 0x8a8a8a,\n\t246: 0x949494,\n\t247: 0x9e9e9e,\n\t248: 0xa8a8a8,\n\t249: 0xb2b2b2,\n\t250: 0xbcbcbc,\n\t251: 0xc6c6c6,\n\t252: 0xd0d0d0,\n\t253: 0xdadada,\n\t254: 0xe4e4e4,\n\t255: 0xeeeeee,\n}\n\nfunc (w *writer) Write(data []byte) (n int, err error) {\n\tvar csbi consoleScreenBufferInfo\n\tprocGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\n\ter := bytes.NewBuffer(data)\nloop:\n\tfor {\n\t\tr1, _, err := procGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\t\tif r1 == 0 {\n\t\t\tbreak loop\n\t\t}\n\n\t\tc1, _, err := er.ReadRune()\n\t\tif err != nil {\n\t\t\tbreak loop\n\t\t}\n\t\tif c1 != 0x1b {\n\t\t\tfmt.Fprint(w.out, string(c1))\n\t\t\tcontinue\n\t\t}\n\t\tc2, _, err := er.ReadRune()\n\t\tif err != nil {\n\t\t\tw.lastbuf.WriteRune(c1)\n\t\t\tbreak loop\n\t\t}\n\t\tif c2 != 0x5b {\n\t\t\tw.lastbuf.WriteRune(c1)\n\t\t\tw.lastbuf.WriteRune(c2)\n\t\t\tcontinue\n\t\t}\n\n\t\tvar buf bytes.Buffer\n\t\tvar m rune\n\t\tfor {\n\t\t\tc, _, err := er.ReadRune()\n\t\t\tif err != nil {\n\t\t\t\tw.lastbuf.WriteRune(c1)\n\t\t\t\tw.lastbuf.WriteRune(c2)\n\t\t\t\tw.lastbuf.Write(buf.Bytes())\n\t\t\t\tbreak loop\n\t\t\t}\n\t\t\tif ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') || c == '@' {\n\t\t\t\tm = c\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tbuf.Write([]byte(string(c)))\n\t\t}\n\n\t\tvar csbi consoleScreenBufferInfo\n\t\tswitch m {\n\t\tcase 'A':\n\t\t\tn, err = strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tprocGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\t\t\tcsbi.cursorPosition.y -= short(n)\n\t\t\tprocSetConsoleCursorPosition.Call(uintptr(w.handle), *(*uintptr)(unsafe.Pointer(&csbi.cursorPosition)))\n\t\tcase 'B':\n\t\t\tn, err = strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tprocGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\t\t\tcsbi.cursorPosition.y += short(n)\n\t\t\tprocSetConsoleCursorPosition.Call(uintptr(w.handle), *(*uintptr)(unsafe.Pointer(&csbi.cursorPosition)))\n\t\tcase 'C':\n\t\t\tn, err = strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tprocGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\t\t\tcsbi.cursorPosition.x -= short(n)\n\t\t\tprocSetConsoleCursorPosition.Call(uintptr(w.handle), *(*uintptr)(unsafe.Pointer(&csbi.cursorPosition)))\n\t\tcase 'D':\n\t\t\tn, err = strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif n, err = strconv.Atoi(buf.String()); err == nil {\n\t\t\t\tvar csbi consoleScreenBufferInfo\n\t\t\t\tprocGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\t\t\t\tcsbi.cursorPosition.x += short(n)\n\t\t\t\tprocSetConsoleCursorPosition.Call(uintptr(w.handle), *(*uintptr)(unsafe.Pointer(&csbi.cursorPosition)))\n\t\t\t}\n\t\tcase 'E':\n\t\t\tn, err = strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tprocGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\t\t\tcsbi.cursorPosition.x = 0\n\t\t\tcsbi.cursorPosition.y += short(n)\n\t\t\tprocSetConsoleCursorPosition.Call(uintptr(w.handle), *(*uintptr)(unsafe.Pointer(&csbi.cursorPosition)))\n\t\tcase 'F':\n\t\t\tn, err = strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tprocGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\t\t\tcsbi.cursorPosition.x = 0\n\t\t\tcsbi.cursorPosition.y -= short(n)\n\t\t\tprocSetConsoleCursorPosition.Call(uintptr(w.handle), *(*uintptr)(unsafe.Pointer(&csbi.cursorPosition)))\n\t\tcase 'G':\n\t\t\tn, err = strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tprocGetConsoleScreenBufferInfo.Call(uintptr(w.handle), uintptr(unsafe.Pointer(&csbi)))\n\t\t\tcsbi.cursorPosition.x = short(n)\n\t\t\tprocSetConsoleCursorPosition.Call(uintptr(w.handle), *(*uintptr)(unsafe.Pointer(&csbi.cursorPosition)))\n\t\tcase 'H':\n\t\t\ttoken := strings.Split(buf.String(), \";\")\n\t\t\tif len(token) != 2 {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tn1, err := strconv.Atoi(token[0])\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tn2, err := strconv.Atoi(token[1])\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tcsbi.cursorPosition.x = short(n2)\n\t\t\tcsbi.cursorPosition.x = short(n1)\n\t\t\tprocSetConsoleCursorPosition.Call(uintptr(w.handle), *(*uintptr)(unsafe.Pointer(&csbi.cursorPosition)))\n\t\tcase 'J':\n\t\t\tn, err := strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tvar cursor coord\n\t\t\tswitch n {\n\t\t\tcase 0:\n\t\t\t\tcursor = coord{x: csbi.cursorPosition.x, y: csbi.cursorPosition.y}\n\t\t\tcase 1:\n\t\t\t\tcursor = coord{x: csbi.window.left, y: csbi.window.top}\n\t\t\tcase 2:\n\t\t\t\tcursor = coord{x: csbi.window.left, y: csbi.window.top}\n\t\t\t}\n\t\t\tvar count, written dword\n\t\t\tcount = dword(csbi.size.x - csbi.cursorPosition.x + (csbi.size.y-csbi.cursorPosition.y)*csbi.size.x)\n\t\t\tprocFillConsoleOutputCharacter.Call(uintptr(w.handle), uintptr(' '), uintptr(count), *(*uintptr)(unsafe.Pointer(&cursor)), uintptr(unsafe.Pointer(&written)))\n\t\t\tprocFillConsoleOutputAttribute.Call(uintptr(w.handle), uintptr(csbi.attributes), uintptr(count), *(*uintptr)(unsafe.Pointer(&cursor)), uintptr(unsafe.Pointer(&written)))\n\t\tcase 'K':\n\t\t\tn, err := strconv.Atoi(buf.String())\n\t\t\tif err != nil {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tvar cursor coord\n\t\t\tswitch n {\n\t\t\tcase 0:\n\t\t\t\tcursor = coord{x: csbi.cursorPosition.x, y: csbi.cursorPosition.y}\n\t\t\tcase 1:\n\t\t\t\tcursor = coord{x: csbi.window.left, y: csbi.window.top + csbi.cursorPosition.y}\n\t\t\tcase 2:\n\t\t\t\tcursor = coord{x: csbi.window.left, y: csbi.window.top + csbi.cursorPosition.y}\n\t\t\t}\n\t\t\tvar count, written dword\n\t\t\tcount = dword(csbi.size.x - csbi.cursorPosition.x)\n\t\t\tprocFillConsoleOutputCharacter.Call(uintptr(w.handle), uintptr(' '), uintptr(count), *(*uintptr)(unsafe.Pointer(&cursor)), uintptr(unsafe.Pointer(&written)))\n\t\t\tprocFillConsoleOutputAttribute.Call(uintptr(w.handle), uintptr(csbi.attributes), uintptr(count), *(*uintptr)(unsafe.Pointer(&cursor)), uintptr(unsafe.Pointer(&written)))\n\t\tcase 'm':\n\t\t\tattr := csbi.attributes\n\t\t\tcs := buf.String()\n\t\t\tif cs == \"\" {\n\t\t\t\tprocSetConsoleTextAttribute.Call(uintptr(w.handle), uintptr(w.oldattr))\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\ttoken := strings.Split(cs, \";\")\n\t\t\tfor i := 0; i < len(token); i += 1 {\n\t\t\t\tns := token[i]\n\t\t\t\tif n, err = strconv.Atoi(ns); err == nil {\n\t\t\t\t\tswitch {\n\t\t\t\t\tcase n == 0 || n == 100:\n\t\t\t\t\t\tattr = w.oldattr\n\t\t\t\t\tcase 1 <= n && n <= 5:\n\t\t\t\t\t\tattr |= foregroundIntensity\n\t\t\t\t\tcase n == 7:\n\t\t\t\t\t\tattr = ((attr & foregroundMask) << 4) | ((attr & backgroundMask) >> 4)\n\t\t\t\t\tcase 22 == n || n == 25 || n == 25:\n\t\t\t\t\t\tattr |= foregroundIntensity\n\t\t\t\t\tcase n == 27:\n\t\t\t\t\t\tattr = ((attr & foregroundMask) << 4) | ((attr & backgroundMask) >> 4)\n\t\t\t\t\tcase 30 <= n && n <= 37:\n\t\t\t\t\t\tattr = (attr & backgroundMask)\n\t\t\t\t\t\tif (n-30)&1 != 0 {\n\t\t\t\t\t\t\tattr |= foregroundRed\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (n-30)&2 != 0 {\n\t\t\t\t\t\t\tattr |= foregroundGreen\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (n-30)&4 != 0 {\n\t\t\t\t\t\t\tattr |= foregroundBlue\n\t\t\t\t\t\t}\n\t\t\t\t\tcase n == 38: // set foreground color.\n\t\t\t\t\t\tif i < len(token)-2 && (token[i+1] == \"5\" || token[i+1] == \"05\") {\n\t\t\t\t\t\t\tif n256, err := strconv.Atoi(token[i+2]); err == nil {\n\t\t\t\t\t\t\t\tif n256foreAttr == nil {\n\t\t\t\t\t\t\t\t\tn256setup()\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\tattr &= backgroundMask\n\t\t\t\t\t\t\t\tattr |= n256foreAttr[n256]\n\t\t\t\t\t\t\t\ti += 2\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tattr = attr & (w.oldattr & backgroundMask)\n\t\t\t\t\t\t}\n\t\t\t\t\tcase n == 39: // reset foreground color.\n\t\t\t\t\t\tattr &= backgroundMask\n\t\t\t\t\t\tattr |= w.oldattr & foregroundMask\n\t\t\t\t\tcase 40 <= n && n <= 47:\n\t\t\t\t\t\tattr = (attr & foregroundMask)\n\t\t\t\t\t\tif (n-40)&1 != 0 {\n\t\t\t\t\t\t\tattr |= backgroundRed\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (n-40)&2 != 0 {\n\t\t\t\t\t\t\tattr |= backgroundGreen\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (n-40)&4 != 0 {\n\t\t\t\t\t\t\tattr |= backgroundBlue\n\t\t\t\t\t\t}\n\t\t\t\t\tcase n == 48: // set background color.\n\t\t\t\t\t\tif i < len(token)-2 && token[i+1] == \"5\" {\n\t\t\t\t\t\t\tif n256, err := strconv.Atoi(token[i+2]); err == nil {\n\t\t\t\t\t\t\t\tif n256backAttr == nil {\n\t\t\t\t\t\t\t\t\tn256setup()\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\tattr &= foregroundMask\n\t\t\t\t\t\t\t\tattr |= n256backAttr[n256]\n\t\t\t\t\t\t\t\ti += 2\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tattr = attr & (w.oldattr & foregroundMask)\n\t\t\t\t\t\t}\n\t\t\t\t\tcase n == 49: // reset foreground color.\n\t\t\t\t\t\tattr &= foregroundMask\n\t\t\t\t\t\tattr |= w.oldattr & backgroundMask\n\t\t\t\t\tcase 90 <= n && n <= 97:\n\t\t\t\t\t\tattr = (attr & backgroundMask)\n\t\t\t\t\t\tattr |= foregroundIntensity\n\t\t\t\t\t\tif (n-90)&1 != 0 {\n\t\t\t\t\t\t\tattr |= foregroundRed\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (n-90)&2 != 0 {\n\t\t\t\t\t\t\tattr |= foregroundGreen\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (n-90)&4 != 0 {\n\t\t\t\t\t\t\tattr |= foregroundBlue\n\t\t\t\t\t\t}\n\t\t\t\t\tcase 100 <= n && n <= 107:\n\t\t\t\t\t\tattr = (attr & foregroundMask)\n\t\t\t\t\t\tattr |= backgroundIntensity\n\t\t\t\t\t\tif (n-100)&1 != 0 {\n\t\t\t\t\t\t\tattr |= backgroundRed\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (n-100)&2 != 0 {\n\t\t\t\t\t\t\tattr |= backgroundGreen\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (n-100)&4 != 0 {\n\t\t\t\t\t\t\tattr |= backgroundBlue\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tprocSetConsoleTextAttribute.Call(uintptr(w.handle), uintptr(attr))\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn len(data) - w.lastbuf.Len(), nil\n}\n\ntype consoleColor struct {\n\trgb int\n\tred bool\n\tgreen bool\n\tblue bool\n\tintensity bool\n}\n\nfunc (c consoleColor) foregroundAttr() (attr word) {\n\tif c.red {\n\t\tattr |= foregroundRed\n\t}\n\tif c.green {\n\t\tattr |= foregroundGreen\n\t}\n\tif c.blue {\n\t\tattr |= foregroundBlue\n\t}\n\tif c.intensity {\n\t\tattr |= foregroundIntensity\n\t}\n\treturn\n}\n\nfunc (c consoleColor) backgroundAttr() (attr word) {\n\tif c.red {\n\t\tattr |= backgroundRed\n\t}\n\tif c.green {\n\t\tattr |= backgroundGreen\n\t}\n\tif c.blue {\n\t\tattr |= backgroundBlue\n\t}\n\tif c.intensity {\n\t\tattr |= backgroundIntensity\n\t}\n\treturn\n}\n\nvar color16 = []consoleColor{\n\tconsoleColor{0x000000, false, false, false, false},\n\tconsoleColor{0x000080, false, false, true, false},\n\tconsoleColor{0x008000, false, true, false, false},\n\tconsoleColor{0x008080, false, true, true, false},\n\tconsoleColor{0x800000, true, false, false, false},\n\tconsoleColor{0x800080, true, false, true, false},\n\tconsoleColor{0x808000, true, true, false, false},\n\tconsoleColor{0xc0c0c0, true, true, true, false},\n\tconsoleColor{0x808080, false, false, false, true},\n\tconsoleColor{0x0000ff, false, false, true, true},\n\tconsoleColor{0x00ff00, false, true, false, true},\n\tconsoleColor{0x00ffff, false, true, true, true},\n\tconsoleColor{0xff0000, true, false, false, true},\n\tconsoleColor{0xff00ff, true, false, true, true},\n\tconsoleColor{0xffff00, true, true, false, true},\n\tconsoleColor{0xffffff, true, true, true, true},\n}\n\ntype hsv struct {\n\th, s, v float32\n}\n\nfunc (a hsv) dist(b hsv) float32 {\n\tdh := a.h - b.h\n\tswitch {\n\tcase dh > 0.5:\n\t\tdh = 1 - dh\n\tcase dh < -0.5:\n\t\tdh = -1 - dh\n\t}\n\tds := a.s - b.s\n\tdv := a.v - b.v\n\treturn float32(math.Sqrt(float64(dh*dh + ds*ds + dv*dv)))\n}\n\nfunc toHSV(rgb int) hsv {\n\tr, g, b := float32((rgb&0xFF0000)>>16)/256.0,\n\t\tfloat32((rgb&0x00FF00)>>8)/256.0,\n\t\tfloat32(rgb&0x0000FF)/256.0\n\tmin, max := minmax3f(r, g, b)\n\th := max - min\n\tif h > 0 {\n\t\tif max == r {\n\t\t\th = (g - b) / h\n\t\t\tif h < 0 {\n\t\t\t\th += 6\n\t\t\t}\n\t\t} else if max == g {\n\t\t\th = 2 + (b-r)/h\n\t\t} else {\n\t\t\th = 4 + (r-g)/h\n\t\t}\n\t}\n\th /= 6.0\n\ts := max - min\n\tif max != 0 {\n\t\ts /= max\n\t}\n\tv := max\n\treturn hsv{h: h, s: s, v: v}\n}\n\ntype hsvTable []hsv\n\nfunc toHSVTable(rgbTable []consoleColor) hsvTable {\n\tt := make(hsvTable, len(rgbTable))\n\tfor i, c := range rgbTable {\n\t\tt[i] = toHSV(c.rgb)\n\t}\n\treturn t\n}\n\nfunc (t hsvTable) find(rgb int) consoleColor {\n\thsv := toHSV(rgb)\n\tn := 7\n\tl := float32(5.0)\n\tfor i, p := range t {\n\t\td := hsv.dist(p)\n\t\tif d < l {\n\t\t\tl, n = d, i\n\t\t}\n\t}\n\treturn color16[n]\n}\n\nfunc minmax3f(a, b, c float32) (min, max float32) {\n\tif a < b {\n\t\tif b < c {\n\t\t\treturn a, c\n\t\t} else if a < c {\n\t\t\treturn a, b\n\t\t} else {\n\t\t\treturn c, b\n\t\t}\n\t} else {\n\t\tif a < c {\n\t\t\treturn b, c\n\t\t} else if b < c {\n\t\t\treturn b, a\n\t\t} else {\n\t\t\treturn c, a\n\t\t}\n\t}\n}\n\nvar n256foreAttr []word\nvar n256backAttr []word\n\nfunc n256setup() {\n\tn256foreAttr = make([]word, 256)\n\tn256backAttr = make([]word, 256)\n\tt := toHSVTable(color16)\n\tfor i, rgb := range color256 {\n\t\tc := t.find(rgb)\n\t\tn256foreAttr[i] = c.foregroundAttr()\n\t\tn256backAttr[i] = c.backgroundAttr()\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/formatter/formatter.go",
"content": "package formatter\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"regexp\"\n\t\"strconv\"\n\t\"strings\"\n)\n\n// ColorableStdOut and ColorableStdErr enable color output support on Windows\nvar ColorableStdOut = newColorable(os.Stdout)\nvar ColorableStdErr = newColorable(os.Stderr)\n\nconst COLS = 80\n\ntype ColorMode uint8\n\nconst (\n\tColorModeNone ColorMode = iota\n\tColorModeTerminal\n\tColorModePassthrough\n)\n\nvar SingletonFormatter = New(ColorModeTerminal)\n\nfunc F(format string, args ...any) string {\n\treturn SingletonFormatter.F(format, args...)\n}\n\nfunc Fi(indentation uint, format string, args ...any) string {\n\treturn SingletonFormatter.Fi(indentation, format, args...)\n}\n\nfunc Fiw(indentation uint, maxWidth uint, format string, args ...any) string {\n\treturn SingletonFormatter.Fiw(indentation, maxWidth, format, args...)\n}\n\ntype Formatter struct {\n\tColorMode ColorMode\n\tcolors map[string]string\n\tstyleRe *regexp.Regexp\n\tpreserveColorStylingTags bool\n}\n\nfunc NewWithNoColorBool(noColor bool) Formatter {\n\tif noColor {\n\t\treturn New(ColorModeNone)\n\t}\n\treturn New(ColorModeTerminal)\n}\n\nfunc New(colorMode ColorMode) Formatter {\n\tcolorAliases := map[string]int{\n\t\t\"black\": 0,\n\t\t\"red\": 1,\n\t\t\"green\": 2,\n\t\t\"yellow\": 3,\n\t\t\"blue\": 4,\n\t\t\"magenta\": 5,\n\t\t\"cyan\": 6,\n\t\t\"white\": 7,\n\t}\n\tfor colorAlias, n := range colorAliases {\n\t\tcolorAliases[fmt.Sprintf(\"bright-%s\", colorAlias)] = n + 8\n\t}\n\n\tgetColor := func(color, defaultEscapeCode string) string {\n\t\tcolor = strings.ToUpper(strings.ReplaceAll(color, \"-\", \"_\"))\n\t\tenvVar := fmt.Sprintf(\"GINKGO_CLI_COLOR_%s\", color)\n\t\tenvVarColor := os.Getenv(envVar)\n\t\tif envVarColor == \"\" {\n\t\t\treturn defaultEscapeCode\n\t\t}\n\t\tif colorCode, ok := colorAliases[envVarColor]; ok {\n\t\t\treturn fmt.Sprintf(\"\\x1b[38;5;%dm\", colorCode)\n\t\t}\n\t\tcolorCode, err := strconv.Atoi(envVarColor)\n\t\tif err != nil || colorCode < 0 || colorCode > 255 {\n\t\t\treturn defaultEscapeCode\n\t\t}\n\t\treturn fmt.Sprintf(\"\\x1b[38;5;%dm\", colorCode)\n\t}\n\n\tif _, noColor := os.LookupEnv(\"GINKGO_NO_COLOR\"); noColor {\n\t\tcolorMode = ColorModeNone\n\t}\n\n\tf := Formatter{\n\t\tColorMode: colorMode,\n\t\tcolors: map[string]string{\n\t\t\t\"/\": \"\\x1b[0m\",\n\t\t\t\"bold\": \"\\x1b[1m\",\n\t\t\t\"underline\": \"\\x1b[4m\",\n\n\t\t\t\"red\": getColor(\"red\", \"\\x1b[38;5;9m\"),\n\t\t\t\"orange\": getColor(\"orange\", \"\\x1b[38;5;214m\"),\n\t\t\t\"coral\": getColor(\"coral\", \"\\x1b[38;5;204m\"),\n\t\t\t\"magenta\": getColor(\"magenta\", \"\\x1b[38;5;13m\"),\n\t\t\t\"green\": getColor(\"green\", \"\\x1b[38;5;10m\"),\n\t\t\t\"dark-green\": getColor(\"dark-green\", \"\\x1b[38;5;28m\"),\n\t\t\t\"yellow\": getColor(\"yellow\", \"\\x1b[38;5;11m\"),\n\t\t\t\"light-yellow\": getColor(\"light-yellow\", \"\\x1b[38;5;228m\"),\n\t\t\t\"cyan\": getColor(\"cyan\", \"\\x1b[38;5;14m\"),\n\t\t\t\"gray\": getColor(\"gray\", \"\\x1b[38;5;243m\"),\n\t\t\t\"light-gray\": getColor(\"light-gray\", \"\\x1b[38;5;246m\"),\n\t\t\t\"blue\": getColor(\"blue\", \"\\x1b[38;5;12m\"),\n\t\t},\n\t}\n\tcolors := []string{}\n\tfor color := range f.colors {\n\t\tcolors = append(colors, color)\n\t}\n\tf.styleRe = regexp.MustCompile(\"{{(\" + strings.Join(colors, \"|\") + \")}}\")\n\treturn f\n}\n\nfunc (f Formatter) F(format string, args ...any) string {\n\treturn f.Fi(0, format, args...)\n}\n\nfunc (f Formatter) Fi(indentation uint, format string, args ...any) string {\n\treturn f.Fiw(indentation, 0, format, args...)\n}\n\nfunc (f Formatter) Fiw(indentation uint, maxWidth uint, format string, args ...any) string {\n\tout := f.style(format)\n\tif len(args) > 0 {\n\t\tout = fmt.Sprintf(out, args...)\n\t}\n\n\tif indentation == 0 && maxWidth == 0 {\n\t\treturn out\n\t}\n\n\tlines := strings.Split(out, \"\\n\")\n\n\tif maxWidth != 0 {\n\t\toutLines := []string{}\n\n\t\tmaxWidth = maxWidth - indentation*2\n\t\tfor _, line := range lines {\n\t\t\tif f.length(line) <= maxWidth {\n\t\t\t\toutLines = append(outLines, line)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\twords := strings.Split(line, \" \")\n\t\t\toutWords := []string{words[0]}\n\t\t\tlength := uint(f.length(words[0]))\n\t\t\tfor _, word := range words[1:] {\n\t\t\t\twordLength := f.length(word)\n\t\t\t\tif length+wordLength+1 <= maxWidth {\n\t\t\t\t\tlength += wordLength + 1\n\t\t\t\t\toutWords = append(outWords, word)\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\toutLines = append(outLines, strings.Join(outWords, \" \"))\n\t\t\t\toutWords = []string{word}\n\t\t\t\tlength = wordLength\n\t\t\t}\n\t\t\tif len(outWords) > 0 {\n\t\t\t\toutLines = append(outLines, strings.Join(outWords, \" \"))\n\t\t\t}\n\t\t}\n\n\t\tlines = outLines\n\t}\n\n\tif indentation == 0 {\n\t\treturn strings.Join(lines, \"\\n\")\n\t}\n\n\tpadding := strings.Repeat(\" \", int(indentation))\n\tfor i := range lines {\n\t\tif lines[i] != \"\" {\n\t\t\tlines[i] = padding + lines[i]\n\t\t}\n\t}\n\n\treturn strings.Join(lines, \"\\n\")\n}\n\nfunc (f Formatter) length(styled string) uint {\n\tn := uint(0)\n\tinStyle := false\n\tfor _, b := range styled {\n\t\tif inStyle {\n\t\t\tif b == 'm' {\n\t\t\t\tinStyle = false\n\t\t\t}\n\t\t\tcontinue\n\t\t}\n\t\tif b == '\\x1b' {\n\t\t\tinStyle = true\n\t\t\tcontinue\n\t\t}\n\t\tn += 1\n\t}\n\treturn n\n}\n\nfunc (f Formatter) CycleJoin(elements []string, joiner string, cycle []string) string {\n\tif len(elements) == 0 {\n\t\treturn \"\"\n\t}\n\tn := len(cycle)\n\tout := \"\"\n\tfor i, text := range elements {\n\t\tout += cycle[i%n] + text\n\t\tif i < len(elements)-1 {\n\t\t\tout += joiner\n\t\t}\n\t}\n\tout += \"{{/}}\"\n\treturn f.style(out)\n}\n\nfunc (f Formatter) style(s string) string {\n\tswitch f.ColorMode {\n\tcase ColorModeNone:\n\t\treturn f.styleRe.ReplaceAllString(s, \"\")\n\tcase ColorModePassthrough:\n\t\treturn s\n\tcase ColorModeTerminal:\n\t\treturn f.styleRe.ReplaceAllStringFunc(s, func(match string) string {\n\t\t\tif out, ok := f.colors[strings.Trim(match, \"{}\")]; ok {\n\t\t\t\treturn out\n\t\t\t}\n\t\t\treturn match\n\t\t})\n\t}\n\n\treturn \"\"\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/README.md",
"content": "This entire directory is a lightly modified clone of https://github.com/uber-go/automaxprocs\n\nIt will be removed when Go 1.26 ships and we no longer need to support Go 1.24 (which does not correctly autodetect maxprocs in containers).\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/automaxprocs.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n// Package maxprocs lets Go programs easily configure runtime.GOMAXPROCS to\n// match the configured Linux CPU quota. Unlike the top-level automaxprocs\n// package, it lets the caller configure logging and handle errors.\npackage automaxprocs\n\nimport (\n\t\"os\"\n\t\"runtime\"\n)\n\nfunc init() {\n\tSet()\n}\n\nconst _maxProcsKey = \"GOMAXPROCS\"\n\ntype config struct {\n\tprocs func(int, func(v float64) int) (int, CPUQuotaStatus, error)\n\tminGOMAXPROCS int\n\troundQuotaFunc func(v float64) int\n}\n\n// Set GOMAXPROCS to match the Linux container CPU quota (if any), returning\n// any error encountered and an undo function.\n//\n// Set is a no-op on non-Linux systems and in Linux environments without a\n// configured CPU quota.\nfunc Set() error {\n\tcfg := &config{\n\t\tprocs: CPUQuotaToGOMAXPROCS,\n\t\troundQuotaFunc: DefaultRoundFunc,\n\t\tminGOMAXPROCS: 1,\n\t}\n\n\t// Honor the GOMAXPROCS environment variable if present. Otherwise, amend\n\t// `runtime.GOMAXPROCS()` with the current process' CPU quota if the OS is\n\t// Linux, and guarantee a minimum value of 1. The minimum guaranteed value\n\t// can be overridden using `maxprocs.Min()`.\n\tif _, exists := os.LookupEnv(_maxProcsKey); exists {\n\t\treturn nil\n\t}\n\tmaxProcs, status, err := cfg.procs(cfg.minGOMAXPROCS, cfg.roundQuotaFunc)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif status == CPUQuotaUndefined {\n\t\treturn nil\n\t}\n\truntime.GOMAXPROCS(maxProcs)\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/cgroup.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n//go:build linux\n// +build linux\n\npackage automaxprocs\n\nimport (\n\t\"bufio\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strconv\"\n)\n\n// CGroup represents the data structure for a Linux control group.\ntype CGroup struct {\n\tpath string\n}\n\n// NewCGroup returns a new *CGroup from a given path.\nfunc NewCGroup(path string) *CGroup {\n\treturn &CGroup{path: path}\n}\n\n// Path returns the path of the CGroup*.\nfunc (cg *CGroup) Path() string {\n\treturn cg.path\n}\n\n// ParamPath returns the path of the given cgroup param under itself.\nfunc (cg *CGroup) ParamPath(param string) string {\n\treturn filepath.Join(cg.path, param)\n}\n\n// readFirstLine reads the first line from a cgroup param file.\nfunc (cg *CGroup) readFirstLine(param string) (string, error) {\n\tparamFile, err := os.Open(cg.ParamPath(param))\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tdefer paramFile.Close()\n\n\tscanner := bufio.NewScanner(paramFile)\n\tif scanner.Scan() {\n\t\treturn scanner.Text(), nil\n\t}\n\tif err := scanner.Err(); err != nil {\n\t\treturn \"\", err\n\t}\n\treturn \"\", io.ErrUnexpectedEOF\n}\n\n// readInt parses the first line from a cgroup param file as int.\nfunc (cg *CGroup) readInt(param string) (int, error) {\n\ttext, err := cg.readFirstLine(param)\n\tif err != nil {\n\t\treturn 0, err\n\t}\n\treturn strconv.Atoi(text)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/cgroups.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n//go:build linux\n// +build linux\n\npackage automaxprocs\n\nconst (\n\t// _cgroupFSType is the Linux CGroup file system type used in\n\t// `/proc/$PID/mountinfo`.\n\t_cgroupFSType = \"cgroup\"\n\t// _cgroupSubsysCPU is the CPU CGroup subsystem.\n\t_cgroupSubsysCPU = \"cpu\"\n\t// _cgroupSubsysCPUAcct is the CPU accounting CGroup subsystem.\n\t_cgroupSubsysCPUAcct = \"cpuacct\"\n\t// _cgroupSubsysCPUSet is the CPUSet CGroup subsystem.\n\t_cgroupSubsysCPUSet = \"cpuset\"\n\t// _cgroupSubsysMemory is the Memory CGroup subsystem.\n\t_cgroupSubsysMemory = \"memory\"\n\n\t// _cgroupCPUCFSQuotaUsParam is the file name for the CGroup CFS quota\n\t// parameter.\n\t_cgroupCPUCFSQuotaUsParam = \"cpu.cfs_quota_us\"\n\t// _cgroupCPUCFSPeriodUsParam is the file name for the CGroup CFS period\n\t// parameter.\n\t_cgroupCPUCFSPeriodUsParam = \"cpu.cfs_period_us\"\n)\n\nconst (\n\t_procPathCGroup = \"/proc/self/cgroup\"\n\t_procPathMountInfo = \"/proc/self/mountinfo\"\n)\n\n// CGroups is a map that associates each CGroup with its subsystem name.\ntype CGroups map[string]*CGroup\n\n// NewCGroups returns a new *CGroups from given `mountinfo` and `cgroup` files\n// under for some process under `/proc` file system (see also proc(5) for more\n// information).\nfunc NewCGroups(procPathMountInfo, procPathCGroup string) (CGroups, error) {\n\tcgroupSubsystems, err := parseCGroupSubsystems(procPathCGroup)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tcgroups := make(CGroups)\n\tnewMountPoint := func(mp *MountPoint) error {\n\t\tif mp.FSType != _cgroupFSType {\n\t\t\treturn nil\n\t\t}\n\n\t\tfor _, opt := range mp.SuperOptions {\n\t\t\tsubsys, exists := cgroupSubsystems[opt]\n\t\t\tif !exists {\n\t\t\t\tcontinue\n\t\t\t}\n\n\t\t\tcgroupPath, err := mp.Translate(subsys.Name)\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tcgroups[opt] = NewCGroup(cgroupPath)\n\t\t}\n\n\t\treturn nil\n\t}\n\n\tif err := parseMountInfo(procPathMountInfo, newMountPoint); err != nil {\n\t\treturn nil, err\n\t}\n\treturn cgroups, nil\n}\n\n// NewCGroupsForCurrentProcess returns a new *CGroups instance for the current\n// process.\nfunc NewCGroupsForCurrentProcess() (CGroups, error) {\n\treturn NewCGroups(_procPathMountInfo, _procPathCGroup)\n}\n\n// CPUQuota returns the CPU quota applied with the CPU cgroup controller.\n// It is a result of `cpu.cfs_quota_us / cpu.cfs_period_us`. If the value of\n// `cpu.cfs_quota_us` was not set (-1), the method returns `(-1, nil)`.\nfunc (cg CGroups) CPUQuota() (float64, bool, error) {\n\tcpuCGroup, exists := cg[_cgroupSubsysCPU]\n\tif !exists {\n\t\treturn -1, false, nil\n\t}\n\n\tcfsQuotaUs, err := cpuCGroup.readInt(_cgroupCPUCFSQuotaUsParam)\n\tif defined := cfsQuotaUs > 0; err != nil || !defined {\n\t\treturn -1, defined, err\n\t}\n\n\tcfsPeriodUs, err := cpuCGroup.readInt(_cgroupCPUCFSPeriodUsParam)\n\tif defined := cfsPeriodUs > 0; err != nil || !defined {\n\t\treturn -1, defined, err\n\t}\n\n\treturn float64(cfsQuotaUs) / float64(cfsPeriodUs), true, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/cgroups2.go",
"content": "// Copyright (c) 2022 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n//go:build linux\n// +build linux\n\npackage automaxprocs\n\nimport (\n\t\"bufio\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"path\"\n\t\"strconv\"\n\t\"strings\"\n)\n\nconst (\n\t// _cgroupv2CPUMax is the file name for the CGroup-V2 CPU max and period\n\t// parameter.\n\t_cgroupv2CPUMax = \"cpu.max\"\n\t// _cgroupFSType is the Linux CGroup-V2 file system type used in\n\t// `/proc/$PID/mountinfo`.\n\t_cgroupv2FSType = \"cgroup2\"\n\n\t_cgroupv2MountPoint = \"/sys/fs/cgroup\"\n\n\t_cgroupV2CPUMaxDefaultPeriod = 100000\n\t_cgroupV2CPUMaxQuotaMax = \"max\"\n)\n\nconst (\n\t_cgroupv2CPUMaxQuotaIndex = iota\n\t_cgroupv2CPUMaxPeriodIndex\n)\n\n// ErrNotV2 indicates that the system is not using cgroups2.\nvar ErrNotV2 = errors.New(\"not using cgroups2\")\n\n// CGroups2 provides access to cgroups data for systems using cgroups2.\ntype CGroups2 struct {\n\tmountPoint string\n\tgroupPath string\n\tcpuMaxFile string\n}\n\n// NewCGroups2ForCurrentProcess builds a CGroups2 for the current process.\n//\n// This returns ErrNotV2 if the system is not using cgroups2.\nfunc NewCGroups2ForCurrentProcess() (*CGroups2, error) {\n\treturn newCGroups2From(_procPathMountInfo, _procPathCGroup)\n}\n\nfunc newCGroups2From(mountInfoPath, procPathCGroup string) (*CGroups2, error) {\n\tisV2, err := isCGroupV2(mountInfoPath)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif !isV2 {\n\t\treturn nil, ErrNotV2\n\t}\n\n\tsubsystems, err := parseCGroupSubsystems(procPathCGroup)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Find v2 subsystem by looking for the `0` id\n\tvar v2subsys *CGroupSubsys\n\tfor _, subsys := range subsystems {\n\t\tif subsys.ID == 0 {\n\t\t\tv2subsys = subsys\n\t\t\tbreak\n\t\t}\n\t}\n\n\tif v2subsys == nil {\n\t\treturn nil, ErrNotV2\n\t}\n\n\treturn &CGroups2{\n\t\tmountPoint: _cgroupv2MountPoint,\n\t\tgroupPath: v2subsys.Name,\n\t\tcpuMaxFile: _cgroupv2CPUMax,\n\t}, nil\n}\n\nfunc isCGroupV2(procPathMountInfo string) (bool, error) {\n\tvar (\n\t\tisV2 bool\n\t\tnewMountPoint = func(mp *MountPoint) error {\n\t\t\tisV2 = isV2 || (mp.FSType == _cgroupv2FSType && mp.MountPoint == _cgroupv2MountPoint)\n\t\t\treturn nil\n\t\t}\n\t)\n\n\tif err := parseMountInfo(procPathMountInfo, newMountPoint); err != nil {\n\t\treturn false, err\n\t}\n\n\treturn isV2, nil\n}\n\n// CPUQuota returns the CPU quota applied with the CPU cgroup2 controller.\n// It is a result of reading cpu quota and period from cpu.max file.\n// It will return `cpu.max / cpu.period`. If cpu.max is set to max, it returns\n// (-1, false, nil)\nfunc (cg *CGroups2) CPUQuota() (float64, bool, error) {\n\tcpuMaxParams, err := os.Open(path.Join(cg.mountPoint, cg.groupPath, cg.cpuMaxFile))\n\tif err != nil {\n\t\tif os.IsNotExist(err) {\n\t\t\treturn -1, false, nil\n\t\t}\n\t\treturn -1, false, err\n\t}\n\tdefer cpuMaxParams.Close()\n\n\tscanner := bufio.NewScanner(cpuMaxParams)\n\tif scanner.Scan() {\n\t\tfields := strings.Fields(scanner.Text())\n\t\tif len(fields) == 0 || len(fields) > 2 {\n\t\t\treturn -1, false, fmt.Errorf(\"invalid format\")\n\t\t}\n\n\t\tif fields[_cgroupv2CPUMaxQuotaIndex] == _cgroupV2CPUMaxQuotaMax {\n\t\t\treturn -1, false, nil\n\t\t}\n\n\t\tmax, err := strconv.Atoi(fields[_cgroupv2CPUMaxQuotaIndex])\n\t\tif err != nil {\n\t\t\treturn -1, false, err\n\t\t}\n\n\t\tvar period int\n\t\tif len(fields) == 1 {\n\t\t\tperiod = _cgroupV2CPUMaxDefaultPeriod\n\t\t} else {\n\t\t\tperiod, err = strconv.Atoi(fields[_cgroupv2CPUMaxPeriodIndex])\n\t\t\tif err != nil {\n\t\t\t\treturn -1, false, err\n\t\t\t}\n\n\t\t\tif period == 0 {\n\t\t\t\treturn -1, false, errors.New(\"zero value for period is not allowed\")\n\t\t\t}\n\t\t}\n\n\t\treturn float64(max) / float64(period), true, nil\n\t}\n\n\tif err := scanner.Err(); err != nil {\n\t\treturn -1, false, err\n\t}\n\n\treturn 0, false, io.ErrUnexpectedEOF\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/cpu_quota_linux.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n//go:build linux\n// +build linux\n\npackage automaxprocs\n\nimport (\n\t\"errors\"\n)\n\n// CPUQuotaToGOMAXPROCS converts the CPU quota applied to the calling process\n// to a valid GOMAXPROCS value. The quota is converted from float to int using round.\n// If round == nil, DefaultRoundFunc is used.\nfunc CPUQuotaToGOMAXPROCS(minValue int, round func(v float64) int) (int, CPUQuotaStatus, error) {\n\tif round == nil {\n\t\tround = DefaultRoundFunc\n\t}\n\tcgroups, err := _newQueryer()\n\tif err != nil {\n\t\treturn -1, CPUQuotaUndefined, err\n\t}\n\n\tquota, defined, err := cgroups.CPUQuota()\n\tif !defined || err != nil {\n\t\treturn -1, CPUQuotaUndefined, err\n\t}\n\n\tmaxProcs := round(quota)\n\tif minValue > 0 && maxProcs < minValue {\n\t\treturn minValue, CPUQuotaMinUsed, nil\n\t}\n\treturn maxProcs, CPUQuotaUsed, nil\n}\n\ntype queryer interface {\n\tCPUQuota() (float64, bool, error)\n}\n\nvar (\n\t_newCgroups2 = NewCGroups2ForCurrentProcess\n\t_newCgroups = NewCGroupsForCurrentProcess\n\t_newQueryer = newQueryer\n)\n\nfunc newQueryer() (queryer, error) {\n\tcgroups, err := _newCgroups2()\n\tif err == nil {\n\t\treturn cgroups, nil\n\t}\n\tif errors.Is(err, ErrNotV2) {\n\t\treturn _newCgroups()\n\t}\n\treturn nil, err\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/cpu_quota_unsupported.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n//go:build !linux\n// +build !linux\n\npackage automaxprocs\n\n// CPUQuotaToGOMAXPROCS converts the CPU quota applied to the calling process\n// to a valid GOMAXPROCS value. This is Linux-specific and not supported in the\n// current OS.\nfunc CPUQuotaToGOMAXPROCS(_ int, _ func(v float64) int) (int, CPUQuotaStatus, error) {\n\treturn -1, CPUQuotaUndefined, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/errors.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n//go:build linux\n// +build linux\n\npackage automaxprocs\n\nimport \"fmt\"\n\ntype cgroupSubsysFormatInvalidError struct {\n\tline string\n}\n\ntype mountPointFormatInvalidError struct {\n\tline string\n}\n\ntype pathNotExposedFromMountPointError struct {\n\tmountPoint string\n\troot string\n\tpath string\n}\n\nfunc (err cgroupSubsysFormatInvalidError) Error() string {\n\treturn fmt.Sprintf(\"invalid format for CGroupSubsys: %q\", err.line)\n}\n\nfunc (err mountPointFormatInvalidError) Error() string {\n\treturn fmt.Sprintf(\"invalid format for MountPoint: %q\", err.line)\n}\n\nfunc (err pathNotExposedFromMountPointError) Error() string {\n\treturn fmt.Sprintf(\"path %q is not a descendant of mount point root %q and cannot be exposed from %q\", err.path, err.root, err.mountPoint)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/mountpoint.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n//go:build linux\n// +build linux\n\npackage automaxprocs\n\nimport (\n\t\"bufio\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n)\n\nconst (\n\t_mountInfoSep = \" \"\n\t_mountInfoOptsSep = \",\"\n\t_mountInfoOptionalFieldsSep = \"-\"\n)\n\nconst (\n\t_miFieldIDMountID = iota\n\t_miFieldIDParentID\n\t_miFieldIDDeviceID\n\t_miFieldIDRoot\n\t_miFieldIDMountPoint\n\t_miFieldIDOptions\n\t_miFieldIDOptionalFields\n\n\t_miFieldCountFirstHalf\n)\n\nconst (\n\t_miFieldOffsetFSType = iota\n\t_miFieldOffsetMountSource\n\t_miFieldOffsetSuperOptions\n\n\t_miFieldCountSecondHalf\n)\n\nconst _miFieldCountMin = _miFieldCountFirstHalf + _miFieldCountSecondHalf\n\n// MountPoint is the data structure for the mount points in\n// `/proc/$PID/mountinfo`. See also proc(5) for more information.\ntype MountPoint struct {\n\tMountID int\n\tParentID int\n\tDeviceID string\n\tRoot string\n\tMountPoint string\n\tOptions []string\n\tOptionalFields []string\n\tFSType string\n\tMountSource string\n\tSuperOptions []string\n}\n\n// NewMountPointFromLine parses a line read from `/proc/$PID/mountinfo` and\n// returns a new *MountPoint.\nfunc NewMountPointFromLine(line string) (*MountPoint, error) {\n\tfields := strings.Split(line, _mountInfoSep)\n\n\tif len(fields) < _miFieldCountMin {\n\t\treturn nil, mountPointFormatInvalidError{line}\n\t}\n\n\tmountID, err := strconv.Atoi(fields[_miFieldIDMountID])\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tparentID, err := strconv.Atoi(fields[_miFieldIDParentID])\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tfor i, field := range fields[_miFieldIDOptionalFields:] {\n\t\tif field == _mountInfoOptionalFieldsSep {\n\t\t\t// End of optional fields.\n\t\t\tfsTypeStart := _miFieldIDOptionalFields + i + 1\n\n\t\t\t// Now we know where the optional fields end, split the line again with a\n\t\t\t// limit to avoid issues with spaces in super options as present on WSL.\n\t\t\tfields = strings.SplitN(line, _mountInfoSep, fsTypeStart+_miFieldCountSecondHalf)\n\t\t\tif len(fields) != fsTypeStart+_miFieldCountSecondHalf {\n\t\t\t\treturn nil, mountPointFormatInvalidError{line}\n\t\t\t}\n\n\t\t\tmiFieldIDFSType := _miFieldOffsetFSType + fsTypeStart\n\t\t\tmiFieldIDMountSource := _miFieldOffsetMountSource + fsTypeStart\n\t\t\tmiFieldIDSuperOptions := _miFieldOffsetSuperOptions + fsTypeStart\n\n\t\t\treturn &MountPoint{\n\t\t\t\tMountID: mountID,\n\t\t\t\tParentID: parentID,\n\t\t\t\tDeviceID: fields[_miFieldIDDeviceID],\n\t\t\t\tRoot: fields[_miFieldIDRoot],\n\t\t\t\tMountPoint: fields[_miFieldIDMountPoint],\n\t\t\t\tOptions: strings.Split(fields[_miFieldIDOptions], _mountInfoOptsSep),\n\t\t\t\tOptionalFields: fields[_miFieldIDOptionalFields:(fsTypeStart - 1)],\n\t\t\t\tFSType: fields[miFieldIDFSType],\n\t\t\t\tMountSource: fields[miFieldIDMountSource],\n\t\t\t\tSuperOptions: strings.Split(fields[miFieldIDSuperOptions], _mountInfoOptsSep),\n\t\t\t}, nil\n\t\t}\n\t}\n\n\treturn nil, mountPointFormatInvalidError{line}\n}\n\n// Translate converts an absolute path inside the *MountPoint's file system to\n// the host file system path in the mount namespace the *MountPoint belongs to.\nfunc (mp *MountPoint) Translate(absPath string) (string, error) {\n\trelPath, err := filepath.Rel(mp.Root, absPath)\n\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tif relPath == \"..\" || strings.HasPrefix(relPath, \"../\") {\n\t\treturn \"\", pathNotExposedFromMountPointError{\n\t\t\tmountPoint: mp.MountPoint,\n\t\t\troot: mp.Root,\n\t\t\tpath: absPath,\n\t\t}\n\t}\n\n\treturn filepath.Join(mp.MountPoint, relPath), nil\n}\n\n// parseMountInfo parses procPathMountInfo (usually at `/proc/$PID/mountinfo`)\n// and yields parsed *MountPoint into newMountPoint.\nfunc parseMountInfo(procPathMountInfo string, newMountPoint func(*MountPoint) error) error {\n\tmountInfoFile, err := os.Open(procPathMountInfo)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer mountInfoFile.Close()\n\n\tscanner := bufio.NewScanner(mountInfoFile)\n\n\tfor scanner.Scan() {\n\t\tmountPoint, err := NewMountPointFromLine(scanner.Text())\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif err := newMountPoint(mountPoint); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\treturn scanner.Err()\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/runtime.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\npackage automaxprocs\n\nimport \"math\"\n\n// CPUQuotaStatus presents the status of how CPU quota is used\ntype CPUQuotaStatus int\n\nconst (\n\t// CPUQuotaUndefined is returned when CPU quota is undefined\n\tCPUQuotaUndefined CPUQuotaStatus = iota\n\t// CPUQuotaUsed is returned when a valid CPU quota can be used\n\tCPUQuotaUsed\n\t// CPUQuotaMinUsed is returned when CPU quota is smaller than the min value\n\tCPUQuotaMinUsed\n)\n\n// DefaultRoundFunc is the default function to convert CPU quota from float to int. It rounds the value down (floor).\nfunc DefaultRoundFunc(v float64) int {\n\treturn int(math.Floor(v))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs/subsys.go",
"content": "// Copyright (c) 2017 Uber Technologies, Inc.\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\n//go:build linux\n// +build linux\n\npackage automaxprocs\n\nimport (\n\t\"bufio\"\n\t\"os\"\n\t\"strconv\"\n\t\"strings\"\n)\n\nconst (\n\t_cgroupSep = \":\"\n\t_cgroupSubsysSep = \",\"\n)\n\nconst (\n\t_csFieldIDID = iota\n\t_csFieldIDSubsystems\n\t_csFieldIDName\n\t_csFieldCount\n)\n\n// CGroupSubsys represents the data structure for entities in\n// `/proc/$PID/cgroup`. See also proc(5) for more information.\ntype CGroupSubsys struct {\n\tID int\n\tSubsystems []string\n\tName string\n}\n\n// NewCGroupSubsysFromLine returns a new *CGroupSubsys by parsing a string in\n// the format of `/proc/$PID/cgroup`\nfunc NewCGroupSubsysFromLine(line string) (*CGroupSubsys, error) {\n\tfields := strings.SplitN(line, _cgroupSep, _csFieldCount)\n\n\tif len(fields) != _csFieldCount {\n\t\treturn nil, cgroupSubsysFormatInvalidError{line}\n\t}\n\n\tid, err := strconv.Atoi(fields[_csFieldIDID])\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tcgroup := &CGroupSubsys{\n\t\tID: id,\n\t\tSubsystems: strings.Split(fields[_csFieldIDSubsystems], _cgroupSubsysSep),\n\t\tName: fields[_csFieldIDName],\n\t}\n\n\treturn cgroup, nil\n}\n\n// parseCGroupSubsystems parses procPathCGroup (usually at `/proc/$PID/cgroup`)\n// and returns a new map[string]*CGroupSubsys.\nfunc parseCGroupSubsystems(procPathCGroup string) (map[string]*CGroupSubsys, error) {\n\tcgroupFile, err := os.Open(procPathCGroup)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer cgroupFile.Close()\n\n\tscanner := bufio.NewScanner(cgroupFile)\n\tsubsystems := make(map[string]*CGroupSubsys)\n\n\tfor scanner.Scan() {\n\t\tcgroup, err := NewCGroupSubsysFromLine(scanner.Text())\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tfor _, subsys := range cgroup.Subsystems {\n\t\t\tsubsystems[subsys] = cgroup\n\t\t}\n\t}\n\n\tif err := scanner.Err(); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn subsystems, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/automaxprocs.go",
"content": "//go:build !go1.25\n// +build !go1.25\n\npackage main\n\nimport (\n\t_ \"github.com/onsi/ginkgo/v2/ginkgo/automaxprocs\"\n)\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/build/build_command.go",
"content": "package build\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path\"\n\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/internal\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc BuildBuildCommand() command.Command {\n\tvar cliConfig = types.NewDefaultCLIConfig()\n\tvar goFlagsConfig = types.NewDefaultGoFlagsConfig()\n\n\tflags, err := types.BuildBuildCommandFlagSet(&cliConfig, &goFlagsConfig)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\treturn command.Command{\n\t\tName: \"build\",\n\t\tFlags: flags,\n\t\tUsage: \"ginkgo build \",\n\t\tShortDoc: \"Build the passed in (or the package in the current directory if left blank).\",\n\t\tDocLink: \"precompiling-suites\",\n\t\tCommand: func(args []string, _ []string) {\n\t\t\tvar errors []error\n\t\t\tcliConfig, goFlagsConfig, errors = types.VetAndInitializeCLIAndGoConfig(cliConfig, goFlagsConfig)\n\t\t\tcommand.AbortIfErrors(\"Ginkgo detected configuration issues:\", errors)\n\t\t\tbuildSpecs(args, cliConfig, goFlagsConfig)\n\t\t},\n\t}\n}\n\nfunc buildSpecs(args []string, cliConfig types.CLIConfig, goFlagsConfig types.GoFlagsConfig) {\n\tsuites := internal.FindSuites(args, cliConfig, false).WithoutState(internal.TestSuiteStateSkippedByFilter)\n\tif len(suites) == 0 {\n\t\tcommand.AbortWith(\"Found no test suites\")\n\t}\n\n\tinternal.VerifyCLIAndFrameworkVersion(suites)\n\n\topc := internal.NewOrderedParallelCompiler(cliConfig.ComputedNumCompilers())\n\topc.StartCompiling(suites, goFlagsConfig, true)\n\n\tfor {\n\t\tsuiteIdx, suite := opc.Next()\n\t\tif suiteIdx >= len(suites) {\n\t\t\tbreak\n\t\t}\n\t\tsuites[suiteIdx] = suite\n\t\tif suite.State.Is(internal.TestSuiteStateFailedToCompile) {\n\t\t\tfmt.Println(suite.CompilationError.Error())\n\t\t} else {\n\t\t\tvar testBinPath string\n\t\t\tif len(goFlagsConfig.O) != 0 {\n\t\t\t\tstat, err := os.Stat(goFlagsConfig.O)\n\t\t\t\tif err != nil {\n\t\t\t\t\tpanic(err)\n\t\t\t\t}\n\t\t\t\tif stat.IsDir() {\n\t\t\t\t\ttestBinPath = goFlagsConfig.O + \"/\" + suite.PackageName + \".test\"\n\t\t\t\t} else {\n\t\t\t\t\ttestBinPath = goFlagsConfig.O\n\t\t\t\t}\n\t\t\t}\n\t\t\tif len(testBinPath) == 0 {\n\t\t\t\ttestBinPath = path.Join(suite.Path, suite.PackageName+\".test\")\n\t\t\t}\n\t\t\tfmt.Printf(\"Compiled %s\\n\", testBinPath)\n\t\t}\n\t}\n\n\tif suites.CountWithState(internal.TestSuiteStateFailedToCompile) > 0 {\n\t\tcommand.AbortWith(\"Failed to compile all tests\")\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/command/abort.go",
"content": "package command\n\nimport \"fmt\"\n\ntype AbortDetails struct {\n\tExitCode int\n\tError error\n\tEmitUsage bool\n}\n\nfunc Abort(details AbortDetails) {\n\tpanic(details)\n}\n\nfunc AbortGracefullyWith(format string, args ...any) {\n\tAbort(AbortDetails{\n\t\tExitCode: 0,\n\t\tError: fmt.Errorf(format, args...),\n\t\tEmitUsage: false,\n\t})\n}\n\nfunc AbortWith(format string, args ...any) {\n\tAbort(AbortDetails{\n\t\tExitCode: 1,\n\t\tError: fmt.Errorf(format, args...),\n\t\tEmitUsage: false,\n\t})\n}\n\nfunc AbortWithUsage(format string, args ...any) {\n\tAbort(AbortDetails{\n\t\tExitCode: 1,\n\t\tError: fmt.Errorf(format, args...),\n\t\tEmitUsage: true,\n\t})\n}\n\nfunc AbortIfError(preamble string, err error) {\n\tif err != nil {\n\t\tAbort(AbortDetails{\n\t\t\tExitCode: 1,\n\t\t\tError: fmt.Errorf(\"%s\\n%s\", preamble, err.Error()),\n\t\t\tEmitUsage: false,\n\t\t})\n\t}\n}\n\nfunc AbortIfErrors(preamble string, errors []error) {\n\tif len(errors) > 0 {\n\t\tout := \"\"\n\t\tfor _, err := range errors {\n\t\t\tout += err.Error()\n\t\t}\n\t\tAbort(AbortDetails{\n\t\t\tExitCode: 1,\n\t\t\tError: fmt.Errorf(\"%s\\n%s\", preamble, out),\n\t\t\tEmitUsage: false,\n\t\t})\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/command/command.go",
"content": "package command\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype Command struct {\n\tName string\n\tFlags types.GinkgoFlagSet\n\tUsage string\n\tShortDoc string\n\tDocumentation string\n\tDocLink string\n\tCommand func(args []string, additionalArgs []string)\n}\n\nfunc (c Command) Run(args []string, additionalArgs []string) {\n\targs, err := c.Flags.Parse(args)\n\tif err != nil {\n\t\tAbortWithUsage(\"%s\", err.Error())\n\t}\n\tfor _, arg := range args {\n\t\tif len(arg) > 1 && strings.HasPrefix(arg, \"-\") {\n\t\t\tAbortWith(\"%s\", types.GinkgoErrors.FlagAfterPositionalParameter().Error())\n\t\t}\n\t}\n\tc.Command(args, additionalArgs)\n}\n\nfunc (c Command) EmitUsage(writer io.Writer) {\n\tfmt.Fprintln(writer, formatter.F(\"{{bold}}\"+c.Usage+\"{{/}}\"))\n\tfmt.Fprintln(writer, formatter.F(\"{{gray}}%s{{/}}\", strings.Repeat(\"-\", len(c.Usage))))\n\tif c.ShortDoc != \"\" {\n\t\tfmt.Fprintln(writer, formatter.Fiw(0, formatter.COLS, c.ShortDoc))\n\t\tfmt.Fprintln(writer, \"\")\n\t}\n\tif c.Documentation != \"\" {\n\t\tfmt.Fprintln(writer, formatter.Fiw(0, formatter.COLS, c.Documentation))\n\t\tfmt.Fprintln(writer, \"\")\n\t}\n\tif c.DocLink != \"\" {\n\t\tfmt.Fprintln(writer, formatter.Fi(0, \"{{bold}}Learn more at:{{/}} {{cyan}}{{underline}}http://onsi.github.io/ginkgo/#%s{{/}}\", c.DocLink))\n\t\tfmt.Fprintln(writer, \"\")\n\t}\n\tflagUsage := c.Flags.Usage()\n\tif flagUsage != \"\" {\n\t\tfmt.Fprint(writer, formatter.F(flagUsage))\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/command/program.go",
"content": "package command\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype Program struct {\n\tName string\n\tHeading string\n\tCommands []Command\n\tDefaultCommand Command\n\tDeprecatedCommands []DeprecatedCommand\n\n\t//For testing - leave as nil in production\n\tOutWriter io.Writer\n\tErrWriter io.Writer\n\tExiter func(code int)\n}\n\ntype DeprecatedCommand struct {\n\tName string\n\tDeprecation types.Deprecation\n}\n\nfunc (p Program) RunAndExit(osArgs []string) {\n\tvar command Command\n\tdeprecationTracker := types.NewDeprecationTracker()\n\tif p.Exiter == nil {\n\t\tp.Exiter = os.Exit\n\t}\n\tif p.OutWriter == nil {\n\t\tp.OutWriter = formatter.ColorableStdOut\n\t}\n\tif p.ErrWriter == nil {\n\t\tp.ErrWriter = formatter.ColorableStdErr\n\t}\n\n\tdefer func() {\n\t\texitCode := 0\n\n\t\tif r := recover(); r != nil {\n\t\t\tdetails, ok := r.(AbortDetails)\n\t\t\tif !ok {\n\t\t\t\tpanic(r)\n\t\t\t}\n\n\t\t\tif details.Error != nil {\n\t\t\t\tfmt.Fprintln(p.ErrWriter, formatter.F(\"{{red}}{{bold}}%s %s{{/}} {{red}}failed{{/}}\", p.Name, command.Name))\n\t\t\t\tfmt.Fprintln(p.ErrWriter, formatter.Fi(1, details.Error.Error()))\n\t\t\t}\n\t\t\tif details.EmitUsage {\n\t\t\t\tif details.Error != nil {\n\t\t\t\t\tfmt.Fprintln(p.ErrWriter, \"\")\n\t\t\t\t}\n\t\t\t\tcommand.EmitUsage(p.ErrWriter)\n\t\t\t}\n\t\t\texitCode = details.ExitCode\n\t\t}\n\n\t\tcommand.Flags.ValidateDeprecations(deprecationTracker)\n\t\tif deprecationTracker.DidTrackDeprecations() {\n\t\t\tfmt.Fprintln(p.ErrWriter, deprecationTracker.DeprecationsReport())\n\t\t}\n\t\tp.Exiter(exitCode)\n\t}()\n\n\targs, additionalArgs := []string{}, []string{}\n\n\tfoundDelimiter := false\n\tfor _, arg := range osArgs[1:] {\n\t\tif !foundDelimiter {\n\t\t\tif arg == \"--\" {\n\t\t\t\tfoundDelimiter = true\n\t\t\t\tcontinue\n\t\t\t}\n\t\t}\n\n\t\tif foundDelimiter {\n\t\t\tadditionalArgs = append(additionalArgs, arg)\n\t\t} else {\n\t\t\targs = append(args, arg)\n\t\t}\n\t}\n\n\tcommand = p.DefaultCommand\n\tif len(args) > 0 {\n\t\tp.handleHelpRequestsAndExit(p.OutWriter, args)\n\t\tif command.Name == args[0] {\n\t\t\targs = args[1:]\n\t\t} else {\n\t\t\tfor _, deprecatedCommand := range p.DeprecatedCommands {\n\t\t\t\tif deprecatedCommand.Name == args[0] {\n\t\t\t\t\tdeprecationTracker.TrackDeprecation(deprecatedCommand.Deprecation)\n\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t}\n\t\t\tfor _, tryCommand := range p.Commands {\n\t\t\t\tif tryCommand.Name == args[0] {\n\t\t\t\t\tcommand, args = tryCommand, args[1:]\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tcommand.Run(args, additionalArgs)\n}\n\nfunc (p Program) handleHelpRequestsAndExit(writer io.Writer, args []string) {\n\tif len(args) == 0 {\n\t\treturn\n\t}\n\n\tmatchesHelpFlag := func(args ...string) bool {\n\t\tfor _, arg := range args {\n\t\t\tif arg == \"--help\" || arg == \"-help\" || arg == \"-h\" || arg == \"--h\" {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t\treturn false\n\t}\n\tif len(args) == 1 {\n\t\tif args[0] == \"help\" || matchesHelpFlag(args[0]) {\n\t\t\tp.EmitUsage(writer)\n\t\t\tAbort(AbortDetails{})\n\t\t}\n\t} else {\n\t\tvar name string\n\t\tif args[0] == \"help\" || matchesHelpFlag(args[0]) {\n\t\t\tname = args[1]\n\t\t} else if matchesHelpFlag(args[1:]...) {\n\t\t\tname = args[0]\n\t\t} else {\n\t\t\treturn\n\t\t}\n\n\t\tif p.DefaultCommand.Name == name || p.Name == name {\n\t\t\tp.DefaultCommand.EmitUsage(writer)\n\t\t\tAbort(AbortDetails{})\n\t\t}\n\t\tfor _, command := range p.Commands {\n\t\t\tif command.Name == name {\n\t\t\t\tcommand.EmitUsage(writer)\n\t\t\t\tAbort(AbortDetails{})\n\t\t\t}\n\t\t}\n\n\t\tfmt.Fprintln(writer, formatter.F(\"{{red}}Unknown Command: {{bold}}%s{{/}}\", name))\n\t\tfmt.Fprintln(writer, \"\")\n\t\tp.EmitUsage(writer)\n\t\tAbort(AbortDetails{ExitCode: 1})\n\t}\n}\n\nfunc (p Program) EmitUsage(writer io.Writer) {\n\tfmt.Fprintln(writer, formatter.F(p.Heading))\n\tfmt.Fprintln(writer, formatter.F(\"{{gray}}%s{{/}}\", strings.Repeat(\"-\", len(p.Heading))))\n\tfmt.Fprintln(writer, formatter.F(\"For usage information for a command, run {{bold}}%s help COMMAND{{/}}.\", p.Name))\n\tfmt.Fprintln(writer, formatter.F(\"For usage information for the default command, run {{bold}}%s help %s{{/}} or {{bold}}%s help %s{{/}}.\", p.Name, p.Name, p.Name, p.DefaultCommand.Name))\n\tfmt.Fprintln(writer, \"\")\n\tfmt.Fprintln(writer, formatter.F(\"The following commands are available:\"))\n\n\tfmt.Fprintln(writer, formatter.Fi(1, \"{{bold}}%s{{/}} or %s {{bold}}%s{{/}} - {{gray}}%s{{/}}\", p.Name, p.Name, p.DefaultCommand.Name, p.DefaultCommand.Usage))\n\tif p.DefaultCommand.ShortDoc != \"\" {\n\t\tfmt.Fprintln(writer, formatter.Fi(2, p.DefaultCommand.ShortDoc))\n\t}\n\n\tfor _, command := range p.Commands {\n\t\tfmt.Fprintln(writer, formatter.Fi(1, \"{{bold}}%s{{/}} - {{gray}}%s{{/}}\", command.Name, command.Usage))\n\t\tif command.ShortDoc != \"\" {\n\t\t\tfmt.Fprintln(writer, formatter.Fi(2, command.ShortDoc))\n\t\t}\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/generators/boostrap_templates.go",
"content": "package generators\n\nvar bootstrapText = `package {{.Package}}\n\nimport (\n\t\"testing\"\n\n\t{{.GinkgoImport}}\n\t{{.GomegaImport}}\n)\n\nfunc Test{{.FormattedName}}(t *testing.T) {\n\t{{.GomegaPackage}}RegisterFailHandler({{.GinkgoPackage}}Fail)\n\t{{.GinkgoPackage}}RunSpecs(t, \"{{.FormattedName}} Suite\")\n}\n`\n\nvar agoutiBootstrapText = `package {{.Package}}\n\nimport (\n\t\"testing\"\n\n\t{{.GinkgoImport}}\n\t{{.GomegaImport}}\n\t\"github.com/sclevine/agouti\"\n)\n\nfunc Test{{.FormattedName}}(t *testing.T) {\n\t{{.GomegaPackage}}RegisterFailHandler({{.GinkgoPackage}}Fail)\n\t{{.GinkgoPackage}}RunSpecs(t, \"{{.FormattedName}} Suite\")\n}\n\nvar agoutiDriver *agouti.WebDriver\n\nvar _ = {{.GinkgoPackage}}BeforeSuite(func() {\n\t// Choose a WebDriver:\n\n\tagoutiDriver = agouti.PhantomJS()\n\t// agoutiDriver = agouti.Selenium()\n\t// agoutiDriver = agouti.ChromeDriver()\n\n\t{{.GomegaPackage}}Expect(agoutiDriver.Start()).To({{.GomegaPackage}}Succeed())\n})\n\nvar _ = {{.GinkgoPackage}}AfterSuite(func() {\n\t{{.GomegaPackage}}Expect(agoutiDriver.Stop()).To({{.GomegaPackage}}Succeed())\n})\n`\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/generators/bootstrap_command.go",
"content": "package generators\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"text/template\"\n\n\tsprig \"github.com/go-task/slim-sprig/v3\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/internal\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc BuildBootstrapCommand() command.Command {\n\tconf := GeneratorsConfig{}\n\tflags, err := types.NewGinkgoFlagSet(\n\t\ttypes.GinkgoFlags{\n\t\t\t{Name: \"agouti\", KeyPath: \"Agouti\",\n\t\t\t\tUsage: \"If set, bootstrap will generate a bootstrap file for writing Agouti tests\"},\n\t\t\t{Name: \"nodot\", KeyPath: \"NoDot\",\n\t\t\t\tUsage: \"If set, bootstrap will generate a bootstrap test file that does not dot-import ginkgo and gomega\"},\n\t\t\t{Name: \"internal\", KeyPath: \"Internal\",\n\t\t\t\tUsage: \"If set, bootstrap will generate a bootstrap test file that uses the regular package name (i.e. `package X`, not `package X_test`)\"},\n\t\t\t{Name: \"template\", KeyPath: \"CustomTemplate\",\n\t\t\t\tUsageArgument: \"template-file\",\n\t\t\t\tUsage: \"If specified, generate will use the contents of the file passed as the bootstrap template\"},\n\t\t\t{Name: \"template-data\", KeyPath: \"CustomTemplateData\",\n\t\t\t\tUsageArgument: \"template-data-file\",\n\t\t\t\tUsage: \"If specified, generate will use the contents of the file passed as data to be rendered in the bootstrap template\"},\n\t\t},\n\t\t&conf,\n\t\ttypes.GinkgoFlagSections{},\n\t)\n\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\treturn command.Command{\n\t\tName: \"bootstrap\",\n\t\tUsage: \"ginkgo bootstrap\",\n\t\tShortDoc: \"Bootstrap a test suite for the current package\",\n\t\tDocumentation: `Tests written in Ginkgo and Gomega require a small amount of boilerplate to hook into Go's testing infrastructure.\n\n{{bold}}ginkgo bootstrap{{/}} generates this boilerplate for you in a file named X_suite_test.go where X is the name of the package under test.`,\n\t\tDocLink: \"generators\",\n\t\tFlags: flags,\n\t\tCommand: func(_ []string, _ []string) {\n\t\t\tgenerateBootstrap(conf)\n\t\t},\n\t}\n}\n\ntype bootstrapData struct {\n\tPackage string\n\tFormattedName string\n\n\tGinkgoImport string\n\tGomegaImport string\n\tGinkgoPackage string\n\tGomegaPackage string\n\tCustomData map[string]any\n}\n\nfunc generateBootstrap(conf GeneratorsConfig) {\n\tpackageName, bootstrapFilePrefix, formattedName := getPackageAndFormattedName()\n\n\tdata := bootstrapData{\n\t\tPackage: determinePackageName(packageName, conf.Internal),\n\t\tFormattedName: formattedName,\n\n\t\tGinkgoImport: `. \"github.com/onsi/ginkgo/v2\"`,\n\t\tGomegaImport: `. \"github.com/onsi/gomega\"`,\n\t\tGinkgoPackage: \"\",\n\t\tGomegaPackage: \"\",\n\t}\n\n\tif conf.NoDot {\n\t\tdata.GinkgoImport = `\"github.com/onsi/ginkgo/v2\"`\n\t\tdata.GomegaImport = `\"github.com/onsi/gomega\"`\n\t\tdata.GinkgoPackage = `ginkgo.`\n\t\tdata.GomegaPackage = `gomega.`\n\t}\n\n\ttargetFile := fmt.Sprintf(\"%s_suite_test.go\", bootstrapFilePrefix)\n\tif internal.FileExists(targetFile) {\n\t\tcommand.AbortWith(\"{{bold}}%s{{/}} already exists\", targetFile)\n\t} else {\n\t\tfmt.Printf(\"Generating ginkgo test suite bootstrap for %s in:\\n\\t%s\\n\", packageName, targetFile)\n\t}\n\n\tf, err := os.Create(targetFile)\n\tcommand.AbortIfError(\"Failed to create file:\", err)\n\tdefer f.Close()\n\n\tvar templateText string\n\tif conf.CustomTemplate != \"\" {\n\t\ttpl, err := os.ReadFile(conf.CustomTemplate)\n\t\tcommand.AbortIfError(\"Failed to read custom bootstrap file:\", err)\n\t\ttemplateText = string(tpl)\n\t\tif conf.CustomTemplateData != \"\" {\n\t\t\tvar tplCustomDataMap map[string]any\n\t\t\ttplCustomData, err := os.ReadFile(conf.CustomTemplateData)\n\t\t\tcommand.AbortIfError(\"Failed to read custom boostrap data file:\", err)\n\t\t\tif !json.Valid([]byte(tplCustomData)) {\n\t\t\t\tcommand.AbortWith(\"Invalid JSON object in custom data file.\")\n\t\t\t}\n\t\t\t//create map from the custom template data\n\t\t\tjson.Unmarshal(tplCustomData, &tplCustomDataMap)\n\t\t\tdata.CustomData = tplCustomDataMap\n\t\t}\n\t} else if conf.Agouti {\n\t\ttemplateText = agoutiBootstrapText\n\t} else {\n\t\ttemplateText = bootstrapText\n\t}\n\n\t//Setting the option to explicitly fail if template is rendered trying to access missing key\n\tbootstrapTemplate, err := template.New(\"bootstrap\").Funcs(sprig.TxtFuncMap()).Option(\"missingkey=error\").Parse(templateText)\n\tcommand.AbortIfError(\"Failed to parse bootstrap template:\", err)\n\n\tbuf := &bytes.Buffer{}\n\t//Being explicit about failing sooner during template rendering\n\t//when accessing custom data rather than during the go fmt command\n\terr = bootstrapTemplate.Execute(buf, data)\n\tcommand.AbortIfError(\"Failed to render bootstrap template:\", err)\n\n\tbuf.WriteTo(f)\n\n\tinternal.GoFmt(targetFile)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/generators/generate_command.go",
"content": "package generators\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n\t\"text/template\"\n\n\tsprig \"github.com/go-task/slim-sprig/v3\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/internal\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc BuildGenerateCommand() command.Command {\n\tconf := GeneratorsConfig{}\n\tflags, err := types.NewGinkgoFlagSet(\n\t\ttypes.GinkgoFlags{\n\t\t\t{Name: \"agouti\", KeyPath: \"Agouti\",\n\t\t\t\tUsage: \"If set, generate will create a test file for writing Agouti tests\"},\n\t\t\t{Name: \"nodot\", KeyPath: \"NoDot\",\n\t\t\t\tUsage: \"If set, generate will create a test file that does not dot-import ginkgo and gomega\"},\n\t\t\t{Name: \"internal\", KeyPath: \"Internal\",\n\t\t\t\tUsage: \"If set, generate will create a test file that uses the regular package name (i.e. `package X`, not `package X_test`)\"},\n\t\t\t{Name: \"template\", KeyPath: \"CustomTemplate\",\n\t\t\t\tUsageArgument: \"template-file\",\n\t\t\t\tUsage: \"If specified, generate will use the contents of the file passed as the test file template\"},\n\t\t\t{Name: \"template-data\", KeyPath: \"CustomTemplateData\",\n\t\t\t\tUsageArgument: \"template-data-file\",\n\t\t\t\tUsage: \"If specified, generate will use the contents of the file passed as data to be rendered in the test file template\"},\n\t\t\t{Name: \"tags\", KeyPath: \"Tags\",\n\t\t\t\tUsageArgument: \"build-tags\",\n\t\t\t\tUsage: \"If specified, generate will create a test file that uses the given build tags (i.e. `--tags e2e,!unit` will add `//go:build e2e,!unit`)\"},\n\t\t},\n\t\t&conf,\n\t\ttypes.GinkgoFlagSections{},\n\t)\n\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\treturn command.Command{\n\t\tName: \"generate\",\n\t\tUsage: \"ginkgo generate \",\n\t\tShortDoc: \"Generate a test file named _test.go\",\n\t\tDocumentation: `If the optional argument is omitted, a file named after the package in the current directory will be created.\n\nYou can pass multiple to generate multiple files simultaneously. The resulting files are named _test.go.\n\nYou can also pass a of the form \"file.go\" and generate will emit \"file_test.go\".`,\n\t\tDocLink: \"generators\",\n\t\tFlags: flags,\n\t\tCommand: func(args []string, _ []string) {\n\t\t\tgenerateTestFiles(conf, args)\n\t\t},\n\t}\n}\n\ntype specData struct {\n\tBuildTags string\n\tPackage string\n\tSubject string\n\tPackageImportPath string\n\tImportPackage bool\n\n\tGinkgoImport string\n\tGomegaImport string\n\tGinkgoPackage string\n\tGomegaPackage string\n\tCustomData map[string]any\n}\n\nfunc generateTestFiles(conf GeneratorsConfig, args []string) {\n\tsubjects := args\n\tif len(subjects) == 0 {\n\t\tsubjects = []string{\"\"}\n\t}\n\tfor _, subject := range subjects {\n\t\tgenerateTestFileForSubject(subject, conf)\n\t}\n}\n\nfunc generateTestFileForSubject(subject string, conf GeneratorsConfig) {\n\tpackageName, specFilePrefix, formattedName := getPackageAndFormattedName()\n\tif subject != \"\" {\n\t\tspecFilePrefix = formatSubject(subject)\n\t\tformattedName = prettifyName(specFilePrefix)\n\t}\n\n\tif conf.Internal {\n\t\tspecFilePrefix = specFilePrefix + \"_internal\"\n\t}\n\n\tdata := specData{\n\t\tBuildTags: getBuildTags(conf.Tags),\n\t\tPackage: determinePackageName(packageName, conf.Internal),\n\t\tSubject: formattedName,\n\t\tPackageImportPath: getPackageImportPath(),\n\t\tImportPackage: !conf.Internal,\n\n\t\tGinkgoImport: `. \"github.com/onsi/ginkgo/v2\"`,\n\t\tGomegaImport: `. \"github.com/onsi/gomega\"`,\n\t\tGinkgoPackage: \"\",\n\t\tGomegaPackage: \"\",\n\t}\n\n\tif conf.NoDot {\n\t\tdata.GinkgoImport = `\"github.com/onsi/ginkgo/v2\"`\n\t\tdata.GomegaImport = `\"github.com/onsi/gomega\"`\n\t\tdata.GinkgoPackage = `ginkgo.`\n\t\tdata.GomegaPackage = `gomega.`\n\t}\n\n\ttargetFile := fmt.Sprintf(\"%s_test.go\", specFilePrefix)\n\tif internal.FileExists(targetFile) {\n\t\tcommand.AbortWith(\"{{bold}}%s{{/}} already exists\", targetFile)\n\t} else {\n\t\tfmt.Printf(\"Generating ginkgo test for %s in:\\n %s\\n\", data.Subject, targetFile)\n\t}\n\n\tf, err := os.Create(targetFile)\n\tcommand.AbortIfError(\"Failed to create test file:\", err)\n\tdefer f.Close()\n\n\tvar templateText string\n\tif conf.CustomTemplate != \"\" {\n\t\ttpl, err := os.ReadFile(conf.CustomTemplate)\n\t\tcommand.AbortIfError(\"Failed to read custom template file:\", err)\n\t\ttemplateText = string(tpl)\n\t\tif conf.CustomTemplateData != \"\" {\n\t\t\tvar tplCustomDataMap map[string]any\n\t\t\ttplCustomData, err := os.ReadFile(conf.CustomTemplateData)\n\t\t\tcommand.AbortIfError(\"Failed to read custom template data file:\", err)\n\t\t\tif !json.Valid([]byte(tplCustomData)) {\n\t\t\t\tcommand.AbortWith(\"Invalid JSON object in custom data file.\")\n\t\t\t}\n\t\t\t//create map from the custom template data\n\t\t\tjson.Unmarshal(tplCustomData, &tplCustomDataMap)\n\t\t\tdata.CustomData = tplCustomDataMap\n\t\t}\n\t} else if conf.Agouti {\n\t\ttemplateText = agoutiSpecText\n\t} else {\n\t\ttemplateText = specText\n\t}\n\n\t//Setting the option to explicitly fail if template is rendered trying to access missing key\n\tspecTemplate, err := template.New(\"spec\").Funcs(sprig.TxtFuncMap()).Option(\"missingkey=error\").Parse(templateText)\n\tcommand.AbortIfError(\"Failed to read parse test template:\", err)\n\n\t//Being explicit about failing sooner during template rendering\n\t//when accessing custom data rather than during the go fmt command\n\terr = specTemplate.Execute(f, data)\n\tcommand.AbortIfError(\"Failed to render bootstrap template:\", err)\n\tinternal.GoFmt(targetFile)\n}\n\nfunc formatSubject(name string) string {\n\tname = strings.ReplaceAll(name, \"-\", \"_\")\n\tname = strings.ReplaceAll(name, \" \", \"_\")\n\tname = strings.Split(name, \".go\")[0]\n\tname = strings.Split(name, \"_test\")[0]\n\treturn name\n}\n\n// moduleName returns module name from go.mod from given module root directory\nfunc moduleName(modRoot string) string {\n\tmodFile, err := os.Open(filepath.Join(modRoot, \"go.mod\"))\n\tif err != nil {\n\t\treturn \"\"\n\t}\n\tdefer modFile.Close()\n\n\tmod := make([]byte, 128)\n\t_, err = modFile.Read(mod)\n\tif err != nil {\n\t\treturn \"\"\n\t}\n\n\tslashSlash := []byte(\"//\")\n\tmoduleStr := []byte(\"module\")\n\n\tfor len(mod) > 0 {\n\t\tline := mod\n\t\tmod = nil\n\t\tif i := bytes.IndexByte(line, '\\n'); i >= 0 {\n\t\t\tline, mod = line[:i], line[i+1:]\n\t\t}\n\t\tif i := bytes.Index(line, slashSlash); i >= 0 {\n\t\t\tline = line[:i]\n\t\t}\n\t\tline = bytes.TrimSpace(line)\n\t\tif !bytes.HasPrefix(line, moduleStr) {\n\t\t\tcontinue\n\t\t}\n\t\tline = line[len(moduleStr):]\n\t\tn := len(line)\n\t\tline = bytes.TrimSpace(line)\n\t\tif len(line) == n || len(line) == 0 {\n\t\t\tcontinue\n\t\t}\n\n\t\tif line[0] == '\"' || line[0] == '`' {\n\t\t\tp, err := strconv.Unquote(string(line))\n\t\t\tif err != nil {\n\t\t\t\treturn \"\" // malformed quoted string or multiline module path\n\t\t\t}\n\t\t\treturn p\n\t\t}\n\n\t\treturn string(line)\n\t}\n\n\treturn \"\" // missing module path\n}\n\nfunc findModuleRoot(dir string) (root string) {\n\tdir = filepath.Clean(dir)\n\n\t// Look for enclosing go.mod.\n\tfor {\n\t\tif fi, err := os.Stat(filepath.Join(dir, \"go.mod\")); err == nil && !fi.IsDir() {\n\t\t\treturn dir\n\t\t}\n\t\td := filepath.Dir(dir)\n\t\tif d == dir {\n\t\t\tbreak\n\t\t}\n\t\tdir = d\n\t}\n\treturn \"\"\n}\n\nfunc getPackageImportPath() string {\n\tworkingDir, err := os.Getwd()\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\n\tsep := string(filepath.Separator)\n\n\t// Try go.mod file first\n\tmodRoot := findModuleRoot(workingDir)\n\tif modRoot != \"\" {\n\t\tmodName := moduleName(modRoot)\n\t\tif modName != \"\" {\n\t\t\tcd := strings.ReplaceAll(workingDir, modRoot, \"\")\n\t\t\tcd = strings.ReplaceAll(cd, sep, \"/\")\n\t\t\treturn modName + cd\n\t\t}\n\t}\n\n\t// Fallback to GOPATH structure\n\tpaths := strings.Split(workingDir, sep+\"src\"+sep)\n\tif len(paths) == 1 {\n\t\tfmt.Printf(\"\\nCouldn't identify package import path.\\n\\n\\tginkgo generate\\n\\nMust be run within a package directory under $GOPATH/src/...\\nYou're going to have to change UNKNOWN_PACKAGE_PATH in the generated file...\\n\\n\")\n\t\treturn \"UNKNOWN_PACKAGE_PATH\"\n\t}\n\treturn filepath.ToSlash(paths[len(paths)-1])\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/generators/generate_templates.go",
"content": "package generators\n\nvar specText = `{{.BuildTags}}\npackage {{.Package}}\n\nimport (\n\t{{.GinkgoImport}}\n\t{{.GomegaImport}}\n\n\t{{if .ImportPackage}}\"{{.PackageImportPath}}\"{{end}}\n)\n\nvar _ = {{.GinkgoPackage}}Describe(\"{{.Subject}}\", func() {\n\n})\n`\n\nvar agoutiSpecText = `{{.BuildTags}}\npackage {{.Package}}\n\nimport (\n\t{{.GinkgoImport}}\n\t{{.GomegaImport}}\n\t\"github.com/sclevine/agouti\"\n\t. \"github.com/sclevine/agouti/matchers\"\n\n\t{{if .ImportPackage}}\"{{.PackageImportPath}}\"{{end}}\n)\n\nvar _ = {{.GinkgoPackage}}Describe(\"{{.Subject}}\", func() {\n\tvar page *agouti.Page\n\n\t{{.GinkgoPackage}}BeforeEach(func() {\n\t\tvar err error\n\t\tpage, err = agoutiDriver.NewPage()\n\t\t{{.GomegaPackage}}Expect(err).NotTo({{.GomegaPackage}}HaveOccurred())\n\t})\n\n\t{{.GinkgoPackage}}AfterEach(func() {\n\t\t{{.GomegaPackage}}Expect(page.Destroy()).To({{.GomegaPackage}}Succeed())\n\t})\n})\n`\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/generators/generators_common.go",
"content": "package generators\n\nimport (\n\t\"fmt\"\n\t\"go/build\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n)\n\ntype GeneratorsConfig struct {\n\tAgouti, NoDot, Internal bool\n\tCustomTemplate string\n\tCustomTemplateData string\n\tTags string\n}\n\nfunc getPackageAndFormattedName() (string, string, string) {\n\tpath, err := os.Getwd()\n\tcommand.AbortIfError(\"Could not get current working directory:\", err)\n\n\tdirName := strings.ReplaceAll(filepath.Base(path), \"-\", \"_\")\n\tdirName = strings.ReplaceAll(dirName, \" \", \"_\")\n\n\tpkg, err := build.ImportDir(path, 0)\n\tpackageName := pkg.Name\n\tif err != nil {\n\t\tpackageName = ensureLegalPackageName(dirName)\n\t}\n\n\tformattedName := prettifyName(filepath.Base(path))\n\treturn packageName, dirName, formattedName\n}\n\nfunc ensureLegalPackageName(name string) string {\n\tif name == \"_\" {\n\t\treturn \"underscore\"\n\t}\n\tif len(name) == 0 {\n\t\treturn \"empty\"\n\t}\n\tn, isDigitErr := strconv.Atoi(string(name[0]))\n\tif isDigitErr == nil {\n\t\treturn []string{\"zero\", \"one\", \"two\", \"three\", \"four\", \"five\", \"six\", \"seven\", \"eight\", \"nine\"}[n] + name[1:]\n\t}\n\treturn name\n}\n\nfunc prettifyName(name string) string {\n\tname = strings.ReplaceAll(name, \"-\", \" \")\n\tname = strings.ReplaceAll(name, \"_\", \" \")\n\tname = strings.Title(name)\n\tname = strings.ReplaceAll(name, \" \", \"\")\n\treturn name\n}\n\nfunc determinePackageName(name string, internal bool) string {\n\tif internal {\n\t\treturn name\n\t}\n\n\treturn name + \"_test\"\n}\n\n// getBuildTags returns the resultant string to be added.\n// If the input string is not empty, then returns a `//go:build {}` string,\n// otherwise returns an empty string.\nfunc getBuildTags(tags string) string {\n\tif tags != \"\" {\n\t\treturn fmt.Sprintf(\"//go:build %s\\n\", tags)\n\t}\n\treturn \"\"\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/internal/compile.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"sync\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc CompileSuite(suite TestSuite, goFlagsConfig types.GoFlagsConfig, preserveSymbols bool) TestSuite {\n\tif suite.PathToCompiledTest != \"\" {\n\t\treturn suite\n\t}\n\n\tsuite.CompilationError = nil\n\n\tpath, err := filepath.Abs(filepath.Join(suite.Path, suite.PackageName+\".test\"))\n\tif err != nil {\n\t\tsuite.State = TestSuiteStateFailedToCompile\n\t\tsuite.CompilationError = fmt.Errorf(\"Failed to compute compilation target path:\\n%s\", err.Error())\n\t\treturn suite\n\t}\n\n\tif len(goFlagsConfig.O) > 0 {\n\t\tuserDefinedPath, err := filepath.Abs(goFlagsConfig.O)\n\t\tif err != nil {\n\t\t\tsuite.State = TestSuiteStateFailedToCompile\n\t\t\tsuite.CompilationError = fmt.Errorf(\"Failed to compute compilation target path %s:\\n%s\", goFlagsConfig.O, err.Error())\n\t\t\treturn suite\n\t\t}\n\t\tpath = userDefinedPath\n\t}\n\n\tgoFlagsConfig.O = path\n\n\tginkgoInvocationPath, _ := os.Getwd()\n\tginkgoInvocationPath, _ = filepath.Abs(ginkgoInvocationPath)\n\tpackagePath := suite.AbsPath()\n\tpathToInvocationPath, err := filepath.Rel(packagePath, ginkgoInvocationPath)\n\tif err != nil {\n\t\tsuite.State = TestSuiteStateFailedToCompile\n\t\tsuite.CompilationError = fmt.Errorf(\"Failed to get relative path from package to the current working directory:\\n%s\", err.Error())\n\t\treturn suite\n\t}\n\targs, err := types.GenerateGoTestCompileArgs(goFlagsConfig, \"./\", pathToInvocationPath, preserveSymbols)\n\tif err != nil {\n\t\tsuite.State = TestSuiteStateFailedToCompile\n\t\tsuite.CompilationError = fmt.Errorf(\"Failed to generate go test compile flags:\\n%s\", err.Error())\n\t\treturn suite\n\t}\n\n\tcmd := exec.Command(\"go\", args...)\n\tcmd.Dir = suite.Path\n\toutput, err := cmd.CombinedOutput()\n\tif err != nil {\n\t\tif len(output) > 0 {\n\t\t\tsuite.State = TestSuiteStateFailedToCompile\n\t\t\tsuite.CompilationError = fmt.Errorf(\"Failed to compile %s:\\n\\n%s\", suite.PackageName, output)\n\t\t} else {\n\t\t\tsuite.State = TestSuiteStateFailedToCompile\n\t\t\tsuite.CompilationError = fmt.Errorf(\"Failed to compile %s\\n%s\", suite.PackageName, err.Error())\n\t\t}\n\t\treturn suite\n\t}\n\n\tif strings.Contains(string(output), \"[no test files]\") {\n\t\tsuite.State = TestSuiteStateSkippedDueToEmptyCompilation\n\t\treturn suite\n\t}\n\n\tif len(output) > 0 {\n\t\tfmt.Println(string(output))\n\t}\n\n\tif !FileExists(path) {\n\t\tsuite.State = TestSuiteStateFailedToCompile\n\t\tsuite.CompilationError = fmt.Errorf(\"Failed to compile %s:\\nOutput file %s could not be found\", suite.PackageName, path)\n\t\treturn suite\n\t}\n\n\tsuite.State = TestSuiteStateCompiled\n\tsuite.PathToCompiledTest = path\n\treturn suite\n}\n\nfunc Cleanup(goFlagsConfig types.GoFlagsConfig, suites ...TestSuite) {\n\tif goFlagsConfig.BinaryMustBePreserved() {\n\t\treturn\n\t}\n\tfor _, suite := range suites {\n\t\tif !suite.Precompiled {\n\t\t\tos.Remove(suite.PathToCompiledTest)\n\t\t}\n\t}\n}\n\ntype parallelSuiteBundle struct {\n\tsuite TestSuite\n\tcompiled chan TestSuite\n}\n\ntype OrderedParallelCompiler struct {\n\tmutex *sync.Mutex\n\tstopped bool\n\tnumCompilers int\n\n\tidx int\n\tnumSuites int\n\tcompletionChannels []chan TestSuite\n}\n\nfunc NewOrderedParallelCompiler(numCompilers int) *OrderedParallelCompiler {\n\treturn &OrderedParallelCompiler{\n\t\tmutex: &sync.Mutex{},\n\t\tnumCompilers: numCompilers,\n\t}\n}\n\nfunc (opc *OrderedParallelCompiler) StartCompiling(suites TestSuites, goFlagsConfig types.GoFlagsConfig, preserveSymbols bool) {\n\topc.stopped = false\n\topc.idx = 0\n\topc.numSuites = len(suites)\n\topc.completionChannels = make([]chan TestSuite, opc.numSuites)\n\n\ttoCompile := make(chan parallelSuiteBundle, opc.numCompilers)\n\tfor compiler := 0; compiler < opc.numCompilers; compiler++ {\n\t\tgo func() {\n\t\t\tfor bundle := range toCompile {\n\t\t\t\tc, suite := bundle.compiled, bundle.suite\n\t\t\t\topc.mutex.Lock()\n\t\t\t\tstopped := opc.stopped\n\t\t\t\topc.mutex.Unlock()\n\t\t\t\tif !stopped {\n\t\t\t\t\tsuite = CompileSuite(suite, goFlagsConfig, preserveSymbols)\n\t\t\t\t}\n\t\t\t\tc <- suite\n\t\t\t}\n\t\t}()\n\t}\n\n\tfor idx, suite := range suites {\n\t\topc.completionChannels[idx] = make(chan TestSuite, 1)\n\t\ttoCompile <- parallelSuiteBundle{suite, opc.completionChannels[idx]}\n\t\tif idx == 0 { //compile first suite serially\n\t\t\tsuite = <-opc.completionChannels[0]\n\t\t\topc.completionChannels[0] <- suite\n\t\t}\n\t}\n\n\tclose(toCompile)\n}\n\nfunc (opc *OrderedParallelCompiler) Next() (int, TestSuite) {\n\tif opc.idx >= opc.numSuites {\n\t\treturn opc.numSuites, TestSuite{}\n\t}\n\n\tidx := opc.idx\n\tsuite := <-opc.completionChannels[idx]\n\topc.idx = opc.idx + 1\n\n\treturn idx, suite\n}\n\nfunc (opc *OrderedParallelCompiler) StopAndDrain() {\n\topc.mutex.Lock()\n\topc.stopped = true\n\topc.mutex.Unlock()\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/internal/gocovmerge.go",
"content": "// Copyright (c) 2015, Wade Simmons\n// All rights reserved.\n\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions are met:\n\n// 1. Redistributions of source code must retain the above copyright notice, this\n// list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright notice,\n// this list of conditions and the following disclaimer in the documentation\n// and/or other materials provided with the distribution.\n\n// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\n// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\n// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR\n// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\n// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n// Package gocovmerge takes the results from multiple `go test -coverprofile`\n// runs and merges them into one profile\n\n// this file was originally taken from the gocovmerge project\n// see also: https://go.shabbyrobe.org/gocovmerge\npackage internal\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"sort\"\n\n\t\"golang.org/x/tools/cover\"\n)\n\nfunc AddCoverProfile(profiles []*cover.Profile, p *cover.Profile) []*cover.Profile {\n\ti := sort.Search(len(profiles), func(i int) bool { return profiles[i].FileName >= p.FileName })\n\tif i < len(profiles) && profiles[i].FileName == p.FileName {\n\t\tMergeCoverProfiles(profiles[i], p)\n\t} else {\n\t\tprofiles = append(profiles, nil)\n\t\tcopy(profiles[i+1:], profiles[i:])\n\t\tprofiles[i] = p\n\t}\n\treturn profiles\n}\n\nfunc DumpCoverProfiles(profiles []*cover.Profile, out io.Writer) error {\n\tif len(profiles) == 0 {\n\t\treturn nil\n\t}\n\tif _, err := fmt.Fprintf(out, \"mode: %s\\n\", profiles[0].Mode); err != nil {\n\t\treturn err\n\t}\n\tfor _, p := range profiles {\n\t\tfor _, b := range p.Blocks {\n\t\t\tif _, err := fmt.Fprintf(out, \"%s:%d.%d,%d.%d %d %d\\n\", p.FileName, b.StartLine, b.StartCol, b.EndLine, b.EndCol, b.NumStmt, b.Count); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc MergeCoverProfiles(into *cover.Profile, merge *cover.Profile) error {\n\tif into.Mode != merge.Mode {\n\t\treturn fmt.Errorf(\"cannot merge profiles with different modes\")\n\t}\n\t// Since the blocks are sorted, we can keep track of where the last block\n\t// was inserted and only look at the blocks after that as targets for merge\n\tstartIndex := 0\n\tfor _, b := range merge.Blocks {\n\t\tvar err error\n\t\tstartIndex, err = mergeProfileBlock(into, b, startIndex)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc mergeProfileBlock(p *cover.Profile, pb cover.ProfileBlock, startIndex int) (int, error) {\n\tsortFunc := func(i int) bool {\n\t\tpi := p.Blocks[i+startIndex]\n\t\treturn pi.StartLine >= pb.StartLine && (pi.StartLine != pb.StartLine || pi.StartCol >= pb.StartCol)\n\t}\n\n\ti := 0\n\tif !sortFunc(i) {\n\t\ti = sort.Search(len(p.Blocks)-startIndex, sortFunc)\n\t}\n\n\ti += startIndex\n\tif i < len(p.Blocks) && p.Blocks[i].StartLine == pb.StartLine && p.Blocks[i].StartCol == pb.StartCol {\n\t\tif p.Blocks[i].EndLine != pb.EndLine || p.Blocks[i].EndCol != pb.EndCol {\n\t\t\treturn i, fmt.Errorf(\"gocovmerge: overlapping merge %v %v %v\", p.FileName, p.Blocks[i], pb)\n\t\t}\n\t\tswitch p.Mode {\n\t\tcase \"set\":\n\t\t\tp.Blocks[i].Count |= pb.Count\n\t\tcase \"count\", \"atomic\":\n\t\t\tp.Blocks[i].Count += pb.Count\n\t\tdefault:\n\t\t\treturn i, fmt.Errorf(\"gocovmerge: unsupported covermode '%s'\", p.Mode)\n\t\t}\n\n\t} else {\n\t\tif i > 0 {\n\t\t\tpa := p.Blocks[i-1]\n\t\t\tif pa.EndLine >= pb.EndLine && (pa.EndLine != pb.EndLine || pa.EndCol > pb.EndCol) {\n\t\t\t\treturn i, fmt.Errorf(\"gocovmerge: overlap before %v %v %v\", p.FileName, pa, pb)\n\t\t\t}\n\t\t}\n\t\tif i < len(p.Blocks)-1 {\n\t\t\tpa := p.Blocks[i+1]\n\t\t\tif pa.StartLine <= pb.StartLine && (pa.StartLine != pb.StartLine || pa.StartCol < pb.StartCol) {\n\t\t\t\treturn i, fmt.Errorf(\"gocovmerge: overlap after %v %v %v\", p.FileName, pa, pb)\n\t\t\t}\n\t\t}\n\t\tp.Blocks = append(p.Blocks, cover.ProfileBlock{})\n\t\tcopy(p.Blocks[i+1:], p.Blocks[i:])\n\t\tp.Blocks[i] = pb\n\t}\n\n\treturn i + 1, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/internal/profiles_and_reports.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"strconv\"\n\n\t\"github.com/google/pprof/profile\"\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n\t\"golang.org/x/tools/cover\"\n)\n\nfunc AbsPathForGeneratedAsset(assetName string, suite TestSuite, cliConfig types.CLIConfig, process int) string {\n\tsuffix := \"\"\n\tif process != 0 {\n\t\tsuffix = fmt.Sprintf(\".%d\", process)\n\t}\n\tif cliConfig.OutputDir == \"\" {\n\t\treturn filepath.Join(suite.AbsPath(), assetName+suffix)\n\t}\n\toutputDir, _ := filepath.Abs(cliConfig.OutputDir)\n\treturn filepath.Join(outputDir, suite.NamespacedName()+\"_\"+assetName+suffix)\n}\n\nfunc FinalizeProfilesAndReportsForSuites(suites TestSuites, cliConfig types.CLIConfig, suiteConfig types.SuiteConfig, reporterConfig types.ReporterConfig, goFlagsConfig types.GoFlagsConfig) ([]string, error) {\n\tmessages := []string{}\n\tsuitesWithProfiles := suites.WithState(TestSuiteStatePassed, TestSuiteStateFailed) //anything else won't have actually run and generated a profile\n\n\t// merge cover profiles if need be\n\tif goFlagsConfig.Cover && !cliConfig.KeepSeparateCoverprofiles {\n\t\tcoverProfiles := []string{}\n\t\tfor _, suite := range suitesWithProfiles {\n\t\t\tif !suite.HasProgrammaticFocus {\n\t\t\t\tcoverProfiles = append(coverProfiles, AbsPathForGeneratedAsset(goFlagsConfig.CoverProfile, suite, cliConfig, 0))\n\t\t\t}\n\t\t}\n\n\t\tif len(coverProfiles) > 0 {\n\t\t\tdst := goFlagsConfig.CoverProfile\n\t\t\tif cliConfig.OutputDir != \"\" {\n\t\t\t\tdst = filepath.Join(cliConfig.OutputDir, goFlagsConfig.CoverProfile)\n\t\t\t}\n\t\t\terr := MergeAndCleanupCoverProfiles(coverProfiles, dst)\n\t\t\tif err != nil {\n\t\t\t\treturn messages, err\n\t\t\t}\n\t\t\tcoverage, err := GetCoverageFromCoverProfile(dst)\n\t\t\tif err != nil {\n\t\t\t\treturn messages, err\n\t\t\t}\n\t\t\tif coverage == 0 {\n\t\t\t\tmessages = append(messages, \"composite coverage: [no statements]\")\n\t\t\t} else if suitesWithProfiles.AnyHaveProgrammaticFocus() {\n\t\t\t\tmessages = append(messages, fmt.Sprintf(\"composite coverage: %.1f%% of statements however some suites did not contribute because they included programatically focused specs\", coverage))\n\t\t\t} else {\n\t\t\t\tmessages = append(messages, fmt.Sprintf(\"composite coverage: %.1f%% of statements\", coverage))\n\t\t\t}\n\t\t} else {\n\t\t\tmessages = append(messages, \"no composite coverage computed: all suites included programatically focused specs\")\n\t\t}\n\t}\n\n\t// copy binaries if need be\n\tfor _, suite := range suitesWithProfiles {\n\t\tif goFlagsConfig.BinaryMustBePreserved() && cliConfig.OutputDir != \"\" {\n\t\t\tsrc := suite.PathToCompiledTest\n\t\t\tdst := filepath.Join(cliConfig.OutputDir, suite.NamespacedName()+\".test\")\n\t\t\tif suite.Precompiled {\n\t\t\t\tif err := CopyFile(src, dst); err != nil {\n\t\t\t\t\treturn messages, err\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tif err := os.Rename(src, dst); err != nil {\n\t\t\t\t\treturn messages, err\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\ttype reportFormat struct {\n\t\tReportName string\n\t\tGenerateFunc func(types.Report, string) error\n\t\tMergeFunc func([]string, string) ([]string, error)\n\t}\n\treportFormats := []reportFormat{}\n\tif reporterConfig.JSONReport != \"\" {\n\t\treportFormats = append(reportFormats, reportFormat{ReportName: reporterConfig.JSONReport, GenerateFunc: reporters.GenerateJSONReport, MergeFunc: reporters.MergeAndCleanupJSONReports})\n\t}\n\tif reporterConfig.GoJSONReport != \"\" {\n\t\treportFormats = append(reportFormats, reportFormat{ReportName: reporterConfig.GoJSONReport, GenerateFunc: reporters.GenerateGoTestJSONReport, MergeFunc: reporters.MergeAndCleanupGoTestJSONReports})\n\t}\n\tif reporterConfig.JUnitReport != \"\" {\n\t\treportFormats = append(reportFormats, reportFormat{ReportName: reporterConfig.JUnitReport, GenerateFunc: reporters.GenerateJUnitReport, MergeFunc: reporters.MergeAndCleanupJUnitReports})\n\t}\n\tif reporterConfig.TeamcityReport != \"\" {\n\t\treportFormats = append(reportFormats, reportFormat{ReportName: reporterConfig.TeamcityReport, GenerateFunc: reporters.GenerateTeamcityReport, MergeFunc: reporters.MergeAndCleanupTeamcityReports})\n\t}\n\n\t// Generate reports for suites that failed to run\n\treportableSuites := suites.ThatAreGinkgoSuites()\n\tfor _, suite := range reportableSuites.WithState(TestSuiteStateFailedToCompile, TestSuiteStateFailedDueToTimeout, TestSuiteStateSkippedDueToPriorFailures, TestSuiteStateSkippedDueToEmptyCompilation) {\n\t\treport := types.Report{\n\t\t\tSuitePath: suite.AbsPath(),\n\t\t\tSuiteConfig: suiteConfig,\n\t\t\tSuiteSucceeded: false,\n\t\t}\n\t\tswitch suite.State {\n\t\tcase TestSuiteStateFailedToCompile:\n\t\t\treport.SpecialSuiteFailureReasons = append(report.SpecialSuiteFailureReasons, suite.CompilationError.Error())\n\t\tcase TestSuiteStateFailedDueToTimeout:\n\t\t\treport.SpecialSuiteFailureReasons = append(report.SpecialSuiteFailureReasons, TIMEOUT_ELAPSED_FAILURE_REASON)\n\t\tcase TestSuiteStateSkippedDueToPriorFailures:\n\t\t\treport.SpecialSuiteFailureReasons = append(report.SpecialSuiteFailureReasons, PRIOR_FAILURES_FAILURE_REASON)\n\t\tcase TestSuiteStateSkippedDueToEmptyCompilation:\n\t\t\treport.SpecialSuiteFailureReasons = append(report.SpecialSuiteFailureReasons, EMPTY_SKIP_FAILURE_REASON)\n\t\t\treport.SuiteSucceeded = true\n\t\t}\n\n\t\tfor _, format := range reportFormats {\n\t\t\tformat.GenerateFunc(report, AbsPathForGeneratedAsset(format.ReportName, suite, cliConfig, 0))\n\t\t}\n\t}\n\n\t// Merge reports unless we've been asked to keep them separate\n\tif !cliConfig.KeepSeparateReports {\n\t\tfor _, format := range reportFormats {\n\t\t\treports := []string{}\n\t\t\tfor _, suite := range reportableSuites {\n\t\t\t\treports = append(reports, AbsPathForGeneratedAsset(format.ReportName, suite, cliConfig, 0))\n\t\t\t}\n\t\t\tdst := format.ReportName\n\t\t\tif cliConfig.OutputDir != \"\" {\n\t\t\t\tdst = filepath.Join(cliConfig.OutputDir, format.ReportName)\n\t\t\t}\n\t\t\tmergeMessages, err := format.MergeFunc(reports, dst)\n\t\t\tmessages = append(messages, mergeMessages...)\n\t\t\tif err != nil {\n\t\t\t\treturn messages, err\n\t\t\t}\n\t\t}\n\t}\n\n\treturn messages, nil\n}\n\n// loads each profile, merges them, deletes them, stores them in destination\nfunc MergeAndCleanupCoverProfiles(profiles []string, destination string) error {\n\tvar merged []*cover.Profile\n\tfor _, file := range profiles {\n\t\tparsedProfiles, err := cover.ParseProfiles(file)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tos.Remove(file)\n\t\tfor _, p := range parsedProfiles {\n\t\t\tmerged = AddCoverProfile(merged, p)\n\t\t}\n\t}\n\tdst, err := os.OpenFile(destination, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0666)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer dst.Close()\n\terr = DumpCoverProfiles(merged, dst)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\nfunc GetCoverageFromCoverProfile(profile string) (float64, error) {\n\tcmd := exec.Command(\"go\", \"tool\", \"cover\", \"-func\", profile)\n\toutput, err := cmd.CombinedOutput()\n\tif err != nil {\n\t\treturn 0, fmt.Errorf(\"Could not process Coverprofile %s: %s - %s\", profile, err.Error(), string(output))\n\t}\n\tre := regexp.MustCompile(`total:\\s*\\(statements\\)\\s*(\\d*\\.\\d*)\\%`)\n\tmatches := re.FindStringSubmatch(string(output))\n\tif matches == nil {\n\t\treturn 0, fmt.Errorf(\"Could not parse Coverprofile to compute coverage percentage\")\n\t}\n\tcoverageString := matches[1]\n\tcoverage, err := strconv.ParseFloat(coverageString, 64)\n\tif err != nil {\n\t\treturn 0, fmt.Errorf(\"Could not parse Coverprofile to compute coverage percentage: %s\", err.Error())\n\t}\n\n\treturn coverage, nil\n}\n\nfunc MergeProfiles(profilePaths []string, destination string) error {\n\tprofiles := []*profile.Profile{}\n\tfor _, profilePath := range profilePaths {\n\t\tproFile, err := os.Open(profilePath)\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"Could not open profile: %s\\n%s\", profilePath, err.Error())\n\t\t}\n\t\tprof, err := profile.Parse(proFile)\n\t\t_ = proFile.Close()\n\t\tif err != nil {\n\t\t\treturn fmt.Errorf(\"Could not parse profile: %s\\n%s\", profilePath, err.Error())\n\t\t}\n\t\tprofiles = append(profiles, prof)\n\t\tos.Remove(profilePath)\n\t}\n\n\tmergedProfile, err := profile.Merge(profiles)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"Could not merge profiles:\\n%s\", err.Error())\n\t}\n\n\toutFile, err := os.Create(destination)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"Could not create merged profile %s:\\n%s\", destination, err.Error())\n\t}\n\terr = mergedProfile.Write(outFile)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"Could not write merged profile %s:\\n%s\", destination, err.Error())\n\t}\n\terr = outFile.Close()\n\tif err != nil {\n\t\treturn fmt.Errorf(\"Could not close merged profile %s:\\n%s\", destination, err.Error())\n\t}\n\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/internal/run.go",
"content": "package internal\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"os/exec\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"strings\"\n\t\"sync/atomic\"\n\t\"syscall\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/internal/parallel_support\"\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc RunCompiledSuite(suite TestSuite, ginkgoConfig types.SuiteConfig, reporterConfig types.ReporterConfig, cliConfig types.CLIConfig, goFlagsConfig types.GoFlagsConfig, additionalArgs []string) TestSuite {\n\tsuite.State = TestSuiteStateFailed\n\tsuite.HasProgrammaticFocus = false\n\n\tif suite.PathToCompiledTest == \"\" {\n\t\treturn suite\n\t}\n\n\tif suite.IsGinkgo && cliConfig.ComputedProcs() > 1 {\n\t\tsuite = runParallel(suite, ginkgoConfig, reporterConfig, cliConfig, goFlagsConfig, additionalArgs)\n\t} else if suite.IsGinkgo {\n\t\tsuite = runSerial(suite, ginkgoConfig, reporterConfig, cliConfig, goFlagsConfig, additionalArgs)\n\t} else {\n\t\tsuite = runGoTest(suite, cliConfig, goFlagsConfig)\n\t}\n\trunAfterRunHook(cliConfig.AfterRunHook, reporterConfig.NoColor, suite)\n\treturn suite\n}\n\nfunc buildAndStartCommand(suite TestSuite, args []string, pipeToStdout bool) (*exec.Cmd, *bytes.Buffer) {\n\tbuf := &bytes.Buffer{}\n\tcmd := exec.Command(suite.PathToCompiledTest, args...)\n\tcmd.Dir = suite.Path\n\tif pipeToStdout {\n\t\tcmd.Stderr = io.MultiWriter(os.Stdout, buf)\n\t\tcmd.Stdout = os.Stdout\n\t} else {\n\t\tcmd.Stderr = buf\n\t\tcmd.Stdout = buf\n\t}\n\terr := cmd.Start()\n\tcommand.AbortIfError(\"Failed to start test suite\", err)\n\n\treturn cmd, buf\n}\n\nfunc checkForNoTestsWarning(buf *bytes.Buffer) bool {\n\tif strings.Contains(buf.String(), \"warning: no tests to run\") {\n\t\tfmt.Fprintf(os.Stderr, `Found no test suites, did you forget to run \"ginkgo bootstrap\"?`)\n\t\treturn true\n\t}\n\treturn false\n}\n\nfunc runGoTest(suite TestSuite, cliConfig types.CLIConfig, goFlagsConfig types.GoFlagsConfig) TestSuite {\n\t// As we run the go test from the suite directory, make sure the cover profile is absolute\n\t// and placed into the expected output directory when one is configured.\n\tif goFlagsConfig.Cover && !filepath.IsAbs(goFlagsConfig.CoverProfile) {\n\t\tgoFlagsConfig.CoverProfile = AbsPathForGeneratedAsset(goFlagsConfig.CoverProfile, suite, cliConfig, 0)\n\t}\n\n\targs, err := types.GenerateGoTestRunArgs(goFlagsConfig)\n\tcommand.AbortIfError(\"Failed to generate test run arguments\", err)\n\tcmd, buf := buildAndStartCommand(suite, args, true)\n\n\tcmd.Wait()\n\n\texitStatus := cmd.ProcessState.Sys().(syscall.WaitStatus).ExitStatus()\n\tpassed := (exitStatus == 0) || (exitStatus == types.GINKGO_FOCUS_EXIT_CODE)\n\tpassed = !(checkForNoTestsWarning(buf) && cliConfig.RequireSuite) && passed\n\tif passed {\n\t\tsuite.State = TestSuiteStatePassed\n\t} else {\n\t\tsuite.State = TestSuiteStateFailed\n\t}\n\n\treturn suite\n}\n\nfunc runSerial(suite TestSuite, ginkgoConfig types.SuiteConfig, reporterConfig types.ReporterConfig, cliConfig types.CLIConfig, goFlagsConfig types.GoFlagsConfig, additionalArgs []string) TestSuite {\n\tif goFlagsConfig.Cover {\n\t\tgoFlagsConfig.CoverProfile = AbsPathForGeneratedAsset(goFlagsConfig.CoverProfile, suite, cliConfig, 0)\n\t}\n\tif goFlagsConfig.BlockProfile != \"\" {\n\t\tgoFlagsConfig.BlockProfile = AbsPathForGeneratedAsset(goFlagsConfig.BlockProfile, suite, cliConfig, 0)\n\t}\n\tif goFlagsConfig.CPUProfile != \"\" {\n\t\tgoFlagsConfig.CPUProfile = AbsPathForGeneratedAsset(goFlagsConfig.CPUProfile, suite, cliConfig, 0)\n\t}\n\tif goFlagsConfig.MemProfile != \"\" {\n\t\tgoFlagsConfig.MemProfile = AbsPathForGeneratedAsset(goFlagsConfig.MemProfile, suite, cliConfig, 0)\n\t}\n\tif goFlagsConfig.MutexProfile != \"\" {\n\t\tgoFlagsConfig.MutexProfile = AbsPathForGeneratedAsset(goFlagsConfig.MutexProfile, suite, cliConfig, 0)\n\t}\n\tif reporterConfig.JSONReport != \"\" {\n\t\treporterConfig.JSONReport = AbsPathForGeneratedAsset(reporterConfig.JSONReport, suite, cliConfig, 0)\n\t}\n\tif reporterConfig.GoJSONReport != \"\" {\n\t\treporterConfig.GoJSONReport = AbsPathForGeneratedAsset(reporterConfig.GoJSONReport, suite, cliConfig, 0)\n\t}\n\tif reporterConfig.JUnitReport != \"\" {\n\t\treporterConfig.JUnitReport = AbsPathForGeneratedAsset(reporterConfig.JUnitReport, suite, cliConfig, 0)\n\t}\n\tif reporterConfig.TeamcityReport != \"\" {\n\t\treporterConfig.TeamcityReport = AbsPathForGeneratedAsset(reporterConfig.TeamcityReport, suite, cliConfig, 0)\n\t}\n\n\targs, err := types.GenerateGinkgoTestRunArgs(ginkgoConfig, reporterConfig, goFlagsConfig)\n\tcommand.AbortIfError(\"Failed to generate test run arguments\", err)\n\targs = append([]string{\"--test.timeout=0\"}, args...)\n\targs = append(args, additionalArgs...)\n\n\tcmd, buf := buildAndStartCommand(suite, args, true)\n\n\tcmd.Wait()\n\n\texitStatus := cmd.ProcessState.Sys().(syscall.WaitStatus).ExitStatus()\n\tsuite.HasProgrammaticFocus = (exitStatus == types.GINKGO_FOCUS_EXIT_CODE)\n\tpassed := (exitStatus == 0) || (exitStatus == types.GINKGO_FOCUS_EXIT_CODE)\n\tpassed = !(checkForNoTestsWarning(buf) && cliConfig.RequireSuite) && passed\n\tif passed {\n\t\tsuite.State = TestSuiteStatePassed\n\t} else {\n\t\tsuite.State = TestSuiteStateFailed\n\t}\n\n\tif suite.HasProgrammaticFocus {\n\t\tif goFlagsConfig.Cover {\n\t\t\tfmt.Fprintln(os.Stdout, \"coverage: no coverfile was generated because specs are programmatically focused\")\n\t\t}\n\t\tif goFlagsConfig.BlockProfile != \"\" {\n\t\t\tfmt.Fprintln(os.Stdout, \"no block profile was generated because specs are programmatically focused\")\n\t\t}\n\t\tif goFlagsConfig.CPUProfile != \"\" {\n\t\t\tfmt.Fprintln(os.Stdout, \"no cpu profile was generated because specs are programmatically focused\")\n\t\t}\n\t\tif goFlagsConfig.MemProfile != \"\" {\n\t\t\tfmt.Fprintln(os.Stdout, \"no mem profile was generated because specs are programmatically focused\")\n\t\t}\n\t\tif goFlagsConfig.MutexProfile != \"\" {\n\t\t\tfmt.Fprintln(os.Stdout, \"no mutex profile was generated because specs are programmatically focused\")\n\t\t}\n\t}\n\n\treturn suite\n}\n\nfunc runParallel(suite TestSuite, ginkgoConfig types.SuiteConfig, reporterConfig types.ReporterConfig, cliConfig types.CLIConfig, goFlagsConfig types.GoFlagsConfig, additionalArgs []string) TestSuite {\n\ttype procResult struct {\n\t\tproc int\n\t\texitResult string\n\t\tpassed bool\n\t\thasProgrammaticFocus bool\n\t}\n\n\tnumProcs := cliConfig.ComputedProcs()\n\tprocOutput := make([]*bytes.Buffer, numProcs)\n\tprocExitResult := make([]string, numProcs)\n\tcoverProfiles := []string{}\n\n\tblockProfiles := []string{}\n\tcpuProfiles := []string{}\n\tmemProfiles := []string{}\n\tmutexProfiles := []string{}\n\n\tprocResults := make(chan procResult)\n\n\tserver, err := parallel_support.NewServer(numProcs, reporters.NewDefaultReporter(reporterConfig, formatter.ColorableStdOut))\n\tcommand.AbortIfError(\"Failed to start parallel spec server\", err)\n\tserver.Start()\n\tdefer server.Close()\n\n\tif reporterConfig.JSONReport != \"\" {\n\t\treporterConfig.JSONReport = AbsPathForGeneratedAsset(reporterConfig.JSONReport, suite, cliConfig, 0)\n\t}\n\tif reporterConfig.GoJSONReport != \"\" {\n\t\treporterConfig.GoJSONReport = AbsPathForGeneratedAsset(reporterConfig.GoJSONReport, suite, cliConfig, 0)\n\t}\n\tif reporterConfig.JUnitReport != \"\" {\n\t\treporterConfig.JUnitReport = AbsPathForGeneratedAsset(reporterConfig.JUnitReport, suite, cliConfig, 0)\n\t}\n\tif reporterConfig.TeamcityReport != \"\" {\n\t\treporterConfig.TeamcityReport = AbsPathForGeneratedAsset(reporterConfig.TeamcityReport, suite, cliConfig, 0)\n\t}\n\n\tfor proc := 1; proc <= numProcs; proc++ {\n\t\tprocGinkgoConfig := ginkgoConfig\n\t\tprocGinkgoConfig.ParallelProcess, procGinkgoConfig.ParallelTotal, procGinkgoConfig.ParallelHost = proc, numProcs, server.Address()\n\n\t\tprocGoFlagsConfig := goFlagsConfig\n\t\tif goFlagsConfig.Cover {\n\t\t\tprocGoFlagsConfig.CoverProfile = AbsPathForGeneratedAsset(goFlagsConfig.CoverProfile, suite, cliConfig, proc)\n\t\t\tcoverProfiles = append(coverProfiles, procGoFlagsConfig.CoverProfile)\n\t\t}\n\t\tif goFlagsConfig.BlockProfile != \"\" {\n\t\t\tprocGoFlagsConfig.BlockProfile = AbsPathForGeneratedAsset(goFlagsConfig.BlockProfile, suite, cliConfig, proc)\n\t\t\tblockProfiles = append(blockProfiles, procGoFlagsConfig.BlockProfile)\n\t\t}\n\t\tif goFlagsConfig.CPUProfile != \"\" {\n\t\t\tprocGoFlagsConfig.CPUProfile = AbsPathForGeneratedAsset(goFlagsConfig.CPUProfile, suite, cliConfig, proc)\n\t\t\tcpuProfiles = append(cpuProfiles, procGoFlagsConfig.CPUProfile)\n\t\t}\n\t\tif goFlagsConfig.MemProfile != \"\" {\n\t\t\tprocGoFlagsConfig.MemProfile = AbsPathForGeneratedAsset(goFlagsConfig.MemProfile, suite, cliConfig, proc)\n\t\t\tmemProfiles = append(memProfiles, procGoFlagsConfig.MemProfile)\n\t\t}\n\t\tif goFlagsConfig.MutexProfile != \"\" {\n\t\t\tprocGoFlagsConfig.MutexProfile = AbsPathForGeneratedAsset(goFlagsConfig.MutexProfile, suite, cliConfig, proc)\n\t\t\tmutexProfiles = append(mutexProfiles, procGoFlagsConfig.MutexProfile)\n\t\t}\n\n\t\targs, err := types.GenerateGinkgoTestRunArgs(procGinkgoConfig, reporterConfig, procGoFlagsConfig)\n\t\tcommand.AbortIfError(\"Failed to generate test run arguments\", err)\n\t\targs = append([]string{\"--test.timeout=0\"}, args...)\n\t\targs = append(args, additionalArgs...)\n\n\t\tcmd, buf := buildAndStartCommand(suite, args, false)\n\t\tvar exited atomic.Bool\n\t\tprocOutput[proc-1] = buf\n\t\tserver.RegisterAlive(proc, func() bool { return !exited.Load() })\n\n\t\tgo func() {\n\t\t\tcmd.Wait()\n\t\t\texitStatus := cmd.ProcessState.Sys().(syscall.WaitStatus).ExitStatus()\n\t\t\tprocResults <- procResult{\n\t\t\t\tproc: proc,\n\t\t\t\texitResult: cmd.ProcessState.String(),\n\t\t\t\tpassed: (exitStatus == 0) || (exitStatus == types.GINKGO_FOCUS_EXIT_CODE),\n\t\t\t\thasProgrammaticFocus: exitStatus == types.GINKGO_FOCUS_EXIT_CODE,\n\t\t\t}\n\t\t\texited.Store(true)\n\t\t}()\n\t}\n\n\tpassed := true\n\tfor proc := 1; proc <= cliConfig.ComputedProcs(); proc++ {\n\t\tresult := <-procResults\n\t\tpassed = passed && result.passed\n\t\tsuite.HasProgrammaticFocus = suite.HasProgrammaticFocus || result.hasProgrammaticFocus\n\t\tprocExitResult[result.proc-1] = result.exitResult\n\t}\n\tif passed {\n\t\tsuite.State = TestSuiteStatePassed\n\t} else {\n\t\tsuite.State = TestSuiteStateFailed\n\t}\n\n\tselect {\n\tcase <-server.GetSuiteDone():\n\t\tfmt.Println(\"\")\n\tcase <-time.After(time.Second):\n\t\t//one of the nodes never finished reporting to the server. Something must have gone wrong.\n\t\tfmt.Fprint(formatter.ColorableStdErr, formatter.F(\"\\n{{bold}}{{red}}Ginkgo timed out waiting for all parallel procs to report back{{/}}\\n\"))\n\t\tfmt.Fprint(formatter.ColorableStdErr, formatter.F(\"{{gray}}Test suite:{{/}} %s (%s)\\n\\n\", suite.PackageName, suite.Path))\n\t\tfmt.Fprint(formatter.ColorableStdErr, formatter.Fiw(0, formatter.COLS, \"This occurs if a parallel process exits before it reports its results to the Ginkgo CLI. The CLI will now print out all the stdout/stderr output it's collected from the running processes. However you may not see anything useful in these logs because the individual test processes usually intercept output to stdout/stderr in order to capture it in the spec reports.\\n\\nYou may want to try rerunning your test suite with {{light-gray}}--output-interceptor-mode=none{{/}} to see additional output here and debug your suite.\\n\"))\n\t\tfmt.Fprintln(formatter.ColorableStdErr, \" \")\n\t\tfor proc := 1; proc <= cliConfig.ComputedProcs(); proc++ {\n\t\t\tfmt.Fprint(formatter.ColorableStdErr, formatter.F(\"{{bold}}Output from proc %d:{{/}}\\n\", proc))\n\t\t\tfmt.Fprintln(os.Stderr, formatter.Fi(1, \"%s\", procOutput[proc-1].String()))\n\t\t\tfmt.Fprint(formatter.ColorableStdErr, formatter.F(\"{{bold}}Exit result of proc %d:{{/}}\\n\", proc))\n\t\t\tfmt.Fprintln(os.Stderr, formatter.Fi(1, \"%s\\n\", procExitResult[proc-1]))\n\t\t}\n\t\tfmt.Fprintf(os.Stderr, \"** End **\")\n\t}\n\n\tfor proc := 1; proc <= cliConfig.ComputedProcs(); proc++ {\n\t\toutput := procOutput[proc-1].String()\n\t\tif proc == 1 && checkForNoTestsWarning(procOutput[0]) && cliConfig.RequireSuite {\n\t\t\tsuite.State = TestSuiteStateFailed\n\t\t}\n\t\tif strings.Contains(output, \"deprecated Ginkgo functionality\") {\n\t\t\tfmt.Fprintln(os.Stderr, output)\n\t\t}\n\t}\n\n\tif len(coverProfiles) > 0 {\n\t\tif suite.HasProgrammaticFocus {\n\t\t\tfmt.Fprintln(os.Stdout, \"coverage: no coverfile was generated because specs are programmatically focused\")\n\t\t} else {\n\t\t\tcoverProfile := AbsPathForGeneratedAsset(goFlagsConfig.CoverProfile, suite, cliConfig, 0)\n\t\t\terr := MergeAndCleanupCoverProfiles(coverProfiles, coverProfile)\n\t\t\tcommand.AbortIfError(\"Failed to combine cover profiles\", err)\n\n\t\t\tcoverage, err := GetCoverageFromCoverProfile(coverProfile)\n\t\t\tcommand.AbortIfError(\"Failed to compute coverage\", err)\n\t\t\tif coverage == 0 {\n\t\t\t\tfmt.Fprintln(os.Stdout, \"coverage: [no statements]\")\n\t\t\t} else {\n\t\t\t\tfmt.Fprintf(os.Stdout, \"coverage: %.1f%% of statements\\n\", coverage)\n\t\t\t}\n\t\t}\n\t}\n\tif len(blockProfiles) > 0 {\n\t\tif suite.HasProgrammaticFocus {\n\t\t\tfmt.Fprintln(os.Stdout, \"no block profile was generated because specs are programmatically focused\")\n\t\t} else {\n\t\t\tblockProfile := AbsPathForGeneratedAsset(goFlagsConfig.BlockProfile, suite, cliConfig, 0)\n\t\t\terr := MergeProfiles(blockProfiles, blockProfile)\n\t\t\tcommand.AbortIfError(\"Failed to combine blockprofiles\", err)\n\t\t}\n\t}\n\tif len(cpuProfiles) > 0 {\n\t\tif suite.HasProgrammaticFocus {\n\t\t\tfmt.Fprintln(os.Stdout, \"no cpu profile was generated because specs are programmatically focused\")\n\t\t} else {\n\t\t\tcpuProfile := AbsPathForGeneratedAsset(goFlagsConfig.CPUProfile, suite, cliConfig, 0)\n\t\t\terr := MergeProfiles(cpuProfiles, cpuProfile)\n\t\t\tcommand.AbortIfError(\"Failed to combine cpuprofiles\", err)\n\t\t}\n\t}\n\tif len(memProfiles) > 0 {\n\t\tif suite.HasProgrammaticFocus {\n\t\t\tfmt.Fprintln(os.Stdout, \"no mem profile was generated because specs are programmatically focused\")\n\t\t} else {\n\t\t\tmemProfile := AbsPathForGeneratedAsset(goFlagsConfig.MemProfile, suite, cliConfig, 0)\n\t\t\terr := MergeProfiles(memProfiles, memProfile)\n\t\t\tcommand.AbortIfError(\"Failed to combine memprofiles\", err)\n\t\t}\n\t}\n\tif len(mutexProfiles) > 0 {\n\t\tif suite.HasProgrammaticFocus {\n\t\t\tfmt.Fprintln(os.Stdout, \"no mutex profile was generated because specs are programmatically focused\")\n\t\t} else {\n\t\t\tmutexProfile := AbsPathForGeneratedAsset(goFlagsConfig.MutexProfile, suite, cliConfig, 0)\n\t\t\terr := MergeProfiles(mutexProfiles, mutexProfile)\n\t\t\tcommand.AbortIfError(\"Failed to combine mutexprofiles\", err)\n\t\t}\n\t}\n\n\treturn suite\n}\n\nfunc runAfterRunHook(command string, noColor bool, suite TestSuite) {\n\tif command == \"\" {\n\t\treturn\n\t}\n\tf := formatter.NewWithNoColorBool(noColor)\n\n\t// Allow for string replacement to pass input to the command\n\tpassed := \"[FAIL]\"\n\tif suite.State.Is(TestSuiteStatePassed) {\n\t\tpassed = \"[PASS]\"\n\t}\n\tcommand = strings.ReplaceAll(command, \"(ginkgo-suite-passed)\", passed)\n\tcommand = strings.ReplaceAll(command, \"(ginkgo-suite-name)\", suite.PackageName)\n\n\t// Must break command into parts\n\tsplitArgs := regexp.MustCompile(`'.+'|\".+\"|\\S+`)\n\tparts := splitArgs.FindAllString(command, -1)\n\n\toutput, err := exec.Command(parts[0], parts[1:]...).CombinedOutput()\n\tif err != nil {\n\t\tfmt.Fprintln(formatter.ColorableStdOut, f.Fi(0, \"{{red}}{{bold}}After-run-hook failed:{{/}}\"))\n\t\tfmt.Fprintln(formatter.ColorableStdOut, f.Fi(1, \"{{red}}%s{{/}}\", output))\n\t} else {\n\t\tfmt.Fprintln(formatter.ColorableStdOut, f.Fi(0, \"{{green}}{{bold}}After-run-hook succeeded:{{/}}\"))\n\t\tfmt.Fprintln(formatter.ColorableStdOut, f.Fi(1, \"{{green}}%s{{/}}\", output))\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/internal/test_suite.go",
"content": "package internal\n\nimport (\n\t\"errors\"\n\t\"math/rand\"\n\t\"os\"\n\t\"path\"\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"runtime\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nconst TIMEOUT_ELAPSED_FAILURE_REASON = \"Suite did not run because the timeout elapsed\"\nconst PRIOR_FAILURES_FAILURE_REASON = \"Suite did not run because prior suites failed and --keep-going is not set\"\nconst EMPTY_SKIP_FAILURE_REASON = \"Suite did not run go test reported that no test files were found\"\n\ntype TestSuiteState uint\n\nconst (\n\tTestSuiteStateInvalid TestSuiteState = iota\n\n\tTestSuiteStateUncompiled\n\tTestSuiteStateCompiled\n\n\tTestSuiteStatePassed\n\n\tTestSuiteStateSkippedDueToEmptyCompilation\n\tTestSuiteStateSkippedByFilter\n\tTestSuiteStateSkippedDueToPriorFailures\n\n\tTestSuiteStateFailed\n\tTestSuiteStateFailedDueToTimeout\n\tTestSuiteStateFailedToCompile\n)\n\nvar TestSuiteStateFailureStates = []TestSuiteState{TestSuiteStateFailed, TestSuiteStateFailedDueToTimeout, TestSuiteStateFailedToCompile}\n\nfunc (state TestSuiteState) Is(states ...TestSuiteState) bool {\n\tfor _, suiteState := range states {\n\t\tif suiteState == state {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n\ntype TestSuite struct {\n\tPath string\n\tPackageName string\n\tIsGinkgo bool\n\n\tPrecompiled bool\n\tPathToCompiledTest string\n\tCompilationError error\n\n\tHasProgrammaticFocus bool\n\tState TestSuiteState\n}\n\nfunc (ts TestSuite) AbsPath() string {\n\tpath, _ := filepath.Abs(ts.Path)\n\treturn path\n}\n\nfunc (ts TestSuite) NamespacedName() string {\n\tname := relPath(ts.Path)\n\tname = strings.TrimLeft(name, \".\"+string(filepath.Separator))\n\tname = strings.ReplaceAll(name, string(filepath.Separator), \"_\")\n\tname = strings.ReplaceAll(name, \" \", \"_\")\n\tif name == \"\" {\n\t\treturn ts.PackageName\n\t}\n\treturn name\n}\n\ntype TestSuites []TestSuite\n\nfunc (ts TestSuites) AnyHaveProgrammaticFocus() bool {\n\tfor _, suite := range ts {\n\t\tif suite.HasProgrammaticFocus {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n\nfunc (ts TestSuites) ThatAreGinkgoSuites() TestSuites {\n\tout := TestSuites{}\n\tfor _, suite := range ts {\n\t\tif suite.IsGinkgo {\n\t\t\tout = append(out, suite)\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (ts TestSuites) CountWithState(states ...TestSuiteState) int {\n\tn := 0\n\tfor _, suite := range ts {\n\t\tif suite.State.Is(states...) {\n\t\t\tn += 1\n\t\t}\n\t}\n\n\treturn n\n}\n\nfunc (ts TestSuites) WithState(states ...TestSuiteState) TestSuites {\n\tout := TestSuites{}\n\tfor _, suite := range ts {\n\t\tif suite.State.Is(states...) {\n\t\t\tout = append(out, suite)\n\t\t}\n\t}\n\n\treturn out\n}\n\nfunc (ts TestSuites) WithoutState(states ...TestSuiteState) TestSuites {\n\tout := TestSuites{}\n\tfor _, suite := range ts {\n\t\tif !suite.State.Is(states...) {\n\t\t\tout = append(out, suite)\n\t\t}\n\t}\n\n\treturn out\n}\n\nfunc (ts TestSuites) ShuffledCopy(seed int64) TestSuites {\n\tout := make(TestSuites, len(ts))\n\tpermutation := rand.New(rand.NewSource(seed)).Perm(len(ts))\n\tfor i, j := range permutation {\n\t\tout[i] = ts[j]\n\t}\n\treturn out\n}\n\nfunc FindSuites(args []string, cliConfig types.CLIConfig, allowPrecompiled bool) TestSuites {\n\tsuites := TestSuites{}\n\n\tif len(args) > 0 {\n\t\tfor _, arg := range args {\n\t\t\tif allowPrecompiled {\n\t\t\t\tsuite, err := precompiledTestSuite(arg)\n\t\t\t\tif err == nil {\n\t\t\t\t\tsuites = append(suites, suite)\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t}\n\t\t\trecurseForSuite := cliConfig.Recurse\n\t\t\tif strings.HasSuffix(arg, \"/...\") && arg != \"/...\" {\n\t\t\t\targ = arg[:len(arg)-4]\n\t\t\t\trecurseForSuite = true\n\t\t\t}\n\t\t\tsuites = append(suites, suitesInDir(arg, recurseForSuite)...)\n\t\t}\n\t} else {\n\t\tsuites = suitesInDir(\".\", cliConfig.Recurse)\n\t}\n\n\tif cliConfig.SkipPackage != \"\" {\n\t\tskipFilters := strings.Split(cliConfig.SkipPackage, \",\")\n\t\tfor idx := range suites {\n\t\t\tfor _, skipFilter := range skipFilters {\n\t\t\t\tif strings.Contains(suites[idx].Path, skipFilter) {\n\t\t\t\t\tsuites[idx].State = TestSuiteStateSkippedByFilter\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn suites\n}\n\nfunc precompiledTestSuite(path string) (TestSuite, error) {\n\tinfo, err := os.Stat(path)\n\tif err != nil {\n\t\treturn TestSuite{}, err\n\t}\n\n\tif info.IsDir() {\n\t\treturn TestSuite{}, errors.New(\"this is a directory, not a file\")\n\t}\n\n\tif filepath.Ext(path) != \".test\" && filepath.Ext(path) != \".exe\" {\n\t\treturn TestSuite{}, errors.New(\"this is not a .test binary\")\n\t}\n\n\tif filepath.Ext(path) == \".test\" && runtime.GOOS != \"windows\" && info.Mode()&0111 == 0 {\n\t\treturn TestSuite{}, errors.New(\"this is not executable\")\n\t}\n\n\tdir := relPath(filepath.Dir(path))\n\tpackageName := strings.TrimSuffix(filepath.Base(path), \".exe\")\n\tpackageName = strings.TrimSuffix(packageName, \".test\")\n\n\tpath, err = filepath.Abs(path)\n\tif err != nil {\n\t\treturn TestSuite{}, err\n\t}\n\n\treturn TestSuite{\n\t\tPath: dir,\n\t\tPackageName: packageName,\n\t\tIsGinkgo: true,\n\t\tPrecompiled: true,\n\t\tPathToCompiledTest: path,\n\t\tState: TestSuiteStateCompiled,\n\t}, nil\n}\n\nfunc suitesInDir(dir string, recurse bool) TestSuites {\n\tsuites := TestSuites{}\n\n\tif path.Base(dir) == \"vendor\" {\n\t\treturn suites\n\t}\n\n\tfiles, _ := os.ReadDir(dir)\n\tre := regexp.MustCompile(`^[^._].*_test\\.go$`)\n\tfor _, file := range files {\n\t\tif !file.IsDir() && re.MatchString(file.Name()) {\n\t\t\tsuite := TestSuite{\n\t\t\t\tPath: relPath(dir),\n\t\t\t\tPackageName: packageNameForSuite(dir),\n\t\t\t\tIsGinkgo: filesHaveGinkgoSuite(dir, files),\n\t\t\t\tState: TestSuiteStateUncompiled,\n\t\t\t}\n\t\t\tsuites = append(suites, suite)\n\t\t\tbreak\n\t\t}\n\t}\n\n\tif recurse {\n\t\tre = regexp.MustCompile(`^[._]`)\n\t\tfor _, file := range files {\n\t\t\tif file.IsDir() && !re.MatchString(file.Name()) {\n\t\t\t\tsuites = append(suites, suitesInDir(dir+\"/\"+file.Name(), recurse)...)\n\t\t\t}\n\t\t}\n\t}\n\n\treturn suites\n}\n\nfunc relPath(dir string) string {\n\tdir, _ = filepath.Abs(dir)\n\tcwd, _ := os.Getwd()\n\tdir, _ = filepath.Rel(cwd, filepath.Clean(dir))\n\n\tif string(dir[0]) != \".\" {\n\t\tdir = \".\" + string(filepath.Separator) + dir\n\t}\n\n\treturn dir\n}\n\nfunc packageNameForSuite(dir string) string {\n\tpath, _ := filepath.Abs(dir)\n\treturn filepath.Base(path)\n}\n\nfunc filesHaveGinkgoSuite(dir string, files []os.DirEntry) bool {\n\treTestFile := regexp.MustCompile(`_test\\.go$`)\n\treGinkgo := regexp.MustCompile(`package ginkgo|\\/ginkgo\"|\\/ginkgo\\/v2\"|\\/ginkgo\\/v2/dsl/`)\n\n\tfor _, file := range files {\n\t\tif !file.IsDir() && reTestFile.MatchString(file.Name()) {\n\t\t\tcontents, _ := os.ReadFile(dir + \"/\" + file.Name())\n\t\t\tif reGinkgo.Match(contents) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t}\n\n\treturn false\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/internal/utils.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"os/exec\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n)\n\nfunc FileExists(path string) bool {\n\t_, err := os.Stat(path)\n\treturn err == nil\n}\n\nfunc CopyFile(src string, dest string) error {\n\tsrcFile, err := os.Open(src)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tsrcStat, err := srcFile.Stat()\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tif _, err := os.Stat(dest); err == nil {\n\t\tos.Remove(dest)\n\t}\n\n\tdestFile, err := os.OpenFile(dest, os.O_WRONLY|os.O_CREATE, srcStat.Mode())\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t_, err = io.Copy(destFile, srcFile)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tif err := srcFile.Close(); err != nil {\n\t\treturn err\n\t}\n\treturn destFile.Close()\n}\n\nfunc GoFmt(path string) {\n\tout, err := exec.Command(\"go\", \"fmt\", path).CombinedOutput()\n\tif err != nil {\n\t\tcommand.AbortIfError(fmt.Sprintf(\"Could not fmt:\\n%s\\n\", string(out)), err)\n\t}\n}\n\nfunc PluralizedWord(singular, plural string, count int) string {\n\tif count == 1 {\n\t\treturn singular\n\t}\n\treturn plural\n}\n\nfunc FailedSuitesReport(suites TestSuites, f formatter.Formatter) string {\n\tout := \"\"\n\tout += \"There were failures detected in the following suites:\\n\"\n\n\tmaxPackageNameLength := 0\n\tfor _, suite := range suites.WithState(TestSuiteStateFailureStates...) {\n\t\tif len(suite.PackageName) > maxPackageNameLength {\n\t\t\tmaxPackageNameLength = len(suite.PackageName)\n\t\t}\n\t}\n\n\tpackageNameFormatter := fmt.Sprintf(\"%%%ds\", maxPackageNameLength)\n\tfor _, suite := range suites {\n\t\tswitch suite.State {\n\t\tcase TestSuiteStateFailed:\n\t\t\tout += f.Fi(1, \"{{red}}\"+packageNameFormatter+\" {{gray}}%s{{/}}\\n\", suite.PackageName, suite.Path)\n\t\tcase TestSuiteStateFailedToCompile:\n\t\t\tout += f.Fi(1, \"{{red}}\"+packageNameFormatter+\" {{gray}}%s {{magenta}}[Compilation failure]{{/}}\\n\", suite.PackageName, suite.Path)\n\t\tcase TestSuiteStateFailedDueToTimeout:\n\t\t\tout += f.Fi(1, \"{{red}}\"+packageNameFormatter+\" {{gray}}%s {{orange}}[%s]{{/}}\\n\", suite.PackageName, suite.Path, TIMEOUT_ELAPSED_FAILURE_REASON)\n\t\t}\n\t}\n\treturn out\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/internal/verify_version.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\t\"os/exec\"\n\t\"regexp\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nvar versiorRe = regexp.MustCompile(`v(\\d+\\.\\d+\\.\\d+)`)\n\nfunc VerifyCLIAndFrameworkVersion(suites TestSuites) {\n\tcliVersion := types.VERSION\n\tmismatches := map[string][]string{}\n\n\tfor _, suite := range suites {\n\t\tcmd := exec.Command(\"go\", \"list\", \"-m\", \"github.com/onsi/ginkgo/v2\")\n\t\tcmd.Dir = suite.Path\n\t\toutput, err := cmd.CombinedOutput()\n\t\tif err != nil {\n\t\t\tcontinue\n\t\t}\n\t\tcomponents := strings.Split(string(output), \" \")\n\t\tif len(components) != 2 {\n\t\t\tcontinue\n\t\t}\n\t\tmatches := versiorRe.FindStringSubmatch(components[1])\n\t\tif matches == nil || len(matches) != 2 {\n\t\t\tcontinue\n\t\t}\n\t\tlibraryVersion := matches[1]\n\t\tif cliVersion != libraryVersion {\n\t\t\tmismatches[libraryVersion] = append(mismatches[libraryVersion], suite.PackageName)\n\t\t}\n\t}\n\n\tif len(mismatches) == 0 {\n\t\treturn\n\t}\n\n\tfmt.Println(formatter.F(\"{{red}}{{bold}}Ginkgo detected a version mismatch between the Ginkgo CLI and the version of Ginkgo imported by your packages:{{/}}\"))\n\n\tfmt.Println(formatter.Fi(1, \"Ginkgo CLI Version:\"))\n\tfmt.Println(formatter.Fi(2, \"{{bold}}%s{{/}}\", cliVersion))\n\tfmt.Println(formatter.Fi(1, \"Mismatched package versions found:\"))\n\tfor version, packages := range mismatches {\n\t\tfmt.Println(formatter.Fi(2, \"{{bold}}%s{{/}} used by %s\", version, strings.Join(packages, \", \")))\n\t}\n\tfmt.Println(\"\")\n\tfmt.Println(formatter.Fiw(1, formatter.COLS, \"{{gray}}Ginkgo will continue to attempt to run but you may see errors (including flag parsing errors) and should either update your go.mod or your version of the Ginkgo CLI to match.\\n\\nTo install the matching version of the CLI run\\n {{bold}}go install github.com/onsi/ginkgo/v2/ginkgo{{/}}{{gray}}\\nfrom a path that contains a go.mod file. Alternatively you can use\\n {{bold}}go run github.com/onsi/ginkgo/v2/ginkgo{{/}}{{gray}}\\nfrom a path that contains a go.mod file to invoke the matching version of the Ginkgo CLI.\\n\\nIf you are attempting to test multiple packages that each have a different version of the Ginkgo library with a single Ginkgo CLI that is currently unsupported.\\n{{/}}\"))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/labels/labels_command.go",
"content": "package labels\n\nimport (\n\t\"fmt\"\n\t\"go/ast\"\n\t\"go/parser\"\n\t\"go/token\"\n\t\"sort\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/internal\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n\t\"golang.org/x/tools/go/ast/inspector\"\n)\n\nfunc BuildLabelsCommand() command.Command {\n\tvar cliConfig = types.NewDefaultCLIConfig()\n\n\tflags, err := types.BuildLabelsCommandFlagSet(&cliConfig)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\treturn command.Command{\n\t\tName: \"labels\",\n\t\tUsage: \"ginkgo labels \",\n\t\tFlags: flags,\n\t\tShortDoc: \"List labels detected in the passed-in packages (or the package in the current directory if left blank).\",\n\t\tDocLink: \"spec-labels\",\n\t\tCommand: func(args []string, _ []string) {\n\t\t\tListLabels(args, cliConfig)\n\t\t},\n\t}\n}\n\nfunc ListLabels(args []string, cliConfig types.CLIConfig) {\n\tsuites := internal.FindSuites(args, cliConfig, false).WithoutState(internal.TestSuiteStateSkippedByFilter)\n\tif len(suites) == 0 {\n\t\tcommand.AbortWith(\"Found no test suites\")\n\t}\n\tfor _, suite := range suites {\n\t\tlabels := fetchLabelsFromPackage(suite.Path)\n\t\tif len(labels) == 0 {\n\t\t\tfmt.Printf(\"%s: No labels found\\n\", suite.PackageName)\n\t\t} else {\n\t\t\tfmt.Printf(\"%s: [%s]\\n\", suite.PackageName, strings.Join(labels, \", \"))\n\t\t}\n\t}\n}\n\nfunc fetchLabelsFromPackage(packagePath string) []string {\n\tfset := token.NewFileSet()\n\tparsedPackages, err := parser.ParseDir(fset, packagePath, nil, 0)\n\tcommand.AbortIfError(\"Failed to parse package source:\", err)\n\n\tfiles := []*ast.File{}\n\thasTestPackage := false\n\tfor key, pkg := range parsedPackages {\n\t\tif strings.HasSuffix(key, \"_test\") {\n\t\t\thasTestPackage = true\n\t\t\tfor _, file := range pkg.Files {\n\t\t\t\tfiles = append(files, file)\n\t\t\t}\n\t\t}\n\t}\n\tif !hasTestPackage {\n\t\tfor _, pkg := range parsedPackages {\n\t\t\tfor _, file := range pkg.Files {\n\t\t\t\tfiles = append(files, file)\n\t\t\t}\n\t\t}\n\t}\n\n\tseen := map[string]bool{}\n\tlabels := []string{}\n\tispr := inspector.New(files)\n\tispr.Preorder([]ast.Node{&ast.CallExpr{}}, func(n ast.Node) {\n\t\tpotentialLabels := fetchLabels(n.(*ast.CallExpr))\n\t\tfor _, label := range potentialLabels {\n\t\t\tif !seen[label] {\n\t\t\t\tseen[label] = true\n\t\t\t\tlabels = append(labels, strconv.Quote(label))\n\t\t\t}\n\t\t}\n\t})\n\n\tsort.Strings(labels)\n\treturn labels\n}\n\nfunc fetchLabels(callExpr *ast.CallExpr) []string {\n\tout := []string{}\n\tswitch expr := callExpr.Fun.(type) {\n\tcase *ast.Ident:\n\t\tif expr.Name != \"Label\" {\n\t\t\treturn out\n\t\t}\n\tcase *ast.SelectorExpr:\n\t\tif expr.Sel.Name != \"Label\" {\n\t\t\treturn out\n\t\t}\n\tdefault:\n\t\treturn out\n\t}\n\tfor _, arg := range callExpr.Args {\n\t\tswitch expr := arg.(type) {\n\t\tcase *ast.BasicLit:\n\t\t\tif expr.Kind == token.STRING {\n\t\t\t\tunquoted, err := strconv.Unquote(expr.Value)\n\t\t\t\tif err != nil {\n\t\t\t\t\tunquoted = expr.Value\n\t\t\t\t}\n\t\t\t\tvalidated, err := types.ValidateAndCleanupLabel(unquoted, types.CodeLocation{})\n\t\t\t\tif err == nil {\n\t\t\t\t\tout = append(out, validated)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/main.go",
"content": "package main\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/build\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/generators\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/labels\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/outline\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/run\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/unfocus\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/watch\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nvar program command.Program\n\nfunc GenerateCommands() []command.Command {\n\treturn []command.Command{\n\t\twatch.BuildWatchCommand(),\n\t\tbuild.BuildBuildCommand(),\n\t\tgenerators.BuildBootstrapCommand(),\n\t\tgenerators.BuildGenerateCommand(),\n\t\tlabels.BuildLabelsCommand(),\n\t\toutline.BuildOutlineCommand(),\n\t\tunfocus.BuildUnfocusCommand(),\n\t\tBuildVersionCommand(),\n\t}\n}\n\nfunc main() {\n\tprogram = command.Program{\n\t\tName: \"ginkgo\",\n\t\tHeading: fmt.Sprintf(\"Ginkgo Version %s\", types.VERSION),\n\t\tCommands: GenerateCommands(),\n\t\tDefaultCommand: run.BuildRunCommand(),\n\t\tDeprecatedCommands: []command.DeprecatedCommand{\n\t\t\t{Name: \"convert\", Deprecation: types.Deprecations.Convert()},\n\t\t\t{Name: \"blur\", Deprecation: types.Deprecations.Blur()},\n\t\t\t{Name: \"nodot\", Deprecation: types.Deprecations.Nodot()},\n\t\t},\n\t}\n\n\tprogram.RunAndExit(os.Args)\n}\n\nfunc BuildVersionCommand() command.Command {\n\treturn command.Command{\n\t\tName: \"version\",\n\t\tUsage: \"ginkgo version\",\n\t\tShortDoc: \"Print Ginkgo's version\",\n\t\tCommand: func(_ []string, _ []string) {\n\t\t\tfmt.Printf(\"Ginkgo Version %s\\n\", types.VERSION)\n\t\t},\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/outline/ginkgo.go",
"content": "package outline\n\nimport (\n\t\"go/ast\"\n\t\"go/token\"\n\t\"strconv\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nconst (\n\t// undefinedTextAlt is used if the spec/container text cannot be derived\n\tundefinedTextAlt = \"undefined\"\n)\n\n// ginkgoMetadata holds useful bits of information for every entry in the outline\ntype ginkgoMetadata struct {\n\t// Name is the spec or container function name, e.g. `Describe` or `It`\n\tName string `json:\"name\"`\n\n\t// Text is the `text` argument passed to specs, and some containers\n\tText string `json:\"text\"`\n\n\t// Start is the position of first character of the spec or container block\n\tStart int `json:\"start\"`\n\n\t// End is the position of first character immediately after the spec or container block\n\tEnd int `json:\"end\"`\n\n\tSpec bool `json:\"spec\"`\n\tFocused bool `json:\"focused\"`\n\tPending bool `json:\"pending\"`\n\tLabels []string `json:\"labels\"`\n}\n\n// ginkgoNode is used to construct the outline as a tree\ntype ginkgoNode struct {\n\tginkgoMetadata\n\tNodes []*ginkgoNode `json:\"nodes\"`\n}\n\ntype walkFunc func(n *ginkgoNode)\n\nfunc (n *ginkgoNode) PreOrder(f walkFunc) {\n\tf(n)\n\tfor _, m := range n.Nodes {\n\t\tm.PreOrder(f)\n\t}\n}\n\nfunc (n *ginkgoNode) PostOrder(f walkFunc) {\n\tfor _, m := range n.Nodes {\n\t\tm.PostOrder(f)\n\t}\n\tf(n)\n}\n\nfunc (n *ginkgoNode) Walk(pre, post walkFunc) {\n\tpre(n)\n\tfor _, m := range n.Nodes {\n\t\tm.Walk(pre, post)\n\t}\n\tpost(n)\n}\n\n// PropagateInheritedProperties propagates the Pending and Focused properties\n// through the subtree rooted at n.\nfunc (n *ginkgoNode) PropagateInheritedProperties() {\n\tn.PreOrder(func(thisNode *ginkgoNode) {\n\t\tfor _, descendantNode := range thisNode.Nodes {\n\t\t\tif thisNode.Pending {\n\t\t\t\tdescendantNode.Pending = true\n\t\t\t\tdescendantNode.Focused = false\n\t\t\t}\n\t\t\tif thisNode.Focused && !descendantNode.Pending {\n\t\t\t\tdescendantNode.Focused = true\n\t\t\t}\n\t\t}\n\t})\n}\n\n// BackpropagateUnfocus propagates the Focused property through the subtree\n// rooted at n. It applies the rule described in the Ginkgo docs:\n// > Nested programmatically focused specs follow a simple rule: if a\n// > leaf-node is marked focused, any of its ancestor nodes that are marked\n// > focus will be unfocused.\nfunc (n *ginkgoNode) BackpropagateUnfocus() {\n\tfocusedSpecInSubtreeStack := []bool{}\n\tn.PostOrder(func(thisNode *ginkgoNode) {\n\t\tif thisNode.Spec {\n\t\t\tfocusedSpecInSubtreeStack = append(focusedSpecInSubtreeStack, thisNode.Focused)\n\t\t\treturn\n\t\t}\n\t\tfocusedSpecInSubtree := false\n\t\tfor range thisNode.Nodes {\n\t\t\tfocusedSpecInSubtree = focusedSpecInSubtree || focusedSpecInSubtreeStack[len(focusedSpecInSubtreeStack)-1]\n\t\t\tfocusedSpecInSubtreeStack = focusedSpecInSubtreeStack[0 : len(focusedSpecInSubtreeStack)-1]\n\t\t}\n\t\tfocusedSpecInSubtreeStack = append(focusedSpecInSubtreeStack, focusedSpecInSubtree)\n\t\tif focusedSpecInSubtree {\n\t\t\tthisNode.Focused = false\n\t\t}\n\t})\n\n}\n\nfunc packageAndIdentNamesFromCallExpr(ce *ast.CallExpr) (string, string, bool) {\n\tswitch ex := ce.Fun.(type) {\n\tcase *ast.Ident:\n\t\treturn \"\", ex.Name, true\n\tcase *ast.SelectorExpr:\n\t\tpkgID, ok := ex.X.(*ast.Ident)\n\t\tif !ok {\n\t\t\treturn \"\", \"\", false\n\t\t}\n\t\t// A package identifier is top-level, so Obj must be nil\n\t\tif pkgID.Obj != nil {\n\t\t\treturn \"\", \"\", false\n\t\t}\n\t\tif ex.Sel == nil {\n\t\t\treturn \"\", \"\", false\n\t\t}\n\t\treturn pkgID.Name, ex.Sel.Name, true\n\tdefault:\n\t\treturn \"\", \"\", false\n\t}\n}\n\n// absoluteOffsetsForNode derives the absolute character offsets of the node start and\n// end positions.\nfunc absoluteOffsetsForNode(fset *token.FileSet, n ast.Node) (start, end int) {\n\treturn fset.PositionFor(n.Pos(), false).Offset, fset.PositionFor(n.End(), false).Offset\n}\n\n// ginkgoNodeFromCallExpr derives an outline entry from a go AST subtree\n// corresponding to a Ginkgo container or spec.\nfunc ginkgoNodeFromCallExpr(fset *token.FileSet, ce *ast.CallExpr, ginkgoPackageName *string) (*ginkgoNode, bool) {\n\tpackageName, identName, ok := packageAndIdentNamesFromCallExpr(ce)\n\tif !ok {\n\t\treturn nil, false\n\t}\n\n\tn := ginkgoNode{}\n\tn.Name = identName\n\tn.Start, n.End = absoluteOffsetsForNode(fset, ce)\n\tn.Nodes = make([]*ginkgoNode, 0)\n\tswitch identName {\n\tcase \"It\", \"Specify\", \"Entry\":\n\t\tn.Spec = true\n\t\tn.Text = textOrAltFromCallExpr(ce, undefinedTextAlt)\n\t\tn.Labels = labelFromCallExpr(ce)\n\t\tn.Pending = pendingFromCallExpr(ce)\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"FIt\", \"FSpecify\", \"FEntry\":\n\t\tn.Spec = true\n\t\tn.Focused = true\n\t\tn.Text = textOrAltFromCallExpr(ce, undefinedTextAlt)\n\t\tn.Labels = labelFromCallExpr(ce)\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"PIt\", \"PSpecify\", \"XIt\", \"XSpecify\", \"PEntry\", \"XEntry\":\n\t\tn.Spec = true\n\t\tn.Pending = true\n\t\tn.Text = textOrAltFromCallExpr(ce, undefinedTextAlt)\n\t\tn.Labels = labelFromCallExpr(ce)\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"Context\", \"Describe\", \"When\", \"DescribeTable\":\n\t\tn.Text = textOrAltFromCallExpr(ce, undefinedTextAlt)\n\t\tn.Labels = labelFromCallExpr(ce)\n\t\tn.Pending = pendingFromCallExpr(ce)\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"FContext\", \"FDescribe\", \"FWhen\", \"FDescribeTable\":\n\t\tn.Focused = true\n\t\tn.Text = textOrAltFromCallExpr(ce, undefinedTextAlt)\n\t\tn.Labels = labelFromCallExpr(ce)\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"PContext\", \"PDescribe\", \"PWhen\", \"XContext\", \"XDescribe\", \"XWhen\", \"PDescribeTable\", \"XDescribeTable\":\n\t\tn.Pending = true\n\t\tn.Text = textOrAltFromCallExpr(ce, undefinedTextAlt)\n\t\tn.Labels = labelFromCallExpr(ce)\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"By\":\n\t\tn.Text = textOrAltFromCallExpr(ce, undefinedTextAlt)\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"AfterEach\", \"BeforeEach\":\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"JustAfterEach\", \"JustBeforeEach\":\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"AfterSuite\", \"BeforeSuite\":\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tcase \"SynchronizedAfterSuite\", \"SynchronizedBeforeSuite\":\n\t\treturn &n, ginkgoPackageName != nil && *ginkgoPackageName == packageName\n\tdefault:\n\t\treturn nil, false\n\t}\n}\n\n// textOrAltFromCallExpr tries to derive the \"text\" of a Ginkgo spec or\n// container. If it cannot derive it, it returns the alt text.\nfunc textOrAltFromCallExpr(ce *ast.CallExpr, alt string) string {\n\ttext, defined := textFromCallExpr(ce)\n\tif !defined {\n\t\treturn alt\n\t}\n\treturn text\n}\n\n// textFromCallExpr tries to derive the \"text\" of a Ginkgo spec or container. If\n// it cannot derive it, it returns false.\nfunc textFromCallExpr(ce *ast.CallExpr) (string, bool) {\n\tif len(ce.Args) < 1 {\n\t\treturn \"\", false\n\t}\n\ttext, ok := ce.Args[0].(*ast.BasicLit)\n\tif !ok {\n\t\treturn \"\", false\n\t}\n\tswitch text.Kind {\n\tcase token.CHAR, token.STRING:\n\t\t// For token.CHAR and token.STRING, Value is quoted\n\t\tunquoted, err := strconv.Unquote(text.Value)\n\t\tif err != nil {\n\t\t\t// If unquoting fails, just use the raw Value\n\t\t\treturn text.Value, true\n\t\t}\n\t\treturn unquoted, true\n\tdefault:\n\t\treturn text.Value, true\n\t}\n}\n\nfunc labelFromCallExpr(ce *ast.CallExpr) []string {\n\n\tlabels := []string{}\n\tif len(ce.Args) < 2 {\n\t\treturn labels\n\t}\n\n\tfor _, arg := range ce.Args[1:] {\n\t\tswitch expr := arg.(type) {\n\t\tcase *ast.CallExpr:\n\t\t\tid, ok := expr.Fun.(*ast.Ident)\n\t\t\tif !ok {\n\t\t\t\t// to skip over cases where the expr.Fun. is actually *ast.SelectorExpr\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif id.Name == \"Label\" {\n\t\t\t\tls := extractLabels(expr)\n\t\t\t\tlabels = append(labels, ls...)\n\t\t\t}\n\t\t}\n\t}\n\treturn labels\n}\n\nfunc extractLabels(expr *ast.CallExpr) []string {\n\tout := []string{}\n\tfor _, arg := range expr.Args {\n\t\tswitch expr := arg.(type) {\n\t\tcase *ast.BasicLit:\n\t\t\tif expr.Kind == token.STRING {\n\t\t\t\tunquoted, err := strconv.Unquote(expr.Value)\n\t\t\t\tif err != nil {\n\t\t\t\t\tunquoted = expr.Value\n\t\t\t\t}\n\t\t\t\tvalidated, err := types.ValidateAndCleanupLabel(unquoted, types.CodeLocation{})\n\t\t\t\tif err == nil {\n\t\t\t\t\tout = append(out, validated)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\treturn out\n}\n\nfunc pendingFromCallExpr(ce *ast.CallExpr) bool {\n\n\tpending := false\n\tif len(ce.Args) < 2 {\n\t\treturn pending\n\t}\n\n\tfor _, arg := range ce.Args[1:] {\n\t\tswitch expr := arg.(type) {\n\t\tcase *ast.CallExpr:\n\t\t\tid, ok := expr.Fun.(*ast.Ident)\n\t\t\tif !ok {\n\t\t\t\t// to skip over cases where the expr.Fun. is actually *ast.SelectorExpr\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif id.Name == \"Pending\" {\n\t\t\t\tpending = true\n\t\t\t}\n\t\tcase *ast.Ident:\n\t\t\tif expr.Name == \"Pending\" {\n\t\t\t\tpending = true\n\t\t\t}\n\t\t}\n\t}\n\treturn pending\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/outline/import.go",
"content": "// Copyright 2013 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Most of the required functions were available in the\n// \"golang.org/x/tools/go/ast/astutil\" package, but not exported.\n// They were copied from https://github.com/golang/tools/blob/2b0845dc783e36ae26d683f4915a5840ef01ab0f/go/ast/astutil/imports.go\n\npackage outline\n\nimport (\n\t\"go/ast\"\n\t\"strconv\"\n\t\"strings\"\n)\n\n// packageNameForImport returns the package name for the package. If the package\n// is not imported, it returns nil. \"Package name\" refers to `pkgname` in the\n// call expression `pkgname.ExportedIdentifier`. Examples:\n// (import path not found) -> nil\n// \"import example.com/pkg/foo\" -> \"foo\"\n// \"import fooalias example.com/pkg/foo\" -> \"fooalias\"\n// \"import . example.com/pkg/foo\" -> \"\"\nfunc packageNameForImport(f *ast.File, path string) *string {\n\tspec := importSpec(f, path)\n\tif spec == nil {\n\t\treturn nil\n\t}\n\tname := spec.Name.String()\n\tif name == \"\" {\n\t\tname = \"ginkgo\"\n\t}\n\tif name == \".\" {\n\t\tname = \"\"\n\t}\n\treturn &name\n}\n\n// importSpec returns the import spec if f imports path,\n// or nil otherwise.\nfunc importSpec(f *ast.File, path string) *ast.ImportSpec {\n\tfor _, s := range f.Imports {\n\t\tif strings.HasPrefix(importPath(s), path) {\n\t\t\treturn s\n\t\t}\n\t}\n\treturn nil\n}\n\n// importPath returns the unquoted import path of s,\n// or \"\" if the path is not properly quoted.\nfunc importPath(s *ast.ImportSpec) string {\n\tt, err := strconv.Unquote(s.Path.Value)\n\tif err != nil {\n\t\treturn \"\"\n\t}\n\treturn t\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/outline/outline.go",
"content": "package outline\n\nimport (\n\t\"bytes\"\n\t\"encoding/csv\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"go/ast\"\n\t\"go/token\"\n\t\"strconv\"\n\t\"strings\"\n\n\t\"golang.org/x/tools/go/ast/inspector\"\n)\n\nconst (\n\t// ginkgoImportPath is the well-known ginkgo import path\n\tginkgoImportPath = \"github.com/onsi/ginkgo/v2\"\n)\n\n// FromASTFile returns an outline for a Ginkgo test source file\nfunc FromASTFile(fset *token.FileSet, src *ast.File) (*outline, error) {\n\tginkgoPackageName := packageNameForImport(src, ginkgoImportPath)\n\tif ginkgoPackageName == nil {\n\t\treturn nil, fmt.Errorf(\"file does not import %q\", ginkgoImportPath)\n\t}\n\n\troot := ginkgoNode{}\n\tstack := []*ginkgoNode{&root}\n\tispr := inspector.New([]*ast.File{src})\n\tispr.Nodes([]ast.Node{(*ast.CallExpr)(nil)}, func(node ast.Node, push bool) bool {\n\t\tif push {\n\t\t\t// Pre-order traversal\n\t\t\tce, ok := node.(*ast.CallExpr)\n\t\t\tif !ok {\n\t\t\t\t// Because `Nodes` calls this function only when the node is an\n\t\t\t\t// ast.CallExpr, this should never happen\n\t\t\t\tpanic(fmt.Errorf(\"node starting at %d, ending at %d is not an *ast.CallExpr\", node.Pos(), node.End()))\n\t\t\t}\n\t\t\tgn, ok := ginkgoNodeFromCallExpr(fset, ce, ginkgoPackageName)\n\t\t\tif !ok {\n\t\t\t\t// Node is not a Ginkgo spec or container, continue\n\t\t\t\treturn true\n\t\t\t}\n\t\t\tparent := stack[len(stack)-1]\n\t\t\tparent.Nodes = append(parent.Nodes, gn)\n\t\t\tstack = append(stack, gn)\n\t\t\treturn true\n\t\t}\n\t\t// Post-order traversal\n\t\tstart, end := absoluteOffsetsForNode(fset, node)\n\t\tlastVisitedGinkgoNode := stack[len(stack)-1]\n\t\tif start != lastVisitedGinkgoNode.Start || end != lastVisitedGinkgoNode.End {\n\t\t\t// Node is not a Ginkgo spec or container, so it was not pushed onto the stack, continue\n\t\t\treturn true\n\t\t}\n\t\tstack = stack[0 : len(stack)-1]\n\t\treturn true\n\t})\n\tif len(root.Nodes) == 0 {\n\t\treturn &outline{[]*ginkgoNode{}}, nil\n\t}\n\n\t// Derive the final focused property for all nodes. This must be done\n\t// _before_ propagating the inherited focused property.\n\troot.BackpropagateUnfocus()\n\t// Now, propagate inherited properties, including focused and pending.\n\troot.PropagateInheritedProperties()\n\n\treturn &outline{root.Nodes}, nil\n}\n\ntype outline struct {\n\tNodes []*ginkgoNode `json:\"nodes\"`\n}\n\nfunc (o *outline) MarshalJSON() ([]byte, error) {\n\treturn json.Marshal(o.Nodes)\n}\n\n// String returns a CSV-formatted outline. Spec or container are output in\n// depth-first order.\nfunc (o *outline) String() string {\n\treturn o.StringIndent(0)\n}\n\n// StringIndent returns a CSV-formated outline, but every line is indented by\n// one 'width' of spaces for every level of nesting.\nfunc (o *outline) StringIndent(width int) string {\n\tvar b bytes.Buffer\n\tb.WriteString(\"Name,Text,Start,End,Spec,Focused,Pending,Labels\\n\")\n\n\tcsvWriter := csv.NewWriter(&b)\n\n\tcurrentIndent := 0\n\tpre := func(n *ginkgoNode) {\n\t\tb.WriteString(fmt.Sprintf(\"%*s\", currentIndent, \"\"))\n\t\tvar labels string\n\t\tif len(n.Labels) == 1 {\n\t\t\tlabels = n.Labels[0]\n\t\t} else {\n\t\t\tlabels = strings.Join(n.Labels, \", \")\n\t\t}\n\n\t\trow := []string{\n\t\t\tn.Name,\n\t\t\tn.Text,\n\t\t\tstrconv.Itoa(n.Start),\n\t\t\tstrconv.Itoa(n.End),\n\t\t\tstrconv.FormatBool(n.Spec),\n\t\t\tstrconv.FormatBool(n.Focused),\n\t\t\tstrconv.FormatBool(n.Pending),\n\t\t\tlabels,\n\t\t}\n\t\tcsvWriter.Write(row)\n\n\t\t// Ensure we write to `b' before the next `b.WriteString()', which might be adding indentation\n\t\tcsvWriter.Flush()\n\n\t\tcurrentIndent += width\n\t}\n\tpost := func(n *ginkgoNode) {\n\t\tcurrentIndent -= width\n\t}\n\tfor _, n := range o.Nodes {\n\t\tn.Walk(pre, post)\n\t}\n\n\treturn b.String()\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/outline/outline_command.go",
"content": "package outline\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"go/parser\"\n\t\"go/token\"\n\t\"os\"\n\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nconst (\n\t// indentWidth is the width used by the 'indent' output\n\tindentWidth = 4\n\t// stdinAlias is a portable alias for stdin. This convention is used in\n\t// other CLIs, e.g., kubectl.\n\tstdinAlias = \"-\"\n\tusageCommand = \"ginkgo outline \"\n)\n\ntype outlineConfig struct {\n\tFormat string\n}\n\nfunc BuildOutlineCommand() command.Command {\n\tconf := outlineConfig{\n\t\tFormat: \"csv\",\n\t}\n\tflags, err := types.NewGinkgoFlagSet(\n\t\ttypes.GinkgoFlags{\n\t\t\t{Name: \"format\", KeyPath: \"Format\",\n\t\t\t\tUsage: \"Format of outline\",\n\t\t\t\tUsageArgument: \"one of 'csv', 'indent', or 'json'\",\n\t\t\t\tUsageDefaultValue: conf.Format,\n\t\t\t},\n\t\t},\n\t\t&conf,\n\t\ttypes.GinkgoFlagSections{},\n\t)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\treturn command.Command{\n\t\tName: \"outline\",\n\t\tUsage: \"ginkgo outline \",\n\t\tShortDoc: \"Create an outline of Ginkgo symbols for a file\",\n\t\tDocumentation: \"To read from stdin, use: `ginkgo outline -`\",\n\t\tDocLink: \"creating-an-outline-of-specs\",\n\t\tFlags: flags,\n\t\tCommand: func(args []string, _ []string) {\n\t\t\toutlineFile(args, conf.Format)\n\t\t},\n\t}\n}\n\nfunc outlineFile(args []string, format string) {\n\tif len(args) != 1 {\n\t\tcommand.AbortWithUsage(\"outline expects exactly one argument\")\n\t}\n\n\tfilename := args[0]\n\tvar src *os.File\n\tif filename == stdinAlias {\n\t\tsrc = os.Stdin\n\t} else {\n\t\tvar err error\n\t\tsrc, err = os.Open(filename)\n\t\tcommand.AbortIfError(\"Failed to open file:\", err)\n\t}\n\n\tfset := token.NewFileSet()\n\n\tparsedSrc, err := parser.ParseFile(fset, filename, src, 0)\n\tcommand.AbortIfError(\"Failed to parse source:\", err)\n\n\to, err := FromASTFile(fset, parsedSrc)\n\tcommand.AbortIfError(\"Failed to create outline:\", err)\n\n\tvar oerr error\n\tswitch format {\n\tcase \"csv\":\n\t\t_, oerr = fmt.Print(o)\n\tcase \"indent\":\n\t\t_, oerr = fmt.Print(o.StringIndent(indentWidth))\n\tcase \"json\":\n\t\tb, err := json.Marshal(o)\n\t\tif err != nil {\n\t\t\tprintln(fmt.Sprintf(\"error marshalling to json: %s\", err))\n\t\t}\n\t\t_, oerr = fmt.Println(string(b))\n\tdefault:\n\t\tcommand.AbortWith(\"Format %s not accepted\", format)\n\t}\n\tcommand.AbortIfError(\"Failed to write outline:\", oerr)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/run/run_command.go",
"content": "package run\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"strings\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/internal\"\n\t\"github.com/onsi/ginkgo/v2/internal/interrupt_handler\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc BuildRunCommand() command.Command {\n\tvar suiteConfig = types.NewDefaultSuiteConfig()\n\tvar reporterConfig = types.NewDefaultReporterConfig()\n\tvar cliConfig = types.NewDefaultCLIConfig()\n\tvar goFlagsConfig = types.NewDefaultGoFlagsConfig()\n\n\tflags, err := types.BuildRunCommandFlagSet(&suiteConfig, &reporterConfig, &cliConfig, &goFlagsConfig)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tinterruptHandler := interrupt_handler.NewInterruptHandler(nil)\n\tinterrupt_handler.SwallowSigQuit()\n\n\treturn command.Command{\n\t\tName: \"run\",\n\t\tFlags: flags,\n\t\tUsage: \"ginkgo run -- \",\n\t\tShortDoc: \"Run the tests in the passed in (or the package in the current directory if left blank)\",\n\t\tDocumentation: \"Any arguments after -- will be passed to the test.\",\n\t\tDocLink: \"running-specs\",\n\t\tCommand: func(args []string, additionalArgs []string) {\n\t\t\tvar errors []error\n\t\t\tcliConfig, goFlagsConfig, errors = types.VetAndInitializeCLIAndGoConfig(cliConfig, goFlagsConfig)\n\t\t\tcommand.AbortIfErrors(\"Ginkgo detected configuration issues:\", errors)\n\n\t\t\trunner := &SpecRunner{\n\t\t\t\tcliConfig: cliConfig,\n\t\t\t\tgoFlagsConfig: goFlagsConfig,\n\t\t\t\tsuiteConfig: suiteConfig,\n\t\t\t\treporterConfig: reporterConfig,\n\t\t\t\tflags: flags,\n\n\t\t\t\tinterruptHandler: interruptHandler,\n\t\t\t}\n\n\t\t\trunner.RunSpecs(args, additionalArgs)\n\t\t},\n\t}\n}\n\ntype SpecRunner struct {\n\tsuiteConfig types.SuiteConfig\n\treporterConfig types.ReporterConfig\n\tcliConfig types.CLIConfig\n\tgoFlagsConfig types.GoFlagsConfig\n\tflags types.GinkgoFlagSet\n\n\tinterruptHandler *interrupt_handler.InterruptHandler\n}\n\nfunc (r *SpecRunner) RunSpecs(args []string, additionalArgs []string) {\n\tsuites := internal.FindSuites(args, r.cliConfig, true)\n\tskippedSuites := suites.WithState(internal.TestSuiteStateSkippedByFilter)\n\tsuites = suites.WithoutState(internal.TestSuiteStateSkippedByFilter)\n\n\tinternal.VerifyCLIAndFrameworkVersion(suites)\n\n\tif len(skippedSuites) > 0 {\n\t\tfmt.Println(\"Will skip:\")\n\t\tfor _, skippedSuite := range skippedSuites {\n\t\t\tfmt.Println(\" \" + skippedSuite.Path)\n\t\t}\n\t}\n\n\tif len(skippedSuites) > 0 && len(suites) == 0 {\n\t\tcommand.AbortGracefullyWith(\"All tests skipped! Exiting...\")\n\t}\n\n\tif len(suites) == 0 {\n\t\tcommand.AbortWith(\"Found no test suites\")\n\t}\n\n\tif len(suites) > 1 && !r.flags.WasSet(\"succinct\") && r.reporterConfig.Verbosity().LT(types.VerbosityLevelVerbose) {\n\t\tr.reporterConfig.Succinct = true\n\t}\n\n\tt := time.Now()\n\tvar endTime time.Time\n\tif r.suiteConfig.Timeout > 0 {\n\t\tendTime = t.Add(r.suiteConfig.Timeout)\n\t}\n\n\titeration := 0\nOUTER_LOOP:\n\tfor {\n\t\tif !r.flags.WasSet(\"seed\") {\n\t\t\tr.suiteConfig.RandomSeed = time.Now().Unix()\n\t\t}\n\t\tif r.cliConfig.RandomizeSuites && len(suites) > 1 {\n\t\t\tsuites = suites.ShuffledCopy(r.suiteConfig.RandomSeed)\n\t\t}\n\n\t\topc := internal.NewOrderedParallelCompiler(r.cliConfig.ComputedNumCompilers())\n\t\topc.StartCompiling(suites, r.goFlagsConfig, false)\n\n\tSUITE_LOOP:\n\t\tfor {\n\t\t\tsuiteIdx, suite := opc.Next()\n\t\t\tif suiteIdx >= len(suites) {\n\t\t\t\tbreak SUITE_LOOP\n\t\t\t}\n\t\t\tsuites[suiteIdx] = suite\n\n\t\t\tif r.interruptHandler.Status().Interrupted() {\n\t\t\t\topc.StopAndDrain()\n\t\t\t\tbreak OUTER_LOOP\n\t\t\t}\n\n\t\t\tif suites[suiteIdx].State.Is(internal.TestSuiteStateSkippedDueToEmptyCompilation) {\n\t\t\t\tfmt.Printf(\"Skipping %s (no test files)\\n\", suite.Path)\n\t\t\t\tcontinue SUITE_LOOP\n\t\t\t}\n\n\t\t\tif suites[suiteIdx].State.Is(internal.TestSuiteStateFailedToCompile) {\n\t\t\t\tfmt.Println(suites[suiteIdx].CompilationError.Error())\n\t\t\t\tif !r.cliConfig.KeepGoing {\n\t\t\t\t\topc.StopAndDrain()\n\t\t\t\t}\n\t\t\t\tcontinue SUITE_LOOP\n\t\t\t}\n\n\t\t\tif suites.CountWithState(internal.TestSuiteStateFailureStates...) > 0 && !r.cliConfig.KeepGoing {\n\t\t\t\tsuites[suiteIdx].State = internal.TestSuiteStateSkippedDueToPriorFailures\n\t\t\t\topc.StopAndDrain()\n\t\t\t\tcontinue SUITE_LOOP\n\t\t\t}\n\n\t\t\tif !endTime.IsZero() {\n\t\t\t\tr.suiteConfig.Timeout = time.Until(endTime)\n\t\t\t\tif r.suiteConfig.Timeout <= 0 {\n\t\t\t\t\tsuites[suiteIdx].State = internal.TestSuiteStateFailedDueToTimeout\n\t\t\t\t\topc.StopAndDrain()\n\t\t\t\t\tcontinue SUITE_LOOP\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tsuites[suiteIdx] = internal.RunCompiledSuite(suites[suiteIdx], r.suiteConfig, r.reporterConfig, r.cliConfig, r.goFlagsConfig, additionalArgs)\n\t\t}\n\n\t\tif suites.CountWithState(internal.TestSuiteStateFailureStates...) > 0 {\n\t\t\tif iteration > 0 {\n\t\t\t\tfmt.Printf(\"\\nTests failed on attempt #%d\\n\\n\", iteration+1)\n\t\t\t}\n\t\t\tbreak OUTER_LOOP\n\t\t}\n\n\t\tif r.cliConfig.UntilItFails {\n\t\t\tfmt.Printf(\"\\nAll tests passed...\\nWill keep running them until they fail.\\nThis was attempt #%d\\n%s\\n\", iteration+1, orcMessage(iteration+1))\n\t\t} else if r.cliConfig.Repeat > 0 && iteration < r.cliConfig.Repeat {\n\t\t\tfmt.Printf(\"\\nAll tests passed...\\nThis was attempt %d of %d.\\n\", iteration+1, r.cliConfig.Repeat+1)\n\t\t} else {\n\t\t\tbreak OUTER_LOOP\n\t\t}\n\t\titeration += 1\n\t}\n\n\tinternal.Cleanup(r.goFlagsConfig, suites...)\n\n\tmessages, err := internal.FinalizeProfilesAndReportsForSuites(suites, r.cliConfig, r.suiteConfig, r.reporterConfig, r.goFlagsConfig)\n\tcommand.AbortIfError(\"could not finalize profiles:\", err)\n\tfor _, message := range messages {\n\t\tfmt.Println(message)\n\t}\n\n\tfmt.Printf(\"\\nGinkgo ran %d %s in %s\\n\", len(suites), internal.PluralizedWord(\"suite\", \"suites\", len(suites)), time.Since(t))\n\n\tif suites.CountWithState(internal.TestSuiteStateFailureStates...) == 0 {\n\t\tif suites.AnyHaveProgrammaticFocus() && strings.TrimSpace(os.Getenv(\"GINKGO_EDITOR_INTEGRATION\")) == \"\" {\n\t\t\tfmt.Printf(\"Test Suite Passed\\n\")\n\t\t\tfmt.Printf(\"Detected Programmatic Focus - setting exit status to %d\\n\", types.GINKGO_FOCUS_EXIT_CODE)\n\t\t\tcommand.Abort(command.AbortDetails{ExitCode: types.GINKGO_FOCUS_EXIT_CODE})\n\t\t} else {\n\t\t\tfmt.Printf(\"Test Suite Passed\\n\")\n\t\t\tcommand.Abort(command.AbortDetails{})\n\t\t}\n\t} else {\n\t\tfmt.Fprintln(formatter.ColorableStdOut, \"\")\n\t\tif len(suites) > 1 && suites.CountWithState(internal.TestSuiteStateFailureStates...) > 0 {\n\t\t\tfmt.Fprintln(formatter.ColorableStdOut,\n\t\t\t\tinternal.FailedSuitesReport(suites, formatter.NewWithNoColorBool(r.reporterConfig.NoColor)))\n\t\t}\n\t\tfmt.Printf(\"Test Suite Failed\\n\")\n\t\tcommand.Abort(command.AbortDetails{ExitCode: 1})\n\t}\n}\n\nfunc orcMessage(iteration int) string {\n\tif iteration < 10 {\n\t\treturn \"\"\n\t} else if iteration < 30 {\n\t\treturn []string{\n\t\t\t\"If at first you succeed...\",\n\t\t\t\"...try, try again.\",\n\t\t\t\"Looking good!\",\n\t\t\t\"Still good...\",\n\t\t\t\"I think your tests are fine....\",\n\t\t\t\"Yep, still passing\",\n\t\t\t\"Oh boy, here I go testin' again!\",\n\t\t\t\"Even the gophers are getting bored\",\n\t\t\t\"Did you try -race?\",\n\t\t\t\"Maybe you should stop now?\",\n\t\t\t\"I'm getting tired...\",\n\t\t\t\"What if I just made you a sandwich?\",\n\t\t\t\"Hit ^C, hit ^C, please hit ^C\",\n\t\t\t\"Make it stop. Please!\",\n\t\t\t\"Come on! Enough is enough!\",\n\t\t\t\"Dave, this conversation can serve no purpose anymore. Goodbye.\",\n\t\t\t\"Just what do you think you're doing, Dave? \",\n\t\t\t\"I, Sisyphus\",\n\t\t\t\"Insanity: doing the same thing over and over again and expecting different results. -Einstein\",\n\t\t\t\"I guess Einstein never tried to churn butter\",\n\t\t}[iteration-10] + \"\\n\"\n\t} else {\n\t\treturn \"No, seriously... you can probably stop now.\\n\"\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/unfocus/unfocus_command.go",
"content": "package unfocus\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"go/ast\"\n\t\"go/parser\"\n\t\"go/token\"\n\t\"io\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"strings\"\n\t\"sync\"\n\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n)\n\nfunc BuildUnfocusCommand() command.Command {\n\treturn command.Command{\n\t\tName: \"unfocus\",\n\t\tUsage: \"ginkgo unfocus\",\n\t\tShortDoc: \"Recursively unfocus any focused tests under the current directory\",\n\t\tDocLink: \"filtering-specs\",\n\t\tCommand: func(_ []string, _ []string) {\n\t\t\tunfocusSpecs()\n\t\t},\n\t}\n}\n\nfunc unfocusSpecs() {\n\tfmt.Println(\"Scanning for focus...\")\n\n\tgoFiles := make(chan string)\n\tgo func() {\n\t\tunfocusDir(goFiles, \".\")\n\t\tclose(goFiles)\n\t}()\n\n\tconst workers = 10\n\twg := sync.WaitGroup{}\n\twg.Add(workers)\n\n\tfor i := 0; i < workers; i++ {\n\t\tgo func() {\n\t\t\tfor path := range goFiles {\n\t\t\t\tunfocusFile(path)\n\t\t\t}\n\t\t\twg.Done()\n\t\t}()\n\t}\n\n\twg.Wait()\n}\n\nfunc unfocusDir(goFiles chan string, path string) {\n\tfiles, err := os.ReadDir(path)\n\tif err != nil {\n\t\tfmt.Println(err.Error())\n\t\treturn\n\t}\n\n\tfor _, f := range files {\n\t\tswitch {\n\t\tcase f.IsDir() && shouldProcessDir(f.Name()):\n\t\t\tunfocusDir(goFiles, filepath.Join(path, f.Name()))\n\t\tcase !f.IsDir() && shouldProcessFile(f.Name()):\n\t\t\tgoFiles <- filepath.Join(path, f.Name())\n\t\t}\n\t}\n}\n\nfunc shouldProcessDir(basename string) bool {\n\treturn basename != \"vendor\" && !strings.HasPrefix(basename, \".\")\n}\n\nfunc shouldProcessFile(basename string) bool {\n\treturn strings.HasSuffix(basename, \".go\")\n}\n\nfunc unfocusFile(path string) {\n\tdata, err := os.ReadFile(path)\n\tif err != nil {\n\t\tfmt.Printf(\"error reading file '%s': %s\\n\", path, err.Error())\n\t\treturn\n\t}\n\n\tast, err := parser.ParseFile(token.NewFileSet(), path, bytes.NewReader(data), parser.ParseComments)\n\tif err != nil {\n\t\tfmt.Printf(\"error parsing file '%s': %s\\n\", path, err.Error())\n\t\treturn\n\t}\n\n\teliminations := scanForFocus(ast)\n\tif len(eliminations) == 0 {\n\t\treturn\n\t}\n\n\tfmt.Printf(\"...updating %s\\n\", path)\n\tbackup, err := writeBackup(path, data)\n\tif err != nil {\n\t\tfmt.Printf(\"error creating backup file: %s\\n\", err.Error())\n\t\treturn\n\t}\n\n\tif err := updateFile(path, data, eliminations); err != nil {\n\t\tfmt.Printf(\"error writing file '%s': %s\\n\", path, err.Error())\n\t\treturn\n\t}\n\n\tos.Remove(backup)\n}\n\nfunc writeBackup(path string, data []byte) (string, error) {\n\tt, err := os.CreateTemp(filepath.Dir(path), filepath.Base(path))\n\n\tif err != nil {\n\t\treturn \"\", fmt.Errorf(\"error creating temporary file: %w\", err)\n\t}\n\tdefer t.Close()\n\n\tif _, err := io.Copy(t, bytes.NewReader(data)); err != nil {\n\t\treturn \"\", fmt.Errorf(\"error writing to temporary file: %w\", err)\n\t}\n\n\treturn t.Name(), nil\n}\n\nfunc updateFile(path string, data []byte, eliminations [][]int64) error {\n\tto, err := os.Create(path)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"error opening file for writing '%s': %w\\n\", path, err)\n\t}\n\tdefer to.Close()\n\n\tfrom := bytes.NewReader(data)\n\tvar cursor int64\n\tfor _, eliminationRange := range eliminations {\n\t\tpositionToEliminate, lengthToEliminate := eliminationRange[0]-1, eliminationRange[1]\n\t\tif _, err := io.CopyN(to, from, positionToEliminate-cursor); err != nil {\n\t\t\treturn fmt.Errorf(\"error copying data: %w\", err)\n\t\t}\n\n\t\tcursor = positionToEliminate + lengthToEliminate\n\n\t\tif _, err := from.Seek(lengthToEliminate, io.SeekCurrent); err != nil {\n\t\t\treturn fmt.Errorf(\"error seeking to position in buffer: %w\", err)\n\t\t}\n\t}\n\n\tif _, err := io.Copy(to, from); err != nil {\n\t\treturn fmt.Errorf(\"error copying end data: %w\", err)\n\t}\n\n\treturn nil\n}\n\nfunc scanForFocus(file *ast.File) (eliminations [][]int64) {\n\tast.Inspect(file, func(n ast.Node) bool {\n\t\tif c, ok := n.(*ast.CallExpr); ok {\n\t\t\tif i, ok := c.Fun.(*ast.Ident); ok {\n\t\t\t\tif isFocus(i.Name) {\n\t\t\t\t\teliminations = append(eliminations, []int64{int64(i.Pos()), 1})\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif i, ok := n.(*ast.Ident); ok {\n\t\t\tif i.Name == \"Focus\" {\n\t\t\t\teliminations = append(eliminations, []int64{int64(i.Pos()), 6})\n\t\t\t}\n\t\t}\n\n\t\treturn true\n\t})\n\n\treturn eliminations\n}\n\nfunc isFocus(name string) bool {\n\tswitch name {\n\tcase \"FDescribe\", \"FContext\", \"FIt\", \"FDescribeTable\", \"FEntry\", \"FSpecify\", \"FWhen\":\n\t\treturn true\n\tdefault:\n\t\treturn false\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/watch/delta.go",
"content": "package watch\n\nimport \"sort\"\n\ntype Delta struct {\n\tModifiedPackages []string\n\n\tNewSuites []*Suite\n\tRemovedSuites []*Suite\n\tmodifiedSuites []*Suite\n}\n\ntype DescendingByDelta []*Suite\n\nfunc (a DescendingByDelta) Len() int { return len(a) }\nfunc (a DescendingByDelta) Swap(i, j int) { a[i], a[j] = a[j], a[i] }\nfunc (a DescendingByDelta) Less(i, j int) bool { return a[i].Delta() > a[j].Delta() }\n\nfunc (d Delta) ModifiedSuites() []*Suite {\n\tsort.Sort(DescendingByDelta(d.modifiedSuites))\n\treturn d.modifiedSuites\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/watch/delta_tracker.go",
"content": "package watch\n\nimport (\n\t\"fmt\"\n\n\t\"regexp\"\n\n\t\"github.com/onsi/ginkgo/v2/ginkgo/internal\"\n)\n\ntype SuiteErrors map[internal.TestSuite]error\n\ntype DeltaTracker struct {\n\tmaxDepth int\n\twatchRegExp *regexp.Regexp\n\tsuites map[string]*Suite\n\tpackageHashes *PackageHashes\n}\n\nfunc NewDeltaTracker(maxDepth int, watchRegExp *regexp.Regexp) *DeltaTracker {\n\treturn &DeltaTracker{\n\t\tmaxDepth: maxDepth,\n\t\twatchRegExp: watchRegExp,\n\t\tpackageHashes: NewPackageHashes(watchRegExp),\n\t\tsuites: map[string]*Suite{},\n\t}\n}\n\nfunc (d *DeltaTracker) Delta(suites internal.TestSuites) (delta Delta, errors SuiteErrors) {\n\terrors = SuiteErrors{}\n\tdelta.ModifiedPackages = d.packageHashes.CheckForChanges()\n\n\tprovidedSuitePaths := map[string]bool{}\n\tfor _, suite := range suites {\n\t\tprovidedSuitePaths[suite.Path] = true\n\t}\n\n\td.packageHashes.StartTrackingUsage()\n\n\tfor _, suite := range d.suites {\n\t\tif providedSuitePaths[suite.Suite.Path] {\n\t\t\tif suite.Delta() > 0 {\n\t\t\t\tdelta.modifiedSuites = append(delta.modifiedSuites, suite)\n\t\t\t}\n\t\t} else {\n\t\t\tdelta.RemovedSuites = append(delta.RemovedSuites, suite)\n\t\t}\n\t}\n\n\td.packageHashes.StopTrackingUsageAndPrune()\n\n\tfor _, suite := range suites {\n\t\t_, ok := d.suites[suite.Path]\n\t\tif !ok {\n\t\t\ts, err := NewSuite(suite, d.maxDepth, d.packageHashes)\n\t\t\tif err != nil {\n\t\t\t\terrors[suite] = err\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\td.suites[suite.Path] = s\n\t\t\tdelta.NewSuites = append(delta.NewSuites, s)\n\t\t}\n\t}\n\n\treturn delta, errors\n}\n\nfunc (d *DeltaTracker) WillRun(suite internal.TestSuite) error {\n\ts, ok := d.suites[suite.Path]\n\tif !ok {\n\t\treturn fmt.Errorf(\"unknown suite %s\", suite.Path)\n\t}\n\n\treturn s.MarkAsRunAndRecomputedDependencies(d.maxDepth)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/watch/dependencies.go",
"content": "package watch\n\nimport (\n\t\"go/build\"\n\t\"strings\"\n)\n\ntype Dependencies struct {\n\tdeps map[string]int\n}\n\nfunc NewDependencies(path string, maxDepth int) (Dependencies, error) {\n\td := Dependencies{\n\t\tdeps: map[string]int{},\n\t}\n\n\tif maxDepth == 0 {\n\t\treturn d, nil\n\t}\n\n\terr := d.seedWithDepsForPackageAtPath(path)\n\tif err != nil {\n\t\treturn d, err\n\t}\n\n\tfor depth := 1; depth < maxDepth; depth++ {\n\t\tn := len(d.deps)\n\t\td.addDepsForDepth(depth)\n\t\tif n == len(d.deps) {\n\t\t\tbreak\n\t\t}\n\t}\n\n\treturn d, nil\n}\n\nfunc (d Dependencies) Dependencies() map[string]int {\n\treturn d.deps\n}\n\nfunc (d Dependencies) seedWithDepsForPackageAtPath(path string) error {\n\tpkg, err := build.ImportDir(path, 0)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\td.resolveAndAdd(pkg.Imports, 1)\n\td.resolveAndAdd(pkg.TestImports, 1)\n\td.resolveAndAdd(pkg.XTestImports, 1)\n\n\tdelete(d.deps, pkg.Dir)\n\treturn nil\n}\n\nfunc (d Dependencies) addDepsForDepth(depth int) {\n\tfor dep, depDepth := range d.deps {\n\t\tif depDepth == depth {\n\t\t\td.addDepsForDep(dep, depth+1)\n\t\t}\n\t}\n}\n\nfunc (d Dependencies) addDepsForDep(dep string, depth int) {\n\tpkg, err := build.ImportDir(dep, 0)\n\tif err != nil {\n\t\tprintln(err.Error())\n\t\treturn\n\t}\n\td.resolveAndAdd(pkg.Imports, depth)\n}\n\nfunc (d Dependencies) resolveAndAdd(deps []string, depth int) {\n\tfor _, dep := range deps {\n\t\tpkg, err := build.Import(dep, \".\", 0)\n\t\tif err != nil {\n\t\t\tcontinue\n\t\t}\n\t\tif !pkg.Goroot && (!matchesGinkgoOrGomega(pkg.Dir) || matchesGinkgoIntegration(pkg.Dir)) {\n\t\t\td.addDepIfNotPresent(pkg.Dir, depth)\n\t\t}\n\t}\n}\n\nfunc (d Dependencies) addDepIfNotPresent(dep string, depth int) {\n\t_, ok := d.deps[dep]\n\tif !ok {\n\t\td.deps[dep] = depth\n\t}\n}\n\nfunc matchesGinkgoOrGomega(s string) bool {\n\treturn strings.Contains(s, \"github.com/onsi/ginkgo\") || strings.Contains(s, \"github.com/onsi/gomega\")\n}\n\nfunc matchesGinkgoIntegration(s string) bool {\n\treturn strings.Contains(s, \"github.com/onsi/ginkgo/integration\") // allow us to integration test this thing\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/watch/package_hash.go",
"content": "package watch\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"regexp\"\n\t\"strings\"\n\t\"time\"\n)\n\nvar goTestRegExp = regexp.MustCompile(`_test\\.go$`)\n\ntype PackageHash struct {\n\tCodeModifiedTime time.Time\n\tTestModifiedTime time.Time\n\tDeleted bool\n\n\tpath string\n\tcodeHash string\n\ttestHash string\n\twatchRegExp *regexp.Regexp\n}\n\nfunc NewPackageHash(path string, watchRegExp *regexp.Regexp) *PackageHash {\n\tp := &PackageHash{\n\t\tpath: path,\n\t\twatchRegExp: watchRegExp,\n\t}\n\n\tp.codeHash, _, p.testHash, _, p.Deleted = p.computeHashes()\n\n\treturn p\n}\n\nfunc (p *PackageHash) CheckForChanges() bool {\n\tcodeHash, codeModifiedTime, testHash, testModifiedTime, deleted := p.computeHashes()\n\n\tif deleted {\n\t\tif !p.Deleted {\n\t\t\tt := time.Now()\n\t\t\tp.CodeModifiedTime = t\n\t\t\tp.TestModifiedTime = t\n\t\t}\n\t\tp.Deleted = true\n\t\treturn true\n\t}\n\n\tmodified := false\n\tp.Deleted = false\n\n\tif p.codeHash != codeHash {\n\t\tp.CodeModifiedTime = codeModifiedTime\n\t\tmodified = true\n\t}\n\tif p.testHash != testHash {\n\t\tp.TestModifiedTime = testModifiedTime\n\t\tmodified = true\n\t}\n\n\tp.codeHash = codeHash\n\tp.testHash = testHash\n\treturn modified\n}\n\nfunc (p *PackageHash) computeHashes() (codeHash string, codeModifiedTime time.Time, testHash string, testModifiedTime time.Time, deleted bool) {\n\tentries, err := os.ReadDir(p.path)\n\n\tif err != nil {\n\t\tdeleted = true\n\t\treturn\n\t}\n\n\tfor _, entry := range entries {\n\t\tif entry.IsDir() {\n\t\t\tcontinue\n\t\t}\n\n\t\tinfo, err := entry.Info()\n\t\tif err != nil {\n\t\t\tcontinue\n\t\t}\n\n\t\tif isHiddenFile(info) {\n\t\t\tcontinue\n\t\t}\n\n\t\tif goTestRegExp.MatchString(info.Name()) {\n\t\t\ttestHash += p.hashForFileInfo(info)\n\t\t\tif info.ModTime().After(testModifiedTime) {\n\t\t\t\ttestModifiedTime = info.ModTime()\n\t\t\t}\n\t\t\tcontinue\n\t\t}\n\n\t\tif p.watchRegExp.MatchString(info.Name()) {\n\t\t\tcodeHash += p.hashForFileInfo(info)\n\t\t\tif info.ModTime().After(codeModifiedTime) {\n\t\t\t\tcodeModifiedTime = info.ModTime()\n\t\t\t}\n\t\t}\n\t}\n\n\ttestHash += codeHash\n\tif codeModifiedTime.After(testModifiedTime) {\n\t\ttestModifiedTime = codeModifiedTime\n\t}\n\n\treturn\n}\n\nfunc isHiddenFile(info os.FileInfo) bool {\n\treturn strings.HasPrefix(info.Name(), \".\") || strings.HasPrefix(info.Name(), \"_\")\n}\n\nfunc (p *PackageHash) hashForFileInfo(info os.FileInfo) string {\n\treturn fmt.Sprintf(\"%s_%d_%d\", info.Name(), info.Size(), info.ModTime().UnixNano())\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/watch/package_hashes.go",
"content": "package watch\n\nimport (\n\t\"path/filepath\"\n\t\"regexp\"\n\t\"sync\"\n)\n\ntype PackageHashes struct {\n\tPackageHashes map[string]*PackageHash\n\tusedPaths map[string]bool\n\twatchRegExp *regexp.Regexp\n\tlock *sync.Mutex\n}\n\nfunc NewPackageHashes(watchRegExp *regexp.Regexp) *PackageHashes {\n\treturn &PackageHashes{\n\t\tPackageHashes: map[string]*PackageHash{},\n\t\tusedPaths: nil,\n\t\twatchRegExp: watchRegExp,\n\t\tlock: &sync.Mutex{},\n\t}\n}\n\nfunc (p *PackageHashes) CheckForChanges() []string {\n\tp.lock.Lock()\n\tdefer p.lock.Unlock()\n\n\tmodified := []string{}\n\n\tfor _, packageHash := range p.PackageHashes {\n\t\tif packageHash.CheckForChanges() {\n\t\t\tmodified = append(modified, packageHash.path)\n\t\t}\n\t}\n\n\treturn modified\n}\n\nfunc (p *PackageHashes) Add(path string) *PackageHash {\n\tp.lock.Lock()\n\tdefer p.lock.Unlock()\n\n\tpath, _ = filepath.Abs(path)\n\t_, ok := p.PackageHashes[path]\n\tif !ok {\n\t\tp.PackageHashes[path] = NewPackageHash(path, p.watchRegExp)\n\t}\n\n\tif p.usedPaths != nil {\n\t\tp.usedPaths[path] = true\n\t}\n\treturn p.PackageHashes[path]\n}\n\nfunc (p *PackageHashes) Get(path string) *PackageHash {\n\tp.lock.Lock()\n\tdefer p.lock.Unlock()\n\n\tpath, _ = filepath.Abs(path)\n\tif p.usedPaths != nil {\n\t\tp.usedPaths[path] = true\n\t}\n\treturn p.PackageHashes[path]\n}\n\nfunc (p *PackageHashes) StartTrackingUsage() {\n\tp.lock.Lock()\n\tdefer p.lock.Unlock()\n\n\tp.usedPaths = map[string]bool{}\n}\n\nfunc (p *PackageHashes) StopTrackingUsageAndPrune() {\n\tp.lock.Lock()\n\tdefer p.lock.Unlock()\n\n\tfor path := range p.PackageHashes {\n\t\tif !p.usedPaths[path] {\n\t\t\tdelete(p.PackageHashes, path)\n\t\t}\n\t}\n\n\tp.usedPaths = nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/watch/suite.go",
"content": "package watch\n\nimport (\n\t\"fmt\"\n\t\"math\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/ginkgo/internal\"\n)\n\ntype Suite struct {\n\tSuite internal.TestSuite\n\tRunTime time.Time\n\tDependencies Dependencies\n\n\tsharedPackageHashes *PackageHashes\n}\n\nfunc NewSuite(suite internal.TestSuite, maxDepth int, sharedPackageHashes *PackageHashes) (*Suite, error) {\n\tdeps, err := NewDependencies(suite.Path, maxDepth)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tsharedPackageHashes.Add(suite.Path)\n\tfor dep := range deps.Dependencies() {\n\t\tsharedPackageHashes.Add(dep)\n\t}\n\n\treturn &Suite{\n\t\tSuite: suite,\n\t\tDependencies: deps,\n\n\t\tsharedPackageHashes: sharedPackageHashes,\n\t}, nil\n}\n\nfunc (s *Suite) Delta() float64 {\n\tdelta := s.delta(s.Suite.Path, true, 0) * 1000\n\tfor dep, depth := range s.Dependencies.Dependencies() {\n\t\tdelta += s.delta(dep, false, depth)\n\t}\n\treturn delta\n}\n\nfunc (s *Suite) MarkAsRunAndRecomputedDependencies(maxDepth int) error {\n\ts.RunTime = time.Now()\n\n\tdeps, err := NewDependencies(s.Suite.Path, maxDepth)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\ts.sharedPackageHashes.Add(s.Suite.Path)\n\tfor dep := range deps.Dependencies() {\n\t\ts.sharedPackageHashes.Add(dep)\n\t}\n\n\ts.Dependencies = deps\n\n\treturn nil\n}\n\nfunc (s *Suite) Description() string {\n\tnumDeps := len(s.Dependencies.Dependencies())\n\tpluralizer := \"ies\"\n\tif numDeps == 1 {\n\t\tpluralizer = \"y\"\n\t}\n\treturn fmt.Sprintf(\"%s [%d dependenc%s]\", s.Suite.Path, numDeps, pluralizer)\n}\n\nfunc (s *Suite) delta(packagePath string, includeTests bool, depth int) float64 {\n\treturn math.Max(float64(s.dt(packagePath, includeTests)), 0) / float64(depth+1)\n}\n\nfunc (s *Suite) dt(packagePath string, includeTests bool) time.Duration {\n\tpackageHash := s.sharedPackageHashes.Get(packagePath)\n\tvar modifiedTime time.Time\n\tif includeTests {\n\t\tmodifiedTime = packageHash.TestModifiedTime\n\t} else {\n\t\tmodifiedTime = packageHash.CodeModifiedTime\n\t}\n\n\treturn modifiedTime.Sub(s.RunTime)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo/watch/watch_command.go",
"content": "package watch\n\nimport (\n\t\"fmt\"\n\t\"regexp\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/command\"\n\t\"github.com/onsi/ginkgo/v2/ginkgo/internal\"\n\t\"github.com/onsi/ginkgo/v2/internal/interrupt_handler\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc BuildWatchCommand() command.Command {\n\tvar suiteConfig = types.NewDefaultSuiteConfig()\n\tvar reporterConfig = types.NewDefaultReporterConfig()\n\tvar cliConfig = types.NewDefaultCLIConfig()\n\tvar goFlagsConfig = types.NewDefaultGoFlagsConfig()\n\n\tflags, err := types.BuildWatchCommandFlagSet(&suiteConfig, &reporterConfig, &cliConfig, &goFlagsConfig)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tinterruptHandler := interrupt_handler.NewInterruptHandler(nil)\n\tinterrupt_handler.SwallowSigQuit()\n\n\treturn command.Command{\n\t\tName: \"watch\",\n\t\tFlags: flags,\n\t\tUsage: \"ginkgo watch -- \",\n\t\tShortDoc: \"Watch the passed in and runs their tests whenever changes occur.\",\n\t\tDocumentation: \"Any arguments after -- will be passed to the test.\",\n\t\tDocLink: \"watching-for-changes\",\n\t\tCommand: func(args []string, additionalArgs []string) {\n\t\t\tvar errors []error\n\t\t\tcliConfig, goFlagsConfig, errors = types.VetAndInitializeCLIAndGoConfig(cliConfig, goFlagsConfig)\n\t\t\tcommand.AbortIfErrors(\"Ginkgo detected configuration issues:\", errors)\n\n\t\t\twatcher := &SpecWatcher{\n\t\t\t\tcliConfig: cliConfig,\n\t\t\t\tgoFlagsConfig: goFlagsConfig,\n\t\t\t\tsuiteConfig: suiteConfig,\n\t\t\t\treporterConfig: reporterConfig,\n\t\t\t\tflags: flags,\n\n\t\t\t\tinterruptHandler: interruptHandler,\n\t\t\t}\n\n\t\t\twatcher.WatchSpecs(args, additionalArgs)\n\t\t},\n\t}\n}\n\ntype SpecWatcher struct {\n\tsuiteConfig types.SuiteConfig\n\treporterConfig types.ReporterConfig\n\tcliConfig types.CLIConfig\n\tgoFlagsConfig types.GoFlagsConfig\n\tflags types.GinkgoFlagSet\n\n\tinterruptHandler *interrupt_handler.InterruptHandler\n}\n\nfunc (w *SpecWatcher) WatchSpecs(args []string, additionalArgs []string) {\n\tsuites := internal.FindSuites(args, w.cliConfig, false).WithoutState(internal.TestSuiteStateSkippedByFilter)\n\n\tinternal.VerifyCLIAndFrameworkVersion(suites)\n\n\tif len(suites) == 0 {\n\t\tcommand.AbortWith(\"Found no test suites\")\n\t}\n\n\tfmt.Printf(\"Identified %d test %s. Locating dependencies to a depth of %d (this may take a while)...\\n\", len(suites), internal.PluralizedWord(\"suite\", \"suites\", len(suites)), w.cliConfig.Depth)\n\tdeltaTracker := NewDeltaTracker(w.cliConfig.Depth, regexp.MustCompile(w.cliConfig.WatchRegExp))\n\tdelta, errors := deltaTracker.Delta(suites)\n\n\tfmt.Printf(\"Watching %d %s:\\n\", len(delta.NewSuites), internal.PluralizedWord(\"suite\", \"suites\", len(delta.NewSuites)))\n\tfor _, suite := range delta.NewSuites {\n\t\tfmt.Println(\" \" + suite.Description())\n\t}\n\n\tfor suite, err := range errors {\n\t\tfmt.Printf(\"Failed to watch %s: %s\\n\", suite.PackageName, err)\n\t}\n\n\tif len(suites) == 1 {\n\t\tw.updateSeed()\n\t\tw.compileAndRun(suites[0], additionalArgs)\n\t}\n\n\tticker := time.NewTicker(time.Second)\n\n\tfor {\n\t\tselect {\n\t\tcase <-ticker.C:\n\t\t\tsuites := internal.FindSuites(args, w.cliConfig, false).WithoutState(internal.TestSuiteStateSkippedByFilter)\n\t\t\tdelta, _ := deltaTracker.Delta(suites)\n\t\t\tcoloredStream := formatter.ColorableStdOut\n\n\t\t\tsuites = internal.TestSuites{}\n\n\t\t\tif len(delta.NewSuites) > 0 {\n\t\t\t\tfmt.Fprintln(coloredStream, formatter.F(\"{{green}}Detected %d new %s:{{/}}\", len(delta.NewSuites), internal.PluralizedWord(\"suite\", \"suites\", len(delta.NewSuites))))\n\t\t\t\tfor _, suite := range delta.NewSuites {\n\t\t\t\t\tsuites = append(suites, suite.Suite)\n\t\t\t\t\tfmt.Fprintln(coloredStream, formatter.Fi(1, \"%s\", suite.Description()))\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tmodifiedSuites := delta.ModifiedSuites()\n\t\t\tif len(modifiedSuites) > 0 {\n\t\t\t\tfmt.Fprintln(coloredStream, formatter.F(\"{{green}}Detected changes in:{{/}}\"))\n\t\t\t\tfor _, pkg := range delta.ModifiedPackages {\n\t\t\t\t\tfmt.Fprintln(coloredStream, formatter.Fi(1, \"%s\", pkg))\n\t\t\t\t}\n\t\t\t\tfmt.Fprintln(coloredStream, formatter.F(\"{{green}}Will run %d %s:{{/}}\", len(modifiedSuites), internal.PluralizedWord(\"suite\", \"suites\", len(modifiedSuites))))\n\t\t\t\tfor _, suite := range modifiedSuites {\n\t\t\t\t\tsuites = append(suites, suite.Suite)\n\t\t\t\t\tfmt.Fprintln(coloredStream, formatter.Fi(1, \"%s\", suite.Description()))\n\t\t\t\t}\n\t\t\t\tfmt.Fprintln(coloredStream, \"\")\n\t\t\t}\n\n\t\t\tif len(suites) == 0 {\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\tw.updateSeed()\n\t\t\tw.computeSuccinctMode(len(suites))\n\t\t\tfor idx := range suites {\n\t\t\t\tif w.interruptHandler.Status().Interrupted() {\n\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t\tdeltaTracker.WillRun(suites[idx])\n\t\t\t\tsuites[idx] = w.compileAndRun(suites[idx], additionalArgs)\n\t\t\t}\n\t\t\tcolor := \"{{green}}\"\n\t\t\tif suites.CountWithState(internal.TestSuiteStateFailureStates...) > 0 {\n\t\t\t\tcolor = \"{{red}}\"\n\t\t\t}\n\t\t\tfmt.Fprintln(coloredStream, formatter.F(color+\"\\nDone. Resuming watch...{{/}}\"))\n\n\t\t\tmessages, err := internal.FinalizeProfilesAndReportsForSuites(suites, w.cliConfig, w.suiteConfig, w.reporterConfig, w.goFlagsConfig)\n\t\t\tcommand.AbortIfError(\"could not finalize profiles:\", err)\n\t\t\tfor _, message := range messages {\n\t\t\t\tfmt.Println(message)\n\t\t\t}\n\t\tcase <-w.interruptHandler.Status().Channel:\n\t\t\treturn\n\t\t}\n\t}\n}\n\nfunc (w *SpecWatcher) compileAndRun(suite internal.TestSuite, additionalArgs []string) internal.TestSuite {\n\tsuite = internal.CompileSuite(suite, w.goFlagsConfig, false)\n\tif suite.State.Is(internal.TestSuiteStateFailedToCompile) {\n\t\tfmt.Println(suite.CompilationError.Error())\n\t\treturn suite\n\t}\n\tif w.interruptHandler.Status().Interrupted() {\n\t\treturn suite\n\t}\n\tsuite = internal.RunCompiledSuite(suite, w.suiteConfig, w.reporterConfig, w.cliConfig, w.goFlagsConfig, additionalArgs)\n\tinternal.Cleanup(w.goFlagsConfig, suite)\n\treturn suite\n}\n\nfunc (w *SpecWatcher) computeSuccinctMode(numSuites int) {\n\tif w.reporterConfig.Verbosity().GTE(types.VerbosityLevelVerbose) {\n\t\tw.reporterConfig.Succinct = false\n\t\treturn\n\t}\n\n\tif w.flags.WasSet(\"succinct\") {\n\t\treturn\n\t}\n\n\tif numSuites == 1 {\n\t\tw.reporterConfig.Succinct = false\n\t}\n\n\tif numSuites > 1 {\n\t\tw.reporterConfig.Succinct = true\n\t}\n}\n\nfunc (w *SpecWatcher) updateSeed() {\n\tif !w.flags.WasSet(\"seed\") {\n\t\tw.suiteConfig.RandomSeed = time.Now().Unix()\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo_cli_dependencies.go",
"content": "//go:build ginkgoclidependencies\n// +build ginkgoclidependencies\n\npackage ginkgo\n\nimport (\n\t_ \"github.com/onsi/ginkgo/v2/ginkgo\"\n)\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/ginkgo_t_dsl.go",
"content": "package ginkgo\n\nimport (\n\t\"context\"\n\t\"io\"\n\t\"testing\"\n\n\t\"github.com/onsi/ginkgo/v2/internal/testingtproxy\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n/*\nGinkgoT() implements an interface that allows third party libraries to integrate with and build on top of Ginkgo.\n\nGinkgoT() is analogous to *testing.T and implements the majority of *testing.T's methods. It can be typically be used a a drop-in replacement with third-party libraries that accept *testing.T through an interface.\n\nGinkgoT() takes an optional offset argument that can be used to get the\ncorrect line number associated with the failure - though you do not need to use this if you call GinkgoHelper() or GinkgoT().Helper() appropriately\n\nGinkgoT() attempts to mimic the behavior of `testing.T` with the exception of the following:\n\n- Error/Errorf: failures in Ginkgo always immediately stop execution and there is no mechanism to log a failure without aborting the test. As such Error/Errorf are equivalent to Fatal/Fatalf.\n- Parallel() is a no-op as Ginkgo's multi-process parallelism model is substantially different from go test's in-process model.\n\nYou can learn more here: https://onsi.github.io/ginkgo/#using-third-party-libraries\n*/\nfunc GinkgoT(optionalOffset ...int) FullGinkgoTInterface {\n\toffset := 1\n\tif len(optionalOffset) > 0 {\n\t\toffset = optionalOffset[0]\n\t}\n\treturn testingtproxy.New(\n\t\tGinkgoWriter,\n\t\tFail,\n\t\tSkip,\n\t\tDeferCleanup,\n\t\tCurrentSpecReport,\n\t\tAddReportEntry,\n\t\tGinkgoRecover,\n\t\tAttachProgressReporter,\n\t\tsuiteConfig.RandomSeed,\n\t\tsuiteConfig.ParallelProcess,\n\t\tsuiteConfig.ParallelTotal,\n\t\treporterConfig.NoColor,\n\t\toffset)\n}\n\n/*\nThe portion of the interface returned by GinkgoT() that maps onto methods in the testing package's T.\n*/\ntype GinkgoTInterface interface {\n\tCleanup(func())\n\tChdir(dir string)\n\tContext() context.Context\n\tSetenv(kev, value string)\n\tError(args ...any)\n\tErrorf(format string, args ...any)\n\tFail()\n\tFailNow()\n\tFailed() bool\n\tFatal(args ...any)\n\tFatalf(format string, args ...any)\n\tHelper()\n\tLog(args ...any)\n\tLogf(format string, args ...any)\n\tName() string\n\tParallel()\n\tSkip(args ...any)\n\tSkipNow()\n\tSkipf(format string, args ...any)\n\tSkipped() bool\n\tTempDir() string\n\tAttr(key, value string)\n\tOutput() io.Writer\n}\n\n/*\nAdditional methods returned by GinkgoT() that provide deeper integration points into Ginkgo\n*/\ntype FullGinkgoTInterface interface {\n\tGinkgoTInterface\n\n\tAddReportEntryVisibilityAlways(name string, args ...any)\n\tAddReportEntryVisibilityFailureOrVerbose(name string, args ...any)\n\tAddReportEntryVisibilityNever(name string, args ...any)\n\n\t//Prints to the GinkgoWriter\n\tPrint(a ...any)\n\tPrintf(format string, a ...any)\n\tPrintln(a ...any)\n\n\t//Provides access to Ginkgo's color formatting, correctly configured to match the color settings specified in the invocation of ginkgo\n\tF(format string, args ...any) string\n\tFi(indentation uint, format string, args ...any) string\n\tFiw(indentation uint, maxWidth uint, format string, args ...any) string\n\n\t//Generates a formatted string version of the current spec's timeline\n\tRenderTimeline() string\n\n\tGinkgoRecover()\n\tDeferCleanup(args ...any)\n\n\tRandomSeed() int64\n\tParallelProcess() int\n\tParallelTotal() int\n\n\tAttachProgressReporter(func() string) func()\n}\n\n/*\nGinkgoTB() implements a wrapper that exactly matches the testing.TB interface.\n\nIn go 1.18 a new private() function was added to the testing.TB interface. Any function which accepts testing.TB as input needs to be passed in something that directly implements testing.TB.\n\nThis wrapper satisfies the testing.TB interface and intended to be used as a drop-in replacement with third party libraries that accept testing.TB.\n\nSimilar to GinkgoT(), GinkgoTB() takes an optional offset argument that can be used to get the\ncorrect line number associated with the failure - though you do not need to use this if you call GinkgoHelper() or GinkgoT().Helper() appropriately\n*/\nfunc GinkgoTB(optionalOffset ...int) *GinkgoTBWrapper {\n\toffset := 2\n\tif len(optionalOffset) > 0 {\n\t\toffset = optionalOffset[0]\n\t}\n\treturn &GinkgoTBWrapper{GinkgoT: GinkgoT(offset)}\n}\n\ntype GinkgoTBWrapper struct {\n\ttesting.TB\n\tGinkgoT FullGinkgoTInterface\n}\n\nfunc (g *GinkgoTBWrapper) Cleanup(f func()) {\n\tg.GinkgoT.Cleanup(f)\n}\nfunc (g *GinkgoTBWrapper) Chdir(dir string) {\n\tg.GinkgoT.Chdir(dir)\n}\nfunc (g *GinkgoTBWrapper) Context() context.Context {\n\treturn g.GinkgoT.Context()\n}\nfunc (g *GinkgoTBWrapper) Error(args ...any) {\n\tg.GinkgoT.Error(args...)\n}\nfunc (g *GinkgoTBWrapper) Errorf(format string, args ...any) {\n\tg.GinkgoT.Errorf(format, args...)\n}\nfunc (g *GinkgoTBWrapper) Fail() {\n\tg.GinkgoT.Fail()\n}\nfunc (g *GinkgoTBWrapper) FailNow() {\n\tg.GinkgoT.FailNow()\n}\nfunc (g *GinkgoTBWrapper) Failed() bool {\n\treturn g.GinkgoT.Failed()\n}\nfunc (g *GinkgoTBWrapper) Fatal(args ...any) {\n\tg.GinkgoT.Fatal(args...)\n}\nfunc (g *GinkgoTBWrapper) Fatalf(format string, args ...any) {\n\tg.GinkgoT.Fatalf(format, args...)\n}\nfunc (g *GinkgoTBWrapper) Helper() {\n\ttypes.MarkAsHelper(1)\n}\nfunc (g *GinkgoTBWrapper) Log(args ...any) {\n\tg.GinkgoT.Log(args...)\n}\nfunc (g *GinkgoTBWrapper) Logf(format string, args ...any) {\n\tg.GinkgoT.Logf(format, args...)\n}\nfunc (g *GinkgoTBWrapper) Name() string {\n\treturn g.GinkgoT.Name()\n}\nfunc (g *GinkgoTBWrapper) Setenv(key, value string) {\n\tg.GinkgoT.Setenv(key, value)\n}\nfunc (g *GinkgoTBWrapper) Skip(args ...any) {\n\tg.GinkgoT.Skip(args...)\n}\nfunc (g *GinkgoTBWrapper) SkipNow() {\n\tg.GinkgoT.SkipNow()\n}\nfunc (g *GinkgoTBWrapper) Skipf(format string, args ...any) {\n\tg.GinkgoT.Skipf(format, args...)\n}\nfunc (g *GinkgoTBWrapper) Skipped() bool {\n\treturn g.GinkgoT.Skipped()\n}\nfunc (g *GinkgoTBWrapper) TempDir() string {\n\treturn g.GinkgoT.TempDir()\n}\nfunc (g *GinkgoTBWrapper) Attr(key, value string) {\n\tg.GinkgoT.Attr(key, value)\n}\nfunc (g *GinkgoTBWrapper) Output() io.Writer {\n\treturn g.GinkgoT.Output()\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/around_node.go",
"content": "package internal\n\nimport (\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc ComputeAroundNodes(specs Specs) Specs {\n\tout := Specs{}\n\tfor _, spec := range specs {\n\t\tnodes := Nodes{}\n\t\tcurrentNestingLevel := 0\n\t\taroundNodes := types.AroundNodes{}\n\t\tnestingLevelIndices := []int{}\n\t\tfor _, node := range spec.Nodes {\n\t\t\tswitch node.NodeType {\n\t\t\tcase types.NodeTypeContainer:\n\t\t\t\tcurrentNestingLevel = node.NestingLevel + 1\n\t\t\t\tnestingLevelIndices = append(nestingLevelIndices, len(aroundNodes))\n\t\t\t\taroundNodes = aroundNodes.Append(node.AroundNodes...)\n\t\t\t\tnodes = append(nodes, node)\n\t\t\tdefault:\n\t\t\t\tif currentNestingLevel > node.NestingLevel {\n\t\t\t\t\tcurrentNestingLevel = node.NestingLevel\n\t\t\t\t\taroundNodes = aroundNodes[:nestingLevelIndices[currentNestingLevel]]\n\t\t\t\t}\n\t\t\t\tnode.AroundNodes = types.AroundNodes{}.Append(aroundNodes...).Append(node.AroundNodes...)\n\t\t\t\tnodes = append(nodes, node)\n\t\t\t}\n\t\t}\n\t\tspec.Nodes = nodes\n\t\tout = append(out, spec)\n\t}\n\treturn out\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/counter.go",
"content": "package internal\n\nfunc MakeIncrementingIndexCounter() func() (int, error) {\n\tidx := -1\n\treturn func() (int, error) {\n\t\tidx += 1\n\t\treturn idx, nil\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/failer.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\t\"sync\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype Failer struct {\n\tlock *sync.Mutex\n\tfailure types.Failure\n\tstate types.SpecState\n}\n\nfunc NewFailer() *Failer {\n\treturn &Failer{\n\t\tlock: &sync.Mutex{},\n\t\tstate: types.SpecStatePassed,\n\t}\n}\n\nfunc (f *Failer) GetState() types.SpecState {\n\tf.lock.Lock()\n\tdefer f.lock.Unlock()\n\treturn f.state\n}\n\nfunc (f *Failer) GetFailure() types.Failure {\n\tf.lock.Lock()\n\tdefer f.lock.Unlock()\n\treturn f.failure\n}\n\nfunc (f *Failer) Panic(location types.CodeLocation, forwardedPanic any) {\n\tf.lock.Lock()\n\tdefer f.lock.Unlock()\n\n\tif f.state == types.SpecStatePassed {\n\t\tf.state = types.SpecStatePanicked\n\t\tf.failure = types.Failure{\n\t\t\tMessage: \"Test Panicked\",\n\t\t\tLocation: location,\n\t\t\tForwardedPanic: fmt.Sprintf(\"%v\", forwardedPanic),\n\t\t}\n\t}\n}\n\nfunc (f *Failer) Fail(message string, location types.CodeLocation) {\n\tf.lock.Lock()\n\tdefer f.lock.Unlock()\n\n\tif f.state == types.SpecStatePassed {\n\t\tf.state = types.SpecStateFailed\n\t\tf.failure = types.Failure{\n\t\t\tMessage: message,\n\t\t\tLocation: location,\n\t\t}\n\t}\n}\n\nfunc (f *Failer) Skip(message string, location types.CodeLocation) {\n\tf.lock.Lock()\n\tdefer f.lock.Unlock()\n\n\tif f.state == types.SpecStatePassed {\n\t\tf.state = types.SpecStateSkipped\n\t\tf.failure = types.Failure{\n\t\t\tMessage: message,\n\t\t\tLocation: location,\n\t\t}\n\t}\n}\n\nfunc (f *Failer) AbortSuite(message string, location types.CodeLocation) {\n\tf.lock.Lock()\n\tdefer f.lock.Unlock()\n\n\tif f.state == types.SpecStatePassed {\n\t\tf.state = types.SpecStateAborted\n\t\tf.failure = types.Failure{\n\t\t\tMessage: message,\n\t\t\tLocation: location,\n\t\t}\n\t}\n}\n\nfunc (f *Failer) Drain() (types.SpecState, types.Failure) {\n\tf.lock.Lock()\n\tdefer f.lock.Unlock()\n\n\tfailure := f.failure\n\toutcome := f.state\n\n\tf.state = types.SpecStatePassed\n\tf.failure = types.Failure{}\n\n\treturn outcome, failure\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/focus.go",
"content": "package internal\n\nimport (\n\t\"regexp\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n/*\nIf a container marked as focus has a descendant that is also marked as focus, Ginkgo's policy is to\nunmark the container's focus. This gives developers a more intuitive experience when debugging specs.\nIt is common to focus a container to just run a subset of specs, then identify the specific specs within the container to focus -\nthis policy allows the developer to simply focus those specific specs and not need to go back and turn the focus off of the container:\n\nAs a common example, consider:\n\n\tFDescribe(\"something to debug\", function() {\n\t\tIt(\"works\", function() {...})\n\t\tIt(\"works\", function() {...})\n\t\tFIt(\"doesn't work\", function() {...})\n\t\tIt(\"works\", function() {...})\n\t})\n\nhere the developer's intent is to focus in on the `\"doesn't work\"` spec and not to run the adjacent specs in the focused `\"something to debug\"` container.\nThe nested policy applied by this function enables this behavior.\n*/\nfunc ApplyNestedFocusPolicyToTree(tree *TreeNode) {\n\tvar walkTree func(tree *TreeNode) bool\n\twalkTree = func(tree *TreeNode) bool {\n\t\tif tree.Node.MarkedPending {\n\t\t\treturn false\n\t\t}\n\t\thasFocusedDescendant := false\n\t\tfor _, child := range tree.Children {\n\t\t\tchildHasFocus := walkTree(child)\n\t\t\thasFocusedDescendant = hasFocusedDescendant || childHasFocus\n\t\t}\n\t\ttree.Node.MarkedFocus = tree.Node.MarkedFocus && !hasFocusedDescendant\n\t\treturn tree.Node.MarkedFocus || hasFocusedDescendant\n\t}\n\n\twalkTree(tree)\n}\n\n/*\nGinkgo supports focussing specs using `FIt`, `FDescribe`, etc. - this is called \"programmatic focus\"\nIt also supports focussing specs using regular expressions on the command line (`-focus=`, `-skip=`) that match against spec text and file filters (`-focus-files=`, `-skip-files=`) that match against code locations for nodes in specs.\n\nWhen both programmatic and file filters are provided their results are ANDed together. If multiple kinds of filters are provided, the file filters run first followed by the regex filters.\n\nThis function sets the `Skip` property on specs by applying Ginkgo's focus policy:\n- If there are no CLI arguments and no programmatic focus, do nothing.\n- If a spec somewhere has programmatic focus skip any specs that have no programmatic focus.\n- If there are CLI arguments parse them and skip any specs that either don't match the focus filters or do match the skip filters.\n\n*Note:* specs with pending nodes are Skipped when created by NewSpec.\n*/\nfunc ApplyFocusToSpecs(specs Specs, description string, suiteLabels Labels, suiteSemVerConstraints SemVerConstraints, suiteComponentSemVerConstraints ComponentSemVerConstraints, suiteConfig types.SuiteConfig) (Specs, bool) {\n\tfocusString := strings.Join(suiteConfig.FocusStrings, \"|\")\n\tskipString := strings.Join(suiteConfig.SkipStrings, \"|\")\n\n\ttype SkipCheck func(spec Spec) bool\n\n\t// by default, skip any specs marked pending\n\tskipChecks := []SkipCheck{func(spec Spec) bool { return spec.Nodes.HasNodeMarkedPending() }}\n\thasProgrammaticFocus := false\n\n\tfor _, spec := range specs {\n\t\tif spec.Nodes.HasNodeMarkedFocus() && !spec.Nodes.HasNodeMarkedPending() {\n\t\t\thasProgrammaticFocus = true\n\t\t\tbreak\n\t\t}\n\t}\n\n\tif hasProgrammaticFocus {\n\t\tskipChecks = append(skipChecks, func(spec Spec) bool { return !spec.Nodes.HasNodeMarkedFocus() })\n\t}\n\n\tif suiteConfig.LabelFilter != \"\" {\n\t\tlabelFilter, _ := types.ParseLabelFilter(suiteConfig.LabelFilter)\n\t\tskipChecks = append(skipChecks, func(spec Spec) bool {\n\t\t\treturn !labelFilter(UnionOfLabels(suiteLabels, spec.Nodes.UnionOfLabels()))\n\t\t})\n\t}\n\n\tif suiteConfig.SemVerFilter != \"\" {\n\t\tsemVerFilter, _ := types.ParseSemVerFilter(suiteConfig.SemVerFilter)\n\t\tskipChecks = append(skipChecks, func(spec Spec) bool {\n\t\t\tnoRun := false\n\n\t\t\t// non-component-specific constraints\n\t\t\tconstraints := UnionOfSemVerConstraints(suiteSemVerConstraints, spec.Nodes.UnionOfSemVerConstraints())\n\t\t\tif len(constraints) != 0 && semVerFilter(\"\", constraints) == false {\n\t\t\t\tnoRun = true\n\t\t\t}\n\n\t\t\t// component-specific constraints\n\t\t\tcomponentConstraints := UnionOfComponentSemVerConstraints(suiteComponentSemVerConstraints, spec.Nodes.UnionOfComponentSemVerConstraints())\n\t\t\tfor component, constraints := range componentConstraints {\n\t\t\t\tif semVerFilter(component, constraints) == false {\n\t\t\t\t\tnoRun = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn noRun\n\t\t})\n\t}\n\n\tif len(suiteConfig.FocusFiles) > 0 {\n\t\tfocusFilters, _ := types.ParseFileFilters(suiteConfig.FocusFiles)\n\t\tskipChecks = append(skipChecks, func(spec Spec) bool { return !focusFilters.Matches(spec.Nodes.CodeLocations()) })\n\t}\n\n\tif len(suiteConfig.SkipFiles) > 0 {\n\t\tskipFilters, _ := types.ParseFileFilters(suiteConfig.SkipFiles)\n\t\tskipChecks = append(skipChecks, func(spec Spec) bool { return skipFilters.Matches(spec.Nodes.CodeLocations()) })\n\t}\n\n\tif focusString != \"\" {\n\t\t// skip specs that don't match the focus string\n\t\tre := regexp.MustCompile(focusString)\n\t\tskipChecks = append(skipChecks, func(spec Spec) bool { return !re.MatchString(description + \" \" + spec.Text()) })\n\t}\n\n\tif skipString != \"\" {\n\t\t// skip specs that match the skip string\n\t\tre := regexp.MustCompile(skipString)\n\t\tskipChecks = append(skipChecks, func(spec Spec) bool { return re.MatchString(description + \" \" + spec.Text()) })\n\t}\n\n\t// skip specs if shouldSkip() is true. note that we do nothing if shouldSkip() is false to avoid overwriting skip status established by the node's pending status\n\tprocessedSpecs := Specs{}\n\tfor _, spec := range specs {\n\t\tfor _, skipCheck := range skipChecks {\n\t\t\tif skipCheck(spec) {\n\t\t\t\tspec.Skip = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tprocessedSpecs = append(processedSpecs, spec)\n\t}\n\n\treturn processedSpecs, hasProgrammaticFocus\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/global/init.go",
"content": "package global\n\nimport (\n\t\"github.com/onsi/ginkgo/v2/internal\"\n)\n\nvar Suite *internal.Suite\nvar Failer *internal.Failer\nvar backupSuite *internal.Suite\n\nfunc init() {\n\tInitializeGlobals()\n}\n\nfunc InitializeGlobals() {\n\tFailer = internal.NewFailer()\n\tSuite = internal.NewSuite()\n}\n\nfunc PushClone() error {\n\tvar err error\n\tbackupSuite, err = Suite.Clone()\n\treturn err\n}\n\nfunc PopClone() {\n\tSuite = backupSuite\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/group.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype runOncePair struct {\n\t//nodeId should only run once...\n\tnodeID uint\n\tnodeType types.NodeType\n\t//...for specs in a hierarchy that includes this context\n\tcontainerID uint\n}\n\nfunc (pair runOncePair) isZero() bool {\n\treturn pair.nodeID == 0\n}\n\nfunc runOncePairForNode(node Node, containerID uint) runOncePair {\n\treturn runOncePair{\n\t\tnodeID: node.ID,\n\t\tnodeType: node.NodeType,\n\t\tcontainerID: containerID,\n\t}\n}\n\ntype runOncePairs []runOncePair\n\nfunc runOncePairsForSpec(spec Spec) runOncePairs {\n\tpairs := runOncePairs{}\n\n\tcontainers := spec.Nodes.WithType(types.NodeTypeContainer)\n\tfor _, node := range spec.Nodes {\n\t\tif node.NodeType.Is(types.NodeTypeBeforeAll | types.NodeTypeAfterAll) {\n\t\t\tpairs = append(pairs, runOncePairForNode(node, containers.FirstWithNestingLevel(node.NestingLevel-1).ID))\n\t\t} else if node.NodeType.Is(types.NodeTypeBeforeEach|types.NodeTypeJustBeforeEach|types.NodeTypeAfterEach|types.NodeTypeJustAfterEach) && node.MarkedOncePerOrdered {\n\t\t\tpassedIntoAnOrderedContainer := false\n\t\t\tfirstOrderedContainerDeeperThanNode := containers.FirstSatisfying(func(container Node) bool {\n\t\t\t\tpassedIntoAnOrderedContainer = passedIntoAnOrderedContainer || container.MarkedOrdered\n\t\t\t\treturn container.NestingLevel >= node.NestingLevel && passedIntoAnOrderedContainer\n\t\t\t})\n\t\t\tif firstOrderedContainerDeeperThanNode.IsZero() {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tpairs = append(pairs, runOncePairForNode(node, firstOrderedContainerDeeperThanNode.ID))\n\t\t}\n\t}\n\n\treturn pairs\n}\n\nfunc (pairs runOncePairs) runOncePairFor(nodeID uint) runOncePair {\n\tfor i := range pairs {\n\t\tif pairs[i].nodeID == nodeID {\n\t\t\treturn pairs[i]\n\t\t}\n\t}\n\treturn runOncePair{}\n}\n\nfunc (pairs runOncePairs) hasRunOncePair(pair runOncePair) bool {\n\tfor i := range pairs {\n\t\tif pairs[i] == pair {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (pairs runOncePairs) withType(nodeTypes types.NodeType) runOncePairs {\n\tcount := 0\n\tfor i := range pairs {\n\t\tif pairs[i].nodeType.Is(nodeTypes) {\n\t\t\tcount++\n\t\t}\n\t}\n\n\tout, j := make(runOncePairs, count), 0\n\tfor i := range pairs {\n\t\tif pairs[i].nodeType.Is(nodeTypes) {\n\t\t\tout[j] = pairs[i]\n\t\t\tj++\n\t\t}\n\t}\n\treturn out\n}\n\ntype group struct {\n\tsuite *Suite\n\tspecs Specs\n\trunOncePairs map[uint]runOncePairs\n\trunOnceTracker map[runOncePair]types.SpecState\n\n\tsucceeded bool\n\tfailedInARunOnceBefore bool\n\tcontinueOnFailure bool\n}\n\nfunc newGroup(suite *Suite) *group {\n\treturn &group{\n\t\tsuite: suite,\n\t\trunOncePairs: map[uint]runOncePairs{},\n\t\trunOnceTracker: map[runOncePair]types.SpecState{},\n\t\tsucceeded: true,\n\t\tfailedInARunOnceBefore: false,\n\t\tcontinueOnFailure: false,\n\t}\n}\n\n// initialReportForSpec constructs a new SpecReport right before running the spec.\nfunc (g *group) initialReportForSpec(spec Spec) types.SpecReport {\n\treturn types.SpecReport{\n\t\tContainerHierarchyTexts: spec.Nodes.WithType(types.NodeTypeContainer).Texts(),\n\t\tContainerHierarchyLocations: spec.Nodes.WithType(types.NodeTypeContainer).CodeLocations(),\n\t\tContainerHierarchyLabels: spec.Nodes.WithType(types.NodeTypeContainer).Labels(),\n\t\tContainerHierarchySemVerConstraints: spec.Nodes.WithType(types.NodeTypeContainer).SemVerConstraints(),\n\t\tContainerHierarchyComponentSemVerConstraints: spec.Nodes.WithType(types.NodeTypeContainer).ComponentSemVerConstraints(),\n\t\tLeafNodeLocation: spec.FirstNodeWithType(types.NodeTypeIt).CodeLocation,\n\t\tLeafNodeType: types.NodeTypeIt,\n\t\tLeafNodeText: spec.FirstNodeWithType(types.NodeTypeIt).Text,\n\t\tLeafNodeLabels: []string(spec.FirstNodeWithType(types.NodeTypeIt).Labels),\n\t\tLeafNodeSemVerConstraints: []string(spec.FirstNodeWithType(types.NodeTypeIt).SemVerConstraints),\n\t\tLeafNodeComponentSemVerConstraints: map[string][]string(spec.FirstNodeWithType(types.NodeTypeIt).ComponentSemVerConstraints),\n\t\tParallelProcess: g.suite.config.ParallelProcess,\n\t\tRunningInParallel: g.suite.isRunningInParallel(),\n\t\tIsSerial: spec.Nodes.HasNodeMarkedSerial(),\n\t\tIsInOrderedContainer: !spec.Nodes.FirstNodeMarkedOrdered().IsZero(),\n\t\tMaxFlakeAttempts: spec.Nodes.GetMaxFlakeAttempts(),\n\t\tMaxMustPassRepeatedly: spec.Nodes.GetMaxMustPassRepeatedly(),\n\t\tSpecPriority: spec.Nodes.GetSpecPriority(),\n\t}\n}\n\n// constructionNodeReportForTreeNode constructs a new SpecReport right before invoking the body\n// of a container node during construction of the full tree.\nfunc constructionNodeReportForTreeNode(node *TreeNode) *types.ConstructionNodeReport {\n\tvar report types.ConstructionNodeReport\n\t// Walk up the tree and set attributes accordingly.\n\taddNodeToReportForNode(&report, node)\n\treturn &report\n}\n\n// addNodeToReportForNode is conceptually similar to initialReportForSpec and therefore placed here\n// although it doesn't do anything with a group.\nfunc addNodeToReportForNode(report *types.ConstructionNodeReport, node *TreeNode) {\n\tif node.Parent != nil {\n\t\t// First add the parent node, then the current one.\n\t\taddNodeToReportForNode(report, node.Parent)\n\t}\n\treport.ContainerHierarchyTexts = append(report.ContainerHierarchyTexts, node.Node.Text)\n\treport.ContainerHierarchyLocations = append(report.ContainerHierarchyLocations, node.Node.CodeLocation)\n\treport.ContainerHierarchyLabels = append(report.ContainerHierarchyLabels, node.Node.Labels)\n\treport.ContainerHierarchySemVerConstraints = append(report.ContainerHierarchySemVerConstraints, node.Node.SemVerConstraints)\n\treport.ContainerHierarchyComponentSemVerConstraints = append(report.ContainerHierarchyComponentSemVerConstraints, node.Node.ComponentSemVerConstraints)\n\tif node.Node.MarkedSerial {\n\t\treport.IsSerial = true\n\t}\n\tif node.Node.MarkedOrdered {\n\t\treport.IsInOrderedContainer = true\n\t}\n}\n\nfunc (g *group) evaluateSkipStatus(spec Spec) (types.SpecState, types.Failure) {\n\tif spec.Nodes.HasNodeMarkedPending() {\n\t\treturn types.SpecStatePending, types.Failure{}\n\t}\n\tif spec.Skip {\n\t\treturn types.SpecStateSkipped, types.Failure{}\n\t}\n\tif g.suite.interruptHandler.Status().Interrupted() || g.suite.skipAll {\n\t\treturn types.SpecStateSkipped, types.Failure{}\n\t}\n\tif !g.suite.deadline.IsZero() && g.suite.deadline.Before(time.Now()) {\n\t\treturn types.SpecStateSkipped, types.Failure{}\n\t}\n\tif !g.succeeded && !g.continueOnFailure {\n\t\treturn types.SpecStateSkipped, g.suite.failureForLeafNodeWithMessage(spec.FirstNodeWithType(types.NodeTypeIt),\n\t\t\t\"Spec skipped because an earlier spec in an ordered container failed\")\n\t}\n\tif g.failedInARunOnceBefore && g.continueOnFailure {\n\t\treturn types.SpecStateSkipped, g.suite.failureForLeafNodeWithMessage(spec.FirstNodeWithType(types.NodeTypeIt),\n\t\t\t\"Spec skipped because a BeforeAll node failed\")\n\t}\n\tbeforeOncePairs := g.runOncePairs[spec.SubjectID()].withType(types.NodeTypeBeforeAll | types.NodeTypeBeforeEach | types.NodeTypeJustBeforeEach)\n\tfor _, pair := range beforeOncePairs {\n\t\tif g.runOnceTracker[pair].Is(types.SpecStateSkipped) {\n\t\t\treturn types.SpecStateSkipped, g.suite.failureForLeafNodeWithMessage(spec.FirstNodeWithType(types.NodeTypeIt),\n\t\t\t\tfmt.Sprintf(\"Spec skipped because Skip() was called in %s\", pair.nodeType))\n\t\t}\n\t}\n\tif g.suite.config.DryRun {\n\t\treturn types.SpecStatePassed, types.Failure{}\n\t}\n\treturn g.suite.currentSpecReport.State, g.suite.currentSpecReport.Failure\n}\n\nfunc (g *group) isLastSpecWithPair(specID uint, pair runOncePair) bool {\n\tlastSpecID := uint(0)\n\tfor idx := range g.specs {\n\t\tif g.specs[idx].Skip {\n\t\t\tcontinue\n\t\t}\n\t\tsID := g.specs[idx].SubjectID()\n\t\tif g.runOncePairs[sID].hasRunOncePair(pair) {\n\t\t\tlastSpecID = sID\n\t\t}\n\t}\n\treturn lastSpecID == specID\n}\n\nfunc (g *group) attemptSpec(isFinalAttempt bool, spec Spec) bool {\n\tfailedInARunOnceBefore := false\n\tpairs := g.runOncePairs[spec.SubjectID()]\n\n\tnodes := spec.Nodes.WithType(types.NodeTypeBeforeAll)\n\tnodes = append(nodes, spec.Nodes.WithType(types.NodeTypeBeforeEach)...).SortedByAscendingNestingLevel()\n\tnodes = append(nodes, spec.Nodes.WithType(types.NodeTypeJustBeforeEach).SortedByAscendingNestingLevel()...)\n\tnodes = append(nodes, spec.Nodes.FirstNodeWithType(types.NodeTypeIt))\n\tterminatingNode, terminatingPair := Node{}, runOncePair{}\n\n\tdeadline := time.Time{}\n\tif spec.SpecTimeout() > 0 {\n\t\tdeadline = time.Now().Add(spec.SpecTimeout())\n\t}\n\n\tfor _, node := range nodes {\n\t\toncePair := pairs.runOncePairFor(node.ID)\n\t\tif !oncePair.isZero() && g.runOnceTracker[oncePair].Is(types.SpecStatePassed) {\n\t\t\tcontinue\n\t\t}\n\t\tg.suite.currentSpecReport.State, g.suite.currentSpecReport.Failure = g.suite.runNode(node, deadline, spec.Nodes.BestTextFor(node))\n\t\tg.suite.currentSpecReport.RunTime = time.Since(g.suite.currentSpecReport.StartTime)\n\t\tif !oncePair.isZero() {\n\t\t\tg.runOnceTracker[oncePair] = g.suite.currentSpecReport.State\n\t\t}\n\t\tif g.suite.currentSpecReport.State != types.SpecStatePassed {\n\t\t\tterminatingNode, terminatingPair = node, oncePair\n\t\t\tfailedInARunOnceBefore = !terminatingPair.isZero()\n\t\t\tbreak\n\t\t}\n\t}\n\n\tafterNodeWasRun := map[uint]bool{}\n\tincludeDeferCleanups := false\n\tfor {\n\t\tnodes := spec.Nodes.WithType(types.NodeTypeAfterEach)\n\t\tnodes = append(nodes, spec.Nodes.WithType(types.NodeTypeAfterAll)...).SortedByDescendingNestingLevel()\n\t\tnodes = append(spec.Nodes.WithType(types.NodeTypeJustAfterEach).SortedByDescendingNestingLevel(), nodes...)\n\t\tif !terminatingNode.IsZero() {\n\t\t\tnodes = nodes.WithinNestingLevel(terminatingNode.NestingLevel)\n\t\t}\n\t\tif includeDeferCleanups {\n\t\t\tnodes = append(nodes, g.suite.cleanupNodes.WithType(types.NodeTypeCleanupAfterEach).Reverse()...)\n\t\t\tnodes = append(nodes, g.suite.cleanupNodes.WithType(types.NodeTypeCleanupAfterAll).Reverse()...)\n\t\t}\n\t\tnodes = nodes.Filter(func(node Node) bool {\n\t\t\tif afterNodeWasRun[node.ID] {\n\t\t\t\t//this node has already been run on this attempt, don't rerun it\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tvar pair runOncePair\n\t\t\tswitch node.NodeType {\n\t\t\tcase types.NodeTypeCleanupAfterEach, types.NodeTypeCleanupAfterAll:\n\t\t\t\t// check if we were generated in an AfterNode that has already run\n\t\t\t\tif afterNodeWasRun[node.NodeIDWhereCleanupWasGenerated] {\n\t\t\t\t\treturn true // we were, so we should definitely run this cleanup now\n\t\t\t\t}\n\t\t\t\t// looks like this cleanup nodes was generated by a before node or it.\n\t\t\t\t// the run-once status of a cleanup node is governed by the run-once status of its generator\n\t\t\t\tpair = pairs.runOncePairFor(node.NodeIDWhereCleanupWasGenerated)\n\t\t\tdefault:\n\t\t\t\tpair = pairs.runOncePairFor(node.ID)\n\t\t\t}\n\t\t\tif pair.isZero() {\n\t\t\t\t// this node is not governed by any run-once policy, we should run it\n\t\t\t\treturn true\n\t\t\t}\n\t\t\t// it's our last chance to run if we're the last spec for our oncePair\n\t\t\tisLastSpecWithPair := g.isLastSpecWithPair(spec.SubjectID(), pair)\n\n\t\t\tswitch g.suite.currentSpecReport.State {\n\t\t\tcase types.SpecStatePassed: //this attempt is passing...\n\t\t\t\treturn isLastSpecWithPair //...we should run-once if we'this is our last chance\n\t\t\tcase types.SpecStateSkipped: //the spec was skipped by the user...\n\t\t\t\tif isLastSpecWithPair {\n\t\t\t\t\treturn true //...we're the last spec, so we should run the AfterNode\n\t\t\t\t}\n\t\t\t\tif !terminatingPair.isZero() && terminatingNode.NestingLevel == node.NestingLevel {\n\t\t\t\t\treturn true //...or, a run-once node at our nesting level was skipped which means this is our last chance to run\n\t\t\t\t}\n\t\t\tcase types.SpecStateFailed, types.SpecStatePanicked, types.SpecStateTimedout: // the spec has failed...\n\t\t\t\tif isFinalAttempt {\n\t\t\t\t\tif g.continueOnFailure {\n\t\t\t\t\t\treturn isLastSpecWithPair || failedInARunOnceBefore //...we're configured to continue on failures - so we should only run if we're the last spec for this pair or if we failed in a runOnceBefore (which means we _are_ the last spec to run)\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn true //...this was the last attempt and continueOnFailure is false therefore we are the last spec to run and so the AfterNode should run\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif !terminatingPair.isZero() { // ...and it failed in a run-once. which will be running again\n\t\t\t\t\tif node.NodeType.Is(types.NodeTypeCleanupAfterEach | types.NodeTypeCleanupAfterAll) {\n\t\t\t\t\t\treturn terminatingNode.ID == node.NodeIDWhereCleanupWasGenerated // we should run this node if we're a clean-up generated by it\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn terminatingNode.NestingLevel == node.NestingLevel // ...or if we're at the same nesting level\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\tcase types.SpecStateInterrupted, types.SpecStateAborted: // ...we've been interrupted and/or aborted\n\t\t\t\treturn true //...that means the test run is over and we should clean up the stack. Run the AfterNode\n\t\t\t}\n\t\t\treturn false\n\t\t})\n\n\t\tif len(nodes) == 0 && includeDeferCleanups {\n\t\t\tbreak\n\t\t}\n\n\t\tfor _, node := range nodes {\n\t\t\tafterNodeWasRun[node.ID] = true\n\t\t\tstate, failure := g.suite.runNode(node, deadline, spec.Nodes.BestTextFor(node))\n\t\t\tg.suite.currentSpecReport.RunTime = time.Since(g.suite.currentSpecReport.StartTime)\n\t\t\tif g.suite.currentSpecReport.State == types.SpecStatePassed || state == types.SpecStateAborted {\n\t\t\t\tg.suite.currentSpecReport.State = state\n\t\t\t\tg.suite.currentSpecReport.Failure = failure\n\t\t\t} else if state.Is(types.SpecStateFailureStates) {\n\t\t\t\tg.suite.currentSpecReport.AdditionalFailures = append(g.suite.currentSpecReport.AdditionalFailures, types.AdditionalFailure{State: state, Failure: failure})\n\t\t\t}\n\t\t}\n\t\tincludeDeferCleanups = true\n\t}\n\n\treturn failedInARunOnceBefore\n}\n\nfunc (g *group) run(specs Specs) {\n\tg.specs = specs\n\tg.continueOnFailure = specs[0].Nodes.FirstNodeMarkedOrdered().MarkedContinueOnFailure\n\tfor _, spec := range g.specs {\n\t\tg.runOncePairs[spec.SubjectID()] = runOncePairsForSpec(spec)\n\t}\n\n\tfor _, spec := range g.specs {\n\t\tg.suite.selectiveLock.Lock()\n\t\tg.suite.currentSpecReport = g.initialReportForSpec(spec)\n\t\tg.suite.selectiveLock.Unlock()\n\n\t\tg.suite.currentSpecReport.State, g.suite.currentSpecReport.Failure = g.evaluateSkipStatus(spec)\n\t\tg.suite.reporter.WillRun(g.suite.currentSpecReport)\n\t\tg.suite.reportEach(spec, types.NodeTypeReportBeforeEach)\n\n\t\tskip := g.suite.config.DryRun || g.suite.currentSpecReport.State.Is(types.SpecStateFailureStates|types.SpecStateSkipped|types.SpecStatePending)\n\n\t\tg.suite.currentSpecReport.StartTime = time.Now()\n\t\tfailedInARunOnceBefore := false\n\t\tif !skip {\n\t\t\tvar maxAttempts = 1\n\n\t\t\tif g.suite.config.MustPassRepeatedly > 0 {\n\t\t\t\tmaxAttempts = g.suite.config.MustPassRepeatedly\n\t\t\t\tg.suite.currentSpecReport.MaxMustPassRepeatedly = maxAttempts\n\t\t\t} else if g.suite.currentSpecReport.MaxMustPassRepeatedly > 0 {\n\t\t\t\tmaxAttempts = max(1, spec.MustPassRepeatedly())\n\t\t\t} else if g.suite.config.FlakeAttempts > 0 {\n\t\t\t\tmaxAttempts = g.suite.config.FlakeAttempts\n\t\t\t\tg.suite.currentSpecReport.MaxFlakeAttempts = maxAttempts\n\t\t\t} else if g.suite.currentSpecReport.MaxFlakeAttempts > 0 {\n\t\t\t\tmaxAttempts = max(1, spec.FlakeAttempts())\n\t\t\t}\n\n\t\t\tfor attempt := 0; attempt < maxAttempts; attempt++ {\n\t\t\t\tg.suite.currentSpecReport.NumAttempts = attempt + 1\n\t\t\t\tg.suite.writer.Truncate()\n\t\t\t\tg.suite.outputInterceptor.StartInterceptingOutput()\n\t\t\t\tif attempt > 0 {\n\t\t\t\t\tif g.suite.currentSpecReport.MaxMustPassRepeatedly > 0 {\n\t\t\t\t\t\tg.suite.handleSpecEvent(types.SpecEvent{SpecEventType: types.SpecEventSpecRepeat, Attempt: attempt})\n\t\t\t\t\t}\n\t\t\t\t\tif g.suite.currentSpecReport.MaxFlakeAttempts > 0 {\n\t\t\t\t\t\tg.suite.handleSpecEvent(types.SpecEvent{SpecEventType: types.SpecEventSpecRetry, Attempt: attempt})\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tfailedInARunOnceBefore = g.attemptSpec(attempt == maxAttempts-1, spec)\n\n\t\t\t\tg.suite.currentSpecReport.EndTime = time.Now()\n\t\t\t\tg.suite.currentSpecReport.RunTime = g.suite.currentSpecReport.EndTime.Sub(g.suite.currentSpecReport.StartTime)\n\t\t\t\tg.suite.currentSpecReport.CapturedGinkgoWriterOutput += string(g.suite.writer.Bytes())\n\t\t\t\tg.suite.currentSpecReport.CapturedStdOutErr += g.suite.outputInterceptor.StopInterceptingAndReturnOutput()\n\n\t\t\t\tif g.suite.currentSpecReport.MaxMustPassRepeatedly > 0 {\n\t\t\t\t\tif g.suite.currentSpecReport.State.Is(types.SpecStateFailureStates | types.SpecStateSkipped) {\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tif g.suite.currentSpecReport.MaxFlakeAttempts > 0 {\n\t\t\t\t\tif g.suite.currentSpecReport.State.Is(types.SpecStatePassed | types.SpecStateSkipped | types.SpecStateAborted | types.SpecStateInterrupted) {\n\t\t\t\t\t\tbreak\n\t\t\t\t\t} else if attempt < maxAttempts-1 {\n\t\t\t\t\t\taf := types.AdditionalFailure{State: g.suite.currentSpecReport.State, Failure: g.suite.currentSpecReport.Failure}\n\t\t\t\t\t\taf.Failure.Message = fmt.Sprintf(\"Failure recorded during attempt %d:\\n%s\", attempt+1, af.Failure.Message)\n\t\t\t\t\t\tg.suite.currentSpecReport.AdditionalFailures = append(g.suite.currentSpecReport.AdditionalFailures, af)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tg.suite.reportEach(spec, types.NodeTypeReportAfterEach)\n\t\tg.suite.processCurrentSpecReport()\n\t\tif g.suite.currentSpecReport.State.Is(types.SpecStateFailureStates) {\n\t\t\tg.succeeded = false\n\t\t\tg.failedInARunOnceBefore = g.failedInARunOnceBefore || failedInARunOnceBefore\n\t\t}\n\t\tg.suite.selectiveLock.Lock()\n\t\tg.suite.currentSpecReport = types.SpecReport{}\n\t\tg.suite.selectiveLock.Unlock()\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/interrupt_handler/interrupt_handler.go",
"content": "package interrupt_handler\n\nimport (\n\t\"os\"\n\t\"os/signal\"\n\t\"sync\"\n\t\"syscall\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/internal/parallel_support\"\n)\n\nvar ABORT_POLLING_INTERVAL = 500 * time.Millisecond\n\ntype InterruptCause uint\n\nconst (\n\tInterruptCauseInvalid InterruptCause = iota\n\tInterruptCauseSignal\n\tInterruptCauseAbortByOtherProcess\n)\n\ntype InterruptLevel uint\n\nconst (\n\tInterruptLevelUninterrupted InterruptLevel = iota\n\tInterruptLevelCleanupAndReport\n\tInterruptLevelReportOnly\n\tInterruptLevelBailOut\n)\n\nfunc (ic InterruptCause) String() string {\n\tswitch ic {\n\tcase InterruptCauseSignal:\n\t\treturn \"Interrupted by User\"\n\tcase InterruptCauseAbortByOtherProcess:\n\t\treturn \"Interrupted by Other Ginkgo Process\"\n\t}\n\treturn \"INVALID_INTERRUPT_CAUSE\"\n}\n\ntype InterruptStatus struct {\n\tChannel chan any\n\tLevel InterruptLevel\n\tCause InterruptCause\n}\n\nfunc (s InterruptStatus) Interrupted() bool {\n\treturn s.Level != InterruptLevelUninterrupted\n}\n\nfunc (s InterruptStatus) Message() string {\n\treturn s.Cause.String()\n}\n\nfunc (s InterruptStatus) ShouldIncludeProgressReport() bool {\n\treturn s.Cause != InterruptCauseAbortByOtherProcess\n}\n\ntype InterruptHandlerInterface interface {\n\tStatus() InterruptStatus\n}\n\ntype InterruptHandler struct {\n\tc chan any\n\tlock *sync.Mutex\n\tlevel InterruptLevel\n\tcause InterruptCause\n\tclient parallel_support.Client\n\tstop chan any\n\tsignals []os.Signal\n\trequestAbortCheck chan any\n}\n\nfunc NewInterruptHandler(client parallel_support.Client, signals ...os.Signal) *InterruptHandler {\n\tif len(signals) == 0 {\n\t\tsignals = []os.Signal{os.Interrupt, syscall.SIGTERM}\n\t}\n\thandler := &InterruptHandler{\n\t\tc: make(chan any),\n\t\tlock: &sync.Mutex{},\n\t\tstop: make(chan any),\n\t\trequestAbortCheck: make(chan any),\n\t\tclient: client,\n\t\tsignals: signals,\n\t}\n\thandler.registerForInterrupts()\n\treturn handler\n}\n\nfunc (handler *InterruptHandler) Stop() {\n\tclose(handler.stop)\n}\n\nfunc (handler *InterruptHandler) registerForInterrupts() {\n\t// os signal handling\n\tsignalChannel := make(chan os.Signal, 1)\n\tsignal.Notify(signalChannel, handler.signals...)\n\n\t// cross-process abort handling\n\tvar abortChannel chan any\n\tif handler.client != nil {\n\t\tabortChannel = make(chan any)\n\t\tgo func() {\n\t\t\tpollTicker := time.NewTicker(ABORT_POLLING_INTERVAL)\n\t\t\tfor {\n\t\t\t\tselect {\n\t\t\t\tcase <-pollTicker.C:\n\t\t\t\t\tif handler.client.ShouldAbort() {\n\t\t\t\t\t\tclose(abortChannel)\n\t\t\t\t\t\tpollTicker.Stop()\n\t\t\t\t\t\treturn\n\t\t\t\t\t}\n\t\t\t\tcase <-handler.requestAbortCheck:\n\t\t\t\t\tif handler.client.ShouldAbort() {\n\t\t\t\t\t\tclose(abortChannel)\n\t\t\t\t\t\tpollTicker.Stop()\n\t\t\t\t\t\treturn\n\t\t\t\t\t}\n\t\t\t\tcase <-handler.stop:\n\t\t\t\t\tpollTicker.Stop()\n\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\t}\n\n\tgo func(abortChannel chan any) {\n\t\tvar interruptCause InterruptCause\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase <-signalChannel:\n\t\t\t\tinterruptCause = InterruptCauseSignal\n\t\t\tcase <-abortChannel:\n\t\t\t\tinterruptCause = InterruptCauseAbortByOtherProcess\n\t\t\tcase <-handler.stop:\n\t\t\t\tsignal.Stop(signalChannel)\n\t\t\t\treturn\n\t\t\t}\n\t\t\tabortChannel = nil\n\n\t\t\thandler.lock.Lock()\n\t\t\toldLevel := handler.level\n\t\t\thandler.cause = interruptCause\n\t\t\tif handler.level == InterruptLevelUninterrupted {\n\t\t\t\thandler.level = InterruptLevelCleanupAndReport\n\t\t\t} else if handler.level == InterruptLevelCleanupAndReport {\n\t\t\t\thandler.level = InterruptLevelReportOnly\n\t\t\t} else if handler.level == InterruptLevelReportOnly {\n\t\t\t\thandler.level = InterruptLevelBailOut\n\t\t\t}\n\t\t\tif handler.level != oldLevel {\n\t\t\t\tclose(handler.c)\n\t\t\t\thandler.c = make(chan any)\n\t\t\t}\n\t\t\thandler.lock.Unlock()\n\t\t}\n\t}(abortChannel)\n}\n\nfunc (handler *InterruptHandler) Status() InterruptStatus {\n\thandler.lock.Lock()\n\tstatus := InterruptStatus{\n\t\tLevel: handler.level,\n\t\tChannel: handler.c,\n\t\tCause: handler.cause,\n\t}\n\thandler.lock.Unlock()\n\n\tif handler.client != nil && handler.client.ShouldAbort() && !status.Interrupted() {\n\t\tclose(handler.requestAbortCheck)\n\t\t<-status.Channel\n\t\treturn handler.Status()\n\t}\n\n\treturn status\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/interrupt_handler/sigquit_swallower_unix.go",
"content": "//go:build freebsd || openbsd || netbsd || dragonfly || darwin || linux || solaris\n// +build freebsd openbsd netbsd dragonfly darwin linux solaris\n\npackage interrupt_handler\n\nimport (\n\t\"os\"\n\t\"os/signal\"\n\t\"syscall\"\n)\n\nfunc SwallowSigQuit() {\n\tc := make(chan os.Signal, 1024)\n\tsignal.Notify(c, syscall.SIGQUIT)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/interrupt_handler/sigquit_swallower_windows.go",
"content": "//go:build windows\n// +build windows\n\npackage interrupt_handler\n\nfunc SwallowSigQuit() {\n\t//noop\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/node.go",
"content": "package internal\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"reflect\"\n\t\"slices\"\n\t\"sort\"\n\t\"sync\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nvar _global_node_id_counter = uint(0)\nvar _global_id_mutex = &sync.Mutex{}\n\nfunc UniqueNodeID() uint {\n\t// There's a reace in the internal integration tests if we don't make\n\t// accessing _global_node_id_counter safe across goroutines.\n\t_global_id_mutex.Lock()\n\tdefer _global_id_mutex.Unlock()\n\t_global_node_id_counter += 1\n\treturn _global_node_id_counter\n}\n\ntype Node struct {\n\tID uint\n\tNodeType types.NodeType\n\n\tText string\n\tBody func(SpecContext)\n\tCodeLocation types.CodeLocation\n\tNestingLevel int\n\tHasContext bool\n\n\tSynchronizedBeforeSuiteProc1Body func(SpecContext) []byte\n\tSynchronizedBeforeSuiteProc1BodyHasContext bool\n\tSynchronizedBeforeSuiteAllProcsBody func(SpecContext, []byte)\n\tSynchronizedBeforeSuiteAllProcsBodyHasContext bool\n\n\tSynchronizedAfterSuiteAllProcsBody func(SpecContext)\n\tSynchronizedAfterSuiteAllProcsBodyHasContext bool\n\tSynchronizedAfterSuiteProc1Body func(SpecContext)\n\tSynchronizedAfterSuiteProc1BodyHasContext bool\n\n\tReportEachBody func(SpecContext, types.SpecReport)\n\tReportSuiteBody func(SpecContext, types.Report)\n\n\tMarkedFocus bool\n\tMarkedPending bool\n\tMarkedSerial bool\n\tMarkedOrdered bool\n\tMarkedContinueOnFailure bool\n\tMarkedOncePerOrdered bool\n\tFlakeAttempts int\n\tMustPassRepeatedly int\n\tLabels Labels\n\tSemVerConstraints SemVerConstraints\n\tComponentSemVerConstraints ComponentSemVerConstraints\n\tPollProgressAfter time.Duration\n\tPollProgressInterval time.Duration\n\tNodeTimeout time.Duration\n\tSpecTimeout time.Duration\n\tGracePeriod time.Duration\n\tAroundNodes types.AroundNodes\n\tHasExplicitlySetSpecPriority bool\n\tSpecPriority int\n\n\tNodeIDWhereCleanupWasGenerated uint\n}\n\n// Decoration Types\ntype focusType bool\ntype pendingType bool\ntype serialType bool\ntype orderedType bool\ntype continueOnFailureType bool\ntype honorsOrderedType bool\ntype suppressProgressReporting bool\n\nconst Focus = focusType(true)\nconst Pending = pendingType(true)\nconst Serial = serialType(true)\nconst Ordered = orderedType(true)\nconst ContinueOnFailure = continueOnFailureType(true)\nconst OncePerOrdered = honorsOrderedType(true)\nconst SuppressProgressReporting = suppressProgressReporting(true)\n\ntype FlakeAttempts uint\ntype MustPassRepeatedly uint\ntype Offset uint\ntype Done chan<- any // Deprecated Done Channel for asynchronous testing\ntype PollProgressInterval time.Duration\ntype PollProgressAfter time.Duration\ntype NodeTimeout time.Duration\ntype SpecTimeout time.Duration\ntype GracePeriod time.Duration\ntype SpecPriority int\n\ntype Labels []string\n\nfunc (l Labels) MatchesLabelFilter(query string) bool {\n\treturn types.MustParseLabelFilter(query)(l)\n}\n\ntype SemVerConstraints []string\n\nfunc (svc SemVerConstraints) MatchesSemVerFilter(version string) bool {\n\treturn types.MustParseSemVerFilter(version)(\"\", svc)\n}\n\ntype ComponentSemVerConstraints map[string][]string\n\nfunc (csvc ComponentSemVerConstraints) MatchesSemVerFilter(component, version string) bool {\n\tfor comp, constraints := range csvc {\n\t\tif comp != component {\n\t\t\tcontinue\n\t\t}\n\n\t\tinput := version\n\t\tif len(component) > 0 {\n\t\t\tinput = fmt.Sprintf(\"%s=%s\", component, version)\n\t\t}\n\t\treturn types.MustParseSemVerFilter(input)(component, constraints)\n\t}\n\treturn false\n}\n\nfunc unionOf[S ~[]E, E comparable](slices ...S) S {\n\tout := S{}\n\tseen := map[E]bool{}\n\tfor _, slice := range slices {\n\t\tfor _, item := range slice {\n\t\t\tif !seen[item] {\n\t\t\t\tseen[item] = true\n\t\t\t\tout = append(out, item)\n\t\t\t}\n\t\t}\n\t}\n\treturn out\n}\n\nfunc UnionOfLabels(labels ...Labels) Labels {\n\treturn unionOf(labels...)\n}\n\nfunc UnionOfSemVerConstraints(semVerConstraints ...SemVerConstraints) SemVerConstraints {\n\treturn unionOf(semVerConstraints...)\n}\n\nfunc UnionOfComponentSemVerConstraints(componentSemVerConstraintsSlice ...ComponentSemVerConstraints) ComponentSemVerConstraints {\n\tunionComponentSemVerConstraints := ComponentSemVerConstraints{}\n\tfor _, componentSemVerConstraints := range componentSemVerConstraintsSlice {\n\t\tfor component, constraints := range componentSemVerConstraints {\n\t\t\tunionComponentSemVerConstraints[component] = unionOf(unionComponentSemVerConstraints[component], constraints)\n\t\t}\n\t}\n\treturn unionComponentSemVerConstraints\n}\n\nfunc PartitionDecorations(args ...any) ([]any, []any) {\n\tdecorations := []any{}\n\tremainingArgs := []any{}\n\tfor _, arg := range args {\n\t\tif isDecoration(arg) {\n\t\t\tdecorations = append(decorations, arg)\n\t\t} else {\n\t\t\tremainingArgs = append(remainingArgs, arg)\n\t\t}\n\t}\n\treturn decorations, remainingArgs\n}\n\nfunc isDecoration(arg any) bool {\n\tswitch t := reflect.TypeOf(arg); {\n\tcase t == nil:\n\t\treturn false\n\tcase t == reflect.TypeOf(Offset(0)):\n\t\treturn true\n\tcase t == reflect.TypeOf(types.CodeLocation{}):\n\t\treturn true\n\tcase t == reflect.TypeOf(Focus):\n\t\treturn true\n\tcase t == reflect.TypeOf(Pending):\n\t\treturn true\n\tcase t == reflect.TypeOf(Serial):\n\t\treturn true\n\tcase t == reflect.TypeOf(Ordered):\n\t\treturn true\n\tcase t == reflect.TypeOf(ContinueOnFailure):\n\t\treturn true\n\tcase t == reflect.TypeOf(OncePerOrdered):\n\t\treturn true\n\tcase t == reflect.TypeOf(SuppressProgressReporting):\n\t\treturn true\n\tcase t == reflect.TypeOf(FlakeAttempts(0)):\n\t\treturn true\n\tcase t == reflect.TypeOf(MustPassRepeatedly(0)):\n\t\treturn true\n\tcase t == reflect.TypeOf(Labels{}):\n\t\treturn true\n\tcase t == reflect.TypeOf(SemVerConstraints{}):\n\t\treturn true\n\tcase t == reflect.TypeOf(ComponentSemVerConstraints{}):\n\t\treturn true\n\tcase t == reflect.TypeOf(PollProgressInterval(0)):\n\t\treturn true\n\tcase t == reflect.TypeOf(PollProgressAfter(0)):\n\t\treturn true\n\tcase t == reflect.TypeOf(NodeTimeout(0)):\n\t\treturn true\n\tcase t == reflect.TypeOf(SpecTimeout(0)):\n\t\treturn true\n\tcase t == reflect.TypeOf(GracePeriod(0)):\n\t\treturn true\n\tcase t == reflect.TypeOf(types.AroundNodeDecorator{}):\n\t\treturn true\n\tcase t == reflect.TypeOf(SpecPriority(0)):\n\t\treturn true\n\tcase t.Kind() == reflect.Slice && isSliceOfDecorations(arg):\n\t\treturn true\n\tdefault:\n\t\treturn false\n\t}\n}\n\nfunc isSliceOfDecorations(slice any) bool {\n\tvSlice := reflect.ValueOf(slice)\n\tif vSlice.Len() == 0 {\n\t\treturn false\n\t}\n\tfor i := 0; i < vSlice.Len(); i++ {\n\t\tif !isDecoration(vSlice.Index(i).Interface()) {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\nvar contextType = reflect.TypeOf(new(context.Context)).Elem()\nvar specContextType = reflect.TypeOf(new(SpecContext)).Elem()\n\nfunc NewNode(deprecationTracker *types.DeprecationTracker, nodeType types.NodeType, text string, args ...any) (Node, []error) {\n\tbaseOffset := 2\n\tnode := Node{\n\t\tID: UniqueNodeID(),\n\t\tNodeType: nodeType,\n\t\tText: text,\n\t\tLabels: Labels{},\n\t\tSemVerConstraints: SemVerConstraints{},\n\t\tComponentSemVerConstraints: ComponentSemVerConstraints{},\n\t\tCodeLocation: types.NewCodeLocation(baseOffset),\n\t\tNestingLevel: -1,\n\t\tPollProgressAfter: -1,\n\t\tPollProgressInterval: -1,\n\t\tGracePeriod: -1,\n\t}\n\n\terrors := []error{}\n\tappendError := func(err error) {\n\t\tif err != nil {\n\t\t\terrors = append(errors, err)\n\t\t}\n\t}\n\n\targs = UnrollInterfaceSlice(args)\n\n\tremainingArgs := []any{}\n\t// First get the CodeLocation up-to-date\n\tfor _, arg := range args {\n\t\tswitch v := arg.(type) {\n\t\tcase Offset:\n\t\t\tnode.CodeLocation = types.NewCodeLocation(baseOffset + int(v))\n\t\tcase types.CodeLocation:\n\t\t\tnode.CodeLocation = v\n\t\tdefault:\n\t\t\tremainingArgs = append(remainingArgs, arg)\n\t\t}\n\t}\n\n\tlabelsSeen := map[string]bool{}\n\tsemVerConstraintsSeen := map[string]bool{}\n\ttrackedFunctionError := false\n\targs = remainingArgs\n\tremainingArgs = []any{}\n\t// now process the rest of the args\n\tfor _, arg := range args {\n\t\tswitch t := reflect.TypeOf(arg); {\n\t\tcase t == reflect.TypeOf(float64(0)):\n\t\t\tbreak // ignore deprecated timeouts\n\t\tcase t == reflect.TypeOf(Focus):\n\t\t\tnode.MarkedFocus = bool(arg.(focusType))\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"Focus\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(Pending):\n\t\t\tnode.MarkedPending = bool(arg.(pendingType))\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"Pending\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(Serial):\n\t\t\tnode.MarkedSerial = bool(arg.(serialType))\n\t\t\tif !labelsSeen[\"Serial\"] {\n\t\t\t\tnode.Labels = append(node.Labels, \"Serial\")\n\t\t\t}\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"Serial\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(Ordered):\n\t\t\tnode.MarkedOrdered = bool(arg.(orderedType))\n\t\t\tif !nodeType.Is(types.NodeTypeContainer) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"Ordered\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(ContinueOnFailure):\n\t\t\tnode.MarkedContinueOnFailure = bool(arg.(continueOnFailureType))\n\t\t\tif !nodeType.Is(types.NodeTypeContainer) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"ContinueOnFailure\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(OncePerOrdered):\n\t\t\tnode.MarkedOncePerOrdered = bool(arg.(honorsOrderedType))\n\t\t\tif !nodeType.Is(types.NodeTypeBeforeEach | types.NodeTypeJustBeforeEach | types.NodeTypeAfterEach | types.NodeTypeJustAfterEach) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"OncePerOrdered\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(SuppressProgressReporting):\n\t\t\tdeprecationTracker.TrackDeprecation(types.Deprecations.SuppressProgressReporting())\n\t\tcase t == reflect.TypeOf(FlakeAttempts(0)):\n\t\t\tnode.FlakeAttempts = int(arg.(FlakeAttempts))\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"FlakeAttempts\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(MustPassRepeatedly(0)):\n\t\t\tnode.MustPassRepeatedly = int(arg.(MustPassRepeatedly))\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"MustPassRepeatedly\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(PollProgressAfter(0)):\n\t\t\tnode.PollProgressAfter = time.Duration(arg.(PollProgressAfter))\n\t\t\tif nodeType.Is(types.NodeTypeContainer) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"PollProgressAfter\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(PollProgressInterval(0)):\n\t\t\tnode.PollProgressInterval = time.Duration(arg.(PollProgressInterval))\n\t\t\tif nodeType.Is(types.NodeTypeContainer) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"PollProgressInterval\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(NodeTimeout(0)):\n\t\t\tnode.NodeTimeout = time.Duration(arg.(NodeTimeout))\n\t\t\tif nodeType.Is(types.NodeTypeContainer) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"NodeTimeout\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(SpecTimeout(0)):\n\t\t\tnode.SpecTimeout = time.Duration(arg.(SpecTimeout))\n\t\t\tif !nodeType.Is(types.NodeTypeIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"SpecTimeout\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(GracePeriod(0)):\n\t\t\tnode.GracePeriod = time.Duration(arg.(GracePeriod))\n\t\t\tif nodeType.Is(types.NodeTypeContainer) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"GracePeriod\"))\n\t\t\t}\n\t\tcase t == reflect.TypeOf(SpecPriority(0)):\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"SpecPriority\"))\n\t\t\t}\n\t\t\tnode.SpecPriority = int(arg.(SpecPriority))\n\t\t\tnode.HasExplicitlySetSpecPriority = true\n\t\tcase t == reflect.TypeOf(types.AroundNodeDecorator{}):\n\t\t\tnode.AroundNodes = append(node.AroundNodes, arg.(types.AroundNodeDecorator))\n\t\tcase t == reflect.TypeOf(Labels{}):\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"Label\"))\n\t\t\t}\n\t\t\tfor _, label := range arg.(Labels) {\n\t\t\t\tif !labelsSeen[label] {\n\t\t\t\t\tlabelsSeen[label] = true\n\t\t\t\t\tlabel, err := types.ValidateAndCleanupLabel(label, node.CodeLocation)\n\t\t\t\t\tnode.Labels = append(node.Labels, label)\n\t\t\t\t\tappendError(err)\n\t\t\t\t}\n\t\t\t}\n\t\tcase t == reflect.TypeOf(SemVerConstraints{}):\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"SemVerConstraint\"))\n\t\t\t}\n\t\t\tfor _, semVerConstraint := range arg.(SemVerConstraints) {\n\t\t\t\tif !semVerConstraintsSeen[semVerConstraint] {\n\t\t\t\t\tsemVerConstraintsSeen[semVerConstraint] = true\n\t\t\t\t\tsemVerConstraint, err := types.ValidateAndCleanupSemVerConstraint(semVerConstraint, node.CodeLocation)\n\t\t\t\t\tnode.SemVerConstraints = append(node.SemVerConstraints, semVerConstraint)\n\t\t\t\t\tappendError(err)\n\t\t\t\t}\n\t\t\t}\n\t\tcase t == reflect.TypeOf(ComponentSemVerConstraints{}):\n\t\t\tif !nodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tappendError(types.GinkgoErrors.InvalidDecoratorForNodeType(node.CodeLocation, nodeType, \"ComponentSemVerConstraint\"))\n\t\t\t}\n\t\t\tfor component, semVerConstraints := range arg.(ComponentSemVerConstraints) {\n\t\t\t\t// while using ComponentSemVerConstraints, we should not allow empty component names.\n\t\t\t\t// you should use SemVerConstraints for that.\n\t\t\t\thasErr := false\n\t\t\t\tif len(component) == 0 {\n\t\t\t\t\tappendError(types.GinkgoErrors.InvalidEmptyComponentForSemVerConstraint(node.CodeLocation))\n\t\t\t\t\thasErr = true\n\t\t\t\t}\n\t\t\t\tfor _, semVerConstraint := range semVerConstraints {\n\t\t\t\t\t_, err := types.ValidateAndCleanupSemVerConstraint(semVerConstraint, node.CodeLocation)\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\tappendError(err)\n\t\t\t\t\t\thasErr = true\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif !hasErr {\n\t\t\t\t\t// merge constraints if the component already exists\n\t\t\t\t\tconstraints := slices.Clone(semVerConstraints)\n\t\t\t\t\tif existingConstraints, exists := node.ComponentSemVerConstraints[component]; exists {\n\t\t\t\t\t\tconstraints = UnionOfSemVerConstraints([]string(existingConstraints), constraints)\n\t\t\t\t\t}\n\n\t\t\t\t\tnode.ComponentSemVerConstraints[component] = slices.Clone(constraints)\n\t\t\t\t}\n\t\t\t}\n\t\tcase t.Kind() == reflect.Func:\n\t\t\tif nodeType.Is(types.NodeTypeContainer) {\n\t\t\t\tif node.Body != nil {\n\t\t\t\t\tappendError(types.GinkgoErrors.MultipleBodyFunctions(node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tif t.NumOut() > 0 || t.NumIn() > 0 {\n\t\t\t\t\tappendError(types.GinkgoErrors.InvalidBodyTypeForContainer(t, node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tbody := arg.(func())\n\t\t\t\tnode.Body = func(SpecContext) { body() }\n\t\t\t} else if nodeType.Is(types.NodeTypeReportBeforeEach | types.NodeTypeReportAfterEach) {\n\t\t\t\tif node.ReportEachBody == nil {\n\t\t\t\t\tif fn, ok := arg.(func(types.SpecReport)); ok {\n\t\t\t\t\t\tnode.ReportEachBody = func(_ SpecContext, r types.SpecReport) { fn(r) }\n\t\t\t\t\t} else {\n\t\t\t\t\t\tnode.ReportEachBody = arg.(func(SpecContext, types.SpecReport))\n\t\t\t\t\t\tnode.HasContext = true\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\tappendError(types.GinkgoErrors.MultipleBodyFunctions(node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t} else if nodeType.Is(types.NodeTypeReportBeforeSuite | types.NodeTypeReportAfterSuite) {\n\t\t\t\tif node.ReportSuiteBody == nil {\n\t\t\t\t\tif fn, ok := arg.(func(types.Report)); ok {\n\t\t\t\t\t\tnode.ReportSuiteBody = func(_ SpecContext, r types.Report) { fn(r) }\n\t\t\t\t\t} else {\n\t\t\t\t\t\tnode.ReportSuiteBody = arg.(func(SpecContext, types.Report))\n\t\t\t\t\t\tnode.HasContext = true\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\tappendError(types.GinkgoErrors.MultipleBodyFunctions(node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t} else if nodeType.Is(types.NodeTypeSynchronizedBeforeSuite) {\n\t\t\t\tif node.SynchronizedBeforeSuiteProc1Body != nil && node.SynchronizedBeforeSuiteAllProcsBody != nil {\n\t\t\t\t\tappendError(types.GinkgoErrors.MultipleBodyFunctions(node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tif node.SynchronizedBeforeSuiteProc1Body == nil {\n\t\t\t\t\tbody, hasContext := extractSynchronizedBeforeSuiteProc1Body(arg)\n\t\t\t\t\tif body == nil {\n\t\t\t\t\t\tappendError(types.GinkgoErrors.InvalidBodyTypeForSynchronizedBeforeSuiteProc1(t, node.CodeLocation))\n\t\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\t}\n\t\t\t\t\tnode.SynchronizedBeforeSuiteProc1Body, node.SynchronizedBeforeSuiteProc1BodyHasContext = body, hasContext\n\t\t\t\t} else if node.SynchronizedBeforeSuiteAllProcsBody == nil {\n\t\t\t\t\tbody, hasContext := extractSynchronizedBeforeSuiteAllProcsBody(arg)\n\t\t\t\t\tif body == nil {\n\t\t\t\t\t\tappendError(types.GinkgoErrors.InvalidBodyTypeForSynchronizedBeforeSuiteAllProcs(t, node.CodeLocation))\n\t\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\t}\n\t\t\t\t\tnode.SynchronizedBeforeSuiteAllProcsBody, node.SynchronizedBeforeSuiteAllProcsBodyHasContext = body, hasContext\n\t\t\t\t}\n\t\t\t} else if nodeType.Is(types.NodeTypeSynchronizedAfterSuite) {\n\t\t\t\tif node.SynchronizedAfterSuiteAllProcsBody != nil && node.SynchronizedAfterSuiteProc1Body != nil {\n\t\t\t\t\tappendError(types.GinkgoErrors.MultipleBodyFunctions(node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tbody, hasContext := extractBodyFunction(deprecationTracker, node.CodeLocation, arg)\n\t\t\t\tif body == nil {\n\t\t\t\t\tappendError(types.GinkgoErrors.InvalidBodyType(t, node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tif node.SynchronizedAfterSuiteAllProcsBody == nil {\n\t\t\t\t\tnode.SynchronizedAfterSuiteAllProcsBody, node.SynchronizedAfterSuiteAllProcsBodyHasContext = body, hasContext\n\t\t\t\t} else if node.SynchronizedAfterSuiteProc1Body == nil {\n\t\t\t\t\tnode.SynchronizedAfterSuiteProc1Body, node.SynchronizedAfterSuiteProc1BodyHasContext = body, hasContext\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tif node.Body != nil {\n\t\t\t\t\tappendError(types.GinkgoErrors.MultipleBodyFunctions(node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tnode.Body, node.HasContext = extractBodyFunction(deprecationTracker, node.CodeLocation, arg)\n\t\t\t\tif node.Body == nil {\n\t\t\t\t\tappendError(types.GinkgoErrors.InvalidBodyType(t, node.CodeLocation, nodeType))\n\t\t\t\t\ttrackedFunctionError = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\tdefault:\n\t\t\tremainingArgs = append(remainingArgs, arg)\n\t\t}\n\t}\n\n\t// validations\n\tif node.MarkedPending && node.MarkedFocus {\n\t\tappendError(types.GinkgoErrors.InvalidDeclarationOfFocusedAndPending(node.CodeLocation, nodeType))\n\t}\n\n\tif node.MarkedContinueOnFailure && !node.MarkedOrdered {\n\t\tappendError(types.GinkgoErrors.InvalidContinueOnFailureDecoration(node.CodeLocation))\n\t}\n\n\thasContext := node.HasContext || node.SynchronizedAfterSuiteProc1BodyHasContext || node.SynchronizedAfterSuiteAllProcsBodyHasContext || node.SynchronizedBeforeSuiteProc1BodyHasContext || node.SynchronizedBeforeSuiteAllProcsBodyHasContext\n\n\tif !hasContext && (node.NodeTimeout > 0 || node.SpecTimeout > 0 || node.GracePeriod > 0) && len(errors) == 0 {\n\t\tappendError(types.GinkgoErrors.InvalidTimeoutOrGracePeriodForNonContextNode(node.CodeLocation, nodeType))\n\t}\n\n\tif !node.NodeType.Is(types.NodeTypeReportBeforeEach|types.NodeTypeReportAfterEach|types.NodeTypeSynchronizedBeforeSuite|types.NodeTypeSynchronizedAfterSuite|types.NodeTypeReportBeforeSuite|types.NodeTypeReportAfterSuite) && node.Body == nil && !node.MarkedPending && !trackedFunctionError {\n\t\tappendError(types.GinkgoErrors.MissingBodyFunction(node.CodeLocation, nodeType))\n\t}\n\n\tif node.NodeType.Is(types.NodeTypeSynchronizedBeforeSuite) && !trackedFunctionError && (node.SynchronizedBeforeSuiteProc1Body == nil || node.SynchronizedBeforeSuiteAllProcsBody == nil) {\n\t\tappendError(types.GinkgoErrors.MissingBodyFunction(node.CodeLocation, nodeType))\n\t}\n\n\tif node.NodeType.Is(types.NodeTypeSynchronizedAfterSuite) && !trackedFunctionError && (node.SynchronizedAfterSuiteProc1Body == nil || node.SynchronizedAfterSuiteAllProcsBody == nil) {\n\t\tappendError(types.GinkgoErrors.MissingBodyFunction(node.CodeLocation, nodeType))\n\t}\n\n\tfor _, arg := range remainingArgs {\n\t\tappendError(types.GinkgoErrors.UnknownDecorator(node.CodeLocation, nodeType, arg))\n\t}\n\n\tif node.FlakeAttempts > 0 && node.MustPassRepeatedly > 0 {\n\t\tappendError(types.GinkgoErrors.InvalidDeclarationOfFlakeAttemptsAndMustPassRepeatedly(node.CodeLocation, nodeType))\n\t}\n\n\tif len(errors) > 0 {\n\t\treturn Node{}, errors\n\t}\n\n\treturn node, errors\n}\n\nvar doneType = reflect.TypeOf(make(Done))\n\nfunc extractBodyFunction(deprecationTracker *types.DeprecationTracker, cl types.CodeLocation, arg any) (func(SpecContext), bool) {\n\tt := reflect.TypeOf(arg)\n\tif t.NumOut() > 0 || t.NumIn() > 1 {\n\t\treturn nil, false\n\t}\n\tif t.NumIn() == 1 {\n\t\tif t.In(0) == doneType {\n\t\t\tdeprecationTracker.TrackDeprecation(types.Deprecations.Async(), cl)\n\t\t\tdeprecatedAsyncBody := arg.(func(Done))\n\t\t\treturn func(SpecContext) { deprecatedAsyncBody(make(Done)) }, false\n\t\t} else if t.In(0).Implements(specContextType) {\n\t\t\treturn arg.(func(SpecContext)), true\n\t\t} else if t.In(0).Implements(contextType) {\n\t\t\tbody := arg.(func(context.Context))\n\t\t\treturn func(c SpecContext) { body(c) }, true\n\t\t}\n\n\t\treturn nil, false\n\t}\n\n\tbody := arg.(func())\n\treturn func(SpecContext) { body() }, false\n}\n\nvar byteType = reflect.TypeOf([]byte{})\n\nfunc extractSynchronizedBeforeSuiteProc1Body(arg any) (func(SpecContext) []byte, bool) {\n\tt := reflect.TypeOf(arg)\n\tv := reflect.ValueOf(arg)\n\n\tif t.NumOut() > 1 || t.NumIn() > 1 {\n\t\treturn nil, false\n\t} else if t.NumOut() == 1 && t.Out(0) != byteType {\n\t\treturn nil, false\n\t} else if t.NumIn() == 1 && !t.In(0).Implements(contextType) {\n\t\treturn nil, false\n\t}\n\thasContext := t.NumIn() == 1\n\n\treturn func(c SpecContext) []byte {\n\t\tvar out []reflect.Value\n\t\tif hasContext {\n\t\t\tout = v.Call([]reflect.Value{reflect.ValueOf(c)})\n\t\t} else {\n\t\t\tout = v.Call([]reflect.Value{})\n\t\t}\n\t\tif len(out) == 1 {\n\t\t\treturn (out[0].Interface()).([]byte)\n\t\t} else {\n\t\t\treturn []byte{}\n\t\t}\n\t}, hasContext\n}\n\nfunc extractSynchronizedBeforeSuiteAllProcsBody(arg any) (func(SpecContext, []byte), bool) {\n\tt := reflect.TypeOf(arg)\n\tv := reflect.ValueOf(arg)\n\thasContext, hasByte := false, false\n\n\tif t.NumOut() > 0 || t.NumIn() > 2 {\n\t\treturn nil, false\n\t} else if t.NumIn() == 2 && t.In(0).Implements(contextType) && t.In(1) == byteType {\n\t\thasContext, hasByte = true, true\n\t} else if t.NumIn() == 1 && t.In(0).Implements(contextType) {\n\t\thasContext = true\n\t} else if t.NumIn() == 1 && t.In(0) == byteType {\n\t\thasByte = true\n\t} else if t.NumIn() != 0 {\n\t\treturn nil, false\n\t}\n\n\treturn func(c SpecContext, b []byte) {\n\t\tin := []reflect.Value{}\n\t\tif hasContext {\n\t\t\tin = append(in, reflect.ValueOf(c))\n\t\t}\n\t\tif hasByte {\n\t\t\tin = append(in, reflect.ValueOf(b))\n\t\t}\n\t\tv.Call(in)\n\t}, hasContext\n}\n\nvar errInterface = reflect.TypeOf((*error)(nil)).Elem()\n\nfunc NewCleanupNode(deprecationTracker *types.DeprecationTracker, fail func(string, types.CodeLocation), args ...any) (Node, []error) {\n\tdecorations, remainingArgs := PartitionDecorations(args...)\n\tbaseOffset := 2\n\tcl := types.NewCodeLocation(baseOffset)\n\tfinalArgs := []any{}\n\tfor _, arg := range decorations {\n\t\tswitch t := reflect.TypeOf(arg); {\n\t\tcase t == reflect.TypeOf(Offset(0)):\n\t\t\tcl = types.NewCodeLocation(baseOffset + int(arg.(Offset)))\n\t\tcase t == reflect.TypeOf(types.CodeLocation{}):\n\t\t\tcl = arg.(types.CodeLocation)\n\t\tdefault:\n\t\t\tfinalArgs = append(finalArgs, arg)\n\t\t}\n\t}\n\tfinalArgs = append(finalArgs, cl)\n\n\tif len(remainingArgs) == 0 {\n\t\treturn Node{}, []error{types.GinkgoErrors.DeferCleanupInvalidFunction(cl)}\n\t}\n\n\tcallback := reflect.ValueOf(remainingArgs[0])\n\tif !(callback.Kind() == reflect.Func) {\n\t\treturn Node{}, []error{types.GinkgoErrors.DeferCleanupInvalidFunction(cl)}\n\t}\n\n\tcallArgs := []reflect.Value{}\n\tfor _, arg := range remainingArgs[1:] {\n\t\tcallArgs = append(callArgs, reflect.ValueOf(arg))\n\t}\n\n\thasContext := false\n\tt := callback.Type()\n\tif t.NumIn() > 0 {\n\t\tif t.In(0).Implements(specContextType) {\n\t\t\thasContext = true\n\t\t} else if t.In(0).Implements(contextType) && (len(callArgs) == 0 || !callArgs[0].Type().Implements(contextType)) {\n\t\t\thasContext = true\n\t\t}\n\t}\n\n\thandleFailure := func(out []reflect.Value) {\n\t\tif len(out) == 0 {\n\t\t\treturn\n\t\t}\n\t\tlast := out[len(out)-1]\n\t\tif last.Type().Implements(errInterface) && !last.IsNil() {\n\t\t\tfail(fmt.Sprintf(\"DeferCleanup callback returned error: %v\", last), cl)\n\t\t}\n\t}\n\n\tif hasContext {\n\t\tfinalArgs = append(finalArgs, func(c SpecContext) {\n\t\t\tout := callback.Call(append([]reflect.Value{reflect.ValueOf(c)}, callArgs...))\n\t\t\thandleFailure(out)\n\t\t})\n\t} else {\n\t\tfinalArgs = append(finalArgs, func() {\n\t\t\tout := callback.Call(callArgs)\n\t\t\thandleFailure(out)\n\t\t})\n\t}\n\n\treturn NewNode(deprecationTracker, types.NodeTypeCleanupInvalid, \"\", finalArgs)\n}\n\nfunc (n Node) IsZero() bool {\n\treturn n.ID == 0\n}\n\n/* Nodes */\ntype Nodes []Node\n\nfunc (n Nodes) Clone() Nodes {\n\tnodes := make(Nodes, len(n))\n\tcopy(nodes, n)\n\treturn nodes\n}\n\nfunc (n Nodes) CopyAppend(nodes ...Node) Nodes {\n\tnumN := len(n)\n\tout := make(Nodes, numN+len(nodes))\n\tcopy(out, n)\n\tfor j, node := range nodes {\n\t\tout[numN+j] = node\n\t}\n\treturn out\n}\n\nfunc (n Nodes) SplitAround(pivot Node) (Nodes, Nodes) {\n\tpivotIdx := len(n)\n\tfor i := range n {\n\t\tif n[i].ID == pivot.ID {\n\t\t\tpivotIdx = i\n\t\t\tbreak\n\t\t}\n\t}\n\tleft := n[:pivotIdx]\n\tright := Nodes{}\n\tif pivotIdx+1 < len(n) {\n\t\tright = n[pivotIdx+1:]\n\t}\n\n\treturn left, right\n}\n\nfunc (n Nodes) FirstNodeWithType(nodeTypes types.NodeType) Node {\n\tfor i := range n {\n\t\tif n[i].NodeType.Is(nodeTypes) {\n\t\t\treturn n[i]\n\t\t}\n\t}\n\treturn Node{}\n}\n\nfunc (n Nodes) WithType(nodeTypes types.NodeType) Nodes {\n\tcount := 0\n\tfor i := range n {\n\t\tif n[i].NodeType.Is(nodeTypes) {\n\t\t\tcount++\n\t\t}\n\t}\n\n\tout, j := make(Nodes, count), 0\n\tfor i := range n {\n\t\tif n[i].NodeType.Is(nodeTypes) {\n\t\t\tout[j] = n[i]\n\t\t\tj++\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) WithoutType(nodeTypes types.NodeType) Nodes {\n\tcount := 0\n\tfor i := range n {\n\t\tif !n[i].NodeType.Is(nodeTypes) {\n\t\t\tcount++\n\t\t}\n\t}\n\n\tout, j := make(Nodes, count), 0\n\tfor i := range n {\n\t\tif !n[i].NodeType.Is(nodeTypes) {\n\t\t\tout[j] = n[i]\n\t\t\tj++\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) WithoutNode(nodeToExclude Node) Nodes {\n\tidxToExclude := len(n)\n\tfor i := range n {\n\t\tif n[i].ID == nodeToExclude.ID {\n\t\t\tidxToExclude = i\n\t\t\tbreak\n\t\t}\n\t}\n\tif idxToExclude == len(n) {\n\t\treturn n\n\t}\n\tout, j := make(Nodes, len(n)-1), 0\n\tfor i := range n {\n\t\tif i == idxToExclude {\n\t\t\tcontinue\n\t\t}\n\t\tout[j] = n[i]\n\t\tj++\n\t}\n\treturn out\n}\n\nfunc (n Nodes) Filter(filter func(Node) bool) Nodes {\n\ttrufa, count := make([]bool, len(n)), 0\n\tfor i := range n {\n\t\tif filter(n[i]) {\n\t\t\ttrufa[i] = true\n\t\t\tcount += 1\n\t\t}\n\t}\n\tout, j := make(Nodes, count), 0\n\tfor i := range n {\n\t\tif trufa[i] {\n\t\t\tout[j] = n[i]\n\t\t\tj++\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) FirstSatisfying(filter func(Node) bool) Node {\n\tfor i := range n {\n\t\tif filter(n[i]) {\n\t\t\treturn n[i]\n\t\t}\n\t}\n\treturn Node{}\n}\n\nfunc (n Nodes) WithinNestingLevel(deepestNestingLevel int) Nodes {\n\tcount := 0\n\tfor i := range n {\n\t\tif n[i].NestingLevel <= deepestNestingLevel {\n\t\t\tcount++\n\t\t}\n\t}\n\tout, j := make(Nodes, count), 0\n\tfor i := range n {\n\t\tif n[i].NestingLevel <= deepestNestingLevel {\n\t\t\tout[j] = n[i]\n\t\t\tj++\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) SortedByDescendingNestingLevel() Nodes {\n\tout := make(Nodes, len(n))\n\tcopy(out, n)\n\tsort.SliceStable(out, func(i int, j int) bool {\n\t\treturn out[i].NestingLevel > out[j].NestingLevel\n\t})\n\n\treturn out\n}\n\nfunc (n Nodes) SortedByAscendingNestingLevel() Nodes {\n\tout := make(Nodes, len(n))\n\tcopy(out, n)\n\tsort.SliceStable(out, func(i int, j int) bool {\n\t\treturn out[i].NestingLevel < out[j].NestingLevel\n\t})\n\n\treturn out\n}\n\nfunc (n Nodes) FirstWithNestingLevel(level int) Node {\n\tfor i := range n {\n\t\tif n[i].NestingLevel == level {\n\t\t\treturn n[i]\n\t\t}\n\t}\n\treturn Node{}\n}\n\nfunc (n Nodes) Reverse() Nodes {\n\tout := make(Nodes, len(n))\n\tfor i := range n {\n\t\tout[len(n)-1-i] = n[i]\n\t}\n\treturn out\n}\n\nfunc (n Nodes) Texts() []string {\n\tout := make([]string, len(n))\n\tfor i := range n {\n\t\tout[i] = n[i].Text\n\t}\n\treturn out\n}\n\nfunc (n Nodes) Labels() [][]string {\n\tout := make([][]string, len(n))\n\tfor i := range n {\n\t\tif n[i].Labels == nil {\n\t\t\tout[i] = []string{}\n\t\t} else {\n\t\t\tout[i] = []string(n[i].Labels)\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) UnionOfLabels() []string {\n\tout := []string{}\n\tseen := map[string]bool{}\n\tfor i := range n {\n\t\tfor _, label := range n[i].Labels {\n\t\t\tif !seen[label] {\n\t\t\t\tseen[label] = true\n\t\t\t\tout = append(out, label)\n\t\t\t}\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) SemVerConstraints() [][]string {\n\tout := make([][]string, len(n))\n\tfor i := range n {\n\t\tif n[i].SemVerConstraints == nil {\n\t\t\tout[i] = []string{}\n\t\t} else {\n\t\t\tout[i] = []string(n[i].SemVerConstraints)\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) UnionOfSemVerConstraints() []string {\n\tout := []string{}\n\tseen := map[string]bool{}\n\tfor i := range n {\n\t\tfor _, constraint := range n[i].SemVerConstraints {\n\t\t\tif !seen[constraint] {\n\t\t\t\tseen[constraint] = true\n\t\t\t\tout = append(out, constraint)\n\t\t\t}\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) ComponentSemVerConstraints() []map[string][]string {\n\tout := make([]map[string][]string, len(n))\n\tfor i := range n {\n\t\tif n[i].ComponentSemVerConstraints == nil {\n\t\t\tout[i] = map[string][]string{}\n\t\t} else {\n\t\t\tout[i] = map[string][]string(n[i].ComponentSemVerConstraints)\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) UnionOfComponentSemVerConstraints() map[string][]string {\n\tout := map[string][]string{}\n\tseen := map[string]bool{}\n\tfor i := range n {\n\t\tfor component := range n[i].ComponentSemVerConstraints {\n\t\t\tif !seen[component] {\n\t\t\t\tseen[component] = true\n\t\t\t\tout[component] = n[i].ComponentSemVerConstraints[component]\n\t\t\t} else {\n\t\t\t\tout[component] = UnionOfSemVerConstraints(out[component], n[i].ComponentSemVerConstraints[component])\n\t\t\t}\n\t\t}\n\t}\n\treturn out\n}\n\nfunc (n Nodes) CodeLocations() []types.CodeLocation {\n\tout := make([]types.CodeLocation, len(n))\n\tfor i := range n {\n\t\tout[i] = n[i].CodeLocation\n\t}\n\treturn out\n}\n\nfunc (n Nodes) BestTextFor(node Node) string {\n\tif node.Text != \"\" {\n\t\treturn node.Text\n\t}\n\tparentNestingLevel := node.NestingLevel - 1\n\tfor i := range n {\n\t\tif n[i].Text != \"\" && n[i].NestingLevel == parentNestingLevel {\n\t\t\treturn n[i].Text\n\t\t}\n\t}\n\n\treturn \"\"\n}\n\nfunc (n Nodes) ContainsNodeID(id uint) bool {\n\tfor i := range n {\n\t\tif n[i].ID == id {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (n Nodes) HasNodeMarkedPending() bool {\n\tfor i := range n {\n\t\tif n[i].MarkedPending {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (n Nodes) HasNodeMarkedFocus() bool {\n\tfor i := range n {\n\t\tif n[i].MarkedFocus {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (n Nodes) HasNodeMarkedSerial() bool {\n\tfor i := range n {\n\t\tif n[i].MarkedSerial {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (n Nodes) FirstNodeMarkedOrdered() Node {\n\tfor i := range n {\n\t\tif n[i].MarkedOrdered {\n\t\t\treturn n[i]\n\t\t}\n\t}\n\treturn Node{}\n}\n\nfunc (n Nodes) IndexOfFirstNodeMarkedOrdered() int {\n\tfor i := range n {\n\t\tif n[i].MarkedOrdered {\n\t\t\treturn i\n\t\t}\n\t}\n\treturn -1\n}\n\nfunc (n Nodes) GetMaxFlakeAttempts() int {\n\tmaxFlakeAttempts := 0\n\tfor i := range n {\n\t\tif n[i].FlakeAttempts > 0 {\n\t\t\tmaxFlakeAttempts = n[i].FlakeAttempts\n\t\t}\n\t}\n\treturn maxFlakeAttempts\n}\n\nfunc (n Nodes) GetMaxMustPassRepeatedly() int {\n\tmaxMustPassRepeatedly := 0\n\tfor i := range n {\n\t\tif n[i].MustPassRepeatedly > 0 {\n\t\t\tmaxMustPassRepeatedly = n[i].MustPassRepeatedly\n\t\t}\n\t}\n\treturn maxMustPassRepeatedly\n}\n\nfunc (n Nodes) GetSpecPriority() int {\n\tfor i := len(n) - 1; i >= 0; i-- {\n\t\tif n[i].HasExplicitlySetSpecPriority {\n\t\t\treturn n[i].SpecPriority\n\t\t}\n\t}\n\treturn 0\n}\n\nfunc UnrollInterfaceSlice(args any) []any {\n\tv := reflect.ValueOf(args)\n\tif v.Kind() != reflect.Slice {\n\t\treturn []any{args}\n\t}\n\tout := []any{}\n\tfor i := 0; i < v.Len(); i++ {\n\t\tel := reflect.ValueOf(v.Index(i).Interface())\n\t\tif el.Kind() == reflect.Slice && el.Type() != reflect.TypeOf(Labels{}) && el.Type() != reflect.TypeOf(SemVerConstraints{}) {\n\t\t\tout = append(out, UnrollInterfaceSlice(el.Interface())...)\n\t\t} else {\n\t\t\tout = append(out, v.Index(i).Interface())\n\t\t}\n\t}\n\treturn out\n}\n\ntype NodeArgsTransformer func(nodeType types.NodeType, offset Offset, text string, args []any) (string, []any, []error)\n\nfunc AddTreeConstructionNodeArgsTransformer(transformer NodeArgsTransformer) func() {\n\tid := nodeArgsTransformerCounter\n\tnodeArgsTransformerCounter++\n\tnodeArgsTransformers = append(nodeArgsTransformers, registeredNodeArgsTransformer{id, transformer})\n\treturn func() {\n\t\tnodeArgsTransformers = slices.DeleteFunc(nodeArgsTransformers, func(transformer registeredNodeArgsTransformer) bool {\n\t\t\treturn transformer.id == id\n\t\t})\n\t}\n}\n\nvar (\n\tnodeArgsTransformerCounter int64\n\tnodeArgsTransformers []registeredNodeArgsTransformer\n)\n\ntype registeredNodeArgsTransformer struct {\n\tid int64\n\ttransformer NodeArgsTransformer\n}\n\n// TransformNewNodeArgs is the helper for DSL functions which handles NodeArgsTransformers.\n//\n// Its return valus are intentionally the same as the internal.NewNode parameters,\n// which makes it possible to chain the invocations:\n//\n//\tNewNode(transformNewNodeArgs(...))\nfunc TransformNewNodeArgs(exitIfErrors func([]error), deprecationTracker *types.DeprecationTracker, nodeType types.NodeType, text string, args ...any) (*types.DeprecationTracker, types.NodeType, string, []any) {\n\tvar errs []error\n\n\t// Most recent first...\n\t//\n\t// This intentionally doesn't use slices.Backward because\n\t// using iterators influences stack unwinding.\n\tfor i := len(nodeArgsTransformers) - 1; i >= 0; i-- {\n\t\ttransformer := nodeArgsTransformers[i].transformer\n\t\targs = UnrollInterfaceSlice(args)\n\n\t\t// We do not really need to recompute this on additional loop iterations,\n\t\t// but its fast and simpler this way.\n\t\tvar offset Offset\n\t\tfor _, arg := range args {\n\t\t\tif o, ok := arg.(Offset); ok {\n\t\t\t\toffset = o\n\t\t\t}\n\t\t}\n\t\toffset += 3 // The DSL function, this helper, and the TransformNodeArgs implementation.\n\n\t\ttext, args, errs = transformer(nodeType, offset, text, args)\n\t\texitIfErrors(errs)\n\t}\n\treturn deprecationTracker, nodeType, text, args\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/ordering.go",
"content": "package internal\n\nimport (\n\t\"math/rand\"\n\t\"sort\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype SortableSpecs struct {\n\tSpecs Specs\n\tIndexes []int\n}\n\nfunc NewSortableSpecs(specs Specs) *SortableSpecs {\n\tindexes := make([]int, len(specs))\n\tfor i := range specs {\n\t\tindexes[i] = i\n\t}\n\treturn &SortableSpecs{\n\t\tSpecs: specs,\n\t\tIndexes: indexes,\n\t}\n}\nfunc (s *SortableSpecs) Len() int { return len(s.Indexes) }\nfunc (s *SortableSpecs) Swap(i, j int) { s.Indexes[i], s.Indexes[j] = s.Indexes[j], s.Indexes[i] }\nfunc (s *SortableSpecs) Less(i, j int) bool {\n\ta, b := s.Specs[s.Indexes[i]], s.Specs[s.Indexes[j]]\n\n\taNodes, bNodes := a.Nodes.WithType(types.NodeTypesForContainerAndIt), b.Nodes.WithType(types.NodeTypesForContainerAndIt)\n\n\tfirstOrderedAIdx, firstOrderedBIdx := aNodes.IndexOfFirstNodeMarkedOrdered(), bNodes.IndexOfFirstNodeMarkedOrdered()\n\tif firstOrderedAIdx > -1 && firstOrderedBIdx > -1 && aNodes[firstOrderedAIdx].ID == bNodes[firstOrderedBIdx].ID {\n\t\t// strictly preserve order within an ordered containers. ID will track this as IDs are generated monotonically\n\t\treturn aNodes.FirstNodeWithType(types.NodeTypeIt).ID < bNodes.FirstNodeWithType(types.NodeTypeIt).ID\n\t}\n\n\t// if either spec is in an ordered container - only use the nodes up to the outermost ordered container\n\tif firstOrderedAIdx > -1 {\n\t\taNodes = aNodes[:firstOrderedAIdx+1]\n\t}\n\tif firstOrderedBIdx > -1 {\n\t\tbNodes = bNodes[:firstOrderedBIdx+1]\n\t}\n\n\tfor i := 0; i < len(aNodes) && i < len(bNodes); i++ {\n\t\taCL, bCL := aNodes[i].CodeLocation, bNodes[i].CodeLocation\n\t\tif aCL.FileName != bCL.FileName {\n\t\t\treturn aCL.FileName < bCL.FileName\n\t\t}\n\t\tif aCL.LineNumber != bCL.LineNumber {\n\t\t\treturn aCL.LineNumber < bCL.LineNumber\n\t\t}\n\t}\n\t// either everything is equal or we have different lengths of CLs\n\tif len(aNodes) != len(bNodes) {\n\t\treturn len(aNodes) < len(bNodes)\n\t}\n\t// ok, now we are sure everything was equal. so we use the spec text to break ties\n\tfor i := 0; i < len(aNodes); i++ {\n\t\tif aNodes[i].Text != bNodes[i].Text {\n\t\t\treturn aNodes[i].Text < bNodes[i].Text\n\t\t}\n\t}\n\t// ok, all those texts were equal. we'll use the ID of the most deeply nested node as a last resort\n\treturn aNodes[len(aNodes)-1].ID < bNodes[len(bNodes)-1].ID\n}\n\ntype GroupedSpecIndices []SpecIndices\ntype SpecIndices []int\n\nfunc OrderSpecs(specs Specs, suiteConfig types.SuiteConfig) (GroupedSpecIndices, GroupedSpecIndices) {\n\t/*\n\t\tGinkgo has sophisticated support for randomizing specs. Specs are guaranteed to have the same\n\t\torder for a given seed across test runs.\n\n\t\tBy default only top-level containers and specs are shuffled - this makes for a more intuitive debugging\n\t\texperience - specs within a given container run in the order they appear in the file.\n\n\t\tDevelopers can set -randomizeAllSpecs to shuffle _all_ specs.\n\n\t\tIn addition, spec containers can be marked as Ordered. Specs within an Ordered container are never shuffled.\n\n\t\tFinally, specs and spec containers can be marked as Serial. When running in parallel, serial specs run on Process #1 _after_ all other processes have finished.\n\t*/\n\n\t// Seed a new random source based on thee configured random seed.\n\tr := rand.New(rand.NewSource(suiteConfig.RandomSeed))\n\n\t// first, we sort the entire suite to ensure a deterministic order. the sort is performed by filename, then line number, and then spec text. this ensures every parallel process has the exact same spec order and is only necessary to cover the edge case where the user iterates over a map to generate specs.\n\tsortableSpecs := NewSortableSpecs(specs)\n\tsort.Sort(sortableSpecs)\n\n\t// then we break things into execution groups\n\t// a group represents a single unit of execution and is a collection of SpecIndices\n\t// usually a group is just a single spec, however ordered containers must be preserved as a single group\n\texecutionGroupIDs := []uint{}\n\texecutionGroups := map[uint]SpecIndices{}\n\tfor _, idx := range sortableSpecs.Indexes {\n\t\tspec := specs[idx]\n\t\tgroupNode := spec.Nodes.FirstNodeMarkedOrdered()\n\t\tif groupNode.IsZero() {\n\t\t\tgroupNode = spec.Nodes.FirstNodeWithType(types.NodeTypeIt)\n\t\t}\n\t\texecutionGroups[groupNode.ID] = append(executionGroups[groupNode.ID], idx)\n\t\tif len(executionGroups[groupNode.ID]) == 1 {\n\t\t\texecutionGroupIDs = append(executionGroupIDs, groupNode.ID)\n\t\t}\n\t}\n\n\t// now, we only shuffle all the execution groups if we're randomizing all specs, otherwise\n\t// we shuffle outermost containers. so we need to form shufflable groupings of GroupIDs\n\tshufflableGroupingIDs := []uint{}\n\tshufflableGroupingIDToGroupIDs := map[uint][]uint{}\n\n\t// for each execution group we're going to have to pick a node to represent how the\n\t// execution group is grouped for shuffling:\n\tnodeTypesToShuffle := types.NodeTypesForContainerAndIt\n\tif suiteConfig.RandomizeAllSpecs {\n\t\tnodeTypesToShuffle = types.NodeTypeIt\n\t}\n\n\t//so, for each execution group:\n\tfor _, groupID := range executionGroupIDs {\n\t\t// pick out a representative spec\n\t\trepresentativeSpec := specs[executionGroups[groupID][0]]\n\n\t\t// and grab the node on the spec that will represent which shufflable group this execution group belongs to\n\t\tshufflableGroupingNode := representativeSpec.Nodes.FirstNodeWithType(nodeTypesToShuffle)\n\n\t\t//add the execution group to its shufflable group\n\t\tshufflableGroupingIDToGroupIDs[shufflableGroupingNode.ID] = append(shufflableGroupingIDToGroupIDs[shufflableGroupingNode.ID], groupID)\n\n\t\t//and if it's the first one in\n\t\tif len(shufflableGroupingIDToGroupIDs[shufflableGroupingNode.ID]) == 1 {\n\t\t\t// record the shuffleable group ID\n\t\t\tshufflableGroupingIDs = append(shufflableGroupingIDs, shufflableGroupingNode.ID)\n\t\t}\n\t}\n\n\t// now, for each shuffleable group, we compute the priority\n\tshufflableGroupingIDPriorities := map[uint]int{}\n\tfor shufflableGroupingID, groupIDs := range shufflableGroupingIDToGroupIDs {\n\t\t// the priority of a shufflable grouping is the max priority of any spec in any execution group in the shufflable grouping\n\t\tmaxPriority := -1 << 31 // min int\n\t\tfor _, groupID := range groupIDs {\n\t\t\tfor _, specIdx := range executionGroups[groupID] {\n\t\t\t\tspecPriority := specs[specIdx].Nodes.GetSpecPriority()\n\t\t\t\tmaxPriority = max(specPriority, maxPriority)\n\t\t\t}\n\t\t}\n\t\tshufflableGroupingIDPriorities[shufflableGroupingID] = maxPriority\n\t}\n\n\t// now we permute the sorted shufflable grouping IDs and build the ordered Groups\n\tpermutation := r.Perm(len(shufflableGroupingIDs))\n\tshuffledGroupingIds := make([]uint, len(shufflableGroupingIDs))\n\tfor i, j := range permutation {\n\t\tshuffledGroupingIds[i] = shufflableGroupingIDs[j]\n\t}\n\t// now, we need to stable sort the shuffledGroupingIds by priority (higher priority first)\n\tsort.SliceStable(shuffledGroupingIds, func(i, j int) bool {\n\t\treturn shufflableGroupingIDPriorities[shuffledGroupingIds[i]] > shufflableGroupingIDPriorities[shuffledGroupingIds[j]]\n\t})\n\n\t// we can now take these prioritized, shuffled, groupings and form the final set of ordered spec groups\n\torderedGroups := GroupedSpecIndices{}\n\tfor _, id := range shuffledGroupingIds {\n\t\tfor _, executionGroupID := range shufflableGroupingIDToGroupIDs[id] {\n\t\t\torderedGroups = append(orderedGroups, executionGroups[executionGroupID])\n\t\t}\n\t}\n\n\t// If we're running in series, we're done.\n\tif suiteConfig.ParallelTotal == 1 {\n\t\treturn orderedGroups, GroupedSpecIndices{}\n\t}\n\n\t// We're running in parallel so we need to partition the ordered groups into a parallelizable set and a serialized set.\n\t// The parallelizable groups will run across all Ginkgo processes...\n\t// ...the serial groups will only run on Process #1 after all other processes have exited.\n\tparallelizableGroups, serialGroups := GroupedSpecIndices{}, GroupedSpecIndices{}\n\tfor _, specIndices := range orderedGroups {\n\t\tif specs[specIndices[0]].Nodes.HasNodeMarkedSerial() {\n\t\t\tserialGroups = append(serialGroups, specIndices)\n\t\t} else {\n\t\t\tparallelizableGroups = append(parallelizableGroups, specIndices)\n\t\t}\n\t}\n\n\treturn parallelizableGroups, serialGroups\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/output_interceptor.go",
"content": "package internal\n\nimport (\n\t\"bytes\"\n\t\"io\"\n\t\"os\"\n\t\"time\"\n)\n\nconst BAILOUT_TIME = 1 * time.Second\nconst BAILOUT_MESSAGE = `Ginkgo detected an issue while intercepting output.\n\nWhen running in parallel, Ginkgo captures stdout and stderr output\nand attaches it to the running spec. It looks like that process is getting\nstuck for this suite.\n\nThis usually happens if you, or a library you are using, spin up an external\nprocess and set cmd.Stdout = os.Stdout and/or cmd.Stderr = os.Stderr. This\ncauses the external process to keep Ginkgo's output interceptor pipe open and\ncauses output interception to hang.\n\nGinkgo has detected this and shortcircuited the capture process. The specs\nwill continue running after this message however output from the external\nprocess that caused this issue will not be captured.\n\nYou have several options to fix this. In preferred order they are:\n\n1. Pass GinkgoWriter instead of os.Stdout or os.Stderr to your process.\n2. Ensure your process exits before the current spec completes. If your\nprocess is long-lived and must cross spec boundaries, this option won't\nwork for you.\n3. Pause Ginkgo's output interceptor before starting your process and then\nresume it after. Use PauseOutputInterception() and ResumeOutputInterception()\nto do this.\n4. Set --output-interceptor-mode=none when running your Ginkgo suite. This will\nturn off all output interception but allow specs to run in parallel without this\nissue. You may miss important output if you do this including output from Go's\nrace detector.\n\nMore details on issue #851 - https://github.com/onsi/ginkgo/issues/851\n`\n\n/*\nThe OutputInterceptor is used by to\nintercept and capture all stdin and stderr output during a test run.\n*/\ntype OutputInterceptor interface {\n\tStartInterceptingOutput()\n\tStartInterceptingOutputAndForwardTo(io.Writer)\n\tStopInterceptingAndReturnOutput() string\n\n\tPauseIntercepting()\n\tResumeIntercepting()\n\n\tShutdown()\n}\n\ntype NoopOutputInterceptor struct{}\n\nfunc (interceptor NoopOutputInterceptor) StartInterceptingOutput() {}\nfunc (interceptor NoopOutputInterceptor) StartInterceptingOutputAndForwardTo(io.Writer) {}\nfunc (interceptor NoopOutputInterceptor) StopInterceptingAndReturnOutput() string { return \"\" }\nfunc (interceptor NoopOutputInterceptor) PauseIntercepting() {}\nfunc (interceptor NoopOutputInterceptor) ResumeIntercepting() {}\nfunc (interceptor NoopOutputInterceptor) Shutdown() {}\n\ntype pipePair struct {\n\treader *os.File\n\twriter *os.File\n}\n\nfunc startPipeFactory(pipeChannel chan pipePair, shutdown chan any) {\n\tfor {\n\t\t//make the next pipe...\n\t\tpair := pipePair{}\n\t\tpair.reader, pair.writer, _ = os.Pipe()\n\t\tselect {\n\t\t//...and provide it to the next consumer (they are responsible for closing the files)\n\t\tcase pipeChannel <- pair:\n\t\t\tcontinue\n\t\t//...or close the files if we were told to shutdown\n\t\tcase <-shutdown:\n\t\t\tpair.reader.Close()\n\t\t\tpair.writer.Close()\n\t\t\treturn\n\t\t}\n\t}\n}\n\ntype interceptorImplementation interface {\n\tCreateStdoutStderrClones() (*os.File, *os.File)\n\tConnectPipeToStdoutStderr(*os.File)\n\tRestoreStdoutStderrFromClones(*os.File, *os.File)\n\tShutdownClones(*os.File, *os.File)\n}\n\ntype genericOutputInterceptor struct {\n\tintercepting bool\n\n\tstdoutClone *os.File\n\tstderrClone *os.File\n\tpipe pipePair\n\n\tshutdown chan any\n\temergencyBailout chan any\n\tpipeChannel chan pipePair\n\tinterceptedContent chan string\n\n\tforwardTo io.Writer\n\taccumulatedOutput string\n\n\timplementation interceptorImplementation\n}\n\nfunc (interceptor *genericOutputInterceptor) StartInterceptingOutput() {\n\tinterceptor.StartInterceptingOutputAndForwardTo(io.Discard)\n}\n\nfunc (interceptor *genericOutputInterceptor) StartInterceptingOutputAndForwardTo(w io.Writer) {\n\tif interceptor.intercepting {\n\t\treturn\n\t}\n\tinterceptor.accumulatedOutput = \"\"\n\tinterceptor.forwardTo = w\n\tinterceptor.ResumeIntercepting()\n}\n\nfunc (interceptor *genericOutputInterceptor) StopInterceptingAndReturnOutput() string {\n\tif interceptor.intercepting {\n\t\tinterceptor.PauseIntercepting()\n\t}\n\treturn interceptor.accumulatedOutput\n}\n\nfunc (interceptor *genericOutputInterceptor) ResumeIntercepting() {\n\tif interceptor.intercepting {\n\t\treturn\n\t}\n\tinterceptor.intercepting = true\n\tif interceptor.stdoutClone == nil {\n\t\tinterceptor.stdoutClone, interceptor.stderrClone = interceptor.implementation.CreateStdoutStderrClones()\n\t\tinterceptor.shutdown = make(chan any)\n\t\tgo startPipeFactory(interceptor.pipeChannel, interceptor.shutdown)\n\t}\n\n\t// Now we make a pipe, we'll use this to redirect the input to the 1 and 2 file descriptors (this is how everything else in the world is string to log to stdout and stderr)\n\t// we get the pipe from our pipe factory. it runs in the background so we can request the next pipe while the spec being intercepted is running\n\tinterceptor.pipe = <-interceptor.pipeChannel\n\n\tinterceptor.emergencyBailout = make(chan any)\n\n\t//Spin up a goroutine to copy data from the pipe into a buffer, this is how we capture any output the user is emitting\n\tgo func() {\n\t\tbuffer := &bytes.Buffer{}\n\t\tdestination := io.MultiWriter(buffer, interceptor.forwardTo)\n\t\tcopyFinished := make(chan any)\n\t\treader := interceptor.pipe.reader\n\t\tgo func() {\n\t\t\tio.Copy(destination, reader)\n\t\t\treader.Close() // close the read end of the pipe so we don't leak a file descriptor\n\t\t\tclose(copyFinished)\n\t\t}()\n\t\tselect {\n\t\tcase <-copyFinished:\n\t\t\tinterceptor.interceptedContent <- buffer.String()\n\t\tcase <-interceptor.emergencyBailout:\n\t\t\tinterceptor.interceptedContent <- \"\"\n\t\t}\n\t}()\n\n\tinterceptor.implementation.ConnectPipeToStdoutStderr(interceptor.pipe.writer)\n}\n\nfunc (interceptor *genericOutputInterceptor) PauseIntercepting() {\n\tif !interceptor.intercepting {\n\t\treturn\n\t}\n\t// first we have to close the write end of the pipe. To do this we have to close all file descriptors pointing\n\t// to the write end. So that would be the pipewriter itself, and FD #1 and FD #2 if we've Dup2'd them\n\tinterceptor.pipe.writer.Close() // the pipewriter itself\n\n\t// we also need to stop intercepting. we do that by reconnecting the stdout and stderr file descriptions back to their respective #1 and #2 file descriptors;\n\t// this also closes #1 and #2 before it points that their original stdout and stderr file descriptions\n\tinterceptor.implementation.RestoreStdoutStderrFromClones(interceptor.stdoutClone, interceptor.stderrClone)\n\n\tvar content string\n\tselect {\n\tcase content = <-interceptor.interceptedContent:\n\tcase <-time.After(BAILOUT_TIME):\n\t\t/*\n\t\t\tBy closing all the pipe writer's file descriptors associated with the pipe writer's file description the io.Copy reading from the reader\n\t\t\tshould eventually receive an EOF and exit.\n\n\t\t\t**However**, if the user has spun up an external process and passed in os.Stdout/os.Stderr to cmd.Stdout/cmd.Stderr then the external process\n\t\t\twill have a file descriptor pointing to the pipe writer's file description and it will not close until the external process exits.\n\n\t\t\tThat would leave us hanging here waiting for the io.Copy to close forever. Instead we invoke this emergency escape valve. This returns whatever\n\t\t\tcontent we've got but leaves the io.Copy running. This ensures the external process can continue writing without hanging at the cost of leaking a goroutine\n\t\t\tand file descriptor (those these will be cleaned up when the process exits).\n\n\t\t\tWe tack on a message to notify the user that they've hit this edgecase and encourage them to address it.\n\t\t*/\n\t\tclose(interceptor.emergencyBailout)\n\t\tcontent = <-interceptor.interceptedContent + BAILOUT_MESSAGE\n\t}\n\n\tinterceptor.accumulatedOutput += content\n\tinterceptor.intercepting = false\n}\n\nfunc (interceptor *genericOutputInterceptor) Shutdown() {\n\tinterceptor.PauseIntercepting()\n\n\tif interceptor.stdoutClone != nil {\n\t\tclose(interceptor.shutdown)\n\t\tinterceptor.implementation.ShutdownClones(interceptor.stdoutClone, interceptor.stderrClone)\n\t\tinterceptor.stdoutClone = nil\n\t\tinterceptor.stderrClone = nil\n\t}\n}\n\n/* This is used on windows builds but included here so it can be explicitly tested on unix systems too */\nfunc NewOSGlobalReassigningOutputInterceptor() OutputInterceptor {\n\treturn &genericOutputInterceptor{\n\t\tinterceptedContent: make(chan string),\n\t\tpipeChannel: make(chan pipePair),\n\t\tshutdown: make(chan any),\n\t\timplementation: &osGlobalReassigningOutputInterceptorImpl{},\n\t}\n}\n\ntype osGlobalReassigningOutputInterceptorImpl struct{}\n\nfunc (impl *osGlobalReassigningOutputInterceptorImpl) CreateStdoutStderrClones() (*os.File, *os.File) {\n\treturn os.Stdout, os.Stderr\n}\n\nfunc (impl *osGlobalReassigningOutputInterceptorImpl) ConnectPipeToStdoutStderr(pipeWriter *os.File) {\n\tos.Stdout = pipeWriter\n\tos.Stderr = pipeWriter\n}\n\nfunc (impl *osGlobalReassigningOutputInterceptorImpl) RestoreStdoutStderrFromClones(stdoutClone *os.File, stderrClone *os.File) {\n\tos.Stdout = stdoutClone\n\tos.Stderr = stderrClone\n}\n\nfunc (impl *osGlobalReassigningOutputInterceptorImpl) ShutdownClones(_ *os.File, _ *os.File) {\n\t//noop\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/output_interceptor_unix.go",
"content": "//go:build freebsd || openbsd || netbsd || dragonfly || darwin || linux || solaris\n// +build freebsd openbsd netbsd dragonfly darwin linux solaris\n\npackage internal\n\nimport (\n\t\"os\"\n\n\t\"golang.org/x/sys/unix\"\n)\n\nfunc NewOutputInterceptor() OutputInterceptor {\n\treturn &genericOutputInterceptor{\n\t\tinterceptedContent: make(chan string),\n\t\tpipeChannel: make(chan pipePair),\n\t\tshutdown: make(chan any),\n\t\timplementation: &dupSyscallOutputInterceptorImpl{},\n\t}\n}\n\ntype dupSyscallOutputInterceptorImpl struct{}\n\nfunc (impl *dupSyscallOutputInterceptorImpl) CreateStdoutStderrClones() (*os.File, *os.File) {\n\t// To clone stdout and stderr we:\n\t// First, create two clone file descriptors that point to the stdout and stderr file descriptions\n\tstdoutCloneFD, _ := unix.Dup(1)\n\tstderrCloneFD, _ := unix.Dup(2)\n\n\t// Important, set the fds to FD_CLOEXEC to prevent them leaking into childs\n\t// https://github.com/onsi/ginkgo/issues/1191\n\tflags, err := unix.FcntlInt(uintptr(stdoutCloneFD), unix.F_GETFD, 0)\n\tif err == nil {\n\t\tunix.FcntlInt(uintptr(stdoutCloneFD), unix.F_SETFD, flags|unix.FD_CLOEXEC)\n\t}\n\tflags, err = unix.FcntlInt(uintptr(stderrCloneFD), unix.F_GETFD, 0)\n\tif err == nil {\n\t\tunix.FcntlInt(uintptr(stderrCloneFD), unix.F_SETFD, flags|unix.FD_CLOEXEC)\n\t}\n\n\t// And then wrap the clone file descriptors in files.\n\t// One benefit of this (that we don't use yet) is that we can actually write\n\t// to these files to emit output to the console even though we're intercepting output\n\tstdoutClone := os.NewFile(uintptr(stdoutCloneFD), \"stdout-clone\")\n\tstderrClone := os.NewFile(uintptr(stderrCloneFD), \"stderr-clone\")\n\n\t//these clones remain alive throughout the lifecycle of the suite and don't need to be recreated\n\t//this speeds things up a bit, actually.\n\treturn stdoutClone, stderrClone\n}\n\nfunc (impl *dupSyscallOutputInterceptorImpl) ConnectPipeToStdoutStderr(pipeWriter *os.File) {\n\t// To redirect output to our pipe we need to point the 1 and 2 file descriptors (which is how the world tries to log things)\n\t// to the write end of the pipe.\n\t// We do this with Dup2 (possibly Dup3 on some architectures) to have file descriptors 1 and 2 point to the same file description as the pipeWriter\n\t// This effectively shunts data written to stdout and stderr to the write end of our pipe\n\tunix.Dup2(int(pipeWriter.Fd()), 1)\n\tunix.Dup2(int(pipeWriter.Fd()), 2)\n}\n\nfunc (impl *dupSyscallOutputInterceptorImpl) RestoreStdoutStderrFromClones(stdoutClone *os.File, stderrClone *os.File) {\n\t// To restore stdour/stderr from the clones we have the 1 and 2 file descriptors\n\t// point to the original file descriptions that we saved off in the clones.\n\t// This has the added benefit of closing the connection between these descriptors and the write end of the pipe\n\t// which is important to cause the io.Copy on the pipe.Reader to end.\n\tunix.Dup2(int(stdoutClone.Fd()), 1)\n\tunix.Dup2(int(stderrClone.Fd()), 2)\n}\n\nfunc (impl *dupSyscallOutputInterceptorImpl) ShutdownClones(stdoutClone *os.File, stderrClone *os.File) {\n\t// We're done with the clones so we can close them to clean up after ourselves\n\tstdoutClone.Close()\n\tstderrClone.Close()\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/output_interceptor_wasm.go",
"content": "//go:build wasm\n\npackage internal\n\nfunc NewOutputInterceptor() OutputInterceptor {\n\treturn &NoopOutputInterceptor{}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/output_interceptor_win.go",
"content": "// +build windows\n\npackage internal\n\nfunc NewOutputInterceptor() OutputInterceptor {\n\treturn NewOSGlobalReassigningOutputInterceptor()\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/parallel_support/client_server.go",
"content": "package parallel_support\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype BeforeSuiteState struct {\n\tData []byte\n\tState types.SpecState\n}\n\ntype ParallelIndexCounter struct {\n\tIndex int\n}\n\nvar ErrorGone = fmt.Errorf(\"gone\")\nvar ErrorFailed = fmt.Errorf(\"failed\")\nvar ErrorEarly = fmt.Errorf(\"early\")\n\nvar POLLING_INTERVAL = 50 * time.Millisecond\n\ntype Server interface {\n\tStart()\n\tClose()\n\tAddress() string\n\tRegisterAlive(node int, alive func() bool)\n\tGetSuiteDone() chan any\n\tGetOutputDestination() io.Writer\n\tSetOutputDestination(io.Writer)\n}\n\ntype Client interface {\n\tConnect() bool\n\tClose() error\n\n\tPostSuiteWillBegin(report types.Report) error\n\tPostDidRun(report types.SpecReport) error\n\tPostSuiteDidEnd(report types.Report) error\n\tPostReportBeforeSuiteCompleted(state types.SpecState) error\n\tBlockUntilReportBeforeSuiteCompleted() (types.SpecState, error)\n\tPostSynchronizedBeforeSuiteCompleted(state types.SpecState, data []byte) error\n\tBlockUntilSynchronizedBeforeSuiteData() (types.SpecState, []byte, error)\n\tBlockUntilNonprimaryProcsHaveFinished() error\n\tBlockUntilAggregatedNonprimaryProcsReport() (types.Report, error)\n\tFetchNextCounter() (int, error)\n\tPostAbort() error\n\tShouldAbort() bool\n\tPostEmitProgressReport(report types.ProgressReport) error\n\tWrite(p []byte) (int, error)\n}\n\nfunc NewServer(parallelTotal int, reporter reporters.Reporter) (Server, error) {\n\tif os.Getenv(\"GINKGO_PARALLEL_PROTOCOL\") == \"HTTP\" {\n\t\treturn newHttpServer(parallelTotal, reporter)\n\t} else {\n\t\treturn newRPCServer(parallelTotal, reporter)\n\t}\n}\n\nfunc NewClient(serverHost string) Client {\n\tif os.Getenv(\"GINKGO_PARALLEL_PROTOCOL\") == \"HTTP\" {\n\t\treturn newHttpClient(serverHost)\n\t} else {\n\t\treturn newRPCClient(serverHost)\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/parallel_support/http_client.go",
"content": "package parallel_support\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype httpClient struct {\n\tserverHost string\n}\n\nfunc newHttpClient(serverHost string) *httpClient {\n\treturn &httpClient{\n\t\tserverHost: serverHost,\n\t}\n}\n\nfunc (client *httpClient) Connect() bool {\n\tresp, err := http.Get(client.serverHost + \"/up\")\n\tif err != nil {\n\t\treturn false\n\t}\n\tresp.Body.Close()\n\treturn resp.StatusCode == http.StatusOK\n}\n\nfunc (client *httpClient) Close() error {\n\treturn nil\n}\n\nfunc (client *httpClient) post(path string, data any) error {\n\tvar body io.Reader\n\tif data != nil {\n\t\tencoded, err := json.Marshal(data)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tbody = bytes.NewBuffer(encoded)\n\t}\n\tresp, err := http.Post(client.serverHost+path, \"application/json\", body)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer resp.Body.Close()\n\tif resp.StatusCode != http.StatusOK {\n\t\treturn fmt.Errorf(\"received unexpected status code %d\", resp.StatusCode)\n\t}\n\treturn nil\n}\n\nfunc (client *httpClient) poll(path string, data any) error {\n\tfor {\n\t\tresp, err := http.Get(client.serverHost + path)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif resp.StatusCode == http.StatusTooEarly {\n\t\t\tresp.Body.Close()\n\t\t\ttime.Sleep(POLLING_INTERVAL)\n\t\t\tcontinue\n\t\t}\n\t\tdefer resp.Body.Close()\n\t\tif resp.StatusCode == http.StatusGone {\n\t\t\treturn ErrorGone\n\t\t}\n\t\tif resp.StatusCode == http.StatusFailedDependency {\n\t\t\treturn ErrorFailed\n\t\t}\n\t\tif resp.StatusCode != http.StatusOK {\n\t\t\treturn fmt.Errorf(\"received unexpected status code %d\", resp.StatusCode)\n\t\t}\n\t\tif data != nil {\n\t\t\treturn json.NewDecoder(resp.Body).Decode(data)\n\t\t}\n\t\treturn nil\n\t}\n}\n\nfunc (client *httpClient) PostSuiteWillBegin(report types.Report) error {\n\treturn client.post(\"/suite-will-begin\", report)\n}\n\nfunc (client *httpClient) PostDidRun(report types.SpecReport) error {\n\treturn client.post(\"/did-run\", report)\n}\n\nfunc (client *httpClient) PostSuiteDidEnd(report types.Report) error {\n\treturn client.post(\"/suite-did-end\", report)\n}\n\nfunc (client *httpClient) PostEmitProgressReport(report types.ProgressReport) error {\n\treturn client.post(\"/progress-report\", report)\n}\n\nfunc (client *httpClient) PostReportBeforeSuiteCompleted(state types.SpecState) error {\n\treturn client.post(\"/report-before-suite-completed\", state)\n}\n\nfunc (client *httpClient) BlockUntilReportBeforeSuiteCompleted() (types.SpecState, error) {\n\tvar state types.SpecState\n\terr := client.poll(\"/report-before-suite-state\", &state)\n\tif err == ErrorGone {\n\t\treturn types.SpecStateFailed, nil\n\t}\n\treturn state, err\n}\n\nfunc (client *httpClient) PostSynchronizedBeforeSuiteCompleted(state types.SpecState, data []byte) error {\n\tbeforeSuiteState := BeforeSuiteState{\n\t\tState: state,\n\t\tData: data,\n\t}\n\treturn client.post(\"/before-suite-completed\", beforeSuiteState)\n}\n\nfunc (client *httpClient) BlockUntilSynchronizedBeforeSuiteData() (types.SpecState, []byte, error) {\n\tvar beforeSuiteState BeforeSuiteState\n\terr := client.poll(\"/before-suite-state\", &beforeSuiteState)\n\tif err == ErrorGone {\n\t\treturn types.SpecStateInvalid, nil, types.GinkgoErrors.SynchronizedBeforeSuiteDisappearedOnProc1()\n\t}\n\treturn beforeSuiteState.State, beforeSuiteState.Data, err\n}\n\nfunc (client *httpClient) BlockUntilNonprimaryProcsHaveFinished() error {\n\treturn client.poll(\"/have-nonprimary-procs-finished\", nil)\n}\n\nfunc (client *httpClient) BlockUntilAggregatedNonprimaryProcsReport() (types.Report, error) {\n\tvar report types.Report\n\terr := client.poll(\"/aggregated-nonprimary-procs-report\", &report)\n\tif err == ErrorGone {\n\t\treturn types.Report{}, types.GinkgoErrors.AggregatedReportUnavailableDueToNodeDisappearing()\n\t}\n\treturn report, err\n}\n\nfunc (client *httpClient) FetchNextCounter() (int, error) {\n\tvar counter ParallelIndexCounter\n\terr := client.poll(\"/counter\", &counter)\n\treturn counter.Index, err\n}\n\nfunc (client *httpClient) PostAbort() error {\n\treturn client.post(\"/abort\", nil)\n}\n\nfunc (client *httpClient) ShouldAbort() bool {\n\terr := client.poll(\"/abort\", nil)\n\treturn err == ErrorGone\n}\n\nfunc (client *httpClient) Write(p []byte) (int, error) {\n\tresp, err := http.Post(client.serverHost+\"/emit-output\", \"text/plain;charset=UTF-8 \", bytes.NewReader(p))\n\tresp.Body.Close()\n\tif resp.StatusCode != http.StatusOK {\n\t\treturn 0, fmt.Errorf(\"failed to emit output\")\n\t}\n\treturn len(p), err\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/parallel_support/http_server.go",
"content": "/*\n\nThe remote package provides the pieces to allow Ginkgo test suites to report to remote listeners.\nThis is used, primarily, to enable streaming parallel test output but has, in principal, broader applications (e.g. streaming test output to a browser).\n\n*/\n\npackage parallel_support\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net\"\n\t\"net/http\"\n\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n/*\nhttpServer spins up on an automatically selected port and listens for communication from the forwarding reporter.\nIt then forwards that communication to attached reporters.\n*/\ntype httpServer struct {\n\tlistener net.Listener\n\thandler *ServerHandler\n}\n\n// Create a new server, automatically selecting a port\nfunc newHttpServer(parallelTotal int, reporter reporters.Reporter) (*httpServer, error) {\n\tlistener, err := net.Listen(\"tcp\", \"127.0.0.1:0\")\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn &httpServer{\n\t\tlistener: listener,\n\t\thandler: newServerHandler(parallelTotal, reporter),\n\t}, nil\n}\n\n// Start the server. You don't need to `go s.Start()`, just `s.Start()`\nfunc (server *httpServer) Start() {\n\thttpServer := &http.Server{}\n\tmux := http.NewServeMux()\n\thttpServer.Handler = mux\n\n\t//streaming endpoints\n\tmux.HandleFunc(\"/suite-will-begin\", server.specSuiteWillBegin)\n\tmux.HandleFunc(\"/did-run\", server.didRun)\n\tmux.HandleFunc(\"/suite-did-end\", server.specSuiteDidEnd)\n\tmux.HandleFunc(\"/emit-output\", server.emitOutput)\n\tmux.HandleFunc(\"/progress-report\", server.emitProgressReport)\n\n\t//synchronization endpoints\n\tmux.HandleFunc(\"/report-before-suite-completed\", server.handleReportBeforeSuiteCompleted)\n\tmux.HandleFunc(\"/report-before-suite-state\", server.handleReportBeforeSuiteState)\n\tmux.HandleFunc(\"/before-suite-completed\", server.handleBeforeSuiteCompleted)\n\tmux.HandleFunc(\"/before-suite-state\", server.handleBeforeSuiteState)\n\tmux.HandleFunc(\"/have-nonprimary-procs-finished\", server.handleHaveNonprimaryProcsFinished)\n\tmux.HandleFunc(\"/aggregated-nonprimary-procs-report\", server.handleAggregatedNonprimaryProcsReport)\n\tmux.HandleFunc(\"/counter\", server.handleCounter)\n\tmux.HandleFunc(\"/up\", server.handleUp)\n\tmux.HandleFunc(\"/abort\", server.handleAbort)\n\n\tgo httpServer.Serve(server.listener)\n}\n\n// Stop the server\nfunc (server *httpServer) Close() {\n\tserver.listener.Close()\n}\n\n// The address the server can be reached it. Pass this into the `ForwardingReporter`.\nfunc (server *httpServer) Address() string {\n\treturn \"http://\" + server.listener.Addr().String()\n}\n\nfunc (server *httpServer) GetSuiteDone() chan any {\n\treturn server.handler.done\n}\n\nfunc (server *httpServer) GetOutputDestination() io.Writer {\n\treturn server.handler.outputDestination\n}\n\nfunc (server *httpServer) SetOutputDestination(w io.Writer) {\n\tserver.handler.outputDestination = w\n}\n\nfunc (server *httpServer) RegisterAlive(node int, alive func() bool) {\n\tserver.handler.registerAlive(node, alive)\n}\n\n//\n// Streaming Endpoints\n//\n\n// The server will forward all received messages to Ginkgo reporters registered with `RegisterReporters`\nfunc (server *httpServer) decode(writer http.ResponseWriter, request *http.Request, object any) bool {\n\tdefer request.Body.Close()\n\tif json.NewDecoder(request.Body).Decode(object) != nil {\n\t\twriter.WriteHeader(http.StatusBadRequest)\n\t\treturn false\n\t}\n\treturn true\n}\n\nfunc (server *httpServer) handleError(err error, writer http.ResponseWriter) bool {\n\tif err == nil {\n\t\treturn false\n\t}\n\tswitch err {\n\tcase ErrorEarly:\n\t\twriter.WriteHeader(http.StatusTooEarly)\n\tcase ErrorGone:\n\t\twriter.WriteHeader(http.StatusGone)\n\tcase ErrorFailed:\n\t\twriter.WriteHeader(http.StatusFailedDependency)\n\tdefault:\n\t\twriter.WriteHeader(http.StatusInternalServerError)\n\t}\n\treturn true\n}\n\nfunc (server *httpServer) specSuiteWillBegin(writer http.ResponseWriter, request *http.Request) {\n\tvar report types.Report\n\tif !server.decode(writer, request, &report) {\n\t\treturn\n\t}\n\n\tserver.handleError(server.handler.SpecSuiteWillBegin(report, voidReceiver), writer)\n}\n\nfunc (server *httpServer) didRun(writer http.ResponseWriter, request *http.Request) {\n\tvar report types.SpecReport\n\tif !server.decode(writer, request, &report) {\n\t\treturn\n\t}\n\n\tserver.handleError(server.handler.DidRun(report, voidReceiver), writer)\n}\n\nfunc (server *httpServer) specSuiteDidEnd(writer http.ResponseWriter, request *http.Request) {\n\tvar report types.Report\n\tif !server.decode(writer, request, &report) {\n\t\treturn\n\t}\n\tserver.handleError(server.handler.SpecSuiteDidEnd(report, voidReceiver), writer)\n}\n\nfunc (server *httpServer) emitOutput(writer http.ResponseWriter, request *http.Request) {\n\toutput, err := io.ReadAll(request.Body)\n\tif err != nil {\n\t\twriter.WriteHeader(http.StatusInternalServerError)\n\t\treturn\n\t}\n\tvar n int\n\tserver.handleError(server.handler.EmitOutput(output, &n), writer)\n}\n\nfunc (server *httpServer) emitProgressReport(writer http.ResponseWriter, request *http.Request) {\n\tvar report types.ProgressReport\n\tif !server.decode(writer, request, &report) {\n\t\treturn\n\t}\n\tserver.handleError(server.handler.EmitProgressReport(report, voidReceiver), writer)\n}\n\nfunc (server *httpServer) handleReportBeforeSuiteCompleted(writer http.ResponseWriter, request *http.Request) {\n\tvar state types.SpecState\n\tif !server.decode(writer, request, &state) {\n\t\treturn\n\t}\n\n\tserver.handleError(server.handler.ReportBeforeSuiteCompleted(state, voidReceiver), writer)\n}\n\nfunc (server *httpServer) handleReportBeforeSuiteState(writer http.ResponseWriter, request *http.Request) {\n\tvar state types.SpecState\n\tif server.handleError(server.handler.ReportBeforeSuiteState(voidSender, &state), writer) {\n\t\treturn\n\t}\n\tjson.NewEncoder(writer).Encode(state)\n}\n\nfunc (server *httpServer) handleBeforeSuiteCompleted(writer http.ResponseWriter, request *http.Request) {\n\tvar beforeSuiteState BeforeSuiteState\n\tif !server.decode(writer, request, &beforeSuiteState) {\n\t\treturn\n\t}\n\n\tserver.handleError(server.handler.BeforeSuiteCompleted(beforeSuiteState, voidReceiver), writer)\n}\n\nfunc (server *httpServer) handleBeforeSuiteState(writer http.ResponseWriter, request *http.Request) {\n\tvar beforeSuiteState BeforeSuiteState\n\tif server.handleError(server.handler.BeforeSuiteState(voidSender, &beforeSuiteState), writer) {\n\t\treturn\n\t}\n\tjson.NewEncoder(writer).Encode(beforeSuiteState)\n}\n\nfunc (server *httpServer) handleHaveNonprimaryProcsFinished(writer http.ResponseWriter, request *http.Request) {\n\tif server.handleError(server.handler.HaveNonprimaryProcsFinished(voidSender, voidReceiver), writer) {\n\t\treturn\n\t}\n\twriter.WriteHeader(http.StatusOK)\n}\n\nfunc (server *httpServer) handleAggregatedNonprimaryProcsReport(writer http.ResponseWriter, request *http.Request) {\n\tvar aggregatedReport types.Report\n\tif server.handleError(server.handler.AggregatedNonprimaryProcsReport(voidSender, &aggregatedReport), writer) {\n\t\treturn\n\t}\n\tjson.NewEncoder(writer).Encode(aggregatedReport)\n}\n\nfunc (server *httpServer) handleCounter(writer http.ResponseWriter, request *http.Request) {\n\tvar n int\n\tif server.handleError(server.handler.Counter(voidSender, &n), writer) {\n\t\treturn\n\t}\n\tjson.NewEncoder(writer).Encode(ParallelIndexCounter{Index: n})\n}\n\nfunc (server *httpServer) handleUp(writer http.ResponseWriter, request *http.Request) {\n\twriter.WriteHeader(http.StatusOK)\n}\n\nfunc (server *httpServer) handleAbort(writer http.ResponseWriter, request *http.Request) {\n\tif request.Method == \"GET\" {\n\t\tvar shouldAbort bool\n\t\tserver.handler.ShouldAbort(voidSender, &shouldAbort)\n\t\tif shouldAbort {\n\t\t\twriter.WriteHeader(http.StatusGone)\n\t\t} else {\n\t\t\twriter.WriteHeader(http.StatusOK)\n\t\t}\n\t} else {\n\t\tserver.handler.Abort(voidSender, voidReceiver)\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/parallel_support/rpc_client.go",
"content": "package parallel_support\n\nimport (\n\t\"net/rpc\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype rpcClient struct {\n\tserverHost string\n\tclient *rpc.Client\n}\n\nfunc newRPCClient(serverHost string) *rpcClient {\n\treturn &rpcClient{\n\t\tserverHost: serverHost,\n\t}\n}\n\nfunc (client *rpcClient) Connect() bool {\n\tvar err error\n\tif client.client != nil {\n\t\treturn true\n\t}\n\tclient.client, err = rpc.DialHTTPPath(\"tcp\", client.serverHost, \"/\")\n\tif err != nil {\n\t\tclient.client = nil\n\t\treturn false\n\t}\n\treturn true\n}\n\nfunc (client *rpcClient) Close() error {\n\treturn client.client.Close()\n}\n\nfunc (client *rpcClient) poll(method string, data any) error {\n\tfor {\n\t\terr := client.client.Call(method, voidSender, data)\n\t\tif err == nil {\n\t\t\treturn nil\n\t\t}\n\t\tswitch err.Error() {\n\t\tcase ErrorEarly.Error():\n\t\t\ttime.Sleep(POLLING_INTERVAL)\n\t\tcase ErrorGone.Error():\n\t\t\treturn ErrorGone\n\t\tcase ErrorFailed.Error():\n\t\t\treturn ErrorFailed\n\t\tdefault:\n\t\t\treturn err\n\t\t}\n\t}\n}\n\nfunc (client *rpcClient) PostSuiteWillBegin(report types.Report) error {\n\treturn client.client.Call(\"Server.SpecSuiteWillBegin\", report, voidReceiver)\n}\n\nfunc (client *rpcClient) PostDidRun(report types.SpecReport) error {\n\treturn client.client.Call(\"Server.DidRun\", report, voidReceiver)\n}\n\nfunc (client *rpcClient) PostSuiteDidEnd(report types.Report) error {\n\treturn client.client.Call(\"Server.SpecSuiteDidEnd\", report, voidReceiver)\n}\n\nfunc (client *rpcClient) Write(p []byte) (int, error) {\n\tvar n int\n\terr := client.client.Call(\"Server.EmitOutput\", p, &n)\n\treturn n, err\n}\n\nfunc (client *rpcClient) PostEmitProgressReport(report types.ProgressReport) error {\n\treturn client.client.Call(\"Server.EmitProgressReport\", report, voidReceiver)\n}\n\nfunc (client *rpcClient) PostReportBeforeSuiteCompleted(state types.SpecState) error {\n\treturn client.client.Call(\"Server.ReportBeforeSuiteCompleted\", state, voidReceiver)\n}\n\nfunc (client *rpcClient) BlockUntilReportBeforeSuiteCompleted() (types.SpecState, error) {\n\tvar state types.SpecState\n\terr := client.poll(\"Server.ReportBeforeSuiteState\", &state)\n\tif err == ErrorGone {\n\t\treturn types.SpecStateFailed, nil\n\t}\n\treturn state, err\n}\n\nfunc (client *rpcClient) PostSynchronizedBeforeSuiteCompleted(state types.SpecState, data []byte) error {\n\tbeforeSuiteState := BeforeSuiteState{\n\t\tState: state,\n\t\tData: data,\n\t}\n\treturn client.client.Call(\"Server.BeforeSuiteCompleted\", beforeSuiteState, voidReceiver)\n}\n\nfunc (client *rpcClient) BlockUntilSynchronizedBeforeSuiteData() (types.SpecState, []byte, error) {\n\tvar beforeSuiteState BeforeSuiteState\n\terr := client.poll(\"Server.BeforeSuiteState\", &beforeSuiteState)\n\tif err == ErrorGone {\n\t\treturn types.SpecStateInvalid, nil, types.GinkgoErrors.SynchronizedBeforeSuiteDisappearedOnProc1()\n\t}\n\treturn beforeSuiteState.State, beforeSuiteState.Data, err\n}\n\nfunc (client *rpcClient) BlockUntilNonprimaryProcsHaveFinished() error {\n\treturn client.poll(\"Server.HaveNonprimaryProcsFinished\", voidReceiver)\n}\n\nfunc (client *rpcClient) BlockUntilAggregatedNonprimaryProcsReport() (types.Report, error) {\n\tvar report types.Report\n\terr := client.poll(\"Server.AggregatedNonprimaryProcsReport\", &report)\n\tif err == ErrorGone {\n\t\treturn types.Report{}, types.GinkgoErrors.AggregatedReportUnavailableDueToNodeDisappearing()\n\t}\n\treturn report, err\n}\n\nfunc (client *rpcClient) FetchNextCounter() (int, error) {\n\tvar counter int\n\terr := client.client.Call(\"Server.Counter\", voidSender, &counter)\n\treturn counter, err\n}\n\nfunc (client *rpcClient) PostAbort() error {\n\treturn client.client.Call(\"Server.Abort\", voidSender, voidReceiver)\n}\n\nfunc (client *rpcClient) ShouldAbort() bool {\n\tvar shouldAbort bool\n\tclient.client.Call(\"Server.ShouldAbort\", voidSender, &shouldAbort)\n\treturn shouldAbort\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/parallel_support/rpc_server.go",
"content": "/*\n\nThe remote package provides the pieces to allow Ginkgo test suites to report to remote listeners.\nThis is used, primarily, to enable streaming parallel test output but has, in principal, broader applications (e.g. streaming test output to a browser).\n\n*/\n\npackage parallel_support\n\nimport (\n\t\"io\"\n\t\"net\"\n\t\"net/http\"\n\t\"net/rpc\"\n\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n)\n\n/*\nRPCServer spins up on an automatically selected port and listens for communication from the forwarding reporter.\nIt then forwards that communication to attached reporters.\n*/\ntype RPCServer struct {\n\tlistener net.Listener\n\thandler *ServerHandler\n}\n\n// Create a new server, automatically selecting a port\nfunc newRPCServer(parallelTotal int, reporter reporters.Reporter) (*RPCServer, error) {\n\tlistener, err := net.Listen(\"tcp\", \"127.0.0.1:0\")\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn &RPCServer{\n\t\tlistener: listener,\n\t\thandler: newServerHandler(parallelTotal, reporter),\n\t}, nil\n}\n\n// Start the server. You don't need to `go s.Start()`, just `s.Start()`\nfunc (server *RPCServer) Start() {\n\trpcServer := rpc.NewServer()\n\trpcServer.RegisterName(\"Server\", server.handler) //register the handler's methods as the server\n\n\thttpServer := &http.Server{}\n\thttpServer.Handler = rpcServer\n\n\tgo httpServer.Serve(server.listener)\n}\n\n// Stop the server\nfunc (server *RPCServer) Close() {\n\tserver.listener.Close()\n}\n\n// The address the server can be reached it. Pass this into the `ForwardingReporter`.\nfunc (server *RPCServer) Address() string {\n\treturn server.listener.Addr().String()\n}\n\nfunc (server *RPCServer) GetSuiteDone() chan any {\n\treturn server.handler.done\n}\n\nfunc (server *RPCServer) GetOutputDestination() io.Writer {\n\treturn server.handler.outputDestination\n}\n\nfunc (server *RPCServer) SetOutputDestination(w io.Writer) {\n\tserver.handler.outputDestination = w\n}\n\nfunc (server *RPCServer) RegisterAlive(node int, alive func() bool) {\n\tserver.handler.registerAlive(node, alive)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/parallel_support/server_handler.go",
"content": "package parallel_support\n\nimport (\n\t\"io\"\n\t\"os\"\n\t\"sync\"\n\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype Void struct{}\n\nvar voidReceiver *Void = &Void{}\nvar voidSender Void\n\n// ServerHandler is an RPC-compatible handler that is shared between the http server and the rpc server.\n// It handles all the business logic to avoid duplication between the two servers\n\ntype ServerHandler struct {\n\tdone chan any\n\toutputDestination io.Writer\n\treporter reporters.Reporter\n\talives []func() bool\n\tlock *sync.Mutex\n\tbeforeSuiteState BeforeSuiteState\n\treportBeforeSuiteState types.SpecState\n\tparallelTotal int\n\tcounter int\n\tcounterLock *sync.Mutex\n\tshouldAbort bool\n\n\tnumSuiteDidBegins int\n\tnumSuiteDidEnds int\n\taggregatedReport types.Report\n\treportHoldingArea []types.SpecReport\n}\n\nfunc newServerHandler(parallelTotal int, reporter reporters.Reporter) *ServerHandler {\n\treturn &ServerHandler{\n\t\treporter: reporter,\n\t\tlock: &sync.Mutex{},\n\t\tcounterLock: &sync.Mutex{},\n\t\talives: make([]func() bool, parallelTotal),\n\t\tbeforeSuiteState: BeforeSuiteState{Data: nil, State: types.SpecStateInvalid},\n\n\t\tparallelTotal: parallelTotal,\n\t\toutputDestination: os.Stdout,\n\t\tdone: make(chan any),\n\t}\n}\n\nfunc (handler *ServerHandler) SpecSuiteWillBegin(report types.Report, _ *Void) error {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\n\thandler.numSuiteDidBegins += 1\n\n\t// all summaries are identical, so it's fine to simply emit the last one of these\n\tif handler.numSuiteDidBegins == handler.parallelTotal {\n\t\thandler.reporter.SuiteWillBegin(report)\n\n\t\tfor _, summary := range handler.reportHoldingArea {\n\t\t\thandler.reporter.WillRun(summary)\n\t\t\thandler.reporter.DidRun(summary)\n\t\t}\n\n\t\thandler.reportHoldingArea = nil\n\t}\n\n\treturn nil\n}\n\nfunc (handler *ServerHandler) DidRun(report types.SpecReport, _ *Void) error {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\n\tif handler.numSuiteDidBegins == handler.parallelTotal {\n\t\thandler.reporter.WillRun(report)\n\t\thandler.reporter.DidRun(report)\n\t} else {\n\t\thandler.reportHoldingArea = append(handler.reportHoldingArea, report)\n\t}\n\n\treturn nil\n}\n\nfunc (handler *ServerHandler) SpecSuiteDidEnd(report types.Report, _ *Void) error {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\n\thandler.numSuiteDidEnds += 1\n\tif handler.numSuiteDidEnds == 1 {\n\t\thandler.aggregatedReport = report\n\t} else {\n\t\thandler.aggregatedReport = handler.aggregatedReport.Add(report)\n\t}\n\n\tif handler.numSuiteDidEnds == handler.parallelTotal {\n\t\thandler.reporter.SuiteDidEnd(handler.aggregatedReport)\n\t\tclose(handler.done)\n\t}\n\n\treturn nil\n}\n\nfunc (handler *ServerHandler) EmitOutput(output []byte, n *int) error {\n\tvar err error\n\t*n, err = handler.outputDestination.Write(output)\n\treturn err\n}\n\nfunc (handler *ServerHandler) EmitProgressReport(report types.ProgressReport, _ *Void) error {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\thandler.reporter.EmitProgressReport(report)\n\treturn nil\n}\n\nfunc (handler *ServerHandler) registerAlive(proc int, alive func() bool) {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\thandler.alives[proc-1] = alive\n}\n\nfunc (handler *ServerHandler) procIsAlive(proc int) bool {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\talive := handler.alives[proc-1]\n\tif alive == nil {\n\t\treturn true\n\t}\n\treturn alive()\n}\n\nfunc (handler *ServerHandler) haveNonprimaryProcsFinished() bool {\n\tfor i := 2; i <= handler.parallelTotal; i++ {\n\t\tif handler.procIsAlive(i) {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\nfunc (handler *ServerHandler) ReportBeforeSuiteCompleted(reportBeforeSuiteState types.SpecState, _ *Void) error {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\thandler.reportBeforeSuiteState = reportBeforeSuiteState\n\n\treturn nil\n}\n\nfunc (handler *ServerHandler) ReportBeforeSuiteState(_ Void, reportBeforeSuiteState *types.SpecState) error {\n\tproc1IsAlive := handler.procIsAlive(1)\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\tif handler.reportBeforeSuiteState == types.SpecStateInvalid {\n\t\tif proc1IsAlive {\n\t\t\treturn ErrorEarly\n\t\t} else {\n\t\t\treturn ErrorGone\n\t\t}\n\t}\n\t*reportBeforeSuiteState = handler.reportBeforeSuiteState\n\treturn nil\n}\n\nfunc (handler *ServerHandler) BeforeSuiteCompleted(beforeSuiteState BeforeSuiteState, _ *Void) error {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\thandler.beforeSuiteState = beforeSuiteState\n\n\treturn nil\n}\n\nfunc (handler *ServerHandler) BeforeSuiteState(_ Void, beforeSuiteState *BeforeSuiteState) error {\n\tproc1IsAlive := handler.procIsAlive(1)\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\tif handler.beforeSuiteState.State == types.SpecStateInvalid {\n\t\tif proc1IsAlive {\n\t\t\treturn ErrorEarly\n\t\t} else {\n\t\t\treturn ErrorGone\n\t\t}\n\t}\n\t*beforeSuiteState = handler.beforeSuiteState\n\treturn nil\n}\n\nfunc (handler *ServerHandler) HaveNonprimaryProcsFinished(_ Void, _ *Void) error {\n\tif handler.haveNonprimaryProcsFinished() {\n\t\treturn nil\n\t} else {\n\t\treturn ErrorEarly\n\t}\n}\n\nfunc (handler *ServerHandler) AggregatedNonprimaryProcsReport(_ Void, report *types.Report) error {\n\tif handler.haveNonprimaryProcsFinished() {\n\t\thandler.lock.Lock()\n\t\tdefer handler.lock.Unlock()\n\t\tif handler.numSuiteDidEnds == handler.parallelTotal-1 {\n\t\t\t*report = handler.aggregatedReport\n\t\t\treturn nil\n\t\t} else {\n\t\t\treturn ErrorGone\n\t\t}\n\t} else {\n\t\treturn ErrorEarly\n\t}\n}\n\nfunc (handler *ServerHandler) Counter(_ Void, counter *int) error {\n\thandler.counterLock.Lock()\n\tdefer handler.counterLock.Unlock()\n\t*counter = handler.counter\n\thandler.counter++\n\treturn nil\n}\n\nfunc (handler *ServerHandler) Abort(_ Void, _ *Void) error {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\thandler.shouldAbort = true\n\treturn nil\n}\n\nfunc (handler *ServerHandler) ShouldAbort(_ Void, shouldAbort *bool) error {\n\thandler.lock.Lock()\n\tdefer handler.lock.Unlock()\n\t*shouldAbort = handler.shouldAbort\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/progress_report.go",
"content": "package internal\n\nimport (\n\t\"bufio\"\n\t\"bytes\"\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\t\"os/signal\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nvar _SOURCE_CACHE = map[string][]string{}\n\ntype ProgressSignalRegistrar func(func()) context.CancelFunc\n\nfunc RegisterForProgressSignal(handler func()) context.CancelFunc {\n\tsignalChannel := make(chan os.Signal, 1)\n\tif len(PROGRESS_SIGNALS) > 0 {\n\t\tsignal.Notify(signalChannel, PROGRESS_SIGNALS...)\n\t}\n\tctx, cancel := context.WithCancel(context.Background())\n\tgo func() {\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase <-signalChannel:\n\t\t\t\thandler()\n\t\t\tcase <-ctx.Done():\n\t\t\t\tsignal.Stop(signalChannel)\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn cancel\n}\n\ntype ProgressStepCursor struct {\n\tText string\n\tCodeLocation types.CodeLocation\n\tStartTime time.Time\n}\n\nfunc NewProgressReport(isRunningInParallel bool, report types.SpecReport, currentNode Node, currentNodeStartTime time.Time, currentStep types.SpecEvent, gwOutput string, timelineLocation types.TimelineLocation, additionalReports []string, sourceRoots []string, includeAll bool) (types.ProgressReport, error) {\n\tpr := types.ProgressReport{\n\t\tParallelProcess: report.ParallelProcess,\n\t\tRunningInParallel: isRunningInParallel,\n\t\tContainerHierarchyTexts: report.ContainerHierarchyTexts,\n\t\tLeafNodeText: report.LeafNodeText,\n\t\tLeafNodeLocation: report.LeafNodeLocation,\n\t\tSpecStartTime: report.StartTime,\n\n\t\tCurrentNodeType: currentNode.NodeType,\n\t\tCurrentNodeText: currentNode.Text,\n\t\tCurrentNodeLocation: currentNode.CodeLocation,\n\t\tCurrentNodeStartTime: currentNodeStartTime,\n\n\t\tCurrentStepText: currentStep.Message,\n\t\tCurrentStepLocation: currentStep.CodeLocation,\n\t\tCurrentStepStartTime: currentStep.TimelineLocation.Time,\n\n\t\tAdditionalReports: additionalReports,\n\n\t\tCapturedGinkgoWriterOutput: gwOutput,\n\t\tTimelineLocation: timelineLocation,\n\t}\n\n\tgoroutines, err := extractRunningGoroutines()\n\tif err != nil {\n\t\treturn pr, err\n\t}\n\tpr.Goroutines = goroutines\n\n\t// now we want to try to find goroutines of interest. these will be goroutines that have any function calls with code in packagesOfInterest:\n\tpackagesOfInterest := map[string]bool{}\n\tpackageFromFilename := func(filename string) string {\n\t\treturn filepath.Dir(filename)\n\t}\n\taddPackageFor := func(filename string) {\n\t\tif filename != \"\" {\n\t\t\tpackagesOfInterest[packageFromFilename(filename)] = true\n\t\t}\n\t}\n\tisPackageOfInterest := func(filename string) bool {\n\t\tstackPackage := packageFromFilename(filename)\n\t\tfor packageOfInterest := range packagesOfInterest {\n\t\t\tif strings.HasPrefix(stackPackage, packageOfInterest) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t\treturn false\n\t}\n\tfor _, location := range report.ContainerHierarchyLocations {\n\t\taddPackageFor(location.FileName)\n\t}\n\taddPackageFor(report.LeafNodeLocation.FileName)\n\taddPackageFor(currentNode.CodeLocation.FileName)\n\taddPackageFor(currentStep.CodeLocation.FileName)\n\n\t//First, we find the SpecGoroutine - this will be the goroutine that includes `runNode`\n\tspecGoRoutineIdx := -1\n\trunNodeFunctionCallIdx := -1\nOUTER:\n\tfor goroutineIdx, goroutine := range pr.Goroutines {\n\t\tfor functionCallIdx, functionCall := range goroutine.Stack {\n\t\t\tif strings.Contains(functionCall.Function, \"ginkgo/v2/internal.(*Suite).runNode.func\") {\n\t\t\t\tspecGoRoutineIdx = goroutineIdx\n\t\t\t\trunNodeFunctionCallIdx = functionCallIdx\n\t\t\t\tbreak OUTER\n\t\t\t}\n\t\t}\n\t}\n\n\t//Now, we find the first non-Ginkgo function call\n\tif specGoRoutineIdx > -1 {\n\t\tfor runNodeFunctionCallIdx >= 0 {\n\t\t\tfn := goroutines[specGoRoutineIdx].Stack[runNodeFunctionCallIdx].Function\n\t\t\tfile := goroutines[specGoRoutineIdx].Stack[runNodeFunctionCallIdx].Filename\n\t\t\t// these are all things that could potentially happen from within ginkgo\n\t\t\tif strings.Contains(fn, \"ginkgo/v2/internal\") || strings.Contains(fn, \"reflect.Value\") || strings.Contains(file, \"ginkgo/table_dsl\") || strings.Contains(file, \"ginkgo/core_dsl\") {\n\t\t\t\trunNodeFunctionCallIdx--\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif strings.Contains(goroutines[specGoRoutineIdx].Stack[runNodeFunctionCallIdx].Function, \"ginkgo/table_dsl\") {\n\n\t\t\t}\n\t\t\t//found it! lets add its package of interest\n\t\t\taddPackageFor(goroutines[specGoRoutineIdx].Stack[runNodeFunctionCallIdx].Filename)\n\t\t\tbreak\n\t\t}\n\t}\n\n\tginkgoEntryPointIdx := -1\nOUTER_GINKGO_ENTRY_POINT:\n\tfor goroutineIdx, goroutine := range pr.Goroutines {\n\t\tfor _, functionCall := range goroutine.Stack {\n\t\t\tif strings.Contains(functionCall.Function, \"ginkgo/v2.RunSpecs\") {\n\t\t\t\tginkgoEntryPointIdx = goroutineIdx\n\t\t\t\tbreak OUTER_GINKGO_ENTRY_POINT\n\t\t\t}\n\t\t}\n\t}\n\n\t// Now we go through all goroutines and highlight any lines with packages in `packagesOfInterest`\n\t// Any goroutines with highlighted lines end up in the HighlightGoRoutines\n\tfor goroutineIdx, goroutine := range pr.Goroutines {\n\t\tif goroutineIdx == ginkgoEntryPointIdx {\n\t\t\tcontinue\n\t\t}\n\t\tif goroutineIdx == specGoRoutineIdx {\n\t\t\tpr.Goroutines[goroutineIdx].IsSpecGoroutine = true\n\t\t}\n\t\tfor functionCallIdx, functionCall := range goroutine.Stack {\n\t\t\tif isPackageOfInterest(functionCall.Filename) {\n\t\t\t\tgoroutine.Stack[functionCallIdx].Highlight = true\n\t\t\t\tgoroutine.Stack[functionCallIdx].Source, goroutine.Stack[functionCallIdx].SourceHighlight = fetchSource(functionCall.Filename, functionCall.Line, 2, sourceRoots)\n\t\t\t}\n\t\t}\n\t}\n\n\tif !includeAll {\n\t\tgoroutines := []types.Goroutine{pr.SpecGoroutine()}\n\t\tgoroutines = append(goroutines, pr.HighlightedGoroutines()...)\n\t\tpr.Goroutines = goroutines\n\t}\n\n\treturn pr, nil\n}\n\nfunc extractRunningGoroutines() ([]types.Goroutine, error) {\n\tvar stack []byte\n\tfor size := 64 * 1024; ; size *= 2 {\n\t\tstack = make([]byte, size)\n\t\tif n := runtime.Stack(stack, true); n < size {\n\t\t\tstack = stack[:n]\n\t\t\tbreak\n\t\t}\n\t}\n\tr := bufio.NewReader(bytes.NewReader(stack))\n\tout := []types.Goroutine{}\n\tidx := -1\n\tfor {\n\t\tline, err := r.ReadString('\\n')\n\t\tif err == io.EOF {\n\t\t\tbreak\n\t\t}\n\n\t\tline = strings.TrimSuffix(line, \"\\n\")\n\n\t\t//skip blank lines\n\t\tif line == \"\" {\n\t\t\tcontinue\n\t\t}\n\n\t\t//parse headers for new goroutine frames\n\t\tif strings.HasPrefix(line, \"goroutine\") {\n\t\t\tout = append(out, types.Goroutine{})\n\t\t\tidx = len(out) - 1\n\n\t\t\tline = strings.TrimPrefix(line, \"goroutine \")\n\t\t\tline = strings.TrimSuffix(line, \":\")\n\t\t\tfields := strings.SplitN(line, \" \", 2)\n\t\t\tif len(fields) != 2 {\n\t\t\t\treturn nil, types.GinkgoErrors.FailedToParseStackTrace(fmt.Sprintf(\"Invalid goroutine frame header: %s\", line))\n\t\t\t}\n\t\t\tout[idx].ID, err = strconv.ParseUint(fields[0], 10, 64)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, types.GinkgoErrors.FailedToParseStackTrace(fmt.Sprintf(\"Invalid goroutine ID: %s\", fields[1]))\n\t\t\t}\n\n\t\t\tout[idx].State = strings.TrimSuffix(strings.TrimPrefix(fields[1], \"[\"), \"]\")\n\t\t\tcontinue\n\t\t}\n\n\t\t//if we are here we must be at a function call entry in the stack\n\t\tfunctionCall := types.FunctionCall{\n\t\t\tFunction: strings.TrimPrefix(line, \"created by \"), // no need to track 'created by'\n\t\t}\n\n\t\tline, err = r.ReadString('\\n')\n\t\tline = strings.TrimSuffix(line, \"\\n\")\n\t\tif err == io.EOF {\n\t\t\treturn nil, types.GinkgoErrors.FailedToParseStackTrace(fmt.Sprintf(\"Invalid function call: %s -- missing file name and line number\", functionCall.Function))\n\t\t}\n\t\tline = strings.TrimLeft(line, \" \\t\")\n\t\tdelimiterIdx := strings.LastIndex(line, \":\")\n\t\tif delimiterIdx == -1 {\n\t\t\treturn nil, types.GinkgoErrors.FailedToParseStackTrace(fmt.Sprintf(\"Invalid filename and line number: %s\", line))\n\t\t}\n\t\tfunctionCall.Filename = line[:delimiterIdx]\n\t\tline = strings.Split(line[delimiterIdx+1:], \" \")[0]\n\t\tlineNumber, err := strconv.ParseInt(line, 10, 32)\n\t\tfunctionCall.Line = int(lineNumber)\n\t\tif err != nil {\n\t\t\treturn nil, types.GinkgoErrors.FailedToParseStackTrace(fmt.Sprintf(\"Invalid function call line number: %s\\n%s\", line, err.Error()))\n\t\t}\n\t\tout[idx].Stack = append(out[idx].Stack, functionCall)\n\t}\n\n\treturn out, nil\n}\n\nfunc fetchSource(filename string, lineNumber int, span int, configuredSourceRoots []string) ([]string, int) {\n\tif filename == \"\" {\n\t\treturn []string{}, 0\n\t}\n\n\tvar lines []string\n\tvar ok bool\n\tif lines, ok = _SOURCE_CACHE[filename]; !ok {\n\t\tsourceRoots := []string{\"\"}\n\t\tsourceRoots = append(sourceRoots, configuredSourceRoots...)\n\t\tvar data []byte\n\t\tvar err error\n\t\tvar found bool\n\t\tfor _, root := range sourceRoots {\n\t\t\tdata, err = os.ReadFile(filepath.Join(root, filename))\n\t\t\tif err == nil {\n\t\t\t\tfound = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !found {\n\t\t\treturn []string{}, 0\n\t\t}\n\t\tlines = strings.Split(string(data), \"\\n\")\n\t\t_SOURCE_CACHE[filename] = lines\n\t}\n\n\tstartIndex := lineNumber - span - 1\n\tendIndex := startIndex + span + span + 1\n\tif startIndex < 0 {\n\t\tstartIndex = 0\n\t}\n\tif endIndex > len(lines) {\n\t\tendIndex = len(lines)\n\t}\n\thighlightIndex := lineNumber - 1 - startIndex\n\treturn lines[startIndex:endIndex], highlightIndex\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/progress_report_bsd.go",
"content": "//go:build freebsd || openbsd || netbsd || darwin || dragonfly\n// +build freebsd openbsd netbsd darwin dragonfly\n\npackage internal\n\nimport (\n\t\"os\"\n\t\"syscall\"\n)\n\nvar PROGRESS_SIGNALS = []os.Signal{syscall.SIGINFO, syscall.SIGUSR1}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/progress_report_unix.go",
"content": "//go:build linux || solaris\n// +build linux solaris\n\npackage internal\n\nimport (\n\t\"os\"\n\t\"syscall\"\n)\n\nvar PROGRESS_SIGNALS = []os.Signal{syscall.SIGUSR1}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/progress_report_wasm.go",
"content": "//go:build wasm\n\npackage internal\n\nimport (\n\t\"os\"\n\t\"syscall\"\n)\n\nvar PROGRESS_SIGNALS = []os.Signal{syscall.SIGUSR1}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/progress_report_win.go",
"content": "//go:build windows\n// +build windows\n\npackage internal\n\nimport \"os\"\n\nvar PROGRESS_SIGNALS = []os.Signal{}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/progress_reporter_manager.go",
"content": "package internal\n\nimport (\n\t\"context\"\n\t\"sort\"\n\t\"strings\"\n\t\"sync\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype ProgressReporterManager struct {\n\tlock *sync.Mutex\n\tprogressReporters map[int]func() string\n\tprCounter int\n}\n\nfunc NewProgressReporterManager() *ProgressReporterManager {\n\treturn &ProgressReporterManager{\n\t\tprogressReporters: map[int]func() string{},\n\t\tlock: &sync.Mutex{},\n\t}\n}\n\nfunc (prm *ProgressReporterManager) AttachProgressReporter(reporter func() string) func() {\n\tprm.lock.Lock()\n\tdefer prm.lock.Unlock()\n\tprm.prCounter += 1\n\tprCounter := prm.prCounter\n\tprm.progressReporters[prCounter] = reporter\n\n\treturn func() {\n\t\tprm.lock.Lock()\n\t\tdefer prm.lock.Unlock()\n\t\tdelete(prm.progressReporters, prCounter)\n\t}\n}\n\nfunc (prm *ProgressReporterManager) QueryProgressReporters(ctx context.Context, failer *Failer) []string {\n\tprm.lock.Lock()\n\tkeys := []int{}\n\tfor key := range prm.progressReporters {\n\t\tkeys = append(keys, key)\n\t}\n\tsort.Ints(keys)\n\treporters := []func() string{}\n\tfor _, key := range keys {\n\t\treporters = append(reporters, prm.progressReporters[key])\n\t}\n\tprm.lock.Unlock()\n\n\tif len(reporters) == 0 {\n\t\treturn nil\n\t}\n\tout := []string{}\n\tfor _, reporter := range reporters {\n\t\treportC := make(chan string, 1)\n\t\tgo func() {\n\t\t\tdefer func() {\n\t\t\t\te := recover()\n\t\t\t\tif e != nil {\n\t\t\t\t\tfailer.Panic(types.NewCodeLocationWithStackTrace(1), e)\n\t\t\t\t\treportC <- \"failed to query attached progress reporter\"\n\t\t\t\t}\n\t\t\t}()\n\t\t\treportC <- reporter()\n\t\t}()\n\t\tvar report string\n\t\tselect {\n\t\tcase report = <-reportC:\n\t\tcase <-ctx.Done():\n\t\t\treturn out\n\t\t}\n\t\tif strings.TrimSpace(report) != \"\" {\n\t\t\tout = append(out, report)\n\t\t}\n\t}\n\treturn out\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/report_entry.go",
"content": "package internal\n\nimport (\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype ReportEntry = types.ReportEntry\n\nfunc NewReportEntry(name string, cl types.CodeLocation, args ...any) (ReportEntry, error) {\n\tout := ReportEntry{\n\t\tVisibility: types.ReportEntryVisibilityAlways,\n\t\tName: name,\n\t\tLocation: cl,\n\t\tTime: time.Now(),\n\t}\n\tvar didSetValue = false\n\tfor _, arg := range args {\n\t\tswitch x := arg.(type) {\n\t\tcase types.ReportEntryVisibility:\n\t\t\tout.Visibility = x\n\t\tcase types.CodeLocation:\n\t\t\tout.Location = x\n\t\tcase Offset:\n\t\t\tout.Location = types.NewCodeLocation(2 + int(x))\n\t\tcase time.Time:\n\t\t\tout.Time = x\n\t\tdefault:\n\t\t\tif didSetValue {\n\t\t\t\treturn ReportEntry{}, types.GinkgoErrors.TooManyReportEntryValues(out.Location, arg)\n\t\t\t}\n\t\t\tout.Value = types.WrapEntryValue(arg)\n\t\t\tdidSetValue = true\n\t\t}\n\t}\n\n\treturn out, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/reporters/gojson.go",
"content": "package reporters\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"strings\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n\t\"golang.org/x/tools/go/packages\"\n)\n\nfunc ptr[T any](in T) *T {\n\treturn &in\n}\n\ntype encoder interface {\n\tEncode(v any) error\n}\n\n// gojsonEvent matches the format from go internals\n// https://github.com/golang/go/blob/master/src/cmd/internal/test2json/test2json.go#L31-L41\n// https://pkg.go.dev/cmd/test2json\ntype gojsonEvent struct {\n\tTime *time.Time `json:\",omitempty\"`\n\tAction GoJSONAction\n\tPackage string `json:\",omitempty\"`\n\tTest string `json:\",omitempty\"`\n\tElapsed *float64 `json:\",omitempty\"`\n\tOutput *string `json:\",omitempty\"`\n\tFailedBuild string `json:\",omitempty\"`\n}\n\ntype GoJSONAction string\n\nconst (\n\t// start - the test binary is about to be executed\n\tGoJSONStart GoJSONAction = \"start\"\n\t// run - the test has started running\n\tGoJSONRun GoJSONAction = \"run\"\n\t// pause - the test has been paused\n\tGoJSONPause GoJSONAction = \"pause\"\n\t// cont - the test has continued running\n\tGoJSONCont GoJSONAction = \"cont\"\n\t// pass - the test passed\n\tGoJSONPass GoJSONAction = \"pass\"\n\t// bench - the benchmark printed log output but did not fail\n\tGoJSONBench GoJSONAction = \"bench\"\n\t// fail - the test or benchmark failed\n\tGoJSONFail GoJSONAction = \"fail\"\n\t// output - the test printed output\n\tGoJSONOutput GoJSONAction = \"output\"\n\t// skip - the test was skipped or the package contained no tests\n\tGoJSONSkip GoJSONAction = \"skip\"\n)\n\nfunc goJSONActionFromSpecState(state types.SpecState) GoJSONAction {\n\tswitch state {\n\tcase types.SpecStateInvalid:\n\t\treturn GoJSONFail\n\tcase types.SpecStatePending:\n\t\treturn GoJSONSkip\n\tcase types.SpecStateSkipped:\n\t\treturn GoJSONSkip\n\tcase types.SpecStatePassed:\n\t\treturn GoJSONPass\n\tcase types.SpecStateFailed:\n\t\treturn GoJSONFail\n\tcase types.SpecStateAborted:\n\t\treturn GoJSONFail\n\tcase types.SpecStatePanicked:\n\t\treturn GoJSONFail\n\tcase types.SpecStateInterrupted:\n\t\treturn GoJSONFail\n\tcase types.SpecStateTimedout:\n\t\treturn GoJSONFail\n\tdefault:\n\t\tpanic(\"unexpected state should not happen\")\n\t}\n}\n\n// gojsonReport wraps types.Report and calcualtes extra fields requires by gojson\ntype gojsonReport struct {\n\to types.Report\n\t// Extra calculated fields\n\tgoPkg string\n\telapsed float64\n}\n\nfunc newReport(in types.Report) *gojsonReport {\n\treturn &gojsonReport{\n\t\to: in,\n\t}\n}\n\nfunc (r *gojsonReport) Fill() error {\n\t// NOTE: could the types.Report include the go package name?\n\tgoPkg, err := suitePathToPkg(r.o.SuitePath)\n\tif err != nil {\n\t\treturn err\n\t}\n\tr.goPkg = goPkg\n\tr.elapsed = r.o.RunTime.Seconds()\n\treturn nil\n}\n\n// gojsonSpecReport wraps types.SpecReport and calculates extra fields required by gojson\ntype gojsonSpecReport struct {\n\to types.SpecReport\n\t// extra calculated fields\n\ttestName string\n\telapsed float64\n\taction GoJSONAction\n}\n\nfunc newSpecReport(in types.SpecReport) *gojsonSpecReport {\n\treturn &gojsonSpecReport{\n\t\to: in,\n\t}\n}\n\nfunc (sr *gojsonSpecReport) Fill() error {\n\tsr.elapsed = sr.o.RunTime.Seconds()\n\tsr.testName = createTestName(sr.o)\n\tsr.action = goJSONActionFromSpecState(sr.o.State)\n\treturn nil\n}\n\nfunc suitePathToPkg(dir string) (string, error) {\n\tcfg := &packages.Config{\n\t\tMode: packages.NeedFiles | packages.NeedSyntax,\n\t}\n\tpkgs, err := packages.Load(cfg, dir)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tif len(pkgs) != 1 {\n\t\treturn \"\", errors.New(\"error\")\n\t}\n\treturn pkgs[0].ID, nil\n}\n\nfunc createTestName(spec types.SpecReport) string {\n\tname := fmt.Sprintf(\"[%s]\", spec.LeafNodeType)\n\tif spec.FullText() != \"\" {\n\t\tname = name + \" \" + spec.FullText()\n\t}\n\tlabels := spec.Labels()\n\tif len(labels) > 0 {\n\t\tname = name + \" [\" + strings.Join(labels, \", \") + \"]\"\n\t}\n\tsemVerConstraints := spec.SemVerConstraints()\n\tif len(semVerConstraints) > 0 {\n\t\tname = name + \" [\" + strings.Join(semVerConstraints, \", \") + \"]\"\n\t}\n\tcomponentSemVerConstraints := spec.ComponentSemVerConstraints()\n\tif len(componentSemVerConstraints) > 0 {\n\t\tname = name + \" [\" + formatComponentSemVerConstraintsToString(componentSemVerConstraints) + \"]\"\n\t}\n\tname = strings.TrimSpace(name)\n\treturn name\n}\n\nfunc formatComponentSemVerConstraintsToString(componentSemVerConstraints map[string][]string) string {\n\tvar tmpStr string\n\tfor component, semVerConstraints := range componentSemVerConstraints {\n\t\ttmpStr = tmpStr + fmt.Sprintf(\"%s: %s, \", component, semVerConstraints)\n\t}\n\ttmpStr = strings.TrimSuffix(tmpStr, \", \")\n\treturn tmpStr\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/reporters/gojson_event_writer.go",
"content": "package reporters\n\ntype GoJSONEventWriter struct {\n\tenc encoder\n\tspecSystemErrFn specSystemExtractFn\n\tspecSystemOutFn specSystemExtractFn\n}\n\nfunc NewGoJSONEventWriter(enc encoder, errFn specSystemExtractFn, outFn specSystemExtractFn) *GoJSONEventWriter {\n\treturn &GoJSONEventWriter{\n\t\tenc: enc,\n\t\tspecSystemErrFn: errFn,\n\t\tspecSystemOutFn: outFn,\n\t}\n}\n\nfunc (r *GoJSONEventWriter) writeEvent(e *gojsonEvent) error {\n\treturn r.enc.Encode(e)\n}\n\nfunc (r *GoJSONEventWriter) WriteSuiteStart(report *gojsonReport) error {\n\te := &gojsonEvent{\n\t\tTime: &report.o.StartTime,\n\t\tAction: GoJSONStart,\n\t\tPackage: report.goPkg,\n\t\tOutput: nil,\n\t\tFailedBuild: \"\",\n\t}\n\treturn r.writeEvent(e)\n}\n\nfunc (r *GoJSONEventWriter) WriteSuiteResult(report *gojsonReport) error {\n\tvar action GoJSONAction\n\tswitch {\n\tcase report.o.PreRunStats.SpecsThatWillRun == 0:\n\t\taction = GoJSONSkip\n\tcase report.o.SuiteSucceeded:\n\t\taction = GoJSONPass\n\tdefault:\n\t\taction = GoJSONFail\n\t}\n\te := &gojsonEvent{\n\t\tTime: &report.o.EndTime,\n\t\tAction: action,\n\t\tPackage: report.goPkg,\n\t\tOutput: nil,\n\t\tFailedBuild: \"\",\n\t\tElapsed: ptr(report.elapsed),\n\t}\n\treturn r.writeEvent(e)\n}\n\nfunc (r *GoJSONEventWriter) WriteSpecStart(report *gojsonReport, specReport *gojsonSpecReport) error {\n\te := &gojsonEvent{\n\t\tTime: &specReport.o.StartTime,\n\t\tAction: GoJSONRun,\n\t\tTest: specReport.testName,\n\t\tPackage: report.goPkg,\n\t\tOutput: nil,\n\t\tFailedBuild: \"\",\n\t}\n\treturn r.writeEvent(e)\n}\n\nfunc (r *GoJSONEventWriter) WriteSpecOut(report *gojsonReport, specReport *gojsonSpecReport) error {\n\tevents := []*gojsonEvent{}\n\n\tstdErr := r.specSystemErrFn(specReport.o)\n\tif stdErr != \"\" {\n\t\tevents = append(events, &gojsonEvent{\n\t\t\tTime: &specReport.o.EndTime,\n\t\t\tAction: GoJSONOutput,\n\t\t\tTest: specReport.testName,\n\t\t\tPackage: report.goPkg,\n\t\t\tOutput: ptr(stdErr),\n\t\t\tFailedBuild: \"\",\n\t\t})\n\t}\n\tstdOut := r.specSystemOutFn(specReport.o)\n\tif stdOut != \"\" {\n\t\tevents = append(events, &gojsonEvent{\n\t\t\tTime: &specReport.o.EndTime,\n\t\t\tAction: GoJSONOutput,\n\t\t\tTest: specReport.testName,\n\t\t\tPackage: report.goPkg,\n\t\t\tOutput: ptr(stdOut),\n\t\t\tFailedBuild: \"\",\n\t\t})\n\t}\n\n\tfor _, ev := range events {\n\t\terr := r.writeEvent(ev)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc (r *GoJSONEventWriter) WriteSpecResult(report *gojsonReport, specReport *gojsonSpecReport) error {\n\te := &gojsonEvent{\n\t\tTime: &specReport.o.EndTime,\n\t\tAction: specReport.action,\n\t\tTest: specReport.testName,\n\t\tPackage: report.goPkg,\n\t\tElapsed: ptr(specReport.elapsed),\n\t\tOutput: nil,\n\t\tFailedBuild: \"\",\n\t}\n\treturn r.writeEvent(e)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/reporters/gojson_reporter.go",
"content": "package reporters\n\nimport (\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype GoJSONReporter struct {\n\tev *GoJSONEventWriter\n}\n\ntype specSystemExtractFn func (spec types.SpecReport) string\n\nfunc NewGoJSONReporter(enc encoder, errFn specSystemExtractFn, outFn specSystemExtractFn) *GoJSONReporter {\n\treturn &GoJSONReporter{\n\t\tev: NewGoJSONEventWriter(enc, errFn, outFn),\n\t}\n}\n\nfunc (r *GoJSONReporter) Write(originalReport types.Report) error {\n\t// suite start events\n\treport := newReport(originalReport)\n\terr := report.Fill()\n\tif err != nil {\n\t\treturn err\n\t}\n\tr.ev.WriteSuiteStart(report)\n\tfor _, originalSpecReport := range originalReport.SpecReports {\n\t\tspecReport := newSpecReport(originalSpecReport)\n\t\terr := specReport.Fill()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif specReport.o.LeafNodeType == types.NodeTypeIt {\n\t\t\t// handle any It leaf node as a spec\n\t\t\tr.ev.WriteSpecStart(report, specReport)\n\t\t\tr.ev.WriteSpecOut(report, specReport)\n\t\t\tr.ev.WriteSpecResult(report, specReport)\n\t\t} else {\n\t\t\t// handle any other leaf node as generic output\n\t\t\tr.ev.WriteSpecOut(report, specReport)\n\t\t}\n\t}\n\tr.ev.WriteSuiteResult(report)\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/spec.go",
"content": "package internal\n\nimport (\n\t\"strings\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype Spec struct {\n\tNodes Nodes\n\tSkip bool\n}\n\nfunc (s Spec) SubjectID() uint {\n\treturn s.Nodes.FirstNodeWithType(types.NodeTypeIt).ID\n}\n\nfunc (s Spec) Text() string {\n\ttexts := []string{}\n\tfor i := range s.Nodes {\n\t\tif s.Nodes[i].Text != \"\" {\n\t\t\ttexts = append(texts, s.Nodes[i].Text)\n\t\t}\n\t}\n\treturn strings.Join(texts, \" \")\n}\n\nfunc (s Spec) FirstNodeWithType(nodeTypes types.NodeType) Node {\n\treturn s.Nodes.FirstNodeWithType(nodeTypes)\n}\n\nfunc (s Spec) FlakeAttempts() int {\n\tflakeAttempts := 0\n\tfor i := range s.Nodes {\n\t\tif s.Nodes[i].FlakeAttempts > 0 {\n\t\t\tflakeAttempts = s.Nodes[i].FlakeAttempts\n\t\t}\n\t}\n\n\treturn flakeAttempts\n}\n\nfunc (s Spec) MustPassRepeatedly() int {\n\tmustPassRepeatedly := 0\n\tfor i := range s.Nodes {\n\t\tif s.Nodes[i].MustPassRepeatedly > 0 {\n\t\t\tmustPassRepeatedly = s.Nodes[i].MustPassRepeatedly\n\t\t}\n\t}\n\n\treturn mustPassRepeatedly\n}\n\nfunc (s Spec) SpecTimeout() time.Duration {\n\treturn s.FirstNodeWithType(types.NodeTypeIt).SpecTimeout\n}\n\ntype Specs []Spec\n\nfunc (s Specs) HasAnySpecsMarkedPending() bool {\n\tfor i := range s {\n\t\tif s[i].Nodes.HasNodeMarkedPending() {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n\nfunc (s Specs) CountWithoutSkip() int {\n\tn := 0\n\tfor i := range s {\n\t\tif !s[i].Skip {\n\t\t\tn += 1\n\t\t}\n\t}\n\treturn n\n}\n\nfunc (s Specs) AtIndices(indices SpecIndices) Specs {\n\tout := make(Specs, len(indices))\n\tfor i, idx := range indices {\n\t\tout[i] = s[idx]\n\t}\n\treturn out\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/spec_context.go",
"content": "package internal\n\nimport (\n\t\"context\"\n\t\"reflect\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype SpecContext interface {\n\tcontext.Context\n\n\tSpecReport() types.SpecReport\n\tAttachProgressReporter(func() string) func()\n\tWrappedContext() context.Context\n}\n\ntype specContext struct {\n\tcontext.Context\n\t*ProgressReporterManager\n\n\tcancel context.CancelCauseFunc\n\n\tsuite *Suite\n}\n\n/*\nSpecContext includes a reference to `suite` and embeds itself in itself as a \"GINKGO_SPEC_CONTEXT\" value. This allows users to create child Contexts without having down-stream consumers (e.g. Gomega) lose access to the SpecContext and its methods. This allows us to build extensions on top of Ginkgo that simply take an all-encompassing context.\n\nNote that while SpecContext is used to enforce deadlines by Ginkgo it is not configured as a context.WithDeadline. Instead, Ginkgo owns responsibility for cancelling the context when the deadline elapses.\n\nThis is because Ginkgo needs finer control over when the context is canceled. Specifically, Ginkgo needs to generate a ProgressReport before it cancels the context to ensure progress is captured where the spec is currently running. The only way to avoid a race here is to manually control the cancellation.\n*/\nfunc NewSpecContext(suite *Suite) *specContext {\n\tctx, cancel := context.WithCancelCause(context.Background())\n\tsc := &specContext{\n\t\tcancel: cancel,\n\t\tsuite: suite,\n\t\tProgressReporterManager: NewProgressReporterManager(),\n\t}\n\tctx = context.WithValue(ctx, \"GINKGO_SPEC_CONTEXT\", sc) //yes, yes, the go docs say don't use a string for a key... but we'd rather avoid a circular dependency between Gomega and Ginkgo\n\tsc.Context = ctx //thank goodness for garbage collectors that can handle circular dependencies\n\n\treturn sc\n}\n\nfunc (sc *specContext) SpecReport() types.SpecReport {\n\treturn sc.suite.CurrentSpecReport()\n}\n\nfunc (sc *specContext) WrappedContext() context.Context {\n\treturn sc.Context\n}\n\n/*\nThe user is allowed to wrap `SpecContext` in a new context.Context when using AroundNodes. But body functions expect SpecContext.\nWe support this by taking their context.Context and returning a SpecContext that wraps it.\n*/\nfunc wrapContextChain(ctx context.Context) SpecContext {\n\tif ctx == nil {\n\t\treturn nil\n\t}\n\tif reflect.TypeOf(ctx) == reflect.TypeOf(&specContext{}) {\n\t\treturn ctx.(*specContext)\n\t} else if sc, ok := ctx.Value(\"GINKGO_SPEC_CONTEXT\").(*specContext); ok {\n\t\treturn &specContext{\n\t\t\tContext: ctx,\n\t\t\tProgressReporterManager: sc.ProgressReporterManager,\n\t\t\tcancel: sc.cancel,\n\t\t\tsuite: sc.suite,\n\t\t}\n\t}\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/suite.go",
"content": "package internal\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"sync\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/internal/interrupt_handler\"\n\t\"github.com/onsi/ginkgo/v2/internal/parallel_support\"\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype Phase uint\n\nconst (\n\tPhaseBuildTopLevel Phase = iota\n\tPhaseBuildTree\n\tPhaseRun\n)\n\nconst ProgressReporterDeadline = 5 * time.Second\n\ntype Suite struct {\n\ttree *TreeNode\n\ttopLevelContainers Nodes\n\n\t*ProgressReporterManager\n\n\tphase Phase\n\n\tsuiteNodes Nodes\n\tcleanupNodes Nodes\n\taroundNodes types.AroundNodes\n\n\tfailer *Failer\n\treporter reporters.Reporter\n\twriter WriterInterface\n\toutputInterceptor OutputInterceptor\n\tinterruptHandler interrupt_handler.InterruptHandlerInterface\n\tconfig types.SuiteConfig\n\tdeadline time.Time\n\n\tcurrentConstructionNodeReport *types.ConstructionNodeReport\n\n\tskipAll bool\n\treport types.Report\n\tcurrentSpecReport types.SpecReport\n\tcurrentNode Node\n\tcurrentNodeStartTime time.Time\n\n\tcurrentSpecContext *specContext\n\n\tcurrentByStep types.SpecEvent\n\ttimelineOrder int\n\n\t/*\n\t\tWe don't need to lock around all operations. Just those that *could* happen concurrently.\n\n\t\tSuite, generally, only runs one node at a time - and so the possibiity for races is small. In fact, the presence of a race usually indicates the user has launched a goroutine that has leaked past the node it was launched in.\n\n\t\tHowever, there are some operations that can happen concurrently:\n\n\t\t- AddReportEntry and CurrentSpecReport can be accessed at any point by the user - including in goroutines that outlive the node intentionally (see, e.g. #1020). They both form a self-contained read-write pair and so a lock in them is sufficent.\n\t\t- generateProgressReport can be invoked at any point in time by an interrupt or a progres poll. Moreover, it requires access to currentSpecReport, currentNode, currentNodeStartTime, and progressStepCursor. To make it threadsafe we need to lock around generateProgressReport when we read those variables _and_ everywhere those variables are *written*. In general we don't need to worry about all possible field writes to these variables as what `generateProgressReport` does with these variables is fairly selective (hence the name of the lock). Specifically, we dont' need to lock around state and failure message changes on `currentSpecReport` - just the setting of the variable itself.\n\t*/\n\tselectiveLock *sync.Mutex\n\n\tclient parallel_support.Client\n}\n\nfunc NewSuite() *Suite {\n\treturn &Suite{\n\t\ttree: &TreeNode{},\n\t\tphase: PhaseBuildTopLevel,\n\t\tProgressReporterManager: NewProgressReporterManager(),\n\n\t\tselectiveLock: &sync.Mutex{},\n\t}\n}\n\nfunc (suite *Suite) Clone() (*Suite, error) {\n\tif suite.phase != PhaseBuildTopLevel {\n\t\treturn nil, fmt.Errorf(\"cannot clone suite after tree has been built\")\n\t}\n\treturn &Suite{\n\t\ttree: &TreeNode{},\n\t\tphase: PhaseBuildTopLevel,\n\t\tProgressReporterManager: NewProgressReporterManager(),\n\t\ttopLevelContainers: suite.topLevelContainers.Clone(),\n\t\tsuiteNodes: suite.suiteNodes.Clone(),\n\t\taroundNodes: suite.aroundNodes.Clone(),\n\t\tselectiveLock: &sync.Mutex{},\n\t}, nil\n}\n\nfunc (suite *Suite) BuildTree() error {\n\t// During PhaseBuildTopLevel, the top level containers are stored in suite.topLevelCotainers and entered\n\t// We now enter PhaseBuildTree where these top level containers are entered and added to the spec tree\n\tsuite.phase = PhaseBuildTree\n\tfor _, topLevelContainer := range suite.topLevelContainers {\n\t\terr := suite.PushNode(topLevelContainer)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc (suite *Suite) Run(description string, suiteLabels Labels, suiteSemVerConstraints SemVerConstraints, suiteComponentSemVerConstraints ComponentSemVerConstraints, suiteAroundNodes types.AroundNodes, suitePath string, failer *Failer, reporter reporters.Reporter, writer WriterInterface, outputInterceptor OutputInterceptor, interruptHandler interrupt_handler.InterruptHandlerInterface, client parallel_support.Client, progressSignalRegistrar ProgressSignalRegistrar, suiteConfig types.SuiteConfig) (bool, bool) {\n\tif suite.phase != PhaseBuildTree {\n\t\tpanic(\"cannot run before building the tree = call suite.BuildTree() first\")\n\t}\n\tApplyNestedFocusPolicyToTree(suite.tree)\n\tspecs := GenerateSpecsFromTreeRoot(suite.tree)\n\tspecs, hasProgrammaticFocus := ApplyFocusToSpecs(specs, description, suiteLabels, suiteSemVerConstraints, suiteComponentSemVerConstraints, suiteConfig)\n\tspecs = ComputeAroundNodes(specs)\n\n\tsuite.phase = PhaseRun\n\tsuite.client = client\n\tsuite.failer = failer\n\tsuite.reporter = reporter\n\tsuite.writer = writer\n\tsuite.outputInterceptor = outputInterceptor\n\tsuite.interruptHandler = interruptHandler\n\tsuite.config = suiteConfig\n\tsuite.aroundNodes = suiteAroundNodes\n\n\tif suite.config.Timeout > 0 {\n\t\tsuite.deadline = time.Now().Add(suite.config.Timeout)\n\t}\n\n\tcancelProgressHandler := progressSignalRegistrar(suite.handleProgressSignal)\n\n\tsuccess := suite.runSpecs(description, suiteLabels, suiteSemVerConstraints, suiteComponentSemVerConstraints, suitePath, hasProgrammaticFocus, specs)\n\n\tcancelProgressHandler()\n\n\treturn success, hasProgrammaticFocus\n}\n\nfunc (suite *Suite) InRunPhase() bool {\n\treturn suite.phase == PhaseRun\n}\n\n/*\n Tree Construction methods\n\n PushNode is used during PhaseBuildTopLevel and PhaseBuildTree\n*/\n\nfunc (suite *Suite) PushNode(node Node) error {\n\tif node.NodeType.Is(types.NodeTypeCleanupInvalid | types.NodeTypeCleanupAfterEach | types.NodeTypeCleanupAfterAll | types.NodeTypeCleanupAfterSuite) {\n\t\treturn suite.pushCleanupNode(node)\n\t}\n\n\tif node.NodeType.Is(types.NodeTypeBeforeSuite | types.NodeTypeAfterSuite | types.NodeTypeSynchronizedBeforeSuite | types.NodeTypeSynchronizedAfterSuite | types.NodeTypeBeforeSuite | types.NodeTypeReportBeforeSuite | types.NodeTypeReportAfterSuite) {\n\t\treturn suite.pushSuiteNode(node)\n\t}\n\n\tif suite.phase == PhaseRun {\n\t\treturn types.GinkgoErrors.PushingNodeInRunPhase(node.NodeType, node.CodeLocation)\n\t}\n\n\tif node.MarkedSerial {\n\t\tfirstOrderedNode := suite.tree.AncestorNodeChain().FirstNodeMarkedOrdered()\n\t\tif !firstOrderedNode.IsZero() && !firstOrderedNode.MarkedSerial {\n\t\t\treturn types.GinkgoErrors.InvalidSerialNodeInNonSerialOrderedContainer(node.CodeLocation, node.NodeType)\n\t\t}\n\t}\n\n\tif node.NodeType.Is(types.NodeTypeBeforeAll | types.NodeTypeAfterAll) {\n\t\tfirstOrderedNode := suite.tree.AncestorNodeChain().FirstNodeMarkedOrdered()\n\t\tif firstOrderedNode.IsZero() {\n\t\t\treturn types.GinkgoErrors.SetupNodeNotInOrderedContainer(node.CodeLocation, node.NodeType)\n\t\t}\n\t}\n\n\tif node.MarkedContinueOnFailure {\n\t\tfirstOrderedNode := suite.tree.AncestorNodeChain().FirstNodeMarkedOrdered()\n\t\tif !firstOrderedNode.IsZero() {\n\t\t\treturn types.GinkgoErrors.InvalidContinueOnFailureDecoration(node.CodeLocation)\n\t\t}\n\t}\n\n\tif node.NodeType == types.NodeTypeContainer {\n\t\t// During PhaseBuildTopLevel we only track the top level containers without entering them\n\t\t// We only enter the top level container nodes during PhaseBuildTree\n\t\t//\n\t\t// This ensures the tree is only constructed after `go spec` has called `flag.Parse()` and gives\n\t\t// the user an opportunity to load suiteConfiguration information in the `TestX` go spec hook just before `RunSpecs`\n\t\t// is invoked. This makes the lifecycle easier to reason about and solves issues like #693.\n\t\tif suite.phase == PhaseBuildTopLevel {\n\t\t\tsuite.topLevelContainers = append(suite.topLevelContainers, node)\n\t\t\treturn nil\n\t\t}\n\t\tif suite.phase == PhaseBuildTree {\n\t\t\tparentTree := suite.tree\n\t\t\tsuite.tree = &TreeNode{Node: node}\n\t\t\tparentTree.AppendChild(suite.tree)\n\t\t\terr := func() (err error) {\n\t\t\t\tdefer func() {\n\t\t\t\t\tif e := recover(); e != nil {\n\t\t\t\t\t\terr = types.GinkgoErrors.CaughtPanicDuringABuildPhase(e, node.CodeLocation)\n\t\t\t\t\t}\n\t\t\t\t}()\n\n\t\t\t\t// Ensure that code running in the body of the container node\n\t\t\t\t// has access to information about the current container node(s).\n\t\t\t\t// The current one (nil in top-level container nodes, non-nil in an\n\t\t\t\t// embedded container node) gets restored when the node is done.\n\t\t\t\toldConstructionNodeReport := suite.currentConstructionNodeReport\n\t\t\t\tsuite.currentConstructionNodeReport = constructionNodeReportForTreeNode(suite.tree)\n\t\t\t\tdefer func() {\n\t\t\t\t\tsuite.currentConstructionNodeReport = oldConstructionNodeReport\n\t\t\t\t}()\n\n\t\t\t\tnode.Body(nil)\n\t\t\t\treturn err\n\t\t\t}()\n\t\t\tsuite.tree = parentTree\n\t\t\treturn err\n\t\t}\n\t} else {\n\t\tsuite.tree.AppendChild(&TreeNode{Node: node})\n\t\treturn nil\n\t}\n\n\treturn nil\n}\n\nfunc (suite *Suite) pushSuiteNode(node Node) error {\n\tif suite.phase == PhaseBuildTree {\n\t\treturn types.GinkgoErrors.SuiteNodeInNestedContext(node.NodeType, node.CodeLocation)\n\t}\n\n\tif suite.phase == PhaseRun {\n\t\treturn types.GinkgoErrors.SuiteNodeDuringRunPhase(node.NodeType, node.CodeLocation)\n\t}\n\n\tswitch node.NodeType {\n\tcase types.NodeTypeBeforeSuite, types.NodeTypeSynchronizedBeforeSuite:\n\t\texistingBefores := suite.suiteNodes.WithType(types.NodeTypeBeforeSuite | types.NodeTypeSynchronizedBeforeSuite)\n\t\tif len(existingBefores) > 0 {\n\t\t\treturn types.GinkgoErrors.MultipleBeforeSuiteNodes(node.NodeType, node.CodeLocation, existingBefores[0].NodeType, existingBefores[0].CodeLocation)\n\t\t}\n\tcase types.NodeTypeAfterSuite, types.NodeTypeSynchronizedAfterSuite:\n\t\texistingAfters := suite.suiteNodes.WithType(types.NodeTypeAfterSuite | types.NodeTypeSynchronizedAfterSuite)\n\t\tif len(existingAfters) > 0 {\n\t\t\treturn types.GinkgoErrors.MultipleAfterSuiteNodes(node.NodeType, node.CodeLocation, existingAfters[0].NodeType, existingAfters[0].CodeLocation)\n\t\t}\n\t}\n\n\tsuite.suiteNodes = append(suite.suiteNodes, node)\n\treturn nil\n}\n\nfunc (suite *Suite) pushCleanupNode(node Node) error {\n\tif suite.phase != PhaseRun || suite.currentNode.IsZero() {\n\t\treturn types.GinkgoErrors.PushingCleanupNodeDuringTreeConstruction(node.CodeLocation)\n\t}\n\n\tswitch suite.currentNode.NodeType {\n\tcase types.NodeTypeBeforeSuite, types.NodeTypeSynchronizedBeforeSuite, types.NodeTypeAfterSuite, types.NodeTypeSynchronizedAfterSuite:\n\t\tnode.NodeType = types.NodeTypeCleanupAfterSuite\n\tcase types.NodeTypeBeforeAll, types.NodeTypeAfterAll:\n\t\tnode.NodeType = types.NodeTypeCleanupAfterAll\n\tcase types.NodeTypeReportBeforeEach, types.NodeTypeReportAfterEach, types.NodeTypeReportBeforeSuite, types.NodeTypeReportAfterSuite:\n\t\treturn types.GinkgoErrors.PushingCleanupInReportingNode(node.CodeLocation, suite.currentNode.NodeType)\n\tcase types.NodeTypeCleanupInvalid, types.NodeTypeCleanupAfterEach, types.NodeTypeCleanupAfterAll, types.NodeTypeCleanupAfterSuite:\n\t\treturn types.GinkgoErrors.PushingCleanupInCleanupNode(node.CodeLocation)\n\tdefault:\n\t\tnode.NodeType = types.NodeTypeCleanupAfterEach\n\t}\n\n\tnode.NodeIDWhereCleanupWasGenerated = suite.currentNode.ID\n\tnode.NestingLevel = suite.currentNode.NestingLevel\n\tnode.AroundNodes = types.AroundNodes{}.Append(suite.currentNode.AroundNodes...).Append(node.AroundNodes...)\n\tsuite.selectiveLock.Lock()\n\tsuite.cleanupNodes = append(suite.cleanupNodes, node)\n\tsuite.selectiveLock.Unlock()\n\n\treturn nil\n}\n\nfunc (suite *Suite) generateTimelineLocation() types.TimelineLocation {\n\tsuite.selectiveLock.Lock()\n\tdefer suite.selectiveLock.Unlock()\n\n\tsuite.timelineOrder += 1\n\treturn types.TimelineLocation{\n\t\tOffset: len(suite.currentSpecReport.CapturedGinkgoWriterOutput) + suite.writer.Len(),\n\t\tOrder: suite.timelineOrder,\n\t\tTime: time.Now(),\n\t}\n}\n\nfunc (suite *Suite) handleSpecEvent(event types.SpecEvent) types.SpecEvent {\n\tevent.TimelineLocation = suite.generateTimelineLocation()\n\tsuite.selectiveLock.Lock()\n\tsuite.currentSpecReport.SpecEvents = append(suite.currentSpecReport.SpecEvents, event)\n\tsuite.selectiveLock.Unlock()\n\tsuite.reporter.EmitSpecEvent(event)\n\treturn event\n}\n\nfunc (suite *Suite) handleSpecEventEnd(eventType types.SpecEventType, startEvent types.SpecEvent) {\n\tevent := startEvent\n\tevent.SpecEventType = eventType\n\tevent.TimelineLocation = suite.generateTimelineLocation()\n\tevent.Duration = event.TimelineLocation.Time.Sub(startEvent.TimelineLocation.Time)\n\tsuite.selectiveLock.Lock()\n\tsuite.currentSpecReport.SpecEvents = append(suite.currentSpecReport.SpecEvents, event)\n\tsuite.selectiveLock.Unlock()\n\tsuite.reporter.EmitSpecEvent(event)\n}\n\nfunc (suite *Suite) By(text string, callback ...func()) error {\n\tcl := types.NewCodeLocation(2)\n\tif suite.phase != PhaseRun {\n\t\treturn types.GinkgoErrors.ByNotDuringRunPhase(cl)\n\t}\n\n\tevent := suite.handleSpecEvent(types.SpecEvent{\n\t\tSpecEventType: types.SpecEventByStart,\n\t\tCodeLocation: cl,\n\t\tMessage: text,\n\t})\n\tsuite.selectiveLock.Lock()\n\tsuite.currentByStep = event\n\tsuite.selectiveLock.Unlock()\n\n\tif len(callback) == 1 {\n\t\tdefer func() {\n\t\t\tsuite.selectiveLock.Lock()\n\t\t\tsuite.currentByStep = types.SpecEvent{}\n\t\t\tsuite.selectiveLock.Unlock()\n\t\t\tsuite.handleSpecEventEnd(types.SpecEventByEnd, event)\n\t\t}()\n\t\tcallback[0]()\n\t} else if len(callback) > 1 {\n\t\tpanic(\"just one callback per By, please\")\n\t}\n\treturn nil\n}\n\nfunc (suite *Suite) CurrentConstructionNodeReport() types.ConstructionNodeReport {\n\tsuite.selectiveLock.Lock()\n\tdefer suite.selectiveLock.Unlock()\n\treport := suite.currentConstructionNodeReport\n\tif report == nil {\n\t\tpanic(\"CurrentConstructionNodeReport may only be called during construction of the spec tree\")\n\t}\n\treturn *report\n}\n\n/*\nSpec Running methods - used during PhaseRun\n*/\nfunc (suite *Suite) CurrentSpecReport() types.SpecReport {\n\tsuite.selectiveLock.Lock()\n\tdefer suite.selectiveLock.Unlock()\n\treport := suite.currentSpecReport\n\tif suite.writer != nil {\n\t\treport.CapturedGinkgoWriterOutput = string(suite.writer.Bytes())\n\t}\n\treport.ReportEntries = make([]ReportEntry, len(report.ReportEntries))\n\tcopy(report.ReportEntries, suite.currentSpecReport.ReportEntries)\n\treturn report\n}\n\n// Only valid in the preview context. In general suite.report only includes\n// the specs run by _this_ node - it is only at the end of the suite that\n// the parallel reports are aggregated. However in the preview context we run\n// in series and\nfunc (suite *Suite) GetPreviewReport() types.Report {\n\tsuite.selectiveLock.Lock()\n\tdefer suite.selectiveLock.Unlock()\n\treturn suite.report\n}\n\nfunc (suite *Suite) AddReportEntry(entry ReportEntry) error {\n\tif suite.phase != PhaseRun {\n\t\treturn types.GinkgoErrors.AddReportEntryNotDuringRunPhase(entry.Location)\n\t}\n\tentry.TimelineLocation = suite.generateTimelineLocation()\n\tentry.Time = entry.TimelineLocation.Time\n\tsuite.selectiveLock.Lock()\n\tsuite.currentSpecReport.ReportEntries = append(suite.currentSpecReport.ReportEntries, entry)\n\tsuite.selectiveLock.Unlock()\n\tsuite.reporter.EmitReportEntry(entry)\n\treturn nil\n}\n\nfunc (suite *Suite) generateProgressReport(fullReport bool) types.ProgressReport {\n\ttimelineLocation := suite.generateTimelineLocation()\n\tsuite.selectiveLock.Lock()\n\tdefer suite.selectiveLock.Unlock()\n\n\tdeadline, cancel := context.WithTimeout(context.Background(), ProgressReporterDeadline)\n\tdefer cancel()\n\tvar additionalReports []string\n\tif suite.currentSpecContext != nil {\n\t\tadditionalReports = append(additionalReports, suite.currentSpecContext.QueryProgressReporters(deadline, suite.failer)...)\n\t}\n\tadditionalReports = append(additionalReports, suite.QueryProgressReporters(deadline, suite.failer)...)\n\tgwOutput := suite.currentSpecReport.CapturedGinkgoWriterOutput + string(suite.writer.Bytes())\n\tpr, err := NewProgressReport(suite.isRunningInParallel(), suite.currentSpecReport, suite.currentNode, suite.currentNodeStartTime, suite.currentByStep, gwOutput, timelineLocation, additionalReports, suite.config.SourceRoots, fullReport)\n\n\tif err != nil {\n\t\tfmt.Printf(\"{{red}}Failed to generate progress report:{{/}}\\n%s\\n\", err.Error())\n\t}\n\treturn pr\n}\n\nfunc (suite *Suite) handleProgressSignal() {\n\treport := suite.generateProgressReport(false)\n\treport.Message = \"{{bold}}You've requested a progress report:{{/}}\"\n\tsuite.emitProgressReport(report)\n}\n\nfunc (suite *Suite) emitProgressReport(report types.ProgressReport) {\n\tsuite.selectiveLock.Lock()\n\tsuite.currentSpecReport.ProgressReports = append(suite.currentSpecReport.ProgressReports, report.WithoutCapturedGinkgoWriterOutput())\n\tsuite.selectiveLock.Unlock()\n\n\tsuite.reporter.EmitProgressReport(report)\n\tif suite.isRunningInParallel() {\n\t\terr := suite.client.PostEmitProgressReport(report)\n\t\tif err != nil {\n\t\t\tfmt.Println(err.Error())\n\t\t}\n\t}\n}\n\nfunc (suite *Suite) isRunningInParallel() bool {\n\treturn suite.config.ParallelTotal > 1\n}\n\nfunc (suite *Suite) processCurrentSpecReport() {\n\tsuite.reporter.DidRun(suite.currentSpecReport)\n\tif suite.isRunningInParallel() {\n\t\tsuite.client.PostDidRun(suite.currentSpecReport)\n\t}\n\tsuite.report.SpecReports = append(suite.report.SpecReports, suite.currentSpecReport)\n\n\tif suite.currentSpecReport.State.Is(types.SpecStateFailureStates) {\n\t\tsuite.report.SuiteSucceeded = false\n\t\tif suite.config.FailFast || suite.currentSpecReport.State.Is(types.SpecStateAborted) {\n\t\t\tsuite.skipAll = true\n\t\t\tif suite.isRunningInParallel() {\n\t\t\t\tsuite.client.PostAbort()\n\t\t\t}\n\t\t}\n\t}\n}\n\nfunc (suite *Suite) runSpecs(description string, suiteLabels Labels, suiteSemVerConstraints SemVerConstraints, suiteComponentSemVerConstraints ComponentSemVerConstraints, suitePath string, hasProgrammaticFocus bool, specs Specs) bool {\n\tnumSpecsThatWillBeRun := specs.CountWithoutSkip()\n\n\tsuite.report = types.Report{\n\t\tSuitePath: suitePath,\n\t\tSuiteDescription: description,\n\t\tSuiteLabels: suiteLabels,\n\t\tSuiteSemVerConstraints: suiteSemVerConstraints,\n\t\tSuiteComponentSemVerConstraints: suiteComponentSemVerConstraints,\n\t\tSuiteConfig: suite.config,\n\t\tSuiteHasProgrammaticFocus: hasProgrammaticFocus,\n\t\tPreRunStats: types.PreRunStats{\n\t\t\tTotalSpecs: len(specs),\n\t\t\tSpecsThatWillRun: numSpecsThatWillBeRun,\n\t\t},\n\t\tStartTime: time.Now(),\n\t}\n\n\tsuite.reporter.SuiteWillBegin(suite.report)\n\tif suite.isRunningInParallel() {\n\t\tsuite.client.PostSuiteWillBegin(suite.report)\n\t}\n\n\tsuite.report.SuiteSucceeded = true\n\n\tsuite.runReportSuiteNodesIfNeedBe(types.NodeTypeReportBeforeSuite)\n\n\tranBeforeSuite := suite.report.SuiteSucceeded\n\tif suite.report.SuiteSucceeded {\n\t\tsuite.runBeforeSuite(numSpecsThatWillBeRun)\n\t}\n\n\tif suite.report.SuiteSucceeded {\n\t\tgroupedSpecIndices, serialGroupedSpecIndices := OrderSpecs(specs, suite.config)\n\t\tnextIndex := MakeIncrementingIndexCounter()\n\t\tif suite.isRunningInParallel() {\n\t\t\tnextIndex = suite.client.FetchNextCounter\n\t\t}\n\n\t\tfor {\n\t\t\tgroupedSpecIdx, err := nextIndex()\n\t\t\tif err != nil {\n\t\t\t\tsuite.report.SpecialSuiteFailureReasons = append(suite.report.SpecialSuiteFailureReasons, fmt.Sprintf(\"Failed to iterate over specs:\\n%s\", err.Error()))\n\t\t\t\tsuite.report.SuiteSucceeded = false\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\tif groupedSpecIdx >= len(groupedSpecIndices) {\n\t\t\t\tif suite.config.ParallelProcess == 1 && len(serialGroupedSpecIndices) > 0 {\n\t\t\t\t\tgroupedSpecIndices, serialGroupedSpecIndices, nextIndex = serialGroupedSpecIndices, GroupedSpecIndices{}, MakeIncrementingIndexCounter()\n\t\t\t\t\tsuite.client.BlockUntilNonprimaryProcsHaveFinished()\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\t// the complexity for running groups of specs is very high because of Ordered containers and FlakeAttempts\n\t\t\t// we encapsulate that complexity in the notion of a Group that can run\n\t\t\t// Group is really just an extension of suite so it gets passed a suite and has access to all its internals\n\t\t\t// Note that group is stateful and intended for single use!\n\t\t\tnewGroup(suite).run(specs.AtIndices(groupedSpecIndices[groupedSpecIdx]))\n\t\t}\n\n\t\tif suite.config.FailOnPending && specs.HasAnySpecsMarkedPending() {\n\t\t\tsuite.report.SpecialSuiteFailureReasons = append(suite.report.SpecialSuiteFailureReasons, \"Detected pending specs and --fail-on-pending is set\")\n\t\t\tsuite.report.SuiteSucceeded = false\n\t\t}\n\n\t\tif suite.config.FailOnEmpty && specs.CountWithoutSkip() == 0 {\n\t\t\tsuite.report.SpecialSuiteFailureReasons = append(suite.report.SpecialSuiteFailureReasons, \"Detected no specs ran and --fail-on-empty is set\")\n\t\t\tsuite.report.SuiteSucceeded = false\n\t\t}\n\t}\n\n\tif ranBeforeSuite {\n\t\tsuite.runAfterSuiteCleanup(numSpecsThatWillBeRun)\n\t}\n\n\tinterruptStatus := suite.interruptHandler.Status()\n\tif interruptStatus.Interrupted() {\n\t\tsuite.report.SpecialSuiteFailureReasons = append(suite.report.SpecialSuiteFailureReasons, interruptStatus.Cause.String())\n\t\tsuite.report.SuiteSucceeded = false\n\t}\n\tsuite.report.EndTime = time.Now()\n\tsuite.report.RunTime = suite.report.EndTime.Sub(suite.report.StartTime)\n\tif !suite.deadline.IsZero() && suite.report.EndTime.After(suite.deadline) {\n\t\tsuite.report.SpecialSuiteFailureReasons = append(suite.report.SpecialSuiteFailureReasons, \"Suite Timeout Elapsed\")\n\t\tsuite.report.SuiteSucceeded = false\n\t}\n\n\tsuite.runReportSuiteNodesIfNeedBe(types.NodeTypeReportAfterSuite)\n\tsuite.reporter.SuiteDidEnd(suite.report)\n\tif suite.isRunningInParallel() {\n\t\tsuite.client.PostSuiteDidEnd(suite.report)\n\t}\n\n\treturn suite.report.SuiteSucceeded\n}\n\nfunc (suite *Suite) runBeforeSuite(numSpecsThatWillBeRun int) {\n\tbeforeSuiteNode := suite.suiteNodes.FirstNodeWithType(types.NodeTypeBeforeSuite | types.NodeTypeSynchronizedBeforeSuite)\n\tif !beforeSuiteNode.IsZero() && numSpecsThatWillBeRun > 0 {\n\t\tsuite.selectiveLock.Lock()\n\t\tsuite.currentSpecReport = types.SpecReport{\n\t\t\tLeafNodeType: beforeSuiteNode.NodeType,\n\t\t\tLeafNodeLocation: beforeSuiteNode.CodeLocation,\n\t\t\tParallelProcess: suite.config.ParallelProcess,\n\t\t\tRunningInParallel: suite.isRunningInParallel(),\n\t\t}\n\t\tsuite.selectiveLock.Unlock()\n\n\t\tsuite.reporter.WillRun(suite.currentSpecReport)\n\t\tsuite.runSuiteNode(beforeSuiteNode)\n\t\tif suite.currentSpecReport.State.Is(types.SpecStateSkipped) {\n\t\t\tsuite.report.SpecialSuiteFailureReasons = append(suite.report.SpecialSuiteFailureReasons, \"Suite skipped in BeforeSuite\")\n\t\t\tsuite.skipAll = true\n\t\t}\n\t\tsuite.processCurrentSpecReport()\n\t}\n}\n\nfunc (suite *Suite) runAfterSuiteCleanup(numSpecsThatWillBeRun int) {\n\tafterSuiteNode := suite.suiteNodes.FirstNodeWithType(types.NodeTypeAfterSuite | types.NodeTypeSynchronizedAfterSuite)\n\tif !afterSuiteNode.IsZero() && numSpecsThatWillBeRun > 0 {\n\t\tsuite.selectiveLock.Lock()\n\t\tsuite.currentSpecReport = types.SpecReport{\n\t\t\tLeafNodeType: afterSuiteNode.NodeType,\n\t\t\tLeafNodeLocation: afterSuiteNode.CodeLocation,\n\t\t\tParallelProcess: suite.config.ParallelProcess,\n\t\t\tRunningInParallel: suite.isRunningInParallel(),\n\t\t}\n\t\tsuite.selectiveLock.Unlock()\n\n\t\tsuite.reporter.WillRun(suite.currentSpecReport)\n\t\tsuite.runSuiteNode(afterSuiteNode)\n\t\tsuite.processCurrentSpecReport()\n\t}\n\n\tafterSuiteCleanup := suite.cleanupNodes.WithType(types.NodeTypeCleanupAfterSuite).Reverse()\n\tif len(afterSuiteCleanup) > 0 {\n\t\tfor _, cleanupNode := range afterSuiteCleanup {\n\t\t\tsuite.selectiveLock.Lock()\n\t\t\tsuite.currentSpecReport = types.SpecReport{\n\t\t\t\tLeafNodeType: cleanupNode.NodeType,\n\t\t\t\tLeafNodeLocation: cleanupNode.CodeLocation,\n\t\t\t\tParallelProcess: suite.config.ParallelProcess,\n\t\t\t\tRunningInParallel: suite.isRunningInParallel(),\n\t\t\t}\n\t\t\tsuite.selectiveLock.Unlock()\n\n\t\t\tsuite.reporter.WillRun(suite.currentSpecReport)\n\t\t\tsuite.runSuiteNode(cleanupNode)\n\t\t\tsuite.processCurrentSpecReport()\n\t\t}\n\t}\n}\n\nfunc (suite *Suite) reportEach(spec Spec, nodeType types.NodeType) {\n\tnodes := spec.Nodes.WithType(nodeType)\n\tif nodeType == types.NodeTypeReportAfterEach {\n\t\tnodes = nodes.SortedByDescendingNestingLevel()\n\t}\n\tif nodeType == types.NodeTypeReportBeforeEach {\n\t\tnodes = nodes.SortedByAscendingNestingLevel()\n\t}\n\tif len(nodes) == 0 {\n\t\treturn\n\t}\n\n\tfor i := range nodes {\n\t\tsuite.writer.Truncate()\n\t\tsuite.outputInterceptor.StartInterceptingOutput()\n\t\treport := suite.currentSpecReport\n\t\tnodes[i].Body = func(ctx SpecContext) {\n\t\t\tnodes[i].ReportEachBody(ctx, report)\n\t\t}\n\t\tstate, failure := suite.runNode(nodes[i], time.Time{}, spec.Nodes.BestTextFor(nodes[i]))\n\n\t\t// If the spec is not in a failure state (i.e. it's Passed/Skipped/Pending) and the reporter has failed, override the state.\n\t\t// Also, if the reporter is every aborted - always override the state to propagate the abort\n\t\tif (!suite.currentSpecReport.State.Is(types.SpecStateFailureStates) && state.Is(types.SpecStateFailureStates)) || state.Is(types.SpecStateAborted) {\n\t\t\tsuite.currentSpecReport.State = state\n\t\t\tsuite.currentSpecReport.Failure = failure\n\t\t}\n\t\tsuite.currentSpecReport.CapturedGinkgoWriterOutput += string(suite.writer.Bytes())\n\t\tsuite.currentSpecReport.CapturedStdOutErr += suite.outputInterceptor.StopInterceptingAndReturnOutput()\n\t}\n}\n\nfunc (suite *Suite) runSuiteNode(node Node) {\n\tif suite.config.DryRun {\n\t\tsuite.currentSpecReport.State = types.SpecStatePassed\n\t\treturn\n\t}\n\n\tsuite.writer.Truncate()\n\tsuite.outputInterceptor.StartInterceptingOutput()\n\tsuite.currentSpecReport.StartTime = time.Now()\n\n\tvar err error\n\tswitch node.NodeType {\n\tcase types.NodeTypeBeforeSuite, types.NodeTypeAfterSuite:\n\t\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = suite.runNode(node, time.Time{}, \"\")\n\tcase types.NodeTypeCleanupAfterSuite:\n\t\tif suite.config.ParallelTotal > 1 && suite.config.ParallelProcess == 1 {\n\t\t\terr = suite.client.BlockUntilNonprimaryProcsHaveFinished()\n\t\t}\n\t\tif err == nil {\n\t\t\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = suite.runNode(node, time.Time{}, \"\")\n\t\t}\n\tcase types.NodeTypeSynchronizedBeforeSuite:\n\t\tvar data []byte\n\t\tvar runAllProcs bool\n\t\tif suite.config.ParallelProcess == 1 {\n\t\t\tif suite.config.ParallelTotal > 1 {\n\t\t\t\tsuite.outputInterceptor.StopInterceptingAndReturnOutput()\n\t\t\t\tsuite.outputInterceptor.StartInterceptingOutputAndForwardTo(suite.client)\n\t\t\t}\n\t\t\tnode.Body = func(c SpecContext) { data = node.SynchronizedBeforeSuiteProc1Body(c) }\n\t\t\tnode.HasContext = node.SynchronizedBeforeSuiteProc1BodyHasContext\n\t\t\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = suite.runNode(node, time.Time{}, \"\")\n\t\t\tif suite.config.ParallelTotal > 1 {\n\t\t\t\tsuite.currentSpecReport.CapturedStdOutErr += suite.outputInterceptor.StopInterceptingAndReturnOutput()\n\t\t\t\tsuite.outputInterceptor.StartInterceptingOutput()\n\t\t\t\tif suite.currentSpecReport.State.Is(types.SpecStatePassed) {\n\t\t\t\t\terr = suite.client.PostSynchronizedBeforeSuiteCompleted(types.SpecStatePassed, data)\n\t\t\t\t} else {\n\t\t\t\t\terr = suite.client.PostSynchronizedBeforeSuiteCompleted(suite.currentSpecReport.State, nil)\n\t\t\t\t}\n\t\t\t}\n\t\t\trunAllProcs = suite.currentSpecReport.State.Is(types.SpecStatePassed) && err == nil\n\t\t} else {\n\t\t\tvar proc1State types.SpecState\n\t\t\tproc1State, data, err = suite.client.BlockUntilSynchronizedBeforeSuiteData()\n\t\t\tswitch proc1State {\n\t\t\tcase types.SpecStatePassed:\n\t\t\t\trunAllProcs = true\n\t\t\tcase types.SpecStateFailed, types.SpecStatePanicked, types.SpecStateTimedout:\n\t\t\t\terr = types.GinkgoErrors.SynchronizedBeforeSuiteFailedOnProc1()\n\t\t\tcase types.SpecStateInterrupted, types.SpecStateAborted, types.SpecStateSkipped:\n\t\t\t\tsuite.currentSpecReport.State = proc1State\n\t\t\t}\n\t\t}\n\t\tif runAllProcs {\n\t\t\tnode.Body = func(c SpecContext) { node.SynchronizedBeforeSuiteAllProcsBody(c, data) }\n\t\t\tnode.HasContext = node.SynchronizedBeforeSuiteAllProcsBodyHasContext\n\t\t\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = suite.runNode(node, time.Time{}, \"\")\n\t\t}\n\tcase types.NodeTypeSynchronizedAfterSuite:\n\t\tnode.Body = node.SynchronizedAfterSuiteAllProcsBody\n\t\tnode.HasContext = node.SynchronizedAfterSuiteAllProcsBodyHasContext\n\t\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = suite.runNode(node, time.Time{}, \"\")\n\t\tif suite.config.ParallelProcess == 1 {\n\t\t\tif suite.config.ParallelTotal > 1 {\n\t\t\t\terr = suite.client.BlockUntilNonprimaryProcsHaveFinished()\n\t\t\t}\n\t\t\tif err == nil {\n\t\t\t\tif suite.config.ParallelTotal > 1 {\n\t\t\t\t\tsuite.currentSpecReport.CapturedStdOutErr += suite.outputInterceptor.StopInterceptingAndReturnOutput()\n\t\t\t\t\tsuite.outputInterceptor.StartInterceptingOutputAndForwardTo(suite.client)\n\t\t\t\t}\n\n\t\t\t\tnode.Body = node.SynchronizedAfterSuiteProc1Body\n\t\t\t\tnode.HasContext = node.SynchronizedAfterSuiteProc1BodyHasContext\n\t\t\t\tstate, failure := suite.runNode(node, time.Time{}, \"\")\n\t\t\t\tif suite.currentSpecReport.State.Is(types.SpecStatePassed) {\n\t\t\t\t\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = state, failure\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tif err != nil && !suite.currentSpecReport.State.Is(types.SpecStateFailureStates) {\n\t\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = types.SpecStateFailed, suite.failureForLeafNodeWithMessage(node, err.Error())\n\t\tsuite.reporter.EmitFailure(suite.currentSpecReport.State, suite.currentSpecReport.Failure)\n\t}\n\n\tsuite.currentSpecReport.EndTime = time.Now()\n\tsuite.currentSpecReport.RunTime = suite.currentSpecReport.EndTime.Sub(suite.currentSpecReport.StartTime)\n\tsuite.currentSpecReport.CapturedGinkgoWriterOutput = string(suite.writer.Bytes())\n\tsuite.currentSpecReport.CapturedStdOutErr += suite.outputInterceptor.StopInterceptingAndReturnOutput()\n}\n\nfunc (suite *Suite) runReportSuiteNodesIfNeedBe(nodeType types.NodeType) {\n\tnodes := suite.suiteNodes.WithType(nodeType)\n\t// only run ReportAfterSuite on proc 1\n\tif nodeType.Is(types.NodeTypeReportAfterSuite) && suite.config.ParallelProcess != 1 {\n\t\treturn\n\t}\n\t// if we're running ReportBeforeSuite on proc > 1 - we should wait until proc 1 has completed\n\tif nodeType.Is(types.NodeTypeReportBeforeSuite) && suite.config.ParallelProcess != 1 && len(nodes) > 0 {\n\t\tstate, err := suite.client.BlockUntilReportBeforeSuiteCompleted()\n\t\tif err != nil || state.Is(types.SpecStateFailed) {\n\t\t\tsuite.report.SuiteSucceeded = false\n\t\t}\n\t\treturn\n\t}\n\n\tfor _, node := range nodes {\n\t\tsuite.selectiveLock.Lock()\n\t\tsuite.currentSpecReport = types.SpecReport{\n\t\t\tLeafNodeType: node.NodeType,\n\t\t\tLeafNodeLocation: node.CodeLocation,\n\t\t\tLeafNodeText: node.Text,\n\t\t\tParallelProcess: suite.config.ParallelProcess,\n\t\t\tRunningInParallel: suite.isRunningInParallel(),\n\t\t}\n\t\tsuite.selectiveLock.Unlock()\n\n\t\tsuite.reporter.WillRun(suite.currentSpecReport)\n\t\tsuite.runReportSuiteNode(node, suite.report)\n\t\tsuite.processCurrentSpecReport()\n\t}\n\n\t// if we're running ReportBeforeSuite and we're running in parallel - we shuld tell the other procs that we're done\n\tif nodeType.Is(types.NodeTypeReportBeforeSuite) && suite.isRunningInParallel() && len(nodes) > 0 {\n\t\tif suite.report.SuiteSucceeded {\n\t\t\tsuite.client.PostReportBeforeSuiteCompleted(types.SpecStatePassed)\n\t\t} else {\n\t\t\tsuite.client.PostReportBeforeSuiteCompleted(types.SpecStateFailed)\n\t\t}\n\t}\n}\n\nfunc (suite *Suite) runReportSuiteNode(node Node, report types.Report) {\n\tsuite.writer.Truncate()\n\tsuite.outputInterceptor.StartInterceptingOutput()\n\tsuite.currentSpecReport.StartTime = time.Now()\n\n\t// if we're running a ReportAfterSuite in parallel (on proc 1) we (a) wait until other procs have exited and\n\t// (b) always fetch the latest report as prior ReportAfterSuites will contribute to it\n\tif node.NodeType.Is(types.NodeTypeReportAfterSuite) && suite.isRunningInParallel() {\n\t\taggregatedReport, err := suite.client.BlockUntilAggregatedNonprimaryProcsReport()\n\t\tif err != nil {\n\t\t\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = types.SpecStateFailed, suite.failureForLeafNodeWithMessage(node, err.Error())\n\t\t\tsuite.reporter.EmitFailure(suite.currentSpecReport.State, suite.currentSpecReport.Failure)\n\t\t\treturn\n\t\t}\n\t\treport = report.Add(aggregatedReport)\n\t}\n\n\tnode.Body = func(ctx SpecContext) { node.ReportSuiteBody(ctx, report) }\n\tsuite.currentSpecReport.State, suite.currentSpecReport.Failure = suite.runNode(node, time.Time{}, \"\")\n\n\tsuite.currentSpecReport.EndTime = time.Now()\n\tsuite.currentSpecReport.RunTime = suite.currentSpecReport.EndTime.Sub(suite.currentSpecReport.StartTime)\n\tsuite.currentSpecReport.CapturedGinkgoWriterOutput = string(suite.writer.Bytes())\n\tsuite.currentSpecReport.CapturedStdOutErr = suite.outputInterceptor.StopInterceptingAndReturnOutput()\n}\n\nfunc (suite *Suite) runNode(node Node, specDeadline time.Time, text string) (types.SpecState, types.Failure) {\n\tif node.NodeType.Is(types.NodeTypeCleanupAfterEach | types.NodeTypeCleanupAfterAll | types.NodeTypeCleanupAfterSuite) {\n\t\tsuite.cleanupNodes = suite.cleanupNodes.WithoutNode(node)\n\t}\n\n\tinterruptStatus := suite.interruptHandler.Status()\n\tif interruptStatus.Level == interrupt_handler.InterruptLevelBailOut {\n\t\treturn types.SpecStateSkipped, types.Failure{}\n\t}\n\tif interruptStatus.Level == interrupt_handler.InterruptLevelReportOnly && !node.NodeType.Is(types.NodeTypesAllowedDuringReportInterrupt) {\n\t\treturn types.SpecStateSkipped, types.Failure{}\n\t}\n\tif interruptStatus.Level == interrupt_handler.InterruptLevelCleanupAndReport && !node.NodeType.Is(types.NodeTypesAllowedDuringReportInterrupt|types.NodeTypesAllowedDuringCleanupInterrupt) {\n\t\treturn types.SpecStateSkipped, types.Failure{}\n\t}\n\n\tsuite.selectiveLock.Lock()\n\tsuite.currentNode = node\n\tsuite.currentNodeStartTime = time.Now()\n\tsuite.currentByStep = types.SpecEvent{}\n\tsuite.selectiveLock.Unlock()\n\tdefer func() {\n\t\tsuite.selectiveLock.Lock()\n\t\tsuite.currentNode = Node{}\n\t\tsuite.currentNodeStartTime = time.Time{}\n\t\tsuite.selectiveLock.Unlock()\n\t}()\n\n\tif text == \"\" {\n\t\ttext = \"TOP-LEVEL\"\n\t}\n\tevent := suite.handleSpecEvent(types.SpecEvent{\n\t\tSpecEventType: types.SpecEventNodeStart,\n\t\tNodeType: node.NodeType,\n\t\tMessage: text,\n\t\tCodeLocation: node.CodeLocation,\n\t})\n\tdefer func() {\n\t\tsuite.handleSpecEventEnd(types.SpecEventNodeEnd, event)\n\t}()\n\n\tvar failure types.Failure\n\tfailure.FailureNodeType, failure.FailureNodeLocation = node.NodeType, node.CodeLocation\n\tif node.NodeType.Is(types.NodeTypeIt) || node.NodeType.Is(types.NodeTypesForSuiteLevelNodes) {\n\t\tfailure.FailureNodeContext = types.FailureNodeIsLeafNode\n\t} else if node.NestingLevel <= 0 {\n\t\tfailure.FailureNodeContext = types.FailureNodeAtTopLevel\n\t} else {\n\t\tfailure.FailureNodeContext, failure.FailureNodeContainerIndex = types.FailureNodeInContainer, node.NestingLevel-1\n\t}\n\tvar outcome types.SpecState\n\n\tgracePeriod := suite.config.GracePeriod\n\tif node.GracePeriod >= 0 {\n\t\tgracePeriod = node.GracePeriod\n\t}\n\n\tnow := time.Now()\n\tdeadline := suite.deadline\n\ttimeoutInPlay := \"suite\"\n\tif deadline.IsZero() || (!specDeadline.IsZero() && specDeadline.Before(deadline)) {\n\t\tdeadline = specDeadline\n\t\ttimeoutInPlay = \"spec\"\n\t}\n\tif node.NodeTimeout > 0 && (deadline.IsZero() || deadline.Sub(now) > node.NodeTimeout) {\n\t\tdeadline = now.Add(node.NodeTimeout)\n\t\ttimeoutInPlay = \"node\"\n\t}\n\tif (!deadline.IsZero() && deadline.Before(now)) || interruptStatus.Interrupted() {\n\t\t// we're out of time already. let's wait for a NodeTimeout if we have it, or GracePeriod if we don't\n\t\tif node.NodeTimeout > 0 {\n\t\t\tdeadline = now.Add(node.NodeTimeout)\n\t\t\ttimeoutInPlay = \"node\"\n\t\t} else {\n\t\t\tdeadline = now.Add(gracePeriod)\n\t\t\ttimeoutInPlay = \"grace period\"\n\t\t}\n\t}\n\n\tif !node.HasContext {\n\t\t// this maps onto the pre-context behavior:\n\t\t// - an interrupted node exits immediately. with this, context-less nodes that are in a spec with a SpecTimeout and/or are interrupted by other means will simply exit immediately after the timeout/interrupt\n\t\t// - clean up nodes have up to GracePeriod (formerly hard-coded at 30s) to complete before they are interrupted\n\t\tgracePeriod = 0\n\t}\n\n\tsc := NewSpecContext(suite)\n\tdefer sc.cancel(fmt.Errorf(\"spec has finished\"))\n\n\tsuite.selectiveLock.Lock()\n\tsuite.currentSpecContext = sc\n\tsuite.selectiveLock.Unlock()\n\n\tvar deadlineChannel <-chan time.Time\n\tif !deadline.IsZero() {\n\t\tdeadlineChannel = time.After(deadline.Sub(now))\n\t}\n\tvar gracePeriodChannel <-chan time.Time\n\n\toutcomeC := make(chan types.SpecState)\n\tfailureC := make(chan types.Failure)\n\n\tgo func() {\n\t\tfinished := false\n\t\tdefer func() {\n\t\t\tif e := recover(); e != nil || !finished {\n\t\t\t\tsuite.failer.Panic(types.NewCodeLocationWithStackTrace(2), e)\n\t\t\t}\n\n\t\t\toutcomeFromRun, failureFromRun := suite.failer.Drain()\n\t\t\tfailureFromRun.TimelineLocation = suite.generateTimelineLocation()\n\t\t\toutcomeC <- outcomeFromRun\n\t\t\tfailureC <- failureFromRun\n\t\t}()\n\n\t\taroundNodes := types.AroundNodes{}.Append(suite.aroundNodes...).Append(node.AroundNodes...)\n\t\tif len(aroundNodes) > 0 {\n\t\t\ti := 0\n\t\t\tvar f func(context.Context)\n\t\t\tf = func(c context.Context) {\n\t\t\t\tsc := wrapContextChain(c)\n\t\t\t\tif sc == nil {\n\t\t\t\t\tsuite.failer.Fail(\"An AroundNode failed to pass a valid Ginkgo SpecContext in. You must always pass in a context derived from the context passed to you.\", aroundNodes[i].CodeLocation)\n\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t\ti++\n\t\t\t\tif i < len(aroundNodes) {\n\t\t\t\t\taroundNodes[i].Body(sc, f)\n\t\t\t\t} else {\n\t\t\t\t\tnode.Body(sc)\n\t\t\t\t}\n\t\t\t}\n\t\t\taroundNodes[0].Body(sc, f)\n\t\t\tif i != len(aroundNodes) {\n\t\t\t\tsuite.failer.Fail(\"An AroundNode failed to call the passed in function.\", aroundNodes[i].CodeLocation)\n\t\t\t}\n\t\t} else {\n\t\t\tnode.Body(sc)\n\t\t}\n\t\tfinished = true\n\t}()\n\n\t// progress polling timer and channel\n\tvar emitProgressNow <-chan time.Time\n\tvar progressPoller *time.Timer\n\tvar pollProgressAfter, pollProgressInterval = suite.config.PollProgressAfter, suite.config.PollProgressInterval\n\tif node.PollProgressAfter >= 0 {\n\t\tpollProgressAfter = node.PollProgressAfter\n\t}\n\tif node.PollProgressInterval >= 0 {\n\t\tpollProgressInterval = node.PollProgressInterval\n\t}\n\tif pollProgressAfter > 0 {\n\t\tprogressPoller = time.NewTimer(pollProgressAfter)\n\t\temitProgressNow = progressPoller.C\n\t\tdefer progressPoller.Stop()\n\t}\n\n\t// now we wait for an outcome, an interrupt, a timeout, or a progress poll\n\tfor {\n\t\tselect {\n\t\tcase outcomeFromRun := <-outcomeC:\n\t\t\tfailureFromRun := <-failureC\n\t\t\tif outcome.Is(types.SpecStateInterrupted | types.SpecStateTimedout) {\n\t\t\t\t// we've already been interrupted/timed out. we just managed to actually exit\n\t\t\t\t// before the grace period elapsed\n\t\t\t\t// if we have a failure message we attach it as an additional failure\n\t\t\t\tif outcomeFromRun != types.SpecStatePassed {\n\t\t\t\t\tadditionalFailure := types.AdditionalFailure{\n\t\t\t\t\t\tState: outcomeFromRun,\n\t\t\t\t\t\tFailure: failure, // we make a copy - this will include all the configuration set up above...\n\t\t\t\t\t}\n\t\t\t\t\t// ...and then we update the failure with the details from failureFromRun\n\t\t\t\t\tadditionalFailure.Failure.Location, additionalFailure.Failure.ForwardedPanic, additionalFailure.Failure.TimelineLocation = failureFromRun.Location, failureFromRun.ForwardedPanic, failureFromRun.TimelineLocation\n\t\t\t\t\tadditionalFailure.Failure.ProgressReport = types.ProgressReport{}\n\t\t\t\t\tif outcome == types.SpecStateTimedout {\n\t\t\t\t\t\tadditionalFailure.Failure.Message = fmt.Sprintf(\"A %s timeout occurred and then the following failure was recorded in the timedout node before it exited:\\n%s\", timeoutInPlay, failureFromRun.Message)\n\t\t\t\t\t} else {\n\t\t\t\t\t\tadditionalFailure.Failure.Message = fmt.Sprintf(\"An interrupt occurred and then the following failure was recorded in the interrupted node before it exited:\\n%s\", failureFromRun.Message)\n\t\t\t\t\t}\n\t\t\t\t\tsuite.reporter.EmitFailure(additionalFailure.State, additionalFailure.Failure)\n\t\t\t\t\tfailure.AdditionalFailure = &additionalFailure\n\t\t\t\t}\n\t\t\t\treturn outcome, failure\n\t\t\t}\n\t\t\tif outcomeFromRun.Is(types.SpecStatePassed) {\n\t\t\t\treturn outcomeFromRun, types.Failure{}\n\t\t\t} else {\n\t\t\t\tfailure.Message, failure.Location, failure.ForwardedPanic, failure.TimelineLocation = failureFromRun.Message, failureFromRun.Location, failureFromRun.ForwardedPanic, failureFromRun.TimelineLocation\n\t\t\t\tsuite.reporter.EmitFailure(outcomeFromRun, failure)\n\t\t\t\treturn outcomeFromRun, failure\n\t\t\t}\n\t\tcase <-gracePeriodChannel:\n\t\t\tif node.HasContext && outcome.Is(types.SpecStateTimedout) {\n\t\t\t\treport := suite.generateProgressReport(false)\n\t\t\t\treport.Message = \"{{bold}}{{orange}}A running node failed to exit in time{{/}}\\nGinkgo is moving on but a node has timed out and failed to exit before its grace period elapsed. The node has now leaked and is running in the background.\\nHere's a current progress report:\"\n\t\t\t\tsuite.emitProgressReport(report)\n\t\t\t}\n\t\t\treturn outcome, failure\n\t\tcase <-deadlineChannel:\n\t\t\t// we're out of time - the outcome is a timeout and we capture the failure and progress report\n\t\t\toutcome = types.SpecStateTimedout\n\t\t\tfailure.Message, failure.Location, failure.TimelineLocation = fmt.Sprintf(\"A %s timeout occurred\", timeoutInPlay), node.CodeLocation, suite.generateTimelineLocation()\n\t\t\tfailure.ProgressReport = suite.generateProgressReport(false).WithoutCapturedGinkgoWriterOutput()\n\t\t\tfailure.ProgressReport.Message = fmt.Sprintf(\"{{bold}}This is the Progress Report generated when the %s timeout occurred:{{/}}\", timeoutInPlay)\n\t\t\tdeadlineChannel = nil\n\t\t\tsuite.reporter.EmitFailure(outcome, failure)\n\n\t\t\t// tell the spec to stop. it's important we generate the progress report first to make sure we capture where\n\t\t\t// the spec is actually stuck\n\t\t\tsc.cancel(fmt.Errorf(\"%s timeout occurred\", timeoutInPlay))\n\t\t\t// and now we wait for the grace period\n\t\t\tgracePeriodChannel = time.After(gracePeriod)\n\t\tcase <-interruptStatus.Channel:\n\t\t\tinterruptStatus = suite.interruptHandler.Status()\n\t\t\t// ignore interruption from other process if we are cleaning up or reporting\n\t\t\tif interruptStatus.Cause == interrupt_handler.InterruptCauseAbortByOtherProcess &&\n\t\t\t\tnode.NodeType.Is(types.NodeTypesAllowedDuringReportInterrupt|types.NodeTypesAllowedDuringCleanupInterrupt) {\n\t\t\t\tcontinue\n\t\t\t}\n\n\t\t\tdeadlineChannel = nil // don't worry about deadlines, time's up now\n\n\t\t\tfailureTimelineLocation := suite.generateTimelineLocation()\n\t\t\tprogressReport := suite.generateProgressReport(true)\n\n\t\t\tif outcome == types.SpecStateInvalid {\n\t\t\t\toutcome = types.SpecStateInterrupted\n\t\t\t\tfailure.Message, failure.Location, failure.TimelineLocation = interruptStatus.Message(), node.CodeLocation, failureTimelineLocation\n\t\t\t\tif interruptStatus.ShouldIncludeProgressReport() {\n\t\t\t\t\tfailure.ProgressReport = progressReport.WithoutCapturedGinkgoWriterOutput()\n\t\t\t\t\tfailure.ProgressReport.Message = \"{{bold}}This is the Progress Report generated when the interrupt was received:{{/}}\"\n\t\t\t\t}\n\t\t\t\tsuite.reporter.EmitFailure(outcome, failure)\n\t\t\t}\n\n\t\t\tprogressReport = progressReport.WithoutOtherGoroutines()\n\t\t\tsc.cancel(fmt.Errorf(\"%s\", interruptStatus.Message()))\n\n\t\t\tif interruptStatus.Level == interrupt_handler.InterruptLevelBailOut {\n\t\t\t\tif interruptStatus.ShouldIncludeProgressReport() {\n\t\t\t\t\tprogressReport.Message = fmt.Sprintf(\"{{bold}}{{orange}}%s{{/}}\\n{{bold}}{{red}}Final interrupt received{{/}}; Ginkgo will not run any cleanup or reporting nodes and will terminate as soon as possible.\\nHere's a current progress report:\", interruptStatus.Message())\n\t\t\t\t\tsuite.emitProgressReport(progressReport)\n\t\t\t\t}\n\t\t\t\treturn outcome, failure\n\t\t\t}\n\t\t\tif interruptStatus.ShouldIncludeProgressReport() {\n\t\t\t\tif interruptStatus.Level == interrupt_handler.InterruptLevelCleanupAndReport {\n\t\t\t\t\tprogressReport.Message = fmt.Sprintf(\"{{bold}}{{orange}}%s{{/}}\\nFirst interrupt received; Ginkgo will run any cleanup and reporting nodes but will skip all remaining specs. {{bold}}Interrupt again to skip cleanup{{/}}.\\nHere's a current progress report:\", interruptStatus.Message())\n\t\t\t\t} else if interruptStatus.Level == interrupt_handler.InterruptLevelReportOnly {\n\t\t\t\t\tprogressReport.Message = fmt.Sprintf(\"{{bold}}{{orange}}%s{{/}}\\nSecond interrupt received; Ginkgo will run any reporting nodes but will skip all remaining specs and cleanup nodes. {{bold}}Interrupt again to bail immediately{{/}}.\\nHere's a current progress report:\", interruptStatus.Message())\n\t\t\t\t}\n\t\t\t\tsuite.emitProgressReport(progressReport)\n\t\t\t}\n\n\t\t\tif gracePeriodChannel == nil {\n\t\t\t\t// we haven't given grace yet... so let's\n\t\t\t\tgracePeriodChannel = time.After(gracePeriod)\n\t\t\t} else {\n\t\t\t\t// we've already given grace. time's up. now.\n\t\t\t\treturn outcome, failure\n\t\t\t}\n\t\tcase <-emitProgressNow:\n\t\t\treport := suite.generateProgressReport(false)\n\t\t\treport.Message = \"{{bold}}Automatically polling progress:{{/}}\"\n\t\t\tsuite.emitProgressReport(report)\n\t\t\tif pollProgressInterval > 0 {\n\t\t\t\tprogressPoller.Reset(pollProgressInterval)\n\t\t\t}\n\t\t}\n\t}\n}\n\n// TODO: search for usages and consider if reporter.EmitFailure() is necessary\nfunc (suite *Suite) failureForLeafNodeWithMessage(node Node, message string) types.Failure {\n\treturn types.Failure{\n\t\tMessage: message,\n\t\tLocation: node.CodeLocation,\n\t\tTimelineLocation: suite.generateTimelineLocation(),\n\t\tFailureNodeContext: types.FailureNodeIsLeafNode,\n\t\tFailureNodeType: node.NodeType,\n\t\tFailureNodeLocation: node.CodeLocation,\n\t}\n}\n\nfunc max(a, b int) int {\n\tif a > b {\n\t\treturn a\n\t}\n\treturn b\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/testingtproxy/testing_t_proxy.go",
"content": "package testingtproxy\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\t\"os\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/internal\"\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype failFunc func(message string, callerSkip ...int)\ntype skipFunc func(message string, callerSkip ...int)\ntype cleanupFunc func(args ...any)\ntype reportFunc func() types.SpecReport\ntype addReportEntryFunc func(names string, args ...any)\ntype ginkgoWriterInterface interface {\n\tio.Writer\n\n\tPrint(a ...any)\n\tPrintf(format string, a ...any)\n\tPrintln(a ...any)\n}\ntype ginkgoRecoverFunc func()\ntype attachProgressReporterFunc func(func() string) func()\n\nvar formatters = map[bool]formatter.Formatter{\n\ttrue: formatter.NewWithNoColorBool(true),\n\tfalse: formatter.NewWithNoColorBool(false),\n}\n\nfunc New(writer ginkgoWriterInterface, fail failFunc, skip skipFunc, cleanup cleanupFunc, report reportFunc, addReportEntry addReportEntryFunc, ginkgoRecover ginkgoRecoverFunc, attachProgressReporter attachProgressReporterFunc, randomSeed int64, parallelProcess int, parallelTotal int, noColor bool, offset int) *ginkgoTestingTProxy {\n\treturn &ginkgoTestingTProxy{\n\t\tfail: fail,\n\t\toffset: offset,\n\t\twriter: writer,\n\t\tskip: skip,\n\t\tcleanup: cleanup,\n\t\treport: report,\n\t\taddReportEntry: addReportEntry,\n\t\tginkgoRecover: ginkgoRecover,\n\t\tattachProgressReporter: attachProgressReporter,\n\t\trandomSeed: randomSeed,\n\t\tparallelProcess: parallelProcess,\n\t\tparallelTotal: parallelTotal,\n\t\tf: formatters[noColor], //minimize allocations by reusing formatters\n\t}\n}\n\ntype ginkgoTestingTProxy struct {\n\tfail failFunc\n\tskip skipFunc\n\tcleanup cleanupFunc\n\treport reportFunc\n\toffset int\n\twriter ginkgoWriterInterface\n\taddReportEntry addReportEntryFunc\n\tginkgoRecover ginkgoRecoverFunc\n\tattachProgressReporter attachProgressReporterFunc\n\trandomSeed int64\n\tparallelProcess int\n\tparallelTotal int\n\tf formatter.Formatter\n}\n\n// basic testing.T support\n\nfunc (t *ginkgoTestingTProxy) Cleanup(f func()) {\n\tt.cleanup(f, internal.Offset(1))\n}\n\nfunc (t *ginkgoTestingTProxy) Setenv(key, value string) {\n\toriginalValue, exists := os.LookupEnv(key)\n\tif exists {\n\t\tt.cleanup(os.Setenv, key, originalValue, internal.Offset(1))\n\t} else {\n\t\tt.cleanup(os.Unsetenv, key, internal.Offset(1))\n\t}\n\n\terr := os.Setenv(key, value)\n\tif err != nil {\n\t\tt.fail(fmt.Sprintf(\"Failed to set environment variable: %v\", err), 1)\n\t}\n}\n\nfunc (t *ginkgoTestingTProxy) Chdir(dir string) {\n\tcurrentDir, err := os.Getwd()\n\tif err != nil {\n\t\tt.fail(fmt.Sprintf(\"Failed to get current directory: %v\", err), 1)\n\t}\n\n\tt.cleanup(os.Chdir, currentDir, internal.Offset(1))\n\n\terr = os.Chdir(dir)\n\tif err != nil {\n\t\tt.fail(fmt.Sprintf(\"Failed to change directory: %v\", err), 1)\n\t}\n}\n\nfunc (t *ginkgoTestingTProxy) Context() context.Context {\n\tctx, cancel := context.WithCancel(context.Background())\n\tt.cleanup(cancel, internal.Offset(1))\n\treturn ctx\n}\n\nfunc (t *ginkgoTestingTProxy) Error(args ...any) {\n\tt.fail(fmt.Sprintln(args...), t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) Errorf(format string, args ...any) {\n\tt.fail(fmt.Sprintf(format, args...), t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) Fail() {\n\tt.fail(\"failed\", t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) FailNow() {\n\tt.fail(\"failed\", t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) Failed() bool {\n\treturn t.report().Failed()\n}\n\nfunc (t *ginkgoTestingTProxy) Fatal(args ...any) {\n\tt.fail(fmt.Sprintln(args...), t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) Fatalf(format string, args ...any) {\n\tt.fail(fmt.Sprintf(format, args...), t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) Helper() {\n\ttypes.MarkAsHelper(1)\n}\n\nfunc (t *ginkgoTestingTProxy) Log(args ...any) {\n\tfmt.Fprintln(t.writer, args...)\n}\n\nfunc (t *ginkgoTestingTProxy) Logf(format string, args ...any) {\n\tt.Log(fmt.Sprintf(format, args...))\n}\n\nfunc (t *ginkgoTestingTProxy) Name() string {\n\treturn t.report().FullText()\n}\n\nfunc (t *ginkgoTestingTProxy) Parallel() {\n\t// No-op\n}\n\nfunc (t *ginkgoTestingTProxy) Skip(args ...any) {\n\tt.skip(fmt.Sprintln(args...), t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) SkipNow() {\n\tt.skip(\"skip\", t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) Skipf(format string, args ...any) {\n\tt.skip(fmt.Sprintf(format, args...), t.offset)\n}\n\nfunc (t *ginkgoTestingTProxy) Skipped() bool {\n\treturn t.report().State.Is(types.SpecStateSkipped)\n}\n\nfunc (t *ginkgoTestingTProxy) TempDir() string {\n\ttmpDir, err := os.MkdirTemp(\"\", \"ginkgo\")\n\tif err != nil {\n\t\tt.fail(fmt.Sprintf(\"Failed to create temporary directory: %v\", err), 1)\n\t\treturn \"\"\n\t}\n\tt.cleanup(os.RemoveAll, tmpDir)\n\n\treturn tmpDir\n}\n\n// FullGinkgoTInterface\nfunc (t *ginkgoTestingTProxy) AddReportEntryVisibilityAlways(name string, args ...any) {\n\tfinalArgs := []any{internal.Offset(1), types.ReportEntryVisibilityAlways}\n\tt.addReportEntry(name, append(finalArgs, args...)...)\n}\nfunc (t *ginkgoTestingTProxy) AddReportEntryVisibilityFailureOrVerbose(name string, args ...any) {\n\tfinalArgs := []any{internal.Offset(1), types.ReportEntryVisibilityFailureOrVerbose}\n\tt.addReportEntry(name, append(finalArgs, args...)...)\n}\nfunc (t *ginkgoTestingTProxy) AddReportEntryVisibilityNever(name string, args ...any) {\n\tfinalArgs := []any{internal.Offset(1), types.ReportEntryVisibilityNever}\n\tt.addReportEntry(name, append(finalArgs, args...)...)\n}\nfunc (t *ginkgoTestingTProxy) Print(a ...any) {\n\tt.writer.Print(a...)\n}\nfunc (t *ginkgoTestingTProxy) Printf(format string, a ...any) {\n\tt.writer.Printf(format, a...)\n}\nfunc (t *ginkgoTestingTProxy) Println(a ...any) {\n\tt.writer.Println(a...)\n}\nfunc (t *ginkgoTestingTProxy) F(format string, args ...any) string {\n\treturn t.f.F(format, args...)\n}\nfunc (t *ginkgoTestingTProxy) Fi(indentation uint, format string, args ...any) string {\n\treturn t.f.Fi(indentation, format, args...)\n}\nfunc (t *ginkgoTestingTProxy) Fiw(indentation uint, maxWidth uint, format string, args ...any) string {\n\treturn t.f.Fiw(indentation, maxWidth, format, args...)\n}\nfunc (t *ginkgoTestingTProxy) RenderTimeline() string {\n\treturn reporters.RenderTimeline(t.report(), false)\n}\nfunc (t *ginkgoTestingTProxy) GinkgoRecover() {\n\tt.ginkgoRecover()\n}\nfunc (t *ginkgoTestingTProxy) DeferCleanup(args ...any) {\n\tfinalArgs := []any{internal.Offset(1)}\n\tt.cleanup(append(finalArgs, args...)...)\n}\nfunc (t *ginkgoTestingTProxy) RandomSeed() int64 {\n\treturn t.randomSeed\n}\nfunc (t *ginkgoTestingTProxy) ParallelProcess() int {\n\treturn t.parallelProcess\n}\nfunc (t *ginkgoTestingTProxy) ParallelTotal() int {\n\treturn t.parallelTotal\n}\nfunc (t *ginkgoTestingTProxy) AttachProgressReporter(f func() string) func() {\n\treturn t.attachProgressReporter(f)\n}\nfunc (t *ginkgoTestingTProxy) Output() io.Writer {\n\treturn t.writer\n}\nfunc (t *ginkgoTestingTProxy) Attr(key, value string) {\n\tt.addReportEntry(key, value, internal.Offset(1), types.ReportEntryVisibilityFailureOrVerbose)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/tree.go",
"content": "package internal\n\nimport \"github.com/onsi/ginkgo/v2/types\"\n\ntype TreeNode struct {\n\tNode Node\n\tParent *TreeNode\n\tChildren TreeNodes\n}\n\nfunc (tn *TreeNode) AppendChild(child *TreeNode) {\n\ttn.Children = append(tn.Children, child)\n\tchild.Parent = tn\n}\n\nfunc (tn *TreeNode) AncestorNodeChain() Nodes {\n\tif tn.Parent == nil || tn.Parent.Node.IsZero() {\n\t\treturn Nodes{tn.Node}\n\t}\n\treturn append(tn.Parent.AncestorNodeChain(), tn.Node)\n}\n\ntype TreeNodes []*TreeNode\n\nfunc (tn TreeNodes) Nodes() Nodes {\n\tout := make(Nodes, len(tn))\n\tfor i := range tn {\n\t\tout[i] = tn[i].Node\n\t}\n\treturn out\n}\n\nfunc (tn TreeNodes) WithID(id uint) *TreeNode {\n\tfor i := range tn {\n\t\tif tn[i].Node.ID == id {\n\t\t\treturn tn[i]\n\t\t}\n\t}\n\n\treturn nil\n}\n\nfunc GenerateSpecsFromTreeRoot(tree *TreeNode) Specs {\n\tvar walkTree func(nestingLevel int, lNodes Nodes, rNodes Nodes, trees TreeNodes) Specs\n\twalkTree = func(nestingLevel int, lNodes Nodes, rNodes Nodes, trees TreeNodes) Specs {\n\t\ttests := Specs{}\n\n\t\tnodes := make(Nodes, len(trees))\n\t\tfor i := range trees {\n\t\t\tnodes[i] = trees[i].Node\n\t\t\tnodes[i].NestingLevel = nestingLevel\n\t\t}\n\n\t\tfor i := range nodes {\n\t\t\tif !nodes[i].NodeType.Is(types.NodeTypesForContainerAndIt) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tleftNodes, rightNodes := nodes.SplitAround(nodes[i])\n\t\t\tleftNodes = leftNodes.WithoutType(types.NodeTypesForContainerAndIt)\n\t\t\trightNodes = rightNodes.WithoutType(types.NodeTypesForContainerAndIt)\n\n\t\t\tleftNodes = lNodes.CopyAppend(leftNodes...)\n\t\t\trightNodes = rightNodes.CopyAppend(rNodes...)\n\n\t\t\tif nodes[i].NodeType.Is(types.NodeTypeIt) {\n\t\t\t\ttests = append(tests, Spec{Nodes: leftNodes.CopyAppend(nodes[i]).CopyAppend(rightNodes...)})\n\t\t\t} else {\n\t\t\t\ttreeNode := trees.WithID(nodes[i].ID)\n\t\t\t\ttests = append(tests, walkTree(nestingLevel+1, leftNodes.CopyAppend(nodes[i]), rightNodes, treeNode.Children)...)\n\t\t\t}\n\t\t}\n\n\t\treturn tests\n\t}\n\n\treturn walkTree(0, Nodes{}, Nodes{}, tree.Children)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/internal/writer.go",
"content": "package internal\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"sync\"\n\n\t\"github.com/go-logr/logr\"\n\t\"github.com/go-logr/logr/funcr\"\n)\n\ntype WriterMode uint\n\nconst (\n\tWriterModeStreamAndBuffer WriterMode = iota\n\tWriterModeBufferOnly\n)\n\ntype WriterInterface interface {\n\tio.Writer\n\n\tTruncate()\n\tBytes() []byte\n\tLen() int\n}\n\n// Writer implements WriterInterface and GinkgoWriterInterface\ntype Writer struct {\n\tbuffer *bytes.Buffer\n\toutWriter io.Writer\n\tlock *sync.Mutex\n\tmode WriterMode\n\n\tstreamIndent []byte\n\tindentNext bool\n\n\tteeWriters []io.Writer\n}\n\nfunc NewWriter(outWriter io.Writer) *Writer {\n\treturn &Writer{\n\t\tbuffer: &bytes.Buffer{},\n\t\tlock: &sync.Mutex{},\n\t\toutWriter: outWriter,\n\t\tmode: WriterModeStreamAndBuffer,\n\t\tstreamIndent: []byte(\" \"),\n\t\tindentNext: true,\n\t}\n}\n\nfunc (w *Writer) SetMode(mode WriterMode) {\n\tw.lock.Lock()\n\tdefer w.lock.Unlock()\n\tw.mode = mode\n}\n\nfunc (w *Writer) Len() int {\n\tw.lock.Lock()\n\tdefer w.lock.Unlock()\n\treturn w.buffer.Len()\n}\n\nvar newline = []byte(\"\\n\")\n\nfunc (w *Writer) Write(b []byte) (n int, err error) {\n\tw.lock.Lock()\n\tdefer w.lock.Unlock()\n\n\tfor _, teeWriter := range w.teeWriters {\n\t\tteeWriter.Write(b)\n\t}\n\n\tif w.mode == WriterModeStreamAndBuffer {\n\t\tline, remaining, found := []byte{}, b, false\n\t\tfor len(remaining) > 0 {\n\t\t\tline, remaining, found = bytes.Cut(remaining, newline)\n\t\t\tif len(line) > 0 {\n\t\t\t\tif w.indentNext {\n\t\t\t\t\tw.outWriter.Write(w.streamIndent)\n\t\t\t\t\tw.indentNext = false\n\t\t\t\t}\n\t\t\t\tw.outWriter.Write(line)\n\t\t\t}\n\t\t\tif found {\n\t\t\t\tw.outWriter.Write(newline)\n\t\t\t\tw.indentNext = true\n\t\t\t}\n\t\t}\n\t}\n\treturn w.buffer.Write(b)\n}\n\nfunc (w *Writer) Truncate() {\n\tw.lock.Lock()\n\tdefer w.lock.Unlock()\n\tw.buffer.Reset()\n}\n\nfunc (w *Writer) Bytes() []byte {\n\tw.lock.Lock()\n\tdefer w.lock.Unlock()\n\tb := w.buffer.Bytes()\n\tcopied := make([]byte, len(b))\n\tcopy(copied, b)\n\treturn copied\n}\n\n// GinkgoWriterInterface\nfunc (w *Writer) TeeTo(writer io.Writer) {\n\tw.lock.Lock()\n\tdefer w.lock.Unlock()\n\n\tw.teeWriters = append(w.teeWriters, writer)\n}\n\nfunc (w *Writer) ClearTeeWriters() {\n\tw.lock.Lock()\n\tdefer w.lock.Unlock()\n\n\tw.teeWriters = []io.Writer{}\n}\n\nfunc (w *Writer) Print(a ...any) {\n\tfmt.Fprint(w, a...)\n}\n\nfunc (w *Writer) Printf(format string, a ...any) {\n\tfmt.Fprintf(w, format, a...)\n}\n\nfunc (w *Writer) Println(a ...any) {\n\tfmt.Fprintln(w, a...)\n}\n\nfunc GinkgoLogrFunc(writer *Writer) logr.Logger {\n\treturn funcr.New(func(prefix, args string) {\n\t\tif prefix == \"\" {\n\t\t\twriter.Printf(\"%s\\n\", args)\n\t\t} else {\n\t\t\twriter.Printf(\"%s %s\\n\", prefix, args)\n\t\t}\n\t}, funcr.Options{})\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/reporters/default_reporter.go",
"content": "/*\nGinkgo's Default Reporter\n\nA number of command line flags are available to tweak Ginkgo's default output.\n\nThese are documented [here](http://onsi.github.io/ginkgo/#running_tests)\n*/\npackage reporters\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"runtime\"\n\t\"strings\"\n\t\"sync\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype DefaultReporter struct {\n\tconf types.ReporterConfig\n\twriter io.Writer\n\n\t// managing the emission stream\n\tlastCharWasNewline bool\n\tlastEmissionWasDelimiter bool\n\n\t// rendering\n\tspecDenoter string\n\tretryDenoter string\n\tformatter formatter.Formatter\n\n\trunningInParallel bool\n\tlock *sync.Mutex\n}\n\nfunc NewDefaultReporterUnderTest(conf types.ReporterConfig, writer io.Writer) *DefaultReporter {\n\treporter := NewDefaultReporter(conf, writer)\n\treporter.formatter = formatter.New(formatter.ColorModePassthrough)\n\n\treturn reporter\n}\n\nfunc NewDefaultReporter(conf types.ReporterConfig, writer io.Writer) *DefaultReporter {\n\treporter := &DefaultReporter{\n\t\tconf: conf,\n\t\twriter: writer,\n\n\t\tlastCharWasNewline: true,\n\t\tlastEmissionWasDelimiter: false,\n\n\t\tspecDenoter: \"•\",\n\t\tretryDenoter: \"↺\",\n\t\tformatter: formatter.NewWithNoColorBool(conf.NoColor),\n\t\tlock: &sync.Mutex{},\n\t}\n\tif runtime.GOOS == \"windows\" {\n\t\treporter.specDenoter = \"+\"\n\t\treporter.retryDenoter = \"R\"\n\t}\n\n\treturn reporter\n}\n\n/* The Reporter Interface */\n\nfunc (r *DefaultReporter) SuiteWillBegin(report types.Report) {\n\tif r.conf.Verbosity().Is(types.VerbosityLevelSuccinct) {\n\t\tr.emit(r.f(\"[%d] {{bold}}%s{{/}} \", report.SuiteConfig.RandomSeed, report.SuiteDescription))\n\t\tif len(report.SuiteLabels) > 0 {\n\t\t\tr.emit(r.f(\"{{coral}}[%s]{{/}} \", strings.Join(report.SuiteLabels, \", \")))\n\t\t}\n\t\tif len(report.SuiteSemVerConstraints) > 0 {\n\t\t\tr.emit(r.f(\"{{coral}}[%s]{{/}} \", strings.Join(report.SuiteSemVerConstraints, \", \")))\n\t\t}\n\t\tif len(report.SuiteComponentSemVerConstraints) > 0 {\n\t\t\tr.emit(r.f(\"{{coral}}[Components: %s]{{/}} \", formatComponentSemVerConstraintsToString(report.SuiteComponentSemVerConstraints)))\n\t\t}\n\t\tr.emit(r.f(\"- %d/%d specs \", report.PreRunStats.SpecsThatWillRun, report.PreRunStats.TotalSpecs))\n\t\tif report.SuiteConfig.ParallelTotal > 1 {\n\t\t\tr.emit(r.f(\"- %d procs \", report.SuiteConfig.ParallelTotal))\n\t\t}\n\t} else {\n\t\tbanner := r.f(\"Running Suite: %s - %s\", report.SuiteDescription, report.SuitePath)\n\t\tr.emitBlock(banner)\n\t\tbannerWidth := len(banner)\n\t\tif len(report.SuiteLabels) > 0 {\n\t\t\tlabels := strings.Join(report.SuiteLabels, \", \")\n\t\t\tr.emitBlock(r.f(\"{{coral}}[%s]{{/}} \", labels))\n\t\t\tif len(labels)+2 > bannerWidth {\n\t\t\t\tbannerWidth = len(labels) + 2\n\t\t\t}\n\t\t}\n\t\tif len(report.SuiteSemVerConstraints) > 0 {\n\t\t\tsemVerConstraints := strings.Join(report.SuiteSemVerConstraints, \", \")\n\t\t\tr.emitBlock(r.f(\"{{coral}}[%s]{{/}} \", semVerConstraints))\n\t\t\tif len(semVerConstraints)+2 > bannerWidth {\n\t\t\t\tbannerWidth = len(semVerConstraints) + 2\n\t\t\t}\n\t\t}\n\t\tif len(report.SuiteComponentSemVerConstraints) > 0 {\n\t\t\tcomponentSemVerConstraints := formatComponentSemVerConstraintsToString(report.SuiteComponentSemVerConstraints)\n\t\t\tr.emitBlock(r.f(\"{{coral}}[Components: %s]{{/}} \", componentSemVerConstraints))\n\t\t\tif len(componentSemVerConstraints)+2 > bannerWidth {\n\t\t\t\tbannerWidth = len(componentSemVerConstraints) + 2\n\t\t\t}\n\t\t}\n\t\tr.emitBlock(strings.Repeat(\"=\", bannerWidth))\n\n\t\tout := r.f(\"Random Seed: {{bold}}%d{{/}}\", report.SuiteConfig.RandomSeed)\n\t\tif report.SuiteConfig.RandomizeAllSpecs {\n\t\t\tout += r.f(\" - will randomize all specs\")\n\t\t}\n\t\tr.emitBlock(out)\n\t\tr.emit(\"\\n\")\n\t\tr.emitBlock(r.f(\"Will run {{bold}}%d{{/}} of {{bold}}%d{{/}} specs\", report.PreRunStats.SpecsThatWillRun, report.PreRunStats.TotalSpecs))\n\t\tif report.SuiteConfig.ParallelTotal > 1 {\n\t\t\tr.emitBlock(r.f(\"Running in parallel across {{bold}}%d{{/}} processes\", report.SuiteConfig.ParallelTotal))\n\t\t}\n\t}\n}\n\nfunc (r *DefaultReporter) SuiteDidEnd(report types.Report) {\n\tfailures := report.SpecReports.WithState(types.SpecStateFailureStates)\n\tif len(failures) > 0 {\n\t\tr.emitBlock(\"\\n\")\n\t\tif len(failures) > 1 {\n\t\t\tr.emitBlock(r.f(\"{{red}}{{bold}}Summarizing %d Failures:{{/}}\", len(failures)))\n\t\t} else {\n\t\t\tr.emitBlock(r.f(\"{{red}}{{bold}}Summarizing 1 Failure:{{/}}\"))\n\t\t}\n\t\tfor _, specReport := range failures {\n\t\t\thighlightColor, heading := \"{{red}}\", \"[FAIL]\"\n\t\t\tswitch specReport.State {\n\t\t\tcase types.SpecStatePanicked:\n\t\t\t\thighlightColor, heading = \"{{magenta}}\", \"[PANICKED!]\"\n\t\t\tcase types.SpecStateAborted:\n\t\t\t\thighlightColor, heading = \"{{coral}}\", \"[ABORTED]\"\n\t\t\tcase types.SpecStateTimedout:\n\t\t\t\thighlightColor, heading = \"{{orange}}\", \"[TIMEDOUT]\"\n\t\t\tcase types.SpecStateInterrupted:\n\t\t\t\thighlightColor, heading = \"{{orange}}\", \"[INTERRUPTED]\"\n\t\t\t}\n\t\t\tlocationBlock := r.codeLocationBlock(specReport, highlightColor, false, true)\n\t\t\tr.emitBlock(r.fi(1, highlightColor+\"%s{{/}} %s\", heading, locationBlock))\n\t\t}\n\t}\n\n\t//summarize the suite\n\tif r.conf.Verbosity().Is(types.VerbosityLevelSuccinct) && report.SuiteSucceeded {\n\t\tr.emit(r.f(\" {{green}}SUCCESS!{{/}} %s \", report.RunTime))\n\t\treturn\n\t}\n\n\tr.emitBlock(\"\\n\")\n\tcolor, status := \"{{green}}{{bold}}\", \"SUCCESS!\"\n\tif !report.SuiteSucceeded {\n\t\tcolor, status = \"{{red}}{{bold}}\", \"FAIL!\"\n\t}\n\n\tspecs := report.SpecReports.WithLeafNodeType(types.NodeTypeIt) //exclude any suite setup nodes\n\tr.emitBlock(r.f(color+\"Ran %d of %d Specs in %.3f seconds{{/}}\",\n\t\tspecs.CountWithState(types.SpecStatePassed)+specs.CountWithState(types.SpecStateFailureStates),\n\t\treport.PreRunStats.TotalSpecs,\n\t\treport.RunTime.Seconds()),\n\t)\n\n\tswitch len(report.SpecialSuiteFailureReasons) {\n\tcase 0:\n\t\tr.emit(r.f(color+\"%s{{/}} -- \", status))\n\tcase 1:\n\t\tr.emit(r.f(color+\"%s - %s{{/}} -- \", status, report.SpecialSuiteFailureReasons[0]))\n\tdefault:\n\t\tr.emitBlock(r.f(color+\"%s - %s{{/}}\\n\", status, strings.Join(report.SpecialSuiteFailureReasons, \", \")))\n\t}\n\n\tif len(specs) == 0 && report.SpecReports.WithLeafNodeType(types.NodeTypeBeforeSuite|types.NodeTypeSynchronizedBeforeSuite).CountWithState(types.SpecStateFailureStates) > 0 {\n\t\tr.emit(r.f(\"{{cyan}}{{bold}}A BeforeSuite node failed so all tests were skipped.{{/}}\\n\"))\n\t} else {\n\t\tr.emit(r.f(\"{{green}}{{bold}}%d Passed{{/}} | \", specs.CountWithState(types.SpecStatePassed)))\n\t\tr.emit(r.f(\"{{red}}{{bold}}%d Failed{{/}} | \", specs.CountWithState(types.SpecStateFailureStates)))\n\t\tif specs.CountOfFlakedSpecs() > 0 {\n\t\t\tr.emit(r.f(\"{{light-yellow}}{{bold}}%d Flaked{{/}} | \", specs.CountOfFlakedSpecs()))\n\t\t}\n\t\tif specs.CountOfRepeatedSpecs() > 0 {\n\t\t\tr.emit(r.f(\"{{light-yellow}}{{bold}}%d Repeated{{/}} | \", specs.CountOfRepeatedSpecs()))\n\t\t}\n\t\tr.emit(r.f(\"{{yellow}}{{bold}}%d Pending{{/}} | \", specs.CountWithState(types.SpecStatePending)))\n\t\tr.emit(r.f(\"{{cyan}}{{bold}}%d Skipped{{/}}\\n\", specs.CountWithState(types.SpecStateSkipped)))\n\t}\n}\n\nfunc (r *DefaultReporter) WillRun(report types.SpecReport) {\n\tv := r.conf.Verbosity()\n\tif v.LT(types.VerbosityLevelVerbose) || report.State.Is(types.SpecStatePending|types.SpecStateSkipped) || report.RunningInParallel {\n\t\treturn\n\t}\n\n\tr.emitDelimiter(0)\n\tr.emitBlock(r.f(r.codeLocationBlock(report, \"{{/}}\", v.Is(types.VerbosityLevelVeryVerbose), false)))\n}\n\nfunc (r *DefaultReporter) wrapTextBlock(sectionName string, fn func()) {\n\tr.emitBlock(\"\\n\")\n\tif r.conf.GithubOutput {\n\t\tr.emitBlock(r.fi(1, \"::group::%s\", sectionName))\n\t} else {\n\t\tr.emitBlock(r.fi(1, \"{{gray}}%s >>{{/}}\", sectionName))\n\t}\n\tfn()\n\tif r.conf.GithubOutput {\n\t\tr.emitBlock(r.fi(1, \"::endgroup::\"))\n\t} else {\n\t\tr.emitBlock(r.fi(1, \"{{gray}}<< %s{{/}}\", sectionName))\n\t}\n\n}\n\nfunc (r *DefaultReporter) DidRun(report types.SpecReport) {\n\tv := r.conf.Verbosity()\n\tinParallel := report.RunningInParallel\n\n\t//should we completely omit this spec?\n\tif report.State.Is(types.SpecStateSkipped) && r.conf.SilenceSkips {\n\t\treturn\n\t}\n\n\theader := r.specDenoter\n\tif report.LeafNodeType.Is(types.NodeTypesForSuiteLevelNodes) {\n\t\theader = fmt.Sprintf(\"[%s]\", report.LeafNodeType)\n\t}\n\thighlightColor := r.highlightColorForState(report.State)\n\n\t// have we already been streaming the timeline?\n\ttimelineHasBeenStreaming := v.GTE(types.VerbosityLevelVerbose) && !inParallel\n\n\t// should we show the timeline?\n\tvar timeline types.Timeline\n\tshowTimeline := !timelineHasBeenStreaming && (v.GTE(types.VerbosityLevelVerbose) || report.Failed())\n\tif showTimeline {\n\t\ttimeline = report.Timeline().WithoutHiddenReportEntries()\n\t\tkeepVeryVerboseSpecEvents := v.Is(types.VerbosityLevelVeryVerbose) ||\n\t\t\t(v.Is(types.VerbosityLevelVerbose) && r.conf.ShowNodeEvents) ||\n\t\t\t(report.Failed() && r.conf.ShowNodeEvents)\n\t\tif !keepVeryVerboseSpecEvents {\n\t\t\ttimeline = timeline.WithoutVeryVerboseSpecEvents()\n\t\t}\n\t\tif len(timeline) == 0 && report.CapturedGinkgoWriterOutput == \"\" {\n\t\t\t// the timeline is completely empty - don't show it\n\t\t\tshowTimeline = false\n\t\t}\n\t\tif v.LT(types.VerbosityLevelVeryVerbose) && report.CapturedGinkgoWriterOutput == \"\" && len(timeline) > 0 {\n\t\t\t//if we aren't -vv and the timeline only has a single failure, don't show it as it will appear at the end of the report\n\t\t\tfailure, isFailure := timeline[0].(types.Failure)\n\t\t\tif isFailure && (len(timeline) == 1 || (len(timeline) == 2 && failure.AdditionalFailure != nil)) {\n\t\t\t\tshowTimeline = false\n\t\t\t}\n\t\t}\n\t}\n\n\t// should we have a separate section for always-visible reports?\n\tshowSeparateVisibilityAlwaysReportsSection := !timelineHasBeenStreaming && !showTimeline && report.ReportEntries.HasVisibility(types.ReportEntryVisibilityAlways)\n\n\t// should we have a separate section for captured stdout/stderr\n\tshowSeparateStdSection := inParallel && (report.CapturedStdOutErr != \"\")\n\n\t// given all that - do we have any actual content to show? or are we a single denoter in a stream?\n\treportHasContent := v.Is(types.VerbosityLevelVeryVerbose) || showTimeline || showSeparateVisibilityAlwaysReportsSection || showSeparateStdSection || report.Failed() || (v.Is(types.VerbosityLevelVerbose) && !report.State.Is(types.SpecStateSkipped))\n\n\t// should we show a runtime?\n\tincludeRuntime := !report.State.Is(types.SpecStateSkipped|types.SpecStatePending) || (report.State.Is(types.SpecStateSkipped) && report.Failure.Message != \"\")\n\n\t// should we show the codelocation block?\n\tshowCodeLocation := !timelineHasBeenStreaming || !report.State.Is(types.SpecStatePassed)\n\n\tswitch report.State {\n\tcase types.SpecStatePassed:\n\t\tif report.LeafNodeType.Is(types.NodeTypesForSuiteLevelNodes) && !reportHasContent {\n\t\t\treturn\n\t\t}\n\t\tif report.LeafNodeType.Is(types.NodeTypesForSuiteLevelNodes) {\n\t\t\theader = fmt.Sprintf(\"%s PASSED\", header)\n\t\t}\n\t\tif report.NumAttempts > 1 && report.MaxFlakeAttempts > 1 {\n\t\t\theader, reportHasContent = fmt.Sprintf(\"%s [FLAKEY TEST - TOOK %d ATTEMPTS TO PASS]\", r.retryDenoter, report.NumAttempts), true\n\t\t}\n\tcase types.SpecStatePending:\n\t\theader = \"P\"\n\t\tif v.GT(types.VerbosityLevelSuccinct) {\n\t\t\theader, reportHasContent = \"P [PENDING]\", true\n\t\t}\n\tcase types.SpecStateSkipped:\n\t\theader = \"S\"\n\t\tif v.Is(types.VerbosityLevelVeryVerbose) || (v.Is(types.VerbosityLevelVerbose) && report.Failure.Message != \"\") {\n\t\t\theader, reportHasContent = \"S [SKIPPED]\", true\n\t\t}\n\tdefault:\n\t\theader = fmt.Sprintf(\"%s [%s]\", header, r.humanReadableState(report.State))\n\t\tif report.MaxMustPassRepeatedly > 1 {\n\t\t\theader = fmt.Sprintf(\"%s DURING REPETITION #%d\", header, report.NumAttempts)\n\t\t}\n\t}\n\n\t// If we have no content to show, just emit the header and return\n\tif !reportHasContent {\n\t\tr.emit(r.f(highlightColor + header + \"{{/}}\"))\n\t\tif r.conf.ForceNewlines {\n\t\t\tr.emit(\"\\n\")\n\t\t}\n\t\treturn\n\t}\n\n\tif includeRuntime {\n\t\theader = r.f(\"%s [%.3f seconds]\", header, report.RunTime.Seconds())\n\t}\n\n\t// Emit header\n\tif !timelineHasBeenStreaming {\n\t\tr.emitDelimiter(0)\n\t}\n\tr.emitBlock(r.f(highlightColor + header + \"{{/}}\"))\n\tif showCodeLocation {\n\t\tr.emitBlock(r.codeLocationBlock(report, highlightColor, v.Is(types.VerbosityLevelVeryVerbose), false))\n\t}\n\n\t//Emit Stdout/Stderr Output\n\tif showSeparateStdSection {\n\t\tr.wrapTextBlock(\"Captured StdOut/StdErr Output\", func() {\n\t\t\tr.emitBlock(r.fi(1, \"%s\", report.CapturedStdOutErr))\n\t\t})\n\t}\n\n\tif showSeparateVisibilityAlwaysReportsSection {\n\t\tr.wrapTextBlock(\"Report Entries\", func() {\n\t\t\tfor _, entry := range report.ReportEntries.WithVisibility(types.ReportEntryVisibilityAlways) {\n\t\t\t\tr.emitReportEntry(1, entry)\n\t\t\t}\n\t\t})\n\t}\n\n\tif showTimeline {\n\t\tr.wrapTextBlock(\"Timeline\", func() {\n\t\t\tr.emitTimeline(1, report, timeline)\n\t\t})\n\t}\n\n\t// Emit Failure Message\n\tif !report.Failure.IsZero() && !v.Is(types.VerbosityLevelVeryVerbose) {\n\t\tr.emitBlock(\"\\n\")\n\t\tr.emitFailure(1, report.State, report.Failure, true)\n\t\tif len(report.AdditionalFailures) > 0 {\n\t\t\tr.emitBlock(r.fi(1, \"\\nThere were {{bold}}{{red}}additional failures{{/}} detected. To view them in detail run {{bold}}ginkgo -vv{{/}}\"))\n\t\t}\n\t}\n\n\tr.emitDelimiter(0)\n}\n\nfunc (r *DefaultReporter) highlightColorForState(state types.SpecState) string {\n\tswitch state {\n\tcase types.SpecStatePassed:\n\t\treturn \"{{green}}\"\n\tcase types.SpecStatePending:\n\t\treturn \"{{yellow}}\"\n\tcase types.SpecStateSkipped:\n\t\treturn \"{{cyan}}\"\n\tcase types.SpecStateFailed:\n\t\treturn \"{{red}}\"\n\tcase types.SpecStateTimedout:\n\t\treturn \"{{orange}}\"\n\tcase types.SpecStatePanicked:\n\t\treturn \"{{magenta}}\"\n\tcase types.SpecStateInterrupted:\n\t\treturn \"{{orange}}\"\n\tcase types.SpecStateAborted:\n\t\treturn \"{{coral}}\"\n\tdefault:\n\t\treturn \"{{gray}}\"\n\t}\n}\n\nfunc (r *DefaultReporter) humanReadableState(state types.SpecState) string {\n\treturn strings.ToUpper(state.String())\n}\n\nfunc (r *DefaultReporter) emitTimeline(indent uint, report types.SpecReport, timeline types.Timeline) {\n\tisVeryVerbose := r.conf.Verbosity().Is(types.VerbosityLevelVeryVerbose)\n\tgw := report.CapturedGinkgoWriterOutput\n\tcursor := 0\n\tfor _, entry := range timeline {\n\t\ttl := entry.GetTimelineLocation()\n\n\t\tend := tl.Offset\n\t\tif end > len(gw) {\n\t\t\tend = len(gw)\n\t\t}\n\t\tif end < cursor {\n\t\t\tend = cursor\n\t\t}\n\t\tif cursor < end && cursor <= len(gw) && end <= len(gw) {\n\t\t\tr.emit(r.fi(indent, \"%s\", gw[cursor:end]))\n\t\t\tcursor = end\n\t\t} else if cursor < len(gw) && end == len(gw) {\n\t\t\tr.emit(r.fi(indent, \"%s\", gw[cursor:]))\n\t\t\tcursor = len(gw)\n\t\t}\n\n\t\tswitch x := entry.(type) {\n\t\tcase types.Failure:\n\t\t\tif isVeryVerbose {\n\t\t\t\tr.emitFailure(indent, report.State, x, false)\n\t\t\t} else {\n\t\t\t\tr.emitShortFailure(indent, report.State, x)\n\t\t\t}\n\t\tcase types.AdditionalFailure:\n\t\t\tif isVeryVerbose {\n\t\t\t\tr.emitFailure(indent, x.State, x.Failure, true)\n\t\t\t} else {\n\t\t\t\tr.emitShortFailure(indent, x.State, x.Failure)\n\t\t\t}\n\t\tcase types.ReportEntry:\n\t\t\tr.emitReportEntry(indent, x)\n\t\tcase types.ProgressReport:\n\t\t\tr.emitProgressReport(indent, false, isVeryVerbose, x)\n\t\tcase types.SpecEvent:\n\t\t\tif isVeryVerbose || !x.IsOnlyVisibleAtVeryVerbose() || r.conf.ShowNodeEvents {\n\t\t\t\tr.emitSpecEvent(indent, x, isVeryVerbose)\n\t\t\t}\n\t\t}\n\t}\n\tif cursor < len(gw) {\n\t\tr.emit(r.fi(indent, \"%s\", gw[cursor:]))\n\t}\n}\n\nfunc (r *DefaultReporter) EmitFailure(state types.SpecState, failure types.Failure) {\n\tif r.conf.Verbosity().Is(types.VerbosityLevelVerbose) {\n\t\tr.emitShortFailure(1, state, failure)\n\t} else if r.conf.Verbosity().Is(types.VerbosityLevelVeryVerbose) {\n\t\tr.emitFailure(1, state, failure, true)\n\t}\n}\n\nfunc (r *DefaultReporter) emitShortFailure(indent uint, state types.SpecState, failure types.Failure) {\n\tr.emitBlock(r.fi(indent, r.highlightColorForState(state)+\"[%s]{{/}} in [%s] - %s {{gray}}@ %s{{/}}\",\n\t\tr.humanReadableState(state),\n\t\tfailure.FailureNodeType,\n\t\tfailure.Location,\n\t\tfailure.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT),\n\t))\n}\n\nfunc (r *DefaultReporter) emitFailure(indent uint, state types.SpecState, failure types.Failure, includeAdditionalFailure bool) {\n\thighlightColor := r.highlightColorForState(state)\n\tr.emitBlock(r.fi(indent, highlightColor+\"[%s] %s{{/}}\", r.humanReadableState(state), failure.Message))\n\tif r.conf.GithubOutput {\n\t\tlevel := \"error\"\n\t\tif state.Is(types.SpecStateSkipped) {\n\t\t\tlevel = \"notice\"\n\t\t}\n\t\tr.emitBlock(r.fi(indent, \"::%s file=%s,line=%d::%s %s\", level, failure.Location.FileName, failure.Location.LineNumber, failure.FailureNodeType, failure.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT)))\n\t} else {\n\t\tr.emitBlock(r.fi(indent, highlightColor+\"In {{bold}}[%s]{{/}}\"+highlightColor+\" at: {{bold}}%s{{/}} {{gray}}@ %s{{/}}\\n\", failure.FailureNodeType, failure.Location, failure.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT)))\n\t}\n\tif failure.ForwardedPanic != \"\" {\n\t\tr.emitBlock(\"\\n\")\n\t\tr.emitBlock(r.fi(indent, highlightColor+\"%s{{/}}\", failure.ForwardedPanic))\n\t}\n\n\tif r.conf.FullTrace || failure.ForwardedPanic != \"\" {\n\t\tr.emitBlock(\"\\n\")\n\t\tr.emitBlock(r.fi(indent, highlightColor+\"Full Stack Trace{{/}}\"))\n\t\tr.emitBlock(r.fi(indent+1, \"%s\", failure.Location.FullStackTrace))\n\t}\n\n\tif !failure.ProgressReport.IsZero() {\n\t\tr.emitBlock(\"\\n\")\n\t\tr.emitProgressReport(indent, false, false, failure.ProgressReport)\n\t}\n\n\tif failure.AdditionalFailure != nil && includeAdditionalFailure {\n\t\tr.emitBlock(\"\\n\")\n\t\tr.emitFailure(indent, failure.AdditionalFailure.State, failure.AdditionalFailure.Failure, true)\n\t}\n}\n\nfunc (r *DefaultReporter) EmitProgressReport(report types.ProgressReport) {\n\tr.emitDelimiter(1)\n\n\tif report.RunningInParallel {\n\t\tr.emit(r.fi(1, \"{{coral}}Progress Report for Ginkgo Process #{{bold}}%d{{/}}\\n\", report.ParallelProcess))\n\t}\n\tshouldEmitGW := report.RunningInParallel || r.conf.Verbosity().LT(types.VerbosityLevelVerbose)\n\tr.emitProgressReport(1, shouldEmitGW, true, report)\n\tr.emitDelimiter(1)\n}\n\nfunc (r *DefaultReporter) emitProgressReport(indent uint, emitGinkgoWriterOutput, emitGroup bool, report types.ProgressReport) {\n\tif report.Message != \"\" {\n\t\tr.emitBlock(r.fi(indent, report.Message+\"\\n\"))\n\t\tindent += 1\n\t}\n\tif report.LeafNodeText != \"\" {\n\t\tsubjectIndent := indent\n\t\tif len(report.ContainerHierarchyTexts) > 0 {\n\t\t\tr.emit(r.fi(indent, r.cycleJoin(report.ContainerHierarchyTexts, \" \")))\n\t\t\tr.emit(\" \")\n\t\t\tsubjectIndent = 0\n\t\t}\n\t\tr.emit(r.fi(subjectIndent, \"{{bold}}{{orange}}%s{{/}} (Spec Runtime: %s)\\n\", report.LeafNodeText, report.Time().Sub(report.SpecStartTime).Round(time.Millisecond)))\n\t\tr.emit(r.fi(indent+1, \"{{gray}}%s{{/}}\\n\", report.LeafNodeLocation))\n\t\tindent += 1\n\t}\n\tif report.CurrentNodeType != types.NodeTypeInvalid {\n\t\tr.emit(r.fi(indent, \"In {{bold}}{{orange}}[%s]{{/}}\", report.CurrentNodeType))\n\t\tif report.CurrentNodeText != \"\" && !report.CurrentNodeType.Is(types.NodeTypeIt) {\n\t\t\tr.emit(r.f(\" {{bold}}{{orange}}%s{{/}}\", report.CurrentNodeText))\n\t\t}\n\n\t\tr.emit(r.f(\" (Node Runtime: %s)\\n\", report.Time().Sub(report.CurrentNodeStartTime).Round(time.Millisecond)))\n\t\tr.emit(r.fi(indent+1, \"{{gray}}%s{{/}}\\n\", report.CurrentNodeLocation))\n\t\tindent += 1\n\t}\n\tif report.CurrentStepText != \"\" {\n\t\tr.emit(r.fi(indent, \"At {{bold}}{{orange}}[By Step] %s{{/}} (Step Runtime: %s)\\n\", report.CurrentStepText, report.Time().Sub(report.CurrentStepStartTime).Round(time.Millisecond)))\n\t\tr.emit(r.fi(indent+1, \"{{gray}}%s{{/}}\\n\", report.CurrentStepLocation))\n\t\tindent += 1\n\t}\n\n\tif indent > 0 {\n\t\tindent -= 1\n\t}\n\n\tif r.conf.GithubOutput && emitGroup {\n\t\tr.emitBlock(r.fi(indent, \"::group::Progress Report\"))\n\t}\n\n\tif emitGinkgoWriterOutput && report.CapturedGinkgoWriterOutput != \"\" {\n\t\tr.emit(\"\\n\")\n\t\tr.emitBlock(r.fi(indent, \"{{gray}}Begin Captured GinkgoWriter Output >>{{/}}\"))\n\t\tlimit, lines := 10, strings.Split(report.CapturedGinkgoWriterOutput, \"\\n\")\n\t\tif len(lines) <= limit {\n\t\t\tr.emitBlock(r.fi(indent+1, \"%s\", report.CapturedGinkgoWriterOutput))\n\t\t} else {\n\t\t\tr.emitBlock(r.fi(indent+1, \"{{gray}}...{{/}}\"))\n\t\t\tfor _, line := range lines[len(lines)-limit-1:] {\n\t\t\t\tr.emitBlock(r.fi(indent+1, \"%s\", line))\n\t\t\t}\n\t\t}\n\t\tr.emitBlock(r.fi(indent, \"{{gray}}<< End Captured GinkgoWriter Output{{/}}\"))\n\t}\n\n\tif !report.SpecGoroutine().IsZero() {\n\t\tr.emit(\"\\n\")\n\t\tr.emit(r.fi(indent, \"{{bold}}{{underline}}Spec Goroutine{{/}}\\n\"))\n\t\tr.emitGoroutines(indent, report.SpecGoroutine())\n\t}\n\n\tif len(report.AdditionalReports) > 0 {\n\t\tr.emit(\"\\n\")\n\t\tr.emitBlock(r.fi(indent, \"{{gray}}Begin Additional Progress Reports >>{{/}}\"))\n\t\tfor i, additionalReport := range report.AdditionalReports {\n\t\t\tr.emit(r.fi(indent+1, additionalReport))\n\t\t\tif i < len(report.AdditionalReports)-1 {\n\t\t\t\tr.emitBlock(r.fi(indent+1, \"{{gray}}%s{{/}}\", strings.Repeat(\"-\", 10)))\n\t\t\t}\n\t\t}\n\t\tr.emitBlock(r.fi(indent, \"{{gray}}<< End Additional Progress Reports{{/}}\"))\n\t}\n\n\thighlightedGoroutines := report.HighlightedGoroutines()\n\tif len(highlightedGoroutines) > 0 {\n\t\tr.emit(\"\\n\")\n\t\tr.emit(r.fi(indent, \"{{bold}}{{underline}}Goroutines of Interest{{/}}\\n\"))\n\t\tr.emitGoroutines(indent, highlightedGoroutines...)\n\t}\n\n\totherGoroutines := report.OtherGoroutines()\n\tif len(otherGoroutines) > 0 {\n\t\tr.emit(\"\\n\")\n\t\tr.emit(r.fi(indent, \"{{gray}}{{bold}}{{underline}}Other Goroutines{{/}}\\n\"))\n\t\tr.emitGoroutines(indent, otherGoroutines...)\n\t}\n\n\tif r.conf.GithubOutput && emitGroup {\n\t\tr.emitBlock(r.fi(indent, \"::endgroup::\"))\n\t}\n}\n\nfunc (r *DefaultReporter) EmitReportEntry(entry types.ReportEntry) {\n\tif r.conf.Verbosity().LT(types.VerbosityLevelVerbose) || entry.Visibility == types.ReportEntryVisibilityNever {\n\t\treturn\n\t}\n\tr.emitReportEntry(1, entry)\n}\n\nfunc (r *DefaultReporter) emitReportEntry(indent uint, entry types.ReportEntry) {\n\tr.emitBlock(r.fi(indent, \"{{bold}}\"+entry.Name+\"{{gray}} \"+fmt.Sprintf(\"- %s @ %s{{/}}\", entry.Location, entry.Time.Format(types.GINKGO_TIME_FORMAT))))\n\tif representation := entry.StringRepresentation(); representation != \"\" {\n\t\tr.emitBlock(r.fi(indent+1, representation))\n\t}\n}\n\nfunc (r *DefaultReporter) EmitSpecEvent(event types.SpecEvent) {\n\tv := r.conf.Verbosity()\n\tif v.Is(types.VerbosityLevelVeryVerbose) || (v.Is(types.VerbosityLevelVerbose) && (r.conf.ShowNodeEvents || !event.IsOnlyVisibleAtVeryVerbose())) {\n\t\tr.emitSpecEvent(1, event, r.conf.Verbosity().Is(types.VerbosityLevelVeryVerbose))\n\t}\n}\n\nfunc (r *DefaultReporter) emitSpecEvent(indent uint, event types.SpecEvent, includeLocation bool) {\n\tlocation := \"\"\n\tif includeLocation {\n\t\tlocation = fmt.Sprintf(\"- %s \", event.CodeLocation.String())\n\t}\n\tswitch event.SpecEventType {\n\tcase types.SpecEventInvalid:\n\t\treturn\n\tcase types.SpecEventByStart:\n\t\tr.emitBlock(r.fi(indent, \"{{bold}}STEP:{{/}} %s {{gray}}%s@ %s{{/}}\", event.Message, location, event.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT)))\n\tcase types.SpecEventByEnd:\n\t\tr.emitBlock(r.fi(indent, \"{{bold}}END STEP:{{/}} %s {{gray}}%s@ %s (%s){{/}}\", event.Message, location, event.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT), event.Duration.Round(time.Millisecond)))\n\tcase types.SpecEventNodeStart:\n\t\tr.emitBlock(r.fi(indent, \"> Enter {{bold}}[%s]{{/}} %s {{gray}}%s@ %s{{/}}\", event.NodeType.String(), event.Message, location, event.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT)))\n\tcase types.SpecEventNodeEnd:\n\t\tr.emitBlock(r.fi(indent, \"< Exit {{bold}}[%s]{{/}} %s {{gray}}%s@ %s (%s){{/}}\", event.NodeType.String(), event.Message, location, event.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT), event.Duration.Round(time.Millisecond)))\n\tcase types.SpecEventSpecRepeat:\n\t\tr.emitBlock(r.fi(indent, \"\\n{{bold}}Attempt #%d {{green}}Passed{{/}}{{bold}}. Repeating %s{{/}} {{gray}}@ %s{{/}}\\n\\n\", event.Attempt, r.retryDenoter, event.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT)))\n\tcase types.SpecEventSpecRetry:\n\t\tr.emitBlock(r.fi(indent, \"\\n{{bold}}Attempt #%d {{red}}Failed{{/}}{{bold}}. Retrying %s{{/}} {{gray}}@ %s{{/}}\\n\\n\", event.Attempt, r.retryDenoter, event.TimelineLocation.Time.Format(types.GINKGO_TIME_FORMAT)))\n\t}\n}\n\nfunc (r *DefaultReporter) emitGoroutines(indent uint, goroutines ...types.Goroutine) {\n\tfor idx, g := range goroutines {\n\t\tcolor := \"{{gray}}\"\n\t\tif g.HasHighlights() {\n\t\t\tcolor = \"{{orange}}\"\n\t\t}\n\t\tr.emit(r.fi(indent, color+\"goroutine %d [%s]{{/}}\\n\", g.ID, g.State))\n\t\tfor _, fc := range g.Stack {\n\t\t\tif fc.Highlight {\n\t\t\t\tr.emit(r.fi(indent, color+\"{{bold}}> %s{{/}}\\n\", fc.Function))\n\t\t\t\tr.emit(r.fi(indent+2, color+\"{{bold}}%s:%d{{/}}\\n\", fc.Filename, fc.Line))\n\t\t\t\tr.emitSource(indent+3, fc)\n\t\t\t} else {\n\t\t\t\tr.emit(r.fi(indent+1, \"{{gray}}%s{{/}}\\n\", fc.Function))\n\t\t\t\tr.emit(r.fi(indent+2, \"{{gray}}%s:%d{{/}}\\n\", fc.Filename, fc.Line))\n\t\t\t}\n\t\t}\n\n\t\tif idx+1 < len(goroutines) {\n\t\t\tr.emit(\"\\n\")\n\t\t}\n\t}\n}\n\nfunc (r *DefaultReporter) emitSource(indent uint, fc types.FunctionCall) {\n\tlines := fc.Source\n\tif len(lines) == 0 {\n\t\treturn\n\t}\n\n\tlTrim := 100000\n\tfor _, line := range lines {\n\t\tlTrimLine := len(line) - len(strings.TrimLeft(line, \" \\t\"))\n\t\tif lTrimLine < lTrim && len(line) > 0 {\n\t\t\tlTrim = lTrimLine\n\t\t}\n\t}\n\tif lTrim == 100000 {\n\t\tlTrim = 0\n\t}\n\n\tfor idx, line := range lines {\n\t\tif len(line) > lTrim {\n\t\t\tline = line[lTrim:]\n\t\t}\n\t\tif idx == fc.SourceHighlight {\n\t\t\tr.emit(r.fi(indent, \"{{bold}}{{orange}}> %s{{/}}\\n\", line))\n\t\t} else {\n\t\t\tr.emit(r.fi(indent, \"| %s\\n\", line))\n\t\t}\n\t}\n}\n\n/* Emitting to the writer */\nfunc (r *DefaultReporter) emit(s string) {\n\tr._emit(s, false, false)\n}\n\nfunc (r *DefaultReporter) emitBlock(s string) {\n\tr._emit(s, true, false)\n}\n\nfunc (r *DefaultReporter) emitDelimiter(indent uint) {\n\tr._emit(r.fi(indent, \"{{gray}}%s{{/}}\", strings.Repeat(\"-\", 30)), true, true)\n}\n\n// a bit ugly - but we're trying to minimize locking on this hot codepath\nfunc (r *DefaultReporter) _emit(s string, block bool, isDelimiter bool) {\n\tif len(s) == 0 {\n\t\treturn\n\t}\n\tr.lock.Lock()\n\tdefer r.lock.Unlock()\n\tif isDelimiter && r.lastEmissionWasDelimiter {\n\t\treturn\n\t}\n\tif block && !r.lastCharWasNewline {\n\t\tr.writer.Write([]byte(\"\\n\"))\n\t}\n\tr.lastCharWasNewline = (s[len(s)-1:] == \"\\n\")\n\tr.writer.Write([]byte(s))\n\tif block && !r.lastCharWasNewline {\n\t\tr.writer.Write([]byte(\"\\n\"))\n\t\tr.lastCharWasNewline = true\n\t}\n\tr.lastEmissionWasDelimiter = isDelimiter\n}\n\n/* Rendering text */\nfunc (r *DefaultReporter) f(format string, args ...any) string {\n\treturn r.formatter.F(format, args...)\n}\n\nfunc (r *DefaultReporter) fi(indentation uint, format string, args ...any) string {\n\treturn r.formatter.Fi(indentation, format, args...)\n}\n\nfunc (r *DefaultReporter) cycleJoin(elements []string, joiner string) string {\n\treturn r.formatter.CycleJoin(elements, joiner, []string{\"{{/}}\", \"{{gray}}\"})\n}\n\nfunc (r *DefaultReporter) codeLocationBlock(report types.SpecReport, highlightColor string, veryVerbose bool, usePreciseFailureLocation bool) string {\n\ttexts, locations, labels, semVerConstraints, componentSemVerConstraints := []string{}, []types.CodeLocation{}, [][]string{}, [][]string{}, []map[string][]string{}\n\ttexts = append(texts, report.ContainerHierarchyTexts...)\n\tlocations = append(locations, report.ContainerHierarchyLocations...)\n\tlabels = append(labels, report.ContainerHierarchyLabels...)\n\tsemVerConstraints = append(semVerConstraints, report.ContainerHierarchySemVerConstraints...)\n\tcomponentSemVerConstraints = append(componentSemVerConstraints, report.ContainerHierarchyComponentSemVerConstraints...)\n\n\tif report.LeafNodeType.Is(types.NodeTypesForSuiteLevelNodes) {\n\t\ttexts = append(texts, r.f(\"[%s] %s\", report.LeafNodeType, report.LeafNodeText))\n\t} else {\n\t\ttexts = append(texts, r.f(report.LeafNodeText))\n\t}\n\tlabels = append(labels, report.LeafNodeLabels)\n\tsemVerConstraints = append(semVerConstraints, report.LeafNodeSemVerConstraints)\n\tcomponentSemVerConstraints = append(componentSemVerConstraints, report.LeafNodeComponentSemVerConstraints)\n\tlocations = append(locations, report.LeafNodeLocation)\n\n\tfailureLocation := report.Failure.FailureNodeLocation\n\tif usePreciseFailureLocation {\n\t\tfailureLocation = report.Failure.Location\n\t}\n\n\thighlightIndex := -1\n\tswitch report.Failure.FailureNodeContext {\n\tcase types.FailureNodeAtTopLevel:\n\t\ttexts = append([]string{fmt.Sprintf(\"TOP-LEVEL [%s]\", report.Failure.FailureNodeType)}, texts...)\n\t\tlocations = append([]types.CodeLocation{failureLocation}, locations...)\n\t\tlabels = append([][]string{{}}, labels...)\n\t\tsemVerConstraints = append([][]string{{}}, semVerConstraints...)\n\t\tcomponentSemVerConstraints = append([]map[string][]string{{}}, componentSemVerConstraints...)\n\t\thighlightIndex = 0\n\tcase types.FailureNodeInContainer:\n\t\ti := report.Failure.FailureNodeContainerIndex\n\t\ttexts[i] = fmt.Sprintf(\"%s [%s]\", texts[i], report.Failure.FailureNodeType)\n\t\tlocations[i] = failureLocation\n\t\thighlightIndex = i\n\tcase types.FailureNodeIsLeafNode:\n\t\ti := len(texts) - 1\n\t\ttexts[i] = fmt.Sprintf(\"[%s] %s\", report.LeafNodeType, report.LeafNodeText)\n\t\tlocations[i] = failureLocation\n\t\thighlightIndex = i\n\tdefault:\n\t\t//there is no failure, so we highlight the leaf ndoe\n\t\thighlightIndex = len(texts) - 1\n\t}\n\n\tout := \"\"\n\tif veryVerbose {\n\t\tfor i := range texts {\n\t\t\tif i == highlightIndex {\n\t\t\t\tout += r.fi(uint(i), highlightColor+\"{{bold}}%s{{/}}\", texts[i])\n\t\t\t} else {\n\t\t\t\tout += r.fi(uint(i), \"%s\", texts[i])\n\t\t\t}\n\t\t\tif len(labels[i]) > 0 {\n\t\t\t\tout += r.f(\" {{coral}}[%s]{{/}}\", strings.Join(labels[i], \", \"))\n\t\t\t}\n\t\t\tif len(semVerConstraints[i]) > 0 {\n\t\t\t\tout += r.f(\" {{coral}}[%s]{{/}}\", strings.Join(semVerConstraints[i], \", \"))\n\t\t\t}\n\t\t\tif len(componentSemVerConstraints[i]) > 0 {\n\t\t\t\tout += r.f(\" {{coral}}[%s]{{/}}\", formatComponentSemVerConstraintsToString(componentSemVerConstraints[i]))\n\t\t\t}\n\t\t\tout += \"\\n\"\n\t\t\tout += r.fi(uint(i), \"{{gray}}%s{{/}}\\n\", locations[i])\n\t\t}\n\t} else {\n\t\tfor i := range texts {\n\t\t\tstyle := \"{{/}}\"\n\t\t\tif i%2 == 1 {\n\t\t\t\tstyle = \"{{gray}}\"\n\t\t\t}\n\t\t\tif i == highlightIndex {\n\t\t\t\tstyle = highlightColor + \"{{bold}}\"\n\t\t\t}\n\t\t\tout += r.f(style+\"%s\", texts[i])\n\t\t\tif i < len(texts)-1 {\n\t\t\t\tout += \" \"\n\t\t\t} else {\n\t\t\t\tout += r.f(\"{{/}}\")\n\t\t\t}\n\t\t}\n\t\tflattenedLabels := report.Labels()\n\t\tif len(flattenedLabels) > 0 {\n\t\t\tout += r.f(\" {{coral}}[%s]{{/}}\", strings.Join(flattenedLabels, \", \"))\n\t\t}\n\t\tflattenedSemVerConstraints := report.SemVerConstraints()\n\t\tif len(flattenedSemVerConstraints) > 0 {\n\t\t\tout += r.f(\" {{coral}}[%s]{{/}}\", strings.Join(flattenedSemVerConstraints, \", \"))\n\t\t}\n\t\tflattenedComponentSemVerConstraints := report.ComponentSemVerConstraints()\n\t\tif len(flattenedComponentSemVerConstraints) > 0 {\n\t\t\tout += r.f(\" {{coral}}[%s]{{/}}\", formatComponentSemVerConstraintsToString(flattenedComponentSemVerConstraints))\n\t\t}\n\t\tout += \"\\n\"\n\t\tif usePreciseFailureLocation {\n\t\t\tout += r.f(\"{{gray}}%s{{/}}\", failureLocation)\n\t\t} else {\n\t\t\tleafLocation := locations[len(locations)-1]\n\t\t\tif (report.Failure.FailureNodeLocation != types.CodeLocation{}) && (report.Failure.FailureNodeLocation != leafLocation) {\n\t\t\t\tout += r.fi(1, highlightColor+\"[%s]{{/}} {{gray}}%s{{/}}\\n\", report.Failure.FailureNodeType, report.Failure.FailureNodeLocation)\n\t\t\t\tout += r.fi(1, \"{{gray}}[%s] %s{{/}}\", report.LeafNodeType, leafLocation)\n\t\t\t} else {\n\t\t\t\tout += r.f(\"{{gray}}%s{{/}}\", leafLocation)\n\t\t\t}\n\t\t}\n\n\t}\n\treturn out\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/reporters/deprecated_reporter.go",
"content": "package reporters\n\nimport (\n\t\"github.com/onsi/ginkgo/v2/config\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n// Deprecated: DeprecatedReporter was how Ginkgo V1 provided support for CustomReporters\n// this has been removed in V2.\n// Please read the documentation at:\n// https://onsi.github.io/ginkgo/MIGRATING_TO_V2#removed-custom-reporters\n// for Ginkgo's new behavior and for a migration path.\ntype DeprecatedReporter interface {\n\tSuiteWillBegin(config config.GinkgoConfigType, summary *types.SuiteSummary)\n\tBeforeSuiteDidRun(setupSummary *types.SetupSummary)\n\tSpecWillRun(specSummary *types.SpecSummary)\n\tSpecDidComplete(specSummary *types.SpecSummary)\n\tAfterSuiteDidRun(setupSummary *types.SetupSummary)\n\tSuiteDidEnd(summary *types.SuiteSummary)\n}\n\n// ReportViaDeprecatedReporter takes a V1 custom reporter and a V2 report and\n// calls the custom reporter's methods with appropriately transformed data from the V2 report.\n//\n// ReportViaDeprecatedReporter should be called in a `ReportAfterSuite()`\n//\n// Deprecated: ReportViaDeprecatedReporter method exists to help developer bridge between deprecated V1 functionality and the new\n// reporting support in V2. It will be removed in a future minor version of Ginkgo.\nfunc ReportViaDeprecatedReporter(reporter DeprecatedReporter, report types.Report) {\n\tconf := config.DeprecatedGinkgoConfigType{\n\t\tRandomSeed: report.SuiteConfig.RandomSeed,\n\t\tRandomizeAllSpecs: report.SuiteConfig.RandomizeAllSpecs,\n\t\tFocusStrings: report.SuiteConfig.FocusStrings,\n\t\tSkipStrings: report.SuiteConfig.SkipStrings,\n\t\tFailOnPending: report.SuiteConfig.FailOnPending,\n\t\tFailFast: report.SuiteConfig.FailFast,\n\t\tFlakeAttempts: report.SuiteConfig.FlakeAttempts,\n\t\tEmitSpecProgress: false,\n\t\tDryRun: report.SuiteConfig.DryRun,\n\t\tParallelNode: report.SuiteConfig.ParallelProcess,\n\t\tParallelTotal: report.SuiteConfig.ParallelTotal,\n\t\tSyncHost: report.SuiteConfig.ParallelHost,\n\t\tStreamHost: report.SuiteConfig.ParallelHost,\n\t}\n\n\tsummary := &types.DeprecatedSuiteSummary{\n\t\tSuiteDescription: report.SuiteDescription,\n\t\tSuiteID: report.SuitePath,\n\n\t\tNumberOfSpecsBeforeParallelization: report.PreRunStats.TotalSpecs,\n\t\tNumberOfTotalSpecs: report.PreRunStats.TotalSpecs,\n\t\tNumberOfSpecsThatWillBeRun: report.PreRunStats.SpecsThatWillRun,\n\t}\n\n\treporter.SuiteWillBegin(conf, summary)\n\n\tfor _, spec := range report.SpecReports {\n\t\tswitch spec.LeafNodeType {\n\t\tcase types.NodeTypeBeforeSuite, types.NodeTypeSynchronizedBeforeSuite:\n\t\t\tsetupSummary := &types.DeprecatedSetupSummary{\n\t\t\t\tComponentType: spec.LeafNodeType,\n\t\t\t\tCodeLocation: spec.LeafNodeLocation,\n\t\t\t\tState: spec.State,\n\t\t\t\tRunTime: spec.RunTime,\n\t\t\t\tFailure: failureFor(spec),\n\t\t\t\tCapturedOutput: spec.CombinedOutput(),\n\t\t\t\tSuiteID: report.SuitePath,\n\t\t\t}\n\t\t\treporter.BeforeSuiteDidRun(setupSummary)\n\t\tcase types.NodeTypeAfterSuite, types.NodeTypeSynchronizedAfterSuite:\n\t\t\tsetupSummary := &types.DeprecatedSetupSummary{\n\t\t\t\tComponentType: spec.LeafNodeType,\n\t\t\t\tCodeLocation: spec.LeafNodeLocation,\n\t\t\t\tState: spec.State,\n\t\t\t\tRunTime: spec.RunTime,\n\t\t\t\tFailure: failureFor(spec),\n\t\t\t\tCapturedOutput: spec.CombinedOutput(),\n\t\t\t\tSuiteID: report.SuitePath,\n\t\t\t}\n\t\t\treporter.AfterSuiteDidRun(setupSummary)\n\t\tcase types.NodeTypeIt:\n\t\t\tcomponentTexts, componentCodeLocations := []string{}, []types.CodeLocation{}\n\t\t\tcomponentTexts = append(componentTexts, spec.ContainerHierarchyTexts...)\n\t\t\tcomponentCodeLocations = append(componentCodeLocations, spec.ContainerHierarchyLocations...)\n\t\t\tcomponentTexts = append(componentTexts, spec.LeafNodeText)\n\t\t\tcomponentCodeLocations = append(componentCodeLocations, spec.LeafNodeLocation)\n\n\t\t\tspecSummary := &types.DeprecatedSpecSummary{\n\t\t\t\tComponentTexts: componentTexts,\n\t\t\t\tComponentCodeLocations: componentCodeLocations,\n\t\t\t\tState: spec.State,\n\t\t\t\tRunTime: spec.RunTime,\n\t\t\t\tFailure: failureFor(spec),\n\t\t\t\tNumberOfSamples: spec.NumAttempts,\n\t\t\t\tCapturedOutput: spec.CombinedOutput(),\n\t\t\t\tSuiteID: report.SuitePath,\n\t\t\t}\n\t\t\treporter.SpecWillRun(specSummary)\n\t\t\treporter.SpecDidComplete(specSummary)\n\n\t\t\tswitch spec.State {\n\t\t\tcase types.SpecStatePending:\n\t\t\t\tsummary.NumberOfPendingSpecs += 1\n\t\t\tcase types.SpecStateSkipped:\n\t\t\t\tsummary.NumberOfSkippedSpecs += 1\n\t\t\tcase types.SpecStateFailed, types.SpecStatePanicked, types.SpecStateInterrupted:\n\t\t\t\tsummary.NumberOfFailedSpecs += 1\n\t\t\tcase types.SpecStatePassed:\n\t\t\t\tsummary.NumberOfPassedSpecs += 1\n\t\t\t\tif spec.NumAttempts > 1 {\n\t\t\t\t\tsummary.NumberOfFlakedSpecs += 1\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tsummary.SuiteSucceeded = report.SuiteSucceeded\n\tsummary.RunTime = report.RunTime\n\n\treporter.SuiteDidEnd(summary)\n}\n\nfunc failureFor(spec types.SpecReport) types.DeprecatedSpecFailure {\n\tif spec.Failure.IsZero() {\n\t\treturn types.DeprecatedSpecFailure{}\n\t}\n\n\tindex := 0\n\tswitch spec.Failure.FailureNodeContext {\n\tcase types.FailureNodeInContainer:\n\t\tindex = spec.Failure.FailureNodeContainerIndex\n\tcase types.FailureNodeAtTopLevel:\n\t\tindex = -1\n\tcase types.FailureNodeIsLeafNode:\n\t\tindex = len(spec.ContainerHierarchyTexts) - 1\n\t\tif spec.LeafNodeText != \"\" {\n\t\t\tindex += 1\n\t\t}\n\t}\n\n\treturn types.DeprecatedSpecFailure{\n\t\tMessage: spec.Failure.Message,\n\t\tLocation: spec.Failure.Location,\n\t\tForwardedPanic: spec.Failure.ForwardedPanic,\n\t\tComponentIndex: index,\n\t\tComponentType: spec.Failure.FailureNodeType,\n\t\tComponentCodeLocation: spec.Failure.FailureNodeLocation,\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/reporters/gojson_report.go",
"content": "package reporters\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"path\"\n\n\t\"github.com/onsi/ginkgo/v2/internal/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n// GenerateGoTestJSONReport produces a JSON-formatted in the test2json format used by `go test -json`\nfunc GenerateGoTestJSONReport(report types.Report, destination string) error {\n\t// walk report and generate test2json-compatible objects\n\t// JSON-encode the objects into filename\n\tif err := os.MkdirAll(path.Dir(destination), 0770); err != nil {\n\t\treturn err\n\t}\n\tf, err := os.Create(destination)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer f.Close()\n\tenc := json.NewEncoder(f)\n\tr := reporters.NewGoJSONReporter(\n\t\tenc,\n\t\tsystemErrForUnstructuredReporters,\n\t\tsystemOutForUnstructuredReporters,\n\t)\n\treturn r.Write(report)\n}\n\n// MergeJSONReports produces a single JSON-formatted report at the passed in destination by merging the JSON-formatted reports provided in sources\n// It skips over reports that fail to decode but reports on them via the returned messages []string\nfunc MergeAndCleanupGoTestJSONReports(sources []string, destination string) ([]string, error) {\n\tmessages := []string{}\n\tif err := os.MkdirAll(path.Dir(destination), 0770); err != nil {\n\t\treturn messages, err\n\t}\n\tf, err := os.Create(destination)\n\tif err != nil {\n\t\treturn messages, err\n\t}\n\tdefer f.Close()\n\n\tfor _, source := range sources {\n\t\tdata, err := os.ReadFile(source)\n\t\tif err != nil {\n\t\t\tmessages = append(messages, fmt.Sprintf(\"Could not open %s:\\n%s\", source, err.Error()))\n\t\t\tcontinue\n\t\t}\n\t\t_, err = f.Write(data)\n\t\tif err != nil {\n\t\t\tmessages = append(messages, fmt.Sprintf(\"Could not write to %s:\\n%s\", destination, err.Error()))\n\t\t\tcontinue\n\t\t}\n\t\tos.Remove(source)\n\t}\n\treturn messages, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/reporters/json_report.go",
"content": "package reporters\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"path\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n// GenerateJSONReport produces a JSON-formatted report at the passed in destination\nfunc GenerateJSONReport(report types.Report, destination string) error {\n\tif err := os.MkdirAll(path.Dir(destination), 0770); err != nil {\n\t\treturn err\n\t}\n\tf, err := os.Create(destination)\n\tif err != nil {\n\t\treturn err\n\t}\n\tdefer f.Close()\n\tenc := json.NewEncoder(f)\n\tenc.SetIndent(\"\", \" \")\n\terr = enc.Encode([]types.Report{\n\t\treport,\n\t})\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\n// MergeJSONReports produces a single JSON-formatted report at the passed in destination by merging the JSON-formatted reports provided in sources\n// It skips over reports that fail to decode but reports on them via the returned messages []string\nfunc MergeAndCleanupJSONReports(sources []string, destination string) ([]string, error) {\n\tmessages := []string{}\n\tallReports := []types.Report{}\n\tfor _, source := range sources {\n\t\treports := []types.Report{}\n\t\tdata, err := os.ReadFile(source)\n\t\tif err != nil {\n\t\t\tmessages = append(messages, fmt.Sprintf(\"Could not open %s:\\n%s\", source, err.Error()))\n\t\t\tcontinue\n\t\t}\n\t\terr = json.Unmarshal(data, &reports)\n\t\tif err != nil {\n\t\t\tmessages = append(messages, fmt.Sprintf(\"Could not decode %s:\\n%s\", source, err.Error()))\n\t\t\tcontinue\n\t\t}\n\t\tos.Remove(source)\n\t\tallReports = append(allReports, reports...)\n\t}\n\n\tif err := os.MkdirAll(path.Dir(destination), 0770); err != nil {\n\t\treturn messages, err\n\t}\n\tf, err := os.Create(destination)\n\tif err != nil {\n\t\treturn messages, err\n\t}\n\tdefer f.Close()\n\tenc := json.NewEncoder(f)\n\tenc.SetIndent(\"\", \" \")\n\terr = enc.Encode(allReports)\n\tif err != nil {\n\t\treturn messages, err\n\t}\n\treturn messages, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/reporters/junit_report.go",
"content": "/*\n\nJUnit XML Reporter for Ginkgo\n\nFor usage instructions: http://onsi.github.io/ginkgo/#generating_junit_xml_output\n\nThe schema used for the generated JUnit xml file was adapted from https://llg.cubic.org/docs/junit/\n\n*/\n\npackage reporters\n\nimport (\n\t\"encoding/xml\"\n\t\"fmt\"\n\t\"maps\"\n\t\"os\"\n\t\"path\"\n\t\"regexp\"\n\t\"slices\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/config\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype JunitReportConfig struct {\n\t// Spec States for which no timeline should be emitted for system-err\n\t// set this to types.SpecStatePassed|types.SpecStateSkipped|types.SpecStatePending to only match failing specs\n\tOmitTimelinesForSpecState types.SpecState\n\n\t// Enable OmitFailureMessageAttr to prevent failure messages appearing in the \"message\" attribute of the Failure and Error tags\n\tOmitFailureMessageAttr bool\n\n\t//Enable OmitCapturedStdOutErr to prevent captured stdout/stderr appearing in system-out\n\tOmitCapturedStdOutErr bool\n\n\t// Enable OmitSpecLabels to prevent labels from appearing in the spec name\n\tOmitSpecLabels bool\n\n\t// Enable OmitSpecSemVerConstraints to prevent semantic version constraints from appearing in the spec name\n\tOmitSpecSemVerConstraints bool\n\n\t// Enable OmitSpecComponentSemVerConstraints to prevent component semantic version constraints from appearing in the spec name\n\tOmitSpecComponentSemVerConstraints bool\n\n\t// Enable OmitLeafNodeType to prevent the spec leaf node type from appearing in the spec name\n\tOmitLeafNodeType bool\n\n\t// Enable OmitSuiteSetupNodes to prevent the creation of testcase entries for setup nodes\n\tOmitSuiteSetupNodes bool\n}\n\ntype JUnitTestSuites struct {\n\tXMLName xml.Name `xml:\"testsuites\"`\n\t// Tests maps onto the total number of specs in all test suites (this includes any suite nodes such as BeforeSuite)\n\tTests int `xml:\"tests,attr\"`\n\t// Disabled maps onto specs that are pending and/or skipped\n\tDisabled int `xml:\"disabled,attr\"`\n\t// Errors maps onto specs that panicked or were interrupted\n\tErrors int `xml:\"errors,attr\"`\n\t// Failures maps onto specs that failed\n\tFailures int `xml:\"failures,attr\"`\n\t// Time is the time in seconds to execute all test suites\n\tTime float64 `xml:\"time,attr\"`\n\n\t//The set of all test suites\n\tTestSuites []JUnitTestSuite `xml:\"testsuite\"`\n}\n\ntype JUnitTestSuite struct {\n\t// Name maps onto the description of the test suite - maps onto Report.SuiteDescription\n\tName string `xml:\"name,attr\"`\n\t// Package maps onto the absolute path to the test suite - maps onto Report.SuitePath\n\tPackage string `xml:\"package,attr\"`\n\t// Tests maps onto the total number of specs in the test suite (this includes any suite nodes such as BeforeSuite)\n\tTests int `xml:\"tests,attr\"`\n\t// Disabled maps onto specs that are pending\n\tDisabled int `xml:\"disabled,attr\"`\n\t// Skiped maps onto specs that are skipped\n\tSkipped int `xml:\"skipped,attr\"`\n\t// Errors maps onto specs that panicked or were interrupted\n\tErrors int `xml:\"errors,attr\"`\n\t// Failures maps onto specs that failed\n\tFailures int `xml:\"failures,attr\"`\n\t// Time is the time in seconds to execute all the test suite - maps onto Report.RunTime\n\tTime float64 `xml:\"time,attr\"`\n\t// Timestamp is the ISO 8601 formatted start-time of the suite - maps onto Report.StartTime\n\tTimestamp string `xml:\"timestamp,attr\"`\n\n\t//Properties captures the information stored in the rest of the Report type (including SuiteConfig) as key-value pairs\n\tProperties JUnitProperties `xml:\"properties\"`\n\n\t//TestCases capture the individual specs\n\tTestCases []JUnitTestCase `xml:\"testcase\"`\n}\n\ntype JUnitProperties struct {\n\tProperties []JUnitProperty `xml:\"property\"`\n}\n\nfunc (jup JUnitProperties) WithName(name string) string {\n\tfor _, property := range jup.Properties {\n\t\tif property.Name == name {\n\t\t\treturn property.Value\n\t\t}\n\t}\n\treturn \"\"\n}\n\ntype JUnitProperty struct {\n\tName string `xml:\"name,attr\"`\n\tValue string `xml:\"value,attr\"`\n}\n\nvar ownerRE = regexp.MustCompile(`(?i)^owner:(.*)$`)\n\ntype JUnitTestCase struct {\n\t// Name maps onto the full text of the spec - equivalent to \"[SpecReport.LeafNodeType] SpecReport.FullText()\"\n\tName string `xml:\"name,attr\"`\n\t// Classname maps onto the name of the test suite - equivalent to Report.SuiteDescription\n\tClassname string `xml:\"classname,attr\"`\n\t// Status maps onto the string representation of SpecReport.State\n\tStatus string `xml:\"status,attr\"`\n\t// Time is the time in seconds to execute the spec - maps onto SpecReport.RunTime\n\tTime float64 `xml:\"time,attr\"`\n\t// Owner is the owner the spec - is set if a label matching Label(\"owner:X\") is provided. The last matching label is used as the owner, thereby allowing specs to override owners specified in container nodes.\n\tOwner string `xml:\"owner,attr,omitempty\"`\n\t//Skipped is populated with a message if the test was skipped or pending\n\tSkipped *JUnitSkipped `xml:\"skipped,omitempty\"`\n\t//Error is populated if the test panicked or was interrupted\n\tError *JUnitError `xml:\"error,omitempty\"`\n\t//Failure is populated if the test failed\n\tFailure *JUnitFailure `xml:\"failure,omitempty\"`\n\t//SystemOut maps onto any captured stdout/stderr output - maps onto SpecReport.CapturedStdOutErr\n\tSystemOut string `xml:\"system-out,omitempty\"`\n\t//SystemOut maps onto any captured GinkgoWriter output - maps onto SpecReport.CapturedGinkgoWriterOutput\n\tSystemErr string `xml:\"system-err,omitempty\"`\n}\n\ntype JUnitSkipped struct {\n\t// Message maps onto \"pending\" if the test was marked pending, \"skipped\" if the test was marked skipped, and \"skipped - REASON\" if the user called Skip(REASON)\n\tMessage string `xml:\"message,attr\"`\n}\n\ntype JUnitError struct {\n\t//Message maps onto the panic/exception thrown - equivalent to SpecReport.Failure.ForwardedPanic - or to \"interrupted\"\n\tMessage string `xml:\"message,attr\"`\n\t//Type is one of \"panicked\" or \"interrupted\"\n\tType string `xml:\"type,attr\"`\n\t//Description maps onto the captured stack trace for a panic, or the failure message for an interrupt which will include the dump of running goroutines\n\tDescription string `xml:\",chardata\"`\n}\n\ntype JUnitFailure struct {\n\t//Message maps onto the failure message - equivalent to SpecReport.Failure.Message\n\tMessage string `xml:\"message,attr\"`\n\t//Type is \"failed\"\n\tType string `xml:\"type,attr\"`\n\t//Description maps onto the location and stack trace of the failure\n\tDescription string `xml:\",chardata\"`\n}\n\nfunc GenerateJUnitReport(report types.Report, dst string) error {\n\treturn GenerateJUnitReportWithConfig(report, dst, JunitReportConfig{})\n}\n\nfunc GenerateJUnitReportWithConfig(report types.Report, dst string, config JunitReportConfig) error {\n\tsuite := JUnitTestSuite{\n\t\tName: report.SuiteDescription,\n\t\tPackage: report.SuitePath,\n\t\tTime: report.RunTime.Seconds(),\n\t\tTimestamp: report.StartTime.Format(\"2006-01-02T15:04:05\"),\n\t\tProperties: JUnitProperties{\n\t\t\tProperties: []JUnitProperty{\n\t\t\t\t{\"SuiteSucceeded\", fmt.Sprintf(\"%t\", report.SuiteSucceeded)},\n\t\t\t\t{\"SuiteHasProgrammaticFocus\", fmt.Sprintf(\"%t\", report.SuiteHasProgrammaticFocus)},\n\t\t\t\t{\"SpecialSuiteFailureReason\", strings.Join(report.SpecialSuiteFailureReasons, \",\")},\n\t\t\t\t{\"SuiteLabels\", fmt.Sprintf(\"[%s]\", strings.Join(report.SuiteLabels, \",\"))},\n\t\t\t\t{\"SuiteSemVerConstraints\", fmt.Sprintf(\"[%s]\", strings.Join(report.SuiteSemVerConstraints, \",\"))},\n\t\t\t\t{\"SuiteComponentSemVerConstraints\", fmt.Sprintf(\"[%s]\", formatComponentSemVerConstraintsToString(report.SuiteComponentSemVerConstraints))},\n\t\t\t\t{\"RandomSeed\", fmt.Sprintf(\"%d\", report.SuiteConfig.RandomSeed)},\n\t\t\t\t{\"RandomizeAllSpecs\", fmt.Sprintf(\"%t\", report.SuiteConfig.RandomizeAllSpecs)},\n\t\t\t\t{\"LabelFilter\", report.SuiteConfig.LabelFilter},\n\t\t\t\t{\"SemVerFilter\", report.SuiteConfig.SemVerFilter},\n\t\t\t\t{\"FocusStrings\", strings.Join(report.SuiteConfig.FocusStrings, \",\")},\n\t\t\t\t{\"SkipStrings\", strings.Join(report.SuiteConfig.SkipStrings, \",\")},\n\t\t\t\t{\"FocusFiles\", strings.Join(report.SuiteConfig.FocusFiles, \";\")},\n\t\t\t\t{\"SkipFiles\", strings.Join(report.SuiteConfig.SkipFiles, \";\")},\n\t\t\t\t{\"FailOnPending\", fmt.Sprintf(\"%t\", report.SuiteConfig.FailOnPending)},\n\t\t\t\t{\"FailOnEmpty\", fmt.Sprintf(\"%t\", report.SuiteConfig.FailOnEmpty)},\n\t\t\t\t{\"FailFast\", fmt.Sprintf(\"%t\", report.SuiteConfig.FailFast)},\n\t\t\t\t{\"FlakeAttempts\", fmt.Sprintf(\"%d\", report.SuiteConfig.FlakeAttempts)},\n\t\t\t\t{\"DryRun\", fmt.Sprintf(\"%t\", report.SuiteConfig.DryRun)},\n\t\t\t\t{\"ParallelTotal\", fmt.Sprintf(\"%d\", report.SuiteConfig.ParallelTotal)},\n\t\t\t\t{\"OutputInterceptorMode\", report.SuiteConfig.OutputInterceptorMode},\n\t\t\t},\n\t\t},\n\t}\n\tfor _, spec := range report.SpecReports {\n\t\tif config.OmitSuiteSetupNodes && spec.LeafNodeType != types.NodeTypeIt {\n\t\t\tcontinue\n\t\t}\n\t\tname := fmt.Sprintf(\"[%s]\", spec.LeafNodeType)\n\t\tif config.OmitLeafNodeType {\n\t\t\tname = \"\"\n\t\t}\n\t\tif spec.FullText() != \"\" {\n\t\t\tname = name + \" \" + spec.FullText()\n\t\t}\n\t\tlabels := spec.Labels()\n\t\tif len(labels) > 0 && !config.OmitSpecLabels {\n\t\t\tname = name + \" [\" + strings.Join(labels, \", \") + \"]\"\n\t\t}\n\t\towner := \"\"\n\t\tfor _, label := range labels {\n\t\t\tif matches := ownerRE.FindStringSubmatch(label); len(matches) == 2 {\n\t\t\t\towner = matches[1]\n\t\t\t}\n\t\t}\n\t\tsemVerConstraints := spec.SemVerConstraints()\n\t\tif len(semVerConstraints) > 0 && !config.OmitSpecSemVerConstraints {\n\t\t\tname = name + \" [\" + strings.Join(semVerConstraints, \", \") + \"]\"\n\t\t}\n\t\tcomponentSemVerConstraints := spec.ComponentSemVerConstraints()\n\t\tif len(componentSemVerConstraints) > 0 && !config.OmitSpecComponentSemVerConstraints {\n\t\t\tname = name + \" [\" + formatComponentSemVerConstraintsToString(componentSemVerConstraints) + \"]\"\n\t\t}\n\t\tname = strings.TrimSpace(name)\n\n\t\ttest := JUnitTestCase{\n\t\t\tName: name,\n\t\t\tClassname: report.SuiteDescription,\n\t\t\tStatus: spec.State.String(),\n\t\t\tTime: spec.RunTime.Seconds(),\n\t\t\tOwner: owner,\n\t\t}\n\t\tif !spec.State.Is(config.OmitTimelinesForSpecState) {\n\t\t\ttest.SystemErr = systemErrForUnstructuredReporters(spec)\n\t\t}\n\t\tif !config.OmitCapturedStdOutErr {\n\t\t\ttest.SystemOut = systemOutForUnstructuredReporters(spec)\n\t\t}\n\t\tsuite.Tests += 1\n\n\t\tswitch spec.State {\n\t\tcase types.SpecStateSkipped:\n\t\t\tmessage := \"skipped\"\n\t\t\tif spec.Failure.Message != \"\" {\n\t\t\t\tmessage += \" - \" + spec.Failure.Message\n\t\t\t}\n\t\t\ttest.Skipped = &JUnitSkipped{Message: message}\n\t\t\tsuite.Skipped += 1\n\t\tcase types.SpecStatePending:\n\t\t\ttest.Skipped = &JUnitSkipped{Message: \"pending\"}\n\t\t\tsuite.Disabled += 1\n\t\tcase types.SpecStateFailed:\n\t\t\ttest.Failure = &JUnitFailure{\n\t\t\t\tMessage: spec.Failure.Message,\n\t\t\t\tType: \"failed\",\n\t\t\t\tDescription: failureDescriptionForUnstructuredReporters(spec),\n\t\t\t}\n\t\t\tif config.OmitFailureMessageAttr {\n\t\t\t\ttest.Failure.Message = \"\"\n\t\t\t}\n\t\t\tsuite.Failures += 1\n\t\tcase types.SpecStateTimedout:\n\t\t\ttest.Failure = &JUnitFailure{\n\t\t\t\tMessage: spec.Failure.Message,\n\t\t\t\tType: \"timedout\",\n\t\t\t\tDescription: failureDescriptionForUnstructuredReporters(spec),\n\t\t\t}\n\t\t\tif config.OmitFailureMessageAttr {\n\t\t\t\ttest.Failure.Message = \"\"\n\t\t\t}\n\t\t\tsuite.Failures += 1\n\t\tcase types.SpecStateInterrupted:\n\t\t\ttest.Error = &JUnitError{\n\t\t\t\tMessage: spec.Failure.Message,\n\t\t\t\tType: \"interrupted\",\n\t\t\t\tDescription: failureDescriptionForUnstructuredReporters(spec),\n\t\t\t}\n\t\t\tif config.OmitFailureMessageAttr {\n\t\t\t\ttest.Error.Message = \"\"\n\t\t\t}\n\t\t\tsuite.Errors += 1\n\t\tcase types.SpecStateAborted:\n\t\t\ttest.Failure = &JUnitFailure{\n\t\t\t\tMessage: spec.Failure.Message,\n\t\t\t\tType: \"aborted\",\n\t\t\t\tDescription: failureDescriptionForUnstructuredReporters(spec),\n\t\t\t}\n\t\t\tif config.OmitFailureMessageAttr {\n\t\t\t\ttest.Failure.Message = \"\"\n\t\t\t}\n\t\t\tsuite.Errors += 1\n\t\tcase types.SpecStatePanicked:\n\t\t\ttest.Error = &JUnitError{\n\t\t\t\tMessage: spec.Failure.ForwardedPanic,\n\t\t\t\tType: \"panicked\",\n\t\t\t\tDescription: failureDescriptionForUnstructuredReporters(spec),\n\t\t\t}\n\t\t\tif config.OmitFailureMessageAttr {\n\t\t\t\ttest.Error.Message = \"\"\n\t\t\t}\n\t\t\tsuite.Errors += 1\n\t\t}\n\n\t\tsuite.TestCases = append(suite.TestCases, test)\n\t}\n\n\tjunitReport := JUnitTestSuites{\n\t\tTests: suite.Tests,\n\t\tDisabled: suite.Disabled + suite.Skipped,\n\t\tErrors: suite.Errors,\n\t\tFailures: suite.Failures,\n\t\tTime: suite.Time,\n\t\tTestSuites: []JUnitTestSuite{suite},\n\t}\n\n\tif err := os.MkdirAll(path.Dir(dst), 0770); err != nil {\n\t\treturn err\n\t}\n\tf, err := os.Create(dst)\n\tif err != nil {\n\t\treturn err\n\t}\n\tf.WriteString(xml.Header)\n\tencoder := xml.NewEncoder(f)\n\tencoder.Indent(\" \", \" \")\n\tencoder.Encode(junitReport)\n\n\treturn f.Close()\n}\n\nfunc MergeAndCleanupJUnitReports(sources []string, dst string) ([]string, error) {\n\tmessages := []string{}\n\tmergedReport := JUnitTestSuites{}\n\tfor _, source := range sources {\n\t\treport := JUnitTestSuites{}\n\t\tf, err := os.Open(source)\n\t\tif err != nil {\n\t\t\tmessages = append(messages, fmt.Sprintf(\"Could not open %s:\\n%s\", source, err.Error()))\n\t\t\tcontinue\n\t\t}\n\t\terr = xml.NewDecoder(f).Decode(&report)\n\t\t_ = f.Close()\n\t\tif err != nil {\n\t\t\tmessages = append(messages, fmt.Sprintf(\"Could not decode %s:\\n%s\", source, err.Error()))\n\t\t\tcontinue\n\t\t}\n\t\tos.Remove(source)\n\n\t\tmergedReport.Tests += report.Tests\n\t\tmergedReport.Disabled += report.Disabled\n\t\tmergedReport.Errors += report.Errors\n\t\tmergedReport.Failures += report.Failures\n\t\tmergedReport.Time += report.Time\n\t\tmergedReport.TestSuites = append(mergedReport.TestSuites, report.TestSuites...)\n\t}\n\n\tif err := os.MkdirAll(path.Dir(dst), 0770); err != nil {\n\t\treturn messages, err\n\t}\n\tf, err := os.Create(dst)\n\tif err != nil {\n\t\treturn messages, err\n\t}\n\tf.WriteString(xml.Header)\n\tencoder := xml.NewEncoder(f)\n\tencoder.Indent(\" \", \" \")\n\tencoder.Encode(mergedReport)\n\n\treturn messages, f.Close()\n}\n\nfunc failureDescriptionForUnstructuredReporters(spec types.SpecReport) string {\n\tout := &strings.Builder{}\n\tNewDefaultReporter(types.ReporterConfig{NoColor: true, VeryVerbose: true}, out).emitFailure(0, spec.State, spec.Failure, true)\n\tif len(spec.AdditionalFailures) > 0 {\n\t\tout.WriteString(\"\\nThere were additional failures detected after the initial failure. These are visible in the timeline\\n\")\n\t}\n\treturn out.String()\n}\n\nfunc systemErrForUnstructuredReporters(spec types.SpecReport) string {\n\treturn RenderTimeline(spec, true)\n}\n\nfunc RenderTimeline(spec types.SpecReport, noColor bool) string {\n\tout := &strings.Builder{}\n\tNewDefaultReporter(types.ReporterConfig{NoColor: noColor, VeryVerbose: true}, out).emitTimeline(0, spec, spec.Timeline())\n\treturn out.String()\n}\n\nfunc systemOutForUnstructuredReporters(spec types.SpecReport) string {\n\treturn spec.CapturedStdOutErr\n}\n\nfunc formatComponentSemVerConstraintsToString(componentSemVerConstraints map[string][]string) string {\n\tvar tmpStr string\n\tfor _, key := range slices.Sorted(maps.Keys(componentSemVerConstraints)) {\n\t\ttmpStr = tmpStr + fmt.Sprintf(\"%s: %s, \", key, componentSemVerConstraints[key])\n\t}\n\n\ttmpStr = strings.TrimSuffix(tmpStr, \", \")\n\treturn tmpStr\n}\n\n// Deprecated JUnitReporter (so folks can still compile their suites)\ntype JUnitReporter struct{}\n\nfunc NewJUnitReporter(_ string) *JUnitReporter { return &JUnitReporter{} }\nfunc (reporter *JUnitReporter) SuiteWillBegin(_ config.GinkgoConfigType, _ *types.SuiteSummary) {}\nfunc (reporter *JUnitReporter) BeforeSuiteDidRun(_ *types.SetupSummary) {}\nfunc (reporter *JUnitReporter) SpecWillRun(_ *types.SpecSummary) {}\nfunc (reporter *JUnitReporter) SpecDidComplete(_ *types.SpecSummary) {}\nfunc (reporter *JUnitReporter) AfterSuiteDidRun(_ *types.SetupSummary) {}\nfunc (reporter *JUnitReporter) SuiteDidEnd(_ *types.SuiteSummary) {}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/reporters/reporter.go",
"content": "package reporters\n\nimport (\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\ntype Reporter interface {\n\tSuiteWillBegin(report types.Report)\n\tWillRun(report types.SpecReport)\n\tDidRun(report types.SpecReport)\n\tSuiteDidEnd(report types.Report)\n\n\t//Timeline emission\n\tEmitFailure(state types.SpecState, failure types.Failure)\n\tEmitProgressReport(progressReport types.ProgressReport)\n\tEmitReportEntry(entry types.ReportEntry)\n\tEmitSpecEvent(event types.SpecEvent)\n}\n\ntype NoopReporter struct{}\n\nfunc (n NoopReporter) SuiteWillBegin(report types.Report) {}\nfunc (n NoopReporter) WillRun(report types.SpecReport) {}\nfunc (n NoopReporter) DidRun(report types.SpecReport) {}\nfunc (n NoopReporter) SuiteDidEnd(report types.Report) {}\nfunc (n NoopReporter) EmitFailure(state types.SpecState, failure types.Failure) {}\nfunc (n NoopReporter) EmitProgressReport(progressReport types.ProgressReport) {}\nfunc (n NoopReporter) EmitReportEntry(entry types.ReportEntry) {}\nfunc (n NoopReporter) EmitSpecEvent(event types.SpecEvent) {}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/reporters/teamcity_report.go",
"content": "/*\n\nTeamCity Reporter for Ginkgo\n\nMakes use of TeamCity's support for Service Messages\nhttp://confluence.jetbrains.com/display/TCD7/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ReportingTests\n*/\n\npackage reporters\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"path\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\nfunc tcEscape(s string) string {\n\ts = strings.ReplaceAll(s, \"|\", \"||\")\n\ts = strings.ReplaceAll(s, \"'\", \"|'\")\n\ts = strings.ReplaceAll(s, \"\\n\", \"|n\")\n\ts = strings.ReplaceAll(s, \"\\r\", \"|r\")\n\ts = strings.ReplaceAll(s, \"[\", \"|[\")\n\ts = strings.ReplaceAll(s, \"]\", \"|]\")\n\treturn s\n}\n\nfunc GenerateTeamcityReport(report types.Report, dst string) error {\n\tif err := os.MkdirAll(path.Dir(dst), 0770); err != nil {\n\t\treturn err\n\t}\n\tf, err := os.Create(dst)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tname := report.SuiteDescription\n\tlabels := report.SuiteLabels\n\tsemVerConstraints := report.SuiteSemVerConstraints\n\tcomponentSemVerConstraints := report.SuiteComponentSemVerConstraints\n\tif len(labels) > 0 {\n\t\tname = name + \" [\" + strings.Join(labels, \", \") + \"]\"\n\t}\n\tif len(semVerConstraints) > 0 {\n\t\tname = name + \" [\" + strings.Join(semVerConstraints, \", \") + \"]\"\n\t}\n\tif len(componentSemVerConstraints) > 0 {\n\t\tname = name + \" [\" + formatComponentSemVerConstraintsToString(componentSemVerConstraints) + \"]\"\n\t}\n\tfmt.Fprintf(f, \"##teamcity[testSuiteStarted name='%s']\\n\", tcEscape(name))\n\tfor _, spec := range report.SpecReports {\n\t\tname := fmt.Sprintf(\"[%s]\", spec.LeafNodeType)\n\t\tif spec.FullText() != \"\" {\n\t\t\tname = name + \" \" + spec.FullText()\n\t\t}\n\t\tlabels := spec.Labels()\n\t\tif len(labels) > 0 {\n\t\t\tname = name + \" [\" + strings.Join(labels, \", \") + \"]\"\n\t\t}\n\t\tsemVerConstraints := spec.SemVerConstraints()\n\t\tif len(semVerConstraints) > 0 {\n\t\t\tname = name + \" [\" + strings.Join(semVerConstraints, \", \") + \"]\"\n\t\t}\n\t\tcomponentSemVerConstraints := spec.ComponentSemVerConstraints()\n\t\tif len(componentSemVerConstraints) > 0 {\n\t\t\tname = name + \" [\" + formatComponentSemVerConstraintsToString(componentSemVerConstraints) + \"]\"\n\t\t}\n\n\t\tname = tcEscape(name)\n\t\tfmt.Fprintf(f, \"##teamcity[testStarted name='%s']\\n\", name)\n\t\tswitch spec.State {\n\t\tcase types.SpecStatePending:\n\t\t\tfmt.Fprintf(f, \"##teamcity[testIgnored name='%s' message='pending']\\n\", name)\n\t\tcase types.SpecStateSkipped:\n\t\t\tmessage := \"skipped\"\n\t\t\tif spec.Failure.Message != \"\" {\n\t\t\t\tmessage += \" - \" + spec.Failure.Message\n\t\t\t}\n\t\t\tfmt.Fprintf(f, \"##teamcity[testIgnored name='%s' message='%s']\\n\", name, tcEscape(message))\n\t\tcase types.SpecStateFailed:\n\t\t\tdetails := failureDescriptionForUnstructuredReporters(spec)\n\t\t\tfmt.Fprintf(f, \"##teamcity[testFailed name='%s' message='failed - %s' details='%s']\\n\", name, tcEscape(spec.Failure.Message), tcEscape(details))\n\t\tcase types.SpecStatePanicked:\n\t\t\tdetails := failureDescriptionForUnstructuredReporters(spec)\n\t\t\tfmt.Fprintf(f, \"##teamcity[testFailed name='%s' message='panicked - %s' details='%s']\\n\", name, tcEscape(spec.Failure.ForwardedPanic), tcEscape(details))\n\t\tcase types.SpecStateTimedout:\n\t\t\tdetails := failureDescriptionForUnstructuredReporters(spec)\n\t\t\tfmt.Fprintf(f, \"##teamcity[testFailed name='%s' message='timedout - %s' details='%s']\\n\", name, tcEscape(spec.Failure.Message), tcEscape(details))\n\t\tcase types.SpecStateInterrupted:\n\t\t\tdetails := failureDescriptionForUnstructuredReporters(spec)\n\t\t\tfmt.Fprintf(f, \"##teamcity[testFailed name='%s' message='interrupted - %s' details='%s']\\n\", name, tcEscape(spec.Failure.Message), tcEscape(details))\n\t\tcase types.SpecStateAborted:\n\t\t\tdetails := failureDescriptionForUnstructuredReporters(spec)\n\t\t\tfmt.Fprintf(f, \"##teamcity[testFailed name='%s' message='aborted - %s' details='%s']\\n\", name, tcEscape(spec.Failure.Message), tcEscape(details))\n\t\t}\n\n\t\tfmt.Fprintf(f, \"##teamcity[testStdOut name='%s' out='%s']\\n\", name, tcEscape(systemOutForUnstructuredReporters(spec)))\n\t\tfmt.Fprintf(f, \"##teamcity[testStdErr name='%s' out='%s']\\n\", name, tcEscape(systemErrForUnstructuredReporters(spec)))\n\t\tfmt.Fprintf(f, \"##teamcity[testFinished name='%s' duration='%d']\\n\", name, int(spec.RunTime.Seconds()*1000.0))\n\t}\n\tfmt.Fprintf(f, \"##teamcity[testSuiteFinished name='%s']\\n\", tcEscape(report.SuiteDescription))\n\n\treturn f.Close()\n}\n\nfunc MergeAndCleanupTeamcityReports(sources []string, dst string) ([]string, error) {\n\tmessages := []string{}\n\tmerged := []byte{}\n\tfor _, source := range sources {\n\t\tdata, err := os.ReadFile(source)\n\t\tif err != nil {\n\t\t\tmessages = append(messages, fmt.Sprintf(\"Could not open %s:\\n%s\", source, err.Error()))\n\t\t\tcontinue\n\t\t}\n\t\tos.Remove(source)\n\t\tmerged = append(merged, data...)\n\t}\n\treturn messages, os.WriteFile(dst, merged, 0666)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/reporting_dsl.go",
"content": "package ginkgo\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/internal\"\n\t\"github.com/onsi/ginkgo/v2/internal/global\"\n\t\"github.com/onsi/ginkgo/v2/reporters\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n/*\nReport represents the report for a Suite.\nIt is documented here: https://pkg.go.dev/github.com/onsi/ginkgo/v2/types#Report\n*/\ntype Report = types.Report\n\n/*\nReport represents the report for a Spec.\nIt is documented here: https://pkg.go.dev/github.com/onsi/ginkgo/v2/types#SpecReport\n*/\ntype SpecReport = types.SpecReport\n\n/*\nCurrentSpecReport returns information about the current running spec.\nThe returned object is a types.SpecReport which includes helper methods\nto make extracting information about the spec easier.\n\nDuring construction of the test tree the result is empty.\n\nYou can learn more about SpecReport here: https://pkg.go.dev/github.com/onsi/ginkgo/types#SpecReport\nYou can learn more about CurrentSpecReport() here: https://onsi.github.io/ginkgo/#getting-a-report-for-the-current-spec\n*/\nfunc CurrentSpecReport() SpecReport {\n\treturn global.Suite.CurrentSpecReport()\n}\n\n/*\nConstructionNodeReport describes the container nodes during construction of\nthe spec tree. It provides a subset of the information that is provided\nby SpecReport at runtime.\n\nIt is documented here: [types.ConstructionNodeReport]\n*/\ntype ConstructionNodeReport = types.ConstructionNodeReport\n\n/*\nCurrentConstructionNodeReport returns information about the current container nodes\nthat are leading to the current path in the spec tree.\nThe returned object is a types.ConstructionNodeReport which includes helper methods\nto make extracting information about the spec easier.\n\nMay only be called during construction of the spec tree. It panics when\ncalled while tests are running. Use CurrentSpecReport instead in that\nphase.\n\nYou can learn more about ConstructionNodeReport here: [types.ConstructionNodeReport]\n*/\nfunc CurrentTreeConstructionNodeReport() ConstructionNodeReport {\n\treturn global.Suite.CurrentConstructionNodeReport()\n}\n\n/*\n\tReportEntryVisibility governs the visibility of ReportEntries in Ginkgo's console reporter\n\n- ReportEntryVisibilityAlways: the default behavior - the ReportEntry is always emitted.\n- ReportEntryVisibilityFailureOrVerbose: the ReportEntry is only emitted if the spec fails or if the tests are run with -v (similar to GinkgoWriters behavior).\n- ReportEntryVisibilityNever: the ReportEntry is never emitted though it appears in any generated machine-readable reports (e.g. by setting `--json-report`).\n\nYou can learn more about Report Entries here: https://onsi.github.io/ginkgo/#attaching-data-to-reports\n*/\ntype ReportEntryVisibility = types.ReportEntryVisibility\n\nconst ReportEntryVisibilityAlways, ReportEntryVisibilityFailureOrVerbose, ReportEntryVisibilityNever = types.ReportEntryVisibilityAlways, types.ReportEntryVisibilityFailureOrVerbose, types.ReportEntryVisibilityNever\n\n/*\nAddReportEntry generates and adds a new ReportEntry to the current spec's SpecReport.\nIt can take any of the following arguments:\n - A single arbitrary object to attach as the Value of the ReportEntry. This object will be included in any generated reports and will be emitted to the console when the report is emitted.\n - A ReportEntryVisibility enum to control the visibility of the ReportEntry\n - An Offset or CodeLocation decoration to control the reported location of the ReportEntry\n\nIf the Value object implements `fmt.Stringer`, it's `String()` representation is used when emitting to the console.\n\nAddReportEntry() must be called within a Subject or Setup node - not in a Container node.\n\nYou can learn more about Report Entries here: https://onsi.github.io/ginkgo/#attaching-data-to-reports\n*/\nfunc AddReportEntry(name string, args ...any) {\n\tcl := types.NewCodeLocation(1)\n\treportEntry, err := internal.NewReportEntry(name, cl, args...)\n\tif err != nil {\n\t\tFail(fmt.Sprintf(\"Failed to generate Report Entry:\\n%s\", err.Error()), 1)\n\t}\n\terr = global.Suite.AddReportEntry(reportEntry)\n\tif err != nil {\n\t\tFail(fmt.Sprintf(\"Failed to add Report Entry:\\n%s\", err.Error()), 1)\n\t}\n}\n\n/*\nReportBeforeEach nodes are run for each spec, even if the spec is skipped or pending. ReportBeforeEach nodes take a function that\nreceives a SpecReport or both SpecContext and Report for interruptible behavior. They are called before the spec starts.\n\nExample:\n\n\tReportBeforeEach(func(report SpecReport) { // process report })\n\tReportBeforeEach(func(ctx SpecContext, report SpecReport) {\n\t\t// process report\n\t}), NodeTimeout(1 * time.Minute))\n\nYou cannot nest any other Ginkgo nodes within a ReportBeforeEach node's closure.\nYou can learn more about ReportBeforeEach here: https://onsi.github.io/ginkgo/#generating-reports-programmatically\n\nYou can learn about interruptible nodes here: https://onsi.github.io/ginkgo/#spec-timeouts-and-interruptible-nodes\n*/\nfunc ReportBeforeEach(body any, args ...any) bool {\n\tcombinedArgs := []any{body}\n\tcombinedArgs = append(combinedArgs, args...)\n\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeReportBeforeEach, \"\", combinedArgs...)))\n}\n\n/*\nReportAfterEach nodes are run for each spec, even if the spec is skipped or pending.\nReportAfterEach nodes take a function that receives a SpecReport or both SpecContext and Report for interruptible behavior.\nThey are called after the spec has completed and receive the final report for the spec.\n\nExample:\n\n\tReportAfterEach(func(report SpecReport) { // process report })\n\tReportAfterEach(func(ctx SpecContext, report SpecReport) {\n\t\t// process report\n\t}), NodeTimeout(1 * time.Minute))\n\nYou cannot nest any other Ginkgo nodes within a ReportAfterEach node's closure.\nYou can learn more about ReportAfterEach here: https://onsi.github.io/ginkgo/#generating-reports-programmatically\n\nYou can learn about interruptible nodes here: https://onsi.github.io/ginkgo/#spec-timeouts-and-interruptible-nodes\n*/\nfunc ReportAfterEach(body any, args ...any) bool {\n\tcombinedArgs := []any{body}\n\tcombinedArgs = append(combinedArgs, args...)\n\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeReportAfterEach, \"\", combinedArgs...)))\n}\n\n/*\nReportBeforeSuite nodes are run at the beginning of the suite. ReportBeforeSuite nodes take a function\nthat can either receive Report or both SpecContext and Report for interruptible behavior.\n\nExample Usage:\n\n\tReportBeforeSuite(func(r Report) { // process report })\n\tReportBeforeSuite(func(ctx SpecContext, r Report) {\n\t\t// process report\n\t}, NodeTimeout(1 * time.Minute))\n\nThey are called at the beginning of the suite, before any specs have run and any BeforeSuite or SynchronizedBeforeSuite nodes, and are passed in the initial report for the suite.\nReportBeforeSuite nodes must be created at the top-level (i.e. not nested in a Context/Describe/When node)\n\n# When running in parallel, Ginkgo ensures that only one of the parallel nodes runs the ReportBeforeSuite\n\nYou cannot nest any other Ginkgo nodes within a ReportAfterSuite node's closure.\nYou can learn more about ReportAfterSuite here: https://onsi.github.io/ginkgo/#generating-reports-programmatically\n\nYou can learn more about Ginkgo's reporting infrastructure, including generating reports with the CLI here: https://onsi.github.io/ginkgo/#generating-machine-readable-reports\n\nYou can learn about interruptible nodes here: https://onsi.github.io/ginkgo/#spec-timeouts-and-interruptible-nodes\n*/\nfunc ReportBeforeSuite(body any, args ...any) bool {\n\tcombinedArgs := []any{body}\n\tcombinedArgs = append(combinedArgs, args...)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeReportBeforeSuite, \"\", combinedArgs...)))\n}\n\n/*\nReportAfterSuite nodes are run at the end of the suite. ReportAfterSuite nodes execute at the suite's conclusion,\nand accept a function that can either receive Report or both SpecContext and Report for interruptible behavior.\n\nExample Usage:\n\n\tReportAfterSuite(\"Non-interruptible ReportAfterSuite\", func(r Report) { // process report })\n\tReportAfterSuite(\"Interruptible ReportAfterSuite\", func(ctx SpecContext, r Report) {\n\t\t// process report\n\t}, NodeTimeout(1 * time.Minute))\n\nThey are called at the end of the suite, after all specs have run and any AfterSuite or SynchronizedAfterSuite nodes, and are passed in the final report for the suite.\nReportAfterSuite nodes must be created at the top-level (i.e. not nested in a Context/Describe/When node)\n\nWhen running in parallel, Ginkgo ensures that only one of the parallel nodes runs the ReportAfterSuite and that it is passed a report that is aggregated across\nall parallel nodes\n\nIn addition to using ReportAfterSuite to programmatically generate suite reports, you can also generate JSON, GoJSON, JUnit, and Teamcity formatted reports using the --json-report, --gojson-report, --junit-report, and --teamcity-report ginkgo CLI flags.\n\nYou cannot nest any other Ginkgo nodes within a ReportAfterSuite node's closure.\nYou can learn more about ReportAfterSuite here: https://onsi.github.io/ginkgo/#generating-reports-programmatically\n\nYou can learn more about Ginkgo's reporting infrastructure, including generating reports with the CLI here: https://onsi.github.io/ginkgo/#generating-machine-readable-reports\n\nYou can learn about interruptible nodes here: https://onsi.github.io/ginkgo/#spec-timeouts-and-interruptible-nodes\n*/\nfunc ReportAfterSuite(text string, body any, args ...any) bool {\n\tcombinedArgs := []any{body}\n\tcombinedArgs = append(combinedArgs, args...)\n\treturn pushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeReportAfterSuite, text, combinedArgs...)))\n}\n\nfunc registerReportAfterSuiteNodeForAutogeneratedReports(reporterConfig types.ReporterConfig) {\n\tbody := func(report Report) {\n\t\tif reporterConfig.JSONReport != \"\" {\n\t\t\terr := reporters.GenerateJSONReport(report, reporterConfig.JSONReport)\n\t\t\tif err != nil {\n\t\t\t\tFail(fmt.Sprintf(\"Failed to generate JSON report:\\n%s\", err.Error()))\n\t\t\t}\n\t\t}\n\t\tif reporterConfig.GoJSONReport != \"\" {\n\t\t\terr := reporters.GenerateGoTestJSONReport(report, reporterConfig.GoJSONReport)\n\t\t\tif err != nil {\n\t\t\t\tFail(fmt.Sprintf(\"Failed to generate Go JSON report:\\n%s\", err.Error()))\n\t\t\t}\n\t\t}\n\t\tif reporterConfig.JUnitReport != \"\" {\n\t\t\terr := reporters.GenerateJUnitReport(report, reporterConfig.JUnitReport)\n\t\t\tif err != nil {\n\t\t\t\tFail(fmt.Sprintf(\"Failed to generate JUnit report:\\n%s\", err.Error()))\n\t\t\t}\n\t\t}\n\t\tif reporterConfig.TeamcityReport != \"\" {\n\t\t\terr := reporters.GenerateTeamcityReport(report, reporterConfig.TeamcityReport)\n\t\t\tif err != nil {\n\t\t\t\tFail(fmt.Sprintf(\"Failed to generate Teamcity report:\\n%s\", err.Error()))\n\t\t\t}\n\t\t}\n\t}\n\n\tflags := []string{}\n\tif reporterConfig.JSONReport != \"\" {\n\t\tflags = append(flags, \"--json-report\")\n\t}\n\tif reporterConfig.GoJSONReport != \"\" {\n\t\tflags = append(flags, \"--gojson-report\")\n\t}\n\tif reporterConfig.JUnitReport != \"\" {\n\t\tflags = append(flags, \"--junit-report\")\n\t}\n\tif reporterConfig.TeamcityReport != \"\" {\n\t\tflags = append(flags, \"--teamcity-report\")\n\t}\n\tpushNode(internal.NewNode(\n\t\tinternal.TransformNewNodeArgs(\n\t\t\texitIfErrors, deprecationTracker, types.NodeTypeReportAfterSuite,\n\t\t\tfmt.Sprintf(\"Autogenerated ReportAfterSuite for %s\", strings.Join(flags, \" \")),\n\t\t\tbody,\n\t\t\ttypes.NewCustomCodeLocation(\"autogenerated by Ginkgo\"),\n\t\t),\n\t))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/table_dsl.go",
"content": "package ginkgo\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"reflect\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/internal\"\n\t\"github.com/onsi/ginkgo/v2/types\"\n)\n\n/*\nThe EntryDescription decorator allows you to pass a format string to DescribeTable() and Entry(). This format string is used to generate entry names via:\n\n\tfmt.Sprintf(formatString, parameters...)\n\nwhere parameters are the parameters passed into the entry.\n\nWhen passed into an Entry the EntryDescription is used to generate the name or that entry. When passed to DescribeTable, the EntryDescription is used to generate the names for any entries that have `nil` descriptions.\n\nYou can learn more about generating EntryDescriptions here: https://onsi.github.io/ginkgo/#generating-entry-descriptions\n*/\ntype EntryDescription string\n\nfunc (ed EntryDescription) render(args ...any) string {\n\treturn fmt.Sprintf(string(ed), args...)\n}\n\n/*\nDescribeTable describes a table-driven spec.\n\nFor example:\n\n\tDescribeTable(\"a simple table\",\n\t func(x int, y int, expected bool) {\n\t Ω(x > y).Should(Equal(expected))\n\t },\n\t Entry(\"x > y\", 1, 0, true),\n\t Entry(\"x == y\", 0, 0, false),\n\t Entry(\"x < y\", 0, 1, false),\n\t)\n\nYou can learn more about DescribeTable here: https://onsi.github.io/ginkgo/#table-specs\nAnd can explore some Table patterns here: https://onsi.github.io/ginkgo/#table-specs-patterns\n*/\nfunc DescribeTable(description string, args ...any) bool {\n\tGinkgoHelper()\n\tgenerateTable(description, false, args...)\n\treturn true\n}\n\n/*\nYou can focus a table with `FDescribeTable`. This is equivalent to `FDescribe`.\n*/\nfunc FDescribeTable(description string, args ...any) bool {\n\tGinkgoHelper()\n\targs = append(args, internal.Focus)\n\tgenerateTable(description, false, args...)\n\treturn true\n}\n\n/*\nYou can mark a table as pending with `PDescribeTable`. This is equivalent to `PDescribe`.\n*/\nfunc PDescribeTable(description string, args ...any) bool {\n\tGinkgoHelper()\n\targs = append(args, internal.Pending)\n\tgenerateTable(description, false, args...)\n\treturn true\n}\n\n/*\nYou can mark a table as pending with `XDescribeTable`. This is equivalent to `XDescribe`.\n*/\nvar XDescribeTable = PDescribeTable\n\n/*\nDescribeTableSubtree describes a table-driven spec that generates a set of tests for each entry.\n\nFor example:\n\n\tDescribeTableSubtree(\"a subtree table\",\n\t func(url string, code int, message string) {\n\t\t\tvar resp *http.Response\n\t\t\tBeforeEach(func() {\n\t\t\t\tvar err error\n\t\t\t\tresp, err = http.Get(url)\n\t\t\t\tExpect(err).NotTo(HaveOccurred())\n\t\t\t\tDeferCleanup(resp.Body.Close)\n\t\t\t})\n\n\t\t\tIt(\"should return the expected status code\", func() {\n\t\t\t\tExpect(resp.StatusCode).To(Equal(code))\n\t\t\t})\n\n\t\t\tIt(\"should return the expected message\", func() {\n\t\t\t\tbody, err := io.ReadAll(resp.Body)\n\t\t\t\tExpect(err).NotTo(HaveOccurred())\n\t\t\t\tExpect(string(body)).To(Equal(message))\n\t\t\t})\n\t },\n\t Entry(\"default response\", \"example.com/response\", http.StatusOK, \"hello world\"),\n\t Entry(\"missing response\", \"example.com/missing\", http.StatusNotFound, \"wat?\"),\n\t)\n\nNote that you **must** place define an It inside the body function.\n\nYou can learn more about DescribeTableSubtree here: https://onsi.github.io/ginkgo/#table-specs\nAnd can explore some Table patterns here: https://onsi.github.io/ginkgo/#table-specs-patterns\n*/\nfunc DescribeTableSubtree(description string, args ...any) bool {\n\tGinkgoHelper()\n\tgenerateTable(description, true, args...)\n\treturn true\n}\n\n/*\nYou can focus a table with `FDescribeTableSubtree`. This is equivalent to `FDescribe`.\n*/\nfunc FDescribeTableSubtree(description string, args ...any) bool {\n\tGinkgoHelper()\n\targs = append(args, internal.Focus)\n\tgenerateTable(description, true, args...)\n\treturn true\n}\n\n/*\nYou can mark a table as pending with `PDescribeTableSubtree`. This is equivalent to `PDescribe`.\n*/\nfunc PDescribeTableSubtree(description string, args ...any) bool {\n\tGinkgoHelper()\n\targs = append(args, internal.Pending)\n\tgenerateTable(description, true, args...)\n\treturn true\n}\n\n/*\nYou can mark a table as pending with `XDescribeTableSubtree`. This is equivalent to `XDescribe`.\n*/\nvar XDescribeTableSubtree = PDescribeTableSubtree\n\n/*\nTableEntry represents an entry in a table test. You generally use the `Entry` constructor.\n*/\ntype TableEntry struct {\n\tdescription any\n\tdecorations []any\n\tparameters []any\n\tcodeLocation types.CodeLocation\n}\n\n/*\nEntry constructs a TableEntry.\n\nThe first argument is a description. This can be a string, a function that accepts the parameters passed to the TableEntry and returns a string, an EntryDescription format string, or nil. If nil is provided then the name of the Entry is derived using the table-level entry description.\nSubsequent arguments accept any Ginkgo decorators. These are filtered out and the remaining arguments are passed into the Spec function associated with the table.\n\nEach Entry ends up generating an individual Ginkgo It. The body of the it is the Table Body function with the Entry parameters passed in.\n\nIf you want to generate interruptible specs simply write a Table function that accepts a SpecContext as its first argument. You can then decorate individual Entrys with the NodeTimeout and SpecTimeout decorators.\n\nYou can learn more about Entry here: https://onsi.github.io/ginkgo/#table-specs\n*/\nfunc Entry(description any, args ...any) TableEntry {\n\tGinkgoHelper()\n\tdecorations, parameters := internal.PartitionDecorations(args...)\n\treturn TableEntry{description: description, decorations: decorations, parameters: parameters, codeLocation: types.NewCodeLocation(0)}\n}\n\n/*\nYou can focus a particular entry with FEntry. This is equivalent to FIt.\n*/\nfunc FEntry(description any, args ...any) TableEntry {\n\tGinkgoHelper()\n\tdecorations, parameters := internal.PartitionDecorations(args...)\n\tdecorations = append(decorations, internal.Focus)\n\treturn TableEntry{description: description, decorations: decorations, parameters: parameters, codeLocation: types.NewCodeLocation(0)}\n}\n\n/*\nYou can mark a particular entry as pending with PEntry. This is equivalent to PIt.\n*/\nfunc PEntry(description any, args ...any) TableEntry {\n\tGinkgoHelper()\n\tdecorations, parameters := internal.PartitionDecorations(args...)\n\tdecorations = append(decorations, internal.Pending)\n\treturn TableEntry{description: description, decorations: decorations, parameters: parameters, codeLocation: types.NewCodeLocation(0)}\n}\n\n/*\nYou can mark a particular entry as pending with XEntry. This is equivalent to XIt.\n*/\nvar XEntry = PEntry\n\nvar contextType = reflect.TypeOf(new(context.Context)).Elem()\nvar specContextType = reflect.TypeOf(new(SpecContext)).Elem()\n\nfunc generateTable(description string, isSubtree bool, args ...any) {\n\tGinkgoHelper()\n\tcl := types.NewCodeLocation(0)\n\tcontainerNodeArgs := []any{cl}\n\n\tentries := []TableEntry{}\n\tvar internalBody any\n\tvar internalBodyType reflect.Type\n\n\tvar tableLevelEntryDescription any\n\ttableLevelEntryDescription = func(args ...any) string {\n\t\tout := []string{}\n\t\tfor _, arg := range args {\n\t\t\tout = append(out, fmt.Sprint(arg))\n\t\t}\n\t\treturn \"Entry: \" + strings.Join(out, \", \")\n\t}\n\n\tif len(args) == 1 {\n\t\texitIfErr(types.GinkgoErrors.MissingParametersForTableFunction(cl))\n\t}\n\n\tfor i, arg := range args {\n\t\tswitch t := reflect.TypeOf(arg); {\n\t\tcase t == nil:\n\t\t\texitIfErr(types.GinkgoErrors.IncorrectParameterTypeForTable(i, \"nil\", cl))\n\t\tcase t == reflect.TypeOf(TableEntry{}):\n\t\t\tentries = append(entries, arg.(TableEntry))\n\t\tcase t == reflect.TypeOf([]TableEntry{}):\n\t\t\tentries = append(entries, arg.([]TableEntry)...)\n\t\tcase t == reflect.TypeOf(EntryDescription(\"\")):\n\t\t\ttableLevelEntryDescription = arg.(EntryDescription).render\n\t\tcase t.Kind() == reflect.Func && t.NumOut() == 1 && t.Out(0) == reflect.TypeOf(\"\"):\n\t\t\ttableLevelEntryDescription = arg\n\t\tcase t.Kind() == reflect.Func:\n\t\t\tif internalBody != nil {\n\t\t\t\texitIfErr(types.GinkgoErrors.MultipleEntryBodyFunctionsForTable(cl))\n\t\t\t}\n\t\t\tinternalBody = arg\n\t\t\tinternalBodyType = reflect.TypeOf(internalBody)\n\t\tdefault:\n\t\t\tcontainerNodeArgs = append(containerNodeArgs, arg)\n\t\t}\n\t}\n\n\tcontainerNodeArgs = append(containerNodeArgs, func() {\n\t\tfor _, entry := range entries {\n\t\t\tvar err error\n\t\t\tentry := entry\n\t\t\tvar description string\n\t\t\tswitch t := reflect.TypeOf(entry.description); {\n\t\t\tcase t == nil:\n\t\t\t\terr = validateParameters(tableLevelEntryDescription, entry.parameters, \"Entry Description function\", entry.codeLocation, false)\n\t\t\t\tif err == nil {\n\t\t\t\t\tdescription = invokeFunction(tableLevelEntryDescription, entry.parameters)[0].String()\n\t\t\t\t}\n\t\t\tcase t == reflect.TypeOf(EntryDescription(\"\")):\n\t\t\t\tdescription = entry.description.(EntryDescription).render(entry.parameters...)\n\t\t\tcase t == reflect.TypeOf(\"\"):\n\t\t\t\tdescription = entry.description.(string)\n\t\t\tcase t.Kind() == reflect.Func && t.NumOut() == 1 && t.Out(0) == reflect.TypeOf(\"\"):\n\t\t\t\terr = validateParameters(entry.description, entry.parameters, \"Entry Description function\", entry.codeLocation, false)\n\t\t\t\tif err == nil {\n\t\t\t\t\tdescription = invokeFunction(entry.description, entry.parameters)[0].String()\n\t\t\t\t}\n\t\t\tdefault:\n\t\t\t\terr = types.GinkgoErrors.InvalidEntryDescription(entry.codeLocation)\n\t\t\t}\n\n\t\t\tinternalNodeArgs := []any{entry.codeLocation}\n\t\t\tinternalNodeArgs = append(internalNodeArgs, entry.decorations...)\n\n\t\t\thasContext := false\n\t\t\tif internalBodyType.NumIn() > 0 {\n\t\t\t\tif internalBodyType.In(0).Implements(specContextType) {\n\t\t\t\t\thasContext = true\n\t\t\t\t} else if internalBodyType.In(0).Implements(contextType) {\n\t\t\t\t\thasContext = true\n\t\t\t\t\tif len(entry.parameters) > 0 && reflect.TypeOf(entry.parameters[0]) != nil && reflect.TypeOf(entry.parameters[0]).Implements(contextType) {\n\t\t\t\t\t\t// we allow you to pass in a non-nil context\n\t\t\t\t\t\thasContext = false\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif err == nil {\n\t\t\t\terr = validateParameters(internalBody, entry.parameters, \"Table Body function\", entry.codeLocation, hasContext)\n\t\t\t}\n\n\t\t\tif hasContext {\n\t\t\t\tinternalNodeArgs = append(internalNodeArgs, func(c SpecContext) {\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\tpanic(err)\n\t\t\t\t\t}\n\t\t\t\t\tinvokeFunction(internalBody, append([]any{c}, entry.parameters...))\n\t\t\t\t})\n\t\t\t\tif isSubtree {\n\t\t\t\t\texitIfErr(types.GinkgoErrors.ContextsCannotBeUsedInSubtreeTables(cl))\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tinternalNodeArgs = append(internalNodeArgs, func() {\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\tpanic(err)\n\t\t\t\t\t}\n\t\t\t\t\tinvokeFunction(internalBody, entry.parameters)\n\t\t\t\t})\n\t\t\t}\n\n\t\t\tinternalNodeType := types.NodeTypeIt\n\t\t\tif isSubtree {\n\t\t\t\tinternalNodeType = types.NodeTypeContainer\n\t\t\t}\n\n\t\t\tpushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, internalNodeType, description, internalNodeArgs...)))\n\t\t}\n\t})\n\n\tpushNode(internal.NewNode(internal.TransformNewNodeArgs(exitIfErrors, deprecationTracker, types.NodeTypeContainer, description, containerNodeArgs...)))\n}\n\nfunc invokeFunction(function any, parameters []any) []reflect.Value {\n\tinValues := make([]reflect.Value, len(parameters))\n\n\tfuncType := reflect.TypeOf(function)\n\tlimit := funcType.NumIn()\n\tif funcType.IsVariadic() {\n\t\tlimit = limit - 1\n\t}\n\n\tfor i := 0; i < limit && i < len(parameters); i++ {\n\t\tinValues[i] = computeValue(parameters[i], funcType.In(i))\n\t}\n\n\tif funcType.IsVariadic() {\n\t\tvariadicType := funcType.In(limit).Elem()\n\t\tfor i := limit; i < len(parameters); i++ {\n\t\t\tinValues[i] = computeValue(parameters[i], variadicType)\n\t\t}\n\t}\n\n\treturn reflect.ValueOf(function).Call(inValues)\n}\n\nfunc validateParameters(function any, parameters []any, kind string, cl types.CodeLocation, hasContext bool) error {\n\tfuncType := reflect.TypeOf(function)\n\tlimit := funcType.NumIn()\n\toffset := 0\n\tif hasContext {\n\t\tlimit = limit - 1\n\t\toffset = 1\n\t}\n\tif funcType.IsVariadic() {\n\t\tlimit = limit - 1\n\t}\n\tif len(parameters) < limit {\n\t\treturn types.GinkgoErrors.TooFewParametersToTableFunction(limit, len(parameters), kind, cl)\n\t}\n\tif len(parameters) > limit && !funcType.IsVariadic() {\n\t\treturn types.GinkgoErrors.TooManyParametersToTableFunction(limit, len(parameters), kind, cl)\n\t}\n\tvar i = 0\n\tfor ; i < limit; i++ {\n\t\tactual := reflect.TypeOf(parameters[i])\n\t\texpected := funcType.In(i + offset)\n\t\tif !(actual == nil) && !actual.AssignableTo(expected) {\n\t\t\treturn types.GinkgoErrors.IncorrectParameterTypeToTableFunction(i+1, expected, actual, kind, cl)\n\t\t}\n\t}\n\tif funcType.IsVariadic() {\n\t\texpected := funcType.In(limit + offset).Elem()\n\t\tfor ; i < len(parameters); i++ {\n\t\t\tactual := reflect.TypeOf(parameters[i])\n\t\t\tif !(actual == nil) && !actual.AssignableTo(expected) {\n\t\t\t\treturn types.GinkgoErrors.IncorrectVariadicParameterTypeToTableFunction(expected, actual, kind, cl)\n\t\t\t}\n\t\t}\n\t}\n\n\treturn nil\n}\n\nfunc computeValue(parameter any, t reflect.Type) reflect.Value {\n\tif parameter == nil {\n\t\treturn reflect.Zero(t)\n\t} else {\n\t\treturn reflect.ValueOf(parameter)\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/around_node.go",
"content": "package types\n\nimport (\n\t\"context\"\n)\n\ntype AroundNodeAllowedFuncs interface {\n\t~func(context.Context, func(context.Context)) | ~func(context.Context) context.Context | ~func()\n}\ntype AroundNodeFunc func(ctx context.Context, body func(ctx context.Context))\n\nfunc AroundNode[F AroundNodeAllowedFuncs](f F, cl CodeLocation) AroundNodeDecorator {\n\tif f == nil {\n\t\tpanic(\"BuildAroundNode cannot be called with a nil function.\")\n\t}\n\tvar aroundNodeFunc func(context.Context, func(context.Context))\n\tswitch x := any(f).(type) {\n\tcase func(context.Context, func(context.Context)):\n\t\taroundNodeFunc = x\n\tcase func(context.Context) context.Context:\n\t\taroundNodeFunc = func(ctx context.Context, body func(context.Context)) {\n\t\t\tctx = x(ctx)\n\t\t\tbody(ctx)\n\t\t}\n\tcase func():\n\t\taroundNodeFunc = func(ctx context.Context, body func(context.Context)) {\n\t\t\tx()\n\t\t\tbody(ctx)\n\t\t}\n\t}\n\n\treturn AroundNodeDecorator{\n\t\tBody: aroundNodeFunc,\n\t\tCodeLocation: cl,\n\t}\n}\n\ntype AroundNodeDecorator struct {\n\tBody AroundNodeFunc\n\tCodeLocation CodeLocation\n}\n\ntype AroundNodes []AroundNodeDecorator\n\nfunc (an AroundNodes) Clone() AroundNodes {\n\tout := make(AroundNodes, len(an))\n\tcopy(out, an)\n\treturn out\n}\n\nfunc (an AroundNodes) Append(other ...AroundNodeDecorator) AroundNodes {\n\tout := make(AroundNodes, len(an)+len(other))\n\tcopy(out, an)\n\tcopy(out[len(an):], other)\n\treturn out\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/code_location.go",
"content": "package types\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"regexp\"\n\t\"runtime\"\n\t\"runtime/debug\"\n\t\"strings\"\n\t\"sync\"\n)\n\ntype CodeLocation struct {\n\tFileName string `json:\",omitempty\"`\n\tLineNumber int `json:\",omitempty\"`\n\tFullStackTrace string `json:\",omitempty\"`\n\tCustomMessage string `json:\",omitempty\"`\n}\n\nfunc (codeLocation CodeLocation) String() string {\n\tif codeLocation.CustomMessage != \"\" {\n\t\treturn codeLocation.CustomMessage\n\t}\n\treturn fmt.Sprintf(\"%s:%d\", codeLocation.FileName, codeLocation.LineNumber)\n}\n\nfunc (codeLocation CodeLocation) ContentsOfLine() string {\n\tif codeLocation.CustomMessage != \"\" {\n\t\treturn \"\"\n\t}\n\tcontents, err := os.ReadFile(codeLocation.FileName)\n\tif err != nil {\n\t\treturn \"\"\n\t}\n\tlines := strings.Split(string(contents), \"\\n\")\n\tif len(lines) < codeLocation.LineNumber {\n\t\treturn \"\"\n\t}\n\treturn lines[codeLocation.LineNumber-1]\n}\n\ntype codeLocationLocator struct {\n\tpcs map[uintptr]bool\n\thelpers map[string]bool\n\tlock *sync.Mutex\n}\n\nfunc (c *codeLocationLocator) addHelper(pc uintptr) {\n\tc.lock.Lock()\n\tdefer c.lock.Unlock()\n\n\tif c.pcs[pc] {\n\t\treturn\n\t}\n\tc.lock.Unlock()\n\tf := runtime.FuncForPC(pc)\n\tc.lock.Lock()\n\tif f == nil {\n\t\treturn\n\t}\n\tc.helpers[f.Name()] = true\n\tc.pcs[pc] = true\n}\n\nfunc (c *codeLocationLocator) hasHelper(name string) bool {\n\tc.lock.Lock()\n\tdefer c.lock.Unlock()\n\treturn c.helpers[name]\n}\n\nfunc (c *codeLocationLocator) getCodeLocation(skip int) CodeLocation {\n\tpc := make([]uintptr, 40)\n\tn := runtime.Callers(skip+2, pc)\n\tif n == 0 {\n\t\treturn CodeLocation{}\n\t}\n\tpc = pc[:n]\n\tframes := runtime.CallersFrames(pc)\n\tfor {\n\t\tframe, more := frames.Next()\n\t\tif !c.hasHelper(frame.Function) {\n\t\t\treturn CodeLocation{FileName: frame.File, LineNumber: frame.Line}\n\t\t}\n\t\tif !more {\n\t\t\tbreak\n\t\t}\n\t}\n\treturn CodeLocation{}\n}\n\nvar clLocator = &codeLocationLocator{\n\tpcs: map[uintptr]bool{},\n\thelpers: map[string]bool{},\n\tlock: &sync.Mutex{},\n}\n\n// MarkAsHelper is used by GinkgoHelper to mark the caller (appropriately offset by skip)as a helper. You can use this directly if you need to provide an optional `skip` to mark functions further up the call stack as helpers.\nfunc MarkAsHelper(optionalSkip ...int) {\n\tskip := 1\n\tif len(optionalSkip) > 0 {\n\t\tskip += optionalSkip[0]\n\t}\n\tpc, _, _, ok := runtime.Caller(skip)\n\tif ok {\n\t\tclLocator.addHelper(pc)\n\t}\n}\n\nfunc NewCustomCodeLocation(message string) CodeLocation {\n\treturn CodeLocation{\n\t\tCustomMessage: message,\n\t}\n}\n\nfunc NewCodeLocation(skip int) CodeLocation {\n\treturn clLocator.getCodeLocation(skip + 1)\n}\n\nfunc NewCodeLocationWithStackTrace(skip int) CodeLocation {\n\tcl := clLocator.getCodeLocation(skip + 1)\n\tcl.FullStackTrace = PruneStack(string(debug.Stack()), skip+1)\n\treturn cl\n}\n\n// PruneStack removes references to functions that are internal to Ginkgo\n// and the Go runtime from a stack string and a certain number of stack entries\n// at the beginning of the stack. The stack string has the format\n// as returned by runtime/debug.Stack. The leading goroutine information is\n// optional and always removed if present. Beware that runtime/debug.Stack\n// adds itself as first entry, so typically skip must be >= 1 to remove that\n// entry.\nfunc PruneStack(fullStackTrace string, skip int) string {\n\tstack := strings.Split(fullStackTrace, \"\\n\")\n\t// Ensure that the even entries are the method names and the\n\t// odd entries the source code information.\n\tif len(stack) > 0 && strings.HasPrefix(stack[0], \"goroutine \") {\n\t\t// Ignore \"goroutine 29 [running]:\" line.\n\t\tstack = stack[1:]\n\t}\n\t// The \"+1\" is for skipping over the initial entry, which is\n\t// runtime/debug.Stack() itself.\n\tif len(stack) > 2*(skip+1) {\n\t\tstack = stack[2*(skip+1):]\n\t}\n\tprunedStack := []string{}\n\tif os.Getenv(\"GINKGO_PRUNE_STACK\") == \"FALSE\" {\n\t\tprunedStack = stack\n\t} else {\n\t\tre := regexp.MustCompile(`\\/ginkgo\\/|\\/pkg\\/testing\\/|\\/pkg\\/runtime\\/`)\n\t\tfor i := 0; i < len(stack)/2; i++ {\n\t\t\t// We filter out based on the source code file name.\n\t\t\tif !re.MatchString(stack[i*2+1]) {\n\t\t\t\tprunedStack = append(prunedStack, stack[i*2])\n\t\t\t\tprunedStack = append(prunedStack, stack[i*2+1])\n\t\t\t}\n\t\t}\n\t}\n\treturn strings.Join(prunedStack, \"\\n\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/config.go",
"content": "/*\nGinkgo accepts a number of configuration options.\nThese are documented [here](http://onsi.github.io/ginkgo/#the-ginkgo-cli)\n*/\n\npackage types\n\nimport (\n\t\"flag\"\n\t\"os\"\n\t\"path/filepath\"\n\t\"runtime\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n)\n\n// Configuration controlling how an individual test suite is run\ntype SuiteConfig struct {\n\tRandomSeed int64\n\tRandomizeAllSpecs bool\n\tFocusStrings []string\n\tSkipStrings []string\n\tFocusFiles []string\n\tSkipFiles []string\n\tLabelFilter string\n\tSemVerFilter string\n\tFailOnPending bool\n\tFailOnEmpty bool\n\tFailFast bool\n\tFlakeAttempts int\n\tMustPassRepeatedly int\n\tDryRun bool\n\tPollProgressAfter time.Duration\n\tPollProgressInterval time.Duration\n\tTimeout time.Duration\n\tEmitSpecProgress bool // this is deprecated but its removal is causing compile issue for some users that were setting it manually\n\tOutputInterceptorMode string\n\tSourceRoots []string\n\tGracePeriod time.Duration\n\n\tParallelProcess int\n\tParallelTotal int\n\tParallelHost string\n}\n\nfunc NewDefaultSuiteConfig() SuiteConfig {\n\treturn SuiteConfig{\n\t\tRandomSeed: time.Now().Unix(),\n\t\tTimeout: time.Hour,\n\t\tParallelProcess: 1,\n\t\tParallelTotal: 1,\n\t\tGracePeriod: 30 * time.Second,\n\t}\n}\n\ntype VerbosityLevel uint\n\nconst (\n\tVerbosityLevelSuccinct VerbosityLevel = iota\n\tVerbosityLevelNormal\n\tVerbosityLevelVerbose\n\tVerbosityLevelVeryVerbose\n)\n\nfunc (vl VerbosityLevel) GT(comp VerbosityLevel) bool {\n\treturn vl > comp\n}\n\nfunc (vl VerbosityLevel) GTE(comp VerbosityLevel) bool {\n\treturn vl >= comp\n}\n\nfunc (vl VerbosityLevel) Is(comp VerbosityLevel) bool {\n\treturn vl == comp\n}\n\nfunc (vl VerbosityLevel) LTE(comp VerbosityLevel) bool {\n\treturn vl <= comp\n}\n\nfunc (vl VerbosityLevel) LT(comp VerbosityLevel) bool {\n\treturn vl < comp\n}\n\n// Configuration for Ginkgo's reporter\ntype ReporterConfig struct {\n\tNoColor bool\n\tSuccinct bool\n\tVerbose bool\n\tVeryVerbose bool\n\tFullTrace bool\n\tShowNodeEvents bool\n\tGithubOutput bool\n\tSilenceSkips bool\n\tForceNewlines bool\n\n\tJSONReport string\n\tGoJSONReport string\n\tJUnitReport string\n\tTeamcityReport string\n}\n\nfunc (rc ReporterConfig) Verbosity() VerbosityLevel {\n\tif rc.Succinct {\n\t\treturn VerbosityLevelSuccinct\n\t} else if rc.Verbose {\n\t\treturn VerbosityLevelVerbose\n\t} else if rc.VeryVerbose {\n\t\treturn VerbosityLevelVeryVerbose\n\t}\n\treturn VerbosityLevelNormal\n}\n\nfunc (rc ReporterConfig) WillGenerateReport() bool {\n\treturn rc.JSONReport != \"\" || rc.GoJSONReport != \"\" || rc.JUnitReport != \"\" || rc.TeamcityReport != \"\"\n}\n\nfunc NewDefaultReporterConfig() ReporterConfig {\n\treturn ReporterConfig{}\n}\n\n// Configuration for the Ginkgo CLI\ntype CLIConfig struct {\n\t//for build, run, and watch\n\tRecurse bool\n\tSkipPackage string\n\tRequireSuite bool\n\tNumCompilers int\n\n\t//for run and watch only\n\tProcs int\n\tParallel bool\n\tAfterRunHook string\n\tOutputDir string\n\tKeepSeparateCoverprofiles bool\n\tKeepSeparateReports bool\n\n\t//for run only\n\tKeepGoing bool\n\tUntilItFails bool\n\tRepeat int\n\tRandomizeSuites bool\n\n\t//for watch only\n\tDepth int\n\tWatchRegExp string\n}\n\nfunc NewDefaultCLIConfig() CLIConfig {\n\treturn CLIConfig{\n\t\tDepth: 1,\n\t\tWatchRegExp: `\\.go$`,\n\t}\n}\n\nfunc (g CLIConfig) ComputedProcs() int {\n\tif g.Procs > 0 {\n\t\treturn g.Procs\n\t}\n\n\tn := 1\n\tif g.Parallel {\n\t\tn = runtime.GOMAXPROCS(-1)\n\t\tif n > 4 {\n\t\t\tn = n - 1\n\t\t}\n\t}\n\treturn n\n}\n\nfunc (g CLIConfig) ComputedNumCompilers() int {\n\tif g.NumCompilers > 0 {\n\t\treturn g.NumCompilers\n\t}\n\n\treturn runtime.GOMAXPROCS(-1)\n}\n\n// Configuration for the Ginkgo CLI capturing available go flags\n// A subset of Go flags are exposed by Ginkgo. Some are available at compile time (e.g. ginkgo build) and others only at run time (e.g. ginkgo run - which has both build and run time flags).\n// More details can be found at:\n// https://docs.google.com/spreadsheets/d/1zkp-DS4hU4sAJl5eHh1UmgwxCPQhf3s5a8fbiOI8tJU/\ntype GoFlagsConfig struct {\n\t//build-time flags for code-and-performance analysis\n\tRace bool\n\tCover bool\n\tCoverMode string\n\tCoverPkg string\n\tVet string\n\n\t//run-time flags for code-and-performance analysis\n\tBlockProfile string\n\tBlockProfileRate int\n\tCoverProfile string\n\tCPUProfile string\n\tMemProfile string\n\tMemProfileRate int\n\tMutexProfile string\n\tMutexProfileFraction int\n\tTrace string\n\n\t//build-time flags for building\n\tA bool\n\tASMFlags string\n\tBuildMode string\n\tBuildVCS bool\n\tCompiler string\n\tGCCGoFlags string\n\tGCFlags string\n\tInstallSuffix string\n\tLDFlags string\n\tLinkShared bool\n\tMod string\n\tN bool\n\tModFile string\n\tModCacheRW bool\n\tMSan bool\n\tPkgDir string\n\tTags string\n\tTrimPath bool\n\tToolExec string\n\tWork bool\n\tX bool\n\tO string\n}\n\nfunc NewDefaultGoFlagsConfig() GoFlagsConfig {\n\treturn GoFlagsConfig{}\n}\n\nfunc (g GoFlagsConfig) BinaryMustBePreserved() bool {\n\treturn g.BlockProfile != \"\" || g.CPUProfile != \"\" || g.MemProfile != \"\" || g.MutexProfile != \"\"\n}\n\nfunc (g GoFlagsConfig) NeedsSymbols() bool {\n\treturn g.BinaryMustBePreserved()\n}\n\n// Configuration that were deprecated in 2.0\ntype deprecatedConfig struct {\n\tDebugParallel bool\n\tNoisySkippings bool\n\tNoisyPendings bool\n\tRegexScansFilePath bool\n\tSlowSpecThresholdWithFLoatUnits float64\n\tStream bool\n\tNotify bool\n\tEmitSpecProgress bool\n\tSlowSpecThreshold time.Duration\n\tAlwaysEmitGinkgoWriter bool\n}\n\n// Flags\n\n// Flags sections used by both the CLI and the Ginkgo test process\nvar FlagSections = GinkgoFlagSections{\n\t{Key: \"multiple-suites\", Style: \"{{dark-green}}\", Heading: \"Running Multiple Test Suites\"},\n\t{Key: \"order\", Style: \"{{green}}\", Heading: \"Controlling Test Order\"},\n\t{Key: \"parallel\", Style: \"{{yellow}}\", Heading: \"Controlling Test Parallelism\"},\n\t{Key: \"low-level-parallel\", Style: \"{{yellow}}\", Heading: \"Controlling Test Parallelism\",\n\t\tDescription: \"These are set by the Ginkgo CLI, {{red}}{{bold}}do not set them manually{{/}} via go test.\\nUse ginkgo -p or ginkgo -procs=N instead.\"},\n\t{Key: \"filter\", Style: \"{{cyan}}\", Heading: \"Filtering Tests\"},\n\t{Key: \"failure\", Style: \"{{red}}\", Heading: \"Failure Handling\"},\n\t{Key: \"output\", Style: \"{{magenta}}\", Heading: \"Controlling Output Formatting\"},\n\t{Key: \"code-and-coverage-analysis\", Style: \"{{orange}}\", Heading: \"Code and Coverage Analysis\",\n\t\tDescription: \"When generating a cover files, please pass a filename {{bold}}not{{/}} a path. To specify a different directory use {{magenta}}--output-dir{{/}}.\",\n\t},\n\t{Key: \"performance-analysis\", Style: \"{{coral}}\", Heading: \"Performance Analysis\",\n\t\tDescription: \"When generating profile files, please pass filenames {{bold}}not{{/}} a path. Ginkgo will generate a profile file with the given name in the package's directory. To specify a different directory use {{magenta}}--output-dir{{/}}.\",\n\t},\n\t{Key: \"debug\", Style: \"{{blue}}\", Heading: \"Debugging Tests\",\n\t\tDescription: \"In addition to these flags, Ginkgo supports a few debugging environment variables. To change the parallel server protocol set {{blue}}GINKGO_PARALLEL_PROTOCOL{{/}} to {{bold}}HTTP{{/}}. To avoid pruning callstacks set {{blue}}GINKGO_PRUNE_STACK{{/}} to {{bold}}FALSE{{/}}.\"},\n\t{Key: \"watch\", Style: \"{{light-yellow}}\", Heading: \"Controlling Ginkgo Watch\"},\n\t{Key: \"misc\", Style: \"{{light-gray}}\", Heading: \"Miscellaneous\"},\n\t{Key: \"go-build\", Style: \"{{light-gray}}\", Heading: \"Go Build Flags\", Succinct: true,\n\t\tDescription: \"These flags are inherited from go build. Run {{bold}}ginkgo help build{{/}} for more detailed flag documentation.\"},\n}\n\n// SuiteConfigFlags provides flags for the Ginkgo test process, and CLI\nvar SuiteConfigFlags = GinkgoFlags{\n\t{KeyPath: \"S.RandomSeed\", Name: \"seed\", SectionKey: \"order\", UsageDefaultValue: \"randomly generated by Ginkgo\",\n\t\tUsage: \"The seed used to randomize the spec suite.\", AlwaysExport: true},\n\t{KeyPath: \"S.RandomizeAllSpecs\", Name: \"randomize-all\", SectionKey: \"order\", DeprecatedName: \"randomizeAllSpecs\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, ginkgo will randomize all specs together. By default, ginkgo only randomizes the top level Describe, Context and When containers.\"},\n\n\t{KeyPath: \"S.FailOnPending\", Name: \"fail-on-pending\", SectionKey: \"failure\", DeprecatedName: \"failOnPending\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, ginkgo will mark the test suite as failed if any specs are pending.\"},\n\t{KeyPath: \"S.FailFast\", Name: \"fail-fast\", SectionKey: \"failure\", DeprecatedName: \"failFast\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, ginkgo will stop running a test suite after a failure occurs.\"},\n\t{KeyPath: \"S.FlakeAttempts\", Name: \"flake-attempts\", SectionKey: \"failure\", UsageDefaultValue: \"0 - failed tests are not retried\", DeprecatedName: \"flakeAttempts\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"Make up to this many attempts to run each spec. If any of the attempts succeed, the suite will not be failed.\"},\n\t{KeyPath: \"S.FailOnEmpty\", Name: \"fail-on-empty\", SectionKey: \"failure\",\n\t\tUsage: \"If set, ginkgo will mark the test suite as failed if no specs are run.\"},\n\n\t{KeyPath: \"S.DryRun\", Name: \"dry-run\", SectionKey: \"debug\", DeprecatedName: \"dryRun\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, ginkgo will walk the test hierarchy without actually running anything. Best paired with -v.\"},\n\t{KeyPath: \"S.PollProgressAfter\", Name: \"poll-progress-after\", SectionKey: \"debug\", UsageDefaultValue: \"0\",\n\t\tUsage: \"Emit node progress reports periodically if node hasn't completed after this duration.\"},\n\t{KeyPath: \"S.PollProgressInterval\", Name: \"poll-progress-interval\", SectionKey: \"debug\", UsageDefaultValue: \"10s\",\n\t\tUsage: \"The rate at which to emit node progress reports after poll-progress-after has elapsed.\"},\n\t{KeyPath: \"S.SourceRoots\", Name: \"source-root\", SectionKey: \"debug\",\n\t\tUsage: \"The location to look for source code when generating progress reports. You can pass multiple --source-root flags.\"},\n\t{KeyPath: \"S.Timeout\", Name: \"timeout\", SectionKey: \"debug\", UsageDefaultValue: \"1h\",\n\t\tUsage: \"Test suite fails if it does not complete within the specified timeout.\"},\n\t{KeyPath: \"S.GracePeriod\", Name: \"grace-period\", SectionKey: \"debug\", UsageDefaultValue: \"30s\",\n\t\tUsage: \"When interrupted, Ginkgo will wait for GracePeriod for the current running node to exit before moving on to the next one.\"},\n\t{KeyPath: \"S.OutputInterceptorMode\", Name: \"output-interceptor-mode\", SectionKey: \"debug\", UsageArgument: \"dup, swap, or none\",\n\t\tUsage: \"If set, ginkgo will use the specified output interception strategy when running in parallel. Defaults to dup on unix and swap on windows.\"},\n\n\t{KeyPath: \"S.LabelFilter\", Name: \"label-filter\", SectionKey: \"filter\", UsageArgument: \"expression\",\n\t\tUsage: \"If set, ginkgo will only run specs with labels that match the label-filter. The passed-in expression can include boolean operations (!, &&, ||, ','), groupings via '()', and regular expressions '/regexp/'. e.g. '(cat || dog) && !fruit'\"},\n\t{KeyPath: \"S.SemVerFilter\", Name: \"sem-ver-filter\", SectionKey: \"filter\", UsageArgument: \"version\",\n\t\tUsage: \"If set, ginkgo will only run specs with semantic version constraints that are satisfied by the provided version. e.g. '2.1.0'\"},\n\t{KeyPath: \"S.FocusStrings\", Name: \"focus\", SectionKey: \"filter\",\n\t\tUsage: \"If set, ginkgo will only run specs that match this regular expression. Can be specified multiple times, values are ORed.\"},\n\t{KeyPath: \"S.SkipStrings\", Name: \"skip\", SectionKey: \"filter\",\n\t\tUsage: \"If set, ginkgo will only run specs that do not match this regular expression. Can be specified multiple times, values are ORed.\"},\n\t{KeyPath: \"S.FocusFiles\", Name: \"focus-file\", SectionKey: \"filter\", UsageArgument: \"file (regexp) | file:line | file:lineA-lineB | file:line,line,line\",\n\t\tUsage: \"If set, ginkgo will only run specs in matching files. Can be specified multiple times, values are ORed.\"},\n\t{KeyPath: \"S.SkipFiles\", Name: \"skip-file\", SectionKey: \"filter\", UsageArgument: \"file (regexp) | file:line | file:lineA-lineB | file:line,line,line\",\n\t\tUsage: \"If set, ginkgo will skip specs in matching files. Can be specified multiple times, values are ORed.\"},\n\n\t{KeyPath: \"D.RegexScansFilePath\", DeprecatedName: \"regexScansFilePath\", DeprecatedDocLink: \"removed--regexscansfilepath\", DeprecatedVersion: \"2.0.0\"},\n\t{KeyPath: \"D.DebugParallel\", DeprecatedName: \"debug\", DeprecatedDocLink: \"removed--debug\", DeprecatedVersion: \"2.0.0\"},\n\t{KeyPath: \"D.EmitSpecProgress\", DeprecatedName: \"progress\", SectionKey: \"debug\",\n\t\tDeprecatedVersion: \"2.5.0\", Usage: \". The functionality provided by --progress was confusing and is no longer needed. Use --show-node-events instead to see node entry and exit events included in the timeline of failed and verbose specs. Or you can run with -vv to always see all node events. Lastly, --poll-progress-after and the PollProgressAfter decorator now provide a better mechanism for debugging specs that tend to get stuck.\"},\n}\n\n// ParallelConfigFlags provides flags for the Ginkgo test process (not the CLI)\nvar ParallelConfigFlags = GinkgoFlags{\n\t{KeyPath: \"S.ParallelProcess\", Name: \"parallel.process\", SectionKey: \"low-level-parallel\", UsageDefaultValue: \"1\",\n\t\tUsage: \"This worker process's (one-indexed) process number. For running specs in parallel.\"},\n\t{KeyPath: \"S.ParallelTotal\", Name: \"parallel.total\", SectionKey: \"low-level-parallel\", UsageDefaultValue: \"1\",\n\t\tUsage: \"The total number of worker processes. For running specs in parallel.\"},\n\t{KeyPath: \"S.ParallelHost\", Name: \"parallel.host\", SectionKey: \"low-level-parallel\", UsageDefaultValue: \"set by Ginkgo CLI\",\n\t\tUsage: \"The address for the server that will synchronize the processes.\"},\n}\n\n// ReporterConfigFlags provides flags for the Ginkgo test process, and CLI\nvar ReporterConfigFlags = GinkgoFlags{\n\t{KeyPath: \"R.NoColor\", Name: \"no-color\", SectionKey: \"output\", DeprecatedName: \"noColor\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, suppress color output in default reporter. You can also set the environment variable GINKGO_NO_COLOR=TRUE\"},\n\t{KeyPath: \"R.Verbose\", Name: \"v\", SectionKey: \"output\",\n\t\tUsage: \"If set, emits more output including GinkgoWriter contents.\"},\n\t{KeyPath: \"R.VeryVerbose\", Name: \"vv\", SectionKey: \"output\",\n\t\tUsage: \"If set, emits with maximal verbosity - includes skipped and pending tests.\"},\n\t{KeyPath: \"R.Succinct\", Name: \"succinct\", SectionKey: \"output\",\n\t\tUsage: \"If set, default reporter prints out a very succinct report\"},\n\t{KeyPath: \"R.FullTrace\", Name: \"trace\", SectionKey: \"output\",\n\t\tUsage: \"If set, default reporter prints out the full stack trace when a failure occurs\"},\n\t{KeyPath: \"R.ShowNodeEvents\", Name: \"show-node-events\", SectionKey: \"output\",\n\t\tUsage: \"If set, default reporter prints node > Enter and < Exit events when specs fail\"},\n\t{KeyPath: \"R.GithubOutput\", Name: \"github-output\", SectionKey: \"output\",\n\t\tUsage: \"If set, default reporter prints easier to manage output in Github Actions.\"},\n\t{KeyPath: \"R.SilenceSkips\", Name: \"silence-skips\", SectionKey: \"output\",\n\t\tUsage: \"If set, default reporter will not print out skipped tests.\"},\n\t{KeyPath: \"R.ForceNewlines\", Name: \"force-newlines\", SectionKey: \"output\",\n\t\tUsage: \"If set, default reporter will ensure a newline appears after each test.\"},\n\n\t{KeyPath: \"R.JSONReport\", Name: \"json-report\", UsageArgument: \"filename.json\", SectionKey: \"output\",\n\t\tUsage: \"If set, Ginkgo will generate a JSON-formatted test report at the specified location.\"},\n\t{KeyPath: \"R.GoJSONReport\", Name: \"gojson-report\", UsageArgument: \"filename.json\", SectionKey: \"output\",\n\t\tUsage: \"If set, Ginkgo will generate a Go JSON-formatted test report at the specified location.\"},\n\t{KeyPath: \"R.JUnitReport\", Name: \"junit-report\", UsageArgument: \"filename.xml\", SectionKey: \"output\", DeprecatedName: \"reportFile\", DeprecatedDocLink: \"improved-reporting-infrastructure\",\n\t\tUsage: \"If set, Ginkgo will generate a conformant junit test report in the specified file.\"},\n\t{KeyPath: \"R.TeamcityReport\", Name: \"teamcity-report\", UsageArgument: \"filename\", SectionKey: \"output\",\n\t\tUsage: \"If set, Ginkgo will generate a Teamcity-formatted test report at the specified location.\"},\n\n\t{KeyPath: \"D.SlowSpecThresholdWithFLoatUnits\", DeprecatedName: \"slowSpecThreshold\", DeprecatedDocLink: \"changed--slowspecthreshold\",\n\t\tUsage: \"use --slow-spec-threshold instead and pass in a duration string (e.g. '5s', not '5.0')\"},\n\t{KeyPath: \"D.NoisyPendings\", DeprecatedName: \"noisyPendings\", DeprecatedDocLink: \"removed--noisypendings-and--noisyskippings\", DeprecatedVersion: \"2.0.0\"},\n\t{KeyPath: \"D.NoisySkippings\", DeprecatedName: \"noisySkippings\", DeprecatedDocLink: \"removed--noisypendings-and--noisyskippings\", DeprecatedVersion: \"2.0.0\"},\n\t{KeyPath: \"D.SlowSpecThreshold\", DeprecatedName: \"slow-spec-threshold\", SectionKey: \"output\", Usage: \"--slow-spec-threshold has been deprecated and will be removed in a future version of Ginkgo. This feature has proved to be more noisy than useful. You can use --poll-progress-after, instead, to get more actionable feedback about potentially slow specs and understand where they might be getting stuck.\", DeprecatedVersion: \"2.5.0\"},\n\t{KeyPath: \"D.AlwaysEmitGinkgoWriter\", DeprecatedName: \"always-emit-ginkgo-writer\", SectionKey: \"output\", Usage: \" - use -v instead, or one of Ginkgo's machine-readable report formats to get GinkgoWriter output for passing specs.\"},\n}\n\n// BuildTestSuiteFlagSet attaches to the CommandLine flagset and provides flags for the Ginkgo test process\nfunc BuildTestSuiteFlagSet(suiteConfig *SuiteConfig, reporterConfig *ReporterConfig) (GinkgoFlagSet, error) {\n\tflags := SuiteConfigFlags.CopyAppend(ParallelConfigFlags...).CopyAppend(ReporterConfigFlags...)\n\tflags = flags.WithPrefix(\"ginkgo\")\n\tbindings := map[string]any{\n\t\t\"S\": suiteConfig,\n\t\t\"R\": reporterConfig,\n\t\t\"D\": &deprecatedConfig{},\n\t}\n\textraGoFlagsSection := GinkgoFlagSection{Style: \"{{gray}}\", Heading: \"Go test flags\"}\n\n\treturn NewAttachedGinkgoFlagSet(flag.CommandLine, flags, bindings, FlagSections, extraGoFlagsSection)\n}\n\n// VetConfig validates that the Ginkgo test process' configuration is sound\nfunc VetConfig(flagSet GinkgoFlagSet, suiteConfig SuiteConfig, reporterConfig ReporterConfig) []error {\n\terrors := []error{}\n\n\tif flagSet.WasSet(\"count\") || flagSet.WasSet(\"test.count\") {\n\t\tflag := flagSet.Lookup(\"count\")\n\t\tif flag == nil {\n\t\t\tflag = flagSet.Lookup(\"test.count\")\n\t\t}\n\t\tcount, err := strconv.Atoi(flag.Value.String())\n\t\tif err != nil || count != 1 {\n\t\t\terrors = append(errors, GinkgoErrors.InvalidGoFlagCount())\n\t\t}\n\t}\n\n\tif flagSet.WasSet(\"parallel\") || flagSet.WasSet(\"test.parallel\") {\n\t\terrors = append(errors, GinkgoErrors.InvalidGoFlagParallel())\n\t}\n\n\tif suiteConfig.ParallelTotal < 1 {\n\t\terrors = append(errors, GinkgoErrors.InvalidParallelTotalConfiguration())\n\t}\n\n\tif suiteConfig.ParallelProcess > suiteConfig.ParallelTotal || suiteConfig.ParallelProcess < 1 {\n\t\terrors = append(errors, GinkgoErrors.InvalidParallelProcessConfiguration())\n\t}\n\n\tif suiteConfig.ParallelTotal > 1 && suiteConfig.ParallelHost == \"\" {\n\t\terrors = append(errors, GinkgoErrors.MissingParallelHostConfiguration())\n\t}\n\n\tif suiteConfig.DryRun && suiteConfig.ParallelTotal > 1 {\n\t\terrors = append(errors, GinkgoErrors.DryRunInParallelConfiguration())\n\t}\n\n\tif suiteConfig.GracePeriod <= 0 {\n\t\terrors = append(errors, GinkgoErrors.GracePeriodCannotBeZero())\n\t}\n\n\tif len(suiteConfig.FocusFiles) > 0 {\n\t\t_, err := ParseFileFilters(suiteConfig.FocusFiles)\n\t\tif err != nil {\n\t\t\terrors = append(errors, err)\n\t\t}\n\t}\n\n\tif len(suiteConfig.SkipFiles) > 0 {\n\t\t_, err := ParseFileFilters(suiteConfig.SkipFiles)\n\t\tif err != nil {\n\t\t\terrors = append(errors, err)\n\t\t}\n\t}\n\n\tif suiteConfig.LabelFilter != \"\" {\n\t\t_, err := ParseLabelFilter(suiteConfig.LabelFilter)\n\t\tif err != nil {\n\t\t\terrors = append(errors, err)\n\t\t}\n\t}\n\n\tif suiteConfig.SemVerFilter != \"\" {\n\t\t_, err := ParseSemVerFilter(suiteConfig.SemVerFilter)\n\t\tif err != nil {\n\t\t\terrors = append(errors, err)\n\t\t}\n\t}\n\n\tswitch strings.ToLower(suiteConfig.OutputInterceptorMode) {\n\tcase \"\", \"dup\", \"swap\", \"none\":\n\tdefault:\n\t\terrors = append(errors, GinkgoErrors.InvalidOutputInterceptorModeConfiguration(suiteConfig.OutputInterceptorMode))\n\t}\n\n\tnumVerbosity := 0\n\tfor _, v := range []bool{reporterConfig.Succinct, reporterConfig.Verbose, reporterConfig.VeryVerbose} {\n\t\tif v {\n\t\t\tnumVerbosity++\n\t\t}\n\t}\n\tif numVerbosity > 1 {\n\t\terrors = append(errors, GinkgoErrors.ConflictingVerbosityConfiguration())\n\t}\n\n\treturn errors\n}\n\n// GinkgoCLISharedFlags provides flags shared by the Ginkgo CLI's build, watch, and run commands\nvar GinkgoCLISharedFlags = GinkgoFlags{\n\t{KeyPath: \"C.Recurse\", Name: \"r\", SectionKey: \"multiple-suites\",\n\t\tUsage: \"If set, ginkgo finds and runs test suites under the current directory recursively.\"},\n\t{KeyPath: \"C.SkipPackage\", Name: \"skip-package\", SectionKey: \"multiple-suites\", DeprecatedName: \"skipPackage\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsageArgument: \"comma-separated list of packages\",\n\t\tUsage: \"A comma-separated list of package names to be skipped. If any part of the package's path matches, that package is ignored.\"},\n\t{KeyPath: \"C.RequireSuite\", Name: \"require-suite\", SectionKey: \"failure\", DeprecatedName: \"requireSuite\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, Ginkgo fails if there are ginkgo tests in a directory but no invocation of RunSpecs.\"},\n\t{KeyPath: \"C.NumCompilers\", Name: \"compilers\", SectionKey: \"multiple-suites\", UsageDefaultValue: \"0 (will autodetect)\",\n\t\tUsage: \"When running multiple packages, the number of concurrent compilations to perform.\"},\n}\n\n// GinkgoCLIRunAndWatchFlags provides flags shared by the Ginkgo CLI's build and watch commands (but not run)\nvar GinkgoCLIRunAndWatchFlags = GinkgoFlags{\n\t{KeyPath: \"C.Procs\", Name: \"procs\", SectionKey: \"parallel\", UsageDefaultValue: \"1 (run in series)\",\n\t\tUsage: \"The number of parallel test nodes to run.\"},\n\t{KeyPath: \"C.Procs\", Name: \"nodes\", SectionKey: \"parallel\", UsageDefaultValue: \"1 (run in series)\",\n\t\tUsage: \"--nodes is an alias for --procs\"},\n\t{KeyPath: \"C.Parallel\", Name: \"p\", SectionKey: \"parallel\",\n\t\tUsage: \"If set, ginkgo will run in parallel with an auto-detected number of nodes.\"},\n\t{KeyPath: \"C.AfterRunHook\", Name: \"after-run-hook\", SectionKey: \"misc\", DeprecatedName: \"afterSuiteHook\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"Command to run when a test suite completes.\"},\n\t{KeyPath: \"C.OutputDir\", Name: \"output-dir\", SectionKey: \"output\", UsageArgument: \"directory\", DeprecatedName: \"outputdir\", DeprecatedDocLink: \"improved-profiling-support\",\n\t\tUsage: \"A location to place all generated profiles and reports.\"},\n\t{KeyPath: \"C.KeepSeparateCoverprofiles\", Name: \"keep-separate-coverprofiles\", SectionKey: \"code-and-coverage-analysis\",\n\t\tUsage: \"If set, Ginkgo does not merge coverprofiles into one monolithic coverprofile. The coverprofiles will remain in their respective package directories or in -output-dir if set.\"},\n\t{KeyPath: \"C.KeepSeparateReports\", Name: \"keep-separate-reports\", SectionKey: \"output\",\n\t\tUsage: \"If set, Ginkgo does not merge per-suite reports (e.g. -json-report) into one monolithic report for the entire testrun. The reports will remain in their respective package directories or in -output-dir if set.\"},\n\n\t{KeyPath: \"D.Stream\", DeprecatedName: \"stream\", DeprecatedDocLink: \"removed--stream\", DeprecatedVersion: \"2.0.0\"},\n\t{KeyPath: \"D.Notify\", DeprecatedName: \"notify\", DeprecatedDocLink: \"removed--notify\", DeprecatedVersion: \"2.0.0\"},\n}\n\n// GinkgoCLIRunFlags provides flags for Ginkgo CLI's run command that aren't shared by any other commands\nvar GinkgoCLIRunFlags = GinkgoFlags{\n\t{KeyPath: \"C.KeepGoing\", Name: \"keep-going\", SectionKey: \"multiple-suites\", DeprecatedName: \"keepGoing\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, failures from earlier test suites do not prevent later test suites from running.\"},\n\t{KeyPath: \"C.UntilItFails\", Name: \"until-it-fails\", SectionKey: \"debug\", DeprecatedName: \"untilItFails\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, ginkgo will keep rerunning test suites until a failure occurs.\"},\n\t{KeyPath: \"C.Repeat\", Name: \"repeat\", SectionKey: \"debug\", UsageArgument: \"n\", UsageDefaultValue: \"0 - i.e. no repetition, run only once\",\n\t\tUsage: \"The number of times to re-run a test-suite. Useful for debugging flaky tests. If set to N the suite will be run N+1 times and will be required to pass each time.\"},\n\t{KeyPath: \"C.RandomizeSuites\", Name: \"randomize-suites\", SectionKey: \"order\", DeprecatedName: \"randomizeSuites\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsage: \"If set, ginkgo will randomize the order in which test suites run.\"},\n}\n\n// GinkgoCLIRunFlags provides flags for Ginkgo CLI's watch command that aren't shared by any other commands\nvar GinkgoCLIWatchFlags = GinkgoFlags{\n\t{KeyPath: \"C.Depth\", Name: \"depth\", SectionKey: \"watch\",\n\t\tUsage: \"Ginkgo will watch dependencies down to this depth in the dependency tree.\"},\n\t{KeyPath: \"C.WatchRegExp\", Name: \"watch-regexp\", SectionKey: \"watch\", DeprecatedName: \"watchRegExp\", DeprecatedDocLink: \"changed-command-line-flags\",\n\t\tUsageArgument: \"Regular Expression\",\n\t\tUsageDefaultValue: `\\.go$`,\n\t\tUsage: \"Only files matching this regular expression will be watched for changes.\"},\n}\n\n// GoBuildFlags provides flags for the Ginkgo CLI build, run, and watch commands that capture go's build-time flags. These are passed to go test -c by the ginkgo CLI\nvar GoBuildFlags = GinkgoFlags{\n\t{KeyPath: \"Go.Race\", Name: \"race\", SectionKey: \"code-and-coverage-analysis\",\n\t\tUsage: \"enable data race detection. Supported on linux/amd64, linux/ppc64le, linux/arm64, linux/s390x, freebsd/amd64, netbsd/amd64, darwin/amd64, darwin/arm64, and windows/amd64.\"},\n\t{KeyPath: \"Go.Vet\", Name: \"vet\", UsageArgument: \"list\", SectionKey: \"code-and-coverage-analysis\",\n\t\tUsage: `Configure the invocation of \"go vet\" during \"go test\" to use the comma-separated list of vet checks. If list is empty (by explicitly passing --vet=\"\"), \"go test\" runs \"go vet\" with a curated list of checks believed to be always worth addressing. If list is \"off\", \"go test\" does not run \"go vet\" at all. Available checks can be found by running 'go doc cmd/vet'`},\n\t{KeyPath: \"Go.Cover\", Name: \"cover\", SectionKey: \"code-and-coverage-analysis\",\n\t\tUsage: \"Enable coverage analysis.\tNote that because coverage works by annotating the source code before compilation, compilation and test failures with coverage enabled may report line numbers that don't correspond to the original sources.\"},\n\t{KeyPath: \"Go.CoverMode\", Name: \"covermode\", UsageArgument: \"set,count,atomic\", SectionKey: \"code-and-coverage-analysis\",\n\t\tUsage: `Set the mode for coverage analysis for the package[s] being tested. 'set': does this statement run? 'count': how many times does this statement run? 'atomic': like count, but correct in multithreaded tests and more expensive (must use atomic with -race). Sets -cover`},\n\t{KeyPath: \"Go.CoverPkg\", Name: \"coverpkg\", UsageArgument: \"pattern1,pattern2,pattern3\", SectionKey: \"code-and-coverage-analysis\",\n\t\tUsage: \"Apply coverage analysis in each test to packages matching the patterns. \tThe default is for each test to analyze only the package being tested. See 'go help packages' for a description of package patterns. Sets -cover.\"},\n\n\t{KeyPath: \"Go.A\", Name: \"a\", SectionKey: \"go-build\",\n\t\tUsage: \"force rebuilding of packages that are already up-to-date.\"},\n\t{KeyPath: \"Go.ASMFlags\", Name: \"asmflags\", UsageArgument: \"'[pattern=]arg list'\", SectionKey: \"go-build\",\n\t\tUsage: \"arguments to pass on each go tool asm invocation.\"},\n\t{KeyPath: \"Go.BuildMode\", Name: \"buildmode\", UsageArgument: \"mode\", SectionKey: \"go-build\",\n\t\tUsage: \"build mode to use. See 'go help buildmode' for more.\"},\n\t{KeyPath: \"Go.BuildVCS\", Name: \"buildvcs\", SectionKey: \"go-build\",\n\t\tUsage: \"adds version control information.\"},\n\t{KeyPath: \"Go.Compiler\", Name: \"compiler\", UsageArgument: \"name\", SectionKey: \"go-build\",\n\t\tUsage: \"name of compiler to use, as in runtime.Compiler (gccgo or gc).\"},\n\t{KeyPath: \"Go.GCCGoFlags\", Name: \"gccgoflags\", UsageArgument: \"'[pattern=]arg list'\", SectionKey: \"go-build\",\n\t\tUsage: \"arguments to pass on each gccgo compiler/linker invocation.\"},\n\t{KeyPath: \"Go.GCFlags\", Name: \"gcflags\", UsageArgument: \"'[pattern=]arg list'\", SectionKey: \"go-build\",\n\t\tUsage: \"arguments to pass on each go tool compile invocation.\"},\n\t{KeyPath: \"Go.InstallSuffix\", Name: \"installsuffix\", SectionKey: \"go-build\",\n\t\tUsage: \"a suffix to use in the name of the package installation directory, in order to keep output separate from default builds. If using the -race flag, the install suffix is automatically set to raceor, if set explicitly, has _race appended to it. Likewise for the -msan flag. Using a -buildmode option that requires non-default compile flags has a similar effect.\"},\n\t{KeyPath: \"Go.LDFlags\", Name: \"ldflags\", UsageArgument: \"'[pattern=]arg list'\", SectionKey: \"go-build\",\n\t\tUsage: \"arguments to pass on each go tool link invocation.\"},\n\t{KeyPath: \"Go.LinkShared\", Name: \"linkshared\", SectionKey: \"go-build\",\n\t\tUsage: \"build code that will be linked against shared libraries previously created with -buildmode=shared.\"},\n\t{KeyPath: \"Go.Mod\", Name: \"mod\", UsageArgument: \"mode (readonly, vendor, or mod)\", SectionKey: \"go-build\",\n\t\tUsage: \"module download mode to use: readonly, vendor, or mod. See 'go help modules' for more.\"},\n\t{KeyPath: \"Go.ModCacheRW\", Name: \"modcacherw\", SectionKey: \"go-build\",\n\t\tUsage: \"leave newly-created directories in the module cache read-write instead of making them read-only.\"},\n\t{KeyPath: \"Go.ModFile\", Name: \"modfile\", UsageArgument: \"file\", SectionKey: \"go-build\",\n\t\tUsage: `in module aware mode, read (and possibly write) an alternate go.mod file instead of the one in the module root directory. A file named go.mod must still be present in order to determine the module root directory, but it is not accessed. When -modfile is specified, an alternate go.sum file is also used: its path is derived from the -modfile flag by trimming the \".mod\" extension and appending \".sum\".`},\n\t{KeyPath: \"Go.MSan\", Name: \"msan\", SectionKey: \"go-build\",\n\t\tUsage: \"enable interoperation with memory sanitizer. Supported only on linux/amd64, linux/arm64 and only with Clang/LLVM as the host C compiler. On linux/arm64, pie build mode will be used.\"},\n\t{KeyPath: \"Go.N\", Name: \"n\", SectionKey: \"go-build\",\n\t\tUsage: \"print the commands but do not run them.\"},\n\t{KeyPath: \"Go.PkgDir\", Name: \"pkgdir\", UsageArgument: \"dir\", SectionKey: \"go-build\",\n\t\tUsage: \"install and load all packages from dir instead of the usual locations. For example, when building with a non-standard configuration, use -pkgdir to keep generated packages in a separate location.\"},\n\t{KeyPath: \"Go.Tags\", Name: \"tags\", UsageArgument: \"tag,list\", SectionKey: \"go-build\",\n\t\tUsage: \"a comma-separated list of build tags to consider satisfied during the build. For more information about build tags, see the description of build constraints in the documentation for the go/build package. (Earlier versions of Go used a space-separated list, and that form is deprecated but still recognized.)\"},\n\t{KeyPath: \"Go.TrimPath\", Name: \"trimpath\", SectionKey: \"go-build\",\n\t\tUsage: `remove all file system paths from the resulting executable. Instead of absolute file system paths, the recorded file names will begin with either \"go\" (for the standard library), or a module path@version (when using modules), or a plain import path (when using GOPATH).`},\n\t{KeyPath: \"Go.ToolExec\", Name: \"toolexec\", UsageArgument: \"'cmd args'\", SectionKey: \"go-build\",\n\t\tUsage: \"a program to use to invoke toolchain programs like vet and asm. For example, instead of running asm, the go command will run cmd args /path/to/asm '.\"},\n\t{KeyPath: \"Go.Work\", Name: \"work\", SectionKey: \"go-build\",\n\t\tUsage: \"print the name of the temporary work directory and do not delete it when exiting.\"},\n\t{KeyPath: \"Go.X\", Name: \"x\", SectionKey: \"go-build\",\n\t\tUsage: \"print the commands.\"},\n}\n\nvar GoBuildOFlags = GinkgoFlags{\n\t{KeyPath: \"Go.O\", Name: \"o\", SectionKey: \"go-build\",\n\t\tUsage: \"output binary path (including name).\"},\n}\n\n// GoRunFlags provides flags for the Ginkgo CLI run, and watch commands that capture go's run-time flags. These are passed to the compiled test binary by the ginkgo CLI\nvar GoRunFlags = GinkgoFlags{\n\t{KeyPath: \"Go.CoverProfile\", Name: \"coverprofile\", UsageArgument: \"file\", SectionKey: \"code-and-coverage-analysis\",\n\t\tUsage: `Write a coverage profile to the file after all tests have passed. Sets -cover. Must be passed a filename, not a path. Use output-dir to control the location of the output.`},\n\t{KeyPath: \"Go.BlockProfile\", Name: \"blockprofile\", UsageArgument: \"file\", SectionKey: \"performance-analysis\",\n\t\tUsage: `Write a goroutine blocking profile to the specified file when all tests are complete. Preserves test binary.`},\n\t{KeyPath: \"Go.BlockProfileRate\", Name: \"blockprofilerate\", UsageArgument: \"rate\", SectionKey: \"performance-analysis\",\n\t\tUsage: `Control the detail provided in goroutine blocking profiles by calling runtime.SetBlockProfileRate with rate. See 'go doc runtime.SetBlockProfileRate'. The profiler aims to sample, on average, one blocking event every n nanoseconds the program spends blocked. By default, if -test.blockprofile is set without this flag, all blocking events are recorded, equivalent to -test.blockprofilerate=1.`},\n\t{KeyPath: \"Go.CPUProfile\", Name: \"cpuprofile\", UsageArgument: \"file\", SectionKey: \"performance-analysis\",\n\t\tUsage: `Write a CPU profile to the specified file before exiting. Preserves test binary.`},\n\t{KeyPath: \"Go.MemProfile\", Name: \"memprofile\", UsageArgument: \"file\", SectionKey: \"performance-analysis\",\n\t\tUsage: `Write an allocation profile to the file after all tests have passed. Preserves test binary.`},\n\t{KeyPath: \"Go.MemProfileRate\", Name: \"memprofilerate\", UsageArgument: \"rate\", SectionKey: \"performance-analysis\",\n\t\tUsage: `Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate. See 'go doc runtime.MemProfileRate'. To profile all memory allocations, use -test.memprofilerate=1.`},\n\t{KeyPath: \"Go.MutexProfile\", Name: \"mutexprofile\", UsageArgument: \"file\", SectionKey: \"performance-analysis\",\n\t\tUsage: `Write a mutex contention profile to the specified file when all tests are complete. Preserves test binary.`},\n\t{KeyPath: \"Go.MutexProfileFraction\", Name: \"mutexprofilefraction\", UsageArgument: \"n\", SectionKey: \"performance-analysis\",\n\t\tUsage: `if >= 0, calls runtime.SetMutexProfileFraction()\tSample 1 in n stack traces of goroutines holding a contended mutex.`},\n\t{KeyPath: \"Go.Trace\", Name: \"execution-trace\", UsageArgument: \"file\", ExportAs: \"trace\", SectionKey: \"performance-analysis\",\n\t\tUsage: `Write an execution trace to the specified file before exiting.`},\n}\n\n// VetAndInitializeCLIAndGoConfig validates that the Ginkgo CLI's configuration is sound\n// It returns a potentially mutated copy of the config that rationalizes the configuration to ensure consistency for downstream consumers\nfunc VetAndInitializeCLIAndGoConfig(cliConfig CLIConfig, goFlagsConfig GoFlagsConfig) (CLIConfig, GoFlagsConfig, []error) {\n\terrors := []error{}\n\n\tif cliConfig.Repeat > 0 && cliConfig.UntilItFails {\n\t\terrors = append(errors, GinkgoErrors.BothRepeatAndUntilItFails())\n\t}\n\n\tif strings.ContainsRune(goFlagsConfig.CoverProfile, os.PathSeparator) {\n\t\terrors = append(errors, GinkgoErrors.ExpectFilenameNotPath(\"--coverprofile\", goFlagsConfig.CoverProfile))\n\t}\n\tif strings.ContainsRune(goFlagsConfig.CPUProfile, os.PathSeparator) {\n\t\terrors = append(errors, GinkgoErrors.ExpectFilenameNotPath(\"--cpuprofile\", goFlagsConfig.CPUProfile))\n\t}\n\tif strings.ContainsRune(goFlagsConfig.MemProfile, os.PathSeparator) {\n\t\terrors = append(errors, GinkgoErrors.ExpectFilenameNotPath(\"--memprofile\", goFlagsConfig.MemProfile))\n\t}\n\tif strings.ContainsRune(goFlagsConfig.BlockProfile, os.PathSeparator) {\n\t\terrors = append(errors, GinkgoErrors.ExpectFilenameNotPath(\"--blockprofile\", goFlagsConfig.BlockProfile))\n\t}\n\tif strings.ContainsRune(goFlagsConfig.MutexProfile, os.PathSeparator) {\n\t\terrors = append(errors, GinkgoErrors.ExpectFilenameNotPath(\"--mutexprofile\", goFlagsConfig.MutexProfile))\n\t}\n\n\t//initialize the output directory\n\tif cliConfig.OutputDir != \"\" {\n\t\terr := os.MkdirAll(cliConfig.OutputDir, 0777)\n\t\tif err != nil {\n\t\t\terrors = append(errors, err)\n\t\t}\n\t}\n\n\t//ensure cover mode is configured appropriately\n\tif goFlagsConfig.CoverMode != \"\" || goFlagsConfig.CoverPkg != \"\" || goFlagsConfig.CoverProfile != \"\" {\n\t\tgoFlagsConfig.Cover = true\n\t}\n\tif goFlagsConfig.Cover && goFlagsConfig.CoverProfile == \"\" {\n\t\tgoFlagsConfig.CoverProfile = \"coverprofile.out\"\n\t}\n\n\treturn cliConfig, goFlagsConfig, errors\n}\n\n// GenerateGoTestCompileArgs is used by the Ginkgo CLI to generate command line arguments to pass to the go test -c command when compiling the test\nfunc GenerateGoTestCompileArgs(goFlagsConfig GoFlagsConfig, packageToBuild string, pathToInvocationPath string, preserveSymbols bool) ([]string, error) {\n\t// if the user has set the CoverProfile run-time flag make sure to set the build-time cover flag to make sure\n\t// the built test binary can generate a coverprofile\n\tif goFlagsConfig.CoverProfile != \"\" {\n\t\tgoFlagsConfig.Cover = true\n\t}\n\n\tif goFlagsConfig.CoverPkg != \"\" {\n\t\tcoverPkgs := strings.Split(goFlagsConfig.CoverPkg, \",\")\n\t\tadjustedCoverPkgs := make([]string, len(coverPkgs))\n\t\tfor i, coverPkg := range coverPkgs {\n\t\t\tcoverPkg = strings.Trim(coverPkg, \" \")\n\t\t\tif strings.HasPrefix(coverPkg, \"./\") {\n\t\t\t\t// this is a relative coverPkg - we need to reroot it\n\t\t\t\tadjustedCoverPkgs[i] = \"./\" + filepath.Join(pathToInvocationPath, strings.TrimPrefix(coverPkg, \"./\"))\n\t\t\t} else {\n\t\t\t\t// this is a package name - don't touch it\n\t\t\t\tadjustedCoverPkgs[i] = coverPkg\n\t\t\t}\n\t\t}\n\t\tgoFlagsConfig.CoverPkg = strings.Join(adjustedCoverPkgs, \",\")\n\t}\n\n\tif !goFlagsConfig.NeedsSymbols() && goFlagsConfig.LDFlags == \"\" && !preserveSymbols {\n\t\tgoFlagsConfig.LDFlags = \"-w -s\"\n\t}\n\n\targs := []string{\"test\", \"-c\", packageToBuild}\n\tgoArgs, err := GenerateFlagArgs(\n\t\tGoBuildFlags.CopyAppend(GoBuildOFlags...),\n\t\tmap[string]any{\n\t\t\t\"Go\": &goFlagsConfig,\n\t\t},\n\t)\n\n\tif err != nil {\n\t\treturn []string{}, err\n\t}\n\targs = append(args, goArgs...)\n\treturn args, nil\n}\n\n// GenerateGinkgoTestRunArgs is used by the Ginkgo CLI to generate command line arguments to pass to the compiled Ginkgo test binary\nfunc GenerateGinkgoTestRunArgs(suiteConfig SuiteConfig, reporterConfig ReporterConfig, goFlagsConfig GoFlagsConfig) ([]string, error) {\n\tvar flags GinkgoFlags\n\tflags = SuiteConfigFlags.WithPrefix(\"ginkgo\")\n\tflags = flags.CopyAppend(ParallelConfigFlags.WithPrefix(\"ginkgo\")...)\n\tflags = flags.CopyAppend(ReporterConfigFlags.WithPrefix(\"ginkgo\")...)\n\tflags = flags.CopyAppend(GoRunFlags.WithPrefix(\"test\")...)\n\tbindings := map[string]any{\n\t\t\"S\": &suiteConfig,\n\t\t\"R\": &reporterConfig,\n\t\t\"Go\": &goFlagsConfig,\n\t}\n\n\treturn GenerateFlagArgs(flags, bindings)\n}\n\n// GenerateGoTestRunArgs is used by the Ginkgo CLI to generate command line arguments to pass to the compiled non-Ginkgo test binary\nfunc GenerateGoTestRunArgs(goFlagsConfig GoFlagsConfig) ([]string, error) {\n\tflags := GoRunFlags.WithPrefix(\"test\")\n\tbindings := map[string]any{\n\t\t\"Go\": &goFlagsConfig,\n\t}\n\n\targs, err := GenerateFlagArgs(flags, bindings)\n\tif err != nil {\n\t\treturn args, err\n\t}\n\targs = append(args, \"--test.v\")\n\treturn args, nil\n}\n\n// BuildRunCommandFlagSet builds the FlagSet for the `ginkgo run` command\nfunc BuildRunCommandFlagSet(suiteConfig *SuiteConfig, reporterConfig *ReporterConfig, cliConfig *CLIConfig, goFlagsConfig *GoFlagsConfig) (GinkgoFlagSet, error) {\n\tflags := SuiteConfigFlags\n\tflags = flags.CopyAppend(ReporterConfigFlags...)\n\tflags = flags.CopyAppend(GinkgoCLISharedFlags...)\n\tflags = flags.CopyAppend(GinkgoCLIRunAndWatchFlags...)\n\tflags = flags.CopyAppend(GinkgoCLIRunFlags...)\n\tflags = flags.CopyAppend(GoBuildFlags...)\n\tflags = flags.CopyAppend(GoRunFlags...)\n\n\tbindings := map[string]any{\n\t\t\"S\": suiteConfig,\n\t\t\"R\": reporterConfig,\n\t\t\"C\": cliConfig,\n\t\t\"Go\": goFlagsConfig,\n\t\t\"D\": &deprecatedConfig{},\n\t}\n\n\treturn NewGinkgoFlagSet(flags, bindings, FlagSections)\n}\n\n// BuildWatchCommandFlagSet builds the FlagSet for the `ginkgo watch` command\nfunc BuildWatchCommandFlagSet(suiteConfig *SuiteConfig, reporterConfig *ReporterConfig, cliConfig *CLIConfig, goFlagsConfig *GoFlagsConfig) (GinkgoFlagSet, error) {\n\tflags := SuiteConfigFlags\n\tflags = flags.CopyAppend(ReporterConfigFlags...)\n\tflags = flags.CopyAppend(GinkgoCLISharedFlags...)\n\tflags = flags.CopyAppend(GinkgoCLIRunAndWatchFlags...)\n\tflags = flags.CopyAppend(GinkgoCLIWatchFlags...)\n\tflags = flags.CopyAppend(GoBuildFlags...)\n\tflags = flags.CopyAppend(GoRunFlags...)\n\n\tbindings := map[string]any{\n\t\t\"S\": suiteConfig,\n\t\t\"R\": reporterConfig,\n\t\t\"C\": cliConfig,\n\t\t\"Go\": goFlagsConfig,\n\t\t\"D\": &deprecatedConfig{},\n\t}\n\n\treturn NewGinkgoFlagSet(flags, bindings, FlagSections)\n}\n\n// BuildBuildCommandFlagSet builds the FlagSet for the `ginkgo build` command\nfunc BuildBuildCommandFlagSet(cliConfig *CLIConfig, goFlagsConfig *GoFlagsConfig) (GinkgoFlagSet, error) {\n\tflags := GinkgoCLISharedFlags\n\tflags = flags.CopyAppend(GoBuildFlags...)\n\tflags = flags.CopyAppend(GoBuildOFlags...)\n\n\tbindings := map[string]any{\n\t\t\"C\": cliConfig,\n\t\t\"Go\": goFlagsConfig,\n\t\t\"D\": &deprecatedConfig{},\n\t}\n\n\tflagSections := make(GinkgoFlagSections, len(FlagSections))\n\tcopy(flagSections, FlagSections)\n\tfor i := range flagSections {\n\t\tif flagSections[i].Key == \"multiple-suites\" {\n\t\t\tflagSections[i].Heading = \"Building Multiple Suites\"\n\t\t}\n\t\tif flagSections[i].Key == \"go-build\" {\n\t\t\tflagSections[i] = GinkgoFlagSection{Key: \"go-build\", Style: \"{{/}}\", Heading: \"Go Build Flags\",\n\t\t\t\tDescription: \"These flags are inherited from go build.\"}\n\t\t}\n\t}\n\n\treturn NewGinkgoFlagSet(flags, bindings, flagSections)\n}\n\nfunc BuildLabelsCommandFlagSet(cliConfig *CLIConfig) (GinkgoFlagSet, error) {\n\tflags := GinkgoCLISharedFlags.SubsetWithNames(\"r\", \"skip-package\")\n\n\tbindings := map[string]any{\n\t\t\"C\": cliConfig,\n\t}\n\n\tflagSections := make(GinkgoFlagSections, len(FlagSections))\n\tcopy(flagSections, FlagSections)\n\tfor i := range flagSections {\n\t\tif flagSections[i].Key == \"multiple-suites\" {\n\t\t\tflagSections[i].Heading = \"Fetching Labels from Multiple Suites\"\n\t\t}\n\t}\n\n\treturn NewGinkgoFlagSet(flags, bindings, flagSections)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/deprecated_types.go",
"content": "package types\n\nimport (\n\t\"strconv\"\n\t\"time\"\n)\n\n/*\n\tA set of deprecations to make the transition from v1 to v2 easier for users who have written custom reporters.\n*/\n\ntype SuiteSummary = DeprecatedSuiteSummary\ntype SetupSummary = DeprecatedSetupSummary\ntype SpecSummary = DeprecatedSpecSummary\ntype SpecMeasurement = DeprecatedSpecMeasurement\ntype SpecComponentType = NodeType\ntype SpecFailure = DeprecatedSpecFailure\n\nvar (\n\tSpecComponentTypeInvalid = NodeTypeInvalid\n\tSpecComponentTypeContainer = NodeTypeContainer\n\tSpecComponentTypeIt = NodeTypeIt\n\tSpecComponentTypeBeforeEach = NodeTypeBeforeEach\n\tSpecComponentTypeJustBeforeEach = NodeTypeJustBeforeEach\n\tSpecComponentTypeAfterEach = NodeTypeAfterEach\n\tSpecComponentTypeJustAfterEach = NodeTypeJustAfterEach\n\tSpecComponentTypeBeforeSuite = NodeTypeBeforeSuite\n\tSpecComponentTypeSynchronizedBeforeSuite = NodeTypeSynchronizedBeforeSuite\n\tSpecComponentTypeAfterSuite = NodeTypeAfterSuite\n\tSpecComponentTypeSynchronizedAfterSuite = NodeTypeSynchronizedAfterSuite\n)\n\ntype DeprecatedSuiteSummary struct {\n\tSuiteDescription string\n\tSuiteSucceeded bool\n\tSuiteID string\n\n\tNumberOfSpecsBeforeParallelization int\n\tNumberOfTotalSpecs int\n\tNumberOfSpecsThatWillBeRun int\n\tNumberOfPendingSpecs int\n\tNumberOfSkippedSpecs int\n\tNumberOfPassedSpecs int\n\tNumberOfFailedSpecs int\n\tNumberOfFlakedSpecs int\n\tRunTime time.Duration\n}\n\ntype DeprecatedSetupSummary struct {\n\tComponentType SpecComponentType\n\tCodeLocation CodeLocation\n\n\tState SpecState\n\tRunTime time.Duration\n\tFailure SpecFailure\n\n\tCapturedOutput string\n\tSuiteID string\n}\n\ntype DeprecatedSpecSummary struct {\n\tComponentTexts []string\n\tComponentCodeLocations []CodeLocation\n\n\tState SpecState\n\tRunTime time.Duration\n\tFailure SpecFailure\n\tIsMeasurement bool\n\tNumberOfSamples int\n\tMeasurements map[string]*DeprecatedSpecMeasurement\n\n\tCapturedOutput string\n\tSuiteID string\n}\n\nfunc (s DeprecatedSpecSummary) HasFailureState() bool {\n\treturn s.State.Is(SpecStateFailureStates)\n}\n\nfunc (s DeprecatedSpecSummary) TimedOut() bool {\n\treturn false\n}\n\nfunc (s DeprecatedSpecSummary) Panicked() bool {\n\treturn s.State == SpecStatePanicked\n}\n\nfunc (s DeprecatedSpecSummary) Failed() bool {\n\treturn s.State == SpecStateFailed\n}\n\nfunc (s DeprecatedSpecSummary) Passed() bool {\n\treturn s.State == SpecStatePassed\n}\n\nfunc (s DeprecatedSpecSummary) Skipped() bool {\n\treturn s.State == SpecStateSkipped\n}\n\nfunc (s DeprecatedSpecSummary) Pending() bool {\n\treturn s.State == SpecStatePending\n}\n\ntype DeprecatedSpecFailure struct {\n\tMessage string\n\tLocation CodeLocation\n\tForwardedPanic string\n\n\tComponentIndex int\n\tComponentType SpecComponentType\n\tComponentCodeLocation CodeLocation\n}\n\ntype DeprecatedSpecMeasurement struct {\n\tName string\n\tInfo any\n\tOrder int\n\n\tResults []float64\n\n\tSmallest float64\n\tLargest float64\n\tAverage float64\n\tStdDeviation float64\n\n\tSmallestLabel string\n\tLargestLabel string\n\tAverageLabel string\n\tUnits string\n\tPrecision int\n}\n\nfunc (s DeprecatedSpecMeasurement) PrecisionFmt() string {\n\tif s.Precision == 0 {\n\t\treturn \"%f\"\n\t}\n\n\tstr := strconv.Itoa(s.Precision)\n\n\treturn \"%.\" + str + \"f\"\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/deprecation_support.go",
"content": "package types\n\nimport (\n\t\"os\"\n\t\"strconv\"\n\t\"strings\"\n\t\"sync\"\n\t\"unicode\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n)\n\ntype Deprecation struct {\n\tMessage string\n\tDocLink string\n\tVersion string\n}\n\ntype deprecations struct{}\n\nvar Deprecations = deprecations{}\n\nfunc (d deprecations) CustomReporter() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"Support for custom reporters has been removed in V2. Please read the documentation linked to below for Ginkgo's new behavior and for a migration path:\",\n\t\tDocLink: \"removed-custom-reporters\",\n\t\tVersion: \"1.16.0\",\n\t}\n}\n\nfunc (d deprecations) Async() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"You are passing a Done channel to a test node to test asynchronous behavior. This is deprecated in Ginkgo V2. Your test will run synchronously and the timeout will be ignored.\",\n\t\tDocLink: \"removed-async-testing\",\n\t\tVersion: \"1.16.0\",\n\t}\n}\n\nfunc (d deprecations) Measure() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"Measure is deprecated and has been removed from Ginkgo V2. Any Measure tests in your spec will not run. Please migrate to gomega/gmeasure.\",\n\t\tDocLink: \"removed-measure\",\n\t\tVersion: \"1.16.3\",\n\t}\n}\n\nfunc (d deprecations) ParallelNode() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"GinkgoParallelNode is deprecated and will be removed in Ginkgo V2. Please use GinkgoParallelProcess instead.\",\n\t\tDocLink: \"renamed-ginkgoparallelnode\",\n\t\tVersion: \"1.16.4\",\n\t}\n}\n\nfunc (d deprecations) CurrentGinkgoTestDescription() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"CurrentGinkgoTestDescription() is deprecated in Ginkgo V2. Use CurrentSpecReport() instead.\",\n\t\tDocLink: \"changed-currentginkgotestdescription\",\n\t\tVersion: \"1.16.0\",\n\t}\n}\n\nfunc (d deprecations) Convert() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"The convert command is deprecated in Ginkgo V2\",\n\t\tDocLink: \"removed-ginkgo-convert\",\n\t\tVersion: \"1.16.0\",\n\t}\n}\n\nfunc (d deprecations) Blur() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"The blur command is deprecated in Ginkgo V2. Use 'ginkgo unfocus' instead.\",\n\t\tVersion: \"1.16.0\",\n\t}\n}\n\nfunc (d deprecations) Nodot() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"The nodot command is deprecated in Ginkgo V2. Please either dot-import Ginkgo or use the package identifier in your code to references objects and types provided by Ginkgo and Gomega.\",\n\t\tDocLink: \"removed-ginkgo-nodot\",\n\t\tVersion: \"1.16.0\",\n\t}\n}\n\nfunc (d deprecations) SuppressProgressReporting() Deprecation {\n\treturn Deprecation{\n\t\tMessage: \"Improvements to how reporters emit timeline information means that SuppressProgressReporting is no longer necessary and has been deprecated.\",\n\t\tVersion: \"2.5.0\",\n\t}\n}\n\ntype DeprecationTracker struct {\n\tdeprecations map[Deprecation][]CodeLocation\n\tlock *sync.Mutex\n}\n\nfunc NewDeprecationTracker() *DeprecationTracker {\n\treturn &DeprecationTracker{\n\t\tdeprecations: map[Deprecation][]CodeLocation{},\n\t\tlock: &sync.Mutex{},\n\t}\n}\n\nfunc (d *DeprecationTracker) TrackDeprecation(deprecation Deprecation, cl ...CodeLocation) {\n\tackVersion := os.Getenv(\"ACK_GINKGO_DEPRECATIONS\")\n\tif deprecation.Version != \"\" && ackVersion != \"\" {\n\t\tack := ParseSemVer(ackVersion)\n\t\tversion := ParseSemVer(deprecation.Version)\n\t\tif ack.GreaterThanOrEqualTo(version) {\n\t\t\treturn\n\t\t}\n\t}\n\n\td.lock.Lock()\n\tdefer d.lock.Unlock()\n\tif len(cl) == 1 {\n\t\td.deprecations[deprecation] = append(d.deprecations[deprecation], cl[0])\n\t} else {\n\t\td.deprecations[deprecation] = []CodeLocation{}\n\t}\n}\n\nfunc (d *DeprecationTracker) DidTrackDeprecations() bool {\n\td.lock.Lock()\n\tdefer d.lock.Unlock()\n\treturn len(d.deprecations) > 0\n}\n\nfunc (d *DeprecationTracker) DeprecationsReport() string {\n\td.lock.Lock()\n\tdefer d.lock.Unlock()\n\tout := formatter.F(\"{{light-yellow}}You're using deprecated Ginkgo functionality:{{/}}\\n\")\n\tout += formatter.F(\"{{light-yellow}}============================================={{/}}\\n\")\n\tfor deprecation, locations := range d.deprecations {\n\t\tout += formatter.Fi(1, \"{{yellow}}\"+deprecation.Message+\"{{/}}\\n\")\n\t\tif deprecation.DocLink != \"\" {\n\t\t\tout += formatter.Fi(1, \"{{bold}}Learn more at:{{/}} {{cyan}}{{underline}}https://onsi.github.io/ginkgo/MIGRATING_TO_V2#%s{{/}}\\n\", deprecation.DocLink)\n\t\t}\n\t\tfor _, location := range locations {\n\t\t\tout += formatter.Fi(2, \"{{gray}}%s{{/}}\\n\", location)\n\t\t}\n\t}\n\tout += formatter.F(\"\\n{{gray}}To silence deprecations that can be silenced set the following environment variable:{{/}}\\n\")\n\tout += formatter.Fi(1, \"{{gray}}ACK_GINKGO_DEPRECATIONS=%s{{/}}\\n\", VERSION)\n\treturn out\n}\n\ntype SemVer struct {\n\tMajor int\n\tMinor int\n\tPatch int\n}\n\nfunc (s SemVer) GreaterThanOrEqualTo(o SemVer) bool {\n\treturn (s.Major > o.Major) ||\n\t\t(s.Major == o.Major && s.Minor > o.Minor) ||\n\t\t(s.Major == o.Major && s.Minor == o.Minor && s.Patch >= o.Patch)\n}\n\nfunc ParseSemVer(semver string) SemVer {\n\tout := SemVer{}\n\tsemver = strings.TrimFunc(semver, func(r rune) bool {\n\t\treturn !(unicode.IsNumber(r) || r == '.')\n\t})\n\tcomponents := strings.Split(semver, \".\")\n\tif len(components) > 0 {\n\t\tout.Major, _ = strconv.Atoi(components[0])\n\t}\n\tif len(components) > 1 {\n\t\tout.Minor, _ = strconv.Atoi(components[1])\n\t}\n\tif len(components) > 2 {\n\t\tout.Patch, _ = strconv.Atoi(components[2])\n\t}\n\treturn out\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/enum_support.go",
"content": "package types\n\nimport \"encoding/json\"\n\ntype EnumSupport struct {\n\ttoString map[uint]string\n\ttoEnum map[string]uint\n\tmaxEnum uint\n}\n\nfunc NewEnumSupport(toString map[uint]string) EnumSupport {\n\ttoEnum, maxEnum := map[string]uint{}, uint(0)\n\tfor k, v := range toString {\n\t\ttoEnum[v] = k\n\t\tif maxEnum < k {\n\t\t\tmaxEnum = k\n\t\t}\n\t}\n\treturn EnumSupport{toString: toString, toEnum: toEnum, maxEnum: maxEnum}\n}\n\nfunc (es EnumSupport) String(e uint) string {\n\tif e > es.maxEnum {\n\t\treturn es.toString[0]\n\t}\n\treturn es.toString[e]\n}\n\nfunc (es EnumSupport) UnmarshJSON(b []byte) (uint, error) {\n\tvar dec string\n\tif err := json.Unmarshal(b, &dec); err != nil {\n\t\treturn 0, err\n\t}\n\tout := es.toEnum[dec] // if we miss we get 0 which is what we want anyway\n\treturn out, nil\n}\n\nfunc (es EnumSupport) MarshJSON(e uint) ([]byte, error) {\n\tif e == 0 || e > es.maxEnum {\n\t\treturn json.Marshal(nil)\n\t}\n\treturn json.Marshal(es.toString[e])\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/errors.go",
"content": "package types\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\t\"strings\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n)\n\ntype GinkgoError struct {\n\tHeading string\n\tMessage string\n\tDocLink string\n\tCodeLocation CodeLocation\n}\n\nfunc (g GinkgoError) Error() string {\n\tout := formatter.F(\"{{bold}}{{red}}%s{{/}}\\n\", g.Heading)\n\tif (g.CodeLocation != CodeLocation{}) {\n\t\tcontentsOfLine := strings.TrimLeft(g.CodeLocation.ContentsOfLine(), \"\\t \")\n\t\tif contentsOfLine != \"\" {\n\t\t\tout += formatter.F(\"{{light-gray}}%s{{/}}\\n\", contentsOfLine)\n\t\t}\n\t\tout += formatter.F(\"{{gray}}%s{{/}}\\n\", g.CodeLocation)\n\t}\n\tif g.Message != \"\" {\n\t\tout += formatter.Fiw(1, formatter.COLS, g.Message)\n\t\tout += \"\\n\\n\"\n\t}\n\tif g.DocLink != \"\" {\n\t\tout += formatter.Fiw(1, formatter.COLS, \"{{bold}}Learn more at:{{/}} {{cyan}}{{underline}}http://onsi.github.io/ginkgo/#%s{{/}}\\n\", g.DocLink)\n\t}\n\n\treturn out\n}\n\ntype ginkgoErrors struct{}\n\nvar GinkgoErrors = ginkgoErrors{}\n\nfunc (g ginkgoErrors) UncaughtGinkgoPanic(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Your Test Panicked\",\n\t\tMessage: `When you, or your assertion library, calls Ginkgo's Fail(),\nGinkgo panics to prevent subsequent assertions from running.\n\nNormally Ginkgo rescues this panic so you shouldn't see it.\n\nHowever, if you make an assertion in a goroutine, Ginkgo can't capture the panic.\nTo circumvent this, you should call\n\n\tdefer GinkgoRecover()\n\nat the top of the goroutine that caused this panic.\n\nAlternatively, you may have made an assertion outside of a Ginkgo\nleaf node (e.g. in a container node or some out-of-band function) - please move your assertion to\nan appropriate Ginkgo node (e.g. a BeforeSuite, BeforeEach, It, etc...).`,\n\t\tDocLink: \"mental-model-how-ginkgo-handles-failure\",\n\t\tCodeLocation: cl,\n\t}\n}\n\nfunc (g ginkgoErrors) RerunningSuite() error {\n\treturn GinkgoError{\n\t\tHeading: \"Rerunning Suite\",\n\t\tMessage: formatter.F(`It looks like you are calling RunSpecs more than once. Ginkgo does not support rerunning suites. If you want to rerun a suite try {{bold}}ginkgo --repeat=N{{/}} or {{bold}}ginkgo --until-it-fails{{/}}`),\n\t\tDocLink: \"repeating-spec-runs-and-managing-flaky-specs\",\n\t}\n}\n\n/* Tree construction errors */\n\nfunc (g ginkgoErrors) PushingNodeInRunPhase(nodeType NodeType, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Ginkgo detected an issue with your spec structure\",\n\t\tMessage: formatter.F(\n\t\t\t`It looks like you are trying to add a {{bold}}[%s]{{/}} node\nto the Ginkgo spec tree in a leaf node {{bold}}after{{/}} the specs started running.\n\nTo enable randomization and parallelization Ginkgo requires the spec tree\nto be fully constructed up front. In practice, this means that you can\nonly create nodes like {{bold}}[%s]{{/}} at the top-level or within the\nbody of a {{bold}}Describe{{/}}, {{bold}}Context{{/}}, or {{bold}}When{{/}}.`, nodeType, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"mental-model-how-ginkgo-traverses-the-spec-hierarchy\",\n\t}\n}\n\nfunc (g ginkgoErrors) CaughtPanicDuringABuildPhase(caughtPanic any, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Assertion or Panic detected during tree construction\",\n\t\tMessage: formatter.F(\n\t\t\t`Ginkgo detected a panic while constructing the spec tree.\nYou may be trying to make an assertion in the body of a container node\n(i.e. {{bold}}Describe{{/}}, {{bold}}Context{{/}}, or {{bold}}When{{/}}).\n\nPlease ensure all assertions are inside leaf nodes such as {{bold}}BeforeEach{{/}},\n{{bold}}It{{/}}, etc.\n\n{{bold}}Here's the content of the panic that was caught:{{/}}\n%v`, caughtPanic),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"no-assertions-in-container-nodes\",\n\t}\n}\n\nfunc (g ginkgoErrors) SuiteNodeInNestedContext(nodeType NodeType, cl CodeLocation) error {\n\tdocLink := \"suite-setup-and-cleanup-beforesuite-and-aftersuite\"\n\tif nodeType.Is(NodeTypeReportBeforeSuite | NodeTypeReportAfterSuite) {\n\t\tdocLink = \"reporting-nodes---reportbeforesuite-and-reportaftersuite\"\n\t}\n\n\treturn GinkgoError{\n\t\tHeading: \"Ginkgo detected an issue with your spec structure\",\n\t\tMessage: formatter.F(\n\t\t\t`It looks like you are trying to add a {{bold}}[%s]{{/}} node within a container node.\n\n{{bold}}%s{{/}} can only be called at the top level.`, nodeType, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: docLink,\n\t}\n}\n\nfunc (g ginkgoErrors) SuiteNodeDuringRunPhase(nodeType NodeType, cl CodeLocation) error {\n\tdocLink := \"suite-setup-and-cleanup-beforesuite-and-aftersuite\"\n\tif nodeType.Is(NodeTypeReportBeforeSuite | NodeTypeReportAfterSuite) {\n\t\tdocLink = \"reporting-nodes---reportbeforesuite-and-reportaftersuite\"\n\t}\n\n\treturn GinkgoError{\n\t\tHeading: \"Ginkgo detected an issue with your spec structure\",\n\t\tMessage: formatter.F(\n\t\t\t`It looks like you are trying to add a {{bold}}[%s]{{/}} node within a leaf node after the spec started running.\n\n{{bold}}%s{{/}} can only be called at the top level.`, nodeType, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: docLink,\n\t}\n}\n\nfunc (g ginkgoErrors) MultipleBeforeSuiteNodes(nodeType NodeType, cl CodeLocation, earlierNodeType NodeType, earlierCodeLocation CodeLocation) error {\n\treturn ginkgoErrorMultipleSuiteNodes(\"setup\", nodeType, cl, earlierNodeType, earlierCodeLocation)\n}\n\nfunc (g ginkgoErrors) MultipleAfterSuiteNodes(nodeType NodeType, cl CodeLocation, earlierNodeType NodeType, earlierCodeLocation CodeLocation) error {\n\treturn ginkgoErrorMultipleSuiteNodes(\"teardown\", nodeType, cl, earlierNodeType, earlierCodeLocation)\n}\n\nfunc ginkgoErrorMultipleSuiteNodes(setupOrTeardown string, nodeType NodeType, cl CodeLocation, earlierNodeType NodeType, earlierCodeLocation CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Ginkgo detected an issue with your spec structure\",\n\t\tMessage: formatter.F(\n\t\t\t`It looks like you are trying to add a {{bold}}[%s]{{/}} node but\nyou already have a {{bold}}[%s]{{/}} node defined at: {{gray}}%s{{/}}.\n\nGinkgo only allows you to define one suite %s node.`, nodeType, earlierNodeType, earlierCodeLocation, setupOrTeardown),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"suite-setup-and-cleanup-beforesuite-and-aftersuite\",\n\t}\n}\n\n/* Decorator errors */\nfunc (g ginkgoErrors) InvalidDecoratorForNodeType(cl CodeLocation, nodeType NodeType, decorator string) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Decorator\",\n\t\tMessage: formatter.F(`[%s] node cannot be passed a(n) '%s' decorator`, nodeType, decorator),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidDeclarationOfFocusedAndPending(cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Combination of Decorators: Focused and Pending\",\n\t\tMessage: formatter.F(`[%s] node was decorated with both Focus and Pending. At most one is allowed.`, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidDeclarationOfFlakeAttemptsAndMustPassRepeatedly(cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Combination of Decorators: FlakeAttempts and MustPassRepeatedly\",\n\t\tMessage: formatter.F(`[%s] node was decorated with both FlakeAttempts and MustPassRepeatedly. At most one is allowed.`, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) UnknownDecorator(cl CodeLocation, nodeType NodeType, decorator any) error {\n\treturn GinkgoError{\n\t\tHeading: \"Unknown Decorator\",\n\t\tMessage: formatter.F(`[%s] node was passed an unknown decorator: '%#v'`, nodeType, decorator),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidBodyTypeForContainer(t reflect.Type, cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Function\",\n\t\tMessage: formatter.F(`[%s] node must be passed {{bold}}func(){{/}} - i.e. functions that take nothing and return nothing. You passed {{bold}}%s{{/}} instead.`, nodeType, t),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidBodyType(t reflect.Type, cl CodeLocation, nodeType NodeType) error {\n\tmustGet := \"{{bold}}func(){{/}}, {{bold}}func(ctx SpecContext){{/}}, or {{bold}}func(ctx context.Context){{/}}\"\n\tif nodeType.Is(NodeTypeContainer) {\n\t\tmustGet = \"{{bold}}func(){{/}}\"\n\t}\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Function\",\n\t\tMessage: formatter.F(`[%s] node must be passed `+mustGet+`.\nYou passed {{bold}}%s{{/}} instead.`, nodeType, t),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidBodyTypeForSynchronizedBeforeSuiteProc1(t reflect.Type, cl CodeLocation) error {\n\tmustGet := \"{{bold}}func() []byte{{/}}, {{bold}}func(ctx SpecContext) []byte{{/}}, or {{bold}}func(ctx context.Context) []byte{{/}}, {{bold}}func(){{/}}, {{bold}}func(ctx SpecContext){{/}}, or {{bold}}func(ctx context.Context){{/}}\"\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Function\",\n\t\tMessage: formatter.F(`[SynchronizedBeforeSuite] node must be passed `+mustGet+` for its first function.\nYou passed {{bold}}%s{{/}} instead.`, t),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidBodyTypeForSynchronizedBeforeSuiteAllProcs(t reflect.Type, cl CodeLocation) error {\n\tmustGet := \"{{bold}}func(){{/}}, {{bold}}func(ctx SpecContext){{/}}, or {{bold}}func(ctx context.Context){{/}}, {{bold}}func([]byte){{/}}, {{bold}}func(ctx SpecContext, []byte){{/}}, or {{bold}}func(ctx context.Context, []byte){{/}}\"\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Function\",\n\t\tMessage: formatter.F(`[SynchronizedBeforeSuite] node must be passed `+mustGet+` for its second function.\nYou passed {{bold}}%s{{/}} instead.`, t),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) MultipleBodyFunctions(cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: \"Multiple Functions\",\n\t\tMessage: formatter.F(`[%s] node must be passed a single function - but more than one was passed in.`, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) MissingBodyFunction(cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: \"Missing Functions\",\n\t\tMessage: formatter.F(`[%s] node must be passed a single function - but none was passed in.`, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidTimeoutOrGracePeriodForNonContextNode(cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid NodeTimeout SpecTimeout, or GracePeriod\",\n\t\tMessage: formatter.F(`[%s] was passed NodeTimeout, SpecTimeout, or GracePeriod but does not have a callback that accepts a {{bold}}SpecContext{{/}} or {{bold}}context.Context{{/}}. You must accept a context to enable timeouts and grace periods`, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"spec-timeouts-and-interruptible-nodes\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidTimeoutOrGracePeriodForNonContextCleanupNode(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid NodeTimeout SpecTimeout, or GracePeriod\",\n\t\tMessage: formatter.F(`[DeferCleanup] was passed NodeTimeout or GracePeriod but does not have a callback that accepts a {{bold}}SpecContext{{/}} or {{bold}}context.Context{{/}}. You must accept a context to enable timeouts and grace periods`),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"spec-timeouts-and-interruptible-nodes\",\n\t}\n}\n\n/* Ordered Container errors */\nfunc (g ginkgoErrors) InvalidSerialNodeInNonSerialOrderedContainer(cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Serial Node in Non-Serial Ordered Container\",\n\t\tMessage: formatter.F(`[%s] node was decorated with Serial but occurs in an Ordered container that is not marked Serial. Move the Serial decorator to the outer-most Ordered container to mark all ordered specs within the container as serial.`, nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"node-decorators-overview\",\n\t}\n}\n\nfunc (g ginkgoErrors) SetupNodeNotInOrderedContainer(cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: \"Setup Node not in Ordered Container\",\n\t\tMessage: fmt.Sprintf(\"[%s] setup nodes must appear inside an Ordered container. They cannot be nested within other containers, even containers in an ordered container.\", nodeType),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"ordered-containers\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidContinueOnFailureDecoration(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"ContinueOnFailure not decorating an outermost Ordered Container\",\n\t\tMessage: \"ContinueOnFailure can only decorate an Ordered container, and this Ordered container must be the outermost Ordered container.\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"ordered-containers\",\n\t}\n}\n\n/* DeferCleanup errors */\nfunc (g ginkgoErrors) DeferCleanupInvalidFunction(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"DeferCleanup requires a valid function\",\n\t\tMessage: \"You must pass DeferCleanup a function to invoke. This function must return zero or one values - if it does return, it must return an error. The function can take arbitrarily many arguments and you should provide these to DeferCleanup to pass along to the function.\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"cleaning-up-our-cleanup-code-defercleanup\",\n\t}\n}\n\nfunc (g ginkgoErrors) PushingCleanupNodeDuringTreeConstruction(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"DeferCleanup must be called inside a setup or subject node\",\n\t\tMessage: \"You must call DeferCleanup inside a setup node (e.g. BeforeEach, BeforeSuite, AfterAll...) or a subject node (i.e. It). You can't call DeferCleanup at the top-level or in a container node - use the After* family of setup nodes instead.\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"cleaning-up-our-cleanup-code-defercleanup\",\n\t}\n}\n\nfunc (g ginkgoErrors) PushingCleanupInReportingNode(cl CodeLocation, nodeType NodeType) error {\n\treturn GinkgoError{\n\t\tHeading: fmt.Sprintf(\"DeferCleanup cannot be called in %s\", nodeType),\n\t\tMessage: \"Please inline your cleanup code - Ginkgo won't run cleanup code after a Reporting node.\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"cleaning-up-our-cleanup-code-defercleanup\",\n\t}\n}\n\nfunc (g ginkgoErrors) PushingCleanupInCleanupNode(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"DeferCleanup cannot be called in a DeferCleanup callback\",\n\t\tMessage: \"Please inline your cleanup code - Ginkgo doesn't let you call DeferCleanup from within DeferCleanup\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"cleaning-up-our-cleanup-code-defercleanup\",\n\t}\n}\n\n/* ReportEntry errors */\nfunc (g ginkgoErrors) TooManyReportEntryValues(cl CodeLocation, arg any) error {\n\treturn GinkgoError{\n\t\tHeading: \"Too Many ReportEntry Values\",\n\t\tMessage: formatter.F(`{{bold}}AddGinkgoReport{{/}} can only be given one value. Got unexpected value: %#v`, arg),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"attaching-data-to-reports\",\n\t}\n}\n\nfunc (g ginkgoErrors) AddReportEntryNotDuringRunPhase(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Ginkgo detected an issue with your spec structure\",\n\t\tMessage: formatter.F(`It looks like you are calling {{bold}}AddGinkgoReport{{/}} outside of a running spec. Make sure you call {{bold}}AddGinkgoReport{{/}} inside a runnable node such as It or BeforeEach and not inside the body of a container such as Describe or Context.`),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"attaching-data-to-reports\",\n\t}\n}\n\n/* By errors */\nfunc (g ginkgoErrors) ByNotDuringRunPhase(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Ginkgo detected an issue with your spec structure\",\n\t\tMessage: formatter.F(`It looks like you are calling {{bold}}By{{/}} outside of a running spec. Make sure you call {{bold}}By{{/}} inside a runnable node such as It or BeforeEach and not inside the body of a container such as Describe or Context.`),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"documenting-complex-specs-by\",\n\t}\n}\n\n/* FileFilter and SkipFilter errors */\nfunc (g ginkgoErrors) InvalidFileFilter(filter string) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid File Filter\",\n\t\tMessage: fmt.Sprintf(`The provided file filter: \"%s\" is invalid. File filters must have the format \"file\", \"file:lines\" where \"file\" is a regular expression that will match against the file path and lines is a comma-separated list of integers (e.g. file:1,5,7) or line-ranges (e.g. file:1-3,5-9) or both (e.g. file:1,5-9)`, filter),\n\t\tDocLink: \"filtering-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidFileFilterRegularExpression(filter string, err error) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid File Filter Regular Expression\",\n\t\tMessage: fmt.Sprintf(`The provided file filter: \"%s\" included an invalid regular expression. regexp.Compile error: %s`, filter, err),\n\t\tDocLink: \"filtering-specs\",\n\t}\n}\n\n/* Label Errors */\nfunc (g ginkgoErrors) SyntaxErrorParsingLabelFilter(input string, location int, error string) error {\n\tvar message string\n\tif location >= 0 {\n\t\tfor i, r := range input {\n\t\t\tif i == location {\n\t\t\t\tmessage += \"{{red}}{{bold}}{{underline}}\"\n\t\t\t}\n\t\t\tmessage += string(r)\n\t\t\tif i == location {\n\t\t\t\tmessage += \"{{/}}\"\n\t\t\t}\n\t\t}\n\t} else {\n\t\tmessage = input\n\t}\n\tmessage += \"\\n\" + error\n\treturn GinkgoError{\n\t\tHeading: \"Syntax Error Parsing Label Filter\",\n\t\tMessage: message,\n\t\tDocLink: \"spec-labels\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidLabel(label string, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Label\",\n\t\tMessage: fmt.Sprintf(\"'%s' is an invalid label. Labels cannot contain of the following characters: '&|!,()/'\", label),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"spec-labels\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidEmptyLabel(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Empty Label\",\n\t\tMessage: \"Labels cannot be empty\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"spec-labels\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidSemVerConstraint(semVerConstraint, errMsg string, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid SemVerConstraint\",\n\t\tMessage: fmt.Sprintf(\"'%s' is an invalid SemVerConstraint: %s\", semVerConstraint, errMsg),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"spec-semantic-version-filtering\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidEmptySemVerConstraint(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Empty SemVerConstraint\",\n\t\tMessage: \"SemVerConstraint cannot be empty\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"spec-semantic-version-filtering\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidEmptyComponentForSemVerConstraint(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Empty Component for ComponentSemVerConstraint\",\n\t\tMessage: \"ComponentSemVerConstraint requires a non-empty component name\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"spec-semantic-version-filtering\",\n\t}\n}\n\n/* Table errors */\nfunc (g ginkgoErrors) MultipleEntryBodyFunctionsForTable(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"DescribeTable passed multiple functions\",\n\t\tMessage: \"It looks like you are passing multiple functions into DescribeTable. Only one function can be passed in. This function will be called for each Entry in the table.\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidEntryDescription(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Invalid Entry description\",\n\t\tMessage: \"Entry description functions must be a string, a function that accepts the entry parameters and returns a string, or nil.\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) MissingParametersForTableFunction(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"No parameters have been passed to the Table Function\",\n\t\tMessage: \"The Table Function expected at least 1 parameter\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) IncorrectParameterTypeForTable(i int, name string, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"DescribeTable passed incorrect parameter type\",\n\t\tMessage: fmt.Sprintf(\"Parameter #%d passed to DescribeTable is of incorrect type <%s>\", i, name),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) TooFewParametersToTableFunction(expected, actual int, kind string, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: fmt.Sprintf(\"Too few parameters passed in to %s\", kind),\n\t\tMessage: fmt.Sprintf(\"The %s expected %d parameters but you passed in %d\", kind, expected, actual),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) TooManyParametersToTableFunction(expected, actual int, kind string, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: fmt.Sprintf(\"Too many parameters passed in to %s\", kind),\n\t\tMessage: fmt.Sprintf(\"The %s expected %d parameters but you passed in %d\", kind, expected, actual),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) IncorrectParameterTypeToTableFunction(i int, expected, actual reflect.Type, kind string, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: fmt.Sprintf(\"Incorrect parameters type passed to %s\", kind),\n\t\tMessage: fmt.Sprintf(\"The %s expected parameter #%d to be of type <%s> but you passed in <%s>\", kind, i, expected, actual),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) IncorrectVariadicParameterTypeToTableFunction(expected, actual reflect.Type, kind string, cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: fmt.Sprintf(\"Incorrect parameters type passed to %s\", kind),\n\t\tMessage: fmt.Sprintf(\"The %s expected its variadic parameters to be of type <%s> but you passed in <%s>\", kind, expected, actual),\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\nfunc (g ginkgoErrors) ContextsCannotBeUsedInSubtreeTables(cl CodeLocation) error {\n\treturn GinkgoError{\n\t\tHeading: \"Contexts cannot be used in subtree tables\",\n\t\tMessage: \"You''ve defined a subtree body function that accepts a context but did not provide one in the table entry. Ginkgo SpecContexts can only be passed in to subject and setup nodes - so if you are trying to implement a spec timeout you should request a context in the It function within your subtree body function, not in the subtree body function itself.\",\n\t\tCodeLocation: cl,\n\t\tDocLink: \"table-specs\",\n\t}\n}\n\n/* Parallel Synchronization errors */\n\nfunc (g ginkgoErrors) AggregatedReportUnavailableDueToNodeDisappearing() error {\n\treturn GinkgoError{\n\t\tHeading: \"Test Report unavailable because a Ginkgo parallel process disappeared\",\n\t\tMessage: \"The aggregated report could not be fetched for a ReportAfterSuite node. A Ginkgo parallel process disappeared before it could finish reporting.\",\n\t}\n}\n\nfunc (g ginkgoErrors) SynchronizedBeforeSuiteFailedOnProc1() error {\n\treturn GinkgoError{\n\t\tHeading: \"SynchronizedBeforeSuite failed on Ginkgo parallel process #1\",\n\t\tMessage: \"The first SynchronizedBeforeSuite function running on Ginkgo parallel process #1 failed. This suite will now abort.\",\n\t}\n}\n\nfunc (g ginkgoErrors) SynchronizedBeforeSuiteDisappearedOnProc1() error {\n\treturn GinkgoError{\n\t\tHeading: \"Process #1 disappeared before SynchronizedBeforeSuite could report back\",\n\t\tMessage: \"Ginkgo parallel process #1 disappeared before the first SynchronizedBeforeSuite function completed. This suite will now abort.\",\n\t}\n}\n\n/* Configuration errors */\n\nfunc (g ginkgoErrors) UnknownTypePassedToRunSpecs(value any) error {\n\treturn GinkgoError{\n\t\tHeading: \"Unknown Type passed to RunSpecs\",\n\t\tMessage: fmt.Sprintf(\"RunSpecs() accepts labels, and configuration of type types.SuiteConfig and/or types.ReporterConfig.\\n You passed in: %v\", value),\n\t}\n}\n\nvar sharedParallelErrorMessage = \"It looks like you are trying to run specs in parallel with go test.\\nThis is unsupported and you should use the ginkgo CLI instead.\"\n\nfunc (g ginkgoErrors) InvalidParallelTotalConfiguration() error {\n\treturn GinkgoError{\n\t\tHeading: \"-ginkgo.parallel.total must be >= 1\",\n\t\tMessage: sharedParallelErrorMessage,\n\t\tDocLink: \"spec-parallelization\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidParallelProcessConfiguration() error {\n\treturn GinkgoError{\n\t\tHeading: \"-ginkgo.parallel.process is one-indexed and must be <= ginkgo.parallel.total\",\n\t\tMessage: sharedParallelErrorMessage,\n\t\tDocLink: \"spec-parallelization\",\n\t}\n}\n\nfunc (g ginkgoErrors) MissingParallelHostConfiguration() error {\n\treturn GinkgoError{\n\t\tHeading: \"-ginkgo.parallel.host is missing\",\n\t\tMessage: sharedParallelErrorMessage,\n\t\tDocLink: \"spec-parallelization\",\n\t}\n}\n\nfunc (g ginkgoErrors) UnreachableParallelHost(host string) error {\n\treturn GinkgoError{\n\t\tHeading: \"Could not reach ginkgo.parallel.host:\" + host,\n\t\tMessage: sharedParallelErrorMessage,\n\t\tDocLink: \"spec-parallelization\",\n\t}\n}\n\nfunc (g ginkgoErrors) DryRunInParallelConfiguration() error {\n\treturn GinkgoError{\n\t\tHeading: \"Ginkgo only performs -dryRun in serial mode.\",\n\t\tMessage: \"Please try running ginkgo -dryRun again, but without -p or -procs to ensure the suite is running in series.\",\n\t}\n}\n\nfunc (g ginkgoErrors) GracePeriodCannotBeZero() error {\n\treturn GinkgoError{\n\t\tHeading: \"Ginkgo requires a positive --grace-period.\",\n\t\tMessage: \"Please set --grace-period to a positive duration. The default is 30s.\",\n\t}\n}\n\nfunc (g ginkgoErrors) ConflictingVerbosityConfiguration() error {\n\treturn GinkgoError{\n\t\tHeading: \"Conflicting reporter verbosity settings.\",\n\t\tMessage: \"You can't set more than one of -v, -vv and --succinct. Please pick one!\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidOutputInterceptorModeConfiguration(value string) error {\n\treturn GinkgoError{\n\t\tHeading: fmt.Sprintf(\"Invalid value '%s' for --output-interceptor-mode.\", value),\n\t\tMessage: \"You must choose one of 'dup', 'swap', or 'none'.\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidGoFlagCount() error {\n\treturn GinkgoError{\n\t\tHeading: \"Use of go test -count\",\n\t\tMessage: \"Ginkgo does not support using go test -count to rerun suites. Only -count=1 is allowed. To repeat suite runs, please use the ginkgo cli and `ginkgo -until-it-fails` or `ginkgo -repeat=N`.\",\n\t}\n}\n\nfunc (g ginkgoErrors) InvalidGoFlagParallel() error {\n\treturn GinkgoError{\n\t\tHeading: \"Use of go test -parallel\",\n\t\tMessage: \"Go test's implementation of parallelization does not actually parallelize Ginkgo specs. Please use the ginkgo cli and `ginkgo -p` or `ginkgo -procs=N` instead.\",\n\t}\n}\n\nfunc (g ginkgoErrors) BothRepeatAndUntilItFails() error {\n\treturn GinkgoError{\n\t\tHeading: \"--repeat and --until-it-fails are both set\",\n\t\tMessage: \"--until-it-fails directs Ginkgo to rerun specs indefinitely until they fail. --repeat directs Ginkgo to rerun specs a set number of times. You can't set both... which would you like?\",\n\t}\n}\n\nfunc (g ginkgoErrors) ExpectFilenameNotPath(flag string, path string) error {\n\treturn GinkgoError{\n\t\tHeading: fmt.Sprintf(\"%s expects a filename but was given a path: %s\", flag, path),\n\t\tMessage: fmt.Sprintf(\"%s takes a filename, not a path. Use --output-dir to specify a directory to collect all test outputs.\", flag),\n\t}\n}\n\nfunc (g ginkgoErrors) FlagAfterPositionalParameter() error {\n\treturn GinkgoError{\n\t\tHeading: \"Malformed arguments - detected a flag after the package liste\",\n\t\tMessage: \"Make sure all flags appear {{bold}}after{{/}} the Ginkgo subcommand and {{bold}}before{{/}} your list of packages (or './...').\\n{{gray}}e.g. 'ginkgo run -p my_package' is valid but `ginkgo -p run my_package` is not.\\n{{gray}}e.g. 'ginkgo -p -vet=\\\"\\\" ./...' is valid but 'ginkgo -p ./... -vet=\\\"\\\"' is not{{/}}\",\n\t}\n}\n\n/* Stack-Trace parsing errors */\n\nfunc (g ginkgoErrors) FailedToParseStackTrace(message string) error {\n\treturn GinkgoError{\n\t\tHeading: \"Failed to Parse Stack Trace\",\n\t\tMessage: message,\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/file_filter.go",
"content": "package types\n\nimport (\n\t\"regexp\"\n\t\"strconv\"\n\t\"strings\"\n)\n\nfunc ParseFileFilters(filters []string) (FileFilters, error) {\n\tffs := FileFilters{}\n\tfor _, filter := range filters {\n\t\tff := FileFilter{}\n\t\tif filter == \"\" {\n\t\t\treturn nil, GinkgoErrors.InvalidFileFilter(filter)\n\t\t}\n\t\tcomponents := strings.Split(filter, \":\")\n\t\tif !(len(components) == 1 || len(components) == 2) {\n\t\t\treturn nil, GinkgoErrors.InvalidFileFilter(filter)\n\t\t}\n\n\t\tvar err error\n\t\tff.Filename, err = regexp.Compile(components[0])\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif len(components) == 2 {\n\t\t\tlineFilters := strings.Split(components[1], \",\")\n\t\t\tfor _, lineFilter := range lineFilters {\n\t\t\t\tcomponents := strings.Split(lineFilter, \"-\")\n\t\t\t\tif len(components) == 1 {\n\t\t\t\t\tline, err := strconv.Atoi(strings.TrimSpace(components[0]))\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn nil, GinkgoErrors.InvalidFileFilter(filter)\n\t\t\t\t\t}\n\t\t\t\t\tff.LineFilters = append(ff.LineFilters, LineFilter{line, line + 1})\n\t\t\t\t} else if len(components) == 2 {\n\t\t\t\t\tline1, err := strconv.Atoi(strings.TrimSpace(components[0]))\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn nil, GinkgoErrors.InvalidFileFilter(filter)\n\t\t\t\t\t}\n\t\t\t\t\tline2, err := strconv.Atoi(strings.TrimSpace(components[1]))\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn nil, GinkgoErrors.InvalidFileFilter(filter)\n\t\t\t\t\t}\n\t\t\t\t\tff.LineFilters = append(ff.LineFilters, LineFilter{line1, line2})\n\t\t\t\t} else {\n\t\t\t\t\treturn nil, GinkgoErrors.InvalidFileFilter(filter)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tffs = append(ffs, ff)\n\t}\n\treturn ffs, nil\n}\n\ntype FileFilter struct {\n\tFilename *regexp.Regexp\n\tLineFilters LineFilters\n}\n\nfunc (f FileFilter) Matches(locations []CodeLocation) bool {\n\tfor _, location := range locations {\n\t\tif f.Filename.MatchString(location.FileName) &&\n\t\t\tf.LineFilters.Matches(location.LineNumber) {\n\t\t\treturn true\n\t\t}\n\n\t}\n\treturn false\n}\n\ntype FileFilters []FileFilter\n\nfunc (ffs FileFilters) Matches(locations []CodeLocation) bool {\n\tfor _, ff := range ffs {\n\t\tif ff.Matches(locations) {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n\ntype LineFilter struct {\n\tMin int\n\tMax int\n}\n\nfunc (lf LineFilter) Matches(line int) bool {\n\treturn lf.Min <= line && line < lf.Max\n}\n\ntype LineFilters []LineFilter\n\nfunc (lfs LineFilters) Matches(line int) bool {\n\tif len(lfs) == 0 {\n\t\treturn true\n\t}\n\n\tfor _, lf := range lfs {\n\t\tif lf.Matches(line) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/flags.go",
"content": "package types\n\nimport (\n\t\"flag\"\n\t\"fmt\"\n\t\"io\"\n\t\"reflect\"\n\t\"strings\"\n\t\"time\"\n\n\t\"github.com/onsi/ginkgo/v2/formatter\"\n)\n\ntype GinkgoFlag struct {\n\tName string\n\tKeyPath string\n\tSectionKey string\n\n\tUsage string\n\tUsageArgument string\n\tUsageDefaultValue string\n\n\tDeprecatedName string\n\tDeprecatedDocLink string\n\tDeprecatedVersion string\n\n\tExportAs string\n\tAlwaysExport bool\n}\n\ntype GinkgoFlags []GinkgoFlag\n\nfunc (f GinkgoFlags) CopyAppend(flags ...GinkgoFlag) GinkgoFlags {\n\tout := GinkgoFlags{}\n\tout = append(out, f...)\n\tout = append(out, flags...)\n\treturn out\n}\n\nfunc (f GinkgoFlags) WithPrefix(prefix string) GinkgoFlags {\n\tif prefix == \"\" {\n\t\treturn f\n\t}\n\tout := GinkgoFlags{}\n\tfor _, flag := range f {\n\t\tif flag.Name != \"\" {\n\t\t\tflag.Name = prefix + \".\" + flag.Name\n\t\t}\n\t\tif flag.DeprecatedName != \"\" {\n\t\t\tflag.DeprecatedName = prefix + \".\" + flag.DeprecatedName\n\t\t}\n\t\tif flag.ExportAs != \"\" {\n\t\t\tflag.ExportAs = prefix + \".\" + flag.ExportAs\n\t\t}\n\t\tout = append(out, flag)\n\t}\n\treturn out\n}\n\nfunc (f GinkgoFlags) SubsetWithNames(names ...string) GinkgoFlags {\n\tout := GinkgoFlags{}\n\tfor _, flag := range f {\n\t\tfor _, name := range names {\n\t\t\tif flag.Name == name {\n\t\t\t\tout = append(out, flag)\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\treturn out\n}\n\ntype GinkgoFlagSection struct {\n\tKey string\n\tStyle string\n\tSuccinct bool\n\tHeading string\n\tDescription string\n}\n\ntype GinkgoFlagSections []GinkgoFlagSection\n\nfunc (gfs GinkgoFlagSections) Lookup(key string) (GinkgoFlagSection, bool) {\n\tfor _, section := range gfs {\n\t\tif section.Key == key {\n\t\t\treturn section, true\n\t\t}\n\t}\n\n\treturn GinkgoFlagSection{}, false\n}\n\ntype GinkgoFlagSet struct {\n\tflags GinkgoFlags\n\tbindings any\n\n\tsections GinkgoFlagSections\n\textraGoFlagsSection GinkgoFlagSection\n\n\tflagSet *flag.FlagSet\n}\n\n// Call NewGinkgoFlagSet to create GinkgoFlagSet that creates and binds to it's own *flag.FlagSet\nfunc NewGinkgoFlagSet(flags GinkgoFlags, bindings any, sections GinkgoFlagSections) (GinkgoFlagSet, error) {\n\treturn bindFlagSet(GinkgoFlagSet{\n\t\tflags: flags,\n\t\tbindings: bindings,\n\t\tsections: sections,\n\t}, nil)\n}\n\n// Call NewGinkgoFlagSet to create GinkgoFlagSet that extends an existing *flag.FlagSet\nfunc NewAttachedGinkgoFlagSet(flagSet *flag.FlagSet, flags GinkgoFlags, bindings any, sections GinkgoFlagSections, extraGoFlagsSection GinkgoFlagSection) (GinkgoFlagSet, error) {\n\treturn bindFlagSet(GinkgoFlagSet{\n\t\tflags: flags,\n\t\tbindings: bindings,\n\t\tsections: sections,\n\t\textraGoFlagsSection: extraGoFlagsSection,\n\t}, flagSet)\n}\n\nfunc bindFlagSet(f GinkgoFlagSet, flagSet *flag.FlagSet) (GinkgoFlagSet, error) {\n\tif flagSet == nil {\n\t\tf.flagSet = flag.NewFlagSet(\"\", flag.ContinueOnError)\n\t\t//suppress all output as Ginkgo is responsible for formatting usage\n\t\tf.flagSet.SetOutput(io.Discard)\n\t} else {\n\t\tf.flagSet = flagSet\n\t\t//we're piggybacking on an existing flagset (typically go test) so we have limited control\n\t\t//on user feedback\n\t\tf.flagSet.Usage = f.substituteUsage\n\t}\n\n\tfor _, flag := range f.flags {\n\t\tname := flag.Name\n\n\t\tdeprecatedUsage := \"[DEPRECATED]\"\n\t\tdeprecatedName := flag.DeprecatedName\n\t\tif name != \"\" {\n\t\t\tdeprecatedUsage = fmt.Sprintf(\"[DEPRECATED] use --%s instead\", name)\n\t\t} else if flag.Usage != \"\" {\n\t\t\tdeprecatedUsage += \" \" + flag.Usage\n\t\t}\n\n\t\tvalue, ok := valueAtKeyPath(f.bindings, flag.KeyPath)\n\t\tif !ok {\n\t\t\treturn GinkgoFlagSet{}, fmt.Errorf(\"could not load KeyPath: %s\", flag.KeyPath)\n\t\t}\n\n\t\tiface, addr := value.Interface(), value.Addr().Interface()\n\n\t\tswitch value.Type() {\n\t\tcase reflect.TypeOf(string(\"\")):\n\t\t\tif name != \"\" {\n\t\t\t\tf.flagSet.StringVar(addr.(*string), name, iface.(string), flag.Usage)\n\t\t\t}\n\t\t\tif deprecatedName != \"\" {\n\t\t\t\tf.flagSet.StringVar(addr.(*string), deprecatedName, iface.(string), deprecatedUsage)\n\t\t\t}\n\t\tcase reflect.TypeOf(int64(0)):\n\t\t\tif name != \"\" {\n\t\t\t\tf.flagSet.Int64Var(addr.(*int64), name, iface.(int64), flag.Usage)\n\t\t\t}\n\t\t\tif deprecatedName != \"\" {\n\t\t\t\tf.flagSet.Int64Var(addr.(*int64), deprecatedName, iface.(int64), deprecatedUsage)\n\t\t\t}\n\t\tcase reflect.TypeOf(float64(0)):\n\t\t\tif name != \"\" {\n\t\t\t\tf.flagSet.Float64Var(addr.(*float64), name, iface.(float64), flag.Usage)\n\t\t\t}\n\t\t\tif deprecatedName != \"\" {\n\t\t\t\tf.flagSet.Float64Var(addr.(*float64), deprecatedName, iface.(float64), deprecatedUsage)\n\t\t\t}\n\t\tcase reflect.TypeOf(int(0)):\n\t\t\tif name != \"\" {\n\t\t\t\tf.flagSet.IntVar(addr.(*int), name, iface.(int), flag.Usage)\n\t\t\t}\n\t\t\tif deprecatedName != \"\" {\n\t\t\t\tf.flagSet.IntVar(addr.(*int), deprecatedName, iface.(int), deprecatedUsage)\n\t\t\t}\n\t\tcase reflect.TypeOf(bool(true)):\n\t\t\tif name != \"\" {\n\t\t\t\tf.flagSet.BoolVar(addr.(*bool), name, iface.(bool), flag.Usage)\n\t\t\t}\n\t\t\tif deprecatedName != \"\" {\n\t\t\t\tf.flagSet.BoolVar(addr.(*bool), deprecatedName, iface.(bool), deprecatedUsage)\n\t\t\t}\n\t\tcase reflect.TypeOf(time.Duration(0)):\n\t\t\tif name != \"\" {\n\t\t\t\tf.flagSet.DurationVar(addr.(*time.Duration), name, iface.(time.Duration), flag.Usage)\n\t\t\t}\n\t\t\tif deprecatedName != \"\" {\n\t\t\t\tf.flagSet.DurationVar(addr.(*time.Duration), deprecatedName, iface.(time.Duration), deprecatedUsage)\n\t\t\t}\n\n\t\tcase reflect.TypeOf([]string{}):\n\t\t\tif name != \"\" {\n\t\t\t\tf.flagSet.Var(stringSliceVar{value}, name, flag.Usage)\n\t\t\t}\n\t\t\tif deprecatedName != \"\" {\n\t\t\t\tf.flagSet.Var(stringSliceVar{value}, deprecatedName, deprecatedUsage)\n\t\t\t}\n\t\tdefault:\n\t\t\treturn GinkgoFlagSet{}, fmt.Errorf(\"unsupported type %T\", iface)\n\t\t}\n\t}\n\n\treturn f, nil\n}\n\nfunc (f GinkgoFlagSet) IsZero() bool {\n\treturn f.flagSet == nil\n}\n\nfunc (f GinkgoFlagSet) WasSet(name string) bool {\n\tfound := false\n\tf.flagSet.Visit(func(f *flag.Flag) {\n\t\tif f.Name == name {\n\t\t\tfound = true\n\t\t}\n\t})\n\n\treturn found\n}\n\nfunc (f GinkgoFlagSet) Lookup(name string) *flag.Flag {\n\treturn f.flagSet.Lookup(name)\n}\n\nfunc (f GinkgoFlagSet) Parse(args []string) ([]string, error) {\n\tif f.IsZero() {\n\t\treturn args, nil\n\t}\n\terr := f.flagSet.Parse(args)\n\tif err != nil {\n\t\treturn []string{}, err\n\t}\n\treturn f.flagSet.Args(), nil\n}\n\nfunc (f GinkgoFlagSet) ValidateDeprecations(deprecationTracker *DeprecationTracker) {\n\tif f.IsZero() {\n\t\treturn\n\t}\n\tf.flagSet.Visit(func(flag *flag.Flag) {\n\t\tfor _, ginkgoFlag := range f.flags {\n\t\t\tif ginkgoFlag.DeprecatedName != \"\" && strings.HasSuffix(flag.Name, ginkgoFlag.DeprecatedName) {\n\t\t\t\tmessage := fmt.Sprintf(\"--%s is deprecated\", ginkgoFlag.DeprecatedName)\n\t\t\t\tif ginkgoFlag.Name != \"\" {\n\t\t\t\t\tmessage = fmt.Sprintf(\"--%s is deprecated, use --%s instead\", ginkgoFlag.DeprecatedName, ginkgoFlag.Name)\n\t\t\t\t} else if ginkgoFlag.Usage != \"\" {\n\t\t\t\t\tmessage += \" \" + ginkgoFlag.Usage\n\t\t\t\t}\n\n\t\t\t\tdeprecationTracker.TrackDeprecation(Deprecation{\n\t\t\t\t\tMessage: message,\n\t\t\t\t\tDocLink: ginkgoFlag.DeprecatedDocLink,\n\t\t\t\t\tVersion: ginkgoFlag.DeprecatedVersion,\n\t\t\t\t})\n\t\t\t}\n\t\t}\n\t})\n}\n\nfunc (f GinkgoFlagSet) Usage() string {\n\tif f.IsZero() {\n\t\treturn \"\"\n\t}\n\tgroupedFlags := map[GinkgoFlagSection]GinkgoFlags{}\n\tungroupedFlags := GinkgoFlags{}\n\tmanagedFlags := map[string]bool{}\n\textraGoFlags := []*flag.Flag{}\n\n\tfor _, flag := range f.flags {\n\t\tmanagedFlags[flag.Name] = true\n\t\tmanagedFlags[flag.DeprecatedName] = true\n\n\t\tif flag.Name == \"\" {\n\t\t\tcontinue\n\t\t}\n\n\t\tsection, ok := f.sections.Lookup(flag.SectionKey)\n\t\tif ok {\n\t\t\tgroupedFlags[section] = append(groupedFlags[section], flag)\n\t\t} else {\n\t\t\tungroupedFlags = append(ungroupedFlags, flag)\n\t\t}\n\t}\n\n\tf.flagSet.VisitAll(func(flag *flag.Flag) {\n\t\tif !managedFlags[flag.Name] {\n\t\t\textraGoFlags = append(extraGoFlags, flag)\n\t\t}\n\t})\n\n\tout := \"\"\n\tfor _, section := range f.sections {\n\t\tflags := groupedFlags[section]\n\t\tif len(flags) == 0 {\n\t\t\tcontinue\n\t\t}\n\t\tout += f.usageForSection(section)\n\t\tif section.Succinct {\n\t\t\tsuccinctFlags := []string{}\n\t\t\tfor _, flag := range flags {\n\t\t\t\tif flag.Name != \"\" {\n\t\t\t\t\tsuccinctFlags = append(succinctFlags, fmt.Sprintf(\"--%s\", flag.Name))\n\t\t\t\t}\n\t\t\t}\n\t\t\tout += formatter.Fiw(1, formatter.COLS, section.Style+strings.Join(succinctFlags, \", \")+\"{{/}}\\n\")\n\t\t} else {\n\t\t\tfor _, flag := range flags {\n\t\t\t\tout += f.usageForFlag(flag, section.Style)\n\t\t\t}\n\t\t}\n\t\tout += \"\\n\"\n\t}\n\tif len(ungroupedFlags) > 0 {\n\t\tfor _, flag := range ungroupedFlags {\n\t\t\tout += f.usageForFlag(flag, \"\")\n\t\t}\n\t\tout += \"\\n\"\n\t}\n\tif len(extraGoFlags) > 0 {\n\t\tout += f.usageForSection(f.extraGoFlagsSection)\n\t\tfor _, goFlag := range extraGoFlags {\n\t\t\tout += f.usageForGoFlag(goFlag)\n\t\t}\n\t}\n\n\treturn out\n}\n\nfunc (f GinkgoFlagSet) substituteUsage() {\n\tfmt.Fprintln(f.flagSet.Output(), f.Usage())\n}\n\nfunc valueAtKeyPath(root any, keyPath string) (reflect.Value, bool) {\n\tif len(keyPath) == 0 {\n\t\treturn reflect.Value{}, false\n\t}\n\n\tval := reflect.ValueOf(root)\n\tcomponents := strings.Split(keyPath, \".\")\n\tfor _, component := range components {\n\t\tval = reflect.Indirect(val)\n\t\tswitch val.Kind() {\n\t\tcase reflect.Map:\n\t\t\tval = val.MapIndex(reflect.ValueOf(component))\n\t\t\tif val.Kind() == reflect.Interface {\n\t\t\t\tval = reflect.ValueOf(val.Interface())\n\t\t\t}\n\t\tcase reflect.Struct:\n\t\t\tval = val.FieldByName(component)\n\t\tdefault:\n\t\t\treturn reflect.Value{}, false\n\t\t}\n\t\tif (val == reflect.Value{}) {\n\t\t\treturn reflect.Value{}, false\n\t\t}\n\t}\n\n\treturn val, true\n}\n\nfunc (f GinkgoFlagSet) usageForSection(section GinkgoFlagSection) string {\n\tout := formatter.F(section.Style + \"{{bold}}{{underline}}\" + section.Heading + \"{{/}}\\n\")\n\tif section.Description != \"\" {\n\t\tout += formatter.Fiw(0, formatter.COLS, section.Description+\"\\n\")\n\t}\n\treturn out\n}\n\nfunc (f GinkgoFlagSet) usageForFlag(flag GinkgoFlag, style string) string {\n\targument := flag.UsageArgument\n\tdefValue := flag.UsageDefaultValue\n\tif argument == \"\" {\n\t\tvalue, _ := valueAtKeyPath(f.bindings, flag.KeyPath)\n\t\tswitch value.Type() {\n\t\tcase reflect.TypeOf(string(\"\")):\n\t\t\targument = \"string\"\n\t\tcase reflect.TypeOf(int64(0)), reflect.TypeOf(int(0)):\n\t\t\targument = \"int\"\n\t\tcase reflect.TypeOf(time.Duration(0)):\n\t\t\targument = \"duration\"\n\t\tcase reflect.TypeOf(float64(0)):\n\t\t\targument = \"float\"\n\t\tcase reflect.TypeOf([]string{}):\n\t\t\targument = \"string\"\n\t\t}\n\t}\n\tif argument != \"\" {\n\t\targument = \"[\" + argument + \"] \"\n\t}\n\tif defValue != \"\" {\n\t\tdefValue = fmt.Sprintf(\"(default: %s)\", defValue)\n\t}\n\thyphens := \"--\"\n\tif len(flag.Name) == 1 {\n\t\thyphens = \"-\"\n\t}\n\n\tout := formatter.Fi(1, style+\"%s%s{{/}} %s{{gray}}%s{{/}}\\n\", hyphens, flag.Name, argument, defValue)\n\tout += formatter.Fiw(2, formatter.COLS, \"{{light-gray}}%s{{/}}\\n\", flag.Usage)\n\treturn out\n}\n\nfunc (f GinkgoFlagSet) usageForGoFlag(goFlag *flag.Flag) string {\n\t//Taken directly from the flag package\n\tout := fmt.Sprintf(\" -%s\", goFlag.Name)\n\tname, usage := flag.UnquoteUsage(goFlag)\n\tif len(name) > 0 {\n\t\tout += \" \" + name\n\t}\n\tif len(out) <= 4 {\n\t\tout += \"\\t\"\n\t} else {\n\t\tout += \"\\n \\t\"\n\t}\n\tout += strings.ReplaceAll(usage, \"\\n\", \"\\n \\t\")\n\tout += \"\\n\"\n\treturn out\n}\n\ntype stringSliceVar struct {\n\tslice reflect.Value\n}\n\nfunc (ssv stringSliceVar) String() string { return \"\" }\nfunc (ssv stringSliceVar) Set(s string) error {\n\tssv.slice.Set(reflect.AppendSlice(ssv.slice, reflect.ValueOf([]string{s})))\n\treturn nil\n}\n\n// given a set of GinkgoFlags and bindings, generate flag arguments suitable to be passed to an application with that set of flags configured.\nfunc GenerateFlagArgs(flags GinkgoFlags, bindings any) ([]string, error) {\n\tresult := []string{}\n\tfor _, flag := range flags {\n\t\tname := flag.ExportAs\n\t\tif name == \"\" {\n\t\t\tname = flag.Name\n\t\t}\n\t\tif name == \"\" {\n\t\t\tcontinue\n\t\t}\n\n\t\tvalue, ok := valueAtKeyPath(bindings, flag.KeyPath)\n\t\tif !ok {\n\t\t\treturn []string{}, fmt.Errorf(\"could not load KeyPath: %s\", flag.KeyPath)\n\t\t}\n\n\t\tiface := value.Interface()\n\t\tswitch value.Type() {\n\t\tcase reflect.TypeOf(string(\"\")):\n\t\t\tif iface.(string) != \"\" || flag.AlwaysExport {\n\t\t\t\tresult = append(result, fmt.Sprintf(\"--%s=%s\", name, iface))\n\t\t\t}\n\t\tcase reflect.TypeOf(int64(0)):\n\t\t\tif iface.(int64) != 0 || flag.AlwaysExport {\n\t\t\t\tresult = append(result, fmt.Sprintf(\"--%s=%d\", name, iface))\n\t\t\t}\n\t\tcase reflect.TypeOf(float64(0)):\n\t\t\tif iface.(float64) != 0 || flag.AlwaysExport {\n\t\t\t\tresult = append(result, fmt.Sprintf(\"--%s=%f\", name, iface))\n\t\t\t}\n\t\tcase reflect.TypeOf(int(0)):\n\t\t\tif iface.(int) != 0 || flag.AlwaysExport {\n\t\t\t\tresult = append(result, fmt.Sprintf(\"--%s=%d\", name, iface))\n\t\t\t}\n\t\tcase reflect.TypeOf(bool(true)):\n\t\t\tif iface.(bool) {\n\t\t\t\tresult = append(result, fmt.Sprintf(\"--%s\", name))\n\t\t\t}\n\t\tcase reflect.TypeOf(time.Duration(0)):\n\t\t\tif iface.(time.Duration) != time.Duration(0) || flag.AlwaysExport {\n\t\t\t\tresult = append(result, fmt.Sprintf(\"--%s=%s\", name, iface))\n\t\t\t}\n\n\t\tcase reflect.TypeOf([]string{}):\n\t\t\tstrings := iface.([]string)\n\t\t\tfor _, s := range strings {\n\t\t\t\tresult = append(result, fmt.Sprintf(\"--%s=%s\", name, s))\n\t\t\t}\n\t\tdefault:\n\t\t\treturn []string{}, fmt.Errorf(\"unsupported type %T\", iface)\n\t\t}\n\t}\n\n\treturn result, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/label_filter.go",
"content": "package types\n\nimport (\n\t\"fmt\"\n\t\"regexp\"\n\t\"strings\"\n)\n\nvar DEBUG_LABEL_FILTER_PARSING = false\n\ntype LabelFilter func([]string) bool\n\nfunc matchLabelAction(label string) LabelFilter {\n\texpected := strings.ToLower(label)\n\treturn func(labels []string) bool {\n\t\tfor i := range labels {\n\t\t\tif strings.ToLower(labels[i]) == expected {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t\treturn false\n\t}\n}\n\nfunc matchLabelRegexAction(regex *regexp.Regexp) LabelFilter {\n\treturn func(labels []string) bool {\n\t\tfor i := range labels {\n\t\t\tif regex.MatchString(labels[i]) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t\treturn false\n\t}\n}\n\nfunc notAction(filter LabelFilter) LabelFilter {\n\treturn func(labels []string) bool { return !filter(labels) }\n}\n\nfunc andAction(a, b LabelFilter) LabelFilter {\n\treturn func(labels []string) bool { return a(labels) && b(labels) }\n}\n\nfunc orAction(a, b LabelFilter) LabelFilter {\n\treturn func(labels []string) bool { return a(labels) || b(labels) }\n}\n\nfunc labelSetFor(key string, labels []string) map[string]bool {\n\tkey = strings.ToLower(strings.TrimSpace(key))\n\tout := map[string]bool{}\n\tfor _, label := range labels {\n\t\tcomponents := strings.SplitN(label, \":\", 2)\n\t\tif len(components) < 2 {\n\t\t\tcontinue\n\t\t}\n\t\tif key == strings.ToLower(strings.TrimSpace(components[0])) {\n\t\t\tout[strings.ToLower(strings.TrimSpace(components[1]))] = true\n\t\t}\n\t}\n\n\treturn out\n}\n\nfunc isEmptyLabelSetAction(key string) LabelFilter {\n\treturn func(labels []string) bool {\n\t\treturn len(labelSetFor(key, labels)) == 0\n\t}\n}\n\nfunc containsAnyLabelSetAction(key string, expectedValues []string) LabelFilter {\n\treturn func(labels []string) bool {\n\t\tset := labelSetFor(key, labels)\n\t\tfor _, value := range expectedValues {\n\t\t\tif set[value] {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t\treturn false\n\t}\n}\n\nfunc containsAllLabelSetAction(key string, expectedValues []string) LabelFilter {\n\treturn func(labels []string) bool {\n\t\tset := labelSetFor(key, labels)\n\t\tfor _, value := range expectedValues {\n\t\t\tif !set[value] {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\treturn true\n\t}\n}\n\nfunc consistsOfLabelSetAction(key string, expectedValues []string) LabelFilter {\n\treturn func(labels []string) bool {\n\t\tset := labelSetFor(key, labels)\n\t\tif len(set) != len(expectedValues) {\n\t\t\treturn false\n\t\t}\n\t\tfor _, value := range expectedValues {\n\t\t\tif !set[value] {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\treturn true\n\t}\n}\n\nfunc isSubsetOfLabelSetAction(key string, expectedValues []string) LabelFilter {\n\texpectedSet := map[string]bool{}\n\tfor _, value := range expectedValues {\n\t\texpectedSet[value] = true\n\t}\n\treturn func(labels []string) bool {\n\t\tset := labelSetFor(key, labels)\n\t\tfor value := range set {\n\t\t\tif !expectedSet[value] {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\treturn true\n\t}\n}\n\ntype lfToken uint\n\nconst (\n\tlfTokenInvalid lfToken = iota\n\n\tlfTokenRoot\n\tlfTokenOpenGroup\n\tlfTokenCloseGroup\n\tlfTokenNot\n\tlfTokenAnd\n\tlfTokenOr\n\tlfTokenRegexp\n\tlfTokenLabel\n\tlfTokenSetKey\n\tlfTokenSetOperation\n\tlfTokenSetArgument\n\tlfTokenEOF\n)\n\nfunc (l lfToken) Precedence() int {\n\tswitch l {\n\tcase lfTokenRoot, lfTokenOpenGroup:\n\t\treturn 0\n\tcase lfTokenOr:\n\t\treturn 1\n\tcase lfTokenAnd:\n\t\treturn 2\n\tcase lfTokenNot:\n\t\treturn 3\n\tcase lfTokenSetOperation:\n\t\treturn 4\n\t}\n\treturn -1\n}\n\nfunc (l lfToken) String() string {\n\tswitch l {\n\tcase lfTokenRoot:\n\t\treturn \"ROOT\"\n\tcase lfTokenOpenGroup:\n\t\treturn \"(\"\n\tcase lfTokenCloseGroup:\n\t\treturn \")\"\n\tcase lfTokenNot:\n\t\treturn \"!\"\n\tcase lfTokenAnd:\n\t\treturn \"&&\"\n\tcase lfTokenOr:\n\t\treturn \"||\"\n\tcase lfTokenRegexp:\n\t\treturn \"/regexp/\"\n\tcase lfTokenLabel:\n\t\treturn \"label\"\n\tcase lfTokenSetKey:\n\t\treturn \"set_key\"\n\tcase lfTokenSetOperation:\n\t\treturn \"set_operation\"\n\tcase lfTokenSetArgument:\n\t\treturn \"set_argument\"\n\tcase lfTokenEOF:\n\t\treturn \"EOF\"\n\t}\n\treturn \"INVALID\"\n}\n\ntype treeNode struct {\n\ttoken lfToken\n\tlocation int\n\tvalue string\n\n\tparent *treeNode\n\tleftNode *treeNode\n\trightNode *treeNode\n}\n\nfunc (tn *treeNode) setRightNode(node *treeNode) {\n\ttn.rightNode = node\n\tnode.parent = tn\n}\n\nfunc (tn *treeNode) setLeftNode(node *treeNode) {\n\ttn.leftNode = node\n\tnode.parent = tn\n}\n\nfunc (tn *treeNode) firstAncestorWithPrecedenceLEQ(precedence int) *treeNode {\n\tif tn.token.Precedence() <= precedence {\n\t\treturn tn\n\t}\n\treturn tn.parent.firstAncestorWithPrecedenceLEQ(precedence)\n}\n\nfunc (tn *treeNode) firstUnmatchedOpenNode() *treeNode {\n\tif tn.token == lfTokenOpenGroup {\n\t\treturn tn\n\t}\n\tif tn.parent == nil {\n\t\treturn nil\n\t}\n\treturn tn.parent.firstUnmatchedOpenNode()\n}\n\nfunc (tn *treeNode) constructLabelFilter(input string) (LabelFilter, error) {\n\tswitch tn.token {\n\tcase lfTokenOpenGroup:\n\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, tn.location, \"Mismatched '(' - could not find matching ')'.\")\n\tcase lfTokenLabel:\n\t\treturn matchLabelAction(tn.value), nil\n\tcase lfTokenRegexp:\n\t\tre, err := regexp.Compile(tn.value)\n\t\tif err != nil {\n\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, tn.location, fmt.Sprintf(\"RegExp compilation error: %s\", err))\n\t\t}\n\t\treturn matchLabelRegexAction(re), nil\n\tcase lfTokenSetOperation:\n\t\ttokenSetOperation := strings.ToLower(tn.value)\n\t\tif tokenSetOperation == \"isempty\" {\n\t\t\treturn isEmptyLabelSetAction(tn.leftNode.value), nil\n\t\t}\n\t\tif tn.rightNode == nil {\n\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, tn.location, fmt.Sprintf(\"Set operation '%s' is missing an argument.\", tn.value))\n\t\t}\n\n\t\trawValues := strings.Split(tn.rightNode.value, \",\")\n\t\tvalues := make([]string, len(rawValues))\n\t\tfor i := range rawValues {\n\t\t\tvalues[i] = strings.ToLower(strings.TrimSpace(rawValues[i]))\n\t\t\tif strings.ContainsAny(values[i], \"&|!,()/\") {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, tn.rightNode.location, fmt.Sprintf(\"Invalid label value '%s' in set operation argument.\", values[i]))\n\t\t\t} else if values[i] == \"\" {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, tn.rightNode.location, \"Empty label value in set operation argument.\")\n\t\t\t}\n\t\t}\n\t\tswitch tokenSetOperation {\n\t\tcase \"containsany\":\n\t\t\treturn containsAnyLabelSetAction(tn.leftNode.value, values), nil\n\t\tcase \"containsall\":\n\t\t\treturn containsAllLabelSetAction(tn.leftNode.value, values), nil\n\t\tcase \"consistsof\":\n\t\t\treturn consistsOfLabelSetAction(tn.leftNode.value, values), nil\n\t\tcase \"issubsetof\":\n\t\t\treturn isSubsetOfLabelSetAction(tn.leftNode.value, values), nil\n\t\t}\n\t}\n\n\tif tn.rightNode == nil {\n\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, -1, \"Unexpected EOF.\")\n\t}\n\trightLF, err := tn.rightNode.constructLabelFilter(input)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tswitch tn.token {\n\tcase lfTokenRoot, lfTokenCloseGroup:\n\t\treturn rightLF, nil\n\tcase lfTokenNot:\n\t\treturn notAction(rightLF), nil\n\t}\n\n\tif tn.leftNode == nil {\n\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, tn.location, fmt.Sprintf(\"Malformed tree - '%s' is missing left operand.\", tn.token))\n\t}\n\tleftLF, err := tn.leftNode.constructLabelFilter(input)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tswitch tn.token {\n\tcase lfTokenAnd:\n\t\treturn andAction(leftLF, rightLF), nil\n\tcase lfTokenOr:\n\t\treturn orAction(leftLF, rightLF), nil\n\t}\n\n\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, tn.location, fmt.Sprintf(\"Invalid token '%s'.\", tn.token))\n}\n\nfunc (tn *treeNode) tokenString() string {\n\tout := fmt.Sprintf(\"<%s\", tn.token)\n\tif tn.value != \"\" {\n\t\tout += \" | \" + tn.value\n\t}\n\tout += \">\"\n\treturn out\n}\n\nfunc (tn *treeNode) toString(indent int) string {\n\tout := tn.tokenString() + \"\\n\"\n\tif tn.leftNode != nil {\n\t\tout += fmt.Sprintf(\"%s |_(L)_%s\", strings.Repeat(\" \", indent), tn.leftNode.toString(indent+1))\n\t}\n\tif tn.rightNode != nil {\n\t\tout += fmt.Sprintf(\"%s |_(R)_%s\", strings.Repeat(\" \", indent), tn.rightNode.toString(indent+1))\n\t}\n\treturn out\n}\n\nvar validSetOperations = map[string]string{\n\t\"containsany\": \"containsAny\",\n\t\"containsall\": \"containsAll\",\n\t\"consistsof\": \"consistsOf\",\n\t\"issubsetof\": \"isSubsetOf\",\n\t\"isempty\": \"isEmpty\",\n}\n\nfunc tokenize(input string) func() (*treeNode, error) {\n\tlastToken := lfTokenInvalid\n\tlastValue := \"\"\n\trunes, i := []rune(input), 0\n\n\tpeekIs := func(r rune) bool {\n\t\tif i+1 < len(runes) {\n\t\t\treturn runes[i+1] == r\n\t\t}\n\t\treturn false\n\t}\n\n\tconsumeUntil := func(cutset string) (string, int) {\n\t\tj := i\n\t\tfor ; j < len(runes); j++ {\n\t\t\tif strings.ContainsRune(cutset, runes[j]) {\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\treturn string(runes[i:j]), j - i\n\t}\n\n\treturn func() (*treeNode, error) {\n\t\tfor i < len(runes) && runes[i] == ' ' {\n\t\t\ti += 1\n\t\t}\n\n\t\tif i >= len(runes) {\n\t\t\treturn &treeNode{token: lfTokenEOF}, nil\n\t\t}\n\n\t\tnode := &treeNode{location: i}\n\t\tdefer func() {\n\t\t\tlastToken = node.token\n\t\t\tlastValue = node.value\n\t\t}()\n\n\t\tif lastToken == lfTokenSetKey {\n\t\t\t//we should get a valid set operation next\n\t\t\tvalue, n := consumeUntil(\" )\")\n\t\t\tif validSetOperations[strings.ToLower(value)] == \"\" {\n\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, i, fmt.Sprintf(\"Invalid set operation '%s'.\", value))\n\t\t\t}\n\t\t\ti += n\n\t\t\tnode.token, node.value = lfTokenSetOperation, value\n\t\t\treturn node, nil\n\t\t}\n\t\tif lastToken == lfTokenSetOperation {\n\t\t\t//we should get an argument next, if we aren't isempty\n\t\t\tvar arg = \"\"\n\t\t\torigI := i\n\t\t\tif runes[i] == '{' {\n\t\t\t\ti += 1\n\t\t\t\tvalue, n := consumeUntil(\"}\")\n\t\t\t\tif i+n >= len(runes) {\n\t\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, i-1, \"Missing closing '}' in set operation argument?\")\n\t\t\t\t}\n\t\t\t\ti += n + 1\n\t\t\t\targ = value\n\t\t\t} else {\n\t\t\t\tvalue, n := consumeUntil(\"&|!,()/\")\n\t\t\t\ti += n\n\t\t\t\targ = strings.TrimSpace(value)\n\t\t\t}\n\t\t\tif strings.ToLower(lastValue) == \"isempty\" && arg != \"\" {\n\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, origI, fmt.Sprintf(\"isEmpty does not take arguments, was passed '%s'.\", arg))\n\t\t\t}\n\t\t\tif arg == \"\" && strings.ToLower(lastValue) != \"isempty\" {\n\t\t\t\tif i < len(runes) && runes[i] == '/' {\n\t\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, origI, \"Set operations do not support regular expressions.\")\n\t\t\t\t} else {\n\t\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, origI, fmt.Sprintf(\"Set operation '%s' requires an argument.\", lastValue))\n\t\t\t\t}\n\t\t\t}\n\t\t\t// note that we sent an empty SetArgument token if we are isempty\n\t\t\tnode.token, node.value = lfTokenSetArgument, arg\n\t\t\treturn node, nil\n\t\t}\n\n\t\tswitch runes[i] {\n\t\tcase '&':\n\t\t\tif !peekIs('&') {\n\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, i, \"Invalid token '&'. Did you mean '&&'?\")\n\t\t\t}\n\t\t\ti += 2\n\t\t\tnode.token = lfTokenAnd\n\t\tcase '|':\n\t\t\tif !peekIs('|') {\n\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, i, \"Invalid token '|'. Did you mean '||'?\")\n\t\t\t}\n\t\t\ti += 2\n\t\t\tnode.token = lfTokenOr\n\t\tcase '!':\n\t\t\ti += 1\n\t\t\tnode.token = lfTokenNot\n\t\tcase ',':\n\t\t\ti += 1\n\t\t\tnode.token = lfTokenOr\n\t\tcase '(':\n\t\t\ti += 1\n\t\t\tnode.token = lfTokenOpenGroup\n\t\tcase ')':\n\t\t\ti += 1\n\t\t\tnode.token = lfTokenCloseGroup\n\t\tcase '/':\n\t\t\ti += 1\n\t\t\tvalue, n := consumeUntil(\"/\")\n\t\t\ti += n + 1\n\t\t\tnode.token, node.value = lfTokenRegexp, value\n\t\tdefault:\n\t\t\tvalue, n := consumeUntil(\"&|!,()/:\")\n\t\t\ti += n\n\t\t\tvalue = strings.TrimSpace(value)\n\n\t\t\t//are we the beginning of a set operation?\n\t\t\tif i < len(runes) && runes[i] == ':' {\n\t\t\t\tif peekIs(' ') {\n\t\t\t\t\tif value == \"\" {\n\t\t\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, i, \"Missing set key.\")\n\t\t\t\t\t}\n\t\t\t\t\ti += 1\n\t\t\t\t\t//we are the beginning of a set operation\n\t\t\t\t\tnode.token, node.value = lfTokenSetKey, value\n\t\t\t\t\treturn node, nil\n\t\t\t\t}\n\t\t\t\tadditionalValue, n := consumeUntil(\"&|!,()/\")\n\t\t\t\tadditionalValue = strings.TrimSpace(additionalValue)\n\t\t\t\tif additionalValue == \":\" {\n\t\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, i, \"Missing set operation.\")\n\t\t\t\t}\n\t\t\t\ti += n\n\t\t\t\tvalue += additionalValue\n\t\t\t}\n\n\t\t\tvalueToCheckForSetOperation := strings.ToLower(value)\n\t\t\tfor setOperation := range validSetOperations {\n\t\t\t\tidx := strings.Index(valueToCheckForSetOperation, \" \"+setOperation)\n\t\t\t\tif idx > 0 {\n\t\t\t\t\treturn &treeNode{}, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, i-n+idx+1, fmt.Sprintf(\"Looks like you are using the set operator '%s' but did not provide a set key. Did you forget the ':'?\", validSetOperations[setOperation]))\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tnode.token, node.value = lfTokenLabel, strings.TrimSpace(value)\n\t\t}\n\t\treturn node, nil\n\t}\n}\n\nfunc MustParseLabelFilter(input string) LabelFilter {\n\tfilter, err := ParseLabelFilter(input)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treturn filter\n}\n\nfunc ParseLabelFilter(input string) (LabelFilter, error) {\n\tif DEBUG_LABEL_FILTER_PARSING {\n\t\tfmt.Println(\"\\n==============\")\n\t\tfmt.Println(\"Input: \", input)\n\t\tfmt.Print(\"Tokens: \")\n\t}\n\tif input == \"\" {\n\t\treturn func(_ []string) bool { return true }, nil\n\t}\n\tnextToken := tokenize(input)\n\n\troot := &treeNode{token: lfTokenRoot}\n\tcurrent := root\nLOOP:\n\tfor {\n\t\tnode, err := nextToken()\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tif DEBUG_LABEL_FILTER_PARSING {\n\t\t\tfmt.Print(node.tokenString() + \" \")\n\t\t}\n\n\t\tswitch node.token {\n\t\tcase lfTokenEOF:\n\t\t\tbreak LOOP\n\t\tcase lfTokenLabel, lfTokenRegexp, lfTokenSetKey:\n\t\t\tif current.rightNode != nil {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, node.location, \"Found two adjacent labels. You need an operator between them.\")\n\t\t\t}\n\t\t\tcurrent.setRightNode(node)\n\t\tcase lfTokenNot, lfTokenOpenGroup:\n\t\t\tif current.rightNode != nil {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, node.location, fmt.Sprintf(\"Invalid token '%s'.\", node.token))\n\t\t\t}\n\t\t\tcurrent.setRightNode(node)\n\t\t\tcurrent = node\n\t\tcase lfTokenAnd, lfTokenOr:\n\t\t\tif current.rightNode == nil {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, node.location, fmt.Sprintf(\"Operator '%s' missing left hand operand.\", node.token))\n\t\t\t}\n\t\t\tnodeToStealFrom := current.firstAncestorWithPrecedenceLEQ(node.token.Precedence())\n\t\t\tnode.setLeftNode(nodeToStealFrom.rightNode)\n\t\t\tnodeToStealFrom.setRightNode(node)\n\t\t\tcurrent = node\n\t\tcase lfTokenSetOperation:\n\t\t\tif current.rightNode == nil {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, node.location, fmt.Sprintf(\"Set operation '%s' missing left hand operand.\", node.value))\n\t\t\t}\n\t\t\tnode.setLeftNode(current.rightNode)\n\t\t\tcurrent.setRightNode(node)\n\t\t\tcurrent = node\n\t\tcase lfTokenSetArgument:\n\t\t\tif current.rightNode != nil {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, node.location, fmt.Sprintf(\"Unexpected set argument '%s'.\", node.token))\n\t\t\t}\n\t\t\tcurrent.setRightNode(node)\n\t\tcase lfTokenCloseGroup:\n\t\t\tfirstUnmatchedOpenNode := current.firstUnmatchedOpenNode()\n\t\t\tif firstUnmatchedOpenNode == nil {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, node.location, \"Mismatched ')' - could not find matching '('.\")\n\t\t\t}\n\t\t\tif firstUnmatchedOpenNode == current && current.rightNode == nil {\n\t\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, node.location, \"Found empty '()' group.\")\n\t\t\t}\n\t\t\tfirstUnmatchedOpenNode.token = lfTokenCloseGroup //signify the group is now closed\n\t\t\tcurrent = firstUnmatchedOpenNode.parent\n\t\tdefault:\n\t\t\treturn nil, GinkgoErrors.SyntaxErrorParsingLabelFilter(input, node.location, fmt.Sprintf(\"Unknown token '%s'.\", node.token))\n\t\t}\n\t}\n\tif DEBUG_LABEL_FILTER_PARSING {\n\t\tfmt.Printf(\"\\n Tree:\\n%s\", root.toString(0))\n\t}\n\treturn root.constructLabelFilter(input)\n}\n\nfunc ValidateAndCleanupLabel(label string, cl CodeLocation) (string, error) {\n\tout := strings.TrimSpace(label)\n\tif out == \"\" {\n\t\treturn \"\", GinkgoErrors.InvalidEmptyLabel(cl)\n\t}\n\tif strings.ContainsAny(out, \"&|!,()/\") {\n\t\treturn \"\", GinkgoErrors.InvalidLabel(label, cl)\n\t}\n\tif out[0] == ':' {\n\t\treturn \"\", GinkgoErrors.InvalidLabel(label, cl)\n\t}\n\tif strings.Contains(out, \":\") {\n\t\tcomponents := strings.SplitN(out, \":\", 2)\n\t\tif len(components) < 2 || components[1] == \"\" {\n\t\t\treturn \"\", GinkgoErrors.InvalidLabel(label, cl)\n\t\t}\n\t}\n\treturn out, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/report_entry.go",
"content": "package types\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"time\"\n)\n\n// ReportEntryValue wraps a report entry's value ensuring it can be encoded and decoded safely into reports\n// and across the network connection when running in parallel\ntype ReportEntryValue struct {\n\traw any //unexported to prevent gob from freaking out about unregistered structs\n\tAsJSON string\n\tRepresentation string\n}\n\nfunc WrapEntryValue(value any) ReportEntryValue {\n\treturn ReportEntryValue{\n\t\traw: value,\n\t}\n}\n\nfunc (rev ReportEntryValue) GetRawValue() any {\n\treturn rev.raw\n}\n\nfunc (rev ReportEntryValue) String() string {\n\tif rev.raw == nil {\n\t\treturn \"\"\n\t}\n\tif colorableStringer, ok := rev.raw.(ColorableStringer); ok {\n\t\treturn colorableStringer.ColorableString()\n\t}\n\n\tif stringer, ok := rev.raw.(fmt.Stringer); ok {\n\t\treturn stringer.String()\n\t}\n\tif rev.Representation != \"\" {\n\t\treturn rev.Representation\n\t}\n\treturn fmt.Sprintf(\"%+v\", rev.raw)\n}\n\nfunc (rev ReportEntryValue) MarshalJSON() ([]byte, error) {\n\t//All this to capture the representation at encoding-time, not creating time\n\t//This way users can Report on pointers and get their final values at reporting-time\n\tout := struct {\n\t\tAsJSON string\n\t\tRepresentation string\n\t}{\n\t\tRepresentation: rev.String(),\n\t}\n\tasJSON, err := json.Marshal(rev.raw)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tout.AsJSON = string(asJSON)\n\n\treturn json.Marshal(out)\n}\n\nfunc (rev *ReportEntryValue) UnmarshalJSON(data []byte) error {\n\tin := struct {\n\t\tAsJSON string\n\t\tRepresentation string\n\t}{}\n\terr := json.Unmarshal(data, &in)\n\tif err != nil {\n\t\treturn err\n\t}\n\trev.AsJSON = in.AsJSON\n\trev.Representation = in.Representation\n\treturn json.Unmarshal([]byte(in.AsJSON), &(rev.raw))\n}\n\nfunc (rev ReportEntryValue) GobEncode() ([]byte, error) {\n\treturn rev.MarshalJSON()\n}\n\nfunc (rev *ReportEntryValue) GobDecode(data []byte) error {\n\treturn rev.UnmarshalJSON(data)\n}\n\n// ReportEntry captures information attached to `SpecReport` via `AddReportEntry`\ntype ReportEntry struct {\n\t// Visibility captures the visibility policy for this ReportEntry\n\tVisibility ReportEntryVisibility\n\t// Location captures the location of the AddReportEntry call\n\tLocation CodeLocation\n\n\tTime time.Time //need this for backwards compatibility\n\tTimelineLocation TimelineLocation\n\n\t// Name captures the name of this report\n\tName string\n\t// Value captures the (optional) object passed into AddReportEntry - this can be\n\t// anything the user wants. The value passed to AddReportEntry is wrapped in a ReportEntryValue to make\n\t// encoding/decoding the value easier. To access the raw value call entry.GetRawValue()\n\tValue ReportEntryValue\n}\n\n// ColorableStringer is an interface that ReportEntry values can satisfy. If they do then ColorableString() is used to generate their representation.\ntype ColorableStringer interface {\n\tColorableString() string\n}\n\n// StringRepresentation() returns the string representation of the value associated with the ReportEntry --\n// if value is nil, empty string is returned\n// if value is a `ColorableStringer` then `Value.ColorableString()` is returned\n// if value is a `fmt.Stringer` then `Value.String()` is returned\n// otherwise the value is formatted with \"%+v\"\nfunc (entry ReportEntry) StringRepresentation() string {\n\treturn entry.Value.String()\n}\n\n// GetRawValue returns the Value object that was passed to AddReportEntry\n// If called in-process this will be the same object that was passed into AddReportEntry.\n// If used from a rehydrated JSON file _or_ in a ReportAfterSuite when running in parallel this will be\n// a JSON-decoded {}interface. If you want to reconstitute your original object you can decode the entry.Value.AsJSON\n// field yourself.\nfunc (entry ReportEntry) GetRawValue() any {\n\treturn entry.Value.GetRawValue()\n}\n\nfunc (entry ReportEntry) GetTimelineLocation() TimelineLocation {\n\treturn entry.TimelineLocation\n}\n\ntype ReportEntries []ReportEntry\n\nfunc (re ReportEntries) HasVisibility(visibilities ...ReportEntryVisibility) bool {\n\tfor _, entry := range re {\n\t\tif entry.Visibility.Is(visibilities...) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (re ReportEntries) WithVisibility(visibilities ...ReportEntryVisibility) ReportEntries {\n\tout := ReportEntries{}\n\n\tfor _, entry := range re {\n\t\tif entry.Visibility.Is(visibilities...) {\n\t\t\tout = append(out, entry)\n\t\t}\n\t}\n\n\treturn out\n}\n\n// ReportEntryVisibility governs the visibility of ReportEntries in Ginkgo's console reporter\ntype ReportEntryVisibility uint\n\nconst (\n\t// Always print out this ReportEntry\n\tReportEntryVisibilityAlways ReportEntryVisibility = iota\n\t// Only print out this ReportEntry if the spec fails or if the test is run with -v\n\tReportEntryVisibilityFailureOrVerbose\n\t// Never print out this ReportEntry (note that ReportEntrys are always encoded in machine readable reports (e.g. JSON, JUnit, etc.))\n\tReportEntryVisibilityNever\n)\n\nvar revEnumSupport = NewEnumSupport(map[uint]string{\n\tuint(ReportEntryVisibilityAlways): \"always\",\n\tuint(ReportEntryVisibilityFailureOrVerbose): \"failure-or-verbose\",\n\tuint(ReportEntryVisibilityNever): \"never\",\n})\n\nfunc (rev ReportEntryVisibility) String() string {\n\treturn revEnumSupport.String(uint(rev))\n}\nfunc (rev *ReportEntryVisibility) UnmarshalJSON(b []byte) error {\n\tout, err := revEnumSupport.UnmarshJSON(b)\n\t*rev = ReportEntryVisibility(out)\n\treturn err\n}\nfunc (rev ReportEntryVisibility) MarshalJSON() ([]byte, error) {\n\treturn revEnumSupport.MarshJSON(uint(rev))\n}\n\nfunc (v ReportEntryVisibility) Is(visibilities ...ReportEntryVisibility) bool {\n\tfor _, visibility := range visibilities {\n\t\tif v == visibility {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/semver_filter.go",
"content": "package types\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/Masterminds/semver/v3\"\n)\n\ntype SemVerFilter func(component string, constraints []string) bool\n\nfunc MustParseSemVerFilter(input string) SemVerFilter {\n\tfilter, err := ParseSemVerFilter(input)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\treturn filter\n}\n\n// ParseSemVerFilter parses non-component and component-specific semantic version filter string.\n// The filter string can contain multiple non-component and component-specific versions separated by commas.\n// Each component-specific version is in the format \"component=version\".\n// If a version is specified without a component, it applies to non-component-specific constraints.\nfunc ParseSemVerFilter(componentFilterVersions string) (SemVerFilter, error) {\n\tif componentFilterVersions == \"\" {\n\t\treturn func(_ string, _ []string) bool { return true }, nil\n\t}\n\n\tresult := map[string]*semver.Version{}\n\tparts := strings.Split(componentFilterVersions, \",\")\n\tfor _, part := range parts {\n\t\tpart = strings.TrimSpace(part)\n\t\tif len(part) == 0 {\n\t\t\tcontinue\n\t\t}\n\t\tif strings.Contains(part, \"=\") {\n\t\t\t// validate component-specific version string\n\t\t\tinvalidPart, invalidErr := false, fmt.Errorf(\"invalid component filter version: %s\", part)\n\t\t\tsubParts := strings.Split(part, \"=\")\n\t\t\tif len(subParts) != 2 {\n\t\t\t\tinvalidPart = true\n\t\t\t}\n\t\t\tcomponent := strings.TrimSpace(subParts[0])\n\t\t\tversionStr := strings.TrimSpace(subParts[1])\n\t\t\tif len(component) == 0 || len(versionStr) == 0 {\n\t\t\t\tinvalidPart = true\n\t\t\t}\n\t\t\tif invalidPart {\n\t\t\t\treturn nil, invalidErr\n\t\t\t}\n\n\t\t\t// validate semver\n\t\t\tv, err := semver.NewVersion(versionStr)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, fmt.Errorf(\"invalid component filter version: %s, error: %w\", part, err)\n\t\t\t}\n\t\t\tresult[component] = v\n\t\t} else {\n\t\t\tv, err := semver.NewVersion(part)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, fmt.Errorf(\"invalid filter version: %s, error: %w\", part, err)\n\t\t\t}\n\t\t\tresult[\"\"] = v\n\t\t}\n\t}\n\n\treturn func(component string, constraints []string) bool {\n\t\t// unconstrained specs always run\n\t\tif len(component) == 0 && len(constraints) == 0 {\n\t\t\treturn true\n\t\t}\n\n\t\t// check non-component specific version constraints\n\t\tif len(component) == 0 && len(constraints) != 0 {\n\t\t\tv := result[\"\"]\n\t\t\tif v != nil {\n\t\t\t\tfor _, constraintStr := range constraints {\n\t\t\t\t\tconstraint, err := semver.NewConstraint(constraintStr)\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\n\t\t\t\t\tif !constraint.Check(v) {\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// check component-specific version constraints\n\t\tif len(component) != 0 && len(constraints) != 0 {\n\t\t\tv := result[component]\n\t\t\tif v != nil {\n\t\t\t\tfor _, constraintStr := range constraints {\n\t\t\t\t\tconstraint, err := semver.NewConstraint(constraintStr)\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\n\t\t\t\t\tif !constraint.Check(v) {\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn true\n\t}, nil\n}\n\nfunc ValidateAndCleanupSemVerConstraint(semVerConstraint string, cl CodeLocation) (string, error) {\n\tif len(semVerConstraint) == 0 {\n\t\treturn \"\", GinkgoErrors.InvalidEmptySemVerConstraint(cl)\n\t}\n\t_, err := semver.NewConstraint(semVerConstraint)\n\tif err != nil {\n\t\treturn \"\", GinkgoErrors.InvalidSemVerConstraint(semVerConstraint, err.Error(), cl)\n\t}\n\n\treturn semVerConstraint, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/types.go",
"content": "package types\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"os\"\n\t\"slices\"\n\t\"sort\"\n\t\"strings\"\n\t\"time\"\n)\n\nconst GINKGO_FOCUS_EXIT_CODE = 197\n\nvar GINKGO_TIME_FORMAT = \"01/02/06 15:04:05.999\"\n\nfunc init() {\n\tif os.Getenv(\"GINKGO_TIME_FORMAT\") != \"\" {\n\t\tGINKGO_TIME_FORMAT = os.Getenv(\"GINKGO_TIME_FORMAT\")\n\t}\n}\n\n// ConstructionNodeReport captures information about a Ginkgo spec.\ntype ConstructionNodeReport struct {\n\t// ContainerHierarchyTexts is a slice containing the text strings of\n\t// all Describe/Context/When containers in this spec's hierarchy.\n\tContainerHierarchyTexts []string\n\n\t// ContainerHierarchyLocations is a slice containing the CodeLocations of\n\t// all Describe/Context/When containers in this spec's hierarchy.\n\tContainerHierarchyLocations []CodeLocation\n\n\t// ContainerHierarchyLabels is a slice containing the labels of\n\t// all Describe/Context/When containers in this spec's hierarchy\n\tContainerHierarchyLabels [][]string\n\n\t// ContainerHierarchySemVerConstraints is a slice containing the semVerConstraints of\n\t// all Describe/Context/When containers in this spec's hierarchy\n\tContainerHierarchySemVerConstraints [][]string\n\n\t// ContainerHierarchyComponentSemVerConstraints is a slice containing the component-specific semVerConstraints of\n\t// all Describe/Context/When containers in this spec's hierarchy\n\tContainerHierarchyComponentSemVerConstraints []map[string][]string\n\n\t// IsSerial captures whether the any container has the Serial decorator\n\tIsSerial bool\n\n\t// IsInOrderedContainer captures whether any container is an Ordered container\n\tIsInOrderedContainer bool\n}\n\n// FullText returns a concatenation of all the report.ContainerHierarchyTexts and report.LeafNodeText\nfunc (report ConstructionNodeReport) FullText() string {\n\ttexts := []string{}\n\ttexts = append(texts, report.ContainerHierarchyTexts...)\n\ttexts = slices.DeleteFunc(texts, func(t string) bool {\n\t\treturn t == \"\"\n\t})\n\treturn strings.Join(texts, \" \")\n}\n\n// Labels returns a deduped set of all the spec's Labels.\nfunc (report ConstructionNodeReport) Labels() []string {\n\tout := []string{}\n\tseen := map[string]bool{}\n\tfor _, labels := range report.ContainerHierarchyLabels {\n\t\tfor _, label := range labels {\n\t\t\tif !seen[label] {\n\t\t\t\tseen[label] = true\n\t\t\t\tout = append(out, label)\n\t\t\t}\n\t\t}\n\t}\n\n\treturn out\n}\n\n// Report captures information about a Ginkgo test run\ntype Report struct {\n\t//SuitePath captures the absolute path to the test suite\n\tSuitePath string\n\n\t//SuiteDescription captures the description string passed to the DSL's RunSpecs() function\n\tSuiteDescription string\n\n\t//SuiteLabels captures any labels attached to the suite by the DSL's RunSpecs() function\n\tSuiteLabels []string\n\n\t//SuiteSemVerConstraints captures any semVerConstraints attached to the suite by the DSL's RunSpecs() function\n\tSuiteSemVerConstraints []string\n\n\t//SuiteComponentSemVerConstraints captures any component-specific semVerConstraints attached to the suite by the DSL's RunSpecs() function\n\tSuiteComponentSemVerConstraints map[string][]string\n\n\t//SuiteSucceeded captures the success or failure status of the test run\n\t//If true, the test run is considered successful.\n\t//If false, the test run is considered unsuccessful\n\tSuiteSucceeded bool\n\n\t//SuiteHasProgrammaticFocus captures whether the test suite has a test or set of tests that are programmatically focused\n\t//(i.e an `FIt` or an `FDescribe`\n\tSuiteHasProgrammaticFocus bool\n\n\t//SpecialSuiteFailureReasons may contain special failure reasons\n\t//For example, a test suite might be considered \"failed\" even if none of the individual specs\n\t//have a failure state. For example, if the user has configured --fail-on-pending the test suite\n\t//will have failed if there are pending tests even though all non-pending tests may have passed. In such\n\t//cases, Ginkgo populates SpecialSuiteFailureReasons with a clear message indicating the reason for the failure.\n\t//SpecialSuiteFailureReasons is also populated if the test suite is interrupted by the user.\n\t//Since multiple special failure reasons can occur, this field is a slice.\n\tSpecialSuiteFailureReasons []string\n\n\t//PreRunStats contains a set of stats captured before the test run begins. This is primarily used\n\t//by Ginkgo's reporter to tell the user how many specs are in the current suite (PreRunStats.TotalSpecs)\n\t//and how many it intends to run (PreRunStats.SpecsThatWillRun) after applying any relevant focus or skip filters.\n\tPreRunStats PreRunStats\n\n\t//StartTime and EndTime capture the start and end time of the test run\n\tStartTime time.Time\n\tEndTime time.Time\n\n\t//RunTime captures the duration of the test run\n\tRunTime time.Duration\n\n\t//SuiteConfig captures the Ginkgo configuration governing this test run\n\t//SuiteConfig includes information necessary for reproducing an identical test run,\n\t//such as the random seed and any filters applied during the test run\n\tSuiteConfig SuiteConfig\n\n\t//SpecReports is a list of all SpecReports generated by this test run\n\t//It is empty when the SuiteReport is provided to ReportBeforeSuite\n\tSpecReports SpecReports\n}\n\n// PreRunStats contains a set of stats captured before the test run begins. This is primarily used\n// by Ginkgo's reporter to tell the user how many specs are in the current suite (PreRunStats.TotalSpecs)\n// and how many it intends to run (PreRunStats.SpecsThatWillRun) after applying any relevant focus or skip filters.\ntype PreRunStats struct {\n\tTotalSpecs int\n\tSpecsThatWillRun int\n}\n\n// Add is used by Ginkgo's parallel aggregation mechanisms to combine test run reports form individual parallel processes\n// to form a complete final report.\nfunc (report Report) Add(other Report) Report {\n\treport.SuiteSucceeded = report.SuiteSucceeded && other.SuiteSucceeded\n\n\tif other.StartTime.Before(report.StartTime) {\n\t\treport.StartTime = other.StartTime\n\t}\n\n\tif other.EndTime.After(report.EndTime) {\n\t\treport.EndTime = other.EndTime\n\t}\n\n\tspecialSuiteFailureReasons := []string{}\n\treasonsLookup := map[string]bool{}\n\tfor _, reasons := range [][]string{report.SpecialSuiteFailureReasons, other.SpecialSuiteFailureReasons} {\n\t\tfor _, reason := range reasons {\n\t\t\tif !reasonsLookup[reason] {\n\t\t\t\treasonsLookup[reason] = true\n\t\t\t\tspecialSuiteFailureReasons = append(specialSuiteFailureReasons, reason)\n\t\t\t}\n\t\t}\n\t}\n\treport.SpecialSuiteFailureReasons = specialSuiteFailureReasons\n\treport.RunTime = report.EndTime.Sub(report.StartTime)\n\n\treports := make(SpecReports, len(report.SpecReports)+len(other.SpecReports))\n\tcopy(reports, report.SpecReports)\n\toffset := len(report.SpecReports)\n\tfor i := range other.SpecReports {\n\t\treports[i+offset] = other.SpecReports[i]\n\t}\n\n\treport.SpecReports = reports\n\treturn report\n}\n\n// SpecReport captures information about a Ginkgo spec.\ntype SpecReport struct {\n\t// ContainerHierarchyTexts is a slice containing the text strings of\n\t// all Describe/Context/When containers in this spec's hierarchy.\n\tContainerHierarchyTexts []string\n\n\t// ContainerHierarchyLocations is a slice containing the CodeLocations of\n\t// all Describe/Context/When containers in this spec's hierarchy.\n\tContainerHierarchyLocations []CodeLocation\n\n\t// ContainerHierarchyLabels is a slice containing the labels of\n\t// all Describe/Context/When containers in this spec's hierarchy\n\tContainerHierarchyLabels [][]string\n\n\t// ContainerHierarchySemVerConstraints is a slice containing the semVerConstraints of\n\t// all Describe/Context/When containers in this spec's hierarchy\n\tContainerHierarchySemVerConstraints [][]string\n\n\t// ContainerHierarchyComponentSemVerConstraints is a slice containing the component-specific semVerConstraints of\n\t// all Describe/Context/When containers in this spec's hierarchy\n\tContainerHierarchyComponentSemVerConstraints []map[string][]string\n\n\t// LeafNodeType, LeafNodeLocation, LeafNodeLabels, LeafNodeSemVerConstraints and LeafNodeText capture the NodeType, CodeLocation, and text\n\t// of the Ginkgo node being tested (typically an NodeTypeIt node, though this can also be\n\t// one of the NodeTypesForSuiteLevelNodes node types)\n\tLeafNodeType NodeType\n\tLeafNodeLocation CodeLocation\n\tLeafNodeLabels []string\n\tLeafNodeSemVerConstraints []string\n\tLeafNodeComponentSemVerConstraints map[string][]string\n\tLeafNodeText string\n\n\t// Captures the Spec Priority\n\tSpecPriority int\n\n\t// State captures whether the spec has passed, failed, etc.\n\tState SpecState\n\n\t// IsSerial captures whether the spec has the Serial decorator\n\tIsSerial bool\n\n\t// IsInOrderedContainer captures whether the spec appears in an Ordered container\n\tIsInOrderedContainer bool\n\n\t// StartTime and EndTime capture the start and end time of the spec\n\tStartTime time.Time\n\tEndTime time.Time\n\n\t// RunTime captures the duration of the spec\n\tRunTime time.Duration\n\n\t// ParallelProcess captures the parallel process that this spec ran on\n\tParallelProcess int\n\n\t// RunningInParallel captures whether this spec is part of a suite that ran in parallel\n\tRunningInParallel bool\n\n\t//Failure is populated if a spec has failed, panicked, been interrupted, or skipped by the user (e.g. calling Skip())\n\t//It includes detailed information about the Failure\n\tFailure Failure\n\n\t// NumAttempts captures the number of times this Spec was run.\n\t// Flakey specs can be retried with ginkgo --flake-attempts=N or the use of the FlakeAttempts decorator.\n\t// Repeated specs can be retried with the use of the MustPassRepeatedly decorator\n\tNumAttempts int\n\n\t// MaxFlakeAttempts captures whether the spec has been retried with ginkgo --flake-attempts=N or the use of the FlakeAttempts decorator.\n\tMaxFlakeAttempts int\n\n\t// MaxMustPassRepeatedly captures whether the spec has the MustPassRepeatedly decorator\n\tMaxMustPassRepeatedly int\n\n\t// CapturedGinkgoWriterOutput contains text printed to the GinkgoWriter\n\tCapturedGinkgoWriterOutput string\n\n\t// CapturedStdOutErr contains text printed to stdout/stderr (when running in parallel)\n\t// This is always empty when running in series or calling CurrentSpecReport()\n\t// It is used internally by Ginkgo's reporter\n\tCapturedStdOutErr string\n\n\t// ReportEntries contains any reports added via `AddReportEntry`\n\tReportEntries ReportEntries\n\n\t// ProgressReports contains any progress reports generated during this spec. These can either be manually triggered, or automatically generated by Ginkgo via the PollProgressAfter() decorator\n\tProgressReports []ProgressReport\n\n\t// AdditionalFailures contains any failures that occurred after the initial spec failure. These typically occur in cleanup nodes after the initial failure and are only emitted when running in verbose mode.\n\tAdditionalFailures []AdditionalFailure\n\n\t// SpecEvents capture additional events that occur during the spec run\n\tSpecEvents SpecEvents\n}\n\nfunc (report SpecReport) MarshalJSON() ([]byte, error) {\n\t//All this to avoid emitting an empty Failure struct in the JSON\n\tout := struct {\n\t\tContainerHierarchyTexts []string\n\t\tContainerHierarchyLocations []CodeLocation\n\t\tContainerHierarchyLabels [][]string\n\t\tContainerHierarchySemVerConstraints [][]string\n\t\tContainerHierarchyComponentSemVerConstraints []map[string][]string\n\t\tLeafNodeType NodeType\n\t\tLeafNodeLocation CodeLocation\n\t\tLeafNodeLabels []string\n\t\tLeafNodeSemVerConstraints []string\n\t\tLeafNodeText string\n\t\tState SpecState\n\t\tStartTime time.Time\n\t\tEndTime time.Time\n\t\tRunTime time.Duration\n\t\tParallelProcess int\n\t\tFailure *Failure `json:\",omitempty\"`\n\t\tNumAttempts int\n\t\tMaxFlakeAttempts int\n\t\tMaxMustPassRepeatedly int\n\t\tCapturedGinkgoWriterOutput string `json:\",omitempty\"`\n\t\tCapturedStdOutErr string `json:\",omitempty\"`\n\t\tReportEntries ReportEntries `json:\",omitempty\"`\n\t\tProgressReports []ProgressReport `json:\",omitempty\"`\n\t\tAdditionalFailures []AdditionalFailure `json:\",omitempty\"`\n\t\tSpecEvents SpecEvents `json:\",omitempty\"`\n\t}{\n\t\tContainerHierarchyTexts: report.ContainerHierarchyTexts,\n\t\tContainerHierarchyLocations: report.ContainerHierarchyLocations,\n\t\tContainerHierarchyLabels: report.ContainerHierarchyLabels,\n\t\tContainerHierarchySemVerConstraints: report.ContainerHierarchySemVerConstraints,\n\t\tContainerHierarchyComponentSemVerConstraints: report.ContainerHierarchyComponentSemVerConstraints,\n\t\tLeafNodeType: report.LeafNodeType,\n\t\tLeafNodeLocation: report.LeafNodeLocation,\n\t\tLeafNodeLabels: report.LeafNodeLabels,\n\t\tLeafNodeSemVerConstraints: report.LeafNodeSemVerConstraints,\n\t\tLeafNodeText: report.LeafNodeText,\n\t\tState: report.State,\n\t\tStartTime: report.StartTime,\n\t\tEndTime: report.EndTime,\n\t\tRunTime: report.RunTime,\n\t\tParallelProcess: report.ParallelProcess,\n\t\tFailure: nil,\n\t\tReportEntries: nil,\n\t\tNumAttempts: report.NumAttempts,\n\t\tMaxFlakeAttempts: report.MaxFlakeAttempts,\n\t\tMaxMustPassRepeatedly: report.MaxMustPassRepeatedly,\n\t\tCapturedGinkgoWriterOutput: report.CapturedGinkgoWriterOutput,\n\t\tCapturedStdOutErr: report.CapturedStdOutErr,\n\t}\n\n\tif !report.Failure.IsZero() {\n\t\tout.Failure = &(report.Failure)\n\t}\n\tif len(report.ReportEntries) > 0 {\n\t\tout.ReportEntries = report.ReportEntries\n\t}\n\tif len(report.ProgressReports) > 0 {\n\t\tout.ProgressReports = report.ProgressReports\n\t}\n\tif len(report.AdditionalFailures) > 0 {\n\t\tout.AdditionalFailures = report.AdditionalFailures\n\t}\n\tif len(report.SpecEvents) > 0 {\n\t\tout.SpecEvents = report.SpecEvents\n\t}\n\n\treturn json.Marshal(out)\n}\n\n// CombinedOutput returns a single string representation of both CapturedStdOutErr and CapturedGinkgoWriterOutput\n// Note that both are empty when using CurrentSpecReport() so CurrentSpecReport().CombinedOutput() will always be empty.\n// CombinedOutput() is used internally by Ginkgo's reporter.\nfunc (report SpecReport) CombinedOutput() string {\n\tif report.CapturedStdOutErr == \"\" {\n\t\treturn report.CapturedGinkgoWriterOutput\n\t}\n\tif report.CapturedGinkgoWriterOutput == \"\" {\n\t\treturn report.CapturedStdOutErr\n\t}\n\treturn report.CapturedStdOutErr + \"\\n\" + report.CapturedGinkgoWriterOutput\n}\n\n// Failed returns true if report.State is one of the SpecStateFailureStates\n// (SpecStateFailed, SpecStatePanicked, SpecStateinterrupted, SpecStateAborted)\nfunc (report SpecReport) Failed() bool {\n\treturn report.State.Is(SpecStateFailureStates)\n}\n\n// FullText returns a concatenation of all the report.ContainerHierarchyTexts and report.LeafNodeText\nfunc (report SpecReport) FullText() string {\n\ttexts := []string{}\n\ttexts = append(texts, report.ContainerHierarchyTexts...)\n\tif report.LeafNodeText != \"\" {\n\t\ttexts = append(texts, report.LeafNodeText)\n\t}\n\ttexts = slices.DeleteFunc(texts, func(t string) bool {\n\t\treturn t == \"\"\n\t})\n\treturn strings.Join(texts, \" \")\n}\n\n// Labels returns a deduped set of all the spec's Labels.\nfunc (report SpecReport) Labels() []string {\n\tout := []string{}\n\tseen := map[string]bool{}\n\tfor _, labels := range report.ContainerHierarchyLabels {\n\t\tfor _, label := range labels {\n\t\t\tif !seen[label] {\n\t\t\t\tseen[label] = true\n\t\t\t\tout = append(out, label)\n\t\t\t}\n\t\t}\n\t}\n\tfor _, label := range report.LeafNodeLabels {\n\t\tif !seen[label] {\n\t\t\tseen[label] = true\n\t\t\tout = append(out, label)\n\t\t}\n\t}\n\n\treturn out\n}\n\n// SemVerConstraints returns a deduped set of all the spec's SemVerConstraints.\nfunc (report SpecReport) SemVerConstraints() []string {\n\tout := []string{}\n\tseen := map[string]bool{}\n\tfor _, semVerConstraints := range report.ContainerHierarchySemVerConstraints {\n\t\tfor _, semVerConstraint := range semVerConstraints {\n\t\t\tif !seen[semVerConstraint] {\n\t\t\t\tseen[semVerConstraint] = true\n\t\t\t\tout = append(out, semVerConstraint)\n\t\t\t}\n\t\t}\n\t}\n\tfor _, semVerConstraint := range report.LeafNodeSemVerConstraints {\n\t\tif !seen[semVerConstraint] {\n\t\t\tseen[semVerConstraint] = true\n\t\t\tout = append(out, semVerConstraint)\n\t\t}\n\t}\n\n\treturn out\n}\n\n// ComponentSemVerConstraints returns a deduped map of all the spec's component-specific SemVerConstraints.\nfunc (report SpecReport) ComponentSemVerConstraints() map[string][]string {\n\tout := map[string][]string{}\n\tseen := map[string]bool{}\n\tfor _, compSemVerConstraints := range report.ContainerHierarchyComponentSemVerConstraints {\n\t\tfor component := range compSemVerConstraints {\n\t\t\tif !seen[component] {\n\t\t\t\tseen[component] = true\n\t\t\t\tout[component] = compSemVerConstraints[component]\n\t\t\t} else {\n\t\t\t\tout[component] = append(out[component], compSemVerConstraints[component]...)\n\t\t\t\tout[component] = slices.Compact(out[component])\n\t\t\t}\n\t\t}\n\t}\n\tfor component := range report.LeafNodeComponentSemVerConstraints {\n\t\tif !seen[component] {\n\t\t\tseen[component] = true\n\t\t\tout[component] = report.LeafNodeComponentSemVerConstraints[component]\n\t\t} else {\n\t\t\tout[component] = append(out[component], report.LeafNodeComponentSemVerConstraints[component]...)\n\t\t\tout[component] = slices.Compact(out[component])\n\t\t}\n\t}\n\n\treturn out\n}\n\n// MatchesLabelFilter returns true if the spec satisfies the passed in label filter query\nfunc (report SpecReport) MatchesLabelFilter(query string) (bool, error) {\n\tfilter, err := ParseLabelFilter(query)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\treturn filter(report.Labels()), nil\n}\n\n// MatchesSemVerFilter returns true if the spec satisfies the passed in label filter query\nfunc (report SpecReport) MatchesSemVerFilter(version string) (bool, error) {\n\tfilter, err := ParseSemVerFilter(version)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\tsemVerConstraints := report.SemVerConstraints()\n\tif len(semVerConstraints) != 0 && filter(\"\", report.SemVerConstraints()) == false {\n\t\treturn false, nil\n\t}\n\n\tcomponentSemVerConstraints := report.ComponentSemVerConstraints()\n\tif len(componentSemVerConstraints) != 0 {\n\t\tfor component, constraints := range componentSemVerConstraints {\n\t\t\tif filter(component, constraints) == false {\n\t\t\t\treturn false, nil\n\t\t\t}\n\t\t}\n\t}\n\n\treturn true, nil\n}\n\n// FileName() returns the name of the file containing the spec\nfunc (report SpecReport) FileName() string {\n\treturn report.LeafNodeLocation.FileName\n}\n\n// LineNumber() returns the line number of the leaf node\nfunc (report SpecReport) LineNumber() int {\n\treturn report.LeafNodeLocation.LineNumber\n}\n\n// FailureMessage() returns the failure message (or empty string if the test hasn't failed)\nfunc (report SpecReport) FailureMessage() string {\n\treturn report.Failure.Message\n}\n\n// FailureLocation() returns the location of the failure (or an empty CodeLocation if the test hasn't failed)\nfunc (report SpecReport) FailureLocation() CodeLocation {\n\treturn report.Failure.Location\n}\n\n// Timeline() returns a timeline view of the report\nfunc (report SpecReport) Timeline() Timeline {\n\ttimeline := Timeline{}\n\tif !report.Failure.IsZero() {\n\t\ttimeline = append(timeline, report.Failure)\n\t\tif report.Failure.AdditionalFailure != nil {\n\t\t\ttimeline = append(timeline, *(report.Failure.AdditionalFailure))\n\t\t}\n\t}\n\tfor _, additionalFailure := range report.AdditionalFailures {\n\t\ttimeline = append(timeline, additionalFailure)\n\t}\n\tfor _, reportEntry := range report.ReportEntries {\n\t\ttimeline = append(timeline, reportEntry)\n\t}\n\tfor _, progressReport := range report.ProgressReports {\n\t\ttimeline = append(timeline, progressReport)\n\t}\n\tfor _, specEvent := range report.SpecEvents {\n\t\ttimeline = append(timeline, specEvent)\n\t}\n\tsort.Sort(timeline)\n\treturn timeline\n}\n\ntype SpecReports []SpecReport\n\n// WithLeafNodeType returns the subset of SpecReports with LeafNodeType matching one of the requested NodeTypes\nfunc (reports SpecReports) WithLeafNodeType(nodeTypes NodeType) SpecReports {\n\tcount := 0\n\tfor i := range reports {\n\t\tif reports[i].LeafNodeType.Is(nodeTypes) {\n\t\t\tcount++\n\t\t}\n\t}\n\n\tout := make(SpecReports, count)\n\tj := 0\n\tfor i := range reports {\n\t\tif reports[i].LeafNodeType.Is(nodeTypes) {\n\t\t\tout[j] = reports[i]\n\t\t\tj++\n\t\t}\n\t}\n\treturn out\n}\n\n// WithState returns the subset of SpecReports with State matching one of the requested SpecStates\nfunc (reports SpecReports) WithState(states SpecState) SpecReports {\n\tcount := 0\n\tfor i := range reports {\n\t\tif reports[i].State.Is(states) {\n\t\t\tcount++\n\t\t}\n\t}\n\n\tout, j := make(SpecReports, count), 0\n\tfor i := range reports {\n\t\tif reports[i].State.Is(states) {\n\t\t\tout[j] = reports[i]\n\t\t\tj++\n\t\t}\n\t}\n\treturn out\n}\n\n// CountWithState returns the number of SpecReports with State matching one of the requested SpecStates\nfunc (reports SpecReports) CountWithState(states SpecState) int {\n\tn := 0\n\tfor i := range reports {\n\t\tif reports[i].State.Is(states) {\n\t\t\tn += 1\n\t\t}\n\t}\n\treturn n\n}\n\n// If the Spec passes, CountOfFlakedSpecs returns the number of SpecReports that failed after multiple attempts.\nfunc (reports SpecReports) CountOfFlakedSpecs() int {\n\tn := 0\n\tfor i := range reports {\n\t\tif reports[i].MaxFlakeAttempts > 1 && reports[i].State.Is(SpecStatePassed) && reports[i].NumAttempts > 1 {\n\t\t\tn += 1\n\t\t}\n\t}\n\treturn n\n}\n\n// If the Spec fails, CountOfRepeatedSpecs returns the number of SpecReports that passed after multiple attempts\nfunc (reports SpecReports) CountOfRepeatedSpecs() int {\n\tn := 0\n\tfor i := range reports {\n\t\tif reports[i].MaxMustPassRepeatedly > 1 && reports[i].State.Is(SpecStateFailureStates) && reports[i].NumAttempts > 1 {\n\t\t\tn += 1\n\t\t}\n\t}\n\treturn n\n}\n\n// TimelineLocation captures the location of an event in the spec's timeline\ntype TimelineLocation struct {\n\t//Offset is the offset (in bytes) of the event relative to the GinkgoWriter stream\n\tOffset int `json:\",omitempty\"`\n\n\t//Order is the order of the event with respect to other events. The absolute value of Order\n\t//is irrelevant. All that matters is that an event with a lower Order occurs before ane vent with a higher Order\n\tOrder int `json:\",omitempty\"`\n\n\tTime time.Time\n}\n\n// TimelineEvent represent an event on the timeline\n// consumers of Timeline will need to check the concrete type of each entry to determine how to handle it\ntype TimelineEvent interface {\n\tGetTimelineLocation() TimelineLocation\n}\n\ntype Timeline []TimelineEvent\n\nfunc (t Timeline) Len() int { return len(t) }\nfunc (t Timeline) Less(i, j int) bool {\n\treturn t[i].GetTimelineLocation().Order < t[j].GetTimelineLocation().Order\n}\nfunc (t Timeline) Swap(i, j int) { t[i], t[j] = t[j], t[i] }\nfunc (t Timeline) WithoutHiddenReportEntries() Timeline {\n\tout := Timeline{}\n\tfor _, event := range t {\n\t\tif reportEntry, isReportEntry := event.(ReportEntry); isReportEntry && reportEntry.Visibility == ReportEntryVisibilityNever {\n\t\t\tcontinue\n\t\t}\n\t\tout = append(out, event)\n\t}\n\treturn out\n}\n\nfunc (t Timeline) WithoutVeryVerboseSpecEvents() Timeline {\n\tout := Timeline{}\n\tfor _, event := range t {\n\t\tif specEvent, isSpecEvent := event.(SpecEvent); isSpecEvent && specEvent.IsOnlyVisibleAtVeryVerbose() {\n\t\t\tcontinue\n\t\t}\n\t\tout = append(out, event)\n\t}\n\treturn out\n}\n\n// Failure captures failure information for an individual test\ntype Failure struct {\n\t// Message - the failure message passed into Fail(...). When using a matcher library\n\t// like Gomega, this will contain the failure message generated by Gomega.\n\t//\n\t// Message is also populated if the user has called Skip(...).\n\tMessage string\n\n\t// Location - the CodeLocation where the failure occurred\n\t// This CodeLocation will include a fully-populated StackTrace\n\tLocation CodeLocation\n\n\tTimelineLocation TimelineLocation\n\n\t// ForwardedPanic - if the failure represents a captured panic (i.e. Summary.State == SpecStatePanicked)\n\t// then ForwardedPanic will be populated with a string representation of the captured panic.\n\tForwardedPanic string `json:\",omitempty\"`\n\n\t// FailureNodeContext - one of three contexts describing the node in which the failure occurred:\n\t// FailureNodeIsLeafNode means the failure occurred in the leaf node of the associated SpecReport. None of the other FailureNode fields will be populated\n\t// FailureNodeAtTopLevel means the failure occurred in a non-leaf node that is defined at the top-level of the spec (i.e. not in a container). FailureNodeType and FailureNodeLocation will be populated.\n\t// FailureNodeInContainer means the failure occurred in a non-leaf node that is defined within a container. FailureNodeType, FailureNodeLocation, and FailureNodeContainerIndex will be populated.\n\t//\n\t// FailureNodeType will contain the NodeType of the node in which the failure occurred.\n\t// FailureNodeLocation will contain the CodeLocation of the node in which the failure occurred.\n\t// If populated, FailureNodeContainerIndex will be the index into SpecReport.ContainerHierarchyTexts and SpecReport.ContainerHierarchyLocations that represents the parent container of the node in which the failure occurred.\n\tFailureNodeContext FailureNodeContext `json:\",omitempty\"`\n\n\tFailureNodeType NodeType `json:\",omitempty\"`\n\n\tFailureNodeLocation CodeLocation `json:\",omitempty\"`\n\n\tFailureNodeContainerIndex int `json:\",omitempty\"`\n\n\t//ProgressReport is populated if the spec was interrupted or timed out\n\tProgressReport ProgressReport `json:\",omitempty\"`\n\n\t//AdditionalFailure is non-nil if a follow-on failure occurred within the same node after the primary failure. This only happens when a node has timed out or been interrupted. In such cases the AdditionalFailure can include information about where/why the spec was stuck.\n\tAdditionalFailure *AdditionalFailure `json:\",omitempty\"`\n}\n\nfunc (f Failure) IsZero() bool {\n\treturn f.Message == \"\" && (f.Location == CodeLocation{})\n}\n\nfunc (f Failure) GetTimelineLocation() TimelineLocation {\n\treturn f.TimelineLocation\n}\n\n// FailureNodeContext captures the location context for the node containing the failing line of code\ntype FailureNodeContext uint\n\nconst (\n\tFailureNodeContextInvalid FailureNodeContext = iota\n\n\tFailureNodeIsLeafNode\n\tFailureNodeAtTopLevel\n\tFailureNodeInContainer\n)\n\nvar fncEnumSupport = NewEnumSupport(map[uint]string{\n\tuint(FailureNodeContextInvalid): \"INVALID FAILURE NODE CONTEXT\",\n\tuint(FailureNodeIsLeafNode): \"leaf-node\",\n\tuint(FailureNodeAtTopLevel): \"top-level\",\n\tuint(FailureNodeInContainer): \"in-container\",\n})\n\nfunc (fnc FailureNodeContext) String() string {\n\treturn fncEnumSupport.String(uint(fnc))\n}\nfunc (fnc *FailureNodeContext) UnmarshalJSON(b []byte) error {\n\tout, err := fncEnumSupport.UnmarshJSON(b)\n\t*fnc = FailureNodeContext(out)\n\treturn err\n}\nfunc (fnc FailureNodeContext) MarshalJSON() ([]byte, error) {\n\treturn fncEnumSupport.MarshJSON(uint(fnc))\n}\n\n// AdditionalFailure capturs any additional failures that occur after the initial failure of a psec\n// these typically occur in clean up nodes after the spec has failed.\n// We can't simply use Failure as we want to track the SpecState to know what kind of failure this is\ntype AdditionalFailure struct {\n\tState SpecState\n\tFailure Failure\n}\n\nfunc (f AdditionalFailure) GetTimelineLocation() TimelineLocation {\n\treturn f.Failure.TimelineLocation\n}\n\n// SpecState captures the state of a spec\n// To determine if a given `state` represents a failure state, use `state.Is(SpecStateFailureStates)`\ntype SpecState uint\n\nconst (\n\tSpecStateInvalid SpecState = 0\n\n\tSpecStatePending SpecState = 1 << iota\n\tSpecStateSkipped\n\tSpecStatePassed\n\tSpecStateFailed\n\tSpecStateAborted\n\tSpecStatePanicked\n\tSpecStateInterrupted\n\tSpecStateTimedout\n)\n\nvar ssEnumSupport = NewEnumSupport(map[uint]string{\n\tuint(SpecStateInvalid): \"INVALID SPEC STATE\",\n\tuint(SpecStatePending): \"pending\",\n\tuint(SpecStateSkipped): \"skipped\",\n\tuint(SpecStatePassed): \"passed\",\n\tuint(SpecStateFailed): \"failed\",\n\tuint(SpecStateAborted): \"aborted\",\n\tuint(SpecStatePanicked): \"panicked\",\n\tuint(SpecStateInterrupted): \"interrupted\",\n\tuint(SpecStateTimedout): \"timedout\",\n})\n\nfunc (ss SpecState) String() string {\n\treturn ssEnumSupport.String(uint(ss))\n}\nfunc (ss SpecState) GomegaString() string {\n\treturn ssEnumSupport.String(uint(ss))\n}\nfunc (ss *SpecState) UnmarshalJSON(b []byte) error {\n\tout, err := ssEnumSupport.UnmarshJSON(b)\n\t*ss = SpecState(out)\n\treturn err\n}\nfunc (ss SpecState) MarshalJSON() ([]byte, error) {\n\treturn ssEnumSupport.MarshJSON(uint(ss))\n}\n\nvar SpecStateFailureStates = SpecStateFailed | SpecStateTimedout | SpecStateAborted | SpecStatePanicked | SpecStateInterrupted\n\nfunc (ss SpecState) Is(states SpecState) bool {\n\treturn ss&states != 0\n}\n\n// ProgressReport captures the progress of the current spec. It is, effectively, a structured Ginkgo-aware stack trace\ntype ProgressReport struct {\n\tMessage string `json:\",omitempty\"`\n\tParallelProcess int `json:\",omitempty\"`\n\tRunningInParallel bool `json:\",omitempty\"`\n\n\tContainerHierarchyTexts []string `json:\",omitempty\"`\n\tLeafNodeText string `json:\",omitempty\"`\n\tLeafNodeLocation CodeLocation `json:\",omitempty\"`\n\tSpecStartTime time.Time `json:\",omitempty\"`\n\n\tCurrentNodeType NodeType `json:\",omitempty\"`\n\tCurrentNodeText string `json:\",omitempty\"`\n\tCurrentNodeLocation CodeLocation `json:\",omitempty\"`\n\tCurrentNodeStartTime time.Time `json:\",omitempty\"`\n\n\tCurrentStepText string `json:\",omitempty\"`\n\tCurrentStepLocation CodeLocation `json:\",omitempty\"`\n\tCurrentStepStartTime time.Time `json:\",omitempty\"`\n\n\tAdditionalReports []string `json:\",omitempty\"`\n\n\tCapturedGinkgoWriterOutput string `json:\",omitempty\"`\n\tTimelineLocation TimelineLocation `json:\",omitempty\"`\n\n\tGoroutines []Goroutine `json:\",omitempty\"`\n}\n\nfunc (pr ProgressReport) IsZero() bool {\n\treturn pr.CurrentNodeType == NodeTypeInvalid\n}\n\nfunc (pr ProgressReport) Time() time.Time {\n\treturn pr.TimelineLocation.Time\n}\n\nfunc (pr ProgressReport) SpecGoroutine() Goroutine {\n\tfor _, goroutine := range pr.Goroutines {\n\t\tif goroutine.IsSpecGoroutine {\n\t\t\treturn goroutine\n\t\t}\n\t}\n\treturn Goroutine{}\n}\n\nfunc (pr ProgressReport) HighlightedGoroutines() []Goroutine {\n\tout := []Goroutine{}\n\tfor _, goroutine := range pr.Goroutines {\n\t\tif goroutine.IsSpecGoroutine || !goroutine.HasHighlights() {\n\t\t\tcontinue\n\t\t}\n\t\tout = append(out, goroutine)\n\t}\n\treturn out\n}\n\nfunc (pr ProgressReport) OtherGoroutines() []Goroutine {\n\tout := []Goroutine{}\n\tfor _, goroutine := range pr.Goroutines {\n\t\tif goroutine.IsSpecGoroutine || goroutine.HasHighlights() {\n\t\t\tcontinue\n\t\t}\n\t\tout = append(out, goroutine)\n\t}\n\treturn out\n}\n\nfunc (pr ProgressReport) WithoutCapturedGinkgoWriterOutput() ProgressReport {\n\tout := pr\n\tout.CapturedGinkgoWriterOutput = \"\"\n\treturn out\n}\n\nfunc (pr ProgressReport) WithoutOtherGoroutines() ProgressReport {\n\tout := pr\n\tfilteredGoroutines := []Goroutine{}\n\tfor _, goroutine := range pr.Goroutines {\n\t\tif goroutine.IsSpecGoroutine || goroutine.HasHighlights() {\n\t\t\tfilteredGoroutines = append(filteredGoroutines, goroutine)\n\t\t}\n\t}\n\tout.Goroutines = filteredGoroutines\n\treturn out\n}\n\nfunc (pr ProgressReport) GetTimelineLocation() TimelineLocation {\n\treturn pr.TimelineLocation\n}\n\ntype Goroutine struct {\n\tID uint64\n\tState string\n\tStack []FunctionCall\n\tIsSpecGoroutine bool\n}\n\nfunc (g Goroutine) IsZero() bool {\n\treturn g.ID == 0\n}\n\nfunc (g Goroutine) HasHighlights() bool {\n\tfor _, fc := range g.Stack {\n\t\tif fc.Highlight {\n\t\t\treturn true\n\t\t}\n\t}\n\n\treturn false\n}\n\ntype FunctionCall struct {\n\tFunction string\n\tFilename string\n\tLine int\n\tHighlight bool `json:\",omitempty\"`\n\tSource []string `json:\",omitempty\"`\n\tSourceHighlight int `json:\",omitempty\"`\n}\n\n// NodeType captures the type of a given Ginkgo Node\ntype NodeType uint\n\nconst (\n\tNodeTypeInvalid NodeType = 0\n\n\tNodeTypeContainer NodeType = 1 << iota\n\tNodeTypeIt\n\n\tNodeTypeBeforeEach\n\tNodeTypeJustBeforeEach\n\tNodeTypeAfterEach\n\tNodeTypeJustAfterEach\n\n\tNodeTypeBeforeAll\n\tNodeTypeAfterAll\n\n\tNodeTypeBeforeSuite\n\tNodeTypeSynchronizedBeforeSuite\n\tNodeTypeAfterSuite\n\tNodeTypeSynchronizedAfterSuite\n\n\tNodeTypeReportBeforeEach\n\tNodeTypeReportAfterEach\n\tNodeTypeReportBeforeSuite\n\tNodeTypeReportAfterSuite\n\n\tNodeTypeCleanupInvalid\n\tNodeTypeCleanupAfterEach\n\tNodeTypeCleanupAfterAll\n\tNodeTypeCleanupAfterSuite\n)\n\nvar NodeTypesForContainerAndIt = NodeTypeContainer | NodeTypeIt\nvar NodeTypesForSuiteLevelNodes = NodeTypeBeforeSuite | NodeTypeSynchronizedBeforeSuite | NodeTypeAfterSuite | NodeTypeSynchronizedAfterSuite | NodeTypeReportBeforeSuite | NodeTypeReportAfterSuite | NodeTypeCleanupAfterSuite\nvar NodeTypesAllowedDuringCleanupInterrupt = NodeTypeAfterEach | NodeTypeJustAfterEach | NodeTypeAfterAll | NodeTypeAfterSuite | NodeTypeSynchronizedAfterSuite | NodeTypeCleanupAfterEach | NodeTypeCleanupAfterAll | NodeTypeCleanupAfterSuite\nvar NodeTypesAllowedDuringReportInterrupt = NodeTypeReportBeforeEach | NodeTypeReportAfterEach | NodeTypeReportBeforeSuite | NodeTypeReportAfterSuite\n\nvar ntEnumSupport = NewEnumSupport(map[uint]string{\n\tuint(NodeTypeInvalid): \"INVALID NODE TYPE\",\n\tuint(NodeTypeContainer): \"Container\",\n\tuint(NodeTypeIt): \"It\",\n\tuint(NodeTypeBeforeEach): \"BeforeEach\",\n\tuint(NodeTypeJustBeforeEach): \"JustBeforeEach\",\n\tuint(NodeTypeAfterEach): \"AfterEach\",\n\tuint(NodeTypeJustAfterEach): \"JustAfterEach\",\n\tuint(NodeTypeBeforeAll): \"BeforeAll\",\n\tuint(NodeTypeAfterAll): \"AfterAll\",\n\tuint(NodeTypeBeforeSuite): \"BeforeSuite\",\n\tuint(NodeTypeSynchronizedBeforeSuite): \"SynchronizedBeforeSuite\",\n\tuint(NodeTypeAfterSuite): \"AfterSuite\",\n\tuint(NodeTypeSynchronizedAfterSuite): \"SynchronizedAfterSuite\",\n\tuint(NodeTypeReportBeforeEach): \"ReportBeforeEach\",\n\tuint(NodeTypeReportAfterEach): \"ReportAfterEach\",\n\tuint(NodeTypeReportBeforeSuite): \"ReportBeforeSuite\",\n\tuint(NodeTypeReportAfterSuite): \"ReportAfterSuite\",\n\tuint(NodeTypeCleanupInvalid): \"DeferCleanup\",\n\tuint(NodeTypeCleanupAfterEach): \"DeferCleanup (Each)\",\n\tuint(NodeTypeCleanupAfterAll): \"DeferCleanup (All)\",\n\tuint(NodeTypeCleanupAfterSuite): \"DeferCleanup (Suite)\",\n})\n\nfunc (nt NodeType) String() string {\n\treturn ntEnumSupport.String(uint(nt))\n}\nfunc (nt *NodeType) UnmarshalJSON(b []byte) error {\n\tout, err := ntEnumSupport.UnmarshJSON(b)\n\t*nt = NodeType(out)\n\treturn err\n}\nfunc (nt NodeType) MarshalJSON() ([]byte, error) {\n\treturn ntEnumSupport.MarshJSON(uint(nt))\n}\n\nfunc (nt NodeType) Is(nodeTypes NodeType) bool {\n\treturn nt&nodeTypes != 0\n}\n\n/*\nSpecEvent captures a vareity of events that can occur when specs run. See SpecEventType for the list of available events.\n*/\ntype SpecEvent struct {\n\tSpecEventType SpecEventType\n\n\tCodeLocation CodeLocation\n\tTimelineLocation TimelineLocation\n\n\tMessage string `json:\",omitempty\"`\n\tDuration time.Duration `json:\",omitempty\"`\n\tNodeType NodeType `json:\",omitempty\"`\n\tAttempt int `json:\",omitempty\"`\n}\n\nfunc (se SpecEvent) GetTimelineLocation() TimelineLocation {\n\treturn se.TimelineLocation\n}\n\nfunc (se SpecEvent) IsOnlyVisibleAtVeryVerbose() bool {\n\treturn se.SpecEventType.Is(SpecEventByEnd | SpecEventNodeStart | SpecEventNodeEnd)\n}\n\nfunc (se SpecEvent) GomegaString() string {\n\tout := &strings.Builder{}\n\tout.WriteString(\"[\" + se.SpecEventType.String() + \" SpecEvent] \")\n\tif se.Message != \"\" {\n\t\tout.WriteString(\"Message=\")\n\t\tout.WriteString(`\"` + se.Message + `\",`)\n\t}\n\tif se.Duration != 0 {\n\t\tout.WriteString(\"Duration=\" + se.Duration.String() + \",\")\n\t}\n\tif se.NodeType != NodeTypeInvalid {\n\t\tout.WriteString(\"NodeType=\" + se.NodeType.String() + \",\")\n\t}\n\tif se.Attempt != 0 {\n\t\tout.WriteString(fmt.Sprintf(\"Attempt=%d\", se.Attempt) + \",\")\n\t}\n\tout.WriteString(\"CL=\" + se.CodeLocation.String() + \",\")\n\tout.WriteString(fmt.Sprintf(\"TL.Offset=%d\", se.TimelineLocation.Offset))\n\n\treturn out.String()\n}\n\ntype SpecEvents []SpecEvent\n\nfunc (se SpecEvents) WithType(seType SpecEventType) SpecEvents {\n\tout := SpecEvents{}\n\tfor _, event := range se {\n\t\tif event.SpecEventType.Is(seType) {\n\t\t\tout = append(out, event)\n\t\t}\n\t}\n\treturn out\n}\n\ntype SpecEventType uint\n\nconst (\n\tSpecEventInvalid SpecEventType = 0\n\n\tSpecEventByStart SpecEventType = 1 << iota\n\tSpecEventByEnd\n\tSpecEventNodeStart\n\tSpecEventNodeEnd\n\tSpecEventSpecRepeat\n\tSpecEventSpecRetry\n)\n\nvar seEnumSupport = NewEnumSupport(map[uint]string{\n\tuint(SpecEventInvalid): \"INVALID SPEC EVENT\",\n\tuint(SpecEventByStart): \"By\",\n\tuint(SpecEventByEnd): \"By (End)\",\n\tuint(SpecEventNodeStart): \"Node\",\n\tuint(SpecEventNodeEnd): \"Node (End)\",\n\tuint(SpecEventSpecRepeat): \"Repeat\",\n\tuint(SpecEventSpecRetry): \"Retry\",\n})\n\nfunc (se SpecEventType) String() string {\n\treturn seEnumSupport.String(uint(se))\n}\nfunc (se *SpecEventType) UnmarshalJSON(b []byte) error {\n\tout, err := seEnumSupport.UnmarshJSON(b)\n\t*se = SpecEventType(out)\n\treturn err\n}\nfunc (se SpecEventType) MarshalJSON() ([]byte, error) {\n\treturn seEnumSupport.MarshJSON(uint(se))\n}\n\nfunc (se SpecEventType) Is(specEventTypes SpecEventType) bool {\n\treturn se&specEventTypes != 0\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/ginkgo/v2/types/version.go",
"content": "package types\n\nconst VERSION = \"2.28.1\"\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/.gitignore",
"content": ".DS_Store\n*.test\n.\n.idea\ngomega.iml\nTODO\n.vscode"
},
{
"path": "tests/vendor/github.com/onsi/gomega/CHANGELOG.md",
"content": "## 1.39.1\n\nUpdate all dependencies. This auto-updated the required version of Go to 1.24, consistent with the fact that Go 1.23 has been out of support for almost six months.\n\n## 1.39.0\n\n### Features\n\nAdd `MatchErrorStrictly` which only passes if `errors.Is(actual, expected)` returns true. `MatchError`, by contrast, will fallback to string comparison.\n\n## 1.38.3\n\n### Fixes\nmake string formatitng more consistent for users who use format.Object directly\n\n## 1.38.2\n\n- roll back to go 1.23.0 [c404969]\n\n## 1.38.1\n\n### Fixes\n\nNumerous minor fixes and dependency bumps\n\n## 1.38.0\n\n### Features\n- gstruct handles extra unexported fields [4ee7ed0]\n\n### Fixes\n- support [] in IgnoringTopFunction function signatures (#851) [36bbf72]\n\n### Maintenance\n- Bump golang.org/x/net from 0.40.0 to 0.41.0 (#846) [529d408]\n- Fix typo [acd1f55]\n- Bump google.golang.org/protobuf from 1.36.5 to 1.36.6 (#835) [bae65a0]\n- Bump nokogiri from 1.18.4 to 1.18.8 in /docs (#842) [8dda91f]\n- Bump golang.org/x/net from 0.39.0 to 0.40.0 (#843) [212d812]\n- Bump github.com/onsi/ginkgo/v2 from 2.23.3 to 2.23.4 (#839) [59bd7f9]\n- Bump nokogiri from 1.18.1 to 1.18.4 in /docs (#834) [328c729]\n- Bump uri from 1.0.2 to 1.0.3 in /docs (#826) [9a798a1]\n- Bump golang.org/x/net from 0.37.0 to 0.39.0 (#841) [04a72c6]\n\n## 1.37.0\n\n### Features\n- add To/ToNot/NotTo aliases for AsyncAssertion [5666f98]\n\n## 1.36.3\n\n### Maintenance\n\n- bump all the things [adb8b49]\n- chore: replace `interface{}` with `any` [7613216]\n- Bump google.golang.org/protobuf from 1.36.1 to 1.36.5 (#822) [9fe5259]\n- remove spurious \"toolchain\" from go.mod (#819) [a0e85b9]\n- Bump golang.org/x/net from 0.33.0 to 0.35.0 (#823) [604a8b1]\n- Bump activesupport from 6.0.6.1 to 6.1.7.5 in /docs (#772) [36fbc84]\n- Bump github-pages from 231 to 232 in /docs (#778) [ced70d7]\n- Bump rexml from 3.2.6 to 3.3.9 in /docs (#788) [c8b4a07]\n- Bump github.com/onsi/ginkgo/v2 from 2.22.1 to 2.22.2 (#812) [06431b9]\n- Bump webrick from 1.8.1 to 1.9.1 in /docs (#800) [b55a92d]\n- Fix typos (#813) [a1d518b]\n\n## 1.36.2\n\n### Maintenance\n- Bump google.golang.org/protobuf from 1.35.1 to 1.36.1 (#810) [9a7609d]\n- Bump golang.org/x/net from 0.30.0 to 0.33.0 (#807) [b6cb028]\n- Bump github.com/onsi/ginkgo/v2 from 2.20.1 to 2.22.1 (#808) [5756529]\n- Bump nokogiri from 1.16.3 to 1.16.5 in /docs (#757) [dabc12e]\n\n## 1.36.1\n\n### Fixes\n- Fix https://github.com/onsi/gomega/issues/803 [1c6c112]\n- resolves onsi/gomega#696: make HaveField great on pointer receivers given only a non-addressable value [4feb9d7]\n\n## 1.36.0\n\n### Features\n- new: make collection-related matchers Go 1.23 iterator aware [4c964c6]\n\n### Maintenance\n- Replace min/max helpers with built-in min/max [ece6872]\n- Fix some typos in docs [8e924d7]\n\n## 1.35.1\n\n### Fixes\n- Export EnforceDefaultTimeoutsWhenUsingContexts and DisableDefaultTimeoutsWhenUsingContext [ca36da1]\n\n## 1.35.0\n\n### Features\n\n- You can now call `EnforceDefaultTimeoutsWhenUsingContexts()` to have `Eventually` honor the default timeout when passed a context. (prior to this you had to expclility add a timeout) [e4c4265]\n- You can call `StopTrying(message).Successfully()` to abort a `Consistently` early without failure [eeca931]\n\n### Fixes\n\n- Stop memoizing the result of `HaveField` to avoid unexpected errors when used with async assertions. [3bdbc4e]\n\n### Maintenance\n\n- Bump all dependencies [a05a416]\n\n## 1.34.2\n\nRequire Go 1.22+\n\n### Maintenance\n- bump ginkgo as well [c59c6dc]\n- bump to go 1.22 - remove x/exp dependency [8158b99]\n\n## 1.34.1\n\n### Maintenance\n- Use slices from exp/slices to keep golang 1.20 compat [5e71dcd]\n\n## 1.34.0\n\n### Features\n- Add RoundTripper method to ghttp.Server [c549e0d]\n\n### Fixes\n- fix incorrect handling of nil slices in HaveExactElements (fixes #771) [878940c]\n- issue_765 - fixed bug in Hopcroft-Karp algorithm [ebadb67]\n\n### Maintenance\n- bump ginkgo [8af2ece]\n- Fix typo in docs [123a071]\n- Bump github.com/onsi/ginkgo/v2 from 2.17.2 to 2.17.3 (#756) [0e69083]\n- Bump google.golang.org/protobuf from 1.33.0 to 1.34.1 (#755) [2675796]\n- Bump golang.org/x/net from 0.24.0 to 0.25.0 (#754) [4160c0f]\n- Bump github-pages from 230 to 231 in /docs (#748) [892c303]\n\n## 1.33.1\n\n### Fixes\n- fix confusing eventually docs [3a66379]\n\n### Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.17.1 to 2.17.2 [e9bc35a]\n\n## 1.33.0\n\n### Features\n\n`Receive` not accepts `Receive(, MATCHER>)`, allowing you to pick out a specific value on the channel that satisfies the provided matcher and is stored in the provided pointer.\n\n### Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.15.0 to 2.17.1 (#745) [9999deb]\n- Bump github-pages from 229 to 230 in /docs (#735) [cb5ff21]\n- Bump golang.org/x/net from 0.20.0 to 0.23.0 (#746) [bac6596]\n\n## 1.32.0\n\n### Maintenance\n- Migrate github.com/golang/protobuf to google.golang.org/protobuf [436a197]\n \n This release drops the deprecated github.com/golang/protobuf and adopts google.golang.org/protobuf. Care was taken to ensure the release is backwards compatible (thanks @jbduncan !). Please open an issue if you run into one.\n\n- chore: test with Go 1.22 (#733) [32ef35e]\n- Bump golang.org/x/net from 0.19.0 to 0.20.0 (#717) [a0d0387]\n- Bump github-pages and jekyll-feed in /docs (#732) [b71e477]\n- docs: fix typo and broken anchor link to gstruct [f460154]\n- docs: fix HaveEach matcher signature [a2862e4]\n\n## 1.31.1\n\n### Fixes\n- Inverted arguments order of FailureMessage of BeComparableToMatcher [e0dd999]\n- Update test in case keeping msg is desired [ad1a367]\n\n### Maintenance\n- Show how to import the format sub package [24e958d]\n- tidy up go.sum [26661b8]\n- bump dependencies [bde8f7a]\n\n## 1.31.0\n\n### Features\n- Async assertions include context cancellation cause if present [121c37f]\n\n### Maintenance\n- Bump minimum go version [dee1e3c]\n- docs: fix typo in example usage \"occured\" -> \"occurred\" [49005fe]\n- Bump actions/setup-go from 4 to 5 (#714) [f1c8757]\n- Bump github/codeql-action from 2 to 3 (#715) [9836e76]\n- Bump github.com/onsi/ginkgo/v2 from 2.13.0 to 2.13.2 (#713) [54726f0]\n- Bump golang.org/x/net from 0.17.0 to 0.19.0 (#711) [df97ecc]\n- docs: fix `HaveExactElement` typo (#712) [a672c86]\n\n## 1.30.0\n\n### Features\n- BeTrueBecause and BeFalseBecause allow for better failure messages [4da4c7f]\n\n### Maintenance\n- Bump actions/checkout from 3 to 4 (#694) [6ca6e97]\n- doc: fix type on gleak go doc [f1b8343]\n\n## 1.29.0\n\n### Features\n- MatchError can now take an optional func(error) bool + description [2b39142]\n\n## 1.28.1\n\n### Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.12.0 to 2.13.0 [635d196]\n- Bump github.com/google/go-cmp from 0.5.9 to 0.6.0 [14f8859]\n- Bump golang.org/x/net from 0.14.0 to 0.17.0 [d8a6508]\n- #703 doc(matchers): HaveEach() doc comment updated [2705bdb]\n- Minor typos (#699) [375648c]\n\n## 1.28.0\n\n### Features\n- Add VerifyHost handler to ghttp (#698) [0b03b36]\n\n### Fixes\n- Read Body for Newer Responses in HaveHTTPBodyMatcher (#686) [18d6673]\n\n### Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.11.0 to 2.12.0 (#693) [55a33f3]\n- Typo in matchers.go (#691) [de68e8f]\n- Bump commonmarker from 0.23.9 to 0.23.10 in /docs (#690) [ab17f5e]\n- chore: update test matrix for Go 1.21 (#689) [5069017]\n- Bump golang.org/x/net from 0.12.0 to 0.14.0 (#688) [babe25f]\n\n## 1.27.10\n\n### Fixes\n- fix: go 1.21 adding goroutine ID to creator+location (#685) [bdc7803]\n\n## 1.27.9\n\n### Fixes\n- Prevent nil-dereference in format.Object for boxed nil error (#681) [3b31fc3]\n\n### Maintenance\n- Bump golang.org/x/net from 0.11.0 to 0.12.0 (#679) [360849b]\n- chore: use String() instead of fmt.Sprintf (#678) [86f3659]\n- Bump golang.org/x/net from 0.10.0 to 0.11.0 (#674) [642ead0]\n- chore: unnecessary use of fmt.Sprintf (#677) [ceb9ca6]\n- Bump github.com/onsi/ginkgo/v2 from 2.10.0 to 2.11.0 (#675) [a2087d8]\n- docs: fix ContainSubstring references (#673) [fc9a89f]\n- Bump github.com/onsi/ginkgo/v2 from 2.9.7 to 2.10.0 (#671) [9076019]\n\n## 1.27.8\n\n### Fixes\n- HaveExactElement should not call FailureMessage if a submatcher returned an error [096f392]\n\n### Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.9.5 to 2.9.7 (#669) [8884bee]\n\n## 1.27.7\n\n### Fixes\n- fix: gcustom.MakeMatcher accepts nil as actual value (#666) [57054d5]\n\n### Maintenance\n- update gitignore [05c1bc6]\n- Bump github.com/onsi/ginkgo/v2 from 2.9.4 to 2.9.5 (#663) [7cadcf6]\n- Bump golang.org/x/net from 0.9.0 to 0.10.0 (#662) [b524839]\n- Bump github.com/onsi/ginkgo/v2 from 2.9.2 to 2.9.4 (#661) [5f44694]\n- Bump commonmarker from 0.23.8 to 0.23.9 in /docs (#657) [05dc99a]\n- Bump nokogiri from 1.14.1 to 1.14.3 in /docs (#658) [3a033d1]\n- Replace deprecated NewGomegaWithT with NewWithT (#659) [a19238f]\n- Bump golang.org/x/net from 0.8.0 to 0.9.0 (#656) [29ed041]\n- Bump actions/setup-go from 3 to 4 (#651) [11b2080]\n\n## 1.27.6\n\n### Fixes\n- Allow collections matchers to work correctly when expected has nil elements [60e7cf3]\n\n### Maintenance\n- updates MatchError godoc comment to also accept a Gomega matcher (#654) [67b869d]\n\n## 1.27.5\n\n### Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.9.1 to 2.9.2 (#653) [a215021]\n- Bump github.com/go-task/slim-sprig (#652) [a26fed8]\n\n## 1.27.4\n\n### Fixes\n- improve error formatting and remove duplication of error message in Eventually/Consistently [854f075]\n\n### Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.9.0 to 2.9.1 (#650) [ccebd9b]\n\n## 1.27.3\n\n### Fixes\n- format.Object now always includes err.Error() when passed an error [86d97ef]\n- Fix HaveExactElements to work inside ContainElement or other collection matchers (#648) [636757e]\n\n### Maintenance\n- Bump github.com/golang/protobuf from 1.5.2 to 1.5.3 (#649) [cc16689]\n- Bump github.com/onsi/ginkgo/v2 from 2.8.4 to 2.9.0 (#646) [e783366]\n\n## 1.27.2\n\n### Fixes\n- improve poll progress message when polling a consistently that has been passing [28a319b]\n\n### Maintenance\n- bump ginkgo\n- remove tools.go hack as Ginkgo 2.8.2 automatically pulls in the cli dependencies [81443b3]\n\n## 1.27.1\n\n### Maintenance\n\n- Bump golang.org/x/net from 0.6.0 to 0.7.0 (#640) [bc686cd]\n\n## 1.27.0\n\n### Features\n- Add HaveExactElements matcher (#634) [9d50783]\n- update Gomega docs to discuss GinkgoHelper() [be32774]\n\n### Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.8.0 to 2.8.1 (#639) [296a68b]\n- Bump golang.org/x/net from 0.5.0 to 0.6.0 (#638) [c2b098b]\n- Bump github-pages from 227 to 228 in /docs (#636) [a9069ab]\n- test: update matrix for Go 1.20 (#635) [6bd25c8]\n- Bump github.com/onsi/ginkgo/v2 from 2.7.0 to 2.8.0 (#631) [5445f8b]\n- Bump webrick from 1.7.0 to 1.8.1 in /docs (#630) [03e93bb]\n- codeql: add ruby language (#626) [63c7d21]\n- dependabot: add bundler package-ecosystem for docs (#625) [d92f963]\n\n## 1.26.0\n\n### Features\n- When a polled function returns an error, keep track of the actual and report on the matcher state of the last non-errored actual [21f3090]\n- improve eventually failure message output [c530fb3]\n\n### Fixes\n- fix several documentation spelling issues [e2eff1f]\n\n\n## 1.25.0\n\n### Features\n- add `MustPassRepeatedly(int)` to asyncAssertion (#619) [4509f72]\n- compare unwrapped errors using DeepEqual (#617) [aaeaa5d]\n\n### Maintenance\n- Bump golang.org/x/net from 0.4.0 to 0.5.0 (#614) [c7cfea4]\n- Bump github.com/onsi/ginkgo/v2 from 2.6.1 to 2.7.0 (#615) [71b8adb]\n- Docs: Fix typo \"MUltiple\" -> \"Multiple\" (#616) [9351dda]\n- clean up go.sum [cd1dc1d]\n\n## 1.24.2\n\n### Fixes\n- Correctly handle assertion failure panics for eventually/consistnetly \"g Gomega\"s in a goroutine [78f1660]\n- docs:Fix typo \"you an\" -> \"you can\" (#607) [3187c1f]\n- fixes issue #600 (#606) [808d192]\n\n### Maintenance\n- Bump golang.org/x/net from 0.2.0 to 0.4.0 (#611) [6ebc0bf]\n- Bump nokogiri from 1.13.9 to 1.13.10 in /docs (#612) [258cfc8]\n- Bump github.com/onsi/ginkgo/v2 from 2.5.0 to 2.5.1 (#609) [e6c3eb9]\n\n## 1.24.1\n\n### Fixes\n- maintain backward compatibility for Eventually and Consisntetly's signatures [4c7df5e]\n- fix small typo (#601) [ea0ebe6]\n\n### Maintenance\n- Bump golang.org/x/net from 0.1.0 to 0.2.0 (#603) [1ba8372]\n- Bump github.com/onsi/ginkgo/v2 from 2.4.0 to 2.5.0 (#602) [f9426cb]\n- fix label-filter in test.yml [d795db6]\n- stop running flakey tests and rely on external network dependencies in CI [7133290]\n\n## 1.24.0\n\n### Features\n\nIntroducing [gcustom](https://onsi.github.io/gomega/#gcustom-a-convenient-mechanism-for-buildling-custom-matchers) - a convenient mechanism for building custom matchers.\n\nThis is an RC release for `gcustom`. The external API may be tweaked in response to feedback however it is expected to remain mostly stable.\n\n### Maintenance\n\n- Update BeComparableTo documentation [756eaa0]\n\n## 1.23.0\n\n### Features\n- Custom formatting on a per-type basis can be provided using `format.RegisterCustomFormatter()` -- see the docs [here](https://onsi.github.io/gomega/#adjusting-output)\n\n- Substantial improvement have been made to `StopTrying()`:\n - Users can now use `StopTrying().Wrap(err)` to wrap errors and `StopTrying().Attach(description, object)` to attach arbitrary objects to the `StopTrying()` error\n - `StopTrying()` is now always interpreted as a failure. If you are an early adopter of `StopTrying()` you may need to change your code as the prior version would match against the returned value even if `StopTrying()` was returned. Going forward the `StopTrying()` api should remain stable.\n - `StopTrying()` and `StopTrying().Now()` can both be used in matchers - not just polled functions.\n\n- `TryAgainAfter(duration)` is used like `StopTrying()` but instructs `Eventually` and `Consistently` that the poll should be tried again after the specified duration. This allows you to dynamically adjust the polling duration.\n\n- `ctx` can now be passed-in as the first argument to `Eventually` and `Consistently`.\n\n## Maintenance\n\n- Bump github.com/onsi/ginkgo/v2 from 2.3.0 to 2.3.1 (#597) [afed901]\n- Bump nokogiri from 1.13.8 to 1.13.9 in /docs (#599) [7c691b3]\n- Bump github.com/google/go-cmp from 0.5.8 to 0.5.9 (#587) [ff22665]\n\n## 1.22.1\n\n## Fixes\n- When passed a context and no explicit timeout, Eventually will only timeout when the context is cancelled [e5105cf]\n- Allow StopTrying() to be wrapped [bf3cba9]\n\n## Maintenance\n- bump to ginkgo v2.3.0 [c5d5c39]\n\n## 1.22.0\n\n### Features\n\nSeveral improvements have been made to `Eventually` and `Consistently` in this and the most recent releases:\n\n- Eventually and Consistently can take a context.Context [65c01bc]\n This enables integration with Ginkgo 2.3.0's interruptible nodes and node timeouts.\n- Eventually and Consistently that are passed a SpecContext can provide reports when an interrupt occurs [0d063c9]\n- Eventually/Consistently will forward an attached context to functions that ask for one [e2091c5]\n- Eventually/Consistently supports passing arguments to functions via WithArguments() [a2dc7c3]\n- Eventually and Consistently can now be stopped early with StopTrying(message) and StopTrying(message).Now() [52976bb]\n\nThese improvements are all documented in [Gomega's docs](https://onsi.github.io/gomega/#making-asynchronous-assertions)\n\n## Fixes\n\n## Maintenance\n\n## 1.21.1\n\n### Features\n- Eventually and Consistently that are passed a SpecContext can provide reports when an interrupt occurs [0d063c9]\n\n## 1.21.0\n\n### Features\n- Eventually and Consistently can take a context.Context [65c01bc]\n This enables integration with Ginkgo 2.3.0's interruptible nodes and node timeouts.\n- Introduces Eventually.Within.ProbeEvery with tests and documentation (#591) [f633800]\n- New BeKeyOf matcher with documentation and unit tests (#590) [fb586b3]\n \n## Fixes\n- Cover the entire gmeasure suite with leak detection [8c54344]\n- Fix gmeasure leak [119d4ce]\n- Ignore new Ginkgo ProgressSignal goroutine in gleak [ba548e2]\n\n## Maintenance\n\n- Fixes crashes on newer Ruby 3 installations by upgrading github-pages gem dependency (#596) [12469a0]\n\n\n## 1.20.2\n\n## Fixes\n- label specs that rely on remote access; bump timeout on short-circuit test to make it less flaky [35eeadf]\n- gexec: allow more headroom for SIGABRT-related unit tests (#581) [5b78f40]\n- Enable reading from a closed gbytes.Buffer (#575) [061fd26]\n\n## Maintenance\n- Bump github.com/onsi/ginkgo/v2 from 2.1.5 to 2.1.6 (#583) [55d895b]\n- Bump github.com/onsi/ginkgo/v2 from 2.1.4 to 2.1.5 (#582) [346de7c]\n\n## 1.20.1\n\n## Fixes\n- fix false positive gleaks when using ginkgo -p (#577) [cb46517]\n- Fix typos in gomega_dsl.go (#569) [5f71ed2]\n- don't panic on Eventually(nil), fixing #555 (#567) [9d1186f]\n- vet optional description args in assertions, fixing #560 (#566) [8e37808]\n\n## Maintenance\n- test: add new Go 1.19 to test matrix (#571) [40d7efe]\n- Bump tzinfo from 1.2.9 to 1.2.10 in /docs (#564) [5f26371]\n\n## 1.20.0\n\n## Features\n- New [`gleak`](https://onsi.github.io/gomega/#codegleakcode-finding-leaked-goroutines) experimental goroutine leak detection package! (#538) [85ba7bc]\n- New `BeComparableTo` matcher(#546) that uses `gocmp` to make comparisons [e77ea75]\n- New `HaveExistingField` matcher (#553) [fd130e1]\n- Document how to wrap Gomega (#539) [56714a4]\n\n## Fixes\n- Support pointer receivers in HaveField; fixes #543 (#544) [8dab36e]\n\n## Maintenance\n- Bump various dependencies:\n - Upgrade to yaml.v3 (#556) [f5a83b1]\n - Bump github/codeql-action from 1 to 2 (#549) [52f5adf]\n - Bump github.com/google/go-cmp from 0.5.7 to 0.5.8 (#551) [5f3942d]\n - Bump nokogiri from 1.13.4 to 1.13.6 in /docs (#554) [eb4b4c2]\n - Use latest ginkgo (#535) [1c29028]\n - Bump nokogiri from 1.13.3 to 1.13.4 in /docs (#541) [1ce84d5]\n - Bump actions/setup-go from 2 to 3 (#540) [755485e]\n - Bump nokogiri from 1.12.5 to 1.13.3 in /docs (#522) [4fbb0dc]\n - Bump actions/checkout from 2 to 3 (#526) [ac49202]\n\n## 1.19.0\n\n## Features\n- New [`HaveEach`](https://onsi.github.io/gomega/#haveeachelement-interface) matcher to ensure that each and every element in an `array`, `slice`, or `map` satisfies the passed in matcher. (#523) [9fc2ae2] (#524) [c8ba582]\n- Users can now wrap the `Gomega` interface to implement custom behavior on each assertion. (#521) [1f2e714]\n- [`ContainElement`](https://onsi.github.io/gomega/#containelementelement-interface) now accepts an additional pointer argument. Elements that satisfy the matcher are stored in the pointer enabling developers to easily add subsequent, more detailed, assertions against the matching element. (#527) [1a4e27f]\n\n## Fixes\n- update RELEASING instructions to match ginkgo [0917cde]\n- Bump github.com/onsi/ginkgo/v2 from 2.0.0 to 2.1.3 (#519) [49ab4b0]\n- Fix CVE-2021-38561 (#534) [f1b4456]\n- Fix max number of samples in experiments on non-64-bit systems. (#528) [1c84497]\n- Remove dependency on ginkgo v1.16.4 (#530) [4dea8d5]\n- Fix for Go 1.18 (#532) [56d2a29]\n- Document precedence of timeouts (#533) [b607941]\n\n## 1.18.1\n\n## Fixes\n- Add pointer support to HaveField matcher (#495) [79e41a3]\n\n## 1.18.0\n\n## Features\n- Docs now live on the master branch in the docs folder which will make for easier PRs. The docs also use Ginkgo 2.0's new docs html/css/js. [2570272]\n- New HaveValue matcher can handle actuals that are either values (in which case they are passed on unscathed) or pointers (in which case they are indirected). [Docs here.](https://onsi.github.io/gomega/#working-with-values) (#485) [bdc087c]\n- Gmeasure has been declared GA [360db9d]\n\n## Fixes\n- Gomega now uses ioutil for Go 1.15 and lower (#492) - official support is only for the most recent two major versions of Go but this will unblock users who need to stay on older unsupported versions of Go. [c29c1c0]\n\n## Maintenance\n- Remove Travis workflow (#491) [72e6040]\n- Upgrade to Ginkgo 2.0.0 GA [f383637]\n- chore: fix description of HaveField matcher (#487) [2b4b2c0]\n- use tools.go to ensure Ginkgo cli dependencies are included [f58a52b]\n- remove dockerfile and simplify github actions to match ginkgo's actions [3f8160d]\n\n## 1.17.0\n\n### Features\n- Add HaveField matcher [3a26311]\n- add Error() assertions on the final error value of multi-return values (#480) [2f96943]\n- separate out offsets and timeouts (#478) [18a4723]\n- fix transformation error reporting (#479) [e001fab]\n- allow transform functions to report errors (#472) [bf93408]\n\n### Fixes\nStop using deprecated ioutil package (#467) [07f405d]\n\n## 1.16.0\n\n### Features\n- feat: HaveHTTPStatus multiple expected values (#465) [aa69f1b]\n- feat: HaveHTTPHeaderWithValue() matcher (#463) [dd83a96]\n- feat: HaveHTTPBody matcher (#462) [504e1f2]\n- feat: formatter for HTTP responses (#461) [e5b3157]\n\n## 1.15.0\n\n### Fixes\nThe previous version (1.14.0) introduced a change to allow `Eventually` and `Consistently` to support functions that make assertions. This was accomplished by overriding the global fail handler when running the callbacks passed to `Eventually/Consistently` in order to capture any resulting errors. Issue #457 uncovered a flaw with this approach: when multiple `Eventually`s are running concurrently they race when overriding the singleton global fail handler.\n\n1.15.0 resolves this by requiring users who want to make assertions in `Eventually/Consistently` call backs to explicitly pass in a function that takes a `Gomega` as an argument. The passed-in `Gomega` instance can be used to make assertions. Any failures will cause `Eventually` to retry the callback. This cleaner interface avoids the issue of swapping out globals but comes at the cost of changing the contract introduced in v1.14.0. As such 1.15.0 introduces a breaking change with respect to 1.14.0 - however we expect that adoption of this feature in 1.14.0 remains limited.\n\nIn addition, 1.15.0 cleans up some of Gomega's internals. Most users shouldn't notice any differences stemming from the refactoring that was made.\n\n## 1.14.0\n\n### Features\n- gmeasure.SamplingConfig now suppers a MinSamplingInterval [e94dbca]\n- Eventually and Consistently support functions that make assertions [2f04e6e]\n - Eventually and Consistently now allow their passed-in functions to make assertions.\n These assertions must pass or the function is considered to have failed and is retried.\n - Eventually and Consistently can now take functions with no return values. These implicitly return nil\n if they contain no failed assertion. Otherwise they return an error wrapping the first assertion failure. This allows\n these functions to be used with the Succeed() matcher.\n - Introduce InterceptGomegaFailure - an analogue to InterceptGomegaFailures - that captures the first assertion failure\n and halts execution in its passed-in callback.\n\n### Fixes\n- Call Verify GHTTPWithGomega receiver funcs (#454) [496e6fd]\n- Build a binary with an expected name (#446) [7356360]\n\n## 1.13.0\n\n### Features\n- gmeasure provides BETA support for benchmarking (#447) [8f2dfbf]\n- Set consistently and eventually defaults on init (#443) [12eb778]\n\n## 1.12.0\n\n### Features\n- Add Satisfy() matcher (#437) [c548f31]\n- tweak truncation message [3360b8c]\n- Add format.GomegaStringer (#427) [cc80b6f]\n- Add Clear() method to gbytes.Buffer [c3c0920]\n\n### Fixes\n- Fix error message in BeNumericallyMatcher (#432) [09c074a]\n- Bump github.com/onsi/ginkgo from 1.12.1 to 1.16.2 (#442) [e5f6ea0]\n- Bump github.com/golang/protobuf from 1.4.3 to 1.5.2 (#431) [adae3bf]\n- Bump golang.org/x/net (#441) [3275b35]\n\n## 1.11.0\n\n### Features\n- feature: add index to gstruct element func (#419) [334e00d]\n- feat(gexec) Add CompileTest functions. Close #410 (#411) [47c613f]\n\n### Fixes\n- Check more carefully for nils in WithTransform (#423) [3c60a15]\n- fix: typo in Makefile [b82522a]\n- Allow WithTransform function to accept a nil value (#422) [b75d2f2]\n- fix: print value type for interface{} containers (#409) [f08e2dc]\n- fix(BeElementOf): consistently flatten expected values [1fa9468]\n\n## 1.10.5\n\n### Fixes\n- fix: collections matchers should display type of expectation (#408) [6b4eb5a]\n- fix(ContainElements): consistently flatten expected values [073b880]\n- fix(ConsistOf): consistently flatten expected values [7266efe]\n\n## 1.10.4\n\n### Fixes\n- update golang net library to more recent version without vulnerability (#406) [817a8b9]\n- Correct spelling: alloted -> allotted (#403) [0bae715]\n- fix a panic in MessageWithDiff with long message (#402) [ea06b9b]\n\n## 1.10.3\n\n### Fixes\n- updates golang/x/net to fix vulnerability detected by snyk (#394) [c479356]\n\n## 1.10.2\n\n### Fixes\n- Add ExpectWithOffset, EventuallyWithOffset and ConsistentlyWithOffset to WithT (#391) [990941a]\n\n## 1.10.1\n\n### Fixes\n- Update dependencies (#389) [9f5eecd]\n\n## 1.10.0\n\n### Features\n- Add HaveHTTPStatusMatcher (#378) [f335c94]\n- Changed matcher for content-type in VerifyJSONRepresenting (#377) [6024f5b]\n- Make ghttp usable with x-unit style tests (#376) [c0be499]\n- Implement PanicWith matcher (#381) [f8032b4]\n\n## 1.9.0\n\n### Features\n- Add ContainElements matcher (#370) [2f57380]\n- Output missing and extra elements in ConsistOf failure message [a31eda7]\n- Document method LargestMatching [7c5a280]\n\n## 1.8.1\n\n### Fixes\n- Fix unexpected MatchError() behaviour (#375) [8ae7b2f]\n\n## 1.8.0\n\n### Features\n- Allow optional description to be lazily evaluated function (#364) [bf64010]\n- Support wrapped errors (#359) [0a981cb]\n\n## 1.7.1\n\n### Fixes\n- Bump go-yaml version to cover fixed ddos heuristic (#362) [95e431e]\n\n## 1.7.0\n\n### Features\n- export format property variables (#347) [642e5ba]\n\n### Fixes\n- minor fix in the documentation of ExpectWithOffset (#358) [beea727]\n\n## 1.6.0\n\n### Features\n\n- Display special chars on error [41e1b26]\n- Add BeElementOf matcher [6a48b48]\n\n### Fixes\n\n- Remove duplication in XML matcher tests [cc1a6cb]\n- Remove unnecessary conversions (#357) [7bf756a]\n- Fixed import order (#353) [2e3b965]\n- Added missing error handling in test (#355) [c98d3eb]\n- Simplify code (#356) [0001ed9]\n- Simplify code (#354) [0d9100e]\n- Fixed typos (#352) [3f647c4]\n- Add failure message tests to BeElementOf matcher [efe19c3]\n- Update go-testcov untested sections [37ee382]\n- Mark all uncovered files so go-testcov ./... works [53b150e]\n- Reenable gotip in travis [5c249dc]\n- Fix the typo of comment (#345) [f0e010e]\n- Optimize contain_element_matcher [abeb93d]\n\n\n## 1.5.0\n\n### Features\n\n- Added MatchKeys matchers [8b909fc]\n\n### Fixes and Minor Improvements\n\n- Add type aliases to remove stuttering [03b0461]\n- Don't run session_test.go on windows (#324) [5533ce8]\n\n## 1.4.3\n\n### Fixes:\n\n- ensure file name and line numbers are correctly reported for XUnit [6fff58f]\n- Fixed matcher for content-type (#305) [69d9b43]\n\n## 1.4.2\n\n### Fixes:\n\n- Add go.mod and go.sum files to define the gomega go module [f3de367, a085d30]\n- Work around go vet issue with Go v1.11 (#300) [40dd6ad]\n- Better output when using with go XUnit-style tests, fixes #255 (#297) [29a4b97]\n- Fix MatchJSON fail to parse json.RawMessage (#298) [ae19f1b]\n- show threshold in failure message of BeNumericallyMatcher (#293) [4bbecc8]\n\n## 1.4.1\n\n### Fixes:\n\n- Update documentation formatting and examples (#289) [9be8410]\n- allow 'Receive' matcher to be used with concrete types (#286) [41673fd]\n- Fix data race in ghttp server (#283) [7ac6b01]\n- Travis badge should only show master [cc102ab]\n\n## 1.4.0\n\n### Features\n- Make string pretty diff user configurable (#273) [eb112ce, 649b44d]\n\n### Fixes\n- Use httputil.DumpRequest to pretty-print unhandled requests (#278) [a4ff0fc, b7d1a52]\n- fix typo floa32 > float32 (#272) [041ae3b, 6e33911]\n- Fix link to documentation on adding your own matchers (#270) [bb2c830, fcebc62]\n- Use setters and getters to avoid race condition (#262) [13057c3, a9c79f1]\n- Avoid sending a signal if the process is not alive (#259) [b8043e5, 4fc1762]\n- Improve message from AssignableToTypeOf when expected value is nil (#281) [9c1fb20]\n\n## 1.3.0\n\nImprovements:\n\n- The `Equal` matcher matches byte slices more performantly.\n- Improved how `MatchError` matches error strings.\n- `MatchXML` ignores the order of xml node attributes.\n- Improve support for XUnit style golang tests. ([#254](https://github.com/onsi/gomega/issues/254))\n\nBug Fixes:\n\n- Diff generation now handles multi-byte sequences correctly.\n- Multiple goroutines can now call `gexec.Build` concurrently.\n\n## 1.2.0\n\nImprovements:\n\n- Added `BeSent` which attempts to send a value down a channel and fails if the attempt blocks. Can be paired with `Eventually` to safely send a value down a channel with a timeout.\n- `Ω`, `Expect`, `Eventually`, and `Consistently` now immediately `panic` if there is no registered fail handler. This is always a mistake that can hide failing tests.\n- `Receive()` no longer errors when passed a closed channel, it's perfectly fine to attempt to read from a closed channel so Ω(c).Should(Receive()) always fails and Ω(c).ShouldNot(Receive()) always passes with a closed channel.\n- Added `HavePrefix` and `HaveSuffix` matchers.\n- `ghttp` can now handle concurrent requests.\n- Added `Succeed` which allows one to write `Ω(MyFunction()).Should(Succeed())`.\n- Improved `ghttp`'s behavior around failing assertions and panics:\n - If a registered handler makes a failing assertion `ghttp` will return `500`.\n - If a registered handler panics, `ghttp` will return `500` *and* fail the test. This is new behavior that may cause existing code to break. This code is almost certainly incorrect and creating a false positive.\n- `ghttp` servers can take an `io.Writer`. `ghttp` will write a line to the writer when each request arrives.\n- Added `WithTransform` matcher to allow munging input data before feeding into the relevant matcher\n- Added boolean `And`, `Or`, and `Not` matchers to allow creating composite matchers\n- Added `gbytes.TimeoutCloser`, `gbytes.TimeoutReader`, and `gbytes.TimeoutWriter` - these are convenience wrappers that timeout if the underlying Closer/Reader/Writer does not return within the allotted time.\n- Added `gbytes.BufferReader` - this constructs a `gbytes.Buffer` that asynchronously reads the passed-in `io.Reader` into its buffer.\n\nBug Fixes:\n- gexec: `session.Wait` now uses `EventuallyWithOffset` to get the right line number in the failure.\n- `ContainElement` no longer bails if a passed-in matcher errors.\n\n## 1.0 (8/2/2014)\n\nNo changes. Dropping \"beta\" from the version number.\n\n## 1.0.0-beta (7/8/2014)\nBreaking Changes:\n\n- Changed OmegaMatcher interface. Instead of having `Match` return failure messages, two new methods `FailureMessage` and `NegatedFailureMessage` are called instead.\n- Moved and renamed OmegaFailHandler to types.GomegaFailHandler and OmegaMatcher to types.GomegaMatcher. Any references to OmegaMatcher in any custom matchers will need to be changed to point to types.GomegaMatcher\n\nNew Test-Support Features:\n\n- `ghttp`: supports testing http clients\n - Provides a flexible fake http server\n - Provides a collection of chainable http handlers that perform assertions.\n- `gbytes`: supports making ordered assertions against streams of data\n - Provides a `gbytes.Buffer`\n - Provides a `Say` matcher to perform ordered assertions against output data\n- `gexec`: supports testing external processes\n - Provides support for building Go binaries\n - Wraps and starts `exec.Cmd` commands\n - Makes it easy to assert against stdout and stderr\n - Makes it easy to send signals and wait for processes to exit\n - Provides an `Exit` matcher to assert against exit code.\n\nDSL Changes:\n\n- `Eventually` and `Consistently` can accept `time.Duration` interval and polling inputs.\n- The default timeouts for `Eventually` and `Consistently` are now configurable.\n\nNew Matchers:\n\n- `ConsistOf`: order-independent assertion against the elements of an array/slice or keys of a map.\n- `BeTemporally`: like `BeNumerically` but for `time.Time`\n- `HaveKeyWithValue`: asserts a map has a given key with the given value.\n\nUpdated Matchers:\n\n- `Receive` matcher can take a matcher as an argument and passes only if the channel under test receives an object that satisfies the passed-in matcher.\n- Matchers that implement `MatchMayChangeInTheFuture(actual interface{}) bool` can inform `Eventually` and/or `Consistently` when a match has no chance of changing status in the future. For example, `Receive` returns `false` when a channel is closed.\n\nMisc:\n\n- Start using semantic versioning\n- Start maintaining changelog\n\nMajor refactor:\n\n- Pull out Gomega's internal to `internal`\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/CONTRIBUTING.md",
"content": "# Contributing to Gomega\n\nYour contributions to Gomega are essential for its long-term maintenance and improvement. To make a contribution:\n\n- Please **open an issue first** - describe what problem you are trying to solve and give the community a forum for input and feedback ahead of investing time in writing code!\n- Ensure adequate test coverage:\n - Make sure to add appropriate unit tests\n - Please run all tests locally (`ginkgo -r -p`) and make sure they go green before submitting the PR\n - Please run following linter locally `go vet ./...` and make sure output does not contain any warnings\n- Update the documentation. In addition to standard `godoc` comments Gomega has extensive documentation on the `gh-pages` branch. If relevant, please submit a docs PR to that branch alongside your code PR.\n\nIf you're a committer, check out RELEASING.md to learn how to cut a release.\n\nThanks for supporting Gomega!\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/LICENSE",
"content": "Copyright (c) 2013-2014 Onsi Fakhouri\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/README.md",
"content": "\n\n[](https://github.com/onsi/gomega/actions/workflows/test.yml)\n\nJump straight to the [docs](http://onsi.github.io/gomega/) to learn about Gomega, including a list of [all available matchers](http://onsi.github.io/gomega/#provided-matchers).\n\nIf you have a question, comment, bug report, feature request, etc. please open a GitHub issue.\n\n## [Ginkgo](http://github.com/onsi/ginkgo): a BDD Testing Framework for Golang\n\nLearn more about Ginkgo [here](http://onsi.github.io/ginkgo/)\n\n## Community Matchers\n\nA collection of community matchers is available on the [wiki](https://github.com/onsi/gomega/wiki).\n\n## License\n\nGomega is MIT-Licensed\n\nThe `ConsistOf` matcher uses [goraph](https://github.com/amitkgupta/goraph) which is embedded in the source to simplify distribution. goraph has an MIT license.\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/RELEASING.md",
"content": "A Gomega release is a tagged sha and a GitHub release. To cut a release:\n\n1. Ensure CHANGELOG.md is up to date.\n - Use \n ```bash\n LAST_VERSION=$(git tag --sort=version:refname | tail -n1)\n CHANGES=$(git log --pretty=format:'- %s [%h]' HEAD...$LAST_VERSION)\n echo -e \"## NEXT\\n\\n$CHANGES\\n\\n### Features\\n\\n### Fixes\\n\\n### Maintenance\\n\\n$(cat CHANGELOG.md)\" > CHANGELOG.md\n ```\n to update the changelog\n - Categorize the changes into\n - Breaking Changes (requires a major version)\n - New Features (minor version)\n - Fixes (fix version)\n - Maintenance (which in general should not be mentioned in `CHANGELOG.md` as they have no user impact)\n1. Update GOMEGA_VERSION in `gomega_dsl.go`\n1. Commit, push, and release:\n ```\n git commit -m \"vM.m.p\"\n git push\n gh release create \"vM.m.p\"\n git fetch --tags origin master\n ```"
},
{
"path": "tests/vendor/github.com/onsi/gomega/format/format.go",
"content": "/*\nGomega's format package pretty-prints objects. It explores input objects recursively and generates formatted, indented output with type information.\n*/\n\n// untested sections: 4\n\npackage format\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"reflect\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n)\n\n// Use MaxDepth to set the maximum recursion depth when printing deeply nested objects\nvar MaxDepth = uint(10)\n\n// MaxLength of the string representation of an object.\n// If MaxLength is set to 0, the Object will not be truncated.\nvar MaxLength = 4000\n\n/*\nBy default, all objects (even those that implement fmt.Stringer and fmt.GoStringer) are recursively inspected to generate output.\n\nSet UseStringerRepresentation = true to use GoString (for fmt.GoStringers) or String (for fmt.Stringer) instead.\n\nNote that GoString and String don't always have all the information you need to understand why a test failed!\n*/\nvar UseStringerRepresentation = false\n\n/*\nPrint the content of context objects. By default it will be suppressed.\n\nSet PrintContextObjects = true to enable printing of the context internals.\n*/\nvar PrintContextObjects = false\n\n// TruncatedDiff choose if we should display a truncated pretty diff or not\nvar TruncatedDiff = true\n\n// TruncateThreshold (default 50) specifies the maximum length string to print in string comparison assertion error\n// messages.\nvar TruncateThreshold uint = 50\n\n// CharactersAroundMismatchToInclude (default 5) specifies how many contextual characters should be printed before and\n// after the first diff location in a truncated string assertion error message.\nvar CharactersAroundMismatchToInclude uint = 5\n\nvar contextType = reflect.TypeOf((*context.Context)(nil)).Elem()\nvar timeType = reflect.TypeOf(time.Time{})\n\n// The default indentation string emitted by the format package\nvar Indent = \" \"\n\nvar longFormThreshold = 20\n\n// GomegaStringer allows for custom formatting of objects for gomega.\ntype GomegaStringer interface {\n\t// GomegaString will be used to custom format an object.\n\t// It does not follow UseStringerRepresentation value and will always be called regardless.\n\t// It also ignores the MaxLength value.\n\tGomegaString() string\n}\n\n/*\nCustomFormatters can be registered with Gomega via RegisterCustomFormatter()\nAny value to be rendered by Gomega is passed to each registered CustomFormatters.\nThe CustomFormatter signals that it will handle formatting the value by returning (formatted-string, true)\nIf the CustomFormatter does not want to handle the object it should return (\"\", false)\n\nStrings returned by CustomFormatters are not truncated\n*/\ntype CustomFormatter func(value any) (string, bool)\ntype CustomFormatterKey uint\n\nvar customFormatterKey CustomFormatterKey = 1\n\ntype customFormatterKeyPair struct {\n\tCustomFormatter\n\tCustomFormatterKey\n}\n\n/*\nRegisterCustomFormatter registers a CustomFormatter and returns a CustomFormatterKey\n\nYou can call UnregisterCustomFormatter with the returned key to unregister the associated CustomFormatter\n*/\nfunc RegisterCustomFormatter(customFormatter CustomFormatter) CustomFormatterKey {\n\tkey := customFormatterKey\n\tcustomFormatterKey += 1\n\tcustomFormatters = append(customFormatters, customFormatterKeyPair{customFormatter, key})\n\treturn key\n}\n\n/*\nUnregisterCustomFormatter unregisters a previously registered CustomFormatter. You should pass in the key returned by RegisterCustomFormatter\n*/\nfunc UnregisterCustomFormatter(key CustomFormatterKey) {\n\tformatters := []customFormatterKeyPair{}\n\tfor _, f := range customFormatters {\n\t\tif f.CustomFormatterKey == key {\n\t\t\tcontinue\n\t\t}\n\t\tformatters = append(formatters, f)\n\t}\n\tcustomFormatters = formatters\n}\n\nvar customFormatters = []customFormatterKeyPair{}\n\n/*\nGenerates a formatted matcher success/failure message of the form:\n\n\tExpected\n\t\t\n\t\n\t\t\n\nIf expected is omitted, then the message looks like:\n\n\tExpected\n\t\t\n\t\n*/\nfunc Message(actual any, message string, expected ...any) string {\n\tif len(expected) == 0 {\n\t\treturn fmt.Sprintf(\"Expected\\n%s\\n%s\", Object(actual, 1), message)\n\t}\n\treturn fmt.Sprintf(\"Expected\\n%s\\n%s\\n%s\", Object(actual, 1), message, Object(expected[0], 1))\n}\n\n/*\n\nGenerates a nicely formatted matcher success / failure message\n\nMuch like Message(...), but it attempts to pretty print diffs in strings\n\nExpected\n : \"...aaaaabaaaaa...\"\nto equal |\n : \"...aaaaazaaaaa...\"\n\n*/\n\nfunc MessageWithDiff(actual, message, expected string) string {\n\tif TruncatedDiff && len(actual) >= int(TruncateThreshold) && len(expected) >= int(TruncateThreshold) {\n\t\tdiffPoint := findFirstMismatch(actual, expected)\n\t\tformattedActual := truncateAndFormat(actual, diffPoint)\n\t\tformattedExpected := truncateAndFormat(expected, diffPoint)\n\n\t\tspacesBeforeFormattedMismatch := findFirstMismatch(formattedActual, formattedExpected)\n\n\t\ttabLength := 4\n\t\tspaceFromMessageToActual := tabLength + len(\": \") - len(message)\n\n\t\tpaddingCount := spaceFromMessageToActual + spacesBeforeFormattedMismatch\n\t\tif paddingCount < 0 {\n\t\t\treturn Message(formattedActual, message, formattedExpected)\n\t\t}\n\n\t\tpadding := strings.Repeat(\" \", paddingCount) + \"|\"\n\t\treturn Message(formattedActual, message+padding, formattedExpected)\n\t}\n\n\tactual = escapedWithGoSyntax(actual)\n\texpected = escapedWithGoSyntax(expected)\n\n\treturn Message(actual, message, expected)\n}\n\nfunc escapedWithGoSyntax(str string) string {\n\twithQuotes := fmt.Sprintf(\"%q\", str)\n\treturn withQuotes[1 : len(withQuotes)-1]\n}\n\nfunc truncateAndFormat(str string, index int) string {\n\tleftPadding := `...`\n\trightPadding := `...`\n\n\tstart := index - int(CharactersAroundMismatchToInclude)\n\tif start < 0 {\n\t\tstart = 0\n\t\tleftPadding = \"\"\n\t}\n\n\t// slice index must include the mis-matched character\n\tlengthOfMismatchedCharacter := 1\n\tend := index + int(CharactersAroundMismatchToInclude) + lengthOfMismatchedCharacter\n\tif end > len(str) {\n\t\tend = len(str)\n\t\trightPadding = \"\"\n\n\t}\n\treturn fmt.Sprintf(\"\\\"%s\\\"\", leftPadding+str[start:end]+rightPadding)\n}\n\nfunc findFirstMismatch(a, b string) int {\n\taSlice := strings.Split(a, \"\")\n\tbSlice := strings.Split(b, \"\")\n\n\tfor index, str := range aSlice {\n\t\tif index > len(bSlice)-1 {\n\t\t\treturn index\n\t\t}\n\t\tif str != bSlice[index] {\n\t\t\treturn index\n\t\t}\n\t}\n\n\tif len(b) > len(a) {\n\t\treturn len(a) + 1\n\t}\n\n\treturn 0\n}\n\nconst truncateHelpText = `\nGomega truncated this representation as it exceeds 'format.MaxLength'.\nConsider having the object provide a custom 'GomegaStringer' representation\nor adjust the parameters in Gomega's 'format' package.\n\nLearn more here: https://onsi.github.io/gomega/#adjusting-output\n`\n\nfunc truncateLongStrings(s string) string {\n\tif MaxLength > 0 && len(s) > MaxLength {\n\t\tvar sb strings.Builder\n\t\tfor i, r := range s {\n\t\t\tif i < MaxLength {\n\t\t\t\tsb.WriteRune(r)\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tbreak\n\t\t}\n\n\t\tsb.WriteString(\"...\\n\")\n\t\tsb.WriteString(truncateHelpText)\n\n\t\treturn sb.String()\n\t}\n\treturn s\n}\n\n/*\nPretty prints the passed in object at the passed in indentation level.\n\nObject recurses into deeply nested objects emitting pretty-printed representations of their components.\n\nModify format.MaxDepth to control how deep the recursion is allowed to go\nSet format.UseStringerRepresentation to true to return object.GoString() or object.String() when available instead of\nrecursing into the object.\n\nSet PrintContextObjects to true to print the content of objects implementing context.Context\n*/\nfunc Object(object any, indentation uint) string {\n\tindent := strings.Repeat(Indent, int(indentation))\n\tvalue := reflect.ValueOf(object)\n\tcommonRepresentation := \"\"\n\tif err, ok := object.(error); ok && !isNilValue(value) { // isNilValue check needed here to avoid nil deref due to boxed nil\n\t\tcommonRepresentation += \"\\n\" + IndentString(err.Error(), indentation) + \"\\n\" + indent\n\t}\n\treturn fmt.Sprintf(\"%s<%s>: %s%s\", indent, formatType(value), commonRepresentation, formatValue(value, indentation, true))\n}\n\n/*\nIndentString takes a string and indents each line by the specified amount.\n*/\nfunc IndentString(s string, indentation uint) string {\n\treturn indentString(s, indentation, true)\n}\n\nfunc indentString(s string, indentation uint, indentFirstLine bool) string {\n\tresult := &strings.Builder{}\n\tcomponents := strings.Split(s, \"\\n\")\n\tindent := strings.Repeat(Indent, int(indentation))\n\tfor i, component := range components {\n\t\tif i > 0 || indentFirstLine {\n\t\t\tresult.WriteString(indent)\n\t\t}\n\t\tresult.WriteString(component)\n\t\tif i < len(components)-1 {\n\t\t\tresult.WriteString(\"\\n\")\n\t\t}\n\t}\n\n\treturn result.String()\n}\n\nfunc formatType(v reflect.Value) string {\n\tswitch v.Kind() {\n\tcase reflect.Invalid:\n\t\treturn \"nil\"\n\tcase reflect.Chan:\n\t\treturn fmt.Sprintf(\"%s | len:%d, cap:%d\", v.Type(), v.Len(), v.Cap())\n\tcase reflect.Ptr:\n\t\treturn fmt.Sprintf(\"%s | 0x%x\", v.Type(), v.Pointer())\n\tcase reflect.Slice:\n\t\treturn fmt.Sprintf(\"%s | len:%d, cap:%d\", v.Type(), v.Len(), v.Cap())\n\tcase reflect.Map:\n\t\treturn fmt.Sprintf(\"%s | len:%d\", v.Type(), v.Len())\n\tdefault:\n\t\treturn v.Type().String()\n\t}\n}\n\nfunc formatValue(value reflect.Value, indentation uint, isTopLevel bool) string {\n\tif indentation > MaxDepth {\n\t\treturn \"...\"\n\t}\n\n\tif isNilValue(value) {\n\t\treturn \"nil\"\n\t}\n\n\tif value.CanInterface() {\n\t\tobj := value.Interface()\n\n\t\t// if a CustomFormatter handles this values, we'll go with that\n\t\tfor _, customFormatter := range customFormatters {\n\t\t\tformatted, handled := customFormatter.CustomFormatter(obj)\n\t\t\t// do not truncate a user-provided CustomFormatter()\n\t\t\tif handled {\n\t\t\t\treturn indentString(formatted, indentation+1, false)\n\t\t\t}\n\t\t}\n\n\t\t// GomegaStringer will take precedence to other representations and disregards UseStringerRepresentation\n\t\tif x, ok := obj.(GomegaStringer); ok {\n\t\t\t// do not truncate a user-defined GomegaString() value\n\t\t\treturn indentString(x.GomegaString(), indentation+1, false)\n\t\t}\n\n\t\tif UseStringerRepresentation {\n\t\t\tswitch x := obj.(type) {\n\t\t\tcase fmt.GoStringer:\n\t\t\t\treturn indentString(truncateLongStrings(x.GoString()), indentation+1, false)\n\t\t\tcase fmt.Stringer:\n\t\t\t\treturn indentString(truncateLongStrings(x.String()), indentation+1, false)\n\t\t\t}\n\t\t}\n\t}\n\n\tif !PrintContextObjects {\n\t\tif value.Type().Implements(contextType) && indentation > 1 {\n\t\t\treturn \"\"\n\t\t}\n\t}\n\n\tswitch value.Kind() {\n\tcase reflect.Bool:\n\t\treturn fmt.Sprintf(\"%v\", value.Bool())\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn fmt.Sprintf(\"%v\", value.Int())\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:\n\t\treturn fmt.Sprintf(\"%v\", value.Uint())\n\tcase reflect.Uintptr:\n\t\treturn fmt.Sprintf(\"0x%x\", value.Uint())\n\tcase reflect.Float32, reflect.Float64:\n\t\treturn fmt.Sprintf(\"%v\", value.Float())\n\tcase reflect.Complex64, reflect.Complex128:\n\t\treturn fmt.Sprintf(\"%v\", value.Complex())\n\tcase reflect.Chan:\n\t\treturn fmt.Sprintf(\"0x%x\", value.Pointer())\n\tcase reflect.Func:\n\t\treturn fmt.Sprintf(\"0x%x\", value.Pointer())\n\tcase reflect.Ptr:\n\t\treturn formatValue(value.Elem(), indentation, isTopLevel)\n\tcase reflect.Slice:\n\t\treturn truncateLongStrings(formatSlice(value, indentation))\n\tcase reflect.String:\n\t\treturn truncateLongStrings(formatString(value.String(), indentation, isTopLevel))\n\tcase reflect.Array:\n\t\treturn truncateLongStrings(formatSlice(value, indentation))\n\tcase reflect.Map:\n\t\treturn truncateLongStrings(formatMap(value, indentation))\n\tcase reflect.Struct:\n\t\tif value.Type() == timeType && value.CanInterface() {\n\t\t\tt, _ := value.Interface().(time.Time)\n\t\t\treturn t.Format(time.RFC3339Nano)\n\t\t}\n\t\treturn truncateLongStrings(formatStruct(value, indentation))\n\tcase reflect.Interface:\n\t\treturn formatInterface(value, indentation)\n\tdefault:\n\t\tif value.CanInterface() {\n\t\t\treturn truncateLongStrings(fmt.Sprintf(\"%#v\", value.Interface()))\n\t\t}\n\t\treturn truncateLongStrings(fmt.Sprintf(\"%#v\", value))\n\t}\n}\n\nfunc formatString(object any, indentation uint, isTopLevel bool) string {\n\tif isTopLevel {\n\t\ts := fmt.Sprintf(\"%s\", object)\n\t\tcomponents := strings.Split(s, \"\\n\")\n\t\tresult := \"\"\n\t\tfor i, component := range components {\n\t\t\tif i == 0 {\n\t\t\t\tresult += component\n\t\t\t} else {\n\t\t\t\tresult += Indent + component\n\t\t\t}\n\t\t\tif i < len(components)-1 {\n\t\t\t\tresult += \"\\n\"\n\t\t\t}\n\t\t}\n\n\t\treturn result\n\t} else {\n\t\treturn fmt.Sprintf(\"%q\", object)\n\t}\n}\n\nfunc formatSlice(v reflect.Value, indentation uint) string {\n\tif v.Kind() == reflect.Slice && v.Type().Elem().Kind() == reflect.Uint8 && isPrintableString(string(v.Bytes())) {\n\t\treturn formatString(v.Bytes(), indentation, false)\n\t}\n\n\tl := v.Len()\n\tresult := make([]string, l)\n\tlongest := 0\n\tfor i := range l {\n\t\tresult[i] = formatValue(v.Index(i), indentation+1, false)\n\t\tif len(result[i]) > longest {\n\t\t\tlongest = len(result[i])\n\t\t}\n\t}\n\n\tif longest > longFormThreshold {\n\t\tindenter := strings.Repeat(Indent, int(indentation))\n\t\treturn fmt.Sprintf(\"[\\n%s%s,\\n%s]\", indenter+Indent, strings.Join(result, \",\\n\"+indenter+Indent), indenter)\n\t}\n\treturn fmt.Sprintf(\"[%s]\", strings.Join(result, \", \"))\n}\n\nfunc formatMap(v reflect.Value, indentation uint) string {\n\tl := v.Len()\n\tresult := make([]string, l)\n\n\tlongest := 0\n\tfor i, key := range v.MapKeys() {\n\t\tvalue := v.MapIndex(key)\n\t\tresult[i] = fmt.Sprintf(\"%s: %s\", formatValue(key, indentation+1, false), formatValue(value, indentation+1, false))\n\t\tif len(result[i]) > longest {\n\t\t\tlongest = len(result[i])\n\t\t}\n\t}\n\n\tif longest > longFormThreshold {\n\t\tindenter := strings.Repeat(Indent, int(indentation))\n\t\treturn fmt.Sprintf(\"{\\n%s%s,\\n%s}\", indenter+Indent, strings.Join(result, \",\\n\"+indenter+Indent), indenter)\n\t}\n\treturn fmt.Sprintf(\"{%s}\", strings.Join(result, \", \"))\n}\n\nfunc formatStruct(v reflect.Value, indentation uint) string {\n\tt := v.Type()\n\n\tl := v.NumField()\n\tresult := []string{}\n\tlongest := 0\n\tfor i := range l {\n\t\tstructField := t.Field(i)\n\t\tfieldEntry := v.Field(i)\n\t\trepresentation := fmt.Sprintf(\"%s: %s\", structField.Name, formatValue(fieldEntry, indentation+1, false))\n\t\tresult = append(result, representation)\n\t\tif len(representation) > longest {\n\t\t\tlongest = len(representation)\n\t\t}\n\t}\n\tif longest > longFormThreshold {\n\t\tindenter := strings.Repeat(Indent, int(indentation))\n\t\treturn fmt.Sprintf(\"{\\n%s%s,\\n%s}\", indenter+Indent, strings.Join(result, \",\\n\"+indenter+Indent), indenter)\n\t}\n\treturn fmt.Sprintf(\"{%s}\", strings.Join(result, \", \"))\n}\n\nfunc formatInterface(v reflect.Value, indentation uint) string {\n\treturn fmt.Sprintf(\"<%s>%s\", formatType(v.Elem()), formatValue(v.Elem(), indentation, false))\n}\n\nfunc isNilValue(a reflect.Value) bool {\n\tswitch a.Kind() {\n\tcase reflect.Invalid:\n\t\treturn true\n\tcase reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice:\n\t\treturn a.IsNil()\n\t}\n\n\treturn false\n}\n\n/*\nReturns true when the string is entirely made of printable runes, false otherwise.\n*/\nfunc isPrintableString(str string) bool {\n\tfor _, runeValue := range str {\n\t\tif !strconv.IsPrint(runeValue) {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/gomega_dsl.go",
"content": "/*\nGomega is the Ginkgo BDD-style testing framework's preferred matcher library.\n\nThe godoc documentation describes Gomega's API. More comprehensive documentation (with examples!) is available at http://onsi.github.io/gomega/\n\nGomega on Github: http://github.com/onsi/gomega\n\nLearn more about Ginkgo online: http://onsi.github.io/ginkgo\n\nGinkgo on Github: http://github.com/onsi/ginkgo\n\nGomega is MIT-Licensed\n*/\npackage gomega\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/onsi/gomega/internal\"\n\t\"github.com/onsi/gomega/types\"\n)\n\nconst GOMEGA_VERSION = \"1.39.1\"\n\nconst nilGomegaPanic = `You are trying to make an assertion, but haven't registered Gomega's fail handler.\nIf you're using Ginkgo then you probably forgot to put your assertion in an It().\nAlternatively, you may have forgotten to register a fail handler with RegisterFailHandler() or RegisterTestingT().\nDepending on your vendoring solution you may be inadvertently importing gomega and subpackages (e.g. ghhtp, gexec,...) from different locations.\n`\n\n// Gomega describes the essential Gomega DSL. This interface allows libraries\n// to abstract between the standard package-level function implementations\n// and alternatives like *WithT.\n//\n// The types in the top-level DSL have gotten a bit messy due to earlier deprecations that avoid stuttering\n// and due to an accidental use of a concrete type (*WithT) in an earlier release.\n//\n// As of 1.15 both the WithT and Ginkgo variants of Gomega are implemented by the same underlying object\n// however one (the Ginkgo variant) is exported as an interface (types.Gomega) whereas the other (the withT variant)\n// is shared as a concrete type (*WithT, which is aliased to *internal.Gomega). 1.15 did not clean this mess up to ensure\n// that declarations of *WithT in existing code are not broken by the upgrade to 1.15.\ntype Gomega = types.Gomega\n\n// DefaultGomega supplies the standard package-level implementation\nvar Default = Gomega(internal.NewGomega(internal.FetchDefaultDurationBundle()))\n\n// NewGomega returns an instance of Gomega wired into the passed-in fail handler.\n// You generally don't need to use this when using Ginkgo - RegisterFailHandler will wire up the global gomega\n// However creating a NewGomega with a custom fail handler can be useful in contexts where you want to use Gomega's\n// rich ecosystem of matchers without causing a test to fail. For example, to aggregate a series of potential failures\n// or for use in a non-test setting.\nfunc NewGomega(fail types.GomegaFailHandler) Gomega {\n\treturn internal.NewGomega(internalGomega(Default).DurationBundle).ConfigureWithFailHandler(fail)\n}\n\n// WithT wraps a *testing.T and provides `Expect`, `Eventually`, and `Consistently` methods. This allows you to leverage\n// Gomega's rich ecosystem of matchers in standard `testing` test suites.\n//\n// Use `NewWithT` to instantiate a `WithT`\n//\n// As of 1.15 both the WithT and Ginkgo variants of Gomega are implemented by the same underlying object\n// however one (the Ginkgo variant) is exported as an interface (types.Gomega) whereas the other (the withT variant)\n// is shared as a concrete type (*WithT, which is aliased to *internal.Gomega). 1.15 did not clean this mess up to ensure\n// that declarations of *WithT in existing code are not broken by the upgrade to 1.15.\ntype WithT = internal.Gomega\n\n// GomegaWithT is deprecated in favor of gomega.WithT, which does not stutter.\ntype GomegaWithT = WithT\n\n// inner is an interface that allows users to provide a wrapper around Default. The wrapper\n// must implement the inner interface and return either the original Default or the result of\n// a call to NewGomega().\ntype inner interface {\n\tInner() Gomega\n}\n\nfunc internalGomega(g Gomega) *internal.Gomega {\n\tif v, ok := g.(inner); ok {\n\t\treturn v.Inner().(*internal.Gomega)\n\t}\n\treturn g.(*internal.Gomega)\n}\n\n// NewWithT takes a *testing.T and returns a `gomega.WithT` allowing you to use `Expect`, `Eventually`, and `Consistently` along with\n// Gomega's rich ecosystem of matchers in standard `testing` test suits.\n//\n//\tfunc TestFarmHasCow(t *testing.T) {\n//\t g := gomega.NewWithT(t)\n//\n//\t f := farm.New([]string{\"Cow\", \"Horse\"})\n//\t g.Expect(f.HasCow()).To(BeTrue(), \"Farm should have cow\")\n//\t }\nfunc NewWithT(t types.GomegaTestingT) *WithT {\n\treturn internal.NewGomega(internalGomega(Default).DurationBundle).ConfigureWithT(t)\n}\n\n// NewGomegaWithT is deprecated in favor of gomega.NewWithT, which does not stutter.\nvar NewGomegaWithT = NewWithT\n\n// RegisterFailHandler connects Ginkgo to Gomega. When a matcher fails\n// the fail handler passed into RegisterFailHandler is called.\nfunc RegisterFailHandler(fail types.GomegaFailHandler) {\n\tinternalGomega(Default).ConfigureWithFailHandler(fail)\n}\n\n// RegisterFailHandlerWithT is deprecated and will be removed in a future release.\n// users should use RegisterFailHandler, or RegisterTestingT\nfunc RegisterFailHandlerWithT(_ types.GomegaTestingT, fail types.GomegaFailHandler) {\n\tfmt.Println(\"RegisterFailHandlerWithT is deprecated. Please use RegisterFailHandler or RegisterTestingT instead.\")\n\tinternalGomega(Default).ConfigureWithFailHandler(fail)\n}\n\n// RegisterTestingT connects Gomega to Golang's XUnit style\n// Testing.T tests. It is now deprecated and you should use NewWithT() instead to get a fresh instance of Gomega for each test.\nfunc RegisterTestingT(t types.GomegaTestingT) {\n\tinternalGomega(Default).ConfigureWithT(t)\n}\n\n// InterceptGomegaFailures runs a given callback and returns an array of\n// failure messages generated by any Gomega assertions within the callback.\n// Execution continues after the first failure allowing users to collect all failures\n// in the callback.\n//\n// This is most useful when testing custom matchers, but can also be used to check\n// on a value using a Gomega assertion without causing a test failure.\nfunc InterceptGomegaFailures(f func()) []string {\n\toriginalHandler := internalGomega(Default).Fail\n\tfailures := []string{}\n\tinternalGomega(Default).Fail = func(message string, callerSkip ...int) {\n\t\tfailures = append(failures, message)\n\t}\n\tdefer func() {\n\t\tinternalGomega(Default).Fail = originalHandler\n\t}()\n\tf()\n\treturn failures\n}\n\n// InterceptGomegaFailure runs a given callback and returns the first\n// failure message generated by any Gomega assertions within the callback, wrapped in an error.\n//\n// The callback ceases execution as soon as the first failed assertion occurs, however Gomega\n// does not register a failure with the FailHandler registered via RegisterFailHandler - it is up\n// to the user to decide what to do with the returned error\nfunc InterceptGomegaFailure(f func()) (err error) {\n\toriginalHandler := internalGomega(Default).Fail\n\tinternalGomega(Default).Fail = func(message string, callerSkip ...int) {\n\t\terr = errors.New(message)\n\t\tpanic(\"stop execution\")\n\t}\n\n\tdefer func() {\n\t\tinternalGomega(Default).Fail = originalHandler\n\t\tif e := recover(); e != nil {\n\t\t\tif err == nil {\n\t\t\t\tpanic(e)\n\t\t\t}\n\t\t}\n\t}()\n\n\tf()\n\treturn err\n}\n\nfunc ensureDefaultGomegaIsConfigured() {\n\tif !internalGomega(Default).IsConfigured() {\n\t\tpanic(nilGomegaPanic)\n\t}\n}\n\n// Ω wraps an actual value allowing assertions to be made on it:\n//\n//\tΩ(\"foo\").Should(Equal(\"foo\"))\n//\n// If Ω is passed more than one argument it will pass the *first* argument to the matcher.\n// All subsequent arguments will be required to be nil/zero.\n//\n// This is convenient if you want to make an assertion on a method/function that returns\n// a value and an error - a common pattern in Go.\n//\n// For example, given a function with signature:\n//\n//\tfunc MyAmazingThing() (int, error)\n//\n// Then:\n//\n//\tΩ(MyAmazingThing()).Should(Equal(3))\n//\n// Will succeed only if `MyAmazingThing()` returns `(3, nil)`\n//\n// Ω and Expect are identical\nfunc Ω(actual any, extra ...any) Assertion {\n\tensureDefaultGomegaIsConfigured()\n\treturn Default.Ω(actual, extra...)\n}\n\n// Expect wraps an actual value allowing assertions to be made on it:\n//\n//\tExpect(\"foo\").To(Equal(\"foo\"))\n//\n// If Expect is passed more than one argument it will pass the *first* argument to the matcher.\n// All subsequent arguments will be required to be nil/zero.\n//\n// This is convenient if you want to make an assertion on a method/function that returns\n// a value and an error - a common pattern in Go.\n//\n// For example, given a function with signature:\n//\n//\tfunc MyAmazingThing() (int, error)\n//\n// Then:\n//\n//\tExpect(MyAmazingThing()).Should(Equal(3))\n//\n// Will succeed only if `MyAmazingThing()` returns `(3, nil)`\n//\n// Expect and Ω are identical\nfunc Expect(actual any, extra ...any) Assertion {\n\tensureDefaultGomegaIsConfigured()\n\treturn Default.Expect(actual, extra...)\n}\n\n// ExpectWithOffset wraps an actual value allowing assertions to be made on it:\n//\n//\tExpectWithOffset(1, \"foo\").To(Equal(\"foo\"))\n//\n// Unlike `Expect` and `Ω`, `ExpectWithOffset` takes an additional integer argument\n// that is used to modify the call-stack offset when computing line numbers. It is\n// the same as `Expect(...).WithOffset`.\n//\n// This is most useful in helper functions that make assertions. If you want Gomega's\n// error message to refer to the calling line in the test (as opposed to the line in the helper function)\n// set the first argument of `ExpectWithOffset` appropriately.\nfunc ExpectWithOffset(offset int, actual any, extra ...any) Assertion {\n\tensureDefaultGomegaIsConfigured()\n\treturn Default.ExpectWithOffset(offset, actual, extra...)\n}\n\n/*\nEventually enables making assertions on asynchronous behavior.\n\nEventually checks that an assertion *eventually* passes. Eventually blocks when called and attempts an assertion periodically until it passes or a timeout occurs. Both the timeout and polling interval are configurable as optional arguments.\nThe first optional argument is the timeout (which defaults to 1s), the second is the polling interval (which defaults to 10ms). Both intervals can be specified as time.Duration, parsable duration strings or floats/integers (in which case they are interpreted as seconds). In addition an optional context.Context can be passed in - Eventually will keep trying until either the timeout expires or the context is cancelled, whichever comes first.\n\nEventually works with any Gomega compatible matcher and supports making assertions against three categories of actual value:\n\n**Category 1: Making Eventually assertions on values**\n\nThere are several examples of values that can change over time. These can be passed in to Eventually and will be passed to the matcher repeatedly until a match occurs. For example:\n\n\tc := make(chan bool)\n\tgo DoStuff(c)\n\tEventually(c, \"50ms\").Should(BeClosed())\n\nwill poll the channel repeatedly until it is closed. In this example `Eventually` will block until either the specified timeout of 50ms has elapsed or the channel is closed, whichever comes first.\n\nSeveral Gomega libraries allow you to use Eventually in this way. For example, the gomega/gexec package allows you to block until a *gexec.Session exits successfully via:\n\n\tEventually(session).Should(gexec.Exit(0))\n\nAnd the gomega/gbytes package allows you to monitor a streaming *gbytes.Buffer until a given string is seen:\n\n\tEventually(buffer).Should(gbytes.Say(\"hello there\"))\n\nIn these examples, both `session` and `buffer` are designed to be thread-safe when polled by the `Exit` and `Say` matchers. This is not true in general of most raw values, so while it is tempting to do something like:\n\n\t// THIS IS NOT THREAD-SAFE\n\tvar s *string\n\tgo mutateStringEventually(s)\n\tEventually(s).Should(Equal(\"I've changed\"))\n\nthis will trigger Go's race detector as the goroutine polling via Eventually will race over the value of s with the goroutine mutating the string. For cases like this you can use channels or introduce your own locking around s by passing Eventually a function.\n\n**Category 2: Make Eventually assertions on functions**\n\nEventually can be passed functions that **return at least one value**. When configured this way, Eventually will poll the function repeatedly and pass the first returned value to the matcher.\n\nFor example:\n\n\t Eventually(func() int {\n\t \treturn client.FetchCount()\n\t }).Should(BeNumerically(\">=\", 17))\n\n\twill repeatedly poll client.FetchCount until the BeNumerically matcher is satisfied. (Note that this example could have been written as Eventually(client.FetchCount).Should(BeNumerically(\">=\", 17)))\n\nIf multiple values are returned by the function, Eventually will pass the first value to the matcher and require that all others are zero-valued. This allows you to pass Eventually a function that returns a value and an error - a common pattern in Go.\n\nFor example, consider a method that returns a value and an error:\n\n\tfunc FetchFromDB() (string, error)\n\nThen\n\n\tEventually(FetchFromDB).Should(Equal(\"got it\"))\n\nwill pass only if and when the returned error is nil *and* the returned string satisfies the matcher.\n\nEventually can also accept functions that take arguments, however you must provide those arguments using .WithArguments(). For example, consider a function that takes a user-id and makes a network request to fetch a full name:\n\n\tfunc FetchFullName(userId int) (string, error)\n\nYou can poll this function like so:\n\n\tEventually(FetchFullName).WithArguments(1138).Should(Equal(\"Wookie\"))\n\nIt is important to note that the function passed into Eventually is invoked *synchronously* when polled. Eventually does not (in fact, it cannot) kill the function if it takes longer to return than Eventually's configured timeout. A common practice here is to use a context. Here's an example that combines Ginkgo's spec timeout support with Eventually:\n\n\tIt(\"fetches the correct count\", func(ctx SpecContext) {\n\t\tEventually(ctx, func() int {\n\t\t\treturn client.FetchCount(ctx, \"/users\")\n\t\t}).Should(BeNumerically(\">=\", 17))\n\t}, SpecTimeout(time.Second))\n\nyou an also use Eventually().WithContext(ctx) to pass in the context. Passed-in contexts play nicely with passed-in arguments as long as the context appears first. You can rewrite the above example as:\n\n\tIt(\"fetches the correct count\", func(ctx SpecContext) {\n\t\tEventually(client.FetchCount).WithContext(ctx).WithArguments(\"/users\").Should(BeNumerically(\">=\", 17))\n\t}, SpecTimeout(time.Second))\n\nEither way the context passed to Eventually is also passed to the underlying function. Now, when Ginkgo cancels the context both the FetchCount client and Gomega will be informed and can exit.\n\nBy default, when a context is passed to Eventually *without* an explicit timeout, Gomega will rely solely on the context's cancellation to determine when to stop polling. If you want to specify a timeout in addition to the context you can do so using the .WithTimeout() method. For example:\n\n\tEventually(client.FetchCount).WithContext(ctx).WithTimeout(10*time.Second).Should(BeNumerically(\">=\", 17))\n\nnow either the context cancellation or the timeout will cause Eventually to stop polling.\n\nIf, instead, you would like to opt out of this behavior and have Gomega's default timeouts govern Eventuallys that take a context you can call:\n\n\tEnforceDefaultTimeoutsWhenUsingContexts()\n\nin the DSL (or on a Gomega instance). Now all calls to Eventually that take a context will fail if either the context is cancelled or the default timeout elapses.\n\n**Category 3: Making assertions _in_ the function passed into Eventually**\n\nWhen testing complex systems it can be valuable to assert that a _set_ of assertions passes Eventually. Eventually supports this by accepting functions that take a single Gomega argument and return zero or more values.\n\nHere's an example that makes some assertions and returns a value and error:\n\n\tEventually(func(g Gomega) (Widget, error) {\n\t\tids, err := client.FetchIDs()\n\t\tg.Expect(err).NotTo(HaveOccurred())\n\t\tg.Expect(ids).To(ContainElement(1138))\n\t\treturn client.FetchWidget(1138)\n\t}).Should(Equal(expectedWidget))\n\nwill pass only if all the assertions in the polled function pass and the return value satisfied the matcher.\n\nEventually also supports a special case polling function that takes a single Gomega argument and returns no values. Eventually assumes such a function is making assertions and is designed to work with the Succeed matcher to validate that all assertions have passed.\nFor example:\n\n\tEventually(func(g Gomega) {\n\t\tmodel, err := client.Find(1138)\n\t\tg.Expect(err).NotTo(HaveOccurred())\n\t\tg.Expect(model.Reticulate()).To(Succeed())\n\t\tg.Expect(model.IsReticulated()).To(BeTrue())\n\t\tg.Expect(model.Save()).To(Succeed())\n\t}).Should(Succeed())\n\nwill rerun the function until all assertions pass.\n\nYou can also pass additional arguments to functions that take a Gomega. The only rule is that the Gomega argument must be first. If you also want to pass the context attached to Eventually you must ensure that is the second argument. For example:\n\n\tEventually(func(g Gomega, ctx context.Context, path string, expected ...string){\n\t\ttok, err := client.GetToken(ctx)\n\t\tg.Expect(err).NotTo(HaveOccurred())\n\n\t\telements, err := client.Fetch(ctx, tok, path)\n\t\tg.Expect(err).NotTo(HaveOccurred())\n\t\tg.Expect(elements).To(ConsistOf(expected))\n\t}).WithContext(ctx).WithArguments(\"/names\", \"Joe\", \"Jane\", \"Sam\").Should(Succeed())\n\nYou can ensure that you get a number of consecutive successful tries before succeeding using `MustPassRepeatedly(int)`. For Example:\n\n\tint count := 0\n\tEventually(func() bool {\n\t\tcount++\n\t\treturn count > 2\n\t}).MustPassRepeatedly(2).Should(BeTrue())\n\t// Because we had to wait for 2 calls that returned true\n\tExpect(count).To(Equal(3))\n\nFinally, in addition to passing timeouts and a context to Eventually you can be more explicit with Eventually's chaining configuration methods:\n\n\tEventually(..., \"10s\", \"2s\", ctx).Should(...)\n\nis equivalent to\n\n\tEventually(...).WithTimeout(10*time.Second).WithPolling(2*time.Second).WithContext(ctx).Should(...)\n*/\nfunc Eventually(actualOrCtx any, args ...any) AsyncAssertion {\n\tensureDefaultGomegaIsConfigured()\n\treturn Default.Eventually(actualOrCtx, args...)\n}\n\n// EventuallyWithOffset operates like Eventually but takes an additional\n// initial argument to indicate an offset in the call stack. This is useful when building helper\n// functions that contain matchers. To learn more, read about `ExpectWithOffset`.\n//\n// `EventuallyWithOffset` is the same as `Eventually(...).WithOffset`.\n//\n// `EventuallyWithOffset` specifying a timeout interval (and an optional polling interval) are\n// the same as `Eventually(...).WithOffset(...).WithTimeout` or\n// `Eventually(...).WithOffset(...).WithTimeout(...).WithPolling`.\nfunc EventuallyWithOffset(offset int, actualOrCtx any, args ...any) AsyncAssertion {\n\tensureDefaultGomegaIsConfigured()\n\treturn Default.EventuallyWithOffset(offset, actualOrCtx, args...)\n}\n\n/*\nConsistently, like Eventually, enables making assertions on asynchronous behavior.\n\nConsistently blocks when called for a specified duration. During that duration Consistently repeatedly polls its matcher and ensures that it is satisfied. If the matcher is consistently satisfied, then Consistently will pass. Otherwise Consistently will fail.\n\nBoth the total waiting duration and the polling interval are configurable as optional arguments. The first optional argument is the duration that Consistently will run for (defaults to 100ms), and the second argument is the polling interval (defaults to 10ms). As with Eventually, these intervals can be passed in as time.Duration, parsable duration strings or an integer or float number of seconds. You can also pass in an optional context.Context - Consistently will exit early (with a failure) if the context is cancelled before the waiting duration expires.\n\nConsistently accepts the same three categories of actual as Eventually, check the Eventually docs to learn more.\n\nConsistently is useful in cases where you want to assert that something *does not happen* for a period of time. For example, you may want to assert that a goroutine does *not* send data down a channel. In this case you could write:\n\n\tConsistently(channel, \"200ms\").ShouldNot(Receive())\n\nThis will block for 200 milliseconds and repeatedly check the channel and ensure nothing has been received.\n*/\nfunc Consistently(actualOrCtx any, args ...any) AsyncAssertion {\n\tensureDefaultGomegaIsConfigured()\n\treturn Default.Consistently(actualOrCtx, args...)\n}\n\n// ConsistentlyWithOffset operates like Consistently but takes an additional\n// initial argument to indicate an offset in the call stack. This is useful when building helper\n// functions that contain matchers. To learn more, read about `ExpectWithOffset`.\n//\n// `ConsistentlyWithOffset` is the same as `Consistently(...).WithOffset` and\n// optional `WithTimeout` and `WithPolling`.\nfunc ConsistentlyWithOffset(offset int, actualOrCtx any, args ...any) AsyncAssertion {\n\tensureDefaultGomegaIsConfigured()\n\treturn Default.ConsistentlyWithOffset(offset, actualOrCtx, args...)\n}\n\n/*\nStopTrying can be used to signal to Eventually and Consistently that they should abort and stop trying. This always results in a failure of the assertion - and the failure message is the content of the StopTrying signal.\n\nYou can send the StopTrying signal by either returning StopTrying(\"message\") as an error from your passed-in function _or_ by calling StopTrying(\"message\").Now() to trigger a panic and end execution.\n\nYou can also wrap StopTrying around an error with `StopTrying(\"message\").Wrap(err)` and can attach additional objects via `StopTrying(\"message\").Attach(\"description\", object). When rendered, the signal will include the wrapped error and any attached objects rendered using Gomega's default formatting.\n\nHere are a couple of examples. This is how you might use StopTrying() as an error to signal that Eventually should stop:\n\n\tplayerIndex, numPlayers := 0, 11\n\tEventually(func() (string, error) {\n\t if playerIndex == numPlayers {\n\t return \"\", StopTrying(\"no more players left\")\n\t }\n\t name := client.FetchPlayer(playerIndex)\n\t playerIndex += 1\n\t return name, nil\n\t}).Should(Equal(\"Patrick Mahomes\"))\n\nAnd here's an example where `StopTrying().Now()` is called to halt execution immediately:\n\n\tEventually(func() []string {\n\t\tnames, err := client.FetchAllPlayers()\n\t\tif err == client.IRRECOVERABLE_ERROR {\n\t\t\tStopTrying(\"Irrecoverable error occurred\").Wrap(err).Now()\n\t\t}\n\t\treturn names\n\t}).Should(ContainElement(\"Patrick Mahomes\"))\n*/\nvar StopTrying = internal.StopTrying\n\n/*\nTryAgainAfter() allows you to adjust the polling interval for the _next_ iteration of `Eventually` or `Consistently`. Like `StopTrying` you can either return `TryAgainAfter` as an error or trigger it immedieately with `.Now()`\n\nWhen `TryAgainAfter(` is triggered `Eventually` and `Consistently` will wait for that duration. If a timeout occurs before the next poll is triggered both `Eventually` and `Consistently` will always fail with the content of the TryAgainAfter message. As with StopTrying you can `.Wrap()` and error and `.Attach()` additional objects to `TryAgainAfter`.\n*/\nvar TryAgainAfter = internal.TryAgainAfter\n\n/*\nPollingSignalError is the error returned by StopTrying() and TryAgainAfter()\n*/\ntype PollingSignalError = internal.PollingSignalError\n\n// SetDefaultEventuallyTimeout sets the default timeout duration for Eventually. Eventually will repeatedly poll your condition until it succeeds, or until this timeout elapses.\nfunc SetDefaultEventuallyTimeout(t time.Duration) {\n\tDefault.SetDefaultEventuallyTimeout(t)\n}\n\n// SetDefaultEventuallyPollingInterval sets the default polling interval for Eventually.\nfunc SetDefaultEventuallyPollingInterval(t time.Duration) {\n\tDefault.SetDefaultEventuallyPollingInterval(t)\n}\n\n// SetDefaultConsistentlyDuration sets the default duration for Consistently. Consistently will verify that your condition is satisfied for this long.\nfunc SetDefaultConsistentlyDuration(t time.Duration) {\n\tDefault.SetDefaultConsistentlyDuration(t)\n}\n\n// SetDefaultConsistentlyPollingInterval sets the default polling interval for Consistently.\nfunc SetDefaultConsistentlyPollingInterval(t time.Duration) {\n\tDefault.SetDefaultConsistentlyPollingInterval(t)\n}\n\n// EnforceDefaultTimeoutsWhenUsingContexts forces `Eventually` to apply a default timeout even when a context is provided.\nfunc EnforceDefaultTimeoutsWhenUsingContexts() {\n\tDefault.EnforceDefaultTimeoutsWhenUsingContexts()\n}\n\n// DisableDefaultTimeoutsWhenUsingContext disables the default timeout when a context is provided to `Eventually`.\nfunc DisableDefaultTimeoutsWhenUsingContext() {\n\tDefault.DisableDefaultTimeoutsWhenUsingContext()\n}\n\n// AsyncAssertion is returned by Eventually and Consistently and polls the actual value passed into Eventually against\n// the matcher passed to the Should and ShouldNot methods.\n//\n// Both Should and ShouldNot take a variadic optionalDescription argument.\n// This argument allows you to make your failure messages more descriptive.\n// If a single argument of type `func() string` is passed, this function will be lazily evaluated if a failure occurs\n// and the returned string is used to annotate the failure message.\n// Otherwise, this argument is passed on to fmt.Sprintf() and then used to annotate the failure message.\n//\n// Both Should and ShouldNot return a boolean that is true if the assertion passed and false if it failed.\n//\n// Example:\n//\n//\tEventually(myChannel).Should(Receive(), \"Something should have come down the pipe.\")\n//\tConsistently(myChannel).ShouldNot(Receive(), func() string { return \"Nothing should have come down the pipe.\" })\ntype AsyncAssertion = types.AsyncAssertion\n\n// GomegaAsyncAssertion is deprecated in favor of AsyncAssertion, which does not stutter.\ntype GomegaAsyncAssertion = types.AsyncAssertion\n\n// Assertion is returned by Ω and Expect and compares the actual value to the matcher\n// passed to the Should/ShouldNot and To/ToNot/NotTo methods.\n//\n// Typically Should/ShouldNot are used with Ω and To/ToNot/NotTo are used with Expect\n// though this is not enforced.\n//\n// All methods take a variadic optionalDescription argument.\n// This argument allows you to make your failure messages more descriptive.\n// If a single argument of type `func() string` is passed, this function will be lazily evaluated if a failure occurs\n// and the returned string is used to annotate the failure message.\n// Otherwise, this argument is passed on to fmt.Sprintf() and then used to annotate the failure message.\n//\n// All methods return a bool that is true if the assertion passed and false if it failed.\n//\n// Example:\n//\n//\tΩ(farm.HasCow()).Should(BeTrue(), \"Farm %v should have a cow\", farm)\ntype Assertion = types.Assertion\n\n// GomegaAssertion is deprecated in favor of Assertion, which does not stutter.\ntype GomegaAssertion = types.Assertion\n\n// OmegaMatcher is deprecated in favor of the better-named and better-organized types.GomegaMatcher but sticks around to support existing code that uses it\ntype OmegaMatcher = types.GomegaMatcher\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/internal/assertion.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/types\"\n)\n\ntype Assertion struct {\n\tactuals []any // actual value plus all extra values\n\tactualIndex int // value to pass to the matcher\n\tvet vetinari // the vet to call before calling Gomega matcher\n\toffset int\n\tg *Gomega\n}\n\n// ...obligatory discworld reference, as \"vetineer\" doesn't sound ... quite right.\ntype vetinari func(assertion *Assertion, optionalDescription ...any) bool\n\nfunc NewAssertion(actualInput any, g *Gomega, offset int, extra ...any) *Assertion {\n\treturn &Assertion{\n\t\tactuals: append([]any{actualInput}, extra...),\n\t\tactualIndex: 0,\n\t\tvet: (*Assertion).vetActuals,\n\t\toffset: offset,\n\t\tg: g,\n\t}\n}\n\nfunc (assertion *Assertion) WithOffset(offset int) types.Assertion {\n\tassertion.offset = offset\n\treturn assertion\n}\n\nfunc (assertion *Assertion) Error() types.Assertion {\n\treturn &Assertion{\n\t\tactuals: assertion.actuals,\n\t\tactualIndex: len(assertion.actuals) - 1,\n\t\tvet: (*Assertion).vetError,\n\t\toffset: assertion.offset,\n\t\tg: assertion.g,\n\t}\n}\n\nfunc (assertion *Assertion) Should(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\tassertion.g.THelper()\n\tvetOptionalDescription(\"Assertion\", optionalDescription...)\n\treturn assertion.vet(assertion, optionalDescription...) && assertion.match(matcher, true, optionalDescription...)\n}\n\nfunc (assertion *Assertion) ShouldNot(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\tassertion.g.THelper()\n\tvetOptionalDescription(\"Assertion\", optionalDescription...)\n\treturn assertion.vet(assertion, optionalDescription...) && assertion.match(matcher, false, optionalDescription...)\n}\n\nfunc (assertion *Assertion) To(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\tassertion.g.THelper()\n\tvetOptionalDescription(\"Assertion\", optionalDescription...)\n\treturn assertion.vet(assertion, optionalDescription...) && assertion.match(matcher, true, optionalDescription...)\n}\n\nfunc (assertion *Assertion) ToNot(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\tassertion.g.THelper()\n\tvetOptionalDescription(\"Assertion\", optionalDescription...)\n\treturn assertion.vet(assertion, optionalDescription...) && assertion.match(matcher, false, optionalDescription...)\n}\n\nfunc (assertion *Assertion) NotTo(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\tassertion.g.THelper()\n\tvetOptionalDescription(\"Assertion\", optionalDescription...)\n\treturn assertion.vet(assertion, optionalDescription...) && assertion.match(matcher, false, optionalDescription...)\n}\n\nfunc (assertion *Assertion) buildDescription(optionalDescription ...any) string {\n\tswitch len(optionalDescription) {\n\tcase 0:\n\t\treturn \"\"\n\tcase 1:\n\t\tif describe, ok := optionalDescription[0].(func() string); ok {\n\t\t\treturn describe() + \"\\n\"\n\t\t}\n\t}\n\treturn fmt.Sprintf(optionalDescription[0].(string), optionalDescription[1:]...) + \"\\n\"\n}\n\nfunc (assertion *Assertion) match(matcher types.GomegaMatcher, desiredMatch bool, optionalDescription ...any) bool {\n\tactualInput := assertion.actuals[assertion.actualIndex]\n\tmatches, err := matcher.Match(actualInput)\n\tassertion.g.THelper()\n\tif err != nil {\n\t\tdescription := assertion.buildDescription(optionalDescription...)\n\t\tassertion.g.Fail(description+err.Error(), 2+assertion.offset)\n\t\treturn false\n\t}\n\tif matches != desiredMatch {\n\t\tvar message string\n\t\tif desiredMatch {\n\t\t\tmessage = matcher.FailureMessage(actualInput)\n\t\t} else {\n\t\t\tmessage = matcher.NegatedFailureMessage(actualInput)\n\t\t}\n\t\tdescription := assertion.buildDescription(optionalDescription...)\n\t\tassertion.g.Fail(description+message, 2+assertion.offset)\n\t\treturn false\n\t}\n\n\treturn true\n}\n\n// vetActuals vets the actual values, with the (optional) exception of a\n// specific value, such as the first value in case non-error assertions, or the\n// last value in case of Error()-based assertions.\nfunc (assertion *Assertion) vetActuals(optionalDescription ...any) bool {\n\tsuccess, message := vetActuals(assertion.actuals, assertion.actualIndex)\n\tif success {\n\t\treturn true\n\t}\n\n\tdescription := assertion.buildDescription(optionalDescription...)\n\tassertion.g.THelper()\n\tassertion.g.Fail(description+message, 2+assertion.offset)\n\treturn false\n}\n\n// vetError vets the actual values, except for the final error value, in case\n// the final error value is non-zero. Otherwise, it doesn't vet the actual\n// values, as these are allowed to take on any values unless there is a non-zero\n// error value.\nfunc (assertion *Assertion) vetError(optionalDescription ...any) bool {\n\tif err := assertion.actuals[assertion.actualIndex]; err != nil {\n\t\t// Go error result idiom: all other actual values must be zero values.\n\t\treturn assertion.vetActuals(optionalDescription...)\n\t}\n\treturn true\n}\n\n// vetActuals vets a slice of actual values, optionally skipping a particular\n// value slice element, such as the first or last value slice element.\nfunc vetActuals(actuals []any, skipIndex int) (bool, string) {\n\tfor i, actual := range actuals {\n\t\tif i == skipIndex {\n\t\t\tcontinue\n\t\t}\n\t\tif actual != nil {\n\t\t\tzeroValue := reflect.Zero(reflect.TypeOf(actual)).Interface()\n\t\t\tif !reflect.DeepEqual(zeroValue, actual) {\n\t\t\t\tvar message string\n\t\t\t\tif err, ok := actual.(error); ok {\n\t\t\t\t\tmessage = fmt.Sprintf(\"Unexpected error: %s\\n%s\", err, format.Object(err, 1))\n\t\t\t\t} else {\n\t\t\t\t\tmessage = fmt.Sprintf(\"Unexpected non-nil/non-zero argument at index %d:\\n\\t<%T>: %#v\", i, actual, actual)\n\t\t\t\t}\n\t\t\t\treturn false, message\n\t\t\t}\n\t\t}\n\t}\n\treturn true, \"\"\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/internal/async_assertion.go",
"content": "package internal\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"reflect\"\n\t\"runtime\"\n\t\"sync\"\n\t\"time\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/types\"\n)\n\nvar errInterface = reflect.TypeOf((*error)(nil)).Elem()\nvar gomegaType = reflect.TypeOf((*types.Gomega)(nil)).Elem()\nvar contextType = reflect.TypeOf(new(context.Context)).Elem()\n\ntype formattedGomegaError interface {\n\tFormattedGomegaError() string\n}\n\ntype asyncPolledActualError struct {\n\tmessage string\n}\n\nfunc (err *asyncPolledActualError) Error() string {\n\treturn err.message\n}\n\nfunc (err *asyncPolledActualError) FormattedGomegaError() string {\n\treturn err.message\n}\n\ntype contextWithAttachProgressReporter interface {\n\tAttachProgressReporter(func() string) func()\n}\n\ntype asyncGomegaHaltExecutionError struct{}\n\nfunc (a asyncGomegaHaltExecutionError) GinkgoRecoverShouldIgnoreThisPanic() {}\nfunc (a asyncGomegaHaltExecutionError) Error() string {\n\treturn `An assertion has failed in a goroutine. You should call \n\n defer GinkgoRecover()\n\nat the top of the goroutine that caused this panic. This will allow Ginkgo and Gomega to correctly capture and manage this panic.`\n}\n\ntype AsyncAssertionType uint\n\nconst (\n\tAsyncAssertionTypeEventually AsyncAssertionType = iota\n\tAsyncAssertionTypeConsistently\n)\n\nfunc (at AsyncAssertionType) String() string {\n\tswitch at {\n\tcase AsyncAssertionTypeEventually:\n\t\treturn \"Eventually\"\n\tcase AsyncAssertionTypeConsistently:\n\t\treturn \"Consistently\"\n\t}\n\treturn \"INVALID ASYNC ASSERTION TYPE\"\n}\n\ntype AsyncAssertion struct {\n\tasyncType AsyncAssertionType\n\n\tactualIsFunc bool\n\tactual any\n\targsToForward []any\n\n\ttimeoutInterval time.Duration\n\tpollingInterval time.Duration\n\tmustPassRepeatedly int\n\tctx context.Context\n\toffset int\n\tg *Gomega\n}\n\nfunc NewAsyncAssertion(asyncType AsyncAssertionType, actualInput any, g *Gomega, timeoutInterval time.Duration, pollingInterval time.Duration, mustPassRepeatedly int, ctx context.Context, offset int) *AsyncAssertion {\n\tout := &AsyncAssertion{\n\t\tasyncType: asyncType,\n\t\ttimeoutInterval: timeoutInterval,\n\t\tpollingInterval: pollingInterval,\n\t\tmustPassRepeatedly: mustPassRepeatedly,\n\t\toffset: offset,\n\t\tctx: ctx,\n\t\tg: g,\n\t}\n\n\tout.actual = actualInput\n\tif actualInput != nil && reflect.TypeOf(actualInput).Kind() == reflect.Func {\n\t\tout.actualIsFunc = true\n\t}\n\n\treturn out\n}\n\nfunc (assertion *AsyncAssertion) WithOffset(offset int) types.AsyncAssertion {\n\tassertion.offset = offset\n\treturn assertion\n}\n\nfunc (assertion *AsyncAssertion) WithTimeout(interval time.Duration) types.AsyncAssertion {\n\tassertion.timeoutInterval = interval\n\treturn assertion\n}\n\nfunc (assertion *AsyncAssertion) WithPolling(interval time.Duration) types.AsyncAssertion {\n\tassertion.pollingInterval = interval\n\treturn assertion\n}\n\nfunc (assertion *AsyncAssertion) Within(timeout time.Duration) types.AsyncAssertion {\n\tassertion.timeoutInterval = timeout\n\treturn assertion\n}\n\nfunc (assertion *AsyncAssertion) ProbeEvery(interval time.Duration) types.AsyncAssertion {\n\tassertion.pollingInterval = interval\n\treturn assertion\n}\n\nfunc (assertion *AsyncAssertion) WithContext(ctx context.Context) types.AsyncAssertion {\n\tassertion.ctx = ctx\n\treturn assertion\n}\n\nfunc (assertion *AsyncAssertion) WithArguments(argsToForward ...any) types.AsyncAssertion {\n\tassertion.argsToForward = argsToForward\n\treturn assertion\n}\n\nfunc (assertion *AsyncAssertion) MustPassRepeatedly(count int) types.AsyncAssertion {\n\tassertion.mustPassRepeatedly = count\n\treturn assertion\n}\n\nfunc (assertion *AsyncAssertion) Should(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\tassertion.g.THelper()\n\tvetOptionalDescription(\"Asynchronous assertion\", optionalDescription...)\n\treturn assertion.match(matcher, true, optionalDescription...)\n}\n\nfunc (assertion *AsyncAssertion) To(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\treturn assertion.Should(matcher, optionalDescription...)\n}\n\nfunc (assertion *AsyncAssertion) ShouldNot(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\tassertion.g.THelper()\n\tvetOptionalDescription(\"Asynchronous assertion\", optionalDescription...)\n\treturn assertion.match(matcher, false, optionalDescription...)\n}\n\nfunc (assertion *AsyncAssertion) ToNot(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\treturn assertion.ShouldNot(matcher, optionalDescription...)\n}\n\nfunc (assertion *AsyncAssertion) NotTo(matcher types.GomegaMatcher, optionalDescription ...any) bool {\n\treturn assertion.ShouldNot(matcher, optionalDescription...)\n}\n\nfunc (assertion *AsyncAssertion) buildDescription(optionalDescription ...any) string {\n\tswitch len(optionalDescription) {\n\tcase 0:\n\t\treturn \"\"\n\tcase 1:\n\t\tif describe, ok := optionalDescription[0].(func() string); ok {\n\t\t\treturn describe() + \"\\n\"\n\t\t}\n\t}\n\treturn fmt.Sprintf(optionalDescription[0].(string), optionalDescription[1:]...) + \"\\n\"\n}\n\nfunc (assertion *AsyncAssertion) processReturnValues(values []reflect.Value) (any, error) {\n\tif len(values) == 0 {\n\t\treturn nil, &asyncPolledActualError{\n\t\t\tmessage: fmt.Sprintf(\"The function passed to %s did not return any values\", assertion.asyncType),\n\t\t}\n\t}\n\n\tactual := values[0].Interface()\n\tif _, ok := AsPollingSignalError(actual); ok {\n\t\treturn actual, actual.(error)\n\t}\n\n\tvar err error\n\tfor i, extraValue := range values[1:] {\n\t\textra := extraValue.Interface()\n\t\tif extra == nil {\n\t\t\tcontinue\n\t\t}\n\t\tif _, ok := AsPollingSignalError(extra); ok {\n\t\t\treturn actual, extra.(error)\n\t\t}\n\t\textraType := reflect.TypeOf(extra)\n\t\tzero := reflect.Zero(extraType).Interface()\n\t\tif reflect.DeepEqual(extra, zero) {\n\t\t\tcontinue\n\t\t}\n\t\tif i == len(values)-2 && extraType.Implements(errInterface) {\n\t\t\terr = extra.(error)\n\t\t}\n\t\tif err == nil {\n\t\t\terr = &asyncPolledActualError{\n\t\t\t\tmessage: fmt.Sprintf(\"The function passed to %s had an unexpected non-nil/non-zero return value at index %d:\\n%s\", assertion.asyncType, i+1, format.Object(extra, 1)),\n\t\t\t}\n\t\t}\n\t}\n\n\treturn actual, err\n}\n\nfunc (assertion *AsyncAssertion) invalidFunctionError(t reflect.Type) error {\n\treturn fmt.Errorf(`The function passed to %s had an invalid signature of %s. Functions passed to %s must either:\n\n\t(a) have return values or\n\t(b) take a Gomega interface as their first argument and use that Gomega instance to make assertions.\n\nYou can learn more at https://onsi.github.io/gomega/#eventually\n`, assertion.asyncType, t, assertion.asyncType)\n}\n\nfunc (assertion *AsyncAssertion) noConfiguredContextForFunctionError() error {\n\treturn fmt.Errorf(`The function passed to %s requested a context.Context, but no context has been provided. Please pass one in using %s().WithContext().\n\nYou can learn more at https://onsi.github.io/gomega/#eventually\n`, assertion.asyncType, assertion.asyncType)\n}\n\nfunc (assertion *AsyncAssertion) argumentMismatchError(t reflect.Type, numProvided int) error {\n\thave := \"have\"\n\tif numProvided == 1 {\n\t\thave = \"has\"\n\t}\n\treturn fmt.Errorf(`The function passed to %s has signature %s takes %d arguments but %d %s been provided. Please use %s().WithArguments() to pass the correct set of arguments.\n\nYou can learn more at https://onsi.github.io/gomega/#eventually\n`, assertion.asyncType, t, t.NumIn(), numProvided, have, assertion.asyncType)\n}\n\nfunc (assertion *AsyncAssertion) invalidMustPassRepeatedlyError(reason string) error {\n\treturn fmt.Errorf(`Invalid use of MustPassRepeatedly with %s %s\n\nYou can learn more at https://onsi.github.io/gomega/#eventually\n`, assertion.asyncType, reason)\n}\n\nfunc (assertion *AsyncAssertion) buildActualPoller() (func() (any, error), error) {\n\tif !assertion.actualIsFunc {\n\t\treturn func() (any, error) { return assertion.actual, nil }, nil\n\t}\n\tactualValue := reflect.ValueOf(assertion.actual)\n\tactualType := reflect.TypeOf(assertion.actual)\n\tnumIn, numOut, isVariadic := actualType.NumIn(), actualType.NumOut(), actualType.IsVariadic()\n\n\tif numIn == 0 && numOut == 0 {\n\t\treturn nil, assertion.invalidFunctionError(actualType)\n\t}\n\ttakesGomega, takesContext := false, false\n\tif numIn > 0 {\n\t\ttakesGomega, takesContext = actualType.In(0).Implements(gomegaType), actualType.In(0).Implements(contextType)\n\t}\n\tif takesGomega && numIn > 1 && actualType.In(1).Implements(contextType) {\n\t\ttakesContext = true\n\t}\n\tif takesContext && len(assertion.argsToForward) > 0 && reflect.TypeOf(assertion.argsToForward[0]).Implements(contextType) {\n\t\ttakesContext = false\n\t}\n\tif !takesGomega && numOut == 0 {\n\t\treturn nil, assertion.invalidFunctionError(actualType)\n\t}\n\tif takesContext && assertion.ctx == nil {\n\t\treturn nil, assertion.noConfiguredContextForFunctionError()\n\t}\n\n\tvar assertionFailure error\n\tinValues := []reflect.Value{}\n\tif takesGomega {\n\t\tinValues = append(inValues, reflect.ValueOf(NewGomega(assertion.g.DurationBundle).ConfigureWithFailHandler(func(message string, callerSkip ...int) {\n\t\t\tskip := 0\n\t\t\tif len(callerSkip) > 0 {\n\t\t\t\tskip = callerSkip[0]\n\t\t\t}\n\t\t\t_, file, line, _ := runtime.Caller(skip + 1)\n\t\t\tassertionFailure = &asyncPolledActualError{\n\t\t\t\tmessage: fmt.Sprintf(\"The function passed to %s failed at %s:%d with:\\n%s\", assertion.asyncType, file, line, message),\n\t\t\t}\n\t\t\t// we throw an asyncGomegaHaltExecutionError so that defer GinkgoRecover() can catch this error if the user makes an assertion in a goroutine\n\t\t\tpanic(asyncGomegaHaltExecutionError{})\n\t\t})))\n\t}\n\tif takesContext {\n\t\tinValues = append(inValues, reflect.ValueOf(assertion.ctx))\n\t}\n\tfor _, arg := range assertion.argsToForward {\n\t\tinValues = append(inValues, reflect.ValueOf(arg))\n\t}\n\n\tif !isVariadic && numIn != len(inValues) {\n\t\treturn nil, assertion.argumentMismatchError(actualType, len(inValues))\n\t} else if isVariadic && len(inValues) < numIn-1 {\n\t\treturn nil, assertion.argumentMismatchError(actualType, len(inValues))\n\t}\n\n\tif assertion.mustPassRepeatedly != 1 && assertion.asyncType != AsyncAssertionTypeEventually {\n\t\treturn nil, assertion.invalidMustPassRepeatedlyError(\"it can only be used with Eventually\")\n\t}\n\tif assertion.mustPassRepeatedly < 1 {\n\t\treturn nil, assertion.invalidMustPassRepeatedlyError(\"parameter can't be < 1\")\n\t}\n\n\treturn func() (actual any, err error) {\n\t\tvar values []reflect.Value\n\t\tassertionFailure = nil\n\t\tdefer func() {\n\t\t\tif numOut == 0 && takesGomega {\n\t\t\t\tactual = assertionFailure\n\t\t\t} else {\n\t\t\t\tactual, err = assertion.processReturnValues(values)\n\t\t\t\t_, isAsyncError := AsPollingSignalError(err)\n\t\t\t\tif assertionFailure != nil && !isAsyncError {\n\t\t\t\t\terr = assertionFailure\n\t\t\t\t}\n\t\t\t}\n\t\t\tif e := recover(); e != nil {\n\t\t\t\tif _, isAsyncError := AsPollingSignalError(e); isAsyncError {\n\t\t\t\t\terr = e.(error)\n\t\t\t\t} else if assertionFailure == nil {\n\t\t\t\t\tpanic(e)\n\t\t\t\t}\n\t\t\t}\n\t\t}()\n\t\tvalues = actualValue.Call(inValues)\n\t\treturn\n\t}, nil\n}\n\nfunc (assertion *AsyncAssertion) afterTimeout() <-chan time.Time {\n\tif assertion.timeoutInterval >= 0 {\n\t\treturn time.After(assertion.timeoutInterval)\n\t}\n\n\tif assertion.asyncType == AsyncAssertionTypeConsistently {\n\t\treturn time.After(assertion.g.DurationBundle.ConsistentlyDuration)\n\t} else {\n\t\tif assertion.ctx == nil || assertion.g.DurationBundle.EnforceDefaultTimeoutsWhenUsingContexts {\n\t\t\treturn time.After(assertion.g.DurationBundle.EventuallyTimeout)\n\t\t} else {\n\t\t\treturn nil\n\t\t}\n\t}\n}\n\nfunc (assertion *AsyncAssertion) afterPolling() <-chan time.Time {\n\tif assertion.pollingInterval >= 0 {\n\t\treturn time.After(assertion.pollingInterval)\n\t}\n\tif assertion.asyncType == AsyncAssertionTypeConsistently {\n\t\treturn time.After(assertion.g.DurationBundle.ConsistentlyPollingInterval)\n\t} else {\n\t\treturn time.After(assertion.g.DurationBundle.EventuallyPollingInterval)\n\t}\n}\n\nfunc (assertion *AsyncAssertion) matcherSaysStopTrying(matcher types.GomegaMatcher, value any) bool {\n\tif assertion.actualIsFunc || types.MatchMayChangeInTheFuture(matcher, value) {\n\t\treturn false\n\t}\n\treturn true\n}\n\nfunc (assertion *AsyncAssertion) pollMatcher(matcher types.GomegaMatcher, value any) (matches bool, err error) {\n\tdefer func() {\n\t\tif e := recover(); e != nil {\n\t\t\tif _, isAsyncError := AsPollingSignalError(e); isAsyncError {\n\t\t\t\terr = e.(error)\n\t\t\t} else {\n\t\t\t\tpanic(e)\n\t\t\t}\n\t\t}\n\t}()\n\n\tmatches, err = matcher.Match(value)\n\n\treturn\n}\n\nfunc (assertion *AsyncAssertion) match(matcher types.GomegaMatcher, desiredMatch bool, optionalDescription ...any) bool {\n\ttimer := time.Now()\n\ttimeout := assertion.afterTimeout()\n\tlock := sync.Mutex{}\n\n\tvar matches, hasLastValidActual bool\n\tvar actual, lastValidActual any\n\tvar actualErr, matcherErr error\n\tvar oracleMatcherSaysStop bool\n\n\tassertion.g.THelper()\n\n\tpollActual, buildActualPollerErr := assertion.buildActualPoller()\n\tif buildActualPollerErr != nil {\n\t\tassertion.g.Fail(buildActualPollerErr.Error(), 2+assertion.offset)\n\t\treturn false\n\t}\n\n\tactual, actualErr = pollActual()\n\tif actualErr == nil {\n\t\tlastValidActual = actual\n\t\thasLastValidActual = true\n\t\toracleMatcherSaysStop = assertion.matcherSaysStopTrying(matcher, actual)\n\t\tmatches, matcherErr = assertion.pollMatcher(matcher, actual)\n\t}\n\n\trenderError := func(preamble string, err error) string {\n\t\tmessage := \"\"\n\t\tif pollingSignalErr, ok := AsPollingSignalError(err); ok {\n\t\t\tmessage = err.Error()\n\t\t\tfor _, attachment := range pollingSignalErr.Attachments {\n\t\t\t\tmessage += fmt.Sprintf(\"\\n%s:\\n\", attachment.Description)\n\t\t\t\tmessage += format.Object(attachment.Object, 1)\n\t\t\t}\n\t\t} else {\n\t\t\tmessage = preamble + \"\\n\" + format.Object(err, 1)\n\t\t}\n\t\treturn message\n\t}\n\n\tmessageGenerator := func() string {\n\t\t// can be called out of band by Ginkgo if the user requests a progress report\n\t\tlock.Lock()\n\t\tdefer lock.Unlock()\n\t\tmessage := \"\"\n\n\t\tif actualErr == nil {\n\t\t\tif matcherErr == nil {\n\t\t\t\tif desiredMatch != matches {\n\t\t\t\t\tif desiredMatch {\n\t\t\t\t\t\tmessage += matcher.FailureMessage(actual)\n\t\t\t\t\t} else {\n\t\t\t\t\t\tmessage += matcher.NegatedFailureMessage(actual)\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\tif assertion.asyncType == AsyncAssertionTypeConsistently {\n\t\t\t\t\t\tmessage += \"There is no failure as the matcher passed to Consistently has not yet failed\"\n\t\t\t\t\t} else {\n\t\t\t\t\t\tmessage += \"There is no failure as the matcher passed to Eventually succeeded on its most recent iteration\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tvar fgErr formattedGomegaError\n\t\t\t\tif errors.As(matcherErr, &fgErr) {\n\t\t\t\t\tmessage += fgErr.FormattedGomegaError() + \"\\n\"\n\t\t\t\t} else {\n\t\t\t\t\tmessage += renderError(fmt.Sprintf(\"The matcher passed to %s returned the following error:\", assertion.asyncType), matcherErr)\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tvar fgErr formattedGomegaError\n\t\t\tif errors.As(actualErr, &fgErr) {\n\t\t\t\tmessage += fgErr.FormattedGomegaError() + \"\\n\"\n\t\t\t} else {\n\t\t\t\tmessage += renderError(fmt.Sprintf(\"The function passed to %s returned the following error:\", assertion.asyncType), actualErr)\n\t\t\t}\n\t\t\tif hasLastValidActual {\n\t\t\t\tmessage += fmt.Sprintf(\"\\nAt one point, however, the function did return successfully.\\nYet, %s failed because\", assertion.asyncType)\n\t\t\t\t_, e := matcher.Match(lastValidActual)\n\t\t\t\tif e != nil {\n\t\t\t\t\tmessage += renderError(\" the matcher returned the following error:\", e)\n\t\t\t\t} else {\n\t\t\t\t\tmessage += \" the matcher was not satisfied:\\n\"\n\t\t\t\t\tif desiredMatch {\n\t\t\t\t\t\tmessage += matcher.FailureMessage(lastValidActual)\n\t\t\t\t\t} else {\n\t\t\t\t\t\tmessage += matcher.NegatedFailureMessage(lastValidActual)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tdescription := assertion.buildDescription(optionalDescription...)\n\t\treturn fmt.Sprintf(\"%s%s\", description, message)\n\t}\n\n\tfail := func(preamble string) {\n\t\tassertion.g.THelper()\n\t\tassertion.g.Fail(fmt.Sprintf(\"%s after %.3fs.\\n%s\", preamble, time.Since(timer).Seconds(), messageGenerator()), 3+assertion.offset)\n\t}\n\n\tvar contextDone <-chan struct{}\n\tif assertion.ctx != nil {\n\t\tcontextDone = assertion.ctx.Done()\n\t\tif v, ok := assertion.ctx.Value(\"GINKGO_SPEC_CONTEXT\").(contextWithAttachProgressReporter); ok {\n\t\t\tdetach := v.AttachProgressReporter(messageGenerator)\n\t\t\tdefer detach()\n\t\t}\n\t}\n\n\t// Used to count the number of times in a row a step passed\n\tpassedRepeatedlyCount := 0\n\tfor {\n\t\tvar nextPoll <-chan time.Time = nil\n\t\tvar isTryAgainAfterError = false\n\n\t\tfor _, err := range []error{actualErr, matcherErr} {\n\t\t\tif pollingSignalErr, ok := AsPollingSignalError(err); ok {\n\t\t\t\tif pollingSignalErr.IsStopTrying() {\n\t\t\t\t\tif pollingSignalErr.IsSuccessful() {\n\t\t\t\t\t\tif assertion.asyncType == AsyncAssertionTypeEventually {\n\t\t\t\t\t\t\tfail(\"Told to stop trying (and ignoring call to Successfully(), as it is only relevant with Consistently)\")\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\treturn true // early escape hatch for Consistently\n\t\t\t\t\t\t}\n\t\t\t\t\t} else {\n\t\t\t\t\t\tfail(\"Told to stop trying\")\n\t\t\t\t\t}\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tif pollingSignalErr.IsTryAgainAfter() {\n\t\t\t\t\tnextPoll = time.After(pollingSignalErr.TryAgainDuration())\n\t\t\t\t\tisTryAgainAfterError = true\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif actualErr == nil && matcherErr == nil && matches == desiredMatch {\n\t\t\tif assertion.asyncType == AsyncAssertionTypeEventually {\n\t\t\t\tpassedRepeatedlyCount += 1\n\t\t\t\tif passedRepeatedlyCount == assertion.mustPassRepeatedly {\n\t\t\t\t\treturn true\n\t\t\t\t}\n\t\t\t}\n\t\t} else if !isTryAgainAfterError {\n\t\t\tif assertion.asyncType == AsyncAssertionTypeConsistently {\n\t\t\t\tfail(\"Failed\")\n\t\t\t\treturn false\n\t\t\t}\n\t\t\t// Reset the consecutive pass count\n\t\t\tpassedRepeatedlyCount = 0\n\t\t}\n\n\t\tif oracleMatcherSaysStop {\n\t\t\tif assertion.asyncType == AsyncAssertionTypeEventually {\n\t\t\t\tfail(\"No future change is possible. Bailing out early\")\n\t\t\t\treturn false\n\t\t\t} else {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\n\t\tif nextPoll == nil {\n\t\t\tnextPoll = assertion.afterPolling()\n\t\t}\n\n\t\tselect {\n\t\tcase <-nextPoll:\n\t\t\ta, e := pollActual()\n\t\t\tlock.Lock()\n\t\t\tactual, actualErr = a, e\n\t\t\tlock.Unlock()\n\t\t\tif actualErr == nil {\n\t\t\t\tlock.Lock()\n\t\t\t\tlastValidActual = actual\n\t\t\t\thasLastValidActual = true\n\t\t\t\tlock.Unlock()\n\t\t\t\toracleMatcherSaysStop = assertion.matcherSaysStopTrying(matcher, actual)\n\t\t\t\tm, e := assertion.pollMatcher(matcher, actual)\n\t\t\t\tlock.Lock()\n\t\t\t\tmatches, matcherErr = m, e\n\t\t\t\tlock.Unlock()\n\t\t\t}\n\t\tcase <-contextDone:\n\t\t\terr := context.Cause(assertion.ctx)\n\t\t\tif err != nil && err != context.Canceled {\n\t\t\t\tfail(fmt.Sprintf(\"Context was cancelled (cause: %s)\", err))\n\t\t\t} else {\n\t\t\t\tfail(\"Context was cancelled\")\n\t\t\t}\n\t\t\treturn false\n\t\tcase <-timeout:\n\t\t\tif assertion.asyncType == AsyncAssertionTypeEventually {\n\t\t\t\tfail(\"Timed out\")\n\t\t\t\treturn false\n\t\t\t} else {\n\t\t\t\tif isTryAgainAfterError {\n\t\t\t\t\tfail(\"Timed out while waiting on TryAgainAfter\")\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/internal/duration_bundle.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\t\"reflect\"\n\t\"time\"\n)\n\ntype DurationBundle struct {\n\tEventuallyTimeout time.Duration\n\tEventuallyPollingInterval time.Duration\n\tConsistentlyDuration time.Duration\n\tConsistentlyPollingInterval time.Duration\n\tEnforceDefaultTimeoutsWhenUsingContexts bool\n}\n\nconst (\n\tEventuallyTimeoutEnvVarName = \"GOMEGA_DEFAULT_EVENTUALLY_TIMEOUT\"\n\tEventuallyPollingIntervalEnvVarName = \"GOMEGA_DEFAULT_EVENTUALLY_POLLING_INTERVAL\"\n\n\tConsistentlyDurationEnvVarName = \"GOMEGA_DEFAULT_CONSISTENTLY_DURATION\"\n\tConsistentlyPollingIntervalEnvVarName = \"GOMEGA_DEFAULT_CONSISTENTLY_POLLING_INTERVAL\"\n\n\tEnforceDefaultTimeoutsWhenUsingContextsEnvVarName = \"GOMEGA_ENFORCE_DEFAULT_TIMEOUTS_WHEN_USING_CONTEXTS\"\n)\n\nfunc FetchDefaultDurationBundle() DurationBundle {\n\t_, EnforceDefaultTimeoutsWhenUsingContexts := os.LookupEnv(EnforceDefaultTimeoutsWhenUsingContextsEnvVarName)\n\treturn DurationBundle{\n\t\tEventuallyTimeout: durationFromEnv(EventuallyTimeoutEnvVarName, time.Second),\n\t\tEventuallyPollingInterval: durationFromEnv(EventuallyPollingIntervalEnvVarName, 10*time.Millisecond),\n\n\t\tConsistentlyDuration: durationFromEnv(ConsistentlyDurationEnvVarName, 100*time.Millisecond),\n\t\tConsistentlyPollingInterval: durationFromEnv(ConsistentlyPollingIntervalEnvVarName, 10*time.Millisecond),\n\t\tEnforceDefaultTimeoutsWhenUsingContexts: EnforceDefaultTimeoutsWhenUsingContexts,\n\t}\n}\n\nfunc durationFromEnv(key string, defaultDuration time.Duration) time.Duration {\n\tvalue := os.Getenv(key)\n\tif value == \"\" {\n\t\treturn defaultDuration\n\t}\n\tduration, err := time.ParseDuration(value)\n\tif err != nil {\n\t\tpanic(fmt.Sprintf(\"Expected a duration when using %s! Parse error %v\", key, err))\n\t}\n\treturn duration\n}\n\nfunc toDuration(input any) (time.Duration, error) {\n\tduration, ok := input.(time.Duration)\n\tif ok {\n\t\treturn duration, nil\n\t}\n\n\tvalue := reflect.ValueOf(input)\n\tkind := reflect.TypeOf(input).Kind()\n\n\tif reflect.Int <= kind && kind <= reflect.Int64 {\n\t\treturn time.Duration(value.Int()) * time.Second, nil\n\t} else if reflect.Uint <= kind && kind <= reflect.Uint64 {\n\t\treturn time.Duration(value.Uint()) * time.Second, nil\n\t} else if reflect.Float32 <= kind && kind <= reflect.Float64 {\n\t\treturn time.Duration(value.Float() * float64(time.Second)), nil\n\t} else if reflect.String == kind {\n\t\tduration, err := time.ParseDuration(value.String())\n\t\tif err != nil {\n\t\t\treturn 0, fmt.Errorf(\"%#v is not a valid parsable duration string: %w\", input, err)\n\t\t}\n\t\treturn duration, nil\n\t}\n\n\treturn 0, fmt.Errorf(\"%#v is not a valid interval. Must be a time.Duration, a parsable duration string, or a number.\", input)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/internal/gomega.go",
"content": "package internal\n\nimport (\n\t\"context\"\n\t\"time\"\n\n\t\"github.com/onsi/gomega/types\"\n)\n\ntype Gomega struct {\n\tFail types.GomegaFailHandler\n\tTHelper func()\n\tDurationBundle DurationBundle\n}\n\nfunc NewGomega(bundle DurationBundle) *Gomega {\n\treturn &Gomega{\n\t\tFail: nil,\n\t\tTHelper: nil,\n\t\tDurationBundle: bundle,\n\t}\n}\n\nfunc (g *Gomega) IsConfigured() bool {\n\treturn g.Fail != nil && g.THelper != nil\n}\n\nfunc (g *Gomega) ConfigureWithFailHandler(fail types.GomegaFailHandler) *Gomega {\n\tg.Fail = fail\n\tg.THelper = func() {}\n\treturn g\n}\n\nfunc (g *Gomega) ConfigureWithT(t types.GomegaTestingT) *Gomega {\n\tg.Fail = func(message string, _ ...int) {\n\t\tt.Helper()\n\t\tt.Fatalf(\"\\n%s\", message)\n\t}\n\tg.THelper = t.Helper\n\treturn g\n}\n\nfunc (g *Gomega) Ω(actual any, extra ...any) types.Assertion {\n\treturn g.ExpectWithOffset(0, actual, extra...)\n}\n\nfunc (g *Gomega) Expect(actual any, extra ...any) types.Assertion {\n\treturn g.ExpectWithOffset(0, actual, extra...)\n}\n\nfunc (g *Gomega) ExpectWithOffset(offset int, actual any, extra ...any) types.Assertion {\n\treturn NewAssertion(actual, g, offset, extra...)\n}\n\nfunc (g *Gomega) Eventually(actualOrCtx any, args ...any) types.AsyncAssertion {\n\treturn g.makeAsyncAssertion(AsyncAssertionTypeEventually, 0, actualOrCtx, args...)\n}\n\nfunc (g *Gomega) EventuallyWithOffset(offset int, actualOrCtx any, args ...any) types.AsyncAssertion {\n\treturn g.makeAsyncAssertion(AsyncAssertionTypeEventually, offset, actualOrCtx, args...)\n}\n\nfunc (g *Gomega) Consistently(actualOrCtx any, args ...any) types.AsyncAssertion {\n\treturn g.makeAsyncAssertion(AsyncAssertionTypeConsistently, 0, actualOrCtx, args...)\n}\n\nfunc (g *Gomega) ConsistentlyWithOffset(offset int, actualOrCtx any, args ...any) types.AsyncAssertion {\n\treturn g.makeAsyncAssertion(AsyncAssertionTypeConsistently, offset, actualOrCtx, args...)\n}\n\nfunc (g *Gomega) makeAsyncAssertion(asyncAssertionType AsyncAssertionType, offset int, actualOrCtx any, args ...any) types.AsyncAssertion {\n\tbaseOffset := 3\n\ttimeoutInterval := -time.Duration(1)\n\tpollingInterval := -time.Duration(1)\n\tintervals := []any{}\n\tvar ctx context.Context\n\n\tactual := actualOrCtx\n\tstartingIndex := 0\n\tif _, isCtx := actualOrCtx.(context.Context); isCtx && len(args) > 0 {\n\t\t// the first argument is a context, we should accept it as the context _only if_ it is **not** the only argument **and** the second argument is not a parseable duration\n\t\t// this is due to an unfortunate ambiguity in early version of Gomega in which multi-type durations are allowed after the actual\n\t\tif _, err := toDuration(args[0]); err != nil {\n\t\t\tctx = actualOrCtx.(context.Context)\n\t\t\tactual = args[0]\n\t\t\tstartingIndex = 1\n\t\t}\n\t}\n\n\tfor _, arg := range args[startingIndex:] {\n\t\tswitch v := arg.(type) {\n\t\tcase context.Context:\n\t\t\tctx = v\n\t\tdefault:\n\t\t\tintervals = append(intervals, arg)\n\t\t}\n\t}\n\tvar err error\n\tif len(intervals) > 0 {\n\t\ttimeoutInterval, err = toDuration(intervals[0])\n\t\tif err != nil {\n\t\t\tg.Fail(err.Error(), offset+baseOffset)\n\t\t}\n\t}\n\tif len(intervals) > 1 {\n\t\tpollingInterval, err = toDuration(intervals[1])\n\t\tif err != nil {\n\t\t\tg.Fail(err.Error(), offset+baseOffset)\n\t\t}\n\t}\n\n\treturn NewAsyncAssertion(asyncAssertionType, actual, g, timeoutInterval, pollingInterval, 1, ctx, offset)\n}\n\nfunc (g *Gomega) SetDefaultEventuallyTimeout(t time.Duration) {\n\tg.DurationBundle.EventuallyTimeout = t\n}\n\nfunc (g *Gomega) SetDefaultEventuallyPollingInterval(t time.Duration) {\n\tg.DurationBundle.EventuallyPollingInterval = t\n}\n\nfunc (g *Gomega) SetDefaultConsistentlyDuration(t time.Duration) {\n\tg.DurationBundle.ConsistentlyDuration = t\n}\n\nfunc (g *Gomega) SetDefaultConsistentlyPollingInterval(t time.Duration) {\n\tg.DurationBundle.ConsistentlyPollingInterval = t\n}\n\nfunc (g *Gomega) EnforceDefaultTimeoutsWhenUsingContexts() {\n\tg.DurationBundle.EnforceDefaultTimeoutsWhenUsingContexts = true\n}\n\nfunc (g *Gomega) DisableDefaultTimeoutsWhenUsingContext() {\n\tg.DurationBundle.EnforceDefaultTimeoutsWhenUsingContexts = false\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/internal/gutil/post_ioutil.go",
"content": "//go:build go1.16\n// +build go1.16\n\n// Package gutil is a replacement for ioutil, which should not be used in new\n// code as of Go 1.16. With Go 1.16 and higher, this implementation\n// uses the ioutil replacement functions in \"io\" and \"os\" with some\n// Gomega specifics. This means that we should not get deprecation warnings\n// for ioutil when they are added.\npackage gutil\n\nimport (\n\t\"io\"\n\t\"os\"\n)\n\nfunc NopCloser(r io.Reader) io.ReadCloser {\n\treturn io.NopCloser(r)\n}\n\nfunc ReadAll(r io.Reader) ([]byte, error) {\n\treturn io.ReadAll(r)\n}\n\nfunc ReadDir(dirname string) ([]string, error) {\n\tentries, err := os.ReadDir(dirname)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar names []string\n\tfor _, entry := range entries {\n\t\tnames = append(names, entry.Name())\n\t}\n\n\treturn names, nil\n}\n\nfunc ReadFile(filename string) ([]byte, error) {\n\treturn os.ReadFile(filename)\n}\n\nfunc MkdirTemp(dir, pattern string) (string, error) {\n\treturn os.MkdirTemp(dir, pattern)\n}\n\nfunc WriteFile(filename string, data []byte) error {\n\treturn os.WriteFile(filename, data, 0644)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/internal/gutil/using_ioutil.go",
"content": "//go:build !go1.16\n// +build !go1.16\n\n// Package gutil is a replacement for ioutil, which should not be used in new\n// code as of Go 1.16. With Go 1.15 and lower, this implementation\n// uses the ioutil functions, meaning that although Gomega is not officially\n// supported on these versions, it is still likely to work.\npackage gutil\n\nimport (\n\t\"io\"\n\t\"io/ioutil\"\n)\n\nfunc NopCloser(r io.Reader) io.ReadCloser {\n\treturn ioutil.NopCloser(r)\n}\n\nfunc ReadAll(r io.Reader) ([]byte, error) {\n\treturn ioutil.ReadAll(r)\n}\n\nfunc ReadDir(dirname string) ([]string, error) {\n\tfiles, err := ioutil.ReadDir(dirname)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar names []string\n\tfor _, file := range files {\n\t\tnames = append(names, file.Name())\n\t}\n\n\treturn names, nil\n}\n\nfunc ReadFile(filename string) ([]byte, error) {\n\treturn ioutil.ReadFile(filename)\n}\n\nfunc MkdirTemp(dir, pattern string) (string, error) {\n\treturn ioutil.TempDir(dir, pattern)\n}\n\nfunc WriteFile(filename string, data []byte) error {\n\treturn ioutil.WriteFile(filename, data, 0644)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/internal/polling_signal_error.go",
"content": "package internal\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"time\"\n)\n\ntype PollingSignalErrorType int\n\nconst (\n\tPollingSignalErrorTypeStopTrying PollingSignalErrorType = iota\n\tPollingSignalErrorTypeTryAgainAfter\n)\n\ntype PollingSignalError interface {\n\terror\n\tWrap(err error) PollingSignalError\n\tAttach(description string, obj any) PollingSignalError\n\tSuccessfully() PollingSignalError\n\tNow()\n}\n\nvar StopTrying = func(message string) PollingSignalError {\n\treturn &PollingSignalErrorImpl{\n\t\tmessage: message,\n\t\tpollingSignalErrorType: PollingSignalErrorTypeStopTrying,\n\t}\n}\n\nvar TryAgainAfter = func(duration time.Duration) PollingSignalError {\n\treturn &PollingSignalErrorImpl{\n\t\tmessage: fmt.Sprintf(\"told to try again after %s\", duration),\n\t\tduration: duration,\n\t\tpollingSignalErrorType: PollingSignalErrorTypeTryAgainAfter,\n\t}\n}\n\ntype PollingSignalErrorAttachment struct {\n\tDescription string\n\tObject any\n}\n\ntype PollingSignalErrorImpl struct {\n\tmessage string\n\twrappedErr error\n\tpollingSignalErrorType PollingSignalErrorType\n\tduration time.Duration\n\tsuccessful bool\n\tAttachments []PollingSignalErrorAttachment\n}\n\nfunc (s *PollingSignalErrorImpl) Wrap(err error) PollingSignalError {\n\ts.wrappedErr = err\n\treturn s\n}\n\nfunc (s *PollingSignalErrorImpl) Attach(description string, obj any) PollingSignalError {\n\ts.Attachments = append(s.Attachments, PollingSignalErrorAttachment{description, obj})\n\treturn s\n}\n\nfunc (s *PollingSignalErrorImpl) Error() string {\n\tif s.wrappedErr == nil {\n\t\treturn s.message\n\t} else {\n\t\treturn s.message + \": \" + s.wrappedErr.Error()\n\t}\n}\n\nfunc (s *PollingSignalErrorImpl) Unwrap() error {\n\tif s == nil {\n\t\treturn nil\n\t}\n\treturn s.wrappedErr\n}\n\nfunc (s *PollingSignalErrorImpl) Successfully() PollingSignalError {\n\ts.successful = true\n\treturn s\n}\n\nfunc (s *PollingSignalErrorImpl) Now() {\n\tpanic(s)\n}\n\nfunc (s *PollingSignalErrorImpl) IsStopTrying() bool {\n\treturn s.pollingSignalErrorType == PollingSignalErrorTypeStopTrying\n}\n\nfunc (s *PollingSignalErrorImpl) IsSuccessful() bool {\n\treturn s.successful\n}\n\nfunc (s *PollingSignalErrorImpl) IsTryAgainAfter() bool {\n\treturn s.pollingSignalErrorType == PollingSignalErrorTypeTryAgainAfter\n}\n\nfunc (s *PollingSignalErrorImpl) TryAgainDuration() time.Duration {\n\treturn s.duration\n}\n\nfunc AsPollingSignalError(actual any) (*PollingSignalErrorImpl, bool) {\n\tif actual == nil {\n\t\treturn nil, false\n\t}\n\tif actualErr, ok := actual.(error); ok {\n\t\tvar target *PollingSignalErrorImpl\n\t\tif errors.As(actualErr, &target) {\n\t\t\treturn target, true\n\t\t} else {\n\t\t\treturn nil, false\n\t\t}\n\t}\n\n\treturn nil, false\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/internal/vetoptdesc.go",
"content": "package internal\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/types\"\n)\n\n// vetOptionalDescription vets the optional description args: if it finds any\n// Gomega matcher at the beginning it panics. This allows for rendering Gomega\n// matchers as part of an optional Description, as long as they're not in the\n// first slot.\nfunc vetOptionalDescription(assertion string, optionalDescription ...any) {\n\tif len(optionalDescription) == 0 {\n\t\treturn\n\t}\n\tif _, isGomegaMatcher := optionalDescription[0].(types.GomegaMatcher); isGomegaMatcher {\n\t\tpanic(fmt.Sprintf(\"%s has a GomegaMatcher as the first element of optionalDescription.\\n\\t\"+\n\t\t\t\"Do you mean to use And/Or/SatisfyAll/SatisfyAny to combine multiple matchers?\",\n\t\t\tassertion))\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/and.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/types\"\n)\n\ntype AndMatcher struct {\n\tMatchers []types.GomegaMatcher\n\n\t// state\n\tfirstFailedMatcher types.GomegaMatcher\n}\n\nfunc (m *AndMatcher) Match(actual any) (success bool, err error) {\n\tm.firstFailedMatcher = nil\n\tfor _, matcher := range m.Matchers {\n\t\tsuccess, err := matcher.Match(actual)\n\t\tif !success || err != nil {\n\t\t\tm.firstFailedMatcher = matcher\n\t\t\treturn false, err\n\t\t}\n\t}\n\treturn true, nil\n}\n\nfunc (m *AndMatcher) FailureMessage(actual any) (message string) {\n\treturn m.firstFailedMatcher.FailureMessage(actual)\n}\n\nfunc (m *AndMatcher) NegatedFailureMessage(actual any) (message string) {\n\t// not the most beautiful list of matchers, but not bad either...\n\treturn format.Message(actual, fmt.Sprintf(\"To not satisfy all of these matchers: %s\", m.Matchers))\n}\n\nfunc (m *AndMatcher) MatchMayChangeInTheFuture(actual any) bool {\n\t/*\n\t\tExample with 3 matchers: A, B, C\n\n\t\tMatch evaluates them: T, F, => F\n\t\tSo match is currently F, what should MatchMayChangeInTheFuture() return?\n\t\tSeems like it only depends on B, since currently B MUST change to allow the result to become T\n\n\t\tMatch eval: T, T, T => T\n\t\tSo match is currently T, what should MatchMayChangeInTheFuture() return?\n\t\tSeems to depend on ANY of them being able to change to F.\n\t*/\n\n\tif m.firstFailedMatcher == nil {\n\t\t// so all matchers succeeded.. Any one of them changing would change the result.\n\t\tfor _, matcher := range m.Matchers {\n\t\t\tif types.MatchMayChangeInTheFuture(matcher, actual) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t\treturn false // none of were going to change\n\t}\n\t// one of the matchers failed.. it must be able to change in order to affect the result\n\treturn types.MatchMayChangeInTheFuture(m.firstFailedMatcher, actual)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/assignable_to_type_of_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype AssignableToTypeOfMatcher struct {\n\tExpected any\n}\n\nfunc (matcher *AssignableToTypeOfMatcher) Match(actual any) (success bool, err error) {\n\tif actual == nil && matcher.Expected == nil {\n\t\treturn false, fmt.Errorf(\"Refusing to compare to .\\nBe explicit and use BeNil() instead. This is to avoid mistakes where both sides of an assertion are erroneously uninitialized.\")\n\t} else if matcher.Expected == nil {\n\t\treturn false, fmt.Errorf(\"Refusing to compare type to .\\nBe explicit and use BeNil() instead. This is to avoid mistakes where both sides of an assertion are erroneously uninitialized.\")\n\t} else if actual == nil {\n\t\treturn false, nil\n\t}\n\n\tactualType := reflect.TypeOf(actual)\n\texpectedType := reflect.TypeOf(matcher.Expected)\n\n\treturn actualType.AssignableTo(expectedType), nil\n}\n\nfunc (matcher *AssignableToTypeOfMatcher) FailureMessage(actual any) string {\n\treturn format.Message(actual, fmt.Sprintf(\"to be assignable to the type: %T\", matcher.Expected))\n}\n\nfunc (matcher *AssignableToTypeOfMatcher) NegatedFailureMessage(actual any) string {\n\treturn format.Message(actual, fmt.Sprintf(\"not to be assignable to the type: %T\", matcher.Expected))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/attributes_slice.go",
"content": "package matchers\n\nimport (\n\t\"encoding/xml\"\n\t\"strings\"\n)\n\ntype attributesSlice []xml.Attr\n\nfunc (attrs attributesSlice) Len() int { return len(attrs) }\nfunc (attrs attributesSlice) Less(i, j int) bool {\n\treturn strings.Compare(attrs[i].Name.Local, attrs[j].Name.Local) == -1\n}\nfunc (attrs attributesSlice) Swap(i, j int) { attrs[i], attrs[j] = attrs[j], attrs[i] }\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_a_directory.go",
"content": "// untested sections: 5\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype notADirectoryError struct {\n\tos.FileInfo\n}\n\nfunc (t notADirectoryError) Error() string {\n\tfileInfo := os.FileInfo(t)\n\tswitch {\n\tcase fileInfo.Mode().IsRegular():\n\t\treturn \"file is a regular file\"\n\tdefault:\n\t\treturn fmt.Sprintf(\"file mode is: %s\", fileInfo.Mode().String())\n\t}\n}\n\ntype BeADirectoryMatcher struct {\n\texpected any\n\terr error\n}\n\nfunc (matcher *BeADirectoryMatcher) Match(actual any) (success bool, err error) {\n\tactualFilename, ok := actual.(string)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"BeADirectoryMatcher matcher expects a file path\")\n\t}\n\n\tfileInfo, err := os.Stat(actualFilename)\n\tif err != nil {\n\t\tmatcher.err = err\n\t\treturn false, nil\n\t}\n\n\tif !fileInfo.Mode().IsDir() {\n\t\tmatcher.err = notADirectoryError{fileInfo}\n\t\treturn false, nil\n\t}\n\treturn true, nil\n}\n\nfunc (matcher *BeADirectoryMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, fmt.Sprintf(\"to be a directory: %s\", matcher.err))\n}\n\nfunc (matcher *BeADirectoryMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not be a directory\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_a_regular_file.go",
"content": "// untested sections: 5\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype notARegularFileError struct {\n\tos.FileInfo\n}\n\nfunc (t notARegularFileError) Error() string {\n\tfileInfo := os.FileInfo(t)\n\tswitch {\n\tcase fileInfo.IsDir():\n\t\treturn \"file is a directory\"\n\tdefault:\n\t\treturn fmt.Sprintf(\"file mode is: %s\", fileInfo.Mode().String())\n\t}\n}\n\ntype BeARegularFileMatcher struct {\n\texpected any\n\terr error\n}\n\nfunc (matcher *BeARegularFileMatcher) Match(actual any) (success bool, err error) {\n\tactualFilename, ok := actual.(string)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"BeARegularFileMatcher matcher expects a file path\")\n\t}\n\n\tfileInfo, err := os.Stat(actualFilename)\n\tif err != nil {\n\t\tmatcher.err = err\n\t\treturn false, nil\n\t}\n\n\tif !fileInfo.Mode().IsRegular() {\n\t\tmatcher.err = notARegularFileError{fileInfo}\n\t\treturn false, nil\n\t}\n\treturn true, nil\n}\n\nfunc (matcher *BeARegularFileMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, fmt.Sprintf(\"to be a regular file: %s\", matcher.err))\n}\n\nfunc (matcher *BeARegularFileMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not be a regular file\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_an_existing_file.go",
"content": "// untested sections: 3\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"os\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeAnExistingFileMatcher struct {\n\texpected any\n}\n\nfunc (matcher *BeAnExistingFileMatcher) Match(actual any) (success bool, err error) {\n\tactualFilename, ok := actual.(string)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"BeAnExistingFileMatcher matcher expects a file path\")\n\t}\n\n\tif _, err = os.Stat(actualFilename); err != nil {\n\t\tswitch {\n\t\tcase os.IsNotExist(err):\n\t\t\treturn false, nil\n\t\tdefault:\n\t\t\treturn false, err\n\t\t}\n\t}\n\n\treturn true, nil\n}\n\nfunc (matcher *BeAnExistingFileMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to exist\")\n}\n\nfunc (matcher *BeAnExistingFileMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to exist\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_closed_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeClosedMatcher struct {\n}\n\nfunc (matcher *BeClosedMatcher) Match(actual any) (success bool, err error) {\n\tif !isChan(actual) {\n\t\treturn false, fmt.Errorf(\"BeClosed matcher expects a channel. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tchannelType := reflect.TypeOf(actual)\n\tchannelValue := reflect.ValueOf(actual)\n\n\tif channelType.ChanDir() == reflect.SendDir {\n\t\treturn false, fmt.Errorf(\"BeClosed matcher cannot determine if a send-only channel is closed or open. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\twinnerIndex, _, open := reflect.Select([]reflect.SelectCase{\n\t\t{Dir: reflect.SelectRecv, Chan: channelValue},\n\t\t{Dir: reflect.SelectDefault},\n\t})\n\n\tvar closed bool\n\tif winnerIndex == 0 {\n\t\tclosed = !open\n\t} else if winnerIndex == 1 {\n\t\tclosed = false\n\t}\n\n\treturn closed, nil\n}\n\nfunc (matcher *BeClosedMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to be closed\")\n}\n\nfunc (matcher *BeClosedMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to be open\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_comparable_to_matcher.go",
"content": "package matchers\n\nimport (\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/google/go-cmp/cmp\"\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeComparableToMatcher struct {\n\tExpected any\n\tOptions cmp.Options\n}\n\nfunc (matcher *BeComparableToMatcher) Match(actual any) (success bool, matchErr error) {\n\tif actual == nil && matcher.Expected == nil {\n\t\treturn false, fmt.Errorf(\"Refusing to compare to .\\nBe explicit and use BeNil() instead. This is to avoid mistakes where both sides of an assertion are erroneously uninitialized.\")\n\t}\n\t// Shortcut for byte slices.\n\t// Comparing long byte slices with reflect.DeepEqual is very slow,\n\t// so use bytes.Equal if actual and expected are both byte slices.\n\tif actualByteSlice, ok := actual.([]byte); ok {\n\t\tif expectedByteSlice, ok := matcher.Expected.([]byte); ok {\n\t\t\treturn bytes.Equal(actualByteSlice, expectedByteSlice), nil\n\t\t}\n\t}\n\n\tdefer func() {\n\t\tif r := recover(); r != nil {\n\t\t\tsuccess = false\n\t\t\tif err, ok := r.(error); ok {\n\t\t\t\tmatchErr = err\n\t\t\t} else if errMsg, ok := r.(string); ok {\n\t\t\t\tmatchErr = errors.New(errMsg)\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn cmp.Equal(actual, matcher.Expected, matcher.Options...), nil\n}\n\nfunc (matcher *BeComparableToMatcher) FailureMessage(actual any) (message string) {\n\treturn fmt.Sprint(\"Expected object to be comparable, diff: \", cmp.Diff(actual, matcher.Expected, matcher.Options...))\n}\n\nfunc (matcher *BeComparableToMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to be comparable to\", matcher.Expected)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_element_of_matcher.go",
"content": "// untested sections: 1\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeElementOfMatcher struct {\n\tElements []any\n}\n\nfunc (matcher *BeElementOfMatcher) Match(actual any) (success bool, err error) {\n\tif reflect.TypeOf(actual) == nil {\n\t\treturn false, fmt.Errorf(\"BeElement matcher expects actual to be typed\")\n\t}\n\n\tvar lastError error\n\tfor _, m := range flatten(matcher.Elements) {\n\t\tmatcher := &EqualMatcher{Expected: m}\n\t\tsuccess, err := matcher.Match(actual)\n\t\tif err != nil {\n\t\t\tlastError = err\n\t\t\tcontinue\n\t\t}\n\t\tif success {\n\t\t\treturn true, nil\n\t\t}\n\t}\n\n\treturn false, lastError\n}\n\nfunc (matcher *BeElementOfMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to be an element of\", presentable(matcher.Elements))\n}\n\nfunc (matcher *BeElementOfMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to be an element of\", presentable(matcher.Elements))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_empty_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n)\n\ntype BeEmptyMatcher struct {\n}\n\nfunc (matcher *BeEmptyMatcher) Match(actual any) (success bool, err error) {\n\t// short-circuit the iterator case, as we only need to see the first\n\t// element, if any.\n\tif miter.IsIter(actual) {\n\t\tvar length int\n\t\tif miter.IsSeq2(actual) {\n\t\t\tmiter.IterateKV(actual, func(k, v reflect.Value) bool { length++; return false })\n\t\t} else {\n\t\t\tmiter.IterateV(actual, func(v reflect.Value) bool { length++; return false })\n\t\t}\n\t\treturn length == 0, nil\n\t}\n\n\tlength, ok := lengthOf(actual)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"BeEmpty matcher expects a string/array/map/channel/slice/iterator. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\treturn length == 0, nil\n}\n\nfunc (matcher *BeEmptyMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to be empty\")\n}\n\nfunc (matcher *BeEmptyMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to be empty\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_equivalent_to_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeEquivalentToMatcher struct {\n\tExpected any\n}\n\nfunc (matcher *BeEquivalentToMatcher) Match(actual any) (success bool, err error) {\n\tif actual == nil && matcher.Expected == nil {\n\t\treturn false, fmt.Errorf(\"Both actual and expected must not be nil.\")\n\t}\n\n\tconvertedActual := actual\n\n\tif actual != nil && matcher.Expected != nil && reflect.TypeOf(actual).ConvertibleTo(reflect.TypeOf(matcher.Expected)) {\n\t\tconvertedActual = reflect.ValueOf(actual).Convert(reflect.TypeOf(matcher.Expected)).Interface()\n\t}\n\n\treturn reflect.DeepEqual(convertedActual, matcher.Expected), nil\n}\n\nfunc (matcher *BeEquivalentToMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to be equivalent to\", matcher.Expected)\n}\n\nfunc (matcher *BeEquivalentToMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to be equivalent to\", matcher.Expected)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_false_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeFalseMatcher struct {\n\tReason string\n}\n\nfunc (matcher *BeFalseMatcher) Match(actual any) (success bool, err error) {\n\tif !isBool(actual) {\n\t\treturn false, fmt.Errorf(\"Expected a boolean. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\treturn actual == false, nil\n}\n\nfunc (matcher *BeFalseMatcher) FailureMessage(actual any) (message string) {\n\tif matcher.Reason == \"\" {\n\t\treturn format.Message(actual, \"to be false\")\n\t} else {\n\t\treturn matcher.Reason\n\t}\n}\n\nfunc (matcher *BeFalseMatcher) NegatedFailureMessage(actual any) (message string) {\n\tif matcher.Reason == \"\" {\n\t\treturn format.Message(actual, \"not to be false\")\n\t} else {\n\t\treturn fmt.Sprintf(`Expected not false but got false\\nNegation of \"%s\" failed`, matcher.Reason)\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_identical_to.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"runtime\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeIdenticalToMatcher struct {\n\tExpected any\n}\n\nfunc (matcher *BeIdenticalToMatcher) Match(actual any) (success bool, matchErr error) {\n\tif actual == nil && matcher.Expected == nil {\n\t\treturn false, fmt.Errorf(\"Refusing to compare to .\\nBe explicit and use BeNil() instead. This is to avoid mistakes where both sides of an assertion are erroneously uninitialized.\")\n\t}\n\n\tdefer func() {\n\t\tif r := recover(); r != nil {\n\t\t\tif _, ok := r.(runtime.Error); ok {\n\t\t\t\tsuccess = false\n\t\t\t\tmatchErr = nil\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn actual == matcher.Expected, nil\n}\n\nfunc (matcher *BeIdenticalToMatcher) FailureMessage(actual any) string {\n\treturn format.Message(actual, \"to be identical to\", matcher.Expected)\n}\n\nfunc (matcher *BeIdenticalToMatcher) NegatedFailureMessage(actual any) string {\n\treturn format.Message(actual, \"not to be identical to\", matcher.Expected)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_key_of_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeKeyOfMatcher struct {\n\tMap any\n}\n\nfunc (matcher *BeKeyOfMatcher) Match(actual any) (success bool, err error) {\n\tif !isMap(matcher.Map) {\n\t\treturn false, fmt.Errorf(\"BeKeyOf matcher needs expected to be a map type\")\n\t}\n\n\tif reflect.TypeOf(actual) == nil {\n\t\treturn false, fmt.Errorf(\"BeKeyOf matcher expects actual to be typed\")\n\t}\n\n\tvar lastError error\n\tfor _, key := range reflect.ValueOf(matcher.Map).MapKeys() {\n\t\tmatcher := &EqualMatcher{Expected: key.Interface()}\n\t\tsuccess, err := matcher.Match(actual)\n\t\tif err != nil {\n\t\t\tlastError = err\n\t\t\tcontinue\n\t\t}\n\t\tif success {\n\t\t\treturn true, nil\n\t\t}\n\t}\n\n\treturn false, lastError\n}\n\nfunc (matcher *BeKeyOfMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to be a key of\", presentable(valuesOf(matcher.Map)))\n}\n\nfunc (matcher *BeKeyOfMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to be a key of\", presentable(valuesOf(matcher.Map)))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_nil_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport \"github.com/onsi/gomega/format\"\n\ntype BeNilMatcher struct {\n}\n\nfunc (matcher *BeNilMatcher) Match(actual any) (success bool, err error) {\n\treturn isNil(actual), nil\n}\n\nfunc (matcher *BeNilMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to be nil\")\n}\n\nfunc (matcher *BeNilMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to be nil\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_numerically_matcher.go",
"content": "// untested sections: 4\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"math\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeNumericallyMatcher struct {\n\tComparator string\n\tCompareTo []any\n}\n\nfunc (matcher *BeNumericallyMatcher) FailureMessage(actual any) (message string) {\n\treturn matcher.FormatFailureMessage(actual, false)\n}\n\nfunc (matcher *BeNumericallyMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn matcher.FormatFailureMessage(actual, true)\n}\n\nfunc (matcher *BeNumericallyMatcher) FormatFailureMessage(actual any, negated bool) (message string) {\n\tif len(matcher.CompareTo) == 1 {\n\t\tmessage = fmt.Sprintf(\"to be %s\", matcher.Comparator)\n\t} else {\n\t\tmessage = fmt.Sprintf(\"to be within %v of %s\", matcher.CompareTo[1], matcher.Comparator)\n\t}\n\tif negated {\n\t\tmessage = \"not \" + message\n\t}\n\treturn format.Message(actual, message, matcher.CompareTo[0])\n}\n\nfunc (matcher *BeNumericallyMatcher) Match(actual any) (success bool, err error) {\n\tif len(matcher.CompareTo) == 0 || len(matcher.CompareTo) > 2 {\n\t\treturn false, fmt.Errorf(\"BeNumerically requires 1 or 2 CompareTo arguments. Got:\\n%s\", format.Object(matcher.CompareTo, 1))\n\t}\n\tif !isNumber(actual) {\n\t\treturn false, fmt.Errorf(\"Expected a number. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\tif !isNumber(matcher.CompareTo[0]) {\n\t\treturn false, fmt.Errorf(\"Expected a number. Got:\\n%s\", format.Object(matcher.CompareTo[0], 1))\n\t}\n\tif len(matcher.CompareTo) == 2 && !isNumber(matcher.CompareTo[1]) {\n\t\treturn false, fmt.Errorf(\"Expected a number. Got:\\n%s\", format.Object(matcher.CompareTo[1], 1))\n\t}\n\n\tswitch matcher.Comparator {\n\tcase \"==\", \"~\", \">\", \">=\", \"<\", \"<=\":\n\tdefault:\n\t\treturn false, fmt.Errorf(\"Unknown comparator: %s\", matcher.Comparator)\n\t}\n\n\tif isFloat(actual) || isFloat(matcher.CompareTo[0]) {\n\t\tvar secondOperand float64 = 1e-8\n\t\tif len(matcher.CompareTo) == 2 {\n\t\t\tsecondOperand = toFloat(matcher.CompareTo[1])\n\t\t}\n\t\tsuccess = matcher.matchFloats(toFloat(actual), toFloat(matcher.CompareTo[0]), secondOperand)\n\t} else if isInteger(actual) {\n\t\tvar secondOperand int64 = 0\n\t\tif len(matcher.CompareTo) == 2 {\n\t\t\tsecondOperand = toInteger(matcher.CompareTo[1])\n\t\t}\n\t\tsuccess = matcher.matchIntegers(toInteger(actual), toInteger(matcher.CompareTo[0]), secondOperand)\n\t} else if isUnsignedInteger(actual) {\n\t\tvar secondOperand uint64 = 0\n\t\tif len(matcher.CompareTo) == 2 {\n\t\t\tsecondOperand = toUnsignedInteger(matcher.CompareTo[1])\n\t\t}\n\t\tsuccess = matcher.matchUnsignedIntegers(toUnsignedInteger(actual), toUnsignedInteger(matcher.CompareTo[0]), secondOperand)\n\t} else {\n\t\treturn false, fmt.Errorf(\"Failed to compare:\\n%s\\n%s:\\n%s\", format.Object(actual, 1), matcher.Comparator, format.Object(matcher.CompareTo[0], 1))\n\t}\n\n\treturn success, nil\n}\n\nfunc (matcher *BeNumericallyMatcher) matchIntegers(actual, compareTo, threshold int64) (success bool) {\n\tswitch matcher.Comparator {\n\tcase \"==\", \"~\":\n\t\tdiff := actual - compareTo\n\t\treturn -threshold <= diff && diff <= threshold\n\tcase \">\":\n\t\treturn (actual > compareTo)\n\tcase \">=\":\n\t\treturn (actual >= compareTo)\n\tcase \"<\":\n\t\treturn (actual < compareTo)\n\tcase \"<=\":\n\t\treturn (actual <= compareTo)\n\t}\n\treturn false\n}\n\nfunc (matcher *BeNumericallyMatcher) matchUnsignedIntegers(actual, compareTo, threshold uint64) (success bool) {\n\tswitch matcher.Comparator {\n\tcase \"==\", \"~\":\n\t\tif actual < compareTo {\n\t\t\tactual, compareTo = compareTo, actual\n\t\t}\n\t\treturn actual-compareTo <= threshold\n\tcase \">\":\n\t\treturn (actual > compareTo)\n\tcase \">=\":\n\t\treturn (actual >= compareTo)\n\tcase \"<\":\n\t\treturn (actual < compareTo)\n\tcase \"<=\":\n\t\treturn (actual <= compareTo)\n\t}\n\treturn false\n}\n\nfunc (matcher *BeNumericallyMatcher) matchFloats(actual, compareTo, threshold float64) (success bool) {\n\tswitch matcher.Comparator {\n\tcase \"~\":\n\t\treturn math.Abs(actual-compareTo) <= threshold\n\tcase \"==\":\n\t\treturn (actual == compareTo)\n\tcase \">\":\n\t\treturn (actual > compareTo)\n\tcase \">=\":\n\t\treturn (actual >= compareTo)\n\tcase \"<\":\n\t\treturn (actual < compareTo)\n\tcase \"<=\":\n\t\treturn (actual <= compareTo)\n\t}\n\treturn false\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_sent_matcher.go",
"content": "// untested sections: 3\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeSentMatcher struct {\n\tArg any\n\tchannelClosed bool\n}\n\nfunc (matcher *BeSentMatcher) Match(actual any) (success bool, err error) {\n\tif !isChan(actual) {\n\t\treturn false, fmt.Errorf(\"BeSent expects a channel. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tchannelType := reflect.TypeOf(actual)\n\tchannelValue := reflect.ValueOf(actual)\n\n\tif channelType.ChanDir() == reflect.RecvDir {\n\t\treturn false, fmt.Errorf(\"BeSent matcher cannot be passed a receive-only channel. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\targType := reflect.TypeOf(matcher.Arg)\n\tassignable := argType.AssignableTo(channelType.Elem())\n\n\tif !assignable {\n\t\treturn false, fmt.Errorf(\"Cannot pass:\\n%s to the channel:\\n%s\\nThe types don't match.\", format.Object(matcher.Arg, 1), format.Object(actual, 1))\n\t}\n\n\targValue := reflect.ValueOf(matcher.Arg)\n\n\tdefer func() {\n\t\tif e := recover(); e != nil {\n\t\t\tsuccess = false\n\t\t\terr = fmt.Errorf(\"Cannot send to a closed channel\")\n\t\t\tmatcher.channelClosed = true\n\t\t}\n\t}()\n\n\twinnerIndex, _, _ := reflect.Select([]reflect.SelectCase{\n\t\t{Dir: reflect.SelectSend, Chan: channelValue, Send: argValue},\n\t\t{Dir: reflect.SelectDefault},\n\t})\n\n\tvar didSend bool\n\tif winnerIndex == 0 {\n\t\tdidSend = true\n\t}\n\n\treturn didSend, nil\n}\n\nfunc (matcher *BeSentMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to send:\", matcher.Arg)\n}\n\nfunc (matcher *BeSentMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to send:\", matcher.Arg)\n}\n\nfunc (matcher *BeSentMatcher) MatchMayChangeInTheFuture(actual any) bool {\n\tif !isChan(actual) {\n\t\treturn false\n\t}\n\n\treturn !matcher.channelClosed\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_temporally_matcher.go",
"content": "// untested sections: 3\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeTemporallyMatcher struct {\n\tComparator string\n\tCompareTo time.Time\n\tThreshold []time.Duration\n}\n\nfunc (matcher *BeTemporallyMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, fmt.Sprintf(\"to be %s\", matcher.Comparator), matcher.CompareTo)\n}\n\nfunc (matcher *BeTemporallyMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, fmt.Sprintf(\"not to be %s\", matcher.Comparator), matcher.CompareTo)\n}\n\nfunc (matcher *BeTemporallyMatcher) Match(actual any) (bool, error) {\n\t// predicate to test for time.Time type\n\tisTime := func(t any) bool {\n\t\t_, ok := t.(time.Time)\n\t\treturn ok\n\t}\n\n\tif !isTime(actual) {\n\t\treturn false, fmt.Errorf(\"Expected a time.Time. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tswitch matcher.Comparator {\n\tcase \"==\", \"~\", \">\", \">=\", \"<\", \"<=\":\n\tdefault:\n\t\treturn false, fmt.Errorf(\"Unknown comparator: %s\", matcher.Comparator)\n\t}\n\n\tvar threshold = time.Millisecond\n\tif len(matcher.Threshold) == 1 {\n\t\tthreshold = matcher.Threshold[0]\n\t}\n\n\treturn matcher.matchTimes(actual.(time.Time), matcher.CompareTo, threshold), nil\n}\n\nfunc (matcher *BeTemporallyMatcher) matchTimes(actual, compareTo time.Time, threshold time.Duration) (success bool) {\n\tswitch matcher.Comparator {\n\tcase \"==\":\n\t\treturn actual.Equal(compareTo)\n\tcase \"~\":\n\t\tdiff := actual.Sub(compareTo)\n\t\treturn -threshold <= diff && diff <= threshold\n\tcase \">\":\n\t\treturn actual.After(compareTo)\n\tcase \">=\":\n\t\treturn !actual.Before(compareTo)\n\tcase \"<\":\n\t\treturn actual.Before(compareTo)\n\tcase \"<=\":\n\t\treturn !actual.After(compareTo)\n\t}\n\treturn false\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_true_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeTrueMatcher struct {\n\tReason string\n}\n\nfunc (matcher *BeTrueMatcher) Match(actual any) (success bool, err error) {\n\tif !isBool(actual) {\n\t\treturn false, fmt.Errorf(\"Expected a boolean. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\treturn actual.(bool), nil\n}\n\nfunc (matcher *BeTrueMatcher) FailureMessage(actual any) (message string) {\n\tif matcher.Reason == \"\" {\n\t\treturn format.Message(actual, \"to be true\")\n\t} else {\n\t\treturn matcher.Reason\n\t}\n}\n\nfunc (matcher *BeTrueMatcher) NegatedFailureMessage(actual any) (message string) {\n\tif matcher.Reason == \"\" {\n\t\treturn format.Message(actual, \"not to be true\")\n\t} else {\n\t\treturn fmt.Sprintf(`Expected not true but got true\\nNegation of \"%s\" failed`, matcher.Reason)\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/be_zero_matcher.go",
"content": "package matchers\n\nimport (\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype BeZeroMatcher struct {\n}\n\nfunc (matcher *BeZeroMatcher) Match(actual any) (success bool, err error) {\n\tif actual == nil {\n\t\treturn true, nil\n\t}\n\tzeroValue := reflect.Zero(reflect.TypeOf(actual)).Interface()\n\n\treturn reflect.DeepEqual(zeroValue, actual), nil\n\n}\n\nfunc (matcher *BeZeroMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to be zero-valued\")\n}\n\nfunc (matcher *BeZeroMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to be zero-valued\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/consist_of.go",
"content": "// untested sections: 3\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n\t\"github.com/onsi/gomega/matchers/support/goraph/bipartitegraph\"\n)\n\ntype ConsistOfMatcher struct {\n\tElements []any\n\tmissingElements []any\n\textraElements []any\n}\n\nfunc (matcher *ConsistOfMatcher) Match(actual any) (success bool, err error) {\n\tif !isArrayOrSlice(actual) && !isMap(actual) && !miter.IsIter(actual) {\n\t\treturn false, fmt.Errorf(\"ConsistOf matcher expects an array/slice/map/iter.Seq/iter.Seq2. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tmatchers := matchers(matcher.Elements)\n\tvalues := valuesOf(actual)\n\n\tbipartiteGraph, err := bipartitegraph.NewBipartiteGraph(values, matchers, neighbours)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\tedges := bipartiteGraph.LargestMatching()\n\tif len(edges) == len(values) && len(edges) == len(matchers) {\n\t\treturn true, nil\n\t}\n\n\tvar missingMatchers []any\n\tmatcher.extraElements, missingMatchers = bipartiteGraph.FreeLeftRight(edges)\n\tmatcher.missingElements = equalMatchersToElements(missingMatchers)\n\n\treturn false, nil\n}\n\nfunc neighbours(value, matcher any) (bool, error) {\n\tmatch, err := matcher.(omegaMatcher).Match(value)\n\treturn match && err == nil, nil\n}\n\nfunc equalMatchersToElements(matchers []any) (elements []any) {\n\tfor _, matcher := range matchers {\n\t\tif equalMatcher, ok := matcher.(*EqualMatcher); ok {\n\t\t\telements = append(elements, equalMatcher.Expected)\n\t\t} else if _, ok := matcher.(*BeNilMatcher); ok {\n\t\t\telements = append(elements, nil)\n\t\t} else {\n\t\t\telements = append(elements, matcher)\n\t\t}\n\t}\n\treturn\n}\n\nfunc flatten(elems []any) []any {\n\tif len(elems) != 1 ||\n\t\t!(isArrayOrSlice(elems[0]) ||\n\t\t\t(miter.IsIter(elems[0]) && !miter.IsSeq2(elems[0]))) {\n\t\treturn elems\n\t}\n\n\tif miter.IsIter(elems[0]) {\n\t\tflattened := []any{}\n\t\tmiter.IterateV(elems[0], func(v reflect.Value) bool {\n\t\t\tflattened = append(flattened, v.Interface())\n\t\t\treturn true\n\t\t})\n\t\treturn flattened\n\t}\n\n\tvalue := reflect.ValueOf(elems[0])\n\tflattened := make([]any, value.Len())\n\tfor i := 0; i < value.Len(); i++ {\n\t\tflattened[i] = value.Index(i).Interface()\n\t}\n\treturn flattened\n}\n\nfunc matchers(expectedElems []any) (matchers []any) {\n\tfor _, e := range flatten(expectedElems) {\n\t\tif e == nil {\n\t\t\tmatchers = append(matchers, &BeNilMatcher{})\n\t\t} else if matcher, isMatcher := e.(omegaMatcher); isMatcher {\n\t\t\tmatchers = append(matchers, matcher)\n\t\t} else {\n\t\t\tmatchers = append(matchers, &EqualMatcher{Expected: e})\n\t\t}\n\t}\n\treturn\n}\n\nfunc presentable(elems []any) any {\n\telems = flatten(elems)\n\n\tif len(elems) == 0 {\n\t\treturn []any{}\n\t}\n\n\tsv := reflect.ValueOf(elems)\n\tfirstEl := sv.Index(0)\n\tif firstEl.IsNil() {\n\t\treturn elems\n\t}\n\ttt := firstEl.Elem().Type()\n\tfor i := 1; i < sv.Len(); i++ {\n\t\tel := sv.Index(i)\n\t\tif el.IsNil() || (sv.Index(i).Elem().Type() != tt) {\n\t\t\treturn elems\n\t\t}\n\t}\n\n\tss := reflect.MakeSlice(reflect.SliceOf(tt), sv.Len(), sv.Len())\n\tfor i := 0; i < sv.Len(); i++ {\n\t\tss.Index(i).Set(sv.Index(i).Elem())\n\t}\n\n\treturn ss.Interface()\n}\n\nfunc valuesOf(actual any) []any {\n\tvalue := reflect.ValueOf(actual)\n\tvalues := []any{}\n\tif miter.IsIter(actual) {\n\t\tif miter.IsSeq2(actual) {\n\t\t\tmiter.IterateKV(actual, func(k, v reflect.Value) bool {\n\t\t\t\tvalues = append(values, v.Interface())\n\t\t\t\treturn true\n\t\t\t})\n\t\t} else {\n\t\t\tmiter.IterateV(actual, func(v reflect.Value) bool {\n\t\t\t\tvalues = append(values, v.Interface())\n\t\t\t\treturn true\n\t\t\t})\n\t\t}\n\t} else if isMap(actual) {\n\t\tkeys := value.MapKeys()\n\t\tfor i := 0; i < value.Len(); i++ {\n\t\t\tvalues = append(values, value.MapIndex(keys[i]).Interface())\n\t\t}\n\t} else {\n\t\tfor i := 0; i < value.Len(); i++ {\n\t\t\tvalues = append(values, value.Index(i).Interface())\n\t\t}\n\t}\n\n\treturn values\n}\n\nfunc (matcher *ConsistOfMatcher) FailureMessage(actual any) (message string) {\n\tmessage = format.Message(actual, \"to consist of\", presentable(matcher.Elements))\n\tmessage = appendMissingElements(message, matcher.missingElements)\n\tif len(matcher.extraElements) > 0 {\n\t\tmessage = fmt.Sprintf(\"%s\\nthe extra elements were\\n%s\", message,\n\t\t\tformat.Object(presentable(matcher.extraElements), 1))\n\t}\n\treturn\n}\n\nfunc appendMissingElements(message string, missingElements []any) string {\n\tif len(missingElements) == 0 {\n\t\treturn message\n\t}\n\treturn fmt.Sprintf(\"%s\\nthe missing elements were\\n%s\", message,\n\t\tformat.Object(presentable(missingElements), 1))\n}\n\nfunc (matcher *ConsistOfMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to consist of\", presentable(matcher.Elements))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/contain_element_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n)\n\ntype ContainElementMatcher struct {\n\tElement any\n\tResult []any\n}\n\nfunc (matcher *ContainElementMatcher) Match(actual any) (success bool, err error) {\n\tif !isArrayOrSlice(actual) && !isMap(actual) && !miter.IsIter(actual) {\n\t\treturn false, fmt.Errorf(\"ContainElement matcher expects an array/slice/map/iterator. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tvar actualT reflect.Type\n\tvar result reflect.Value\n\tswitch numResultArgs := len(matcher.Result); {\n\tcase numResultArgs > 1:\n\t\treturn false, errors.New(\"ContainElement matcher expects at most a single optional pointer to store its findings at\")\n\tcase numResultArgs == 1:\n\t\t// Check the optional result arg to point to a single value/array/slice/map\n\t\t// of a type compatible with the actual value.\n\t\tif reflect.ValueOf(matcher.Result[0]).Kind() != reflect.Ptr {\n\t\t\treturn false, fmt.Errorf(\"ContainElement matcher expects a non-nil pointer to store its findings at. Got\\n%s\",\n\t\t\t\tformat.Object(matcher.Result[0], 1))\n\t\t}\n\t\tactualT = reflect.TypeOf(actual)\n\t\tresultReference := matcher.Result[0]\n\t\tresult = reflect.ValueOf(resultReference).Elem() // what ResultReference points to, to stash away our findings\n\t\tswitch result.Kind() {\n\t\tcase reflect.Array: // result arrays are not supported, as they cannot be dynamically sized.\n\t\t\tif miter.IsIter(actual) {\n\t\t\t\t_, actualvT := miter.IterKVTypes(actual)\n\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\treflect.SliceOf(actualvT), result.Type().String())\n\t\t\t}\n\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\treflect.SliceOf(actualT.Elem()).String(), result.Type().String())\n\n\t\tcase reflect.Slice: // result slice\n\t\t\t// can we assign elements in actual to elements in what the result\n\t\t\t// arg points to?\n\t\t\t// - ✔ actual is an array or slice\n\t\t\t// - ✔ actual is an iter.Seq producing \"v\" elements\n\t\t\t// - ✔ actual is an iter.Seq2 producing \"v\" elements, ignoring\n\t\t\t// the \"k\" elements.\n\t\t\tswitch {\n\t\t\tcase isArrayOrSlice(actual):\n\t\t\t\tif !actualT.Elem().AssignableTo(result.Type().Elem()) {\n\t\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\t\tactualT.String(), result.Type().String())\n\t\t\t\t}\n\n\t\t\tcase miter.IsIter(actual):\n\t\t\t\t_, actualvT := miter.IterKVTypes(actual)\n\t\t\t\tif !actualvT.AssignableTo(result.Type().Elem()) {\n\t\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\t\tactualvT.String(), result.Type().String())\n\t\t\t\t}\n\n\t\t\tdefault: // incompatible result reference\n\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\treflect.MapOf(actualT.Key(), actualT.Elem()).String(), result.Type().String())\n\t\t\t}\n\n\t\tcase reflect.Map: // result map\n\t\t\t// can we assign elements in actual to elements in what the result\n\t\t\t// arg points to?\n\t\t\t// - ✔ actual is a map\n\t\t\t// - ✔ actual is an iter.Seq2 (iter.Seq doesn't fit though)\n\t\t\tswitch {\n\t\t\tcase isMap(actual):\n\t\t\t\tif !actualT.AssignableTo(result.Type()) {\n\t\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\t\tactualT.String(), result.Type().String())\n\t\t\t\t}\n\n\t\t\tcase miter.IsIter(actual):\n\t\t\t\tactualkT, actualvT := miter.IterKVTypes(actual)\n\t\t\t\tif actualkT == nil {\n\t\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\t\treflect.SliceOf(actualvT).String(), result.Type().String())\n\t\t\t\t}\n\t\t\t\tif !reflect.MapOf(actualkT, actualvT).AssignableTo(result.Type()) {\n\t\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\t\treflect.MapOf(actualkT, actualvT), result.Type().String())\n\t\t\t\t}\n\n\t\t\tdefault: // incompatible result reference\n\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\tactualT.String(), result.Type().String())\n\t\t\t}\n\n\t\tdefault:\n\t\t\t// can we assign a (single) element in actual to what the result arg\n\t\t\t// points to?\n\t\t\tswitch {\n\t\t\tcase miter.IsIter(actual):\n\t\t\t\t_, actualvT := miter.IterKVTypes(actual)\n\t\t\t\tif !actualvT.AssignableTo(result.Type()) {\n\t\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\t\tactualvT.String(), result.Type().String())\n\t\t\t\t}\n\t\t\tdefault:\n\t\t\t\tif !actualT.Elem().AssignableTo(result.Type()) {\n\t\t\t\t\treturn false, fmt.Errorf(\"ContainElement cannot return findings. Need *%s, got *%s\",\n\t\t\t\t\t\tactualT.Elem().String(), result.Type().String())\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t// If the supplied matcher isn't an Omega matcher, default to the Equal\n\t// matcher.\n\telemMatcher, elementIsMatcher := matcher.Element.(omegaMatcher)\n\tif !elementIsMatcher {\n\t\telemMatcher = &EqualMatcher{Expected: matcher.Element}\n\t}\n\n\tvalue := reflect.ValueOf(actual)\n\n\tvar getFindings func() reflect.Value // abstracts how the findings are collected and stored\n\tvar lastError error\n\n\tif !miter.IsIter(actual) {\n\t\tvar valueAt func(int) any\n\t\tvar foundAt func(int)\n\t\t// We're dealing with an array/slice/map, so in all cases we can iterate\n\t\t// over the elements in actual using indices (that can be considered\n\t\t// keys in case of maps).\n\t\tif isMap(actual) {\n\t\t\tkeys := value.MapKeys()\n\t\t\tvalueAt = func(i int) any {\n\t\t\t\treturn value.MapIndex(keys[i]).Interface()\n\t\t\t}\n\t\t\tif result.Kind() != reflect.Invalid {\n\t\t\t\tfm := reflect.MakeMap(actualT)\n\t\t\t\tgetFindings = func() reflect.Value { return fm }\n\t\t\t\tfoundAt = func(i int) {\n\t\t\t\t\tfm.SetMapIndex(keys[i], value.MapIndex(keys[i]))\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tvalueAt = func(i int) any {\n\t\t\t\treturn value.Index(i).Interface()\n\t\t\t}\n\t\t\tif result.Kind() != reflect.Invalid {\n\t\t\t\tvar fsl reflect.Value\n\t\t\t\tif result.Kind() == reflect.Slice {\n\t\t\t\t\tfsl = reflect.MakeSlice(result.Type(), 0, 0)\n\t\t\t\t} else {\n\t\t\t\t\tfsl = reflect.MakeSlice(reflect.SliceOf(result.Type()), 0, 0)\n\t\t\t\t}\n\t\t\t\tgetFindings = func() reflect.Value { return fsl }\n\t\t\t\tfoundAt = func(i int) {\n\t\t\t\t\tfsl = reflect.Append(fsl, value.Index(i))\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tfor i := 0; i < value.Len(); i++ {\n\t\t\telem := valueAt(i)\n\t\t\tsuccess, err := elemMatcher.Match(elem)\n\t\t\tif err != nil {\n\t\t\t\tlastError = err\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif success {\n\t\t\t\tif result.Kind() == reflect.Invalid {\n\t\t\t\t\treturn true, nil\n\t\t\t\t}\n\t\t\t\tfoundAt(i)\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// We're dealing with an iterator as a first-class construct, so things\n\t\t// are slightly different: there is no index defined as in case of\n\t\t// arrays/slices/maps, just \"ooooorder\"\n\t\tvar found func(k, v reflect.Value)\n\t\tif result.Kind() != reflect.Invalid {\n\t\t\tif result.Kind() == reflect.Map {\n\t\t\t\tfm := reflect.MakeMap(result.Type())\n\t\t\t\tgetFindings = func() reflect.Value { return fm }\n\t\t\t\tfound = func(k, v reflect.Value) { fm.SetMapIndex(k, v) }\n\t\t\t} else {\n\t\t\t\tvar fsl reflect.Value\n\t\t\t\tif result.Kind() == reflect.Slice {\n\t\t\t\t\tfsl = reflect.MakeSlice(result.Type(), 0, 0)\n\t\t\t\t} else {\n\t\t\t\t\tfsl = reflect.MakeSlice(reflect.SliceOf(result.Type()), 0, 0)\n\t\t\t\t}\n\t\t\t\tgetFindings = func() reflect.Value { return fsl }\n\t\t\t\tfound = func(_, v reflect.Value) { fsl = reflect.Append(fsl, v) }\n\t\t\t}\n\t\t}\n\n\t\tsuccess := false\n\t\tactualkT, _ := miter.IterKVTypes(actual)\n\t\tif actualkT == nil {\n\t\t\tmiter.IterateV(actual, func(v reflect.Value) bool {\n\t\t\t\tvar err error\n\t\t\t\tsuccess, err = elemMatcher.Match(v.Interface())\n\t\t\t\tif err != nil {\n\t\t\t\t\tlastError = err\n\t\t\t\t\treturn true // iterate on...\n\t\t\t\t}\n\t\t\t\tif success {\n\t\t\t\t\tif result.Kind() == reflect.Invalid {\n\t\t\t\t\t\treturn false // a match and no result needed, so we're done\n\t\t\t\t\t}\n\t\t\t\t\tfound(reflect.Value{}, v)\n\t\t\t\t}\n\t\t\t\treturn true // iterate on...\n\t\t\t})\n\t\t} else {\n\t\t\tmiter.IterateKV(actual, func(k, v reflect.Value) bool {\n\t\t\t\tvar err error\n\t\t\t\tsuccess, err = elemMatcher.Match(v.Interface())\n\t\t\t\tif err != nil {\n\t\t\t\t\tlastError = err\n\t\t\t\t\treturn true // iterate on...\n\t\t\t\t}\n\t\t\t\tif success {\n\t\t\t\t\tif result.Kind() == reflect.Invalid {\n\t\t\t\t\t\treturn false // a match and no result needed, so we're done\n\t\t\t\t\t}\n\t\t\t\t\tfound(k, v)\n\t\t\t\t}\n\t\t\t\treturn true // iterate on...\n\t\t\t})\n\t\t}\n\t\tif success && result.Kind() == reflect.Invalid {\n\t\t\treturn true, nil\n\t\t}\n\t}\n\n\t// when the expectation isn't interested in the findings except for success\n\t// or non-success, then we're done here and return the last matcher error\n\t// seen, if any, as well as non-success.\n\tif result.Kind() == reflect.Invalid {\n\t\treturn false, lastError\n\t}\n\n\t// pick up any findings the test is interested in as it specified a non-nil\n\t// result reference. However, the expectation always is that there are at\n\t// least one or multiple findings. So, if a result is expected, but we had\n\t// no findings, then this is an error.\n\tfindings := getFindings()\n\tif findings.Len() == 0 {\n\t\treturn false, lastError\n\t}\n\n\t// there's just a single finding and the result is neither a slice nor a map\n\t// (so it's a scalar): pick the one and only finding and return it in the\n\t// place the reference points to.\n\tif findings.Len() == 1 && !isArrayOrSlice(result.Interface()) && !isMap(result.Interface()) {\n\t\tif isMap(actual) {\n\t\t\tmiter := findings.MapRange()\n\t\t\tmiter.Next()\n\t\t\tresult.Set(miter.Value())\n\t\t} else {\n\t\t\tresult.Set(findings.Index(0))\n\t\t}\n\t\treturn true, nil\n\t}\n\n\t// at least one or even multiple findings and a the result references a\n\t// slice or a map, so all we need to do is to store our findings where the\n\t// reference points to.\n\tif !findings.Type().AssignableTo(result.Type()) {\n\t\treturn false, fmt.Errorf(\"ContainElement cannot return multiple findings. Need *%s, got *%s\",\n\t\t\tfindings.Type().String(), result.Type().String())\n\t}\n\tresult.Set(findings)\n\treturn true, nil\n}\n\nfunc (matcher *ContainElementMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to contain element matching\", matcher.Element)\n}\n\nfunc (matcher *ContainElementMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to contain element matching\", matcher.Element)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/contain_elements_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n\t\"github.com/onsi/gomega/matchers/support/goraph/bipartitegraph\"\n)\n\ntype ContainElementsMatcher struct {\n\tElements []any\n\tmissingElements []any\n}\n\nfunc (matcher *ContainElementsMatcher) Match(actual any) (success bool, err error) {\n\tif !isArrayOrSlice(actual) && !isMap(actual) && !miter.IsIter(actual) {\n\t\treturn false, fmt.Errorf(\"ContainElements matcher expects an array/slice/map/iter.Seq/iter.Seq2. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tmatchers := matchers(matcher.Elements)\n\tbipartiteGraph, err := bipartitegraph.NewBipartiteGraph(valuesOf(actual), matchers, neighbours)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\tedges := bipartiteGraph.LargestMatching()\n\tif len(edges) == len(matchers) {\n\t\treturn true, nil\n\t}\n\n\t_, missingMatchers := bipartiteGraph.FreeLeftRight(edges)\n\tmatcher.missingElements = equalMatchersToElements(missingMatchers)\n\n\treturn false, nil\n}\n\nfunc (matcher *ContainElementsMatcher) FailureMessage(actual any) (message string) {\n\tmessage = format.Message(actual, \"to contain elements\", presentable(matcher.Elements))\n\treturn appendMissingElements(message, matcher.missingElements)\n}\n\nfunc (matcher *ContainElementsMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to contain elements\", presentable(matcher.Elements))\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/contain_substring_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype ContainSubstringMatcher struct {\n\tSubstr string\n\tArgs []any\n}\n\nfunc (matcher *ContainSubstringMatcher) Match(actual any) (success bool, err error) {\n\tactualString, ok := toString(actual)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"ContainSubstring matcher requires a string or stringer. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\treturn strings.Contains(actualString, matcher.stringToMatch()), nil\n}\n\nfunc (matcher *ContainSubstringMatcher) stringToMatch() string {\n\tstringToMatch := matcher.Substr\n\tif len(matcher.Args) > 0 {\n\t\tstringToMatch = fmt.Sprintf(matcher.Substr, matcher.Args...)\n\t}\n\treturn stringToMatch\n}\n\nfunc (matcher *ContainSubstringMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to contain substring\", matcher.stringToMatch())\n}\n\nfunc (matcher *ContainSubstringMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to contain substring\", matcher.stringToMatch())\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/equal_matcher.go",
"content": "package matchers\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype EqualMatcher struct {\n\tExpected any\n}\n\nfunc (matcher *EqualMatcher) Match(actual any) (success bool, err error) {\n\tif actual == nil && matcher.Expected == nil {\n\t\treturn false, fmt.Errorf(\"Refusing to compare to .\\nBe explicit and use BeNil() instead. This is to avoid mistakes where both sides of an assertion are erroneously uninitialized.\")\n\t}\n\t// Shortcut for byte slices.\n\t// Comparing long byte slices with reflect.DeepEqual is very slow,\n\t// so use bytes.Equal if actual and expected are both byte slices.\n\tif actualByteSlice, ok := actual.([]byte); ok {\n\t\tif expectedByteSlice, ok := matcher.Expected.([]byte); ok {\n\t\t\treturn bytes.Equal(actualByteSlice, expectedByteSlice), nil\n\t\t}\n\t}\n\treturn reflect.DeepEqual(actual, matcher.Expected), nil\n}\n\nfunc (matcher *EqualMatcher) FailureMessage(actual any) (message string) {\n\tactualString, actualOK := actual.(string)\n\texpectedString, expectedOK := matcher.Expected.(string)\n\tif actualOK && expectedOK {\n\t\treturn format.MessageWithDiff(actualString, \"to equal\", expectedString)\n\t}\n\n\treturn format.Message(actual, \"to equal\", matcher.Expected)\n}\n\nfunc (matcher *EqualMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to equal\", matcher.Expected)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_cap_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype HaveCapMatcher struct {\n\tCount int\n}\n\nfunc (matcher *HaveCapMatcher) Match(actual any) (success bool, err error) {\n\tlength, ok := capOf(actual)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"HaveCap matcher expects a array/channel/slice. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\treturn length == matcher.Count, nil\n}\n\nfunc (matcher *HaveCapMatcher) FailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected\\n%s\\nto have capacity %d\", format.Object(actual, 1), matcher.Count)\n}\n\nfunc (matcher *HaveCapMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected\\n%s\\nnot to have capacity %d\", format.Object(actual, 1), matcher.Count)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_each_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n)\n\ntype HaveEachMatcher struct {\n\tElement any\n}\n\nfunc (matcher *HaveEachMatcher) Match(actual any) (success bool, err error) {\n\tif !isArrayOrSlice(actual) && !isMap(actual) && !miter.IsIter(actual) {\n\t\treturn false, fmt.Errorf(\"HaveEach matcher expects an array/slice/map/iter.Seq/iter.Seq2. Got:\\n%s\",\n\t\t\tformat.Object(actual, 1))\n\t}\n\n\telemMatcher, elementIsMatcher := matcher.Element.(omegaMatcher)\n\tif !elementIsMatcher {\n\t\telemMatcher = &EqualMatcher{Expected: matcher.Element}\n\t}\n\n\tif miter.IsIter(actual) {\n\t\t// rejecting the non-elements case works different for iterators as we\n\t\t// don't want to fetch all elements into a slice first.\n\t\tcount := 0\n\t\tvar success bool\n\t\tvar err error\n\t\tif miter.IsSeq2(actual) {\n\t\t\tmiter.IterateKV(actual, func(k, v reflect.Value) bool {\n\t\t\t\tcount++\n\t\t\t\tsuccess, err = elemMatcher.Match(v.Interface())\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\treturn success\n\t\t\t})\n\t\t} else {\n\t\t\tmiter.IterateV(actual, func(v reflect.Value) bool {\n\t\t\t\tcount++\n\t\t\t\tsuccess, err = elemMatcher.Match(v.Interface())\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\treturn success\n\t\t\t})\n\t\t}\n\t\tif count == 0 {\n\t\t\treturn false, fmt.Errorf(\"HaveEach matcher expects a non-empty iter.Seq/iter.Seq2. Got:\\n%s\",\n\t\t\t\tformat.Object(actual, 1))\n\t\t}\n\t\treturn success, err\n\t}\n\n\tvalue := reflect.ValueOf(actual)\n\tif value.Len() == 0 {\n\t\treturn false, fmt.Errorf(\"HaveEach matcher expects a non-empty array/slice/map. Got:\\n%s\",\n\t\t\tformat.Object(actual, 1))\n\t}\n\n\tvar valueAt func(int) any\n\tif isMap(actual) {\n\t\tkeys := value.MapKeys()\n\t\tvalueAt = func(i int) any {\n\t\t\treturn value.MapIndex(keys[i]).Interface()\n\t\t}\n\t} else {\n\t\tvalueAt = func(i int) any {\n\t\t\treturn value.Index(i).Interface()\n\t\t}\n\t}\n\n\t// if we never failed then we succeed; the empty/nil cases have already been\n\t// rejected above.\n\tfor i := 0; i < value.Len(); i++ {\n\t\tsuccess, err := elemMatcher.Match(valueAt(i))\n\t\tif err != nil {\n\t\t\treturn false, err\n\t\t}\n\t\tif !success {\n\t\t\treturn false, nil\n\t\t}\n\t}\n\n\treturn true, nil\n}\n\n// FailureMessage returns a suitable failure message.\nfunc (matcher *HaveEachMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to contain element matching\", matcher.Element)\n}\n\n// NegatedFailureMessage returns a suitable negated failure message.\nfunc (matcher *HaveEachMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to contain element matching\", matcher.Element)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_exact_elements.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n)\n\ntype mismatchFailure struct {\n\tfailure string\n\tindex int\n}\n\ntype HaveExactElementsMatcher struct {\n\tElements []any\n\tmismatchFailures []mismatchFailure\n\tmissingIndex int\n\textraIndex int\n}\n\nfunc (matcher *HaveExactElementsMatcher) Match(actual any) (success bool, err error) {\n\tmatcher.resetState()\n\n\tif isMap(actual) || miter.IsSeq2(actual) {\n\t\treturn false, fmt.Errorf(\"HaveExactElements matcher doesn't work on map or iter.Seq2. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tmatchers := matchers(matcher.Elements)\n\tlenMatchers := len(matchers)\n\n\tsuccess = true\n\n\tif miter.IsIter(actual) {\n\t\t// In the worst case, we need to see everything before we can give our\n\t\t// verdict. The only exception is fast fail.\n\t\ti := 0\n\t\tmiter.IterateV(actual, func(v reflect.Value) bool {\n\t\t\tif i >= lenMatchers {\n\t\t\t\t// the iterator produces more values than we got matchers: this\n\t\t\t\t// is not good.\n\t\t\t\tmatcher.extraIndex = i\n\t\t\t\tsuccess = false\n\t\t\t\treturn false\n\t\t\t}\n\n\t\t\telemMatcher := matchers[i].(omegaMatcher)\n\t\t\tmatch, err := elemMatcher.Match(v.Interface())\n\t\t\tif err != nil {\n\t\t\t\tmatcher.mismatchFailures = append(matcher.mismatchFailures, mismatchFailure{\n\t\t\t\t\tindex: i,\n\t\t\t\t\tfailure: err.Error(),\n\t\t\t\t})\n\t\t\t\tsuccess = false\n\t\t\t} else if !match {\n\t\t\t\tmatcher.mismatchFailures = append(matcher.mismatchFailures, mismatchFailure{\n\t\t\t\t\tindex: i,\n\t\t\t\t\tfailure: elemMatcher.FailureMessage(v.Interface()),\n\t\t\t\t})\n\t\t\t\tsuccess = false\n\t\t\t}\n\t\t\ti++\n\t\t\treturn true\n\t\t})\n\t\tif i < len(matchers) {\n\t\t\t// the iterator produced less values than we got matchers: this is\n\t\t\t// no good, no no no.\n\t\t\tmatcher.missingIndex = i\n\t\t\tsuccess = false\n\t\t}\n\t\treturn success, nil\n\t}\n\n\tvalues := valuesOf(actual)\n\tlenValues := len(values)\n\n\tfor i := 0; i < lenMatchers || i < lenValues; i++ {\n\t\tif i >= lenMatchers {\n\t\t\tmatcher.extraIndex = i\n\t\t\tsuccess = false\n\t\t\tcontinue\n\t\t}\n\n\t\tif i >= lenValues {\n\t\t\tmatcher.missingIndex = i\n\t\t\tsuccess = false\n\t\t\treturn\n\t\t}\n\n\t\telemMatcher := matchers[i].(omegaMatcher)\n\t\tmatch, err := elemMatcher.Match(values[i])\n\t\tif err != nil {\n\t\t\tmatcher.mismatchFailures = append(matcher.mismatchFailures, mismatchFailure{\n\t\t\t\tindex: i,\n\t\t\t\tfailure: err.Error(),\n\t\t\t})\n\t\t\tsuccess = false\n\t\t} else if !match {\n\t\t\tmatcher.mismatchFailures = append(matcher.mismatchFailures, mismatchFailure{\n\t\t\t\tindex: i,\n\t\t\t\tfailure: elemMatcher.FailureMessage(values[i]),\n\t\t\t})\n\t\t\tsuccess = false\n\t\t}\n\t}\n\n\treturn success, nil\n}\n\nfunc (matcher *HaveExactElementsMatcher) FailureMessage(actual any) (message string) {\n\tmessage = format.Message(actual, \"to have exact elements with\", presentable(matcher.Elements))\n\tif matcher.missingIndex > 0 {\n\t\tmessage = fmt.Sprintf(\"%s\\nthe missing elements start from index %d\", message, matcher.missingIndex)\n\t}\n\tif matcher.extraIndex > 0 {\n\t\tmessage = fmt.Sprintf(\"%s\\nthe extra elements start from index %d\", message, matcher.extraIndex)\n\t}\n\tif len(matcher.mismatchFailures) != 0 {\n\t\tmessage = fmt.Sprintf(\"%s\\nthe mismatch indexes were:\", message)\n\t}\n\tfor _, mismatch := range matcher.mismatchFailures {\n\t\tmessage = fmt.Sprintf(\"%s\\n%d: %s\", message, mismatch.index, mismatch.failure)\n\t}\n\treturn\n}\n\nfunc (matcher *HaveExactElementsMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to contain elements\", presentable(matcher.Elements))\n}\n\nfunc (matcher *HaveExactElementsMatcher) resetState() {\n\tmatcher.mismatchFailures = nil\n\tmatcher.missingIndex = 0\n\tmatcher.extraIndex = 0\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_existing_field_matcher.go",
"content": "package matchers\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype HaveExistingFieldMatcher struct {\n\tField string\n}\n\nfunc (matcher *HaveExistingFieldMatcher) Match(actual any) (success bool, err error) {\n\t// we don't care about the field's actual value, just about any error in\n\t// trying to find the field (or method).\n\t_, err = extractField(actual, matcher.Field, \"HaveExistingField\")\n\tif err == nil {\n\t\treturn true, nil\n\t}\n\tvar mferr missingFieldError\n\tif errors.As(err, &mferr) {\n\t\t// missing field errors aren't errors in this context, but instead\n\t\t// unsuccessful matches.\n\t\treturn false, nil\n\t}\n\treturn false, err\n}\n\nfunc (matcher *HaveExistingFieldMatcher) FailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected\\n%s\\nto have field '%s'\", format.Object(actual, 1), matcher.Field)\n}\n\nfunc (matcher *HaveExistingFieldMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected\\n%s\\nnot to have field '%s'\", format.Object(actual, 1), matcher.Field)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_field.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\t\"strings\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\n// missingFieldError represents a missing field extraction error that\n// HaveExistingFieldMatcher can ignore, as opposed to other, sever field\n// extraction errors, such as nil pointers, et cetera.\ntype missingFieldError string\n\nfunc (e missingFieldError) Error() string {\n\treturn string(e)\n}\n\nfunc extractField(actual any, field string, matchername string) (any, error) {\n\tfields := strings.SplitN(field, \".\", 2)\n\tactualValue := reflect.ValueOf(actual)\n\n\tif actualValue.Kind() == reflect.Ptr {\n\t\tactualValue = actualValue.Elem()\n\t}\n\tif actualValue == (reflect.Value{}) {\n\t\treturn nil, fmt.Errorf(\"%s encountered nil while dereferencing a pointer of type %T.\", matchername, actual)\n\t}\n\n\tif actualValue.Kind() != reflect.Struct {\n\t\treturn nil, fmt.Errorf(\"%s encountered:\\n%s\\nWhich is not a struct.\", matchername, format.Object(actual, 1))\n\t}\n\n\tvar extractedValue reflect.Value\n\n\tif strings.HasSuffix(fields[0], \"()\") {\n\t\textractedValue = actualValue.MethodByName(strings.TrimSuffix(fields[0], \"()\"))\n\t\tif extractedValue == (reflect.Value{}) && actualValue.CanAddr() {\n\t\t\textractedValue = actualValue.Addr().MethodByName(strings.TrimSuffix(fields[0], \"()\"))\n\t\t}\n\t\tif extractedValue == (reflect.Value{}) {\n\t\t\tptr := reflect.New(actualValue.Type())\n\t\t\tptr.Elem().Set(actualValue)\n\t\t\textractedValue = ptr.MethodByName(strings.TrimSuffix(fields[0], \"()\"))\n\t\t\tif extractedValue == (reflect.Value{}) {\n\t\t\t\treturn nil, missingFieldError(fmt.Sprintf(\"%s could not find method named '%s' in struct of type %T.\", matchername, fields[0], actual))\n\t\t\t}\n\t\t}\n\t\tt := extractedValue.Type()\n\t\tif t.NumIn() != 0 || t.NumOut() != 1 {\n\t\t\treturn nil, fmt.Errorf(\"%s found an invalid method named '%s' in struct of type %T.\\nMethods must take no arguments and return exactly one value.\", matchername, fields[0], actual)\n\t\t}\n\t\textractedValue = extractedValue.Call([]reflect.Value{})[0]\n\t} else {\n\t\textractedValue = actualValue.FieldByName(fields[0])\n\t\tif extractedValue == (reflect.Value{}) {\n\t\t\treturn nil, missingFieldError(fmt.Sprintf(\"%s could not find field named '%s' in struct:\\n%s\", matchername, fields[0], format.Object(actual, 1)))\n\t\t}\n\t}\n\n\tif len(fields) == 1 {\n\t\treturn extractedValue.Interface(), nil\n\t} else {\n\t\treturn extractField(extractedValue.Interface(), fields[1], matchername)\n\t}\n}\n\ntype HaveFieldMatcher struct {\n\tField string\n\tExpected any\n}\n\nfunc (matcher *HaveFieldMatcher) expectedMatcher() omegaMatcher {\n\tvar isMatcher bool\n\texpectedMatcher, isMatcher := matcher.Expected.(omegaMatcher)\n\tif !isMatcher {\n\t\texpectedMatcher = &EqualMatcher{Expected: matcher.Expected}\n\t}\n\treturn expectedMatcher\n}\n\nfunc (matcher *HaveFieldMatcher) Match(actual any) (success bool, err error) {\n\textractedField, err := extractField(actual, matcher.Field, \"HaveField\")\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\treturn matcher.expectedMatcher().Match(extractedField)\n}\n\nfunc (matcher *HaveFieldMatcher) FailureMessage(actual any) (message string) {\n\textractedField, err := extractField(actual, matcher.Field, \"HaveField\")\n\tif err != nil {\n\t\t// this really shouldn't happen\n\t\treturn fmt.Sprintf(\"Failed to extract field '%s': %s\", matcher.Field, err)\n\t}\n\tmessage = fmt.Sprintf(\"Value for field '%s' failed to satisfy matcher.\\n\", matcher.Field)\n\tmessage += matcher.expectedMatcher().FailureMessage(extractedField)\n\n\treturn message\n}\n\nfunc (matcher *HaveFieldMatcher) NegatedFailureMessage(actual any) (message string) {\n\textractedField, err := extractField(actual, matcher.Field, \"HaveField\")\n\tif err != nil {\n\t\t// this really shouldn't happen\n\t\treturn fmt.Sprintf(\"Failed to extract field '%s': %s\", matcher.Field, err)\n\t}\n\tmessage = fmt.Sprintf(\"Value for field '%s' satisfied matcher, but should not have.\\n\", matcher.Field)\n\tmessage += matcher.expectedMatcher().NegatedFailureMessage(extractedField)\n\n\treturn message\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_http_body_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/internal/gutil\"\n\t\"github.com/onsi/gomega/types\"\n)\n\ntype HaveHTTPBodyMatcher struct {\n\tExpected any\n\tcachedResponse any\n\tcachedBody []byte\n}\n\nfunc (matcher *HaveHTTPBodyMatcher) Match(actual any) (bool, error) {\n\tbody, err := matcher.body(actual)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\tswitch e := matcher.Expected.(type) {\n\tcase string:\n\t\treturn (&EqualMatcher{Expected: e}).Match(string(body))\n\tcase []byte:\n\t\treturn (&EqualMatcher{Expected: e}).Match(body)\n\tcase types.GomegaMatcher:\n\t\treturn e.Match(body)\n\tdefault:\n\t\treturn false, fmt.Errorf(\"HaveHTTPBody matcher expects string, []byte, or GomegaMatcher. Got:\\n%s\", format.Object(matcher.Expected, 1))\n\t}\n}\n\nfunc (matcher *HaveHTTPBodyMatcher) FailureMessage(actual any) (message string) {\n\tbody, err := matcher.body(actual)\n\tif err != nil {\n\t\treturn fmt.Sprintf(\"failed to read body: %s\", err)\n\t}\n\n\tswitch e := matcher.Expected.(type) {\n\tcase string:\n\t\treturn (&EqualMatcher{Expected: e}).FailureMessage(string(body))\n\tcase []byte:\n\t\treturn (&EqualMatcher{Expected: e}).FailureMessage(body)\n\tcase types.GomegaMatcher:\n\t\treturn e.FailureMessage(body)\n\tdefault:\n\t\treturn fmt.Sprintf(\"HaveHTTPBody matcher expects string, []byte, or GomegaMatcher. Got:\\n%s\", format.Object(matcher.Expected, 1))\n\t}\n}\n\nfunc (matcher *HaveHTTPBodyMatcher) NegatedFailureMessage(actual any) (message string) {\n\tbody, err := matcher.body(actual)\n\tif err != nil {\n\t\treturn fmt.Sprintf(\"failed to read body: %s\", err)\n\t}\n\n\tswitch e := matcher.Expected.(type) {\n\tcase string:\n\t\treturn (&EqualMatcher{Expected: e}).NegatedFailureMessage(string(body))\n\tcase []byte:\n\t\treturn (&EqualMatcher{Expected: e}).NegatedFailureMessage(body)\n\tcase types.GomegaMatcher:\n\t\treturn e.NegatedFailureMessage(body)\n\tdefault:\n\t\treturn fmt.Sprintf(\"HaveHTTPBody matcher expects string, []byte, or GomegaMatcher. Got:\\n%s\", format.Object(matcher.Expected, 1))\n\t}\n}\n\n// body returns the body. It is cached because once we read it in Match()\n// the Reader is closed and it is not readable again in FailureMessage()\n// or NegatedFailureMessage()\nfunc (matcher *HaveHTTPBodyMatcher) body(actual any) ([]byte, error) {\n\tif matcher.cachedResponse == actual && matcher.cachedBody != nil {\n\t\treturn matcher.cachedBody, nil\n\t}\n\n\tbody := func(a *http.Response) ([]byte, error) {\n\t\tif a.Body != nil {\n\t\t\tdefer a.Body.Close()\n\t\t\tvar err error\n\t\t\tmatcher.cachedBody, err = gutil.ReadAll(a.Body)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, fmt.Errorf(\"error reading response body: %w\", err)\n\t\t\t}\n\t\t}\n\t\treturn matcher.cachedBody, nil\n\t}\n\n\tswitch a := actual.(type) {\n\tcase *http.Response:\n\t\tmatcher.cachedResponse = a\n\t\treturn body(a)\n\tcase *httptest.ResponseRecorder:\n\t\tmatcher.cachedResponse = a\n\t\treturn body(a.Result())\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"HaveHTTPBody matcher expects *http.Response or *httptest.ResponseRecorder. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_http_header_with_value_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/types\"\n)\n\ntype HaveHTTPHeaderWithValueMatcher struct {\n\tHeader string\n\tValue any\n}\n\nfunc (matcher *HaveHTTPHeaderWithValueMatcher) Match(actual any) (success bool, err error) {\n\theaderValue, err := matcher.extractHeader(actual)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\theaderMatcher, err := matcher.getSubMatcher()\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\treturn headerMatcher.Match(headerValue)\n}\n\nfunc (matcher *HaveHTTPHeaderWithValueMatcher) FailureMessage(actual any) string {\n\theaderValue, err := matcher.extractHeader(actual)\n\tif err != nil {\n\t\tpanic(err) // protected by Match()\n\t}\n\n\theaderMatcher, err := matcher.getSubMatcher()\n\tif err != nil {\n\t\tpanic(err) // protected by Match()\n\t}\n\n\tdiff := format.IndentString(headerMatcher.FailureMessage(headerValue), 1)\n\treturn fmt.Sprintf(\"HTTP header %q:\\n%s\", matcher.Header, diff)\n}\n\nfunc (matcher *HaveHTTPHeaderWithValueMatcher) NegatedFailureMessage(actual any) (message string) {\n\theaderValue, err := matcher.extractHeader(actual)\n\tif err != nil {\n\t\tpanic(err) // protected by Match()\n\t}\n\n\theaderMatcher, err := matcher.getSubMatcher()\n\tif err != nil {\n\t\tpanic(err) // protected by Match()\n\t}\n\n\tdiff := format.IndentString(headerMatcher.NegatedFailureMessage(headerValue), 1)\n\treturn fmt.Sprintf(\"HTTP header %q:\\n%s\", matcher.Header, diff)\n}\n\nfunc (matcher *HaveHTTPHeaderWithValueMatcher) getSubMatcher() (types.GomegaMatcher, error) {\n\tswitch m := matcher.Value.(type) {\n\tcase string:\n\t\treturn &EqualMatcher{Expected: matcher.Value}, nil\n\tcase types.GomegaMatcher:\n\t\treturn m, nil\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"HaveHTTPHeaderWithValue matcher must be passed a string or a GomegaMatcher. Got:\\n%s\", format.Object(matcher.Value, 1))\n\t}\n}\n\nfunc (matcher *HaveHTTPHeaderWithValueMatcher) extractHeader(actual any) (string, error) {\n\tswitch r := actual.(type) {\n\tcase *http.Response:\n\t\treturn r.Header.Get(matcher.Header), nil\n\tcase *httptest.ResponseRecorder:\n\t\treturn r.Result().Header.Get(matcher.Header), nil\n\tdefault:\n\t\treturn \"\", fmt.Errorf(\"HaveHTTPHeaderWithValue matcher expects *http.Response or *httptest.ResponseRecorder. Got:\\n%s\", format.Object(actual, 1))\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_http_status_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"reflect\"\n\t\"strings\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/internal/gutil\"\n)\n\ntype HaveHTTPStatusMatcher struct {\n\tExpected []any\n}\n\nfunc (matcher *HaveHTTPStatusMatcher) Match(actual any) (success bool, err error) {\n\tvar resp *http.Response\n\tswitch a := actual.(type) {\n\tcase *http.Response:\n\t\tresp = a\n\tcase *httptest.ResponseRecorder:\n\t\tresp = a.Result()\n\tdefault:\n\t\treturn false, fmt.Errorf(\"HaveHTTPStatus matcher expects *http.Response or *httptest.ResponseRecorder. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tif len(matcher.Expected) == 0 {\n\t\treturn false, fmt.Errorf(\"HaveHTTPStatus matcher must be passed an int or a string. Got nothing\")\n\t}\n\n\tfor _, expected := range matcher.Expected {\n\t\tswitch e := expected.(type) {\n\t\tcase int:\n\t\t\tif resp.StatusCode == e {\n\t\t\t\treturn true, nil\n\t\t\t}\n\t\tcase string:\n\t\t\tif resp.Status == e {\n\t\t\t\treturn true, nil\n\t\t\t}\n\t\tdefault:\n\t\t\treturn false, fmt.Errorf(\"HaveHTTPStatus matcher must be passed int or string types. Got:\\n%s\", format.Object(expected, 1))\n\t\t}\n\t}\n\n\treturn false, nil\n}\n\nfunc (matcher *HaveHTTPStatusMatcher) FailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected\\n%s\\n%s\\n%s\", formatHttpResponse(actual), \"to have HTTP status\", matcher.expectedString())\n}\n\nfunc (matcher *HaveHTTPStatusMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected\\n%s\\n%s\\n%s\", formatHttpResponse(actual), \"not to have HTTP status\", matcher.expectedString())\n}\n\nfunc (matcher *HaveHTTPStatusMatcher) expectedString() string {\n\tvar lines []string\n\tfor _, expected := range matcher.Expected {\n\t\tlines = append(lines, format.Object(expected, 1))\n\t}\n\treturn strings.Join(lines, \"\\n\")\n}\n\nfunc formatHttpResponse(input any) string {\n\tvar resp *http.Response\n\tswitch r := input.(type) {\n\tcase *http.Response:\n\t\tresp = r\n\tcase *httptest.ResponseRecorder:\n\t\tresp = r.Result()\n\tdefault:\n\t\treturn \"cannot format invalid HTTP response\"\n\t}\n\n\tbody := \"\"\n\tif resp.Body != nil {\n\t\tdefer resp.Body.Close()\n\t\tdata, err := gutil.ReadAll(resp.Body)\n\t\tif err != nil {\n\t\t\tdata = []byte(\"\")\n\t\t}\n\t\tbody = format.Object(string(data), 0)\n\t}\n\n\tvar s strings.Builder\n\ts.WriteString(fmt.Sprintf(\"%s<%s>: {\\n\", format.Indent, reflect.TypeOf(input)))\n\ts.WriteString(fmt.Sprintf(\"%s%sStatus: %s\\n\", format.Indent, format.Indent, format.Object(resp.Status, 0)))\n\ts.WriteString(fmt.Sprintf(\"%s%sStatusCode: %s\\n\", format.Indent, format.Indent, format.Object(resp.StatusCode, 0)))\n\ts.WriteString(fmt.Sprintf(\"%s%sBody: %s\\n\", format.Indent, format.Indent, body))\n\ts.WriteString(fmt.Sprintf(\"%s}\", format.Indent))\n\n\treturn s.String()\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_key_matcher.go",
"content": "// untested sections: 6\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n)\n\ntype HaveKeyMatcher struct {\n\tKey any\n}\n\nfunc (matcher *HaveKeyMatcher) Match(actual any) (success bool, err error) {\n\tif !isMap(actual) && !miter.IsSeq2(actual) {\n\t\treturn false, fmt.Errorf(\"HaveKey matcher expects a map/iter.Seq2. Got:%s\", format.Object(actual, 1))\n\t}\n\n\tkeyMatcher, keyIsMatcher := matcher.Key.(omegaMatcher)\n\tif !keyIsMatcher {\n\t\tkeyMatcher = &EqualMatcher{Expected: matcher.Key}\n\t}\n\n\tif miter.IsSeq2(actual) {\n\t\tvar success bool\n\t\tvar err error\n\t\tmiter.IterateKV(actual, func(k, v reflect.Value) bool {\n\t\t\tsuccess, err = keyMatcher.Match(k.Interface())\n\t\t\tif err != nil {\n\t\t\t\terr = fmt.Errorf(\"HaveKey's key matcher failed with:\\n%s%s\", format.Indent, err.Error())\n\t\t\t\treturn false\n\t\t\t}\n\t\t\treturn !success\n\t\t})\n\t\treturn success, err\n\t}\n\n\tkeys := reflect.ValueOf(actual).MapKeys()\n\tfor i := range keys {\n\t\tsuccess, err := keyMatcher.Match(keys[i].Interface())\n\t\tif err != nil {\n\t\t\treturn false, fmt.Errorf(\"HaveKey's key matcher failed with:\\n%s%s\", format.Indent, err.Error())\n\t\t}\n\t\tif success {\n\t\t\treturn true, nil\n\t\t}\n\t}\n\n\treturn false, nil\n}\n\nfunc (matcher *HaveKeyMatcher) FailureMessage(actual any) (message string) {\n\tswitch matcher.Key.(type) {\n\tcase omegaMatcher:\n\t\treturn format.Message(actual, \"to have key matching\", matcher.Key)\n\tdefault:\n\t\treturn format.Message(actual, \"to have key\", matcher.Key)\n\t}\n}\n\nfunc (matcher *HaveKeyMatcher) NegatedFailureMessage(actual any) (message string) {\n\tswitch matcher.Key.(type) {\n\tcase omegaMatcher:\n\t\treturn format.Message(actual, \"not to have key matching\", matcher.Key)\n\tdefault:\n\t\treturn format.Message(actual, \"not to have key\", matcher.Key)\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_key_with_value_matcher.go",
"content": "// untested sections:10\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n)\n\ntype HaveKeyWithValueMatcher struct {\n\tKey any\n\tValue any\n}\n\nfunc (matcher *HaveKeyWithValueMatcher) Match(actual any) (success bool, err error) {\n\tif !isMap(actual) && !miter.IsSeq2(actual) {\n\t\treturn false, fmt.Errorf(\"HaveKeyWithValue matcher expects a map/iter.Seq2. Got:%s\", format.Object(actual, 1))\n\t}\n\n\tkeyMatcher, keyIsMatcher := matcher.Key.(omegaMatcher)\n\tif !keyIsMatcher {\n\t\tkeyMatcher = &EqualMatcher{Expected: matcher.Key}\n\t}\n\n\tvalueMatcher, valueIsMatcher := matcher.Value.(omegaMatcher)\n\tif !valueIsMatcher {\n\t\tvalueMatcher = &EqualMatcher{Expected: matcher.Value}\n\t}\n\n\tif miter.IsSeq2(actual) {\n\t\tvar success bool\n\t\tvar err error\n\t\tmiter.IterateKV(actual, func(k, v reflect.Value) bool {\n\t\t\tsuccess, err = keyMatcher.Match(k.Interface())\n\t\t\tif err != nil {\n\t\t\t\terr = fmt.Errorf(\"HaveKey's key matcher failed with:\\n%s%s\", format.Indent, err.Error())\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif success {\n\t\t\t\tsuccess, err = valueMatcher.Match(v.Interface())\n\t\t\t\tif err != nil {\n\t\t\t\t\terr = fmt.Errorf(\"HaveKeyWithValue's value matcher failed with:\\n%s%s\", format.Indent, err.Error())\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn !success\n\t\t})\n\t\treturn success, err\n\t}\n\n\tkeys := reflect.ValueOf(actual).MapKeys()\n\tfor i := range keys {\n\t\tsuccess, err := keyMatcher.Match(keys[i].Interface())\n\t\tif err != nil {\n\t\t\treturn false, fmt.Errorf(\"HaveKeyWithValue's key matcher failed with:\\n%s%s\", format.Indent, err.Error())\n\t\t}\n\t\tif success {\n\t\t\tactualValue := reflect.ValueOf(actual).MapIndex(keys[i])\n\t\t\tsuccess, err := valueMatcher.Match(actualValue.Interface())\n\t\t\tif err != nil {\n\t\t\t\treturn false, fmt.Errorf(\"HaveKeyWithValue's value matcher failed with:\\n%s%s\", format.Indent, err.Error())\n\t\t\t}\n\t\t\treturn success, nil\n\t\t}\n\t}\n\n\treturn false, nil\n}\n\nfunc (matcher *HaveKeyWithValueMatcher) FailureMessage(actual any) (message string) {\n\tstr := \"to have {key: value}\"\n\tif _, ok := matcher.Key.(omegaMatcher); ok {\n\t\tstr += \" matching\"\n\t} else if _, ok := matcher.Value.(omegaMatcher); ok {\n\t\tstr += \" matching\"\n\t}\n\n\texpect := make(map[any]any, 1)\n\texpect[matcher.Key] = matcher.Value\n\treturn format.Message(actual, str, expect)\n}\n\nfunc (matcher *HaveKeyWithValueMatcher) NegatedFailureMessage(actual any) (message string) {\n\tkStr := \"not to have key\"\n\tif _, ok := matcher.Key.(omegaMatcher); ok {\n\t\tkStr = \"not to have key matching\"\n\t}\n\n\tvStr := \"or that key's value not be\"\n\tif _, ok := matcher.Value.(omegaMatcher); ok {\n\t\tvStr = \"or to have that key's value not matching\"\n\t}\n\n\treturn format.Message(actual, kStr, matcher.Key, vStr, matcher.Value)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_len_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype HaveLenMatcher struct {\n\tCount int\n}\n\nfunc (matcher *HaveLenMatcher) Match(actual any) (success bool, err error) {\n\tlength, ok := lengthOf(actual)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"HaveLen matcher expects a string/array/map/channel/slice/iterator. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\treturn length == matcher.Count, nil\n}\n\nfunc (matcher *HaveLenMatcher) FailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected\\n%s\\nto have length %d\", format.Object(actual, 1), matcher.Count)\n}\n\nfunc (matcher *HaveLenMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected\\n%s\\nnot to have length %d\", format.Object(actual, 1), matcher.Count)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_occurred_matcher.go",
"content": "// untested sections: 2\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype HaveOccurredMatcher struct {\n}\n\nfunc (matcher *HaveOccurredMatcher) Match(actual any) (success bool, err error) {\n\t// is purely nil?\n\tif actual == nil {\n\t\treturn false, nil\n\t}\n\n\t// must be an 'error' type\n\tif !isError(actual) {\n\t\treturn false, fmt.Errorf(\"Expected an error-type. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\t// must be non-nil (or a pointer to a non-nil)\n\treturn !isNil(actual), nil\n}\n\nfunc (matcher *HaveOccurredMatcher) FailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Expected an error to have occurred. Got:\\n%s\", format.Object(actual, 1))\n}\n\nfunc (matcher *HaveOccurredMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn fmt.Sprintf(\"Unexpected error:\\n%s\\n%s\", format.Object(actual, 1), \"occurred\")\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_prefix_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype HavePrefixMatcher struct {\n\tPrefix string\n\tArgs []any\n}\n\nfunc (matcher *HavePrefixMatcher) Match(actual any) (success bool, err error) {\n\tactualString, ok := toString(actual)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"HavePrefix matcher requires a string or stringer. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\tprefix := matcher.prefix()\n\treturn len(actualString) >= len(prefix) && actualString[0:len(prefix)] == prefix, nil\n}\n\nfunc (matcher *HavePrefixMatcher) prefix() string {\n\tif len(matcher.Args) > 0 {\n\t\treturn fmt.Sprintf(matcher.Prefix, matcher.Args...)\n\t}\n\treturn matcher.Prefix\n}\n\nfunc (matcher *HavePrefixMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to have prefix\", matcher.prefix())\n}\n\nfunc (matcher *HavePrefixMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to have prefix\", matcher.prefix())\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_suffix_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype HaveSuffixMatcher struct {\n\tSuffix string\n\tArgs []any\n}\n\nfunc (matcher *HaveSuffixMatcher) Match(actual any) (success bool, err error) {\n\tactualString, ok := toString(actual)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"HaveSuffix matcher requires a string or stringer. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\tsuffix := matcher.suffix()\n\treturn len(actualString) >= len(suffix) && actualString[len(actualString)-len(suffix):] == suffix, nil\n}\n\nfunc (matcher *HaveSuffixMatcher) suffix() string {\n\tif len(matcher.Args) > 0 {\n\t\treturn fmt.Sprintf(matcher.Suffix, matcher.Args...)\n\t}\n\treturn matcher.Suffix\n}\n\nfunc (matcher *HaveSuffixMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to have suffix\", matcher.suffix())\n}\n\nfunc (matcher *HaveSuffixMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to have suffix\", matcher.suffix())\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/have_value.go",
"content": "package matchers\n\nimport (\n\t\"errors\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/types\"\n)\n\nconst maxIndirections = 31\n\ntype HaveValueMatcher struct {\n\tMatcher types.GomegaMatcher // the matcher to apply to the \"resolved\" actual value.\n\tresolvedActual any // the (\"resolved\") value.\n}\n\nfunc (m *HaveValueMatcher) Match(actual any) (bool, error) {\n\tval := reflect.ValueOf(actual)\n\tfor allowedIndirs := maxIndirections; allowedIndirs > 0; allowedIndirs-- {\n\t\t// return an error if value isn't valid. Please note that we cannot\n\t\t// check for nil here, as we might not deal with a pointer or interface\n\t\t// at this point.\n\t\tif !val.IsValid() {\n\t\t\treturn false, errors.New(format.Message(\n\t\t\t\tactual, \"not to be \"))\n\t\t}\n\t\tswitch val.Kind() {\n\t\tcase reflect.Ptr, reflect.Interface:\n\t\t\t// resolve pointers and interfaces to their values, then rinse and\n\t\t\t// repeat.\n\t\t\tif val.IsNil() {\n\t\t\t\treturn false, errors.New(format.Message(\n\t\t\t\t\tactual, \"not to be \"))\n\t\t\t}\n\t\t\tval = val.Elem()\n\t\t\tcontinue\n\t\tdefault:\n\t\t\t// forward the final value to the specified matcher.\n\t\t\tm.resolvedActual = val.Interface()\n\t\t\treturn m.Matcher.Match(m.resolvedActual)\n\t\t}\n\t}\n\t// too many indirections: extreme star gazing, indeed...?\n\treturn false, errors.New(format.Message(actual, \"too many indirections\"))\n}\n\nfunc (m *HaveValueMatcher) FailureMessage(_ any) (message string) {\n\treturn m.Matcher.FailureMessage(m.resolvedActual)\n}\n\nfunc (m *HaveValueMatcher) NegatedFailureMessage(_ any) (message string) {\n\treturn m.Matcher.NegatedFailureMessage(m.resolvedActual)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/internal/miter/type_support_iter.go",
"content": "//go:build go1.23\n\npackage miter\n\nimport (\n\t\"reflect\"\n)\n\n// HasIterators always returns false for Go versions before 1.23.\nfunc HasIterators() bool { return true }\n\n// IsIter returns true if the specified value is a function type that can be\n// range-d over, otherwise false.\n//\n// We don't use reflect's CanSeq and CanSeq2 directly, as these would return\n// true also for other value types that are range-able, such as integers,\n// slices, et cetera. Here, we aim only at range-able (iterator) functions.\nfunc IsIter(it any) bool {\n\tif it == nil { // on purpose we only test for untyped nil.\n\t\treturn false\n\t}\n\t// reject all non-iterator-func values, even if they're range-able.\n\tt := reflect.TypeOf(it)\n\tif t.Kind() != reflect.Func {\n\t\treturn false\n\t}\n\treturn t.CanSeq() || t.CanSeq2()\n}\n\n// IterKVTypes returns the reflection types of an iterator's yield function's K\n// and optional V arguments, otherwise nil K and V reflection types.\nfunc IterKVTypes(it any) (k, v reflect.Type) {\n\tif it == nil {\n\t\treturn\n\t}\n\t// reject all non-iterator-func values, even if they're range-able.\n\tt := reflect.TypeOf(it)\n\tif t.Kind() != reflect.Func {\n\t\treturn\n\t}\n\t// get the reflection types for V, and where applicable, K.\n\tswitch {\n\tcase t.CanSeq():\n\t\tv = t. /*iterator fn*/ In(0). /*yield fn*/ In(0)\n\tcase t.CanSeq2():\n\t\tyieldfn := t. /*iterator fn*/ In(0)\n\t\tk = yieldfn.In(0)\n\t\tv = yieldfn.In(1)\n\t}\n\treturn\n}\n\n// IsSeq2 returns true if the passed iterator function is compatible with\n// iter.Seq2, otherwise false.\n//\n// IsSeq2 hides the Go 1.23+ specific reflect.Type.CanSeq2 behind a facade which\n// is empty for Go versions before 1.23.\nfunc IsSeq2(it any) bool {\n\tif it == nil {\n\t\treturn false\n\t}\n\tt := reflect.TypeOf(it)\n\treturn t.Kind() == reflect.Func && t.CanSeq2()\n}\n\n// isNilly returns true if v is either an untyped nil, or is a nil function (not\n// necessarily an iterator function).\nfunc isNilly(v any) bool {\n\tif v == nil {\n\t\treturn true\n\t}\n\trv := reflect.ValueOf(v)\n\treturn rv.Kind() == reflect.Func && rv.IsNil()\n}\n\n// IterateV loops over the elements produced by an iterator function, passing\n// the elements to the specified yield function individually and stopping only\n// when either the iterator function runs out of elements or the yield function\n// tell us to stop it.\n//\n// IterateV works very much like reflect.Value.Seq but hides the Go 1.23+\n// specific parts behind a facade which is empty for Go versions before 1.23, in\n// order to simplify code maintenance for matchers when using older Go versions.\nfunc IterateV(it any, yield func(v reflect.Value) bool) {\n\tif isNilly(it) {\n\t\treturn\n\t}\n\t// reject all non-iterator-func values, even if they're range-able.\n\tt := reflect.TypeOf(it)\n\tif t.Kind() != reflect.Func || !t.CanSeq() {\n\t\treturn\n\t}\n\t// Call the specified iterator function, handing it our adaptor to call the\n\t// specified generic reflection yield function.\n\treflectedYield := reflect.MakeFunc(\n\t\tt. /*iterator fn*/ In(0),\n\t\tfunc(args []reflect.Value) []reflect.Value {\n\t\t\treturn []reflect.Value{reflect.ValueOf(yield(args[0]))}\n\t\t})\n\treflect.ValueOf(it).Call([]reflect.Value{reflectedYield})\n}\n\n// IterateKV loops over the key-value elements produced by an iterator function,\n// passing the elements to the specified yield function individually and\n// stopping only when either the iterator function runs out of elements or the\n// yield function tell us to stop it.\n//\n// IterateKV works very much like reflect.Value.Seq2 but hides the Go 1.23+\n// specific parts behind a facade which is empty for Go versions before 1.23, in\n// order to simplify code maintenance for matchers when using older Go versions.\nfunc IterateKV(it any, yield func(k, v reflect.Value) bool) {\n\tif isNilly(it) {\n\t\treturn\n\t}\n\t// reject all non-iterator-func values, even if they're range-able.\n\tt := reflect.TypeOf(it)\n\tif t.Kind() != reflect.Func || !t.CanSeq2() {\n\t\treturn\n\t}\n\t// Call the specified iterator function, handing it our adaptor to call the\n\t// specified generic reflection yield function.\n\treflectedYield := reflect.MakeFunc(\n\t\tt. /*iterator fn*/ In(0),\n\t\tfunc(args []reflect.Value) []reflect.Value {\n\t\t\treturn []reflect.Value{reflect.ValueOf(yield(args[0], args[1]))}\n\t\t})\n\treflect.ValueOf(it).Call([]reflect.Value{reflectedYield})\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/internal/miter/type_support_noiter.go",
"content": "//go:build !go1.23\n\n/*\nGomega matchers\n\nThis package implements the Gomega matchers and does not typically need to be imported.\nSee the docs for Gomega for documentation on the matchers\n\nhttp://onsi.github.io/gomega/\n*/\n\npackage miter\n\nimport \"reflect\"\n\n// HasIterators always returns false for Go versions before 1.23.\nfunc HasIterators() bool { return false }\n\n// IsIter always returns false for Go versions before 1.23 as there is no\n// iterator (function) pattern defined yet; see also:\n// https://tip.golang.org/blog/range-functions.\nfunc IsIter(i any) bool { return false }\n\n// IsSeq2 always returns false for Go versions before 1.23 as there is no\n// iterator (function) pattern defined yet; see also:\n// https://tip.golang.org/blog/range-functions.\nfunc IsSeq2(it any) bool { return false }\n\n// IterKVTypes always returns nil reflection types for Go versions before 1.23\n// as there is no iterator (function) pattern defined yet; see also:\n// https://tip.golang.org/blog/range-functions.\nfunc IterKVTypes(i any) (k, v reflect.Type) {\n\treturn\n}\n\n// IterateV never loops over what has been passed to it as an iterator for Go\n// versions before 1.23 as there is no iterator (function) pattern defined yet;\n// see also: https://tip.golang.org/blog/range-functions.\nfunc IterateV(it any, yield func(v reflect.Value) bool) {}\n\n// IterateKV never loops over what has been passed to it as an iterator for Go\n// versions before 1.23 as there is no iterator (function) pattern defined yet;\n// see also: https://tip.golang.org/blog/range-functions.\nfunc IterateKV(it any, yield func(k, v reflect.Value) bool) {}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/match_error_matcher.go",
"content": "package matchers\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype MatchErrorMatcher struct {\n\tExpected any\n\tFuncErrDescription []any\n\tisFunc bool\n}\n\nfunc (matcher *MatchErrorMatcher) Match(actual any) (success bool, err error) {\n\tmatcher.isFunc = false\n\n\tif isNil(actual) {\n\t\treturn false, fmt.Errorf(\"Expected an error, got nil\")\n\t}\n\n\tif !isError(actual) {\n\t\treturn false, fmt.Errorf(\"Expected an error. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tactualErr := actual.(error)\n\texpected := matcher.Expected\n\n\tif isError(expected) {\n\t\t// first try the built-in errors.Is\n\t\tif errors.Is(actualErr, expected.(error)) {\n\t\t\treturn true, nil\n\t\t}\n\t\t// if not, try DeepEqual along the error chain\n\t\tfor unwrapped := actualErr; unwrapped != nil; unwrapped = errors.Unwrap(unwrapped) {\n\t\t\tif reflect.DeepEqual(unwrapped, expected) {\n\t\t\t\treturn true, nil\n\t\t\t}\n\t\t}\n\t\treturn false, nil\n\t}\n\n\tif isString(expected) {\n\t\treturn actualErr.Error() == expected, nil\n\t}\n\n\tv := reflect.ValueOf(expected)\n\tt := v.Type()\n\terrorInterface := reflect.TypeOf((*error)(nil)).Elem()\n\tif t.Kind() == reflect.Func && t.NumIn() == 1 && t.In(0).Implements(errorInterface) && t.NumOut() == 1 && t.Out(0).Kind() == reflect.Bool {\n\t\tif len(matcher.FuncErrDescription) == 0 {\n\t\t\treturn false, fmt.Errorf(\"MatchError requires an additional description when passed a function\")\n\t\t}\n\t\tmatcher.isFunc = true\n\t\treturn v.Call([]reflect.Value{reflect.ValueOf(actualErr)})[0].Bool(), nil\n\t}\n\n\tvar subMatcher omegaMatcher\n\tvar hasSubMatcher bool\n\tif expected != nil {\n\t\tsubMatcher, hasSubMatcher = (expected).(omegaMatcher)\n\t\tif hasSubMatcher {\n\t\t\treturn subMatcher.Match(actualErr.Error())\n\t\t}\n\t}\n\n\treturn false, fmt.Errorf(\n\t\t\"MatchError must be passed an error, a string, or a Matcher that can match on strings. Got:\\n%s\",\n\t\tformat.Object(expected, 1))\n}\n\nfunc (matcher *MatchErrorMatcher) FailureMessage(actual any) (message string) {\n\tif matcher.isFunc {\n\t\treturn format.Message(actual, fmt.Sprintf(\"to match error function %s\", matcher.FuncErrDescription[0]))\n\t}\n\treturn format.Message(actual, \"to match error\", matcher.Expected)\n}\n\nfunc (matcher *MatchErrorMatcher) NegatedFailureMessage(actual any) (message string) {\n\tif matcher.isFunc {\n\t\treturn format.Message(actual, fmt.Sprintf(\"not to match error function %s\", matcher.FuncErrDescription[0]))\n\t}\n\treturn format.Message(actual, \"not to match error\", matcher.Expected)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/match_error_strictly_matcher.go",
"content": "package matchers\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype MatchErrorStrictlyMatcher struct {\n\tExpected error\n}\n\nfunc (matcher *MatchErrorStrictlyMatcher) Match(actual any) (success bool, err error) {\n\n\tif isNil(matcher.Expected) {\n\t\treturn false, fmt.Errorf(\"Expected error is nil, use \\\"ToNot(HaveOccurred())\\\" to explicitly check for nil errors\")\n\t}\n\n\tif isNil(actual) {\n\t\treturn false, fmt.Errorf(\"Expected an error, got nil\")\n\t}\n\n\tif !isError(actual) {\n\t\treturn false, fmt.Errorf(\"Expected an error. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tactualErr := actual.(error)\n\n\treturn errors.Is(actualErr, matcher.Expected), nil\n}\n\nfunc (matcher *MatchErrorStrictlyMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to match error\", matcher.Expected)\n}\n\nfunc (matcher *MatchErrorStrictlyMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to match error\", matcher.Expected)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/match_json_matcher.go",
"content": "package matchers\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype MatchJSONMatcher struct {\n\tJSONToMatch any\n\tfirstFailurePath []any\n}\n\nfunc (matcher *MatchJSONMatcher) Match(actual any) (success bool, err error) {\n\tactualString, expectedString, err := matcher.prettyPrint(actual)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\tvar aval any\n\tvar eval any\n\n\t// this is guarded by prettyPrint\n\tjson.Unmarshal([]byte(actualString), &aval)\n\tjson.Unmarshal([]byte(expectedString), &eval)\n\tvar equal bool\n\tequal, matcher.firstFailurePath = deepEqual(aval, eval)\n\treturn equal, nil\n}\n\nfunc (matcher *MatchJSONMatcher) FailureMessage(actual any) (message string) {\n\tactualString, expectedString, _ := matcher.prettyPrint(actual)\n\treturn formattedMessage(format.Message(actualString, \"to match JSON of\", expectedString), matcher.firstFailurePath)\n}\n\nfunc (matcher *MatchJSONMatcher) NegatedFailureMessage(actual any) (message string) {\n\tactualString, expectedString, _ := matcher.prettyPrint(actual)\n\treturn formattedMessage(format.Message(actualString, \"not to match JSON of\", expectedString), matcher.firstFailurePath)\n}\n\nfunc (matcher *MatchJSONMatcher) prettyPrint(actual any) (actualFormatted, expectedFormatted string, err error) {\n\tactualString, ok := toString(actual)\n\tif !ok {\n\t\treturn \"\", \"\", fmt.Errorf(\"MatchJSONMatcher matcher requires a string, stringer, or []byte. Got actual:\\n%s\", format.Object(actual, 1))\n\t}\n\texpectedString, ok := toString(matcher.JSONToMatch)\n\tif !ok {\n\t\treturn \"\", \"\", fmt.Errorf(\"MatchJSONMatcher matcher requires a string, stringer, or []byte. Got expected:\\n%s\", format.Object(matcher.JSONToMatch, 1))\n\t}\n\n\tabuf := new(bytes.Buffer)\n\tebuf := new(bytes.Buffer)\n\n\tif err := json.Indent(abuf, []byte(actualString), \"\", \" \"); err != nil {\n\t\treturn \"\", \"\", fmt.Errorf(\"Actual '%s' should be valid JSON, but it is not.\\nUnderlying error:%s\", actualString, err)\n\t}\n\n\tif err := json.Indent(ebuf, []byte(expectedString), \"\", \" \"); err != nil {\n\t\treturn \"\", \"\", fmt.Errorf(\"Expected '%s' should be valid JSON, but it is not.\\nUnderlying error:%s\", expectedString, err)\n\t}\n\n\treturn abuf.String(), ebuf.String(), nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/match_regexp_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"regexp\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype MatchRegexpMatcher struct {\n\tRegexp string\n\tArgs []any\n}\n\nfunc (matcher *MatchRegexpMatcher) Match(actual any) (success bool, err error) {\n\tactualString, ok := toString(actual)\n\tif !ok {\n\t\treturn false, fmt.Errorf(\"RegExp matcher requires a string or stringer.\\nGot:%s\", format.Object(actual, 1))\n\t}\n\n\tmatch, err := regexp.Match(matcher.regexp(), []byte(actualString))\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"RegExp match failed to compile with error:\\n\\t%s\", err.Error())\n\t}\n\n\treturn match, nil\n}\n\nfunc (matcher *MatchRegexpMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to match regular expression\", matcher.regexp())\n}\n\nfunc (matcher *MatchRegexpMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"not to match regular expression\", matcher.regexp())\n}\n\nfunc (matcher *MatchRegexpMatcher) regexp() string {\n\tre := matcher.Regexp\n\tif len(matcher.Args) > 0 {\n\t\tre = fmt.Sprintf(matcher.Regexp, matcher.Args...)\n\t}\n\treturn re\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/match_xml_matcher.go",
"content": "package matchers\n\nimport (\n\t\"bytes\"\n\t\"encoding/xml\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"reflect\"\n\t\"sort\"\n\t\"strings\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"golang.org/x/net/html/charset\"\n)\n\ntype MatchXMLMatcher struct {\n\tXMLToMatch any\n}\n\nfunc (matcher *MatchXMLMatcher) Match(actual any) (success bool, err error) {\n\tactualString, expectedString, err := matcher.formattedPrint(actual)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\taval, err := parseXmlContent(actualString)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"Actual '%s' should be valid XML, but it is not.\\nUnderlying error:%s\", actualString, err)\n\t}\n\n\teval, err := parseXmlContent(expectedString)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"Expected '%s' should be valid XML, but it is not.\\nUnderlying error:%s\", expectedString, err)\n\t}\n\n\treturn reflect.DeepEqual(aval, eval), nil\n}\n\nfunc (matcher *MatchXMLMatcher) FailureMessage(actual any) (message string) {\n\tactualString, expectedString, _ := matcher.formattedPrint(actual)\n\treturn fmt.Sprintf(\"Expected\\n%s\\nto match XML of\\n%s\", actualString, expectedString)\n}\n\nfunc (matcher *MatchXMLMatcher) NegatedFailureMessage(actual any) (message string) {\n\tactualString, expectedString, _ := matcher.formattedPrint(actual)\n\treturn fmt.Sprintf(\"Expected\\n%s\\nnot to match XML of\\n%s\", actualString, expectedString)\n}\n\nfunc (matcher *MatchXMLMatcher) formattedPrint(actual any) (actualString, expectedString string, err error) {\n\tvar ok bool\n\tactualString, ok = toString(actual)\n\tif !ok {\n\t\treturn \"\", \"\", fmt.Errorf(\"MatchXMLMatcher matcher requires a string, stringer, or []byte. Got actual:\\n%s\", format.Object(actual, 1))\n\t}\n\texpectedString, ok = toString(matcher.XMLToMatch)\n\tif !ok {\n\t\treturn \"\", \"\", fmt.Errorf(\"MatchXMLMatcher matcher requires a string, stringer, or []byte. Got expected:\\n%s\", format.Object(matcher.XMLToMatch, 1))\n\t}\n\treturn actualString, expectedString, nil\n}\n\nfunc parseXmlContent(content string) (*xmlNode, error) {\n\tallNodes := []*xmlNode{}\n\n\tdec := newXmlDecoder(strings.NewReader(content))\n\tfor {\n\t\ttok, err := dec.Token()\n\t\tif err != nil {\n\t\t\tif err == io.EOF {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\treturn nil, fmt.Errorf(\"failed to decode next token: %v\", err) // untested section\n\t\t}\n\n\t\tlastNodeIndex := len(allNodes) - 1\n\t\tvar lastNode *xmlNode\n\t\tif len(allNodes) > 0 {\n\t\t\tlastNode = allNodes[lastNodeIndex]\n\t\t} else {\n\t\t\tlastNode = &xmlNode{}\n\t\t}\n\n\t\tswitch tok := tok.(type) {\n\t\tcase xml.StartElement:\n\t\t\tattrs := attributesSlice(tok.Attr)\n\t\t\tsort.Sort(attrs)\n\t\t\tallNodes = append(allNodes, &xmlNode{XMLName: tok.Name, XMLAttr: tok.Attr})\n\t\tcase xml.EndElement:\n\t\t\tif len(allNodes) > 1 {\n\t\t\t\tallNodes[lastNodeIndex-1].Nodes = append(allNodes[lastNodeIndex-1].Nodes, lastNode)\n\t\t\t\tallNodes = allNodes[:lastNodeIndex]\n\t\t\t}\n\t\tcase xml.CharData:\n\t\t\tlastNode.Content = append(lastNode.Content, tok.Copy()...)\n\t\tcase xml.Comment:\n\t\t\tlastNode.Comments = append(lastNode.Comments, tok.Copy()) // untested section\n\t\tcase xml.ProcInst:\n\t\t\tlastNode.ProcInsts = append(lastNode.ProcInsts, tok.Copy())\n\t\t}\n\t}\n\n\tif len(allNodes) == 0 {\n\t\treturn nil, errors.New(\"found no nodes\")\n\t}\n\tfirstNode := allNodes[0]\n\ttrimParentNodesContentSpaces(firstNode)\n\n\treturn firstNode, nil\n}\n\nfunc newXmlDecoder(reader io.Reader) *xml.Decoder {\n\tdec := xml.NewDecoder(reader)\n\tdec.CharsetReader = charset.NewReaderLabel\n\treturn dec\n}\n\nfunc trimParentNodesContentSpaces(node *xmlNode) {\n\tif len(node.Nodes) > 0 {\n\t\tnode.Content = bytes.TrimSpace(node.Content)\n\t\tfor _, childNode := range node.Nodes {\n\t\t\ttrimParentNodesContentSpaces(childNode)\n\t\t}\n\t}\n}\n\ntype xmlNode struct {\n\tXMLName xml.Name\n\tComments []xml.Comment\n\tProcInsts []xml.ProcInst\n\tXMLAttr []xml.Attr\n\tContent []byte\n\tNodes []*xmlNode\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/match_yaml_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"go.yaml.in/yaml/v3\"\n)\n\ntype MatchYAMLMatcher struct {\n\tYAMLToMatch any\n\tfirstFailurePath []any\n}\n\nfunc (matcher *MatchYAMLMatcher) Match(actual any) (success bool, err error) {\n\tactualString, expectedString, err := matcher.toStrings(actual)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\tvar aval any\n\tvar eval any\n\n\tif err := yaml.Unmarshal([]byte(actualString), &aval); err != nil {\n\t\treturn false, fmt.Errorf(\"Actual '%s' should be valid YAML, but it is not.\\nUnderlying error:%s\", actualString, err)\n\t}\n\tif err := yaml.Unmarshal([]byte(expectedString), &eval); err != nil {\n\t\treturn false, fmt.Errorf(\"Expected '%s' should be valid YAML, but it is not.\\nUnderlying error:%s\", expectedString, err)\n\t}\n\n\tvar equal bool\n\tequal, matcher.firstFailurePath = deepEqual(aval, eval)\n\treturn equal, nil\n}\n\nfunc (matcher *MatchYAMLMatcher) FailureMessage(actual any) (message string) {\n\tactualString, expectedString, _ := matcher.toNormalisedStrings(actual)\n\treturn formattedMessage(format.Message(actualString, \"to match YAML of\", expectedString), matcher.firstFailurePath)\n}\n\nfunc (matcher *MatchYAMLMatcher) NegatedFailureMessage(actual any) (message string) {\n\tactualString, expectedString, _ := matcher.toNormalisedStrings(actual)\n\treturn formattedMessage(format.Message(actualString, \"not to match YAML of\", expectedString), matcher.firstFailurePath)\n}\n\nfunc (matcher *MatchYAMLMatcher) toNormalisedStrings(actual any) (actualFormatted, expectedFormatted string, err error) {\n\tactualString, expectedString, err := matcher.toStrings(actual)\n\treturn normalise(actualString), normalise(expectedString), err\n}\n\nfunc normalise(input string) string {\n\tvar val any\n\terr := yaml.Unmarshal([]byte(input), &val)\n\tif err != nil {\n\t\tpanic(err) // unreachable since Match already calls Unmarshal\n\t}\n\toutput, err := yaml.Marshal(val)\n\tif err != nil {\n\t\tpanic(err) // untested section, unreachable since we Unmarshal above\n\t}\n\treturn strings.TrimSpace(string(output))\n}\n\nfunc (matcher *MatchYAMLMatcher) toStrings(actual any) (actualFormatted, expectedFormatted string, err error) {\n\tactualString, ok := toString(actual)\n\tif !ok {\n\t\treturn \"\", \"\", fmt.Errorf(\"MatchYAMLMatcher matcher requires a string, stringer, or []byte. Got actual:\\n%s\", format.Object(actual, 1))\n\t}\n\texpectedString, ok := toString(matcher.YAMLToMatch)\n\tif !ok {\n\t\treturn \"\", \"\", fmt.Errorf(\"MatchYAMLMatcher matcher requires a string, stringer, or []byte. Got expected:\\n%s\", format.Object(matcher.YAMLToMatch, 1))\n\t}\n\n\treturn actualString, expectedString, nil\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/not.go",
"content": "package matchers\n\nimport (\n\t\"github.com/onsi/gomega/types\"\n)\n\ntype NotMatcher struct {\n\tMatcher types.GomegaMatcher\n}\n\nfunc (m *NotMatcher) Match(actual any) (bool, error) {\n\tsuccess, err := m.Matcher.Match(actual)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\treturn !success, nil\n}\n\nfunc (m *NotMatcher) FailureMessage(actual any) (message string) {\n\treturn m.Matcher.NegatedFailureMessage(actual) // works beautifully\n}\n\nfunc (m *NotMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn m.Matcher.FailureMessage(actual) // works beautifully\n}\n\nfunc (m *NotMatcher) MatchMayChangeInTheFuture(actual any) bool {\n\treturn types.MatchMayChangeInTheFuture(m.Matcher, actual) // just return m.Matcher's value\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/or.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n\t\"github.com/onsi/gomega/types\"\n)\n\ntype OrMatcher struct {\n\tMatchers []types.GomegaMatcher\n\n\t// state\n\tfirstSuccessfulMatcher types.GomegaMatcher\n}\n\nfunc (m *OrMatcher) Match(actual any) (success bool, err error) {\n\tm.firstSuccessfulMatcher = nil\n\tfor _, matcher := range m.Matchers {\n\t\tsuccess, err := matcher.Match(actual)\n\t\tif err != nil {\n\t\t\treturn false, err\n\t\t}\n\t\tif success {\n\t\t\tm.firstSuccessfulMatcher = matcher\n\t\t\treturn true, nil\n\t\t}\n\t}\n\treturn false, nil\n}\n\nfunc (m *OrMatcher) FailureMessage(actual any) (message string) {\n\t// not the most beautiful list of matchers, but not bad either...\n\treturn format.Message(actual, fmt.Sprintf(\"To satisfy at least one of these matchers: %s\", m.Matchers))\n}\n\nfunc (m *OrMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn m.firstSuccessfulMatcher.NegatedFailureMessage(actual)\n}\n\nfunc (m *OrMatcher) MatchMayChangeInTheFuture(actual any) bool {\n\t/*\n\t\tExample with 3 matchers: A, B, C\n\n\t\tMatch evaluates them: F, T, => T\n\t\tSo match is currently T, what should MatchMayChangeInTheFuture() return?\n\t\tSeems like it only depends on B, since currently B MUST change to allow the result to become F\n\n\t\tMatch eval: F, F, F => F\n\t\tSo match is currently F, what should MatchMayChangeInTheFuture() return?\n\t\tSeems to depend on ANY of them being able to change to T.\n\t*/\n\n\tif m.firstSuccessfulMatcher != nil {\n\t\t// one of the matchers succeeded.. it must be able to change in order to affect the result\n\t\treturn types.MatchMayChangeInTheFuture(m.firstSuccessfulMatcher, actual)\n\t} else {\n\t\t// so all matchers failed.. Any one of them changing would change the result.\n\t\tfor _, matcher := range m.Matchers {\n\t\t\tif types.MatchMayChangeInTheFuture(matcher, actual) {\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\t\treturn false // none of were going to change\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/panic_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype PanicMatcher struct {\n\tExpected any\n\tobject any\n}\n\nfunc (matcher *PanicMatcher) Match(actual any) (success bool, err error) {\n\tif actual == nil {\n\t\treturn false, fmt.Errorf(\"PanicMatcher expects a non-nil actual.\")\n\t}\n\n\tactualType := reflect.TypeOf(actual)\n\tif actualType.Kind() != reflect.Func {\n\t\treturn false, fmt.Errorf(\"PanicMatcher expects a function. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\tif !(actualType.NumIn() == 0 && actualType.NumOut() == 0) {\n\t\treturn false, fmt.Errorf(\"PanicMatcher expects a function with no arguments and no return value. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tsuccess = false\n\tdefer func() {\n\t\tif e := recover(); e != nil {\n\t\t\tmatcher.object = e\n\n\t\t\tif matcher.Expected == nil {\n\t\t\t\tsuccess = true\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\tvalueMatcher, valueIsMatcher := matcher.Expected.(omegaMatcher)\n\t\t\tif !valueIsMatcher {\n\t\t\t\tvalueMatcher = &EqualMatcher{Expected: matcher.Expected}\n\t\t\t}\n\n\t\t\tsuccess, err = valueMatcher.Match(e)\n\t\t\tif err != nil {\n\t\t\t\terr = fmt.Errorf(\"PanicMatcher's value matcher failed with:\\n%s%s\", format.Indent, err.Error())\n\t\t\t}\n\t\t}\n\t}()\n\n\treflect.ValueOf(actual).Call([]reflect.Value{})\n\n\treturn\n}\n\nfunc (matcher *PanicMatcher) FailureMessage(actual any) (message string) {\n\tif matcher.Expected == nil {\n\t\t// We wanted any panic to occur, but none did.\n\t\treturn format.Message(actual, \"to panic\")\n\t}\n\n\tif matcher.object == nil {\n\t\t// We wanted a panic with a specific value to occur, but none did.\n\t\tswitch matcher.Expected.(type) {\n\t\tcase omegaMatcher:\n\t\t\treturn format.Message(actual, \"to panic with a value matching\", matcher.Expected)\n\t\tdefault:\n\t\t\treturn format.Message(actual, \"to panic with\", matcher.Expected)\n\t\t}\n\t}\n\n\t// We got a panic, but the value isn't what we expected.\n\tswitch matcher.Expected.(type) {\n\tcase omegaMatcher:\n\t\treturn format.Message(\n\t\t\tactual,\n\t\t\tfmt.Sprintf(\n\t\t\t\t\"to panic with a value matching\\n%s\\nbut panicked with\\n%s\",\n\t\t\t\tformat.Object(matcher.Expected, 1),\n\t\t\t\tformat.Object(matcher.object, 1),\n\t\t\t),\n\t\t)\n\tdefault:\n\t\treturn format.Message(\n\t\t\tactual,\n\t\t\tfmt.Sprintf(\n\t\t\t\t\"to panic with\\n%s\\nbut panicked with\\n%s\",\n\t\t\t\tformat.Object(matcher.Expected, 1),\n\t\t\t\tformat.Object(matcher.object, 1),\n\t\t\t),\n\t\t)\n\t}\n}\n\nfunc (matcher *PanicMatcher) NegatedFailureMessage(actual any) (message string) {\n\tif matcher.Expected == nil {\n\t\t// We didn't want any panic to occur, but one did.\n\t\treturn format.Message(actual, fmt.Sprintf(\"not to panic, but panicked with\\n%s\", format.Object(matcher.object, 1)))\n\t}\n\n\t// We wanted a to ensure a panic with a specific value did not occur, but it did.\n\tswitch matcher.Expected.(type) {\n\tcase omegaMatcher:\n\t\treturn format.Message(\n\t\t\tactual,\n\t\t\tfmt.Sprintf(\n\t\t\t\t\"not to panic with a value matching\\n%s\\nbut panicked with\\n%s\",\n\t\t\t\tformat.Object(matcher.Expected, 1),\n\t\t\t\tformat.Object(matcher.object, 1),\n\t\t\t),\n\t\t)\n\tdefault:\n\t\treturn format.Message(actual, \"not to panic with\", matcher.Expected)\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/receive_matcher.go",
"content": "// untested sections: 3\n\npackage matchers\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype ReceiveMatcher struct {\n\tArgs []any\n\treceivedValue reflect.Value\n\tchannelClosed bool\n}\n\nfunc (matcher *ReceiveMatcher) Match(actual any) (success bool, err error) {\n\tif !isChan(actual) {\n\t\treturn false, fmt.Errorf(\"ReceiveMatcher expects a channel. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tchannelType := reflect.TypeOf(actual)\n\tchannelValue := reflect.ValueOf(actual)\n\n\tif channelType.ChanDir() == reflect.SendDir {\n\t\treturn false, fmt.Errorf(\"ReceiveMatcher matcher cannot be passed a send-only channel. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\tvar subMatcher omegaMatcher\n\tvar hasSubMatcher bool\n\tvar resultReference any\n\n\t// Valid arg formats are as follows, always with optional POINTER before\n\t// optional MATCHER:\n\t// - Receive()\n\t// - Receive(POINTER)\n\t// - Receive(MATCHER)\n\t// - Receive(POINTER, MATCHER)\n\targs := matcher.Args\n\tif len(args) > 0 {\n\t\targ := args[0]\n\t\t_, isSubMatcher := arg.(omegaMatcher)\n\t\tif !isSubMatcher && reflect.ValueOf(arg).Kind() == reflect.Ptr {\n\t\t\t// Consume optional POINTER arg first, if it ain't no matcher ;)\n\t\t\tresultReference = arg\n\t\t\targs = args[1:]\n\t\t}\n\t}\n\tif len(args) > 0 {\n\t\targ := args[0]\n\t\tsubMatcher, hasSubMatcher = arg.(omegaMatcher)\n\t\tif !hasSubMatcher {\n\t\t\t// At this point we assume the dev user wanted to assign a received\n\t\t\t// value, so [POINTER,]MATCHER.\n\t\t\treturn false, fmt.Errorf(\"Cannot assign a value from the channel:\\n%s\\nTo:\\n%s\\nYou need to pass a pointer!\", format.Object(actual, 1), format.Object(arg, 1))\n\t\t}\n\t\t// Consume optional MATCHER arg.\n\t\targs = args[1:]\n\t}\n\tif len(args) > 0 {\n\t\t// If there are still args present, reject all.\n\t\treturn false, errors.New(\"Receive matcher expects at most an optional pointer and/or an optional matcher\")\n\t}\n\n\twinnerIndex, value, open := reflect.Select([]reflect.SelectCase{\n\t\t{Dir: reflect.SelectRecv, Chan: channelValue},\n\t\t{Dir: reflect.SelectDefault},\n\t})\n\n\tvar closed bool\n\tvar didReceive bool\n\tif winnerIndex == 0 {\n\t\tclosed = !open\n\t\tdidReceive = open\n\t}\n\tmatcher.channelClosed = closed\n\n\tif closed {\n\t\treturn false, nil\n\t}\n\n\tif hasSubMatcher {\n\t\tif !didReceive {\n\t\t\treturn false, nil\n\t\t}\n\t\tmatcher.receivedValue = value\n\t\tif match, err := subMatcher.Match(matcher.receivedValue.Interface()); err != nil || !match {\n\t\t\treturn match, err\n\t\t}\n\t\t// if we received a match, then fall through in order to handle an\n\t\t// optional assignment of the received value to the specified reference.\n\t}\n\n\tif didReceive {\n\t\tif resultReference != nil {\n\t\t\toutValue := reflect.ValueOf(resultReference)\n\n\t\t\tif value.Type().AssignableTo(outValue.Elem().Type()) {\n\t\t\t\toutValue.Elem().Set(value)\n\t\t\t\treturn true, nil\n\t\t\t}\n\t\t\tif value.Type().Kind() == reflect.Interface && value.Elem().Type().AssignableTo(outValue.Elem().Type()) {\n\t\t\t\toutValue.Elem().Set(value.Elem())\n\t\t\t\treturn true, nil\n\t\t\t} else {\n\t\t\t\treturn false, fmt.Errorf(\"Cannot assign a value from the channel:\\n%s\\nType:\\n%s\\nTo:\\n%s\", format.Object(actual, 1), format.Object(value.Interface(), 1), format.Object(resultReference, 1))\n\t\t\t}\n\n\t\t}\n\n\t\treturn true, nil\n\t}\n\treturn false, nil\n}\n\nfunc (matcher *ReceiveMatcher) FailureMessage(actual any) (message string) {\n\tvar matcherArg any\n\tif len(matcher.Args) > 0 {\n\t\tmatcherArg = matcher.Args[len(matcher.Args)-1]\n\t}\n\tsubMatcher, hasSubMatcher := (matcherArg).(omegaMatcher)\n\n\tclosedAddendum := \"\"\n\tif matcher.channelClosed {\n\t\tclosedAddendum = \" The channel is closed.\"\n\t}\n\n\tif hasSubMatcher {\n\t\tif matcher.receivedValue.IsValid() {\n\t\t\treturn subMatcher.FailureMessage(matcher.receivedValue.Interface())\n\t\t}\n\t\treturn \"When passed a matcher, ReceiveMatcher's channel *must* receive something.\"\n\t}\n\treturn format.Message(actual, \"to receive something.\"+closedAddendum)\n}\n\nfunc (matcher *ReceiveMatcher) NegatedFailureMessage(actual any) (message string) {\n\tvar matcherArg any\n\tif len(matcher.Args) > 0 {\n\t\tmatcherArg = matcher.Args[len(matcher.Args)-1]\n\t}\n\tsubMatcher, hasSubMatcher := (matcherArg).(omegaMatcher)\n\n\tclosedAddendum := \"\"\n\tif matcher.channelClosed {\n\t\tclosedAddendum = \" The channel is closed.\"\n\t}\n\n\tif hasSubMatcher {\n\t\tif matcher.receivedValue.IsValid() {\n\t\t\treturn subMatcher.NegatedFailureMessage(matcher.receivedValue.Interface())\n\t\t}\n\t\treturn \"When passed a matcher, ReceiveMatcher's channel *must* receive something.\"\n\t}\n\treturn format.Message(actual, \"not to receive anything.\"+closedAddendum)\n}\n\nfunc (matcher *ReceiveMatcher) MatchMayChangeInTheFuture(actual any) bool {\n\tif !isChan(actual) {\n\t\treturn false\n\t}\n\n\treturn !matcher.channelClosed\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/satisfy_matcher.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype SatisfyMatcher struct {\n\tPredicate any\n\n\t// cached type\n\tpredicateArgType reflect.Type\n}\n\nfunc NewSatisfyMatcher(predicate any) *SatisfyMatcher {\n\tif predicate == nil {\n\t\tpanic(\"predicate cannot be nil\")\n\t}\n\tpredicateType := reflect.TypeOf(predicate)\n\tif predicateType.Kind() != reflect.Func {\n\t\tpanic(\"predicate must be a function\")\n\t}\n\tif predicateType.NumIn() != 1 {\n\t\tpanic(\"predicate must have 1 argument\")\n\t}\n\tif predicateType.NumOut() != 1 || predicateType.Out(0).Kind() != reflect.Bool {\n\t\tpanic(\"predicate must return bool\")\n\t}\n\n\treturn &SatisfyMatcher{\n\t\tPredicate: predicate,\n\t\tpredicateArgType: predicateType.In(0),\n\t}\n}\n\nfunc (m *SatisfyMatcher) Match(actual any) (success bool, err error) {\n\t// prepare a parameter to pass to the predicate\n\tvar param reflect.Value\n\tif actual != nil && reflect.TypeOf(actual).AssignableTo(m.predicateArgType) {\n\t\t// The dynamic type of actual is compatible with the predicate argument.\n\t\tparam = reflect.ValueOf(actual)\n\n\t} else if actual == nil && m.predicateArgType.Kind() == reflect.Interface {\n\t\t// The dynamic type of actual is unknown, so there's no way to make its\n\t\t// reflect.Value. Create a nil of the predicate argument, which is known.\n\t\tparam = reflect.Zero(m.predicateArgType)\n\n\t} else {\n\t\treturn false, fmt.Errorf(\"predicate expects '%s' but we have '%T'\", m.predicateArgType, actual)\n\t}\n\n\t// call the predicate with `actual`\n\tfn := reflect.ValueOf(m.Predicate)\n\tresult := fn.Call([]reflect.Value{param})\n\treturn result[0].Bool(), nil\n}\n\nfunc (m *SatisfyMatcher) FailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to satisfy predicate\", m.Predicate)\n}\n\nfunc (m *SatisfyMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn format.Message(actual, \"to not satisfy predicate\", m.Predicate)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/semi_structured_data_support.go",
"content": "// untested sections: 5\n\npackage matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\t\"strings\"\n)\n\nfunc formattedMessage(comparisonMessage string, failurePath []any) string {\n\tvar diffMessage string\n\tif len(failurePath) == 0 {\n\t\tdiffMessage = \"\"\n\t} else {\n\t\tdiffMessage = fmt.Sprintf(\"\\n\\nfirst mismatched key: %s\", formattedFailurePath(failurePath))\n\t}\n\treturn fmt.Sprintf(\"%s%s\", comparisonMessage, diffMessage)\n}\n\nfunc formattedFailurePath(failurePath []any) string {\n\tformattedPaths := []string{}\n\tfor i := len(failurePath) - 1; i >= 0; i-- {\n\t\tswitch p := failurePath[i].(type) {\n\t\tcase int:\n\t\t\tformattedPaths = append(formattedPaths, fmt.Sprintf(`[%d]`, p))\n\t\tdefault:\n\t\t\tif i != len(failurePath)-1 {\n\t\t\t\tformattedPaths = append(formattedPaths, \".\")\n\t\t\t}\n\t\t\tformattedPaths = append(formattedPaths, fmt.Sprintf(`\"%s\"`, p))\n\t\t}\n\t}\n\treturn strings.Join(formattedPaths, \"\")\n}\n\nfunc deepEqual(a any, b any) (bool, []any) {\n\tvar errorPath []any\n\tif reflect.TypeOf(a) != reflect.TypeOf(b) {\n\t\treturn false, errorPath\n\t}\n\n\tswitch a.(type) {\n\tcase []any:\n\t\tif len(a.([]any)) != len(b.([]any)) {\n\t\t\treturn false, errorPath\n\t\t}\n\n\t\tfor i, v := range a.([]any) {\n\t\t\telementEqual, keyPath := deepEqual(v, b.([]any)[i])\n\t\t\tif !elementEqual {\n\t\t\t\treturn false, append(keyPath, i)\n\t\t\t}\n\t\t}\n\t\treturn true, errorPath\n\n\tcase map[any]any:\n\t\tif len(a.(map[any]any)) != len(b.(map[any]any)) {\n\t\t\treturn false, errorPath\n\t\t}\n\n\t\tfor k, v1 := range a.(map[any]any) {\n\t\t\tv2, ok := b.(map[any]any)[k]\n\t\t\tif !ok {\n\t\t\t\treturn false, errorPath\n\t\t\t}\n\t\t\telementEqual, keyPath := deepEqual(v1, v2)\n\t\t\tif !elementEqual {\n\t\t\t\treturn false, append(keyPath, k)\n\t\t\t}\n\t\t}\n\t\treturn true, errorPath\n\n\tcase map[string]any:\n\t\tif len(a.(map[string]any)) != len(b.(map[string]any)) {\n\t\t\treturn false, errorPath\n\t\t}\n\n\t\tfor k, v1 := range a.(map[string]any) {\n\t\t\tv2, ok := b.(map[string]any)[k]\n\t\t\tif !ok {\n\t\t\t\treturn false, errorPath\n\t\t\t}\n\t\t\telementEqual, keyPath := deepEqual(v1, v2)\n\t\t\tif !elementEqual {\n\t\t\t\treturn false, append(keyPath, k)\n\t\t\t}\n\t\t}\n\t\treturn true, errorPath\n\n\tdefault:\n\t\treturn a == b, errorPath\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/succeed_matcher.go",
"content": "package matchers\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\n\t\"github.com/onsi/gomega/format\"\n)\n\ntype formattedGomegaError interface {\n\tFormattedGomegaError() string\n}\n\ntype SucceedMatcher struct {\n}\n\nfunc (matcher *SucceedMatcher) Match(actual any) (success bool, err error) {\n\t// is purely nil?\n\tif actual == nil {\n\t\treturn true, nil\n\t}\n\n\t// must be an 'error' type\n\tif !isError(actual) {\n\t\treturn false, fmt.Errorf(\"Expected an error-type. Got:\\n%s\", format.Object(actual, 1))\n\t}\n\n\t// must be nil (or a pointer to a nil)\n\treturn isNil(actual), nil\n}\n\nfunc (matcher *SucceedMatcher) FailureMessage(actual any) (message string) {\n\tvar fgErr formattedGomegaError\n\tif errors.As(actual.(error), &fgErr) {\n\t\treturn fgErr.FormattedGomegaError()\n\t}\n\treturn fmt.Sprintf(\"Expected success, but got an error:\\n%s\", format.Object(actual, 1))\n}\n\nfunc (matcher *SucceedMatcher) NegatedFailureMessage(actual any) (message string) {\n\treturn \"Expected failure, but got no error.\"\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/support/goraph/bipartitegraph/bipartitegraph.go",
"content": "package bipartitegraph\n\nimport \"fmt\"\n\nimport . \"github.com/onsi/gomega/matchers/support/goraph/node\"\nimport . \"github.com/onsi/gomega/matchers/support/goraph/edge\"\n\ntype BipartiteGraph struct {\n\tLeft NodeOrderedSet\n\tRight NodeOrderedSet\n\tEdges EdgeSet\n}\n\nfunc NewBipartiteGraph(leftValues, rightValues []any, neighbours func(any, any) (bool, error)) (*BipartiteGraph, error) {\n\tleft := NodeOrderedSet{}\n\tfor i, v := range leftValues {\n\t\tleft = append(left, Node{ID: i, Value: v})\n\t}\n\n\tright := NodeOrderedSet{}\n\tfor j, v := range rightValues {\n\t\tright = append(right, Node{ID: j + len(left), Value: v})\n\t}\n\n\tedges := EdgeSet{}\n\tfor i, leftValue := range leftValues {\n\t\tfor j, rightValue := range rightValues {\n\t\t\tneighbours, err := neighbours(leftValue, rightValue)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, fmt.Errorf(\"error determining adjacency for %v and %v: %s\", leftValue, rightValue, err.Error())\n\t\t\t}\n\n\t\t\tif neighbours {\n\t\t\t\tedges = append(edges, Edge{Node1: left[i].ID, Node2: right[j].ID})\n\t\t\t}\n\t\t}\n\t}\n\n\treturn &BipartiteGraph{left, right, edges}, nil\n}\n\n// FreeLeftRight returns left node values and right node values\n// of the BipartiteGraph's nodes which are not part of the given edges.\nfunc (bg *BipartiteGraph) FreeLeftRight(edges EdgeSet) (leftValues, rightValues []any) {\n\tfor _, node := range bg.Left {\n\t\tif edges.Free(node) {\n\t\t\tleftValues = append(leftValues, node.Value)\n\t\t}\n\t}\n\tfor _, node := range bg.Right {\n\t\tif edges.Free(node) {\n\t\t\trightValues = append(rightValues, node.Value)\n\t\t}\n\t}\n\treturn\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/support/goraph/bipartitegraph/bipartitegraphmatching.go",
"content": "package bipartitegraph\n\nimport (\n\t\"slices\"\n\n\t. \"github.com/onsi/gomega/matchers/support/goraph/edge\"\n\t. \"github.com/onsi/gomega/matchers/support/goraph/node\"\n\t\"github.com/onsi/gomega/matchers/support/goraph/util\"\n)\n\n// LargestMatching implements the Hopcroft–Karp algorithm taking as input a bipartite graph\n// and outputting a maximum cardinality matching, i.e. a set of as many edges as possible\n// with the property that no two edges share an endpoint.\nfunc (bg *BipartiteGraph) LargestMatching() (matching EdgeSet) {\n\tpaths := bg.maximalDisjointSLAPCollection(matching)\n\n\tfor len(paths) > 0 {\n\t\tfor _, path := range paths {\n\t\t\tmatching = matching.SymmetricDifference(path)\n\t\t}\n\t\tpaths = bg.maximalDisjointSLAPCollection(matching)\n\t}\n\n\treturn\n}\n\nfunc (bg *BipartiteGraph) maximalDisjointSLAPCollection(matching EdgeSet) (result []EdgeSet) {\n\tguideLayers := bg.createSLAPGuideLayers(matching)\n\tif len(guideLayers) == 0 {\n\t\treturn\n\t}\n\n\tused := make(map[int]bool)\n\n\tfor _, u := range guideLayers[len(guideLayers)-1] {\n\t\tslap, found := bg.findDisjointSLAP(u, matching, guideLayers, used)\n\t\tif found {\n\t\t\tfor _, edge := range slap {\n\t\t\t\tused[edge.Node1] = true\n\t\t\t\tused[edge.Node2] = true\n\t\t\t}\n\t\t\tresult = append(result, slap)\n\t\t}\n\t}\n\n\treturn\n}\n\nfunc (bg *BipartiteGraph) findDisjointSLAP(\n\tstart Node,\n\tmatching EdgeSet,\n\tguideLayers []NodeOrderedSet,\n\tused map[int]bool,\n) ([]Edge, bool) {\n\treturn bg.findDisjointSLAPHelper(start, EdgeSet{}, len(guideLayers)-1, matching, guideLayers, used)\n}\n\nfunc (bg *BipartiteGraph) findDisjointSLAPHelper(\n\tcurrentNode Node,\n\tcurrentSLAP EdgeSet,\n\tcurrentLevel int,\n\tmatching EdgeSet,\n\tguideLayers []NodeOrderedSet,\n\tused map[int]bool,\n) (EdgeSet, bool) {\n\tused[currentNode.ID] = true\n\n\tif currentLevel == 0 {\n\t\treturn currentSLAP, true\n\t}\n\n\tfor _, nextNode := range guideLayers[currentLevel-1] {\n\t\tif used[nextNode.ID] {\n\t\t\tcontinue\n\t\t}\n\n\t\tedge, found := bg.Edges.FindByNodes(currentNode, nextNode)\n\t\tif !found {\n\t\t\tcontinue\n\t\t}\n\n\t\tif matching.Contains(edge) == util.Odd(currentLevel) {\n\t\t\tcontinue\n\t\t}\n\n\t\tcurrentSLAP = append(currentSLAP, edge)\n\t\tslap, found := bg.findDisjointSLAPHelper(nextNode, currentSLAP, currentLevel-1, matching, guideLayers, used)\n\t\tif found {\n\t\t\treturn slap, true\n\t\t}\n\t\tcurrentSLAP = currentSLAP[:len(currentSLAP)-1]\n\t}\n\n\tused[currentNode.ID] = false\n\treturn nil, false\n}\n\nfunc (bg *BipartiteGraph) createSLAPGuideLayers(matching EdgeSet) (guideLayers []NodeOrderedSet) {\n\tused := make(map[int]bool)\n\tcurrentLayer := NodeOrderedSet{}\n\n\tfor _, node := range bg.Left {\n\t\tif matching.Free(node) {\n\t\t\tused[node.ID] = true\n\t\t\tcurrentLayer = append(currentLayer, node)\n\t\t}\n\t}\n\n\tif len(currentLayer) == 0 {\n\t\treturn []NodeOrderedSet{}\n\t}\n\tguideLayers = append(guideLayers, currentLayer)\n\n\tdone := false\n\n\tfor !done {\n\t\tlastLayer := currentLayer\n\t\tcurrentLayer = NodeOrderedSet{}\n\n\t\tif util.Odd(len(guideLayers)) {\n\t\t\tfor _, leftNode := range lastLayer {\n\t\t\t\tfor _, rightNode := range bg.Right {\n\t\t\t\t\tif used[rightNode.ID] {\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\n\t\t\t\t\tedge, found := bg.Edges.FindByNodes(leftNode, rightNode)\n\t\t\t\t\tif !found || matching.Contains(edge) {\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\n\t\t\t\t\tcurrentLayer = append(currentLayer, rightNode)\n\t\t\t\t\tused[rightNode.ID] = true\n\n\t\t\t\t\tif matching.Free(rightNode) {\n\t\t\t\t\t\tdone = true\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfor _, rightNode := range lastLayer {\n\t\t\t\tfor _, leftNode := range bg.Left {\n\t\t\t\t\tif used[leftNode.ID] {\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\n\t\t\t\t\tedge, found := bg.Edges.FindByNodes(leftNode, rightNode)\n\t\t\t\t\tif !found || !matching.Contains(edge) {\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\n\t\t\t\t\tcurrentLayer = append(currentLayer, leftNode)\n\t\t\t\t\tused[leftNode.ID] = true\n\t\t\t\t}\n\t\t\t}\n\n\t\t}\n\n\t\tif len(currentLayer) == 0 {\n\t\t\treturn []NodeOrderedSet{}\n\t\t}\n\t\tif done { // if last layer - into last layer must be only 'free' nodes\n\t\t\tcurrentLayer = slices.DeleteFunc(currentLayer, func(in Node) bool {\n\t\t\t\treturn !matching.Free(in)\n\t\t\t})\n\t\t}\n\t\tguideLayers = append(guideLayers, currentLayer)\n\t}\n\n\treturn\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/support/goraph/edge/edge.go",
"content": "package edge\n\nimport (\n\t. \"github.com/onsi/gomega/matchers/support/goraph/node\"\n\t\"slices\"\n)\n\ntype Edge struct {\n\tNode1 int\n\tNode2 int\n}\n\ntype EdgeSet []Edge\n\nfunc (ec EdgeSet) Free(node Node) bool {\n\tfor _, e := range ec {\n\t\tif e.Node1 == node.ID || e.Node2 == node.ID {\n\t\t\treturn false\n\t\t}\n\t}\n\n\treturn true\n}\n\nfunc (ec EdgeSet) Contains(edge Edge) bool {\n\treturn slices.Contains(ec, edge)\n}\n\nfunc (ec EdgeSet) FindByNodes(node1, node2 Node) (Edge, bool) {\n\tfor _, e := range ec {\n\t\tif (e.Node1 == node1.ID && e.Node2 == node2.ID) || (e.Node1 == node2.ID && e.Node2 == node1.ID) {\n\t\t\treturn e, true\n\t\t}\n\t}\n\n\treturn Edge{}, false\n}\n\nfunc (ec EdgeSet) SymmetricDifference(ec2 EdgeSet) EdgeSet {\n\tedgesToInclude := make(map[Edge]bool)\n\n\tfor _, e := range ec {\n\t\tedgesToInclude[e] = true\n\t}\n\n\tfor _, e := range ec2 {\n\t\tedgesToInclude[e] = !edgesToInclude[e]\n\t}\n\n\tresult := EdgeSet{}\n\tfor e, include := range edgesToInclude {\n\t\tif include {\n\t\t\tresult = append(result, e)\n\t\t}\n\t}\n\n\treturn result\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/support/goraph/node/node.go",
"content": "package node\n\ntype Node struct {\n\tID int\n\tValue any\n}\n\ntype NodeOrderedSet []Node\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/support/goraph/util/util.go",
"content": "package util\n\nimport \"math\"\n\nfunc Odd(n int) bool {\n\treturn math.Mod(float64(n), 2.0) == 1.0\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/type_support.go",
"content": "/*\nGomega matchers\n\nThis package implements the Gomega matchers and does not typically need to be imported.\nSee the docs for Gomega for documentation on the matchers\n\nhttp://onsi.github.io/gomega/\n*/\n\n// untested sections: 11\n\npackage matchers\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/matchers/internal/miter\"\n)\n\ntype omegaMatcher interface {\n\tMatch(actual any) (success bool, err error)\n\tFailureMessage(actual any) (message string)\n\tNegatedFailureMessage(actual any) (message string)\n}\n\nfunc isBool(a any) bool {\n\treturn reflect.TypeOf(a).Kind() == reflect.Bool\n}\n\nfunc isNumber(a any) bool {\n\tif a == nil {\n\t\treturn false\n\t}\n\tkind := reflect.TypeOf(a).Kind()\n\treturn reflect.Int <= kind && kind <= reflect.Float64\n}\n\nfunc isInteger(a any) bool {\n\tkind := reflect.TypeOf(a).Kind()\n\treturn reflect.Int <= kind && kind <= reflect.Int64\n}\n\nfunc isUnsignedInteger(a any) bool {\n\tkind := reflect.TypeOf(a).Kind()\n\treturn reflect.Uint <= kind && kind <= reflect.Uint64\n}\n\nfunc isFloat(a any) bool {\n\tkind := reflect.TypeOf(a).Kind()\n\treturn reflect.Float32 <= kind && kind <= reflect.Float64\n}\n\nfunc toInteger(a any) int64 {\n\tif isInteger(a) {\n\t\treturn reflect.ValueOf(a).Int()\n\t} else if isUnsignedInteger(a) {\n\t\treturn int64(reflect.ValueOf(a).Uint())\n\t} else if isFloat(a) {\n\t\treturn int64(reflect.ValueOf(a).Float())\n\t}\n\tpanic(fmt.Sprintf(\"Expected a number! Got <%T> %#v\", a, a))\n}\n\nfunc toUnsignedInteger(a any) uint64 {\n\tif isInteger(a) {\n\t\treturn uint64(reflect.ValueOf(a).Int())\n\t} else if isUnsignedInteger(a) {\n\t\treturn reflect.ValueOf(a).Uint()\n\t} else if isFloat(a) {\n\t\treturn uint64(reflect.ValueOf(a).Float())\n\t}\n\tpanic(fmt.Sprintf(\"Expected a number! Got <%T> %#v\", a, a))\n}\n\nfunc toFloat(a any) float64 {\n\tif isInteger(a) {\n\t\treturn float64(reflect.ValueOf(a).Int())\n\t} else if isUnsignedInteger(a) {\n\t\treturn float64(reflect.ValueOf(a).Uint())\n\t} else if isFloat(a) {\n\t\treturn reflect.ValueOf(a).Float()\n\t}\n\tpanic(fmt.Sprintf(\"Expected a number! Got <%T> %#v\", a, a))\n}\n\nfunc isError(a any) bool {\n\t_, ok := a.(error)\n\treturn ok\n}\n\nfunc isChan(a any) bool {\n\tif isNil(a) {\n\t\treturn false\n\t}\n\treturn reflect.TypeOf(a).Kind() == reflect.Chan\n}\n\nfunc isMap(a any) bool {\n\tif a == nil {\n\t\treturn false\n\t}\n\treturn reflect.TypeOf(a).Kind() == reflect.Map\n}\n\nfunc isArrayOrSlice(a any) bool {\n\tif a == nil {\n\t\treturn false\n\t}\n\tswitch reflect.TypeOf(a).Kind() {\n\tcase reflect.Array, reflect.Slice:\n\t\treturn true\n\tdefault:\n\t\treturn false\n\t}\n}\n\nfunc isString(a any) bool {\n\tif a == nil {\n\t\treturn false\n\t}\n\treturn reflect.TypeOf(a).Kind() == reflect.String\n}\n\nfunc toString(a any) (string, bool) {\n\taString, isString := a.(string)\n\tif isString {\n\t\treturn aString, true\n\t}\n\n\taBytes, isBytes := a.([]byte)\n\tif isBytes {\n\t\treturn string(aBytes), true\n\t}\n\n\taStringer, isStringer := a.(fmt.Stringer)\n\tif isStringer {\n\t\treturn aStringer.String(), true\n\t}\n\n\taJSONRawMessage, isJSONRawMessage := a.(json.RawMessage)\n\tif isJSONRawMessage {\n\t\treturn string(aJSONRawMessage), true\n\t}\n\n\treturn \"\", false\n}\n\nfunc lengthOf(a any) (int, bool) {\n\tif a == nil {\n\t\treturn 0, false\n\t}\n\tswitch reflect.TypeOf(a).Kind() {\n\tcase reflect.Map, reflect.Array, reflect.String, reflect.Chan, reflect.Slice:\n\t\treturn reflect.ValueOf(a).Len(), true\n\tcase reflect.Func:\n\t\tif !miter.IsIter(a) {\n\t\t\treturn 0, false\n\t\t}\n\t\tvar l int\n\t\tif miter.IsSeq2(a) {\n\t\t\tmiter.IterateKV(a, func(k, v reflect.Value) bool { l++; return true })\n\t\t} else {\n\t\t\tmiter.IterateV(a, func(v reflect.Value) bool { l++; return true })\n\t\t}\n\t\treturn l, true\n\tdefault:\n\t\treturn 0, false\n\t}\n}\nfunc capOf(a any) (int, bool) {\n\tif a == nil {\n\t\treturn 0, false\n\t}\n\tswitch reflect.TypeOf(a).Kind() {\n\tcase reflect.Array, reflect.Chan, reflect.Slice:\n\t\treturn reflect.ValueOf(a).Cap(), true\n\tdefault:\n\t\treturn 0, false\n\t}\n}\n\nfunc isNil(a any) bool {\n\tif a == nil {\n\t\treturn true\n\t}\n\n\tswitch reflect.TypeOf(a).Kind() {\n\tcase reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice:\n\t\treturn reflect.ValueOf(a).IsNil()\n\t}\n\n\treturn false\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers/with_transform.go",
"content": "package matchers\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\n\t\"github.com/onsi/gomega/types\"\n)\n\ntype WithTransformMatcher struct {\n\t// input\n\tTransform any // must be a function of one parameter that returns one value and an optional error\n\tMatcher types.GomegaMatcher\n\n\t// cached value\n\ttransformArgType reflect.Type\n\n\t// state\n\ttransformedValue any\n}\n\n// reflect.Type for error\nvar errorT = reflect.TypeOf((*error)(nil)).Elem()\n\nfunc NewWithTransformMatcher(transform any, matcher types.GomegaMatcher) *WithTransformMatcher {\n\tif transform == nil {\n\t\tpanic(\"transform function cannot be nil\")\n\t}\n\ttxType := reflect.TypeOf(transform)\n\tif txType.NumIn() != 1 {\n\t\tpanic(\"transform function must have 1 argument\")\n\t}\n\tif numout := txType.NumOut(); numout != 1 {\n\t\tif numout != 2 || !txType.Out(1).AssignableTo(errorT) {\n\t\t\tpanic(\"transform function must either have 1 return value, or 1 return value plus 1 error value\")\n\t\t}\n\t}\n\n\treturn &WithTransformMatcher{\n\t\tTransform: transform,\n\t\tMatcher: matcher,\n\t\ttransformArgType: reflect.TypeOf(transform).In(0),\n\t}\n}\n\nfunc (m *WithTransformMatcher) Match(actual any) (bool, error) {\n\t// prepare a parameter to pass to the Transform function\n\tvar param reflect.Value\n\tif actual != nil && reflect.TypeOf(actual).AssignableTo(m.transformArgType) {\n\t\t// The dynamic type of actual is compatible with the transform argument.\n\t\tparam = reflect.ValueOf(actual)\n\n\t} else if actual == nil && m.transformArgType.Kind() == reflect.Interface {\n\t\t// The dynamic type of actual is unknown, so there's no way to make its\n\t\t// reflect.Value. Create a nil of the transform argument, which is known.\n\t\tparam = reflect.Zero(m.transformArgType)\n\n\t} else {\n\t\treturn false, fmt.Errorf(\"Transform function expects '%s' but we have '%T'\", m.transformArgType, actual)\n\t}\n\n\t// call the Transform function with `actual`\n\tfn := reflect.ValueOf(m.Transform)\n\tresult := fn.Call([]reflect.Value{param})\n\tif len(result) == 2 {\n\t\tif !result[1].IsNil() {\n\t\t\treturn false, fmt.Errorf(\"Transform function failed: %s\", result[1].Interface().(error).Error())\n\t\t}\n\t}\n\tm.transformedValue = result[0].Interface() // expect exactly one value\n\n\treturn m.Matcher.Match(m.transformedValue)\n}\n\nfunc (m *WithTransformMatcher) FailureMessage(_ any) (message string) {\n\treturn m.Matcher.FailureMessage(m.transformedValue)\n}\n\nfunc (m *WithTransformMatcher) NegatedFailureMessage(_ any) (message string) {\n\treturn m.Matcher.NegatedFailureMessage(m.transformedValue)\n}\n\nfunc (m *WithTransformMatcher) MatchMayChangeInTheFuture(_ any) bool {\n\t// TODO: Maybe this should always just return true? (Only an issue for non-deterministic transformers.)\n\t//\n\t// Querying the next matcher is fine if the transformer always will return the same value.\n\t// But if the transformer is non-deterministic and returns a different value each time, then there\n\t// is no point in querying the next matcher, since it can only comment on the last transformed value.\n\treturn types.MatchMayChangeInTheFuture(m.Matcher, m.transformedValue)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/matchers.go",
"content": "package gomega\n\nimport (\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/google/go-cmp/cmp\"\n\t\"github.com/onsi/gomega/matchers\"\n\t\"github.com/onsi/gomega/types\"\n)\n\n// Equal uses reflect.DeepEqual to compare actual with expected. Equal is strict about\n// types when performing comparisons.\n// It is an error for both actual and expected to be nil. Use BeNil() instead.\nfunc Equal(expected any) types.GomegaMatcher {\n\treturn &matchers.EqualMatcher{\n\t\tExpected: expected,\n\t}\n}\n\n// BeEquivalentTo is more lax than Equal, allowing equality between different types.\n// This is done by converting actual to have the type of expected before\n// attempting equality with reflect.DeepEqual.\n// It is an error for actual and expected to be nil. Use BeNil() instead.\nfunc BeEquivalentTo(expected any) types.GomegaMatcher {\n\treturn &matchers.BeEquivalentToMatcher{\n\t\tExpected: expected,\n\t}\n}\n\n// BeComparableTo uses gocmp.Equal from github.com/google/go-cmp (instead of reflect.DeepEqual) to perform a deep comparison.\n// You can pass cmp.Option as options.\n// It is an error for actual and expected to be nil. Use BeNil() instead.\nfunc BeComparableTo(expected any, opts ...cmp.Option) types.GomegaMatcher {\n\treturn &matchers.BeComparableToMatcher{\n\t\tExpected: expected,\n\t\tOptions: opts,\n\t}\n}\n\n// BeIdenticalTo uses the == operator to compare actual with expected.\n// BeIdenticalTo is strict about types when performing comparisons.\n// It is an error for both actual and expected to be nil. Use BeNil() instead.\nfunc BeIdenticalTo(expected any) types.GomegaMatcher {\n\treturn &matchers.BeIdenticalToMatcher{\n\t\tExpected: expected,\n\t}\n}\n\n// BeNil succeeds if actual is nil\nfunc BeNil() types.GomegaMatcher {\n\treturn &matchers.BeNilMatcher{}\n}\n\n// BeTrue succeeds if actual is true\n//\n// In general, it's better to use `BeTrueBecause(reason)` to provide a more useful error message if a true check fails.\nfunc BeTrue() types.GomegaMatcher {\n\treturn &matchers.BeTrueMatcher{}\n}\n\n// BeFalse succeeds if actual is false\n//\n// In general, it's better to use `BeFalseBecause(reason)` to provide a more useful error message if a false check fails.\nfunc BeFalse() types.GomegaMatcher {\n\treturn &matchers.BeFalseMatcher{}\n}\n\n// BeTrueBecause succeeds if actual is true and displays the provided reason if it is false\n// fmt.Sprintf is used to render the reason\nfunc BeTrueBecause(format string, args ...any) types.GomegaMatcher {\n\treturn &matchers.BeTrueMatcher{Reason: fmt.Sprintf(format, args...)}\n}\n\n// BeFalseBecause succeeds if actual is false and displays the provided reason if it is true.\n// fmt.Sprintf is used to render the reason\nfunc BeFalseBecause(format string, args ...any) types.GomegaMatcher {\n\treturn &matchers.BeFalseMatcher{Reason: fmt.Sprintf(format, args...)}\n}\n\n// HaveOccurred succeeds if actual is a non-nil error\n// The typical Go error checking pattern looks like:\n//\n//\terr := SomethingThatMightFail()\n//\tExpect(err).ShouldNot(HaveOccurred())\nfunc HaveOccurred() types.GomegaMatcher {\n\treturn &matchers.HaveOccurredMatcher{}\n}\n\n// Succeed passes if actual is a nil error\n// Succeed is intended to be used with functions that return a single error value. Instead of\n//\n//\terr := SomethingThatMightFail()\n//\tExpect(err).ShouldNot(HaveOccurred())\n//\n// You can write:\n//\n//\tExpect(SomethingThatMightFail()).Should(Succeed())\n//\n// It is a mistake to use Succeed with a function that has multiple return values. Gomega's Ω and Expect\n// functions automatically trigger failure if any return values after the first return value are non-zero/non-nil.\n// This means that Ω(MultiReturnFunc()).ShouldNot(Succeed()) can never pass.\nfunc Succeed() types.GomegaMatcher {\n\treturn &matchers.SucceedMatcher{}\n}\n\n// MatchError succeeds if actual is a non-nil error that matches the passed in\n// string, error, function, or matcher.\n//\n// These are valid use-cases:\n//\n// When passed a string:\n//\n//\tExpect(err).To(MatchError(\"an error\"))\n//\n// asserts that err.Error() == \"an error\"\n//\n// When passed an error:\n//\n//\tExpect(err).To(MatchError(SomeError))\n//\n// First checks if errors.Is(err, SomeError).\n// If that fails then it checks if reflect.DeepEqual(err, SomeError) repeatedly for err and any errors wrapped by err\n//\n// When passed a matcher:\n//\n//\tExpect(err).To(MatchError(ContainSubstring(\"sprocket not found\")))\n//\n// the matcher is passed err.Error(). In this case it asserts that err.Error() contains substring \"sprocket not found\"\n//\n// When passed a func(err) bool and a description:\n//\n//\tExpect(err).To(MatchError(os.IsNotExist, \"IsNotExist\"))\n//\n// the function is passed err and matches if the return value is true. The description is required to allow Gomega\n// to print a useful error message.\n//\n// It is an error for err to be nil or an object that does not implement the\n// Error interface\n//\n// The optional second argument is a description of the error function, if used. This is required when passing a function but is ignored in all other cases.\nfunc MatchError(expected any, functionErrorDescription ...any) types.GomegaMatcher {\n\treturn &matchers.MatchErrorMatcher{\n\t\tExpected: expected,\n\t\tFuncErrDescription: functionErrorDescription,\n\t}\n}\n\n// MatchErrorStrictly succeeds iff actual is a non-nil error that matches the passed in\n// expected error according to errors.Is(actual, expected).\n//\n// This behavior differs from MatchError where\n//\n//\tExpect(errors.New(\"some error\")).To(MatchError(errors.New(\"some error\")))\n//\n// succeeds, but errors.Is would return false so:\n//\n//\tExpect(errors.New(\"some error\")).To(MatchErrorStrictly(errors.New(\"some error\")))\n//\n// fails.\nfunc MatchErrorStrictly(expected error) types.GomegaMatcher {\n\treturn &matchers.MatchErrorStrictlyMatcher{\n\t\tExpected: expected,\n\t}\n}\n\n// BeClosed succeeds if actual is a closed channel.\n// It is an error to pass a non-channel to BeClosed, it is also an error to pass nil\n//\n// In order to check whether or not the channel is closed, Gomega must try to read from the channel\n// (even in the `ShouldNot(BeClosed())` case). You should keep this in mind if you wish to make subsequent assertions about\n// values coming down the channel.\n//\n// Also, if you are testing that a *buffered* channel is closed you must first read all values out of the channel before\n// asserting that it is closed (it is not possible to detect that a buffered-channel has been closed until all its buffered values are read).\n//\n// Finally, as a corollary: it is an error to check whether or not a send-only channel is closed.\nfunc BeClosed() types.GomegaMatcher {\n\treturn &matchers.BeClosedMatcher{}\n}\n\n// Receive succeeds if there is a value to be received on actual.\n// Actual must be a channel (and cannot be a send-only channel) -- anything else is an error.\n//\n// Receive returns immediately and never blocks:\n//\n// - If there is nothing on the channel `c` then Expect(c).Should(Receive()) will fail and Ω(c).ShouldNot(Receive()) will pass.\n//\n// - If the channel `c` is closed then Expect(c).Should(Receive()) will fail and Ω(c).ShouldNot(Receive()) will pass.\n//\n// - If there is something on the channel `c` ready to be read, then Expect(c).Should(Receive()) will pass and Ω(c).ShouldNot(Receive()) will fail.\n//\n// If you have a go-routine running in the background that will write to channel `c` you can:\n//\n//\tEventually(c).Should(Receive())\n//\n// This will timeout if nothing gets sent to `c` (you can modify the timeout interval as you normally do with `Eventually`)\n//\n// A similar use-case is to assert that no go-routine writes to a channel (for a period of time). You can do this with `Consistently`:\n//\n//\tConsistently(c).ShouldNot(Receive())\n//\n// You can pass `Receive` a matcher. If you do so, it will match the received object against the matcher. For example:\n//\n//\tExpect(c).Should(Receive(Equal(\"foo\")))\n//\n// When given a matcher, `Receive` will always fail if there is nothing to be received on the channel.\n//\n// Passing Receive a matcher is especially useful when paired with Eventually:\n//\n//\tEventually(c).Should(Receive(ContainSubstring(\"bar\")))\n//\n// will repeatedly attempt to pull values out of `c` until a value matching \"bar\" is received.\n//\n// Furthermore, if you want to have a reference to the value *sent* to the channel you can pass the `Receive` matcher a pointer to a variable of the appropriate type:\n//\n//\tvar myThing thing\n//\tEventually(thingChan).Should(Receive(&myThing))\n//\tExpect(myThing.Sprocket).Should(Equal(\"foo\"))\n//\tExpect(myThing.IsValid()).Should(BeTrue())\n//\n// Finally, if you want to match the received object as well as get the actual received value into a variable, so you can reason further about the value received,\n// you can pass a pointer to a variable of the appropriate type first, and second a matcher:\n//\n//\tvar myThing thing\n//\tEventually(thingChan).Should(Receive(&myThing, ContainSubstring(\"bar\")))\nfunc Receive(args ...any) types.GomegaMatcher {\n\treturn &matchers.ReceiveMatcher{\n\t\tArgs: args,\n\t}\n}\n\n// BeSent succeeds if a value can be sent to actual.\n// Actual must be a channel (and cannot be a receive-only channel) that can sent the type of the value passed into BeSent -- anything else is an error.\n// In addition, actual must not be closed.\n//\n// BeSent never blocks:\n//\n// - If the channel `c` is not ready to receive then Expect(c).Should(BeSent(\"foo\")) will fail immediately\n// - If the channel `c` is eventually ready to receive then Eventually(c).Should(BeSent(\"foo\")) will succeed.. presuming the channel becomes ready to receive before Eventually's timeout\n// - If the channel `c` is closed then Expect(c).Should(BeSent(\"foo\")) and Ω(c).ShouldNot(BeSent(\"foo\")) will both fail immediately\n//\n// Of course, the value is actually sent to the channel. The point of `BeSent` is less to make an assertion about the availability of the channel (which is typically an implementation detail that your test should not be concerned with).\n// Rather, the point of `BeSent` is to make it possible to easily and expressively write tests that can timeout on blocked channel sends.\nfunc BeSent(arg any) types.GomegaMatcher {\n\treturn &matchers.BeSentMatcher{\n\t\tArg: arg,\n\t}\n}\n\n// MatchRegexp succeeds if actual is a string or stringer that matches the\n// passed-in regexp. Optional arguments can be provided to construct a regexp\n// via fmt.Sprintf().\nfunc MatchRegexp(regexp string, args ...any) types.GomegaMatcher {\n\treturn &matchers.MatchRegexpMatcher{\n\t\tRegexp: regexp,\n\t\tArgs: args,\n\t}\n}\n\n// ContainSubstring succeeds if actual is a string or stringer that contains the\n// passed-in substring. Optional arguments can be provided to construct the substring\n// via fmt.Sprintf().\nfunc ContainSubstring(substr string, args ...any) types.GomegaMatcher {\n\treturn &matchers.ContainSubstringMatcher{\n\t\tSubstr: substr,\n\t\tArgs: args,\n\t}\n}\n\n// HavePrefix succeeds if actual is a string or stringer that contains the\n// passed-in string as a prefix. Optional arguments can be provided to construct\n// via fmt.Sprintf().\nfunc HavePrefix(prefix string, args ...any) types.GomegaMatcher {\n\treturn &matchers.HavePrefixMatcher{\n\t\tPrefix: prefix,\n\t\tArgs: args,\n\t}\n}\n\n// HaveSuffix succeeds if actual is a string or stringer that contains the\n// passed-in string as a suffix. Optional arguments can be provided to construct\n// via fmt.Sprintf().\nfunc HaveSuffix(suffix string, args ...any) types.GomegaMatcher {\n\treturn &matchers.HaveSuffixMatcher{\n\t\tSuffix: suffix,\n\t\tArgs: args,\n\t}\n}\n\n// MatchJSON succeeds if actual is a string or stringer of JSON that matches\n// the expected JSON. The JSONs are decoded and the resulting objects are compared via\n// reflect.DeepEqual so things like key-ordering and whitespace shouldn't matter.\nfunc MatchJSON(json any) types.GomegaMatcher {\n\treturn &matchers.MatchJSONMatcher{\n\t\tJSONToMatch: json,\n\t}\n}\n\n// MatchXML succeeds if actual is a string or stringer of XML that matches\n// the expected XML. The XMLs are decoded and the resulting objects are compared via\n// reflect.DeepEqual so things like whitespaces shouldn't matter.\nfunc MatchXML(xml any) types.GomegaMatcher {\n\treturn &matchers.MatchXMLMatcher{\n\t\tXMLToMatch: xml,\n\t}\n}\n\n// MatchYAML succeeds if actual is a string or stringer of YAML that matches\n// the expected YAML. The YAML's are decoded and the resulting objects are compared via\n// reflect.DeepEqual so things like key-ordering and whitespace shouldn't matter.\nfunc MatchYAML(yaml any) types.GomegaMatcher {\n\treturn &matchers.MatchYAMLMatcher{\n\t\tYAMLToMatch: yaml,\n\t}\n}\n\n// BeEmpty succeeds if actual is empty. Actual must be of type string, array, map, chan, or slice.\nfunc BeEmpty() types.GomegaMatcher {\n\treturn &matchers.BeEmptyMatcher{}\n}\n\n// HaveLen succeeds if actual has the passed-in length. Actual must be of type string, array, map, chan, or slice.\nfunc HaveLen(count int) types.GomegaMatcher {\n\treturn &matchers.HaveLenMatcher{\n\t\tCount: count,\n\t}\n}\n\n// HaveCap succeeds if actual has the passed-in capacity. Actual must be of type array, chan, or slice.\nfunc HaveCap(count int) types.GomegaMatcher {\n\treturn &matchers.HaveCapMatcher{\n\t\tCount: count,\n\t}\n}\n\n// BeZero succeeds if actual is the zero value for its type or if actual is nil.\nfunc BeZero() types.GomegaMatcher {\n\treturn &matchers.BeZeroMatcher{}\n}\n\n// ContainElement succeeds if actual contains the passed in element. By default\n// ContainElement() uses Equal() to perform the match, however a matcher can be\n// passed in instead:\n//\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(ContainElement(ContainSubstring(\"Bar\")))\n//\n// Actual must be an array, slice or map. For maps, ContainElement searches\n// through the map's values.\n//\n// If you want to have a copy of the matching element(s) found you can pass a\n// pointer to a variable of the appropriate type. If the variable isn't a slice\n// or map, then exactly one match will be expected and returned. If the variable\n// is a slice or map, then at least one match is expected and all matches will be\n// stored in the variable.\n//\n//\tvar findings []string\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(ContainElement(ContainSubString(\"Bar\", &findings)))\nfunc ContainElement(element any, result ...any) types.GomegaMatcher {\n\treturn &matchers.ContainElementMatcher{\n\t\tElement: element,\n\t\tResult: result,\n\t}\n}\n\n// BeElementOf succeeds if actual is contained in the passed in elements.\n// BeElementOf() always uses Equal() to perform the match.\n// When the passed in elements are comprised of a single element that is either an Array or Slice, BeElementOf() behaves\n// as the reverse of ContainElement() that operates with Equal() to perform the match.\n//\n//\tExpect(2).Should(BeElementOf([]int{1, 2}))\n//\tExpect(2).Should(BeElementOf([2]int{1, 2}))\n//\n// Otherwise, BeElementOf() provides a syntactic sugar for Or(Equal(_), Equal(_), ...):\n//\n//\tExpect(2).Should(BeElementOf(1, 2))\n//\n// Actual must be typed.\nfunc BeElementOf(elements ...any) types.GomegaMatcher {\n\treturn &matchers.BeElementOfMatcher{\n\t\tElements: elements,\n\t}\n}\n\n// BeKeyOf succeeds if actual is contained in the keys of the passed in map.\n// BeKeyOf() always uses Equal() to perform the match between actual and the map keys.\n//\n//\tExpect(\"foo\").Should(BeKeyOf(map[string]bool{\"foo\": true, \"bar\": false}))\nfunc BeKeyOf(element any) types.GomegaMatcher {\n\treturn &matchers.BeKeyOfMatcher{\n\t\tMap: element,\n\t}\n}\n\n// ConsistOf succeeds if actual contains precisely the elements passed into the matcher. The ordering of the elements does not matter.\n// By default ConsistOf() uses Equal() to match the elements, however custom matchers can be passed in instead. Here are some examples:\n//\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(ConsistOf(\"FooBar\", \"Foo\"))\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(ConsistOf(ContainSubstring(\"Bar\"), \"Foo\"))\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(ConsistOf(ContainSubstring(\"Foo\"), ContainSubstring(\"Foo\")))\n//\n// Actual must be an array, slice or map. For maps, ConsistOf matches against the map's values.\n//\n// You typically pass variadic arguments to ConsistOf (as in the examples above). However, if you need to pass in a slice you can provided that it\n// is the only element passed in to ConsistOf:\n//\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(ConsistOf([]string{\"FooBar\", \"Foo\"}))\n//\n// Note that Go's type system does not allow you to write this as ConsistOf([]string{\"FooBar\", \"Foo\"}...) as []string and []any are different types - hence the need for this special rule.\nfunc ConsistOf(elements ...any) types.GomegaMatcher {\n\treturn &matchers.ConsistOfMatcher{\n\t\tElements: elements,\n\t}\n}\n\n// HaveExactElements succeeds if actual contains elements that precisely match the elements passed into the matcher. The ordering of the elements does matter.\n// By default HaveExactElements() uses Equal() to match the elements, however custom matchers can be passed in instead. Here are some examples:\n//\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(HaveExactElements(\"Foo\", \"FooBar\"))\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(HaveExactElements(\"Foo\", ContainSubstring(\"Bar\")))\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(HaveExactElements(ContainSubstring(\"Foo\"), ContainSubstring(\"Foo\")))\n//\n// Actual must be an array or slice.\nfunc HaveExactElements(elements ...any) types.GomegaMatcher {\n\treturn &matchers.HaveExactElementsMatcher{\n\t\tElements: elements,\n\t}\n}\n\n// ContainElements succeeds if actual contains the passed in elements. The ordering of the elements does not matter.\n// By default ContainElements() uses Equal() to match the elements, however custom matchers can be passed in instead. Here are some examples:\n//\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(ContainElements(\"FooBar\"))\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(ContainElements(ContainSubstring(\"Bar\"), \"Foo\"))\n//\n// Actual must be an array, slice or map.\n// For maps, ContainElements searches through the map's values.\nfunc ContainElements(elements ...any) types.GomegaMatcher {\n\treturn &matchers.ContainElementsMatcher{\n\t\tElements: elements,\n\t}\n}\n\n// HaveEach succeeds if actual solely contains elements that match the passed in element.\n// Please note that if actual is empty, HaveEach always will fail.\n// By default HaveEach() uses Equal() to perform the match, however a\n// matcher can be passed in instead:\n//\n//\tExpect([]string{\"Foo\", \"FooBar\"}).Should(HaveEach(ContainSubstring(\"Foo\")))\n//\n// Actual must be an array, slice or map.\n// For maps, HaveEach searches through the map's values.\nfunc HaveEach(element any) types.GomegaMatcher {\n\treturn &matchers.HaveEachMatcher{\n\t\tElement: element,\n\t}\n}\n\n// HaveKey succeeds if actual is a map with the passed in key.\n// By default HaveKey uses Equal() to perform the match, however a\n// matcher can be passed in instead:\n//\n//\tExpect(map[string]string{\"Foo\": \"Bar\", \"BazFoo\": \"Duck\"}).Should(HaveKey(MatchRegexp(`.+Foo$`)))\nfunc HaveKey(key any) types.GomegaMatcher {\n\treturn &matchers.HaveKeyMatcher{\n\t\tKey: key,\n\t}\n}\n\n// HaveKeyWithValue succeeds if actual is a map with the passed in key and value.\n// By default HaveKeyWithValue uses Equal() to perform the match, however a\n// matcher can be passed in instead:\n//\n//\tExpect(map[string]string{\"Foo\": \"Bar\", \"BazFoo\": \"Duck\"}).Should(HaveKeyWithValue(\"Foo\", \"Bar\"))\n//\tExpect(map[string]string{\"Foo\": \"Bar\", \"BazFoo\": \"Duck\"}).Should(HaveKeyWithValue(MatchRegexp(`.+Foo$`), \"Bar\"))\nfunc HaveKeyWithValue(key any, value any) types.GomegaMatcher {\n\treturn &matchers.HaveKeyWithValueMatcher{\n\t\tKey: key,\n\t\tValue: value,\n\t}\n}\n\n// HaveField succeeds if actual is a struct and the value at the passed in field\n// matches the passed in matcher. By default HaveField used Equal() to perform the match,\n// however a matcher can be passed in in stead.\n//\n// The field must be a string that resolves to the name of a field in the struct. Structs can be traversed\n// using the '.' delimiter. If the field ends with '()' a method named field is assumed to exist on the struct and is invoked.\n// Such methods must take no arguments and return a single value:\n//\n//\ttype Book struct {\n//\t Title string\n//\t Author Person\n//\t}\n//\ttype Person struct {\n//\t FirstName string\n//\t LastName string\n//\t DOB time.Time\n//\t}\n//\tExpect(book).To(HaveField(\"Title\", \"Les Miserables\"))\n//\tExpect(book).To(HaveField(\"Title\", ContainSubstring(\"Les\"))\n//\tExpect(book).To(HaveField(\"Author.FirstName\", Equal(\"Victor\"))\n//\tExpect(book).To(HaveField(\"Author.DOB.Year()\", BeNumerically(\"<\", 1900))\nfunc HaveField(field string, expected any) types.GomegaMatcher {\n\treturn &matchers.HaveFieldMatcher{\n\t\tField: field,\n\t\tExpected: expected,\n\t}\n}\n\n// HaveExistingField succeeds if actual is a struct and the specified field\n// exists.\n//\n// HaveExistingField can be combined with HaveField in order to cover use cases\n// with optional fields. HaveField alone would trigger an error in such situations.\n//\n//\tExpect(MrHarmless).NotTo(And(HaveExistingField(\"Title\"), HaveField(\"Title\", \"Supervillain\")))\nfunc HaveExistingField(field string) types.GomegaMatcher {\n\treturn &matchers.HaveExistingFieldMatcher{\n\t\tField: field,\n\t}\n}\n\n// HaveValue applies the given matcher to the value of actual, optionally and\n// repeatedly dereferencing pointers or taking the concrete value of interfaces.\n// Thus, the matcher will always be applied to non-pointer and non-interface\n// values only. HaveValue will fail with an error if a pointer or interface is\n// nil. It will also fail for more than 31 pointer or interface dereferences to\n// guard against mistakenly applying it to arbitrarily deep linked pointers.\n//\n// HaveValue differs from gstruct.PointTo in that it does not expect actual to\n// be a pointer (as gstruct.PointTo does) but instead also accepts non-pointer\n// and even interface values.\n//\n//\tactual := 42\n//\tExpect(actual).To(HaveValue(Equal(42)))\n//\tExpect(&actual).To(HaveValue(Equal(42)))\nfunc HaveValue(matcher types.GomegaMatcher) types.GomegaMatcher {\n\treturn &matchers.HaveValueMatcher{\n\t\tMatcher: matcher,\n\t}\n}\n\n// BeNumerically performs numerical assertions in a type-agnostic way.\n// Actual and expected should be numbers, though the specific type of\n// number is irrelevant (float32, float64, uint8, etc...).\n//\n// There are six, self-explanatory, supported comparators:\n//\n//\tExpect(1.0).Should(BeNumerically(\"==\", 1))\n//\tExpect(1.0).Should(BeNumerically(\"~\", 0.999, 0.01))\n//\tExpect(1.0).Should(BeNumerically(\">\", 0.9))\n//\tExpect(1.0).Should(BeNumerically(\">=\", 1.0))\n//\tExpect(1.0).Should(BeNumerically(\"<\", 3))\n//\tExpect(1.0).Should(BeNumerically(\"<=\", 1.0))\nfunc BeNumerically(comparator string, compareTo ...any) types.GomegaMatcher {\n\treturn &matchers.BeNumericallyMatcher{\n\t\tComparator: comparator,\n\t\tCompareTo: compareTo,\n\t}\n}\n\n// BeTemporally compares time.Time's like BeNumerically\n// Actual and expected must be time.Time. The comparators are the same as for BeNumerically\n//\n//\tExpect(time.Now()).Should(BeTemporally(\">\", time.Time{}))\n//\tExpect(time.Now()).Should(BeTemporally(\"~\", time.Now(), time.Second))\nfunc BeTemporally(comparator string, compareTo time.Time, threshold ...time.Duration) types.GomegaMatcher {\n\treturn &matchers.BeTemporallyMatcher{\n\t\tComparator: comparator,\n\t\tCompareTo: compareTo,\n\t\tThreshold: threshold,\n\t}\n}\n\n// BeAssignableToTypeOf succeeds if actual is assignable to the type of expected.\n// It will return an error when one of the values is nil.\n//\n//\tExpect(0).Should(BeAssignableToTypeOf(0)) // Same values\n//\tExpect(5).Should(BeAssignableToTypeOf(-1)) // different values same type\n//\tExpect(\"foo\").Should(BeAssignableToTypeOf(\"bar\")) // different values same type\n//\tExpect(struct{ Foo string }{}).Should(BeAssignableToTypeOf(struct{ Foo string }{}))\nfunc BeAssignableToTypeOf(expected any) types.GomegaMatcher {\n\treturn &matchers.AssignableToTypeOfMatcher{\n\t\tExpected: expected,\n\t}\n}\n\n// Panic succeeds if actual is a function that, when invoked, panics.\n// Actual must be a function that takes no arguments and returns no results.\nfunc Panic() types.GomegaMatcher {\n\treturn &matchers.PanicMatcher{}\n}\n\n// PanicWith succeeds if actual is a function that, when invoked, panics with a specific value.\n// Actual must be a function that takes no arguments and returns no results.\n//\n// By default PanicWith uses Equal() to perform the match, however a\n// matcher can be passed in instead:\n//\n//\tExpect(fn).Should(PanicWith(MatchRegexp(`.+Foo$`)))\nfunc PanicWith(expected any) types.GomegaMatcher {\n\treturn &matchers.PanicMatcher{Expected: expected}\n}\n\n// BeAnExistingFile succeeds if a file exists.\n// Actual must be a string representing the abs path to the file being checked.\nfunc BeAnExistingFile() types.GomegaMatcher {\n\treturn &matchers.BeAnExistingFileMatcher{}\n}\n\n// BeARegularFile succeeds if a file exists and is a regular file.\n// Actual must be a string representing the abs path to the file being checked.\nfunc BeARegularFile() types.GomegaMatcher {\n\treturn &matchers.BeARegularFileMatcher{}\n}\n\n// BeADirectory succeeds if a file exists and is a directory.\n// Actual must be a string representing the abs path to the file being checked.\nfunc BeADirectory() types.GomegaMatcher {\n\treturn &matchers.BeADirectoryMatcher{}\n}\n\n// HaveHTTPStatus succeeds if the Status or StatusCode field of an HTTP response matches.\n// Actual must be either a *http.Response or *httptest.ResponseRecorder.\n// Expected must be either an int or a string.\n//\n//\tExpect(resp).Should(HaveHTTPStatus(http.StatusOK)) // asserts that resp.StatusCode == 200\n//\tExpect(resp).Should(HaveHTTPStatus(\"404 Not Found\")) // asserts that resp.Status == \"404 Not Found\"\n//\tExpect(resp).Should(HaveHTTPStatus(http.StatusOK, http.StatusNoContent)) // asserts that resp.StatusCode == 200 || resp.StatusCode == 204\nfunc HaveHTTPStatus(expected ...any) types.GomegaMatcher {\n\treturn &matchers.HaveHTTPStatusMatcher{Expected: expected}\n}\n\n// HaveHTTPHeaderWithValue succeeds if the header is found and the value matches.\n// Actual must be either a *http.Response or *httptest.ResponseRecorder.\n// Expected must be a string header name, followed by a header value which\n// can be a string, or another matcher.\nfunc HaveHTTPHeaderWithValue(header string, value any) types.GomegaMatcher {\n\treturn &matchers.HaveHTTPHeaderWithValueMatcher{\n\t\tHeader: header,\n\t\tValue: value,\n\t}\n}\n\n// HaveHTTPBody matches if the body matches.\n// Actual must be either a *http.Response or *httptest.ResponseRecorder.\n// Expected must be either a string, []byte, or other matcher\nfunc HaveHTTPBody(expected any) types.GomegaMatcher {\n\treturn &matchers.HaveHTTPBodyMatcher{Expected: expected}\n}\n\n// And succeeds only if all of the given matchers succeed.\n// The matchers are tried in order, and will fail-fast if one doesn't succeed.\n//\n//\tExpect(\"hi\").To(And(HaveLen(2), Equal(\"hi\"))\n//\n// And(), Or(), Not() and WithTransform() allow matchers to be composed into complex expressions.\nfunc And(ms ...types.GomegaMatcher) types.GomegaMatcher {\n\treturn &matchers.AndMatcher{Matchers: ms}\n}\n\n// SatisfyAll is an alias for And().\n//\n//\tExpect(\"hi\").Should(SatisfyAll(HaveLen(2), Equal(\"hi\")))\nfunc SatisfyAll(matchers ...types.GomegaMatcher) types.GomegaMatcher {\n\treturn And(matchers...)\n}\n\n// Or succeeds if any of the given matchers succeed.\n// The matchers are tried in order and will return immediately upon the first successful match.\n//\n//\tExpect(\"hi\").To(Or(HaveLen(3), HaveLen(2))\n//\n// And(), Or(), Not() and WithTransform() allow matchers to be composed into complex expressions.\nfunc Or(ms ...types.GomegaMatcher) types.GomegaMatcher {\n\treturn &matchers.OrMatcher{Matchers: ms}\n}\n\n// SatisfyAny is an alias for Or().\n//\n//\tExpect(\"hi\").SatisfyAny(Or(HaveLen(3), HaveLen(2))\nfunc SatisfyAny(matchers ...types.GomegaMatcher) types.GomegaMatcher {\n\treturn Or(matchers...)\n}\n\n// Not negates the given matcher; it succeeds if the given matcher fails.\n//\n//\tExpect(1).To(Not(Equal(2))\n//\n// And(), Or(), Not() and WithTransform() allow matchers to be composed into complex expressions.\nfunc Not(matcher types.GomegaMatcher) types.GomegaMatcher {\n\treturn &matchers.NotMatcher{Matcher: matcher}\n}\n\n// WithTransform applies the `transform` to the actual value and matches it against `matcher`.\n// The given transform must be either a function of one parameter that returns one value or a\n// function of one parameter that returns two values, where the second value must be of the\n// error type.\n//\n//\tvar plus1 = func(i int) int { return i + 1 }\n//\tExpect(1).To(WithTransform(plus1, Equal(2))\n//\n//\t var failingplus1 = func(i int) (int, error) { return 42, \"this does not compute\" }\n//\t Expect(1).To(WithTransform(failingplus1, Equal(2)))\n//\n// And(), Or(), Not() and WithTransform() allow matchers to be composed into complex expressions.\nfunc WithTransform(transform any, matcher types.GomegaMatcher) types.GomegaMatcher {\n\treturn matchers.NewWithTransformMatcher(transform, matcher)\n}\n\n// Satisfy matches the actual value against the `predicate` function.\n// The given predicate must be a function of one parameter that returns bool.\n//\n//\tvar isEven = func(i int) bool { return i%2 == 0 }\n//\tExpect(2).To(Satisfy(isEven))\nfunc Satisfy(predicate any) types.GomegaMatcher {\n\treturn matchers.NewSatisfyMatcher(predicate)\n}\n"
},
{
"path": "tests/vendor/github.com/onsi/gomega/types/types.go",
"content": "package types\n\nimport (\n\t\"context\"\n\t\"time\"\n)\n\ntype GomegaFailHandler func(message string, callerSkip ...int)\n\n// A simple *testing.T interface wrapper\ntype GomegaTestingT interface {\n\tHelper()\n\tFatalf(format string, args ...any)\n}\n\n// Gomega represents an object that can perform synchronous and asynchronous assertions with Gomega matchers\ntype Gomega interface {\n\tΩ(actual any, extra ...any) Assertion\n\tExpect(actual any, extra ...any) Assertion\n\tExpectWithOffset(offset int, actual any, extra ...any) Assertion\n\n\tEventually(actualOrCtx any, args ...any) AsyncAssertion\n\tEventuallyWithOffset(offset int, actualOrCtx any, args ...any) AsyncAssertion\n\n\tConsistently(actualOrCtx any, args ...any) AsyncAssertion\n\tConsistentlyWithOffset(offset int, actualOrCtx any, args ...any) AsyncAssertion\n\n\tSetDefaultEventuallyTimeout(time.Duration)\n\tSetDefaultEventuallyPollingInterval(time.Duration)\n\tSetDefaultConsistentlyDuration(time.Duration)\n\tSetDefaultConsistentlyPollingInterval(time.Duration)\n\tEnforceDefaultTimeoutsWhenUsingContexts()\n\tDisableDefaultTimeoutsWhenUsingContext()\n}\n\n// All Gomega matchers must implement the GomegaMatcher interface\n//\n// For details on writing custom matchers, check out: http://onsi.github.io/gomega/#adding-your-own-matchers\ntype GomegaMatcher interface {\n\tMatch(actual any) (success bool, err error)\n\tFailureMessage(actual any) (message string)\n\tNegatedFailureMessage(actual any) (message string)\n}\n\n/*\nGomegaMatchers that also match the OracleMatcher interface can convey information about\nwhether or not their result will change upon future attempts.\n\nThis allows `Eventually` and `Consistently` to short circuit if success becomes impossible.\n\nFor example, a process' exit code can never change. So, gexec's Exit matcher returns `true`\nfor `MatchMayChangeInTheFuture` until the process exits, at which point it returns `false` forevermore.\n*/\ntype OracleMatcher interface {\n\tMatchMayChangeInTheFuture(actual any) bool\n}\n\nfunc MatchMayChangeInTheFuture(matcher GomegaMatcher, value any) bool {\n\toracleMatcher, ok := matcher.(OracleMatcher)\n\tif !ok {\n\t\treturn true\n\t}\n\n\treturn oracleMatcher.MatchMayChangeInTheFuture(value)\n}\n\n// AsyncAssertions are returned by Eventually and Consistently and enable matchers to be polled repeatedly to ensure\n// they are eventually satisfied\ntype AsyncAssertion interface {\n\tShould(matcher GomegaMatcher, optionalDescription ...any) bool\n\tShouldNot(matcher GomegaMatcher, optionalDescription ...any) bool\n\n\t// equivalent to above\n\tTo(matcher GomegaMatcher, optionalDescription ...any) bool\n\tToNot(matcher GomegaMatcher, optionalDescription ...any) bool\n\tNotTo(matcher GomegaMatcher, optionalDescription ...any) bool\n\n\tWithOffset(offset int) AsyncAssertion\n\tWithTimeout(interval time.Duration) AsyncAssertion\n\tWithPolling(interval time.Duration) AsyncAssertion\n\tWithin(timeout time.Duration) AsyncAssertion\n\tProbeEvery(interval time.Duration) AsyncAssertion\n\tWithContext(ctx context.Context) AsyncAssertion\n\tWithArguments(argsToForward ...any) AsyncAssertion\n\tMustPassRepeatedly(count int) AsyncAssertion\n}\n\n// Assertions are returned by Ω and Expect and enable assertions against Gomega matchers\ntype Assertion interface {\n\tShould(matcher GomegaMatcher, optionalDescription ...any) bool\n\tShouldNot(matcher GomegaMatcher, optionalDescription ...any) bool\n\n\tTo(matcher GomegaMatcher, optionalDescription ...any) bool\n\tToNot(matcher GomegaMatcher, optionalDescription ...any) bool\n\tNotTo(matcher GomegaMatcher, optionalDescription ...any) bool\n\n\tWithOffset(offset int) Assertion\n\n\tError() Assertion\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/.dockerignore",
"content": "cmd/tomll/tomll\ncmd/tomljson/tomljson\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/.gitignore",
"content": "test_program/test_program_bin\nfuzz/\ncmd/tomll/tomll\ncmd/tomljson/tomljson\ncmd/tomltestgen/tomltestgen\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/CONTRIBUTING.md",
"content": "## Contributing\n\nThank you for your interest in go-toml! We appreciate you considering\ncontributing to go-toml!\n\nThe main goal is the project is to provide an easy-to-use TOML\nimplementation for Go that gets the job done and gets out of your way –\ndealing with TOML is probably not the central piece of your project.\n\nAs the single maintainer of go-toml, time is scarce. All help, big or\nsmall, is more than welcomed!\n\n### Ask questions\n\nAny question you may have, somebody else might have it too. Always feel\nfree to ask them on the [issues tracker][issues-tracker]. We will try to\nanswer them as clearly and quickly as possible, time permitting.\n\nAsking questions also helps us identify areas where the documentation needs\nimprovement, or new features that weren't envisioned before. Sometimes, a\nseemingly innocent question leads to the fix of a bug. Don't hesitate and\nask away!\n\n### Improve the documentation\n\nThe best way to share your knowledge and experience with go-toml is to\nimprove the documentation. Fix a typo, clarify an interface, add an\nexample, anything goes!\n\nThe documentation is present in the [README][readme] and thorough the\nsource code. On release, it gets updated on [pkg.go.dev][pkg.go.dev]. To make a\nchange to the documentation, create a pull request with your proposed\nchanges. For simple changes like that, the easiest way to go is probably\nthe \"Fork this project and edit the file\" button on Github, displayed at\nthe top right of the file. Unless it's a trivial change (for example a\ntypo), provide a little bit of context in your pull request description or\ncommit message.\n\n### Report a bug\n\nFound a bug! Sorry to hear that :(. Help us and other track them down and\nfix by reporting it. [File a new bug report][bug-report] on the [issues\ntracker][issues-tracker]. The template should provide enough guidance on\nwhat to include. When in doubt: add more details! By reducing ambiguity and\nproviding more information, it decreases back and forth and saves everyone\ntime.\n\n### Code changes\n\nWant to contribute a patch? Very happy to hear that!\n\nFirst, some high-level rules:\n\n* A short proposal with some POC code is better than a lengthy piece of\n text with no code. Code speaks louder than words.\n* No backward-incompatible patch will be accepted unless discussed.\n Sometimes it's hard, and Go's lack of versioning by default does not\n help, but we try not to break people's programs unless we absolutely have\n to.\n* If you are writing a new feature or extending an existing one, make sure\n to write some documentation.\n* Bug fixes need to be accompanied with regression tests.\n* New code needs to be tested.\n* Your commit messages need to explain why the change is needed, even if\n already included in the PR description.\n\nIt does sound like a lot, but those best practices are here to save time\noverall and continuously improve the quality of the project, which is\nsomething everyone benefits from.\n\n#### Get started\n\nThe fairly standard code contribution process looks like that:\n\n1. [Fork the project][fork].\n2. Make your changes, commit on any branch you like.\n3. [Open up a pull request][pull-request]\n4. Review, potential ask for changes.\n5. Merge. You're in!\n\nFeel free to ask for help! You can create draft pull requests to gather\nsome early feedback!\n\n#### Run the tests\n\nYou can run tests for go-toml using Go's test tool: `go test ./...`.\nWhen creating a pull requests, all tests will be ran on Linux on a few Go\nversions (Travis CI), and on Windows using the latest Go version\n(AppVeyor).\n\n#### Style\n\nTry to look around and follow the same format and structure as the rest of\nthe code. We enforce using `go fmt` on the whole code base.\n\n---\n\n### Maintainers-only\n\n#### Merge pull request\n\nChecklist:\n\n* Passing CI.\n* Does not introduce backward-incompatible changes (unless discussed).\n* Has relevant doc changes.\n* Has relevant unit tests.\n\n1. Merge using \"squash and merge\".\n2. Make sure to edit the commit message to keep all the useful information\n nice and clean.\n3. Make sure the commit title is clear and contains the PR number (#123).\n\n#### New release\n\n1. Go to [releases][releases]. Click on \"X commits to master since this\n release\".\n2. Make note of all the changes. Look for backward incompatible changes,\n new features, and bug fixes.\n3. Pick the new version using the above and semver.\n4. Create a [new release][new-release].\n5. Follow the same format as [1.1.0][release-110].\n\n[issues-tracker]: https://github.com/pelletier/go-toml/issues\n[bug-report]: https://github.com/pelletier/go-toml/issues/new?template=bug_report.md\n[pkg.go.dev]: https://pkg.go.dev/github.com/pelletier/go-toml\n[readme]: ./README.md\n[fork]: https://help.github.com/articles/fork-a-repo\n[pull-request]: https://help.github.com/en/articles/creating-a-pull-request\n[releases]: https://github.com/pelletier/go-toml/releases\n[new-release]: https://github.com/pelletier/go-toml/releases/new\n[release-110]: https://github.com/pelletier/go-toml/releases/tag/v1.1.0\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/Dockerfile",
"content": "FROM golang:1.12-alpine3.9 as builder\nWORKDIR /go/src/github.com/pelletier/go-toml\nCOPY . .\nENV CGO_ENABLED=0\nENV GOOS=linux\nRUN go install ./...\n\nFROM scratch\nCOPY --from=builder /go/bin/tomll /usr/bin/tomll\nCOPY --from=builder /go/bin/tomljson /usr/bin/tomljson\nCOPY --from=builder /go/bin/jsontoml /usr/bin/jsontoml\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/LICENSE",
"content": "The bulk of github.com/pelletier/go-toml is distributed under the MIT license\n(see below), with the exception of localtime.go and localtime.test.go.\nThose two files have been copied over from Google's civil library at revision\ned46f5086358513cf8c25f8e3f022cb838a49d66, and are distributed under the Apache\n2.0 license (see below).\n\n\ngithub.com/pelletier/go-toml:\n\n\nThe MIT License (MIT)\n\nCopyright (c) 2013 - 2021 Thomas Pelletier, Eric Anderton\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\nlocaltime.go, localtime_test.go:\n\nOriginals:\n https://raw.githubusercontent.com/googleapis/google-cloud-go/ed46f5086358513cf8c25f8e3f022cb838a49d66/civil/civil.go\n https://raw.githubusercontent.com/googleapis/google-cloud-go/ed46f5086358513cf8c25f8e3f022cb838a49d66/civil/civil_test.go\nChanges:\n * Renamed files from civil* to localtime*.\n * Package changed from civil to toml.\n * 'Local' prefix added to all structs.\nLicense:\n https://raw.githubusercontent.com/googleapis/google-cloud-go/ed46f5086358513cf8c25f8e3f022cb838a49d66/LICENSE\n\n\n Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/Makefile",
"content": "export CGO_ENABLED=0\ngo := go\ngo.goos ?= $(shell echo `go version`|cut -f4 -d ' '|cut -d '/' -f1)\ngo.goarch ?= $(shell echo `go version`|cut -f4 -d ' '|cut -d '/' -f2)\n\nout.tools := tomll tomljson jsontoml\nout.dist := $(out.tools:=_$(go.goos)_$(go.goarch).tar.xz)\nsources := $(wildcard **/*.go)\n\n\n.PHONY:\ntools: $(out.tools)\n\n$(out.tools): $(sources)\n\tGOOS=$(go.goos) GOARCH=$(go.goarch) $(go) build ./cmd/$@\n\n.PHONY:\ndist: $(out.dist)\n\n$(out.dist):%_$(go.goos)_$(go.goarch).tar.xz: %\n\tif [ \"$(go.goos)\" = \"windows\" ]; then \\\n\t\ttar -cJf $@ $^.exe; \\\n\telse \\\n\t\ttar -cJf $@ $^; \\\n\tfi\n\n.PHONY:\nclean:\n\trm -rf $(out.tools) $(out.dist)\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/PULL_REQUEST_TEMPLATE.md",
"content": "**Issue:** add link to pelletier/go-toml issue here\n\nExplanation of what this pull request does.\n\nMore detailed description of the decisions being made and the reasons why (if the patch is non-trivial).\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/README.md",
"content": "# go-toml\n\nGo library for the [TOML](https://toml.io/) format.\n\nThis library supports TOML version\n[v1.0.0-rc.3](https://toml.io/en/v1.0.0-rc.3)\n\n[](https://pkg.go.dev/github.com/pelletier/go-toml)\n[](https://github.com/pelletier/go-toml/blob/master/LICENSE)\n[](https://dev.azure.com/pelletierthomas/go-toml-ci/_build/latest?definitionId=1&branchName=master)\n[](https://codecov.io/gh/pelletier/go-toml)\n[](https://goreportcard.com/report/github.com/pelletier/go-toml)\n[](https://app.fossa.io/projects/git%2Bgithub.com%2Fpelletier%2Fgo-toml?ref=badge_shield)\n\n\n## Development status\n\n**ℹ️ Consider go-toml v2!**\n\nThe next version of go-toml is in [active development][v2-dev], and\n[nearing completion][v2-map].\n\nThough technically in beta, v2 is already more tested, [fixes bugs][v1-bugs],\nand [much faster][v2-bench]. If you only need reading and writing TOML documents\n(majority of cases), those features are implemented and the API unlikely to\nchange.\n\nThe remaining features will be added shortly. While pull-requests are welcome on\nv1, no active development is expected on it. When v2.0.0 is released, v1 will be\ndeprecated.\n\n👉 [go-toml v2][v2]\n\n[v2]: https://github.com/pelletier/go-toml/tree/v2\n[v2-map]: https://github.com/pelletier/go-toml/discussions/506\n[v2-dev]: https://github.com/pelletier/go-toml/tree/v2\n[v1-bugs]: https://github.com/pelletier/go-toml/issues?q=is%3Aissue+is%3Aopen+label%3Av2-fixed\n[v2-bench]: https://github.com/pelletier/go-toml/tree/v2#benchmarks\n\n## Features\n\nGo-toml provides the following features for using data parsed from TOML documents:\n\n* Load TOML documents from files and string data\n* Easily navigate TOML structure using Tree\n* Marshaling and unmarshaling to and from data structures\n* Line & column position data for all parsed elements\n* [Query support similar to JSON-Path](query/)\n* Syntax errors contain line and column numbers\n\n## Import\n\n```go\nimport \"github.com/pelletier/go-toml\"\n```\n\n## Usage example\n\nRead a TOML document:\n\n```go\nconfig, _ := toml.Load(`\n[postgres]\nuser = \"pelletier\"\npassword = \"mypassword\"`)\n// retrieve data directly\nuser := config.Get(\"postgres.user\").(string)\n\n// or using an intermediate object\npostgresConfig := config.Get(\"postgres\").(*toml.Tree)\npassword := postgresConfig.Get(\"password\").(string)\n```\n\nOr use Unmarshal:\n\n```go\ntype Postgres struct {\n User string\n Password string\n}\ntype Config struct {\n Postgres Postgres\n}\n\ndoc := []byte(`\n[Postgres]\nUser = \"pelletier\"\nPassword = \"mypassword\"`)\n\nconfig := Config{}\ntoml.Unmarshal(doc, &config)\nfmt.Println(\"user=\", config.Postgres.User)\n```\n\nOr use a query:\n\n```go\n// use a query to gather elements without walking the tree\nq, _ := query.Compile(\"$..[user,password]\")\nresults := q.Execute(config)\nfor ii, item := range results.Values() {\n fmt.Printf(\"Query result %d: %v\\n\", ii, item)\n}\n```\n\n## Documentation\n\nThe documentation and additional examples are available at\n[pkg.go.dev](https://pkg.go.dev/github.com/pelletier/go-toml).\n\n## Tools\n\nGo-toml provides three handy command line tools:\n\n* `tomll`: Reads TOML files and lints them.\n\n ```\n go install github.com/pelletier/go-toml/cmd/tomll\n tomll --help\n ```\n* `tomljson`: Reads a TOML file and outputs its JSON representation.\n\n ```\n go install github.com/pelletier/go-toml/cmd/tomljson\n tomljson --help\n ```\n\n * `jsontoml`: Reads a JSON file and outputs a TOML representation.\n\n ```\n go install github.com/pelletier/go-toml/cmd/jsontoml\n jsontoml --help\n ```\n\n### Docker image\n\nThose tools are also available as a Docker image from\n[dockerhub](https://hub.docker.com/r/pelletier/go-toml). For example, to\nuse `tomljson`:\n\n```\ndocker run -v $PWD:/workdir pelletier/go-toml tomljson /workdir/example.toml\n```\n\nOnly master (`latest`) and tagged versions are published to dockerhub. You\ncan build your own image as usual:\n\n```\ndocker build -t go-toml .\n```\n\n## Contribute\n\nFeel free to report bugs and patches using GitHub's pull requests system on\n[pelletier/go-toml](https://github.com/pelletier/go-toml). Any feedback would be\nmuch appreciated!\n\n### Run tests\n\n`go test ./...`\n\n### Fuzzing\n\nThe script `./fuzz.sh` is available to\nrun [go-fuzz](https://github.com/dvyukov/go-fuzz) on go-toml.\n\n## Versioning\n\nGo-toml follows [Semantic Versioning](http://semver.org/). The supported version\nof [TOML](https://github.com/toml-lang/toml) is indicated at the beginning of\nthis document. The last two major versions of Go are supported\n(see [Go Release Policy](https://golang.org/doc/devel/release.html#policy)).\n\n## License\n\nThe MIT License (MIT) + Apache 2.0. Read [LICENSE](LICENSE).\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/SECURITY.md",
"content": "# Security Policy\n\n## Supported Versions\n\nUse this section to tell people about which versions of your project are\ncurrently being supported with security updates.\n\n| Version | Supported |\n| ---------- | ------------------ |\n| Latest 2.x | :white_check_mark: |\n| All 1.x | :x: |\n| All 0.x | :x: |\n\n## Reporting a Vulnerability\n\nEmail a vulnerability report to `security@pelletier.codes`. Make sure to include\nas many details as possible to reproduce the vulnerability. This is a\nside-project: I will try to get back to you as quickly as possible, time\npermitting in my personal life. Providing a working patch helps very much!\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/azure-pipelines.yml",
"content": "trigger:\n- master\n\nstages:\n- stage: run_checks\n displayName: \"Check\"\n dependsOn: []\n jobs:\n - job: fmt\n displayName: \"fmt\"\n pool:\n vmImage: ubuntu-latest\n steps:\n - task: GoTool@0\n displayName: \"Install Go 1.16\"\n inputs:\n version: \"1.16\"\n - task: Go@0\n displayName: \"go fmt ./...\"\n inputs:\n command: 'custom'\n customCommand: 'fmt'\n arguments: './...'\n - job: coverage\n displayName: \"coverage\"\n pool:\n vmImage: ubuntu-latest\n steps:\n - task: GoTool@0\n displayName: \"Install Go 1.16\"\n inputs:\n version: \"1.16\"\n - task: Go@0\n displayName: \"Generate coverage\"\n inputs:\n command: 'test'\n arguments: \"-race -coverprofile=coverage.txt -covermode=atomic\"\n - task: Bash@3\n inputs:\n targetType: 'inline'\n script: 'bash <(curl -s https://codecov.io/bash) -t ${CODECOV_TOKEN}'\n env:\n CODECOV_TOKEN: $(CODECOV_TOKEN)\n - job: benchmark\n displayName: \"benchmark\"\n pool:\n vmImage: ubuntu-latest\n steps:\n - task: GoTool@0\n displayName: \"Install Go 1.16\"\n inputs:\n version: \"1.16\"\n - script: echo \"##vso[task.setvariable variable=PATH]${PATH}:/home/vsts/go/bin/\"\n - task: Bash@3\n inputs:\n filePath: './benchmark.sh'\n arguments: \"master $(Build.Repository.Uri)\"\n\n - job: go_unit_tests\n displayName: \"unit tests\"\n strategy:\n matrix:\n linux 1.16:\n goVersion: '1.16'\n imageName: 'ubuntu-latest'\n mac 1.16:\n goVersion: '1.16'\n imageName: 'macOS-latest'\n windows 1.16:\n goVersion: '1.16'\n imageName: 'windows-latest'\n linux 1.15:\n goVersion: '1.15'\n imageName: 'ubuntu-latest'\n mac 1.15:\n goVersion: '1.15'\n imageName: 'macOS-latest'\n windows 1.15:\n goVersion: '1.15'\n imageName: 'windows-latest'\n pool:\n vmImage: $(imageName)\n steps:\n - task: GoTool@0\n displayName: \"Install Go $(goVersion)\"\n inputs:\n version: $(goVersion)\n - task: Go@0\n displayName: \"go test ./...\"\n inputs:\n command: 'test'\n arguments: './...'\n- stage: build_binaries\n displayName: \"Build binaries\"\n dependsOn: run_checks\n jobs:\n - job: build_binary\n displayName: \"Build binary\"\n strategy:\n matrix:\n linux_amd64:\n GOOS: linux\n GOARCH: amd64\n darwin_amd64:\n GOOS: darwin\n GOARCH: amd64\n windows_amd64:\n GOOS: windows\n GOARCH: amd64\n pool:\n vmImage: ubuntu-latest\n steps:\n - task: GoTool@0\n displayName: \"Install Go\"\n inputs:\n version: 1.16\n - task: Bash@3\n inputs:\n targetType: inline\n script: \"make dist\"\n env:\n go.goos: $(GOOS)\n go.goarch: $(GOARCH)\n - task: CopyFiles@2\n inputs:\n sourceFolder: '$(Build.SourcesDirectory)'\n contents: '*.tar.xz'\n TargetFolder: '$(Build.ArtifactStagingDirectory)'\n - task: PublishBuildArtifacts@1\n inputs:\n pathtoPublish: '$(Build.ArtifactStagingDirectory)'\n artifactName: binaries\n- stage: build_binaries_manifest\n displayName: \"Build binaries manifest\"\n dependsOn: build_binaries\n jobs:\n - job: build_manifest\n displayName: \"Build binaries manifest\"\n steps:\n - task: DownloadBuildArtifacts@0\n inputs:\n buildType: 'current'\n downloadType: 'single'\n artifactName: 'binaries'\n downloadPath: '$(Build.SourcesDirectory)'\n - task: Bash@3\n inputs:\n targetType: inline\n script: \"cd binaries && sha256sum --binary *.tar.xz | tee $(Build.ArtifactStagingDirectory)/sha256sums.txt\"\n - task: PublishBuildArtifacts@1\n inputs:\n pathtoPublish: '$(Build.ArtifactStagingDirectory)'\n artifactName: manifest\n\n- stage: build_docker_image\n displayName: \"Build Docker image\"\n dependsOn: run_checks\n jobs:\n - job: build\n displayName: \"Build\"\n pool:\n vmImage: ubuntu-latest\n steps:\n - task: Docker@2\n inputs:\n command: 'build'\n Dockerfile: 'Dockerfile'\n buildContext: '.'\n addPipelineData: false\n\n- stage: publish_docker_image\n displayName: \"Publish Docker image\"\n dependsOn: build_docker_image\n condition: and(succeeded(), eq(variables['Build.SourceBranchName'], 'master'))\n jobs:\n - job: publish\n displayName: \"Publish\"\n pool:\n vmImage: ubuntu-latest\n steps:\n - task: Docker@2\n inputs:\n containerRegistry: 'DockerHub'\n repository: 'pelletier/go-toml'\n command: 'buildAndPush'\n Dockerfile: 'Dockerfile'\n buildContext: '.'\n tags: 'latest'\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/benchmark.sh",
"content": "#!/bin/bash\n\nset -ex\n\nreference_ref=${1:-master}\nreference_git=${2:-.}\n\nif ! `hash benchstat 2>/dev/null`; then\n echo \"Installing benchstat\"\n go get golang.org/x/perf/cmd/benchstat\nfi\n\ntempdir=`mktemp -d /tmp/go-toml-benchmark-XXXXXX`\nref_tempdir=\"${tempdir}/ref\"\nref_benchmark=\"${ref_tempdir}/benchmark-`echo -n ${reference_ref}|tr -s '/' '-'`.txt\"\nlocal_benchmark=\"`pwd`/benchmark-local.txt\"\n\necho \"=== ${reference_ref} (${ref_tempdir})\"\ngit clone ${reference_git} ${ref_tempdir} >/dev/null 2>/dev/null\npushd ${ref_tempdir} >/dev/null\ngit checkout ${reference_ref} >/dev/null 2>/dev/null\ngo test -bench=. -benchmem | tee ${ref_benchmark}\ncd benchmark\ngo test -bench=. -benchmem | tee -a ${ref_benchmark}\npopd >/dev/null\n\necho \"\"\necho \"=== local\"\ngo test -bench=. -benchmem | tee ${local_benchmark}\ncd benchmark\ngo test -bench=. -benchmem | tee -a ${local_benchmark}\n\necho \"\"\necho \"=== diff\"\nbenchstat -delta-test=none ${ref_benchmark} ${local_benchmark}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/doc.go",
"content": "// Package toml is a TOML parser and manipulation library.\n//\n// This version supports the specification as described in\n// https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md\n//\n// Marshaling\n//\n// Go-toml can marshal and unmarshal TOML documents from and to data\n// structures.\n//\n// TOML document as a tree\n//\n// Go-toml can operate on a TOML document as a tree. Use one of the Load*\n// functions to parse TOML data and obtain a Tree instance, then one of its\n// methods to manipulate the tree.\n//\n// JSONPath-like queries\n//\n// The package github.com/pelletier/go-toml/query implements a system\n// similar to JSONPath to quickly retrieve elements of a TOML document using a\n// single expression. See the package documentation for more information.\n//\npackage toml\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/example-crlf.toml",
"content": "# This is a TOML document. Boom.\r\n\r\ntitle = \"TOML Example\"\r\n\r\n[owner]\r\nname = \"Tom Preston-Werner\"\r\norganization = \"GitHub\"\r\nbio = \"GitHub Cofounder & CEO\\nLikes tater tots and beer.\"\r\ndob = 1979-05-27T07:32:00Z # First class dates? Why not?\r\n\r\n[database]\r\nserver = \"192.168.1.1\"\r\nports = [ 8001, 8001, 8002 ]\r\nconnection_max = 5000\r\nenabled = true\r\n\r\n[servers]\r\n\r\n # You can indent as you please. Tabs or spaces. TOML don't care.\r\n [servers.alpha]\r\n ip = \"10.0.0.1\"\r\n dc = \"eqdc10\"\r\n\r\n [servers.beta]\r\n ip = \"10.0.0.2\"\r\n dc = \"eqdc10\"\r\n\r\n[clients]\r\ndata = [ [\"gamma\", \"delta\"], [1, 2] ] # just an update to make sure parsers support it\r\nscore = 4e-08 # to make sure leading zeroes in exponent parts of floats are supported"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/example.toml",
"content": "# This is a TOML document. Boom.\n\ntitle = \"TOML Example\"\n\n[owner]\nname = \"Tom Preston-Werner\"\norganization = \"GitHub\"\nbio = \"GitHub Cofounder & CEO\\nLikes tater tots and beer.\"\ndob = 1979-05-27T07:32:00Z # First class dates? Why not?\n\n[database]\nserver = \"192.168.1.1\"\nports = [ 8001, 8001, 8002 ]\nconnection_max = 5000\nenabled = true\n\n[servers]\n\n # You can indent as you please. Tabs or spaces. TOML don't care.\n [servers.alpha]\n ip = \"10.0.0.1\"\n dc = \"eqdc10\"\n\n [servers.beta]\n ip = \"10.0.0.2\"\n dc = \"eqdc10\"\n\n[clients]\ndata = [ [\"gamma\", \"delta\"], [1, 2] ] # just an update to make sure parsers support it\nscore = 4e-08 # to make sure leading zeroes in exponent parts of floats are supported"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/fuzz.go",
"content": "// +build gofuzz\n\npackage toml\n\nfunc Fuzz(data []byte) int {\n\ttree, err := LoadBytes(data)\n\tif err != nil {\n\t\tif tree != nil {\n\t\t\tpanic(\"tree must be nil if there is an error\")\n\t\t}\n\t\treturn 0\n\t}\n\n\tstr, err := tree.ToTomlString()\n\tif err != nil {\n\t\tif str != \"\" {\n\t\t\tpanic(`str must be \"\" if there is an error`)\n\t\t}\n\t\tpanic(err)\n\t}\n\n\ttree, err = Load(str)\n\tif err != nil {\n\t\tif tree != nil {\n\t\t\tpanic(\"tree must be nil if there is an error\")\n\t\t}\n\t\treturn 0\n\t}\n\n\treturn 1\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/fuzz.sh",
"content": "#! /bin/sh\nset -eu\n\ngo get github.com/dvyukov/go-fuzz/go-fuzz\ngo get github.com/dvyukov/go-fuzz/go-fuzz-build\n\nif [ ! -e toml-fuzz.zip ]; then\n go-fuzz-build github.com/pelletier/go-toml\nfi\n\nrm -fr fuzz\nmkdir -p fuzz/corpus\ncp *.toml fuzz/corpus\n\ngo-fuzz -bin=toml-fuzz.zip -workdir=fuzz\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/keysparsing.go",
"content": "// Parsing keys handling both bare and quoted keys.\n\npackage toml\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n)\n\n// Convert the bare key group string to an array.\n// The input supports double quotation and single quotation,\n// but escape sequences are not supported. Lexers must unescape them beforehand.\nfunc parseKey(key string) ([]string, error) {\n\trunes := []rune(key)\n\tvar groups []string\n\n\tif len(key) == 0 {\n\t\treturn nil, errors.New(\"empty key\")\n\t}\n\n\tidx := 0\n\tfor idx < len(runes) {\n\t\tfor ; idx < len(runes) && isSpace(runes[idx]); idx++ {\n\t\t\t// skip leading whitespace\n\t\t}\n\t\tif idx >= len(runes) {\n\t\t\tbreak\n\t\t}\n\t\tr := runes[idx]\n\t\tif isValidBareChar(r) {\n\t\t\t// parse bare key\n\t\t\tstartIdx := idx\n\t\t\tendIdx := -1\n\t\t\tidx++\n\t\t\tfor idx < len(runes) {\n\t\t\t\tr = runes[idx]\n\t\t\t\tif isValidBareChar(r) {\n\t\t\t\t\tidx++\n\t\t\t\t} else if r == '.' {\n\t\t\t\t\tendIdx = idx\n\t\t\t\t\tbreak\n\t\t\t\t} else if isSpace(r) {\n\t\t\t\t\tendIdx = idx\n\t\t\t\t\tfor ; idx < len(runes) && isSpace(runes[idx]); idx++ {\n\t\t\t\t\t\t// skip trailing whitespace\n\t\t\t\t\t}\n\t\t\t\t\tif idx < len(runes) && runes[idx] != '.' {\n\t\t\t\t\t\treturn nil, fmt.Errorf(\"invalid key character after whitespace: %c\", runes[idx])\n\t\t\t\t\t}\n\t\t\t\t\tbreak\n\t\t\t\t} else {\n\t\t\t\t\treturn nil, fmt.Errorf(\"invalid bare key character: %c\", r)\n\t\t\t\t}\n\t\t\t}\n\t\t\tif endIdx == -1 {\n\t\t\t\tendIdx = idx\n\t\t\t}\n\t\t\tgroups = append(groups, string(runes[startIdx:endIdx]))\n\t\t} else if r == '\\'' {\n\t\t\t// parse single quoted key\n\t\t\tidx++\n\t\t\tstartIdx := idx\n\t\t\tfor {\n\t\t\t\tif idx >= len(runes) {\n\t\t\t\t\treturn nil, fmt.Errorf(\"unclosed single-quoted key\")\n\t\t\t\t}\n\t\t\t\tr = runes[idx]\n\t\t\t\tif r == '\\'' {\n\t\t\t\t\tgroups = append(groups, string(runes[startIdx:idx]))\n\t\t\t\t\tidx++\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tidx++\n\t\t\t}\n\t\t} else if r == '\"' {\n\t\t\t// parse double quoted key\n\t\t\tidx++\n\t\t\tstartIdx := idx\n\t\t\tfor {\n\t\t\t\tif idx >= len(runes) {\n\t\t\t\t\treturn nil, fmt.Errorf(\"unclosed double-quoted key\")\n\t\t\t\t}\n\t\t\t\tr = runes[idx]\n\t\t\t\tif r == '\"' {\n\t\t\t\t\tgroups = append(groups, string(runes[startIdx:idx]))\n\t\t\t\t\tidx++\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tidx++\n\t\t\t}\n\t\t} else if r == '.' {\n\t\t\tidx++\n\t\t\tif idx >= len(runes) {\n\t\t\t\treturn nil, fmt.Errorf(\"unexpected end of key\")\n\t\t\t}\n\t\t\tr = runes[idx]\n\t\t\tif !isValidBareChar(r) && r != '\\'' && r != '\"' && r != ' ' {\n\t\t\t\treturn nil, fmt.Errorf(\"expecting key part after dot\")\n\t\t\t}\n\t\t} else {\n\t\t\treturn nil, fmt.Errorf(\"invalid key character: %c\", r)\n\t\t}\n\t}\n\tif len(groups) == 0 {\n\t\treturn nil, fmt.Errorf(\"empty key\")\n\t}\n\treturn groups, nil\n}\n\nfunc isValidBareChar(r rune) bool {\n\treturn isAlphanumeric(r) || r == '-' || isDigit(r)\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/lexer.go",
"content": "// TOML lexer.\n//\n// Written using the principles developed by Rob Pike in\n// http://www.youtube.com/watch?v=HxaD_trXwRE\n\npackage toml\n\nimport (\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\t\"strconv\"\n\t\"strings\"\n)\n\n// Define state functions\ntype tomlLexStateFn func() tomlLexStateFn\n\n// Define lexer\ntype tomlLexer struct {\n\tinputIdx int\n\tinput []rune // Textual source\n\tcurrentTokenStart int\n\tcurrentTokenStop int\n\ttokens []token\n\tbrackets []rune\n\tline int\n\tcol int\n\tendbufferLine int\n\tendbufferCol int\n}\n\n// Basic read operations on input\n\nfunc (l *tomlLexer) read() rune {\n\tr := l.peek()\n\tif r == '\\n' {\n\t\tl.endbufferLine++\n\t\tl.endbufferCol = 1\n\t} else {\n\t\tl.endbufferCol++\n\t}\n\tl.inputIdx++\n\treturn r\n}\n\nfunc (l *tomlLexer) next() rune {\n\tr := l.read()\n\n\tif r != eof {\n\t\tl.currentTokenStop++\n\t}\n\treturn r\n}\n\nfunc (l *tomlLexer) ignore() {\n\tl.currentTokenStart = l.currentTokenStop\n\tl.line = l.endbufferLine\n\tl.col = l.endbufferCol\n}\n\nfunc (l *tomlLexer) skip() {\n\tl.next()\n\tl.ignore()\n}\n\nfunc (l *tomlLexer) fastForward(n int) {\n\tfor i := 0; i < n; i++ {\n\t\tl.next()\n\t}\n}\n\nfunc (l *tomlLexer) emitWithValue(t tokenType, value string) {\n\tl.tokens = append(l.tokens, token{\n\t\tPosition: Position{l.line, l.col},\n\t\ttyp: t,\n\t\tval: value,\n\t})\n\tl.ignore()\n}\n\nfunc (l *tomlLexer) emit(t tokenType) {\n\tl.emitWithValue(t, string(l.input[l.currentTokenStart:l.currentTokenStop]))\n}\n\nfunc (l *tomlLexer) peek() rune {\n\tif l.inputIdx >= len(l.input) {\n\t\treturn eof\n\t}\n\treturn l.input[l.inputIdx]\n}\n\nfunc (l *tomlLexer) peekString(size int) string {\n\tmaxIdx := len(l.input)\n\tupperIdx := l.inputIdx + size // FIXME: potential overflow\n\tif upperIdx > maxIdx {\n\t\tupperIdx = maxIdx\n\t}\n\treturn string(l.input[l.inputIdx:upperIdx])\n}\n\nfunc (l *tomlLexer) follow(next string) bool {\n\treturn next == l.peekString(len(next))\n}\n\n// Error management\n\nfunc (l *tomlLexer) errorf(format string, args ...interface{}) tomlLexStateFn {\n\tl.tokens = append(l.tokens, token{\n\t\tPosition: Position{l.line, l.col},\n\t\ttyp: tokenError,\n\t\tval: fmt.Sprintf(format, args...),\n\t})\n\treturn nil\n}\n\n// State functions\n\nfunc (l *tomlLexer) lexVoid() tomlLexStateFn {\n\tfor {\n\t\tnext := l.peek()\n\t\tswitch next {\n\t\tcase '}': // after '{'\n\t\t\treturn l.lexRightCurlyBrace\n\t\tcase '[':\n\t\t\treturn l.lexTableKey\n\t\tcase '#':\n\t\t\treturn l.lexComment(l.lexVoid)\n\t\tcase '=':\n\t\t\treturn l.lexEqual\n\t\tcase '\\r':\n\t\t\tfallthrough\n\t\tcase '\\n':\n\t\t\tl.skip()\n\t\t\tcontinue\n\t\t}\n\n\t\tif isSpace(next) {\n\t\t\tl.skip()\n\t\t}\n\n\t\tif isKeyStartChar(next) {\n\t\t\treturn l.lexKey\n\t\t}\n\n\t\tif next == eof {\n\t\t\tl.next()\n\t\t\tbreak\n\t\t}\n\t}\n\n\tl.emit(tokenEOF)\n\treturn nil\n}\n\nfunc (l *tomlLexer) lexRvalue() tomlLexStateFn {\n\tfor {\n\t\tnext := l.peek()\n\t\tswitch next {\n\t\tcase '.':\n\t\t\treturn l.errorf(\"cannot start float with a dot\")\n\t\tcase '=':\n\t\t\treturn l.lexEqual\n\t\tcase '[':\n\t\t\treturn l.lexLeftBracket\n\t\tcase ']':\n\t\t\treturn l.lexRightBracket\n\t\tcase '{':\n\t\t\treturn l.lexLeftCurlyBrace\n\t\tcase '}':\n\t\t\treturn l.lexRightCurlyBrace\n\t\tcase '#':\n\t\t\treturn l.lexComment(l.lexRvalue)\n\t\tcase '\"':\n\t\t\treturn l.lexString\n\t\tcase '\\'':\n\t\t\treturn l.lexLiteralString\n\t\tcase ',':\n\t\t\treturn l.lexComma\n\t\tcase '\\r':\n\t\t\tfallthrough\n\t\tcase '\\n':\n\t\t\tl.skip()\n\t\t\tif len(l.brackets) > 0 && l.brackets[len(l.brackets)-1] == '[' {\n\t\t\t\treturn l.lexRvalue\n\t\t\t}\n\t\t\treturn l.lexVoid\n\t\t}\n\n\t\tif l.follow(\"true\") {\n\t\t\treturn l.lexTrue\n\t\t}\n\n\t\tif l.follow(\"false\") {\n\t\t\treturn l.lexFalse\n\t\t}\n\n\t\tif l.follow(\"inf\") {\n\t\t\treturn l.lexInf\n\t\t}\n\n\t\tif l.follow(\"nan\") {\n\t\t\treturn l.lexNan\n\t\t}\n\n\t\tif isSpace(next) {\n\t\t\tl.skip()\n\t\t\tcontinue\n\t\t}\n\n\t\tif next == eof {\n\t\t\tl.next()\n\t\t\tbreak\n\t\t}\n\n\t\tif next == '+' || next == '-' {\n\t\t\treturn l.lexNumber\n\t\t}\n\n\t\tif isDigit(next) {\n\t\t\treturn l.lexDateTimeOrNumber\n\t\t}\n\n\t\treturn l.errorf(\"no value can start with %c\", next)\n\t}\n\n\tl.emit(tokenEOF)\n\treturn nil\n}\n\nfunc (l *tomlLexer) lexDateTimeOrNumber() tomlLexStateFn {\n\t// Could be either a date/time, or a digit.\n\t// The options for date/times are:\n\t// YYYY-... => date or date-time\n\t// HH:... => time\n\t// Anything else should be a number.\n\n\tlookAhead := l.peekString(5)\n\tif len(lookAhead) < 3 {\n\t\treturn l.lexNumber()\n\t}\n\n\tfor idx, r := range lookAhead {\n\t\tif !isDigit(r) {\n\t\t\tif idx == 2 && r == ':' {\n\t\t\t\treturn l.lexDateTimeOrTime()\n\t\t\t}\n\t\t\tif idx == 4 && r == '-' {\n\t\t\t\treturn l.lexDateTimeOrTime()\n\t\t\t}\n\t\t\treturn l.lexNumber()\n\t\t}\n\t}\n\treturn l.lexNumber()\n}\n\nfunc (l *tomlLexer) lexLeftCurlyBrace() tomlLexStateFn {\n\tl.next()\n\tl.emit(tokenLeftCurlyBrace)\n\tl.brackets = append(l.brackets, '{')\n\treturn l.lexVoid\n}\n\nfunc (l *tomlLexer) lexRightCurlyBrace() tomlLexStateFn {\n\tl.next()\n\tl.emit(tokenRightCurlyBrace)\n\tif len(l.brackets) == 0 || l.brackets[len(l.brackets)-1] != '{' {\n\t\treturn l.errorf(\"cannot have '}' here\")\n\t}\n\tl.brackets = l.brackets[:len(l.brackets)-1]\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexDateTimeOrTime() tomlLexStateFn {\n\t// Example matches:\n\t// 1979-05-27T07:32:00Z\n\t// 1979-05-27T00:32:00-07:00\n\t// 1979-05-27T00:32:00.999999-07:00\n\t// 1979-05-27 07:32:00Z\n\t// 1979-05-27 00:32:00-07:00\n\t// 1979-05-27 00:32:00.999999-07:00\n\t// 1979-05-27T07:32:00\n\t// 1979-05-27T00:32:00.999999\n\t// 1979-05-27 07:32:00\n\t// 1979-05-27 00:32:00.999999\n\t// 1979-05-27\n\t// 07:32:00\n\t// 00:32:00.999999\n\n\t// we already know those two are digits\n\tl.next()\n\tl.next()\n\n\t// Got 2 digits. At that point it could be either a time or a date(-time).\n\n\tr := l.next()\n\tif r == ':' {\n\t\treturn l.lexTime()\n\t}\n\n\treturn l.lexDateTime()\n}\n\nfunc (l *tomlLexer) lexDateTime() tomlLexStateFn {\n\t// This state accepts an offset date-time, a local date-time, or a local date.\n\t//\n\t// v--- cursor\n\t// 1979-05-27T07:32:00Z\n\t// 1979-05-27T00:32:00-07:00\n\t// 1979-05-27T00:32:00.999999-07:00\n\t// 1979-05-27 07:32:00Z\n\t// 1979-05-27 00:32:00-07:00\n\t// 1979-05-27 00:32:00.999999-07:00\n\t// 1979-05-27T07:32:00\n\t// 1979-05-27T00:32:00.999999\n\t// 1979-05-27 07:32:00\n\t// 1979-05-27 00:32:00.999999\n\t// 1979-05-27\n\n\t// date\n\n\t// already checked by lexRvalue\n\tl.next() // digit\n\tl.next() // -\n\n\tfor i := 0; i < 2; i++ {\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"invalid month digit in date: %c\", r)\n\t\t}\n\t}\n\n\tr := l.next()\n\tif r != '-' {\n\t\treturn l.errorf(\"expected - to separate month of a date, not %c\", r)\n\t}\n\n\tfor i := 0; i < 2; i++ {\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"invalid day digit in date: %c\", r)\n\t\t}\n\t}\n\n\tl.emit(tokenLocalDate)\n\n\tr = l.peek()\n\n\tif r == eof {\n\n\t\treturn l.lexRvalue\n\t}\n\n\tif r != ' ' && r != 'T' {\n\t\treturn l.errorf(\"incorrect date/time separation character: %c\", r)\n\t}\n\n\tif r == ' ' {\n\t\tlookAhead := l.peekString(3)[1:]\n\t\tif len(lookAhead) < 2 {\n\t\t\treturn l.lexRvalue\n\t\t}\n\t\tfor _, r := range lookAhead {\n\t\t\tif !isDigit(r) {\n\t\t\t\treturn l.lexRvalue\n\t\t\t}\n\t\t}\n\t}\n\n\tl.skip() // skip the T or ' '\n\n\t// time\n\n\tfor i := 0; i < 2; i++ {\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"invalid hour digit in time: %c\", r)\n\t\t}\n\t}\n\n\tr = l.next()\n\tif r != ':' {\n\t\treturn l.errorf(\"time hour/minute separator should be :, not %c\", r)\n\t}\n\n\tfor i := 0; i < 2; i++ {\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"invalid minute digit in time: %c\", r)\n\t\t}\n\t}\n\n\tr = l.next()\n\tif r != ':' {\n\t\treturn l.errorf(\"time minute/second separator should be :, not %c\", r)\n\t}\n\n\tfor i := 0; i < 2; i++ {\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"invalid second digit in time: %c\", r)\n\t\t}\n\t}\n\n\tr = l.peek()\n\tif r == '.' {\n\t\tl.next()\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"expected at least one digit in time's fraction, not %c\", r)\n\t\t}\n\n\t\tfor {\n\t\t\tr := l.peek()\n\t\t\tif !isDigit(r) {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tl.next()\n\t\t}\n\t}\n\n\tl.emit(tokenLocalTime)\n\n\treturn l.lexTimeOffset\n\n}\n\nfunc (l *tomlLexer) lexTimeOffset() tomlLexStateFn {\n\t// potential offset\n\n\t// Z\n\t// -07:00\n\t// +07:00\n\t// nothing\n\n\tr := l.peek()\n\n\tif r == 'Z' {\n\t\tl.next()\n\t\tl.emit(tokenTimeOffset)\n\t} else if r == '+' || r == '-' {\n\t\tl.next()\n\n\t\tfor i := 0; i < 2; i++ {\n\t\t\tr := l.next()\n\t\t\tif !isDigit(r) {\n\t\t\t\treturn l.errorf(\"invalid hour digit in time offset: %c\", r)\n\t\t\t}\n\t\t}\n\n\t\tr = l.next()\n\t\tif r != ':' {\n\t\t\treturn l.errorf(\"time offset hour/minute separator should be :, not %c\", r)\n\t\t}\n\n\t\tfor i := 0; i < 2; i++ {\n\t\t\tr := l.next()\n\t\t\tif !isDigit(r) {\n\t\t\t\treturn l.errorf(\"invalid minute digit in time offset: %c\", r)\n\t\t\t}\n\t\t}\n\n\t\tl.emit(tokenTimeOffset)\n\t}\n\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexTime() tomlLexStateFn {\n\t// v--- cursor\n\t// 07:32:00\n\t// 00:32:00.999999\n\n\tfor i := 0; i < 2; i++ {\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"invalid minute digit in time: %c\", r)\n\t\t}\n\t}\n\n\tr := l.next()\n\tif r != ':' {\n\t\treturn l.errorf(\"time minute/second separator should be :, not %c\", r)\n\t}\n\n\tfor i := 0; i < 2; i++ {\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"invalid second digit in time: %c\", r)\n\t\t}\n\t}\n\n\tr = l.peek()\n\tif r == '.' {\n\t\tl.next()\n\t\tr := l.next()\n\t\tif !isDigit(r) {\n\t\t\treturn l.errorf(\"expected at least one digit in time's fraction, not %c\", r)\n\t\t}\n\n\t\tfor {\n\t\t\tr := l.peek()\n\t\t\tif !isDigit(r) {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tl.next()\n\t\t}\n\t}\n\n\tl.emit(tokenLocalTime)\n\treturn l.lexRvalue\n\n}\n\nfunc (l *tomlLexer) lexTrue() tomlLexStateFn {\n\tl.fastForward(4)\n\tl.emit(tokenTrue)\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexFalse() tomlLexStateFn {\n\tl.fastForward(5)\n\tl.emit(tokenFalse)\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexInf() tomlLexStateFn {\n\tl.fastForward(3)\n\tl.emit(tokenInf)\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexNan() tomlLexStateFn {\n\tl.fastForward(3)\n\tl.emit(tokenNan)\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexEqual() tomlLexStateFn {\n\tl.next()\n\tl.emit(tokenEqual)\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexComma() tomlLexStateFn {\n\tl.next()\n\tl.emit(tokenComma)\n\tif len(l.brackets) > 0 && l.brackets[len(l.brackets)-1] == '{' {\n\t\treturn l.lexVoid\n\t}\n\treturn l.lexRvalue\n}\n\n// Parse the key and emits its value without escape sequences.\n// bare keys, basic string keys and literal string keys are supported.\nfunc (l *tomlLexer) lexKey() tomlLexStateFn {\n\tvar sb strings.Builder\n\n\tfor r := l.peek(); isKeyChar(r) || r == '\\n' || r == '\\r'; r = l.peek() {\n\t\tif r == '\"' {\n\t\t\tl.next()\n\t\t\tstr, err := l.lexStringAsString(`\"`, false, true)\n\t\t\tif err != nil {\n\t\t\t\treturn l.errorf(err.Error())\n\t\t\t}\n\t\t\tsb.WriteString(\"\\\"\")\n\t\t\tsb.WriteString(str)\n\t\t\tsb.WriteString(\"\\\"\")\n\t\t\tl.next()\n\t\t\tcontinue\n\t\t} else if r == '\\'' {\n\t\t\tl.next()\n\t\t\tstr, err := l.lexLiteralStringAsString(`'`, false)\n\t\t\tif err != nil {\n\t\t\t\treturn l.errorf(err.Error())\n\t\t\t}\n\t\t\tsb.WriteString(\"'\")\n\t\t\tsb.WriteString(str)\n\t\t\tsb.WriteString(\"'\")\n\t\t\tl.next()\n\t\t\tcontinue\n\t\t} else if r == '\\n' {\n\t\t\treturn l.errorf(\"keys cannot contain new lines\")\n\t\t} else if isSpace(r) {\n\t\t\tvar str strings.Builder\n\t\t\tstr.WriteString(\" \")\n\n\t\t\t// skip trailing whitespace\n\t\t\tl.next()\n\t\t\tfor r = l.peek(); isSpace(r); r = l.peek() {\n\t\t\t\tstr.WriteRune(r)\n\t\t\t\tl.next()\n\t\t\t}\n\t\t\t// break loop if not a dot\n\t\t\tif r != '.' {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tstr.WriteString(\".\")\n\t\t\t// skip trailing whitespace after dot\n\t\t\tl.next()\n\t\t\tfor r = l.peek(); isSpace(r); r = l.peek() {\n\t\t\t\tstr.WriteRune(r)\n\t\t\t\tl.next()\n\t\t\t}\n\t\t\tsb.WriteString(str.String())\n\t\t\tcontinue\n\t\t} else if r == '.' {\n\t\t\t// skip\n\t\t} else if !isValidBareChar(r) {\n\t\t\treturn l.errorf(\"keys cannot contain %c character\", r)\n\t\t}\n\t\tsb.WriteRune(r)\n\t\tl.next()\n\t}\n\tl.emitWithValue(tokenKey, sb.String())\n\treturn l.lexVoid\n}\n\nfunc (l *tomlLexer) lexComment(previousState tomlLexStateFn) tomlLexStateFn {\n\treturn func() tomlLexStateFn {\n\t\tfor next := l.peek(); next != '\\n' && next != eof; next = l.peek() {\n\t\t\tif next == '\\r' && l.follow(\"\\r\\n\") {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tl.next()\n\t\t}\n\t\tl.ignore()\n\t\treturn previousState\n\t}\n}\n\nfunc (l *tomlLexer) lexLeftBracket() tomlLexStateFn {\n\tl.next()\n\tl.emit(tokenLeftBracket)\n\tl.brackets = append(l.brackets, '[')\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexLiteralStringAsString(terminator string, discardLeadingNewLine bool) (string, error) {\n\tvar sb strings.Builder\n\n\tif discardLeadingNewLine {\n\t\tif l.follow(\"\\r\\n\") {\n\t\t\tl.skip()\n\t\t\tl.skip()\n\t\t} else if l.peek() == '\\n' {\n\t\t\tl.skip()\n\t\t}\n\t}\n\n\t// find end of string\n\tfor {\n\t\tif l.follow(terminator) {\n\t\t\treturn sb.String(), nil\n\t\t}\n\n\t\tnext := l.peek()\n\t\tif next == eof {\n\t\t\tbreak\n\t\t}\n\t\tsb.WriteRune(l.next())\n\t}\n\n\treturn \"\", errors.New(\"unclosed string\")\n}\n\nfunc (l *tomlLexer) lexLiteralString() tomlLexStateFn {\n\tl.skip()\n\n\t// handle special case for triple-quote\n\tterminator := \"'\"\n\tdiscardLeadingNewLine := false\n\tif l.follow(\"''\") {\n\t\tl.skip()\n\t\tl.skip()\n\t\tterminator = \"'''\"\n\t\tdiscardLeadingNewLine = true\n\t}\n\n\tstr, err := l.lexLiteralStringAsString(terminator, discardLeadingNewLine)\n\tif err != nil {\n\t\treturn l.errorf(err.Error())\n\t}\n\n\tl.emitWithValue(tokenString, str)\n\tl.fastForward(len(terminator))\n\tl.ignore()\n\treturn l.lexRvalue\n}\n\n// Lex a string and return the results as a string.\n// Terminator is the substring indicating the end of the token.\n// The resulting string does not include the terminator.\nfunc (l *tomlLexer) lexStringAsString(terminator string, discardLeadingNewLine, acceptNewLines bool) (string, error) {\n\tvar sb strings.Builder\n\n\tif discardLeadingNewLine {\n\t\tif l.follow(\"\\r\\n\") {\n\t\t\tl.skip()\n\t\t\tl.skip()\n\t\t} else if l.peek() == '\\n' {\n\t\t\tl.skip()\n\t\t}\n\t}\n\n\tfor {\n\t\tif l.follow(terminator) {\n\t\t\treturn sb.String(), nil\n\t\t}\n\n\t\tif l.follow(\"\\\\\") {\n\t\t\tl.next()\n\t\t\tswitch l.peek() {\n\t\t\tcase '\\r':\n\t\t\t\tfallthrough\n\t\t\tcase '\\n':\n\t\t\t\tfallthrough\n\t\t\tcase '\\t':\n\t\t\t\tfallthrough\n\t\t\tcase ' ':\n\t\t\t\t// skip all whitespace chars following backslash\n\t\t\t\tfor strings.ContainsRune(\"\\r\\n\\t \", l.peek()) {\n\t\t\t\t\tl.next()\n\t\t\t\t}\n\t\t\tcase '\"':\n\t\t\t\tsb.WriteString(\"\\\"\")\n\t\t\t\tl.next()\n\t\t\tcase 'n':\n\t\t\t\tsb.WriteString(\"\\n\")\n\t\t\t\tl.next()\n\t\t\tcase 'b':\n\t\t\t\tsb.WriteString(\"\\b\")\n\t\t\t\tl.next()\n\t\t\tcase 'f':\n\t\t\t\tsb.WriteString(\"\\f\")\n\t\t\t\tl.next()\n\t\t\tcase '/':\n\t\t\t\tsb.WriteString(\"/\")\n\t\t\t\tl.next()\n\t\t\tcase 't':\n\t\t\t\tsb.WriteString(\"\\t\")\n\t\t\t\tl.next()\n\t\t\tcase 'r':\n\t\t\t\tsb.WriteString(\"\\r\")\n\t\t\t\tl.next()\n\t\t\tcase '\\\\':\n\t\t\t\tsb.WriteString(\"\\\\\")\n\t\t\t\tl.next()\n\t\t\tcase 'u':\n\t\t\t\tl.next()\n\t\t\t\tvar code strings.Builder\n\t\t\t\tfor i := 0; i < 4; i++ {\n\t\t\t\t\tc := l.peek()\n\t\t\t\t\tif !isHexDigit(c) {\n\t\t\t\t\t\treturn \"\", errors.New(\"unfinished unicode escape\")\n\t\t\t\t\t}\n\t\t\t\t\tl.next()\n\t\t\t\t\tcode.WriteRune(c)\n\t\t\t\t}\n\t\t\t\tintcode, err := strconv.ParseInt(code.String(), 16, 32)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn \"\", errors.New(\"invalid unicode escape: \\\\u\" + code.String())\n\t\t\t\t}\n\t\t\t\tsb.WriteRune(rune(intcode))\n\t\t\tcase 'U':\n\t\t\t\tl.next()\n\t\t\t\tvar code strings.Builder\n\t\t\t\tfor i := 0; i < 8; i++ {\n\t\t\t\t\tc := l.peek()\n\t\t\t\t\tif !isHexDigit(c) {\n\t\t\t\t\t\treturn \"\", errors.New(\"unfinished unicode escape\")\n\t\t\t\t\t}\n\t\t\t\t\tl.next()\n\t\t\t\t\tcode.WriteRune(c)\n\t\t\t\t}\n\t\t\t\tintcode, err := strconv.ParseInt(code.String(), 16, 64)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn \"\", errors.New(\"invalid unicode escape: \\\\U\" + code.String())\n\t\t\t\t}\n\t\t\t\tsb.WriteRune(rune(intcode))\n\t\t\tdefault:\n\t\t\t\treturn \"\", errors.New(\"invalid escape sequence: \\\\\" + string(l.peek()))\n\t\t\t}\n\t\t} else {\n\t\t\tr := l.peek()\n\n\t\t\tif 0x00 <= r && r <= 0x1F && r != '\\t' && !(acceptNewLines && (r == '\\n' || r == '\\r')) {\n\t\t\t\treturn \"\", fmt.Errorf(\"unescaped control character %U\", r)\n\t\t\t}\n\t\t\tl.next()\n\t\t\tsb.WriteRune(r)\n\t\t}\n\n\t\tif l.peek() == eof {\n\t\t\tbreak\n\t\t}\n\t}\n\n\treturn \"\", errors.New(\"unclosed string\")\n}\n\nfunc (l *tomlLexer) lexString() tomlLexStateFn {\n\tl.skip()\n\n\t// handle special case for triple-quote\n\tterminator := `\"`\n\tdiscardLeadingNewLine := false\n\tacceptNewLines := false\n\tif l.follow(`\"\"`) {\n\t\tl.skip()\n\t\tl.skip()\n\t\tterminator = `\"\"\"`\n\t\tdiscardLeadingNewLine = true\n\t\tacceptNewLines = true\n\t}\n\n\tstr, err := l.lexStringAsString(terminator, discardLeadingNewLine, acceptNewLines)\n\tif err != nil {\n\t\treturn l.errorf(err.Error())\n\t}\n\n\tl.emitWithValue(tokenString, str)\n\tl.fastForward(len(terminator))\n\tl.ignore()\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) lexTableKey() tomlLexStateFn {\n\tl.next()\n\n\tif l.peek() == '[' {\n\t\t// token '[[' signifies an array of tables\n\t\tl.next()\n\t\tl.emit(tokenDoubleLeftBracket)\n\t\treturn l.lexInsideTableArrayKey\n\t}\n\t// vanilla table key\n\tl.emit(tokenLeftBracket)\n\treturn l.lexInsideTableKey\n}\n\n// Parse the key till \"]]\", but only bare keys are supported\nfunc (l *tomlLexer) lexInsideTableArrayKey() tomlLexStateFn {\n\tfor r := l.peek(); r != eof; r = l.peek() {\n\t\tswitch r {\n\t\tcase ']':\n\t\t\tif l.currentTokenStop > l.currentTokenStart {\n\t\t\t\tl.emit(tokenKeyGroupArray)\n\t\t\t}\n\t\t\tl.next()\n\t\t\tif l.peek() != ']' {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tl.next()\n\t\t\tl.emit(tokenDoubleRightBracket)\n\t\t\treturn l.lexVoid\n\t\tcase '[':\n\t\t\treturn l.errorf(\"table array key cannot contain ']'\")\n\t\tdefault:\n\t\t\tl.next()\n\t\t}\n\t}\n\treturn l.errorf(\"unclosed table array key\")\n}\n\n// Parse the key till \"]\" but only bare keys are supported\nfunc (l *tomlLexer) lexInsideTableKey() tomlLexStateFn {\n\tfor r := l.peek(); r != eof; r = l.peek() {\n\t\tswitch r {\n\t\tcase ']':\n\t\t\tif l.currentTokenStop > l.currentTokenStart {\n\t\t\t\tl.emit(tokenKeyGroup)\n\t\t\t}\n\t\t\tl.next()\n\t\t\tl.emit(tokenRightBracket)\n\t\t\treturn l.lexVoid\n\t\tcase '[':\n\t\t\treturn l.errorf(\"table key cannot contain ']'\")\n\t\tdefault:\n\t\t\tl.next()\n\t\t}\n\t}\n\treturn l.errorf(\"unclosed table key\")\n}\n\nfunc (l *tomlLexer) lexRightBracket() tomlLexStateFn {\n\tl.next()\n\tl.emit(tokenRightBracket)\n\tif len(l.brackets) == 0 || l.brackets[len(l.brackets)-1] != '[' {\n\t\treturn l.errorf(\"cannot have ']' here\")\n\t}\n\tl.brackets = l.brackets[:len(l.brackets)-1]\n\treturn l.lexRvalue\n}\n\ntype validRuneFn func(r rune) bool\n\nfunc isValidHexRune(r rune) bool {\n\treturn r >= 'a' && r <= 'f' ||\n\t\tr >= 'A' && r <= 'F' ||\n\t\tr >= '0' && r <= '9' ||\n\t\tr == '_'\n}\n\nfunc isValidOctalRune(r rune) bool {\n\treturn r >= '0' && r <= '7' || r == '_'\n}\n\nfunc isValidBinaryRune(r rune) bool {\n\treturn r == '0' || r == '1' || r == '_'\n}\n\nfunc (l *tomlLexer) lexNumber() tomlLexStateFn {\n\tr := l.peek()\n\n\tif r == '0' {\n\t\tfollow := l.peekString(2)\n\t\tif len(follow) == 2 {\n\t\t\tvar isValidRune validRuneFn\n\t\t\tswitch follow[1] {\n\t\t\tcase 'x':\n\t\t\t\tisValidRune = isValidHexRune\n\t\t\tcase 'o':\n\t\t\t\tisValidRune = isValidOctalRune\n\t\t\tcase 'b':\n\t\t\t\tisValidRune = isValidBinaryRune\n\t\t\tdefault:\n\t\t\t\tif follow[1] >= 'a' && follow[1] <= 'z' || follow[1] >= 'A' && follow[1] <= 'Z' {\n\t\t\t\t\treturn l.errorf(\"unknown number base: %s. possible options are x (hex) o (octal) b (binary)\", string(follow[1]))\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif isValidRune != nil {\n\t\t\t\tl.next()\n\t\t\t\tl.next()\n\t\t\t\tdigitSeen := false\n\t\t\t\tfor {\n\t\t\t\t\tnext := l.peek()\n\t\t\t\t\tif !isValidRune(next) {\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t\tdigitSeen = true\n\t\t\t\t\tl.next()\n\t\t\t\t}\n\n\t\t\t\tif !digitSeen {\n\t\t\t\t\treturn l.errorf(\"number needs at least one digit\")\n\t\t\t\t}\n\n\t\t\t\tl.emit(tokenInteger)\n\n\t\t\t\treturn l.lexRvalue\n\t\t\t}\n\t\t}\n\t}\n\n\tif r == '+' || r == '-' {\n\t\tl.next()\n\t\tif l.follow(\"inf\") {\n\t\t\treturn l.lexInf\n\t\t}\n\t\tif l.follow(\"nan\") {\n\t\t\treturn l.lexNan\n\t\t}\n\t}\n\n\tpointSeen := false\n\texpSeen := false\n\tdigitSeen := false\n\tfor {\n\t\tnext := l.peek()\n\t\tif next == '.' {\n\t\t\tif pointSeen {\n\t\t\t\treturn l.errorf(\"cannot have two dots in one float\")\n\t\t\t}\n\t\t\tl.next()\n\t\t\tif !isDigit(l.peek()) {\n\t\t\t\treturn l.errorf(\"float cannot end with a dot\")\n\t\t\t}\n\t\t\tpointSeen = true\n\t\t} else if next == 'e' || next == 'E' {\n\t\t\texpSeen = true\n\t\t\tl.next()\n\t\t\tr := l.peek()\n\t\t\tif r == '+' || r == '-' {\n\t\t\t\tl.next()\n\t\t\t}\n\t\t} else if isDigit(next) {\n\t\t\tdigitSeen = true\n\t\t\tl.next()\n\t\t} else if next == '_' {\n\t\t\tl.next()\n\t\t} else {\n\t\t\tbreak\n\t\t}\n\t\tif pointSeen && !digitSeen {\n\t\t\treturn l.errorf(\"cannot start float with a dot\")\n\t\t}\n\t}\n\n\tif !digitSeen {\n\t\treturn l.errorf(\"no digit in that number\")\n\t}\n\tif pointSeen || expSeen {\n\t\tl.emit(tokenFloat)\n\t} else {\n\t\tl.emit(tokenInteger)\n\t}\n\treturn l.lexRvalue\n}\n\nfunc (l *tomlLexer) run() {\n\tfor state := l.lexVoid; state != nil; {\n\t\tstate = state()\n\t}\n}\n\n// Entry point\nfunc lexToml(inputBytes []byte) []token {\n\trunes := bytes.Runes(inputBytes)\n\tl := &tomlLexer{\n\t\tinput: runes,\n\t\ttokens: make([]token, 0, 256),\n\t\tline: 1,\n\t\tcol: 1,\n\t\tendbufferLine: 1,\n\t\tendbufferCol: 1,\n\t}\n\tl.run()\n\treturn l.tokens\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/localtime.go",
"content": "// Implementation of TOML's local date/time.\n//\n// Copied over from Google's civil to avoid pulling all the Google dependencies.\n// Originals:\n// https://raw.githubusercontent.com/googleapis/google-cloud-go/ed46f5086358513cf8c25f8e3f022cb838a49d66/civil/civil.go\n// Changes:\n// * Renamed files from civil* to localtime*.\n// * Package changed from civil to toml.\n// * 'Local' prefix added to all structs.\n//\n// Copyright 2016 Google LLC\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// Package civil implements types for civil time, a time-zone-independent\n// representation of time that follows the rules of the proleptic\n// Gregorian calendar with exactly 24-hour days, 60-minute hours, and 60-second\n// minutes.\n//\n// Because they lack location information, these types do not represent unique\n// moments or intervals of time. Use time.Time for that purpose.\npackage toml\n\nimport (\n\t\"fmt\"\n\t\"time\"\n)\n\n// A LocalDate represents a date (year, month, day).\n//\n// This type does not include location information, and therefore does not\n// describe a unique 24-hour timespan.\ntype LocalDate struct {\n\tYear int // Year (e.g., 2014).\n\tMonth time.Month // Month of the year (January = 1, ...).\n\tDay int // Day of the month, starting at 1.\n}\n\n// LocalDateOf returns the LocalDate in which a time occurs in that time's location.\nfunc LocalDateOf(t time.Time) LocalDate {\n\tvar d LocalDate\n\td.Year, d.Month, d.Day = t.Date()\n\treturn d\n}\n\n// ParseLocalDate parses a string in RFC3339 full-date format and returns the date value it represents.\nfunc ParseLocalDate(s string) (LocalDate, error) {\n\tt, err := time.Parse(\"2006-01-02\", s)\n\tif err != nil {\n\t\treturn LocalDate{}, err\n\t}\n\treturn LocalDateOf(t), nil\n}\n\n// String returns the date in RFC3339 full-date format.\nfunc (d LocalDate) String() string {\n\treturn fmt.Sprintf(\"%04d-%02d-%02d\", d.Year, d.Month, d.Day)\n}\n\n// IsValid reports whether the date is valid.\nfunc (d LocalDate) IsValid() bool {\n\treturn LocalDateOf(d.In(time.UTC)) == d\n}\n\n// In returns the time corresponding to time 00:00:00 of the date in the location.\n//\n// In is always consistent with time.LocalDate, even when time.LocalDate returns a time\n// on a different day. For example, if loc is America/Indiana/Vincennes, then both\n// time.LocalDate(1955, time.May, 1, 0, 0, 0, 0, loc)\n// and\n// civil.LocalDate{Year: 1955, Month: time.May, Day: 1}.In(loc)\n// return 23:00:00 on April 30, 1955.\n//\n// In panics if loc is nil.\nfunc (d LocalDate) In(loc *time.Location) time.Time {\n\treturn time.Date(d.Year, d.Month, d.Day, 0, 0, 0, 0, loc)\n}\n\n// AddDays returns the date that is n days in the future.\n// n can also be negative to go into the past.\nfunc (d LocalDate) AddDays(n int) LocalDate {\n\treturn LocalDateOf(d.In(time.UTC).AddDate(0, 0, n))\n}\n\n// DaysSince returns the signed number of days between the date and s, not including the end day.\n// This is the inverse operation to AddDays.\nfunc (d LocalDate) DaysSince(s LocalDate) (days int) {\n\t// We convert to Unix time so we do not have to worry about leap seconds:\n\t// Unix time increases by exactly 86400 seconds per day.\n\tdeltaUnix := d.In(time.UTC).Unix() - s.In(time.UTC).Unix()\n\treturn int(deltaUnix / 86400)\n}\n\n// Before reports whether d1 occurs before d2.\nfunc (d1 LocalDate) Before(d2 LocalDate) bool {\n\tif d1.Year != d2.Year {\n\t\treturn d1.Year < d2.Year\n\t}\n\tif d1.Month != d2.Month {\n\t\treturn d1.Month < d2.Month\n\t}\n\treturn d1.Day < d2.Day\n}\n\n// After reports whether d1 occurs after d2.\nfunc (d1 LocalDate) After(d2 LocalDate) bool {\n\treturn d2.Before(d1)\n}\n\n// MarshalText implements the encoding.TextMarshaler interface.\n// The output is the result of d.String().\nfunc (d LocalDate) MarshalText() ([]byte, error) {\n\treturn []byte(d.String()), nil\n}\n\n// UnmarshalText implements the encoding.TextUnmarshaler interface.\n// The date is expected to be a string in a format accepted by ParseLocalDate.\nfunc (d *LocalDate) UnmarshalText(data []byte) error {\n\tvar err error\n\t*d, err = ParseLocalDate(string(data))\n\treturn err\n}\n\n// A LocalTime represents a time with nanosecond precision.\n//\n// This type does not include location information, and therefore does not\n// describe a unique moment in time.\n//\n// This type exists to represent the TIME type in storage-based APIs like BigQuery.\n// Most operations on Times are unlikely to be meaningful. Prefer the LocalDateTime type.\ntype LocalTime struct {\n\tHour int // The hour of the day in 24-hour format; range [0-23]\n\tMinute int // The minute of the hour; range [0-59]\n\tSecond int // The second of the minute; range [0-59]\n\tNanosecond int // The nanosecond of the second; range [0-999999999]\n}\n\n// LocalTimeOf returns the LocalTime representing the time of day in which a time occurs\n// in that time's location. It ignores the date.\nfunc LocalTimeOf(t time.Time) LocalTime {\n\tvar tm LocalTime\n\ttm.Hour, tm.Minute, tm.Second = t.Clock()\n\ttm.Nanosecond = t.Nanosecond()\n\treturn tm\n}\n\n// ParseLocalTime parses a string and returns the time value it represents.\n// ParseLocalTime accepts an extended form of the RFC3339 partial-time format. After\n// the HH:MM:SS part of the string, an optional fractional part may appear,\n// consisting of a decimal point followed by one to nine decimal digits.\n// (RFC3339 admits only one digit after the decimal point).\nfunc ParseLocalTime(s string) (LocalTime, error) {\n\tt, err := time.Parse(\"15:04:05.999999999\", s)\n\tif err != nil {\n\t\treturn LocalTime{}, err\n\t}\n\treturn LocalTimeOf(t), nil\n}\n\n// String returns the date in the format described in ParseLocalTime. If Nanoseconds\n// is zero, no fractional part will be generated. Otherwise, the result will\n// end with a fractional part consisting of a decimal point and nine digits.\nfunc (t LocalTime) String() string {\n\ts := fmt.Sprintf(\"%02d:%02d:%02d\", t.Hour, t.Minute, t.Second)\n\tif t.Nanosecond == 0 {\n\t\treturn s\n\t}\n\treturn s + fmt.Sprintf(\".%09d\", t.Nanosecond)\n}\n\n// IsValid reports whether the time is valid.\nfunc (t LocalTime) IsValid() bool {\n\t// Construct a non-zero time.\n\ttm := time.Date(2, 2, 2, t.Hour, t.Minute, t.Second, t.Nanosecond, time.UTC)\n\treturn LocalTimeOf(tm) == t\n}\n\n// MarshalText implements the encoding.TextMarshaler interface.\n// The output is the result of t.String().\nfunc (t LocalTime) MarshalText() ([]byte, error) {\n\treturn []byte(t.String()), nil\n}\n\n// UnmarshalText implements the encoding.TextUnmarshaler interface.\n// The time is expected to be a string in a format accepted by ParseLocalTime.\nfunc (t *LocalTime) UnmarshalText(data []byte) error {\n\tvar err error\n\t*t, err = ParseLocalTime(string(data))\n\treturn err\n}\n\n// A LocalDateTime represents a date and time.\n//\n// This type does not include location information, and therefore does not\n// describe a unique moment in time.\ntype LocalDateTime struct {\n\tDate LocalDate\n\tTime LocalTime\n}\n\n// Note: We deliberately do not embed LocalDate into LocalDateTime, to avoid promoting AddDays and Sub.\n\n// LocalDateTimeOf returns the LocalDateTime in which a time occurs in that time's location.\nfunc LocalDateTimeOf(t time.Time) LocalDateTime {\n\treturn LocalDateTime{\n\t\tDate: LocalDateOf(t),\n\t\tTime: LocalTimeOf(t),\n\t}\n}\n\n// ParseLocalDateTime parses a string and returns the LocalDateTime it represents.\n// ParseLocalDateTime accepts a variant of the RFC3339 date-time format that omits\n// the time offset but includes an optional fractional time, as described in\n// ParseLocalTime. Informally, the accepted format is\n// YYYY-MM-DDTHH:MM:SS[.FFFFFFFFF]\n// where the 'T' may be a lower-case 't'.\nfunc ParseLocalDateTime(s string) (LocalDateTime, error) {\n\tt, err := time.Parse(\"2006-01-02T15:04:05.999999999\", s)\n\tif err != nil {\n\t\tt, err = time.Parse(\"2006-01-02t15:04:05.999999999\", s)\n\t\tif err != nil {\n\t\t\treturn LocalDateTime{}, err\n\t\t}\n\t}\n\treturn LocalDateTimeOf(t), nil\n}\n\n// String returns the date in the format described in ParseLocalDate.\nfunc (dt LocalDateTime) String() string {\n\treturn dt.Date.String() + \"T\" + dt.Time.String()\n}\n\n// IsValid reports whether the datetime is valid.\nfunc (dt LocalDateTime) IsValid() bool {\n\treturn dt.Date.IsValid() && dt.Time.IsValid()\n}\n\n// In returns the time corresponding to the LocalDateTime in the given location.\n//\n// If the time is missing or ambigous at the location, In returns the same\n// result as time.LocalDate. For example, if loc is America/Indiana/Vincennes, then\n// both\n// time.LocalDate(1955, time.May, 1, 0, 30, 0, 0, loc)\n// and\n// civil.LocalDateTime{\n// civil.LocalDate{Year: 1955, Month: time.May, Day: 1}},\n// civil.LocalTime{Minute: 30}}.In(loc)\n// return 23:30:00 on April 30, 1955.\n//\n// In panics if loc is nil.\nfunc (dt LocalDateTime) In(loc *time.Location) time.Time {\n\treturn time.Date(dt.Date.Year, dt.Date.Month, dt.Date.Day, dt.Time.Hour, dt.Time.Minute, dt.Time.Second, dt.Time.Nanosecond, loc)\n}\n\n// Before reports whether dt1 occurs before dt2.\nfunc (dt1 LocalDateTime) Before(dt2 LocalDateTime) bool {\n\treturn dt1.In(time.UTC).Before(dt2.In(time.UTC))\n}\n\n// After reports whether dt1 occurs after dt2.\nfunc (dt1 LocalDateTime) After(dt2 LocalDateTime) bool {\n\treturn dt2.Before(dt1)\n}\n\n// MarshalText implements the encoding.TextMarshaler interface.\n// The output is the result of dt.String().\nfunc (dt LocalDateTime) MarshalText() ([]byte, error) {\n\treturn []byte(dt.String()), nil\n}\n\n// UnmarshalText implements the encoding.TextUnmarshaler interface.\n// The datetime is expected to be a string in a format accepted by ParseLocalDateTime\nfunc (dt *LocalDateTime) UnmarshalText(data []byte) error {\n\tvar err error\n\t*dt, err = ParseLocalDateTime(string(data))\n\treturn err\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/marshal.go",
"content": "package toml\n\nimport (\n\t\"bytes\"\n\t\"encoding\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"reflect\"\n\t\"sort\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n)\n\nconst (\n\ttagFieldName = \"toml\"\n\ttagFieldComment = \"comment\"\n\ttagCommented = \"commented\"\n\ttagMultiline = \"multiline\"\n\ttagLiteral = \"literal\"\n\ttagDefault = \"default\"\n)\n\ntype tomlOpts struct {\n\tname string\n\tnameFromTag bool\n\tcomment string\n\tcommented bool\n\tmultiline bool\n\tliteral bool\n\tinclude bool\n\tomitempty bool\n\tdefaultValue string\n}\n\ntype encOpts struct {\n\tquoteMapKeys bool\n\tarraysOneElementPerLine bool\n}\n\nvar encOptsDefaults = encOpts{\n\tquoteMapKeys: false,\n}\n\ntype annotation struct {\n\ttag string\n\tcomment string\n\tcommented string\n\tmultiline string\n\tliteral string\n\tdefaultValue string\n}\n\nvar annotationDefault = annotation{\n\ttag: tagFieldName,\n\tcomment: tagFieldComment,\n\tcommented: tagCommented,\n\tmultiline: tagMultiline,\n\tliteral: tagLiteral,\n\tdefaultValue: tagDefault,\n}\n\ntype MarshalOrder int\n\n// Orders the Encoder can write the fields to the output stream.\nconst (\n\t// Sort fields alphabetically.\n\tOrderAlphabetical MarshalOrder = iota + 1\n\t// Preserve the order the fields are encountered. For example, the order of fields in\n\t// a struct.\n\tOrderPreserve\n)\n\nvar timeType = reflect.TypeOf(time.Time{})\nvar marshalerType = reflect.TypeOf(new(Marshaler)).Elem()\nvar unmarshalerType = reflect.TypeOf(new(Unmarshaler)).Elem()\nvar textMarshalerType = reflect.TypeOf(new(encoding.TextMarshaler)).Elem()\nvar textUnmarshalerType = reflect.TypeOf(new(encoding.TextUnmarshaler)).Elem()\nvar localDateType = reflect.TypeOf(LocalDate{})\nvar localTimeType = reflect.TypeOf(LocalTime{})\nvar localDateTimeType = reflect.TypeOf(LocalDateTime{})\nvar mapStringInterfaceType = reflect.TypeOf(map[string]interface{}{})\n\n// Check if the given marshal type maps to a Tree primitive\nfunc isPrimitive(mtype reflect.Type) bool {\n\tswitch mtype.Kind() {\n\tcase reflect.Ptr:\n\t\treturn isPrimitive(mtype.Elem())\n\tcase reflect.Bool:\n\t\treturn true\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn true\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:\n\t\treturn true\n\tcase reflect.Float32, reflect.Float64:\n\t\treturn true\n\tcase reflect.String:\n\t\treturn true\n\tcase reflect.Struct:\n\t\treturn isTimeType(mtype)\n\tdefault:\n\t\treturn false\n\t}\n}\n\nfunc isTimeType(mtype reflect.Type) bool {\n\treturn mtype == timeType || mtype == localDateType || mtype == localDateTimeType || mtype == localTimeType\n}\n\n// Check if the given marshal type maps to a Tree slice or array\nfunc isTreeSequence(mtype reflect.Type) bool {\n\tswitch mtype.Kind() {\n\tcase reflect.Ptr:\n\t\treturn isTreeSequence(mtype.Elem())\n\tcase reflect.Slice, reflect.Array:\n\t\treturn isTree(mtype.Elem())\n\tdefault:\n\t\treturn false\n\t}\n}\n\n// Check if the given marshal type maps to a slice or array of a custom marshaler type\nfunc isCustomMarshalerSequence(mtype reflect.Type) bool {\n\tswitch mtype.Kind() {\n\tcase reflect.Ptr:\n\t\treturn isCustomMarshalerSequence(mtype.Elem())\n\tcase reflect.Slice, reflect.Array:\n\t\treturn isCustomMarshaler(mtype.Elem()) || isCustomMarshaler(reflect.New(mtype.Elem()).Type())\n\tdefault:\n\t\treturn false\n\t}\n}\n\n// Check if the given marshal type maps to a slice or array of a text marshaler type\nfunc isTextMarshalerSequence(mtype reflect.Type) bool {\n\tswitch mtype.Kind() {\n\tcase reflect.Ptr:\n\t\treturn isTextMarshalerSequence(mtype.Elem())\n\tcase reflect.Slice, reflect.Array:\n\t\treturn isTextMarshaler(mtype.Elem()) || isTextMarshaler(reflect.New(mtype.Elem()).Type())\n\tdefault:\n\t\treturn false\n\t}\n}\n\n// Check if the given marshal type maps to a non-Tree slice or array\nfunc isOtherSequence(mtype reflect.Type) bool {\n\tswitch mtype.Kind() {\n\tcase reflect.Ptr:\n\t\treturn isOtherSequence(mtype.Elem())\n\tcase reflect.Slice, reflect.Array:\n\t\treturn !isTreeSequence(mtype)\n\tdefault:\n\t\treturn false\n\t}\n}\n\n// Check if the given marshal type maps to a Tree\nfunc isTree(mtype reflect.Type) bool {\n\tswitch mtype.Kind() {\n\tcase reflect.Ptr:\n\t\treturn isTree(mtype.Elem())\n\tcase reflect.Map:\n\t\treturn true\n\tcase reflect.Struct:\n\t\treturn !isPrimitive(mtype)\n\tdefault:\n\t\treturn false\n\t}\n}\n\nfunc isCustomMarshaler(mtype reflect.Type) bool {\n\treturn mtype.Implements(marshalerType)\n}\n\nfunc callCustomMarshaler(mval reflect.Value) ([]byte, error) {\n\treturn mval.Interface().(Marshaler).MarshalTOML()\n}\n\nfunc isTextMarshaler(mtype reflect.Type) bool {\n\treturn mtype.Implements(textMarshalerType) && !isTimeType(mtype)\n}\n\nfunc callTextMarshaler(mval reflect.Value) ([]byte, error) {\n\treturn mval.Interface().(encoding.TextMarshaler).MarshalText()\n}\n\nfunc isCustomUnmarshaler(mtype reflect.Type) bool {\n\treturn mtype.Implements(unmarshalerType)\n}\n\nfunc callCustomUnmarshaler(mval reflect.Value, tval interface{}) error {\n\treturn mval.Interface().(Unmarshaler).UnmarshalTOML(tval)\n}\n\nfunc isTextUnmarshaler(mtype reflect.Type) bool {\n\treturn mtype.Implements(textUnmarshalerType)\n}\n\nfunc callTextUnmarshaler(mval reflect.Value, text []byte) error {\n\treturn mval.Interface().(encoding.TextUnmarshaler).UnmarshalText(text)\n}\n\n// Marshaler is the interface implemented by types that\n// can marshal themselves into valid TOML.\ntype Marshaler interface {\n\tMarshalTOML() ([]byte, error)\n}\n\n// Unmarshaler is the interface implemented by types that\n// can unmarshal a TOML description of themselves.\ntype Unmarshaler interface {\n\tUnmarshalTOML(interface{}) error\n}\n\n/*\nMarshal returns the TOML encoding of v. Behavior is similar to the Go json\nencoder, except that there is no concept of a Marshaler interface or MarshalTOML\nfunction for sub-structs, and currently only definite types can be marshaled\n(i.e. no `interface{}`).\n\nThe following struct annotations are supported:\n\n toml:\"Field\" Overrides the field's name to output.\n omitempty When set, empty values and groups are not emitted.\n comment:\"comment\" Emits a # comment on the same line. This supports new lines.\n commented:\"true\" Emits the value as commented.\n\nNote that pointers are automatically assigned the \"omitempty\" option, as TOML\nexplicitly does not handle null values (saying instead the label should be\ndropped).\n\nTree structural types and corresponding marshal types:\n\n *Tree (*)struct, (*)map[string]interface{}\n []*Tree (*)[](*)struct, (*)[](*)map[string]interface{}\n []interface{} (as interface{}) (*)[]primitive, (*)[]([]interface{})\n interface{} (*)primitive\n\nTree primitive types and corresponding marshal types:\n\n uint64 uint, uint8-uint64, pointers to same\n int64 int, int8-uint64, pointers to same\n float64 float32, float64, pointers to same\n string string, pointers to same\n bool bool, pointers to same\n time.LocalTime time.LocalTime{}, pointers to same\n\nFor additional flexibility, use the Encoder API.\n*/\nfunc Marshal(v interface{}) ([]byte, error) {\n\treturn NewEncoder(nil).marshal(v)\n}\n\n// Encoder writes TOML values to an output stream.\ntype Encoder struct {\n\tw io.Writer\n\tencOpts\n\tannotation\n\tline int\n\tcol int\n\torder MarshalOrder\n\tpromoteAnon bool\n\tcompactComments bool\n\tindentation string\n}\n\n// NewEncoder returns a new encoder that writes to w.\nfunc NewEncoder(w io.Writer) *Encoder {\n\treturn &Encoder{\n\t\tw: w,\n\t\tencOpts: encOptsDefaults,\n\t\tannotation: annotationDefault,\n\t\tline: 0,\n\t\tcol: 1,\n\t\torder: OrderAlphabetical,\n\t\tindentation: \" \",\n\t}\n}\n\n// Encode writes the TOML encoding of v to the stream.\n//\n// See the documentation for Marshal for details.\nfunc (e *Encoder) Encode(v interface{}) error {\n\tb, err := e.marshal(v)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif _, err := e.w.Write(b); err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n\n// QuoteMapKeys sets up the encoder to encode\n// maps with string type keys with quoted TOML keys.\n//\n// This relieves the character limitations on map keys.\nfunc (e *Encoder) QuoteMapKeys(v bool) *Encoder {\n\te.quoteMapKeys = v\n\treturn e\n}\n\n// ArraysWithOneElementPerLine sets up the encoder to encode arrays\n// with more than one element on multiple lines instead of one.\n//\n// For example:\n//\n// A = [1,2,3]\n//\n// Becomes\n//\n// A = [\n// 1,\n// 2,\n// 3,\n// ]\nfunc (e *Encoder) ArraysWithOneElementPerLine(v bool) *Encoder {\n\te.arraysOneElementPerLine = v\n\treturn e\n}\n\n// Order allows to change in which order fields will be written to the output stream.\nfunc (e *Encoder) Order(ord MarshalOrder) *Encoder {\n\te.order = ord\n\treturn e\n}\n\n// Indentation allows to change indentation when marshalling.\nfunc (e *Encoder) Indentation(indent string) *Encoder {\n\te.indentation = indent\n\treturn e\n}\n\n// SetTagName allows changing default tag \"toml\"\nfunc (e *Encoder) SetTagName(v string) *Encoder {\n\te.tag = v\n\treturn e\n}\n\n// SetTagComment allows changing default tag \"comment\"\nfunc (e *Encoder) SetTagComment(v string) *Encoder {\n\te.comment = v\n\treturn e\n}\n\n// SetTagCommented allows changing default tag \"commented\"\nfunc (e *Encoder) SetTagCommented(v string) *Encoder {\n\te.commented = v\n\treturn e\n}\n\n// SetTagMultiline allows changing default tag \"multiline\"\nfunc (e *Encoder) SetTagMultiline(v string) *Encoder {\n\te.multiline = v\n\treturn e\n}\n\n// PromoteAnonymous allows to change how anonymous struct fields are marshaled.\n// Usually, they are marshaled as if the inner exported fields were fields in\n// the outer struct. However, if an anonymous struct field is given a name in\n// its TOML tag, it is treated like a regular struct field with that name.\n// rather than being anonymous.\n//\n// In case anonymous promotion is enabled, all anonymous structs are promoted\n// and treated like regular struct fields.\nfunc (e *Encoder) PromoteAnonymous(promote bool) *Encoder {\n\te.promoteAnon = promote\n\treturn e\n}\n\n// CompactComments removes the new line before each comment in the tree.\nfunc (e *Encoder) CompactComments(cc bool) *Encoder {\n\te.compactComments = cc\n\treturn e\n}\n\nfunc (e *Encoder) marshal(v interface{}) ([]byte, error) {\n\t// Check if indentation is valid\n\tfor _, char := range e.indentation {\n\t\tif !isSpace(char) {\n\t\t\treturn []byte{}, fmt.Errorf(\"invalid indentation: must only contains space or tab characters\")\n\t\t}\n\t}\n\n\tmtype := reflect.TypeOf(v)\n\tif mtype == nil {\n\t\treturn []byte{}, errors.New(\"nil cannot be marshaled to TOML\")\n\t}\n\n\tswitch mtype.Kind() {\n\tcase reflect.Struct, reflect.Map:\n\tcase reflect.Ptr:\n\t\tif mtype.Elem().Kind() != reflect.Struct {\n\t\t\treturn []byte{}, errors.New(\"Only pointer to struct can be marshaled to TOML\")\n\t\t}\n\t\tif reflect.ValueOf(v).IsNil() {\n\t\t\treturn []byte{}, errors.New(\"nil pointer cannot be marshaled to TOML\")\n\t\t}\n\tdefault:\n\t\treturn []byte{}, errors.New(\"Only a struct or map can be marshaled to TOML\")\n\t}\n\n\tsval := reflect.ValueOf(v)\n\tif isCustomMarshaler(mtype) {\n\t\treturn callCustomMarshaler(sval)\n\t}\n\tif isTextMarshaler(mtype) {\n\t\treturn callTextMarshaler(sval)\n\t}\n\tt, err := e.valueToTree(mtype, sval)\n\tif err != nil {\n\t\treturn []byte{}, err\n\t}\n\n\tvar buf bytes.Buffer\n\t_, err = t.writeToOrdered(&buf, \"\", \"\", 0, e.arraysOneElementPerLine, e.order, e.indentation, e.compactComments, false)\n\n\treturn buf.Bytes(), err\n}\n\n// Create next tree with a position based on Encoder.line\nfunc (e *Encoder) nextTree() *Tree {\n\treturn newTreeWithPosition(Position{Line: e.line, Col: 1})\n}\n\n// Convert given marshal struct or map value to toml tree\nfunc (e *Encoder) valueToTree(mtype reflect.Type, mval reflect.Value) (*Tree, error) {\n\tif mtype.Kind() == reflect.Ptr {\n\t\treturn e.valueToTree(mtype.Elem(), mval.Elem())\n\t}\n\ttval := e.nextTree()\n\tswitch mtype.Kind() {\n\tcase reflect.Struct:\n\t\tswitch mval.Interface().(type) {\n\t\tcase Tree:\n\t\t\treflect.ValueOf(tval).Elem().Set(mval)\n\t\tdefault:\n\t\t\tfor i := 0; i < mtype.NumField(); i++ {\n\t\t\t\tmtypef, mvalf := mtype.Field(i), mval.Field(i)\n\t\t\t\topts := tomlOptions(mtypef, e.annotation)\n\t\t\t\tif opts.include && ((mtypef.Type.Kind() != reflect.Interface && !opts.omitempty) || !isZero(mvalf)) {\n\t\t\t\t\tval, err := e.valueToToml(mtypef.Type, mvalf)\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn nil, err\n\t\t\t\t\t}\n\t\t\t\t\tif tree, ok := val.(*Tree); ok && mtypef.Anonymous && !opts.nameFromTag && !e.promoteAnon {\n\t\t\t\t\t\te.appendTree(tval, tree)\n\t\t\t\t\t} else {\n\t\t\t\t\t\tval = e.wrapTomlValue(val, tval)\n\t\t\t\t\t\ttval.SetPathWithOptions([]string{opts.name}, SetOptions{\n\t\t\t\t\t\t\tComment: opts.comment,\n\t\t\t\t\t\t\tCommented: opts.commented,\n\t\t\t\t\t\t\tMultiline: opts.multiline,\n\t\t\t\t\t\t\tLiteral: opts.literal,\n\t\t\t\t\t\t}, val)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\tcase reflect.Map:\n\t\tkeys := mval.MapKeys()\n\t\tif e.order == OrderPreserve && len(keys) > 0 {\n\t\t\t// Sorting []reflect.Value is not straight forward.\n\t\t\t//\n\t\t\t// OrderPreserve will support deterministic results when string is used\n\t\t\t// as the key to maps.\n\t\t\ttyp := keys[0].Type()\n\t\t\tkind := keys[0].Kind()\n\t\t\tif kind == reflect.String {\n\t\t\t\tikeys := make([]string, len(keys))\n\t\t\t\tfor i := range keys {\n\t\t\t\t\tikeys[i] = keys[i].Interface().(string)\n\t\t\t\t}\n\t\t\t\tsort.Strings(ikeys)\n\t\t\t\tfor i := range ikeys {\n\t\t\t\t\tkeys[i] = reflect.ValueOf(ikeys[i]).Convert(typ)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tfor _, key := range keys {\n\t\t\tmvalf := mval.MapIndex(key)\n\t\t\tif (mtype.Elem().Kind() == reflect.Ptr || mtype.Elem().Kind() == reflect.Interface) && mvalf.IsNil() {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tval, err := e.valueToToml(mtype.Elem(), mvalf)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tval = e.wrapTomlValue(val, tval)\n\t\t\tif e.quoteMapKeys {\n\t\t\t\tkeyStr, err := tomlValueStringRepresentation(key.String(), \"\", \"\", e.order, e.arraysOneElementPerLine)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn nil, err\n\t\t\t\t}\n\t\t\t\ttval.SetPath([]string{keyStr}, val)\n\t\t\t} else {\n\t\t\t\ttval.SetPath([]string{key.String()}, val)\n\t\t\t}\n\t\t}\n\t}\n\treturn tval, nil\n}\n\n// Convert given marshal slice to slice of Toml trees\nfunc (e *Encoder) valueToTreeSlice(mtype reflect.Type, mval reflect.Value) ([]*Tree, error) {\n\ttval := make([]*Tree, mval.Len(), mval.Len())\n\tfor i := 0; i < mval.Len(); i++ {\n\t\tval, err := e.valueToTree(mtype.Elem(), mval.Index(i))\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\ttval[i] = val\n\t}\n\treturn tval, nil\n}\n\n// Convert given marshal slice to slice of toml values\nfunc (e *Encoder) valueToOtherSlice(mtype reflect.Type, mval reflect.Value) (interface{}, error) {\n\ttval := make([]interface{}, mval.Len(), mval.Len())\n\tfor i := 0; i < mval.Len(); i++ {\n\t\tval, err := e.valueToToml(mtype.Elem(), mval.Index(i))\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\ttval[i] = val\n\t}\n\treturn tval, nil\n}\n\n// Convert given marshal value to toml value\nfunc (e *Encoder) valueToToml(mtype reflect.Type, mval reflect.Value) (interface{}, error) {\n\tif mtype.Kind() == reflect.Ptr {\n\t\tswitch {\n\t\tcase isCustomMarshaler(mtype):\n\t\t\treturn callCustomMarshaler(mval)\n\t\tcase isTextMarshaler(mtype):\n\t\t\tb, err := callTextMarshaler(mval)\n\t\t\treturn string(b), err\n\t\tdefault:\n\t\t\treturn e.valueToToml(mtype.Elem(), mval.Elem())\n\t\t}\n\t}\n\tif mtype.Kind() == reflect.Interface {\n\t\treturn e.valueToToml(mval.Elem().Type(), mval.Elem())\n\t}\n\tswitch {\n\tcase isCustomMarshaler(mtype):\n\t\treturn callCustomMarshaler(mval)\n\tcase isTextMarshaler(mtype):\n\t\tb, err := callTextMarshaler(mval)\n\t\treturn string(b), err\n\tcase isTree(mtype):\n\t\treturn e.valueToTree(mtype, mval)\n\tcase isOtherSequence(mtype), isCustomMarshalerSequence(mtype), isTextMarshalerSequence(mtype):\n\t\treturn e.valueToOtherSlice(mtype, mval)\n\tcase isTreeSequence(mtype):\n\t\treturn e.valueToTreeSlice(mtype, mval)\n\tdefault:\n\t\tswitch mtype.Kind() {\n\t\tcase reflect.Bool:\n\t\t\treturn mval.Bool(), nil\n\t\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\t\tif mtype.Kind() == reflect.Int64 && mtype == reflect.TypeOf(time.Duration(1)) {\n\t\t\t\treturn fmt.Sprint(mval), nil\n\t\t\t}\n\t\t\treturn mval.Int(), nil\n\t\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:\n\t\t\treturn mval.Uint(), nil\n\t\tcase reflect.Float32, reflect.Float64:\n\t\t\treturn mval.Float(), nil\n\t\tcase reflect.String:\n\t\t\treturn mval.String(), nil\n\t\tcase reflect.Struct:\n\t\t\treturn mval.Interface(), nil\n\t\tdefault:\n\t\t\treturn nil, fmt.Errorf(\"Marshal can't handle %v(%v)\", mtype, mtype.Kind())\n\t\t}\n\t}\n}\n\nfunc (e *Encoder) appendTree(t, o *Tree) error {\n\tfor key, value := range o.values {\n\t\tif _, ok := t.values[key]; ok {\n\t\t\tcontinue\n\t\t}\n\t\tif tomlValue, ok := value.(*tomlValue); ok {\n\t\t\ttomlValue.position.Col = t.position.Col\n\t\t}\n\t\tt.values[key] = value\n\t}\n\treturn nil\n}\n\n// Create a toml value with the current line number as the position line\nfunc (e *Encoder) wrapTomlValue(val interface{}, parent *Tree) interface{} {\n\t_, isTree := val.(*Tree)\n\t_, isTreeS := val.([]*Tree)\n\tif isTree || isTreeS {\n\t\te.line++\n\t\treturn val\n\t}\n\n\tret := &tomlValue{\n\t\tvalue: val,\n\t\tposition: Position{\n\t\t\te.line,\n\t\t\tparent.position.Col,\n\t\t},\n\t}\n\te.line++\n\treturn ret\n}\n\n// Unmarshal attempts to unmarshal the Tree into a Go struct pointed by v.\n// Neither Unmarshaler interfaces nor UnmarshalTOML functions are supported for\n// sub-structs, and only definite types can be unmarshaled.\nfunc (t *Tree) Unmarshal(v interface{}) error {\n\td := Decoder{tval: t, tagName: tagFieldName}\n\treturn d.unmarshal(v)\n}\n\n// Marshal returns the TOML encoding of Tree.\n// See Marshal() documentation for types mapping table.\nfunc (t *Tree) Marshal() ([]byte, error) {\n\tvar buf bytes.Buffer\n\t_, err := t.WriteTo(&buf)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn buf.Bytes(), nil\n}\n\n// Unmarshal parses the TOML-encoded data and stores the result in the value\n// pointed to by v. Behavior is similar to the Go json encoder, except that there\n// is no concept of an Unmarshaler interface or UnmarshalTOML function for\n// sub-structs, and currently only definite types can be unmarshaled to (i.e. no\n// `interface{}`).\n//\n// The following struct annotations are supported:\n//\n// toml:\"Field\" Overrides the field's name to map to.\n// default:\"foo\" Provides a default value.\n//\n// For default values, only fields of the following types are supported:\n// * string\n// * bool\n// * int\n// * int64\n// * float64\n//\n// See Marshal() documentation for types mapping table.\nfunc Unmarshal(data []byte, v interface{}) error {\n\tt, err := LoadReader(bytes.NewReader(data))\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn t.Unmarshal(v)\n}\n\n// Decoder reads and decodes TOML values from an input stream.\ntype Decoder struct {\n\tr io.Reader\n\ttval *Tree\n\tencOpts\n\ttagName string\n\tstrict bool\n\tvisitor visitorState\n}\n\n// NewDecoder returns a new decoder that reads from r.\nfunc NewDecoder(r io.Reader) *Decoder {\n\treturn &Decoder{\n\t\tr: r,\n\t\tencOpts: encOptsDefaults,\n\t\ttagName: tagFieldName,\n\t}\n}\n\n// Decode reads a TOML-encoded value from it's input\n// and unmarshals it in the value pointed at by v.\n//\n// See the documentation for Marshal for details.\nfunc (d *Decoder) Decode(v interface{}) error {\n\tvar err error\n\td.tval, err = LoadReader(d.r)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn d.unmarshal(v)\n}\n\n// SetTagName allows changing default tag \"toml\"\nfunc (d *Decoder) SetTagName(v string) *Decoder {\n\td.tagName = v\n\treturn d\n}\n\n// Strict allows changing to strict decoding. Any fields that are found in the\n// input data and do not have a corresponding struct member cause an error.\nfunc (d *Decoder) Strict(strict bool) *Decoder {\n\td.strict = strict\n\treturn d\n}\n\nfunc (d *Decoder) unmarshal(v interface{}) error {\n\tmtype := reflect.TypeOf(v)\n\tif mtype == nil {\n\t\treturn errors.New(\"nil cannot be unmarshaled from TOML\")\n\t}\n\tif mtype.Kind() != reflect.Ptr {\n\t\treturn errors.New(\"only a pointer to struct or map can be unmarshaled from TOML\")\n\t}\n\n\telem := mtype.Elem()\n\n\tswitch elem.Kind() {\n\tcase reflect.Struct, reflect.Map:\n\tcase reflect.Interface:\n\t\telem = mapStringInterfaceType\n\tdefault:\n\t\treturn errors.New(\"only a pointer to struct or map can be unmarshaled from TOML\")\n\t}\n\n\tif reflect.ValueOf(v).IsNil() {\n\t\treturn errors.New(\"nil pointer cannot be unmarshaled from TOML\")\n\t}\n\n\tvv := reflect.ValueOf(v).Elem()\n\n\tif d.strict {\n\t\td.visitor = newVisitorState(d.tval)\n\t}\n\n\tsval, err := d.valueFromTree(elem, d.tval, &vv)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif err := d.visitor.validate(); err != nil {\n\t\treturn err\n\t}\n\treflect.ValueOf(v).Elem().Set(sval)\n\treturn nil\n}\n\n// Convert toml tree to marshal struct or map, using marshal type. When mval1\n// is non-nil, merge fields into the given value instead of allocating a new one.\nfunc (d *Decoder) valueFromTree(mtype reflect.Type, tval *Tree, mval1 *reflect.Value) (reflect.Value, error) {\n\tif mtype.Kind() == reflect.Ptr {\n\t\treturn d.unwrapPointer(mtype, tval, mval1)\n\t}\n\n\t// Check if pointer to value implements the Unmarshaler interface.\n\tif mvalPtr := reflect.New(mtype); isCustomUnmarshaler(mvalPtr.Type()) {\n\t\td.visitor.visitAll()\n\n\t\tif tval == nil {\n\t\t\treturn mvalPtr.Elem(), nil\n\t\t}\n\n\t\tif err := callCustomUnmarshaler(mvalPtr, tval.ToMap()); err != nil {\n\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"unmarshal toml: %v\", err)\n\t\t}\n\t\treturn mvalPtr.Elem(), nil\n\t}\n\n\tvar mval reflect.Value\n\tswitch mtype.Kind() {\n\tcase reflect.Struct:\n\t\tif mval1 != nil {\n\t\t\tmval = *mval1\n\t\t} else {\n\t\t\tmval = reflect.New(mtype).Elem()\n\t\t}\n\n\t\tswitch mval.Interface().(type) {\n\t\tcase Tree:\n\t\t\tmval.Set(reflect.ValueOf(tval).Elem())\n\t\tdefault:\n\t\t\tfor i := 0; i < mtype.NumField(); i++ {\n\t\t\t\tmtypef := mtype.Field(i)\n\t\t\t\tan := annotation{tag: d.tagName}\n\t\t\t\topts := tomlOptions(mtypef, an)\n\t\t\t\tif !opts.include {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tbaseKey := opts.name\n\t\t\t\tkeysToTry := []string{\n\t\t\t\t\tbaseKey,\n\t\t\t\t\tstrings.ToLower(baseKey),\n\t\t\t\t\tstrings.ToTitle(baseKey),\n\t\t\t\t\tstrings.ToLower(string(baseKey[0])) + baseKey[1:],\n\t\t\t\t}\n\n\t\t\t\tfound := false\n\t\t\t\tif tval != nil {\n\t\t\t\t\tfor _, key := range keysToTry {\n\t\t\t\t\t\texists := tval.HasPath([]string{key})\n\t\t\t\t\t\tif !exists {\n\t\t\t\t\t\t\tcontinue\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\td.visitor.push(key)\n\t\t\t\t\t\tval := tval.GetPath([]string{key})\n\t\t\t\t\t\tfval := mval.Field(i)\n\t\t\t\t\t\tmvalf, err := d.valueFromToml(mtypef.Type, val, &fval)\n\t\t\t\t\t\tif err != nil {\n\t\t\t\t\t\t\treturn mval, formatError(err, tval.GetPositionPath([]string{key}))\n\t\t\t\t\t\t}\n\t\t\t\t\t\tmval.Field(i).Set(mvalf)\n\t\t\t\t\t\tfound = true\n\t\t\t\t\t\td.visitor.pop()\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tif !found && opts.defaultValue != \"\" {\n\t\t\t\t\tmvalf := mval.Field(i)\n\t\t\t\t\tvar val interface{}\n\t\t\t\t\tvar err error\n\t\t\t\t\tswitch mvalf.Kind() {\n\t\t\t\t\tcase reflect.String:\n\t\t\t\t\t\tval = opts.defaultValue\n\t\t\t\t\tcase reflect.Bool:\n\t\t\t\t\t\tval, err = strconv.ParseBool(opts.defaultValue)\n\t\t\t\t\tcase reflect.Uint:\n\t\t\t\t\t\tval, err = strconv.ParseUint(opts.defaultValue, 10, 0)\n\t\t\t\t\tcase reflect.Uint8:\n\t\t\t\t\t\tval, err = strconv.ParseUint(opts.defaultValue, 10, 8)\n\t\t\t\t\tcase reflect.Uint16:\n\t\t\t\t\t\tval, err = strconv.ParseUint(opts.defaultValue, 10, 16)\n\t\t\t\t\tcase reflect.Uint32:\n\t\t\t\t\t\tval, err = strconv.ParseUint(opts.defaultValue, 10, 32)\n\t\t\t\t\tcase reflect.Uint64:\n\t\t\t\t\t\tval, err = strconv.ParseUint(opts.defaultValue, 10, 64)\n\t\t\t\t\tcase reflect.Int:\n\t\t\t\t\t\tval, err = strconv.ParseInt(opts.defaultValue, 10, 0)\n\t\t\t\t\tcase reflect.Int8:\n\t\t\t\t\t\tval, err = strconv.ParseInt(opts.defaultValue, 10, 8)\n\t\t\t\t\tcase reflect.Int16:\n\t\t\t\t\t\tval, err = strconv.ParseInt(opts.defaultValue, 10, 16)\n\t\t\t\t\tcase reflect.Int32:\n\t\t\t\t\t\tval, err = strconv.ParseInt(opts.defaultValue, 10, 32)\n\t\t\t\t\tcase reflect.Int64:\n\t\t\t\t\t\t// Check if the provided number has a non-numeric extension.\n\t\t\t\t\t\tvar hasExtension bool\n\t\t\t\t\t\tif len(opts.defaultValue) > 0 {\n\t\t\t\t\t\t\tlastChar := opts.defaultValue[len(opts.defaultValue)-1]\n\t\t\t\t\t\t\tif lastChar < '0' || lastChar > '9' {\n\t\t\t\t\t\t\t\thasExtension = true\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t\t// If the value is a time.Duration with extension, parse as duration.\n\t\t\t\t\t\t// If the value is an int64 or a time.Duration without extension, parse as number.\n\t\t\t\t\t\tif hasExtension && mvalf.Type().String() == \"time.Duration\" {\n\t\t\t\t\t\t\tval, err = time.ParseDuration(opts.defaultValue)\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tval, err = strconv.ParseInt(opts.defaultValue, 10, 64)\n\t\t\t\t\t\t}\n\t\t\t\t\tcase reflect.Float32:\n\t\t\t\t\t\tval, err = strconv.ParseFloat(opts.defaultValue, 32)\n\t\t\t\t\tcase reflect.Float64:\n\t\t\t\t\t\tval, err = strconv.ParseFloat(opts.defaultValue, 64)\n\t\t\t\t\tdefault:\n\t\t\t\t\t\treturn mvalf, fmt.Errorf(\"unsupported field type for default option\")\n\t\t\t\t\t}\n\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn mvalf, err\n\t\t\t\t\t}\n\t\t\t\t\tmvalf.Set(reflect.ValueOf(val).Convert(mvalf.Type()))\n\t\t\t\t}\n\n\t\t\t\t// save the old behavior above and try to check structs\n\t\t\t\tif !found && opts.defaultValue == \"\" && mtypef.Type.Kind() == reflect.Struct {\n\t\t\t\t\ttmpTval := tval\n\t\t\t\t\tif !mtypef.Anonymous {\n\t\t\t\t\t\ttmpTval = nil\n\t\t\t\t\t}\n\t\t\t\t\tfval := mval.Field(i)\n\t\t\t\t\tv, err := d.valueFromTree(mtypef.Type, tmpTval, &fval)\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn v, err\n\t\t\t\t\t}\n\t\t\t\t\tmval.Field(i).Set(v)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\tcase reflect.Map:\n\t\tmval = reflect.MakeMap(mtype)\n\t\tfor _, key := range tval.Keys() {\n\t\t\td.visitor.push(key)\n\t\t\t// TODO: path splits key\n\t\t\tval := tval.GetPath([]string{key})\n\t\t\tmvalf, err := d.valueFromToml(mtype.Elem(), val, nil)\n\t\t\tif err != nil {\n\t\t\t\treturn mval, formatError(err, tval.GetPositionPath([]string{key}))\n\t\t\t}\n\t\t\tmval.SetMapIndex(reflect.ValueOf(key).Convert(mtype.Key()), mvalf)\n\t\t\td.visitor.pop()\n\t\t}\n\t}\n\treturn mval, nil\n}\n\n// Convert toml value to marshal struct/map slice, using marshal type\nfunc (d *Decoder) valueFromTreeSlice(mtype reflect.Type, tval []*Tree) (reflect.Value, error) {\n\tmval, err := makeSliceOrArray(mtype, len(tval))\n\tif err != nil {\n\t\treturn mval, err\n\t}\n\n\tfor i := 0; i < len(tval); i++ {\n\t\td.visitor.push(strconv.Itoa(i))\n\t\tval, err := d.valueFromTree(mtype.Elem(), tval[i], nil)\n\t\tif err != nil {\n\t\t\treturn mval, err\n\t\t}\n\t\tmval.Index(i).Set(val)\n\t\td.visitor.pop()\n\t}\n\treturn mval, nil\n}\n\n// Convert toml value to marshal primitive slice, using marshal type\nfunc (d *Decoder) valueFromOtherSlice(mtype reflect.Type, tval []interface{}) (reflect.Value, error) {\n\tmval, err := makeSliceOrArray(mtype, len(tval))\n\tif err != nil {\n\t\treturn mval, err\n\t}\n\n\tfor i := 0; i < len(tval); i++ {\n\t\tval, err := d.valueFromToml(mtype.Elem(), tval[i], nil)\n\t\tif err != nil {\n\t\t\treturn mval, err\n\t\t}\n\t\tmval.Index(i).Set(val)\n\t}\n\treturn mval, nil\n}\n\n// Convert toml value to marshal primitive slice, using marshal type\nfunc (d *Decoder) valueFromOtherSliceI(mtype reflect.Type, tval interface{}) (reflect.Value, error) {\n\tval := reflect.ValueOf(tval)\n\tlength := val.Len()\n\n\tmval, err := makeSliceOrArray(mtype, length)\n\tif err != nil {\n\t\treturn mval, err\n\t}\n\n\tfor i := 0; i < length; i++ {\n\t\tval, err := d.valueFromToml(mtype.Elem(), val.Index(i).Interface(), nil)\n\t\tif err != nil {\n\t\t\treturn mval, err\n\t\t}\n\t\tmval.Index(i).Set(val)\n\t}\n\treturn mval, nil\n}\n\n// Create a new slice or a new array with specified length\nfunc makeSliceOrArray(mtype reflect.Type, tLength int) (reflect.Value, error) {\n\tvar mval reflect.Value\n\tswitch mtype.Kind() {\n\tcase reflect.Slice:\n\t\tmval = reflect.MakeSlice(mtype, tLength, tLength)\n\tcase reflect.Array:\n\t\tmval = reflect.New(reflect.ArrayOf(mtype.Len(), mtype.Elem())).Elem()\n\t\tif tLength > mtype.Len() {\n\t\t\treturn mval, fmt.Errorf(\"unmarshal: TOML array length (%v) exceeds destination array length (%v)\", tLength, mtype.Len())\n\t\t}\n\t}\n\treturn mval, nil\n}\n\n// Convert toml value to marshal value, using marshal type. When mval1 is non-nil\n// and the given type is a struct value, merge fields into it.\nfunc (d *Decoder) valueFromToml(mtype reflect.Type, tval interface{}, mval1 *reflect.Value) (reflect.Value, error) {\n\tif mtype.Kind() == reflect.Ptr {\n\t\treturn d.unwrapPointer(mtype, tval, mval1)\n\t}\n\n\tswitch t := tval.(type) {\n\tcase *Tree:\n\t\tvar mval11 *reflect.Value\n\t\tif mtype.Kind() == reflect.Struct {\n\t\t\tmval11 = mval1\n\t\t}\n\n\t\tif isTree(mtype) {\n\t\t\treturn d.valueFromTree(mtype, t, mval11)\n\t\t}\n\n\t\tif mtype.Kind() == reflect.Interface {\n\t\t\tif mval1 == nil || mval1.IsNil() {\n\t\t\t\treturn d.valueFromTree(reflect.TypeOf(map[string]interface{}{}), t, nil)\n\t\t\t} else {\n\t\t\t\treturn d.valueFromToml(mval1.Elem().Type(), t, nil)\n\t\t\t}\n\t\t}\n\n\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to a tree\", tval, tval)\n\tcase []*Tree:\n\t\tif isTreeSequence(mtype) {\n\t\t\treturn d.valueFromTreeSlice(mtype, t)\n\t\t}\n\t\tif mtype.Kind() == reflect.Interface {\n\t\t\tif mval1 == nil || mval1.IsNil() {\n\t\t\t\treturn d.valueFromTreeSlice(reflect.TypeOf([]map[string]interface{}{}), t)\n\t\t\t} else {\n\t\t\t\tival := mval1.Elem()\n\t\t\t\treturn d.valueFromToml(mval1.Elem().Type(), t, &ival)\n\t\t\t}\n\t\t}\n\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to trees\", tval, tval)\n\tcase []interface{}:\n\t\td.visitor.visit()\n\t\tif isOtherSequence(mtype) {\n\t\t\treturn d.valueFromOtherSlice(mtype, t)\n\t\t}\n\t\tif mtype.Kind() == reflect.Interface {\n\t\t\tif mval1 == nil || mval1.IsNil() {\n\t\t\t\treturn d.valueFromOtherSlice(reflect.TypeOf([]interface{}{}), t)\n\t\t\t} else {\n\t\t\t\tival := mval1.Elem()\n\t\t\t\treturn d.valueFromToml(mval1.Elem().Type(), t, &ival)\n\t\t\t}\n\t\t}\n\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to a slice\", tval, tval)\n\tdefault:\n\t\td.visitor.visit()\n\t\tmvalPtr := reflect.New(mtype)\n\n\t\t// Check if pointer to value implements the Unmarshaler interface.\n\t\tif isCustomUnmarshaler(mvalPtr.Type()) {\n\t\t\tif err := callCustomUnmarshaler(mvalPtr, tval); err != nil {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"unmarshal toml: %v\", err)\n\t\t\t}\n\t\t\treturn mvalPtr.Elem(), nil\n\t\t}\n\n\t\t// Check if pointer to value implements the encoding.TextUnmarshaler.\n\t\tif isTextUnmarshaler(mvalPtr.Type()) && !isTimeType(mtype) {\n\t\t\tif err := d.unmarshalText(tval, mvalPtr); err != nil {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"unmarshal text: %v\", err)\n\t\t\t}\n\t\t\treturn mvalPtr.Elem(), nil\n\t\t}\n\n\t\tswitch mtype.Kind() {\n\t\tcase reflect.Bool, reflect.Struct:\n\t\t\tval := reflect.ValueOf(tval)\n\n\t\t\tswitch val.Type() {\n\t\t\tcase localDateType:\n\t\t\t\tlocalDate := val.Interface().(LocalDate)\n\t\t\t\tswitch mtype {\n\t\t\t\tcase timeType:\n\t\t\t\t\treturn reflect.ValueOf(time.Date(localDate.Year, localDate.Month, localDate.Day, 0, 0, 0, 0, time.Local)), nil\n\t\t\t\t}\n\t\t\tcase localDateTimeType:\n\t\t\t\tlocalDateTime := val.Interface().(LocalDateTime)\n\t\t\t\tswitch mtype {\n\t\t\t\tcase timeType:\n\t\t\t\t\treturn reflect.ValueOf(time.Date(\n\t\t\t\t\t\tlocalDateTime.Date.Year,\n\t\t\t\t\t\tlocalDateTime.Date.Month,\n\t\t\t\t\t\tlocalDateTime.Date.Day,\n\t\t\t\t\t\tlocalDateTime.Time.Hour,\n\t\t\t\t\t\tlocalDateTime.Time.Minute,\n\t\t\t\t\t\tlocalDateTime.Time.Second,\n\t\t\t\t\t\tlocalDateTime.Time.Nanosecond,\n\t\t\t\t\t\ttime.Local)), nil\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// if this passes for when mtype is reflect.Struct, tval is a time.LocalTime\n\t\t\tif !val.Type().ConvertibleTo(mtype) {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to %v\", tval, tval, mtype.String())\n\t\t\t}\n\n\t\t\treturn val.Convert(mtype), nil\n\t\tcase reflect.String:\n\t\t\tval := reflect.ValueOf(tval)\n\t\t\t// stupidly, int64 is convertible to string. So special case this.\n\t\t\tif !val.Type().ConvertibleTo(mtype) || val.Kind() == reflect.Int64 {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to %v\", tval, tval, mtype.String())\n\t\t\t}\n\n\t\t\treturn val.Convert(mtype), nil\n\t\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\t\tval := reflect.ValueOf(tval)\n\t\t\tif mtype.Kind() == reflect.Int64 && mtype == reflect.TypeOf(time.Duration(1)) && val.Kind() == reflect.String {\n\t\t\t\td, err := time.ParseDuration(val.String())\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to %v. %s\", tval, tval, mtype.String(), err)\n\t\t\t\t}\n\t\t\t\treturn reflect.ValueOf(d), nil\n\t\t\t}\n\t\t\tif !val.Type().ConvertibleTo(mtype) || val.Kind() == reflect.Float64 {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to %v\", tval, tval, mtype.String())\n\t\t\t}\n\t\t\tif reflect.Indirect(reflect.New(mtype)).OverflowInt(val.Convert(reflect.TypeOf(int64(0))).Int()) {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"%v(%T) would overflow %v\", tval, tval, mtype.String())\n\t\t\t}\n\n\t\t\treturn val.Convert(mtype), nil\n\t\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\t\tval := reflect.ValueOf(tval)\n\t\t\tif !val.Type().ConvertibleTo(mtype) || val.Kind() == reflect.Float64 {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to %v\", tval, tval, mtype.String())\n\t\t\t}\n\n\t\t\tif val.Type().Kind() != reflect.Uint64 && val.Convert(reflect.TypeOf(int(1))).Int() < 0 {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"%v(%T) is negative so does not fit in %v\", tval, tval, mtype.String())\n\t\t\t}\n\t\t\tif reflect.Indirect(reflect.New(mtype)).OverflowUint(val.Convert(reflect.TypeOf(uint64(0))).Uint()) {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"%v(%T) would overflow %v\", tval, tval, mtype.String())\n\t\t\t}\n\n\t\t\treturn val.Convert(mtype), nil\n\t\tcase reflect.Float32, reflect.Float64:\n\t\t\tval := reflect.ValueOf(tval)\n\t\t\tif !val.Type().ConvertibleTo(mtype) || val.Kind() == reflect.Int64 {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to %v\", tval, tval, mtype.String())\n\t\t\t}\n\t\t\tif reflect.Indirect(reflect.New(mtype)).OverflowFloat(val.Convert(reflect.TypeOf(float64(0))).Float()) {\n\t\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"%v(%T) would overflow %v\", tval, tval, mtype.String())\n\t\t\t}\n\n\t\t\treturn val.Convert(mtype), nil\n\t\tcase reflect.Interface:\n\t\t\tif mval1 == nil || mval1.IsNil() {\n\t\t\t\treturn reflect.ValueOf(tval), nil\n\t\t\t} else {\n\t\t\t\tival := mval1.Elem()\n\t\t\t\treturn d.valueFromToml(mval1.Elem().Type(), t, &ival)\n\t\t\t}\n\t\tcase reflect.Slice, reflect.Array:\n\t\t\tif isOtherSequence(mtype) && isOtherSequence(reflect.TypeOf(t)) {\n\t\t\t\treturn d.valueFromOtherSliceI(mtype, t)\n\t\t\t}\n\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to %v(%v)\", tval, tval, mtype, mtype.Kind())\n\t\tdefault:\n\t\t\treturn reflect.ValueOf(nil), fmt.Errorf(\"Can't convert %v(%T) to %v(%v)\", tval, tval, mtype, mtype.Kind())\n\t\t}\n\t}\n}\n\nfunc (d *Decoder) unwrapPointer(mtype reflect.Type, tval interface{}, mval1 *reflect.Value) (reflect.Value, error) {\n\tvar melem *reflect.Value\n\n\tif mval1 != nil && !mval1.IsNil() && (mtype.Elem().Kind() == reflect.Struct || mtype.Elem().Kind() == reflect.Interface) {\n\t\telem := mval1.Elem()\n\t\tmelem = &elem\n\t}\n\n\tval, err := d.valueFromToml(mtype.Elem(), tval, melem)\n\tif err != nil {\n\t\treturn reflect.ValueOf(nil), err\n\t}\n\tmval := reflect.New(mtype.Elem())\n\tmval.Elem().Set(val)\n\treturn mval, nil\n}\n\nfunc (d *Decoder) unmarshalText(tval interface{}, mval reflect.Value) error {\n\tvar buf bytes.Buffer\n\tfmt.Fprint(&buf, tval)\n\treturn callTextUnmarshaler(mval, buf.Bytes())\n}\n\nfunc tomlOptions(vf reflect.StructField, an annotation) tomlOpts {\n\ttag := vf.Tag.Get(an.tag)\n\tparse := strings.Split(tag, \",\")\n\tvar comment string\n\tif c := vf.Tag.Get(an.comment); c != \"\" {\n\t\tcomment = c\n\t}\n\tcommented, _ := strconv.ParseBool(vf.Tag.Get(an.commented))\n\tmultiline, _ := strconv.ParseBool(vf.Tag.Get(an.multiline))\n\tliteral, _ := strconv.ParseBool(vf.Tag.Get(an.literal))\n\tdefaultValue := vf.Tag.Get(tagDefault)\n\tresult := tomlOpts{\n\t\tname: vf.Name,\n\t\tnameFromTag: false,\n\t\tcomment: comment,\n\t\tcommented: commented,\n\t\tmultiline: multiline,\n\t\tliteral: literal,\n\t\tinclude: true,\n\t\tomitempty: false,\n\t\tdefaultValue: defaultValue,\n\t}\n\tif parse[0] != \"\" {\n\t\tif parse[0] == \"-\" && len(parse) == 1 {\n\t\t\tresult.include = false\n\t\t} else {\n\t\t\tresult.name = strings.Trim(parse[0], \" \")\n\t\t\tresult.nameFromTag = true\n\t\t}\n\t}\n\tif vf.PkgPath != \"\" {\n\t\tresult.include = false\n\t}\n\tif len(parse) > 1 && strings.Trim(parse[1], \" \") == \"omitempty\" {\n\t\tresult.omitempty = true\n\t}\n\tif vf.Type.Kind() == reflect.Ptr {\n\t\tresult.omitempty = true\n\t}\n\treturn result\n}\n\nfunc isZero(val reflect.Value) bool {\n\tswitch val.Type().Kind() {\n\tcase reflect.Slice, reflect.Array, reflect.Map:\n\t\treturn val.Len() == 0\n\tdefault:\n\t\treturn reflect.DeepEqual(val.Interface(), reflect.Zero(val.Type()).Interface())\n\t}\n}\n\nfunc formatError(err error, pos Position) error {\n\tif err.Error()[0] == '(' { // Error already contains position information\n\t\treturn err\n\t}\n\treturn fmt.Errorf(\"%s: %s\", pos, err)\n}\n\n// visitorState keeps track of which keys were unmarshaled.\ntype visitorState struct {\n\ttree *Tree\n\tpath []string\n\tkeys map[string]struct{}\n\tactive bool\n}\n\nfunc newVisitorState(tree *Tree) visitorState {\n\tpath, result := []string{}, map[string]struct{}{}\n\tinsertKeys(path, result, tree)\n\treturn visitorState{\n\t\ttree: tree,\n\t\tpath: path[:0],\n\t\tkeys: result,\n\t\tactive: true,\n\t}\n}\n\nfunc (s *visitorState) push(key string) {\n\tif s.active {\n\t\ts.path = append(s.path, key)\n\t}\n}\n\nfunc (s *visitorState) pop() {\n\tif s.active {\n\t\ts.path = s.path[:len(s.path)-1]\n\t}\n}\n\nfunc (s *visitorState) visit() {\n\tif s.active {\n\t\tdelete(s.keys, strings.Join(s.path, \".\"))\n\t}\n}\n\nfunc (s *visitorState) visitAll() {\n\tif s.active {\n\t\tfor k := range s.keys {\n\t\t\tif strings.HasPrefix(k, strings.Join(s.path, \".\")) {\n\t\t\t\tdelete(s.keys, k)\n\t\t\t}\n\t\t}\n\t}\n}\n\nfunc (s *visitorState) validate() error {\n\tif !s.active {\n\t\treturn nil\n\t}\n\tundecoded := make([]string, 0, len(s.keys))\n\tfor key := range s.keys {\n\t\tundecoded = append(undecoded, key)\n\t}\n\tsort.Strings(undecoded)\n\tif len(undecoded) > 0 {\n\t\treturn fmt.Errorf(\"undecoded keys: %q\", undecoded)\n\t}\n\treturn nil\n}\n\nfunc insertKeys(path []string, m map[string]struct{}, tree *Tree) {\n\tfor k, v := range tree.values {\n\t\tswitch node := v.(type) {\n\t\tcase []*Tree:\n\t\t\tfor i, item := range node {\n\t\t\t\tinsertKeys(append(path, k, strconv.Itoa(i)), m, item)\n\t\t\t}\n\t\tcase *Tree:\n\t\t\tinsertKeys(append(path, k), m, node)\n\t\tcase *tomlValue:\n\t\t\tm[strings.Join(append(path, k), \".\")] = struct{}{}\n\t\t}\n\t}\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/marshal_OrderPreserve_test.toml",
"content": "title = \"TOML Marshal Testing\"\n\n[basic_lists]\n floats = [12.3,45.6,78.9]\n bools = [true,false,true]\n dates = [1979-05-27T07:32:00Z,1980-05-27T07:32:00Z]\n ints = [8001,8001,8002]\n uints = [5002,5003]\n strings = [\"One\",\"Two\",\"Three\"]\n\n[[subdocptrs]]\n name = \"Second\"\n\n[basic_map]\n one = \"one\"\n two = \"two\"\n\n[subdoc]\n\n [subdoc.second]\n name = \"Second\"\n\n [subdoc.first]\n name = \"First\"\n\n[basic]\n uint = 5001\n bool = true\n float = 123.4\n float64 = 123.456782132399\n int = 5000\n string = \"Bite me\"\n date = 1979-05-27T07:32:00Z\n\n[[subdoclist]]\n name = \"List.First\"\n\n[[subdoclist]]\n name = \"List.Second\"\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/marshal_test.toml",
"content": "title = \"TOML Marshal Testing\"\n\n[basic]\n bool = true\n date = 1979-05-27T07:32:00Z\n float = 123.4\n float64 = 123.456782132399\n int = 5000\n string = \"Bite me\"\n uint = 5001\n\n[basic_lists]\n bools = [true,false,true]\n dates = [1979-05-27T07:32:00Z,1980-05-27T07:32:00Z]\n floats = [12.3,45.6,78.9]\n ints = [8001,8001,8002]\n strings = [\"One\",\"Two\",\"Three\"]\n uints = [5002,5003]\n\n[basic_map]\n one = \"one\"\n two = \"two\"\n\n[subdoc]\n\n [subdoc.first]\n name = \"First\"\n\n [subdoc.second]\n name = \"Second\"\n\n[[subdoclist]]\n name = \"List.First\"\n\n[[subdoclist]]\n name = \"List.Second\"\n\n[[subdocptrs]]\n name = \"Second\"\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/parser.go",
"content": "// TOML Parser.\n\npackage toml\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"math\"\n\t\"reflect\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n)\n\ntype tomlParser struct {\n\tflowIdx int\n\tflow []token\n\ttree *Tree\n\tcurrentTable []string\n\tseenTableKeys []string\n}\n\ntype tomlParserStateFn func() tomlParserStateFn\n\n// Formats and panics an error message based on a token\nfunc (p *tomlParser) raiseError(tok *token, msg string, args ...interface{}) {\n\tpanic(tok.Position.String() + \": \" + fmt.Sprintf(msg, args...))\n}\n\nfunc (p *tomlParser) run() {\n\tfor state := p.parseStart; state != nil; {\n\t\tstate = state()\n\t}\n}\n\nfunc (p *tomlParser) peek() *token {\n\tif p.flowIdx >= len(p.flow) {\n\t\treturn nil\n\t}\n\treturn &p.flow[p.flowIdx]\n}\n\nfunc (p *tomlParser) assume(typ tokenType) {\n\ttok := p.getToken()\n\tif tok == nil {\n\t\tp.raiseError(tok, \"was expecting token %s, but token stream is empty\", tok)\n\t}\n\tif tok.typ != typ {\n\t\tp.raiseError(tok, \"was expecting token %s, but got %s instead\", typ, tok)\n\t}\n}\n\nfunc (p *tomlParser) getToken() *token {\n\ttok := p.peek()\n\tif tok == nil {\n\t\treturn nil\n\t}\n\tp.flowIdx++\n\treturn tok\n}\n\nfunc (p *tomlParser) parseStart() tomlParserStateFn {\n\ttok := p.peek()\n\n\t// end of stream, parsing is finished\n\tif tok == nil {\n\t\treturn nil\n\t}\n\n\tswitch tok.typ {\n\tcase tokenDoubleLeftBracket:\n\t\treturn p.parseGroupArray\n\tcase tokenLeftBracket:\n\t\treturn p.parseGroup\n\tcase tokenKey:\n\t\treturn p.parseAssign\n\tcase tokenEOF:\n\t\treturn nil\n\tcase tokenError:\n\t\tp.raiseError(tok, \"parsing error: %s\", tok.String())\n\tdefault:\n\t\tp.raiseError(tok, \"unexpected token %s\", tok.typ)\n\t}\n\treturn nil\n}\n\nfunc (p *tomlParser) parseGroupArray() tomlParserStateFn {\n\tstartToken := p.getToken() // discard the [[\n\tkey := p.getToken()\n\tif key.typ != tokenKeyGroupArray {\n\t\tp.raiseError(key, \"unexpected token %s, was expecting a table array key\", key)\n\t}\n\n\t// get or create table array element at the indicated part in the path\n\tkeys, err := parseKey(key.val)\n\tif err != nil {\n\t\tp.raiseError(key, \"invalid table array key: %s\", err)\n\t}\n\tp.tree.createSubTree(keys[:len(keys)-1], startToken.Position) // create parent entries\n\tdestTree := p.tree.GetPath(keys)\n\tvar array []*Tree\n\tif destTree == nil {\n\t\tarray = make([]*Tree, 0)\n\t} else if target, ok := destTree.([]*Tree); ok && target != nil {\n\t\tarray = destTree.([]*Tree)\n\t} else {\n\t\tp.raiseError(key, \"key %s is already assigned and not of type table array\", key)\n\t}\n\tp.currentTable = keys\n\n\t// add a new tree to the end of the table array\n\tnewTree := newTree()\n\tnewTree.position = startToken.Position\n\tarray = append(array, newTree)\n\tp.tree.SetPath(p.currentTable, array)\n\n\t// remove all keys that were children of this table array\n\tprefix := key.val + \".\"\n\tfound := false\n\tfor ii := 0; ii < len(p.seenTableKeys); {\n\t\ttableKey := p.seenTableKeys[ii]\n\t\tif strings.HasPrefix(tableKey, prefix) {\n\t\t\tp.seenTableKeys = append(p.seenTableKeys[:ii], p.seenTableKeys[ii+1:]...)\n\t\t} else {\n\t\t\tfound = (tableKey == key.val)\n\t\t\tii++\n\t\t}\n\t}\n\n\t// keep this key name from use by other kinds of assignments\n\tif !found {\n\t\tp.seenTableKeys = append(p.seenTableKeys, key.val)\n\t}\n\n\t// move to next parser state\n\tp.assume(tokenDoubleRightBracket)\n\treturn p.parseStart\n}\n\nfunc (p *tomlParser) parseGroup() tomlParserStateFn {\n\tstartToken := p.getToken() // discard the [\n\tkey := p.getToken()\n\tif key.typ != tokenKeyGroup {\n\t\tp.raiseError(key, \"unexpected token %s, was expecting a table key\", key)\n\t}\n\tfor _, item := range p.seenTableKeys {\n\t\tif item == key.val {\n\t\t\tp.raiseError(key, \"duplicated tables\")\n\t\t}\n\t}\n\n\tp.seenTableKeys = append(p.seenTableKeys, key.val)\n\tkeys, err := parseKey(key.val)\n\tif err != nil {\n\t\tp.raiseError(key, \"invalid table array key: %s\", err)\n\t}\n\tif err := p.tree.createSubTree(keys, startToken.Position); err != nil {\n\t\tp.raiseError(key, \"%s\", err)\n\t}\n\tdestTree := p.tree.GetPath(keys)\n\tif target, ok := destTree.(*Tree); ok && target != nil && target.inline {\n\t\tp.raiseError(key, \"could not re-define exist inline table or its sub-table : %s\",\n\t\t\tstrings.Join(keys, \".\"))\n\t}\n\tp.assume(tokenRightBracket)\n\tp.currentTable = keys\n\treturn p.parseStart\n}\n\nfunc (p *tomlParser) parseAssign() tomlParserStateFn {\n\tkey := p.getToken()\n\tp.assume(tokenEqual)\n\n\tparsedKey, err := parseKey(key.val)\n\tif err != nil {\n\t\tp.raiseError(key, \"invalid key: %s\", err.Error())\n\t}\n\n\tvalue := p.parseRvalue()\n\tvar tableKey []string\n\tif len(p.currentTable) > 0 {\n\t\ttableKey = p.currentTable\n\t} else {\n\t\ttableKey = []string{}\n\t}\n\n\tprefixKey := parsedKey[0 : len(parsedKey)-1]\n\ttableKey = append(tableKey, prefixKey...)\n\n\t// find the table to assign, looking out for arrays of tables\n\tvar targetNode *Tree\n\tswitch node := p.tree.GetPath(tableKey).(type) {\n\tcase []*Tree:\n\t\ttargetNode = node[len(node)-1]\n\tcase *Tree:\n\t\ttargetNode = node\n\tcase nil:\n\t\t// create intermediate\n\t\tif err := p.tree.createSubTree(tableKey, key.Position); err != nil {\n\t\t\tp.raiseError(key, \"could not create intermediate group: %s\", err)\n\t\t}\n\t\ttargetNode = p.tree.GetPath(tableKey).(*Tree)\n\tdefault:\n\t\tp.raiseError(key, \"Unknown table type for path: %s\",\n\t\t\tstrings.Join(tableKey, \".\"))\n\t}\n\n\tif targetNode.inline {\n\t\tp.raiseError(key, \"could not add key or sub-table to exist inline table or its sub-table : %s\",\n\t\t\tstrings.Join(tableKey, \".\"))\n\t}\n\n\t// assign value to the found table\n\tkeyVal := parsedKey[len(parsedKey)-1]\n\tlocalKey := []string{keyVal}\n\tfinalKey := append(tableKey, keyVal)\n\tif targetNode.GetPath(localKey) != nil {\n\t\tp.raiseError(key, \"The following key was defined twice: %s\",\n\t\t\tstrings.Join(finalKey, \".\"))\n\t}\n\tvar toInsert interface{}\n\n\tswitch value.(type) {\n\tcase *Tree, []*Tree:\n\t\ttoInsert = value\n\tdefault:\n\t\ttoInsert = &tomlValue{value: value, position: key.Position}\n\t}\n\ttargetNode.values[keyVal] = toInsert\n\treturn p.parseStart\n}\n\nvar errInvalidUnderscore = errors.New(\"invalid use of _ in number\")\n\nfunc numberContainsInvalidUnderscore(value string) error {\n\t// For large numbers, you may use underscores between digits to enhance\n\t// readability. Each underscore must be surrounded by at least one digit on\n\t// each side.\n\n\thasBefore := false\n\tfor idx, r := range value {\n\t\tif r == '_' {\n\t\t\tif !hasBefore || idx+1 >= len(value) {\n\t\t\t\t// can't end with an underscore\n\t\t\t\treturn errInvalidUnderscore\n\t\t\t}\n\t\t}\n\t\thasBefore = isDigit(r)\n\t}\n\treturn nil\n}\n\nvar errInvalidUnderscoreHex = errors.New(\"invalid use of _ in hex number\")\n\nfunc hexNumberContainsInvalidUnderscore(value string) error {\n\thasBefore := false\n\tfor idx, r := range value {\n\t\tif r == '_' {\n\t\t\tif !hasBefore || idx+1 >= len(value) {\n\t\t\t\t// can't end with an underscore\n\t\t\t\treturn errInvalidUnderscoreHex\n\t\t\t}\n\t\t}\n\t\thasBefore = isHexDigit(r)\n\t}\n\treturn nil\n}\n\nfunc cleanupNumberToken(value string) string {\n\tcleanedVal := strings.Replace(value, \"_\", \"\", -1)\n\treturn cleanedVal\n}\n\nfunc (p *tomlParser) parseRvalue() interface{} {\n\ttok := p.getToken()\n\tif tok == nil || tok.typ == tokenEOF {\n\t\tp.raiseError(tok, \"expecting a value\")\n\t}\n\n\tswitch tok.typ {\n\tcase tokenString:\n\t\treturn tok.val\n\tcase tokenTrue:\n\t\treturn true\n\tcase tokenFalse:\n\t\treturn false\n\tcase tokenInf:\n\t\tif tok.val[0] == '-' {\n\t\t\treturn math.Inf(-1)\n\t\t}\n\t\treturn math.Inf(1)\n\tcase tokenNan:\n\t\treturn math.NaN()\n\tcase tokenInteger:\n\t\tcleanedVal := cleanupNumberToken(tok.val)\n\t\tbase := 10\n\t\ts := cleanedVal\n\t\tcheckInvalidUnderscore := numberContainsInvalidUnderscore\n\t\tif len(cleanedVal) >= 3 && cleanedVal[0] == '0' {\n\t\t\tswitch cleanedVal[1] {\n\t\t\tcase 'x':\n\t\t\t\tcheckInvalidUnderscore = hexNumberContainsInvalidUnderscore\n\t\t\t\tbase = 16\n\t\t\tcase 'o':\n\t\t\t\tbase = 8\n\t\t\tcase 'b':\n\t\t\t\tbase = 2\n\t\t\tdefault:\n\t\t\t\tpanic(\"invalid base\") // the lexer should catch this first\n\t\t\t}\n\t\t\ts = cleanedVal[2:]\n\t\t}\n\n\t\terr := checkInvalidUnderscore(tok.val)\n\t\tif err != nil {\n\t\t\tp.raiseError(tok, \"%s\", err)\n\t\t}\n\n\t\tvar val interface{}\n\t\tval, err = strconv.ParseInt(s, base, 64)\n\t\tif err == nil {\n\t\t\treturn val\n\t\t}\n\n\t\tif s[0] != '-' {\n\t\t\tif val, err = strconv.ParseUint(s, base, 64); err == nil {\n\t\t\t\treturn val\n\t\t\t}\n\t\t}\n\t\tp.raiseError(tok, \"%s\", err)\n\tcase tokenFloat:\n\t\terr := numberContainsInvalidUnderscore(tok.val)\n\t\tif err != nil {\n\t\t\tp.raiseError(tok, \"%s\", err)\n\t\t}\n\t\tcleanedVal := cleanupNumberToken(tok.val)\n\t\tval, err := strconv.ParseFloat(cleanedVal, 64)\n\t\tif err != nil {\n\t\t\tp.raiseError(tok, \"%s\", err)\n\t\t}\n\t\treturn val\n\tcase tokenLocalTime:\n\t\tval, err := ParseLocalTime(tok.val)\n\t\tif err != nil {\n\t\t\tp.raiseError(tok, \"%s\", err)\n\t\t}\n\t\treturn val\n\tcase tokenLocalDate:\n\t\t// a local date may be followed by:\n\t\t// * nothing: this is a local date\n\t\t// * a local time: this is a local date-time\n\n\t\tnext := p.peek()\n\t\tif next == nil || next.typ != tokenLocalTime {\n\t\t\tval, err := ParseLocalDate(tok.val)\n\t\t\tif err != nil {\n\t\t\t\tp.raiseError(tok, \"%s\", err)\n\t\t\t}\n\t\t\treturn val\n\t\t}\n\n\t\tlocalDate := tok\n\t\tlocalTime := p.getToken()\n\n\t\tnext = p.peek()\n\t\tif next == nil || next.typ != tokenTimeOffset {\n\t\t\tv := localDate.val + \"T\" + localTime.val\n\t\t\tval, err := ParseLocalDateTime(v)\n\t\t\tif err != nil {\n\t\t\t\tp.raiseError(tok, \"%s\", err)\n\t\t\t}\n\t\t\treturn val\n\t\t}\n\n\t\toffset := p.getToken()\n\n\t\tlayout := time.RFC3339Nano\n\t\tv := localDate.val + \"T\" + localTime.val + offset.val\n\t\tval, err := time.ParseInLocation(layout, v, time.UTC)\n\t\tif err != nil {\n\t\t\tp.raiseError(tok, \"%s\", err)\n\t\t}\n\t\treturn val\n\tcase tokenLeftBracket:\n\t\treturn p.parseArray()\n\tcase tokenLeftCurlyBrace:\n\t\treturn p.parseInlineTable()\n\tcase tokenEqual:\n\t\tp.raiseError(tok, \"cannot have multiple equals for the same key\")\n\tcase tokenError:\n\t\tp.raiseError(tok, \"%s\", tok)\n\tdefault:\n\t\tpanic(fmt.Errorf(\"unhandled token: %v\", tok))\n\t}\n\n\treturn nil\n}\n\nfunc tokenIsComma(t *token) bool {\n\treturn t != nil && t.typ == tokenComma\n}\n\nfunc (p *tomlParser) parseInlineTable() *Tree {\n\ttree := newTree()\n\tvar previous *token\nLoop:\n\tfor {\n\t\tfollow := p.peek()\n\t\tif follow == nil || follow.typ == tokenEOF {\n\t\t\tp.raiseError(follow, \"unterminated inline table\")\n\t\t}\n\t\tswitch follow.typ {\n\t\tcase tokenRightCurlyBrace:\n\t\t\tp.getToken()\n\t\t\tbreak Loop\n\t\tcase tokenKey, tokenInteger, tokenString:\n\t\t\tif !tokenIsComma(previous) && previous != nil {\n\t\t\t\tp.raiseError(follow, \"comma expected between fields in inline table\")\n\t\t\t}\n\t\t\tkey := p.getToken()\n\t\t\tp.assume(tokenEqual)\n\n\t\t\tparsedKey, err := parseKey(key.val)\n\t\t\tif err != nil {\n\t\t\t\tp.raiseError(key, \"invalid key: %s\", err)\n\t\t\t}\n\n\t\t\tvalue := p.parseRvalue()\n\t\t\ttree.SetPath(parsedKey, value)\n\t\tcase tokenComma:\n\t\t\tif tokenIsComma(previous) {\n\t\t\t\tp.raiseError(follow, \"need field between two commas in inline table\")\n\t\t\t}\n\t\t\tp.getToken()\n\t\tdefault:\n\t\t\tp.raiseError(follow, \"unexpected token type in inline table: %s\", follow.String())\n\t\t}\n\t\tprevious = follow\n\t}\n\tif tokenIsComma(previous) {\n\t\tp.raiseError(previous, \"trailing comma at the end of inline table\")\n\t}\n\ttree.inline = true\n\treturn tree\n}\n\nfunc (p *tomlParser) parseArray() interface{} {\n\tvar array []interface{}\n\tarrayType := reflect.TypeOf(newTree())\n\tfor {\n\t\tfollow := p.peek()\n\t\tif follow == nil || follow.typ == tokenEOF {\n\t\t\tp.raiseError(follow, \"unterminated array\")\n\t\t}\n\t\tif follow.typ == tokenRightBracket {\n\t\t\tp.getToken()\n\t\t\tbreak\n\t\t}\n\t\tval := p.parseRvalue()\n\t\tif reflect.TypeOf(val) != arrayType {\n\t\t\tarrayType = nil\n\t\t}\n\t\tarray = append(array, val)\n\t\tfollow = p.peek()\n\t\tif follow == nil || follow.typ == tokenEOF {\n\t\t\tp.raiseError(follow, \"unterminated array\")\n\t\t}\n\t\tif follow.typ != tokenRightBracket && follow.typ != tokenComma {\n\t\t\tp.raiseError(follow, \"missing comma\")\n\t\t}\n\t\tif follow.typ == tokenComma {\n\t\t\tp.getToken()\n\t\t}\n\t}\n\n\t// if the array is a mixed-type array or its length is 0,\n\t// don't convert it to a table array\n\tif len(array) <= 0 {\n\t\tarrayType = nil\n\t}\n\t// An array of Trees is actually an array of inline\n\t// tables, which is a shorthand for a table array. If the\n\t// array was not converted from []interface{} to []*Tree,\n\t// the two notations would not be equivalent.\n\tif arrayType == reflect.TypeOf(newTree()) {\n\t\ttomlArray := make([]*Tree, len(array))\n\t\tfor i, v := range array {\n\t\t\ttomlArray[i] = v.(*Tree)\n\t\t}\n\t\treturn tomlArray\n\t}\n\treturn array\n}\n\nfunc parseToml(flow []token) *Tree {\n\tresult := newTree()\n\tresult.position = Position{1, 1}\n\tparser := &tomlParser{\n\t\tflowIdx: 0,\n\t\tflow: flow,\n\t\ttree: result,\n\t\tcurrentTable: make([]string, 0),\n\t\tseenTableKeys: make([]string, 0),\n\t}\n\tparser.run()\n\treturn result\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/position.go",
"content": "// Position support for go-toml\n\npackage toml\n\nimport (\n\t\"fmt\"\n)\n\n// Position of a document element within a TOML document.\n//\n// Line and Col are both 1-indexed positions for the element's line number and\n// column number, respectively. Values of zero or less will cause Invalid(),\n// to return true.\ntype Position struct {\n\tLine int // line within the document\n\tCol int // column within the line\n}\n\n// String representation of the position.\n// Displays 1-indexed line and column numbers.\nfunc (p Position) String() string {\n\treturn fmt.Sprintf(\"(%d, %d)\", p.Line, p.Col)\n}\n\n// Invalid returns whether or not the position is valid (i.e. with negative or\n// null values)\nfunc (p Position) Invalid() bool {\n\treturn p.Line <= 0 || p.Col <= 0\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/token.go",
"content": "package toml\n\nimport \"fmt\"\n\n// Define tokens\ntype tokenType int\n\nconst (\n\teof = -(iota + 1)\n)\n\nconst (\n\ttokenError tokenType = iota\n\ttokenEOF\n\ttokenComment\n\ttokenKey\n\ttokenString\n\ttokenInteger\n\ttokenTrue\n\ttokenFalse\n\ttokenFloat\n\ttokenInf\n\ttokenNan\n\ttokenEqual\n\ttokenLeftBracket\n\ttokenRightBracket\n\ttokenLeftCurlyBrace\n\ttokenRightCurlyBrace\n\ttokenLeftParen\n\ttokenRightParen\n\ttokenDoubleLeftBracket\n\ttokenDoubleRightBracket\n\ttokenLocalDate\n\ttokenLocalTime\n\ttokenTimeOffset\n\ttokenKeyGroup\n\ttokenKeyGroupArray\n\ttokenComma\n\ttokenColon\n\ttokenDollar\n\ttokenStar\n\ttokenQuestion\n\ttokenDot\n\ttokenDotDot\n\ttokenEOL\n)\n\nvar tokenTypeNames = []string{\n\t\"Error\",\n\t\"EOF\",\n\t\"Comment\",\n\t\"Key\",\n\t\"String\",\n\t\"Integer\",\n\t\"True\",\n\t\"False\",\n\t\"Float\",\n\t\"Inf\",\n\t\"NaN\",\n\t\"=\",\n\t\"[\",\n\t\"]\",\n\t\"{\",\n\t\"}\",\n\t\"(\",\n\t\")\",\n\t\"]]\",\n\t\"[[\",\n\t\"LocalDate\",\n\t\"LocalTime\",\n\t\"TimeOffset\",\n\t\"KeyGroup\",\n\t\"KeyGroupArray\",\n\t\",\",\n\t\":\",\n\t\"$\",\n\t\"*\",\n\t\"?\",\n\t\".\",\n\t\"..\",\n\t\"EOL\",\n}\n\ntype token struct {\n\tPosition\n\ttyp tokenType\n\tval string\n}\n\nfunc (tt tokenType) String() string {\n\tidx := int(tt)\n\tif idx < len(tokenTypeNames) {\n\t\treturn tokenTypeNames[idx]\n\t}\n\treturn \"Unknown\"\n}\n\nfunc (t token) String() string {\n\tswitch t.typ {\n\tcase tokenEOF:\n\t\treturn \"EOF\"\n\tcase tokenError:\n\t\treturn t.val\n\t}\n\n\treturn fmt.Sprintf(\"%q\", t.val)\n}\n\nfunc isSpace(r rune) bool {\n\treturn r == ' ' || r == '\\t'\n}\n\nfunc isAlphanumeric(r rune) bool {\n\treturn 'a' <= r && r <= 'z' || 'A' <= r && r <= 'Z' || r == '_'\n}\n\nfunc isKeyChar(r rune) bool {\n\t// Keys start with the first character that isn't whitespace or [ and end\n\t// with the last non-whitespace character before the equals sign. Keys\n\t// cannot contain a # character.\"\n\treturn !(r == '\\r' || r == '\\n' || r == eof || r == '=')\n}\n\nfunc isKeyStartChar(r rune) bool {\n\treturn !(isSpace(r) || r == '\\r' || r == '\\n' || r == eof || r == '[')\n}\n\nfunc isDigit(r rune) bool {\n\treturn '0' <= r && r <= '9'\n}\n\nfunc isHexDigit(r rune) bool {\n\treturn isDigit(r) ||\n\t\t(r >= 'a' && r <= 'f') ||\n\t\t(r >= 'A' && r <= 'F')\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/toml.go",
"content": "package toml\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"io/ioutil\"\n\t\"os\"\n\t\"runtime\"\n\t\"strings\"\n)\n\ntype tomlValue struct {\n\tvalue interface{} // string, int64, uint64, float64, bool, time.Time, [] of any of this list\n\tcomment string\n\tcommented bool\n\tmultiline bool\n\tliteral bool\n\tposition Position\n}\n\n// Tree is the result of the parsing of a TOML file.\ntype Tree struct {\n\tvalues map[string]interface{} // string -> *tomlValue, *Tree, []*Tree\n\tcomment string\n\tcommented bool\n\tinline bool\n\tposition Position\n}\n\nfunc newTree() *Tree {\n\treturn newTreeWithPosition(Position{})\n}\n\nfunc newTreeWithPosition(pos Position) *Tree {\n\treturn &Tree{\n\t\tvalues: make(map[string]interface{}),\n\t\tposition: pos,\n\t}\n}\n\n// TreeFromMap initializes a new Tree object using the given map.\nfunc TreeFromMap(m map[string]interface{}) (*Tree, error) {\n\tresult, err := toTree(m)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn result.(*Tree), nil\n}\n\n// Position returns the position of the tree.\nfunc (t *Tree) Position() Position {\n\treturn t.position\n}\n\n// Has returns a boolean indicating if the given key exists.\nfunc (t *Tree) Has(key string) bool {\n\tif key == \"\" {\n\t\treturn false\n\t}\n\treturn t.HasPath(strings.Split(key, \".\"))\n}\n\n// HasPath returns true if the given path of keys exists, false otherwise.\nfunc (t *Tree) HasPath(keys []string) bool {\n\treturn t.GetPath(keys) != nil\n}\n\n// Keys returns the keys of the toplevel tree (does not recurse).\nfunc (t *Tree) Keys() []string {\n\tkeys := make([]string, len(t.values))\n\ti := 0\n\tfor k := range t.values {\n\t\tkeys[i] = k\n\t\ti++\n\t}\n\treturn keys\n}\n\n// Get the value at key in the Tree.\n// Key is a dot-separated path (e.g. a.b.c) without single/double quoted strings.\n// If you need to retrieve non-bare keys, use GetPath.\n// Returns nil if the path does not exist in the tree.\n// If keys is of length zero, the current tree is returned.\nfunc (t *Tree) Get(key string) interface{} {\n\tif key == \"\" {\n\t\treturn t\n\t}\n\treturn t.GetPath(strings.Split(key, \".\"))\n}\n\n// GetPath returns the element in the tree indicated by 'keys'.\n// If keys is of length zero, the current tree is returned.\nfunc (t *Tree) GetPath(keys []string) interface{} {\n\tif len(keys) == 0 {\n\t\treturn t\n\t}\n\tsubtree := t\n\tfor _, intermediateKey := range keys[:len(keys)-1] {\n\t\tvalue, exists := subtree.values[intermediateKey]\n\t\tif !exists {\n\t\t\treturn nil\n\t\t}\n\t\tswitch node := value.(type) {\n\t\tcase *Tree:\n\t\t\tsubtree = node\n\t\tcase []*Tree:\n\t\t\t// go to most recent element\n\t\t\tif len(node) == 0 {\n\t\t\t\treturn nil\n\t\t\t}\n\t\t\tsubtree = node[len(node)-1]\n\t\tdefault:\n\t\t\treturn nil // cannot navigate through other node types\n\t\t}\n\t}\n\t// branch based on final node type\n\tswitch node := subtree.values[keys[len(keys)-1]].(type) {\n\tcase *tomlValue:\n\t\treturn node.value\n\tdefault:\n\t\treturn node\n\t}\n}\n\n// GetArray returns the value at key in the Tree.\n// It returns []string, []int64, etc type if key has homogeneous lists\n// Key is a dot-separated path (e.g. a.b.c) without single/double quoted strings.\n// Returns nil if the path does not exist in the tree.\n// If keys is of length zero, the current tree is returned.\nfunc (t *Tree) GetArray(key string) interface{} {\n\tif key == \"\" {\n\t\treturn t\n\t}\n\treturn t.GetArrayPath(strings.Split(key, \".\"))\n}\n\n// GetArrayPath returns the element in the tree indicated by 'keys'.\n// If keys is of length zero, the current tree is returned.\nfunc (t *Tree) GetArrayPath(keys []string) interface{} {\n\tif len(keys) == 0 {\n\t\treturn t\n\t}\n\tsubtree := t\n\tfor _, intermediateKey := range keys[:len(keys)-1] {\n\t\tvalue, exists := subtree.values[intermediateKey]\n\t\tif !exists {\n\t\t\treturn nil\n\t\t}\n\t\tswitch node := value.(type) {\n\t\tcase *Tree:\n\t\t\tsubtree = node\n\t\tcase []*Tree:\n\t\t\t// go to most recent element\n\t\t\tif len(node) == 0 {\n\t\t\t\treturn nil\n\t\t\t}\n\t\t\tsubtree = node[len(node)-1]\n\t\tdefault:\n\t\t\treturn nil // cannot navigate through other node types\n\t\t}\n\t}\n\t// branch based on final node type\n\tswitch node := subtree.values[keys[len(keys)-1]].(type) {\n\tcase *tomlValue:\n\t\tswitch n := node.value.(type) {\n\t\tcase []interface{}:\n\t\t\treturn getArray(n)\n\t\tdefault:\n\t\t\treturn node.value\n\t\t}\n\tdefault:\n\t\treturn node\n\t}\n}\n\n// if homogeneous array, then return slice type object over []interface{}\nfunc getArray(n []interface{}) interface{} {\n\tvar s []string\n\tvar i64 []int64\n\tvar f64 []float64\n\tvar bl []bool\n\tfor _, value := range n {\n\t\tswitch v := value.(type) {\n\t\tcase string:\n\t\t\ts = append(s, v)\n\t\tcase int64:\n\t\t\ti64 = append(i64, v)\n\t\tcase float64:\n\t\t\tf64 = append(f64, v)\n\t\tcase bool:\n\t\t\tbl = append(bl, v)\n\t\tdefault:\n\t\t\treturn n\n\t\t}\n\t}\n\tif len(s) == len(n) {\n\t\treturn s\n\t} else if len(i64) == len(n) {\n\t\treturn i64\n\t} else if len(f64) == len(n) {\n\t\treturn f64\n\t} else if len(bl) == len(n) {\n\t\treturn bl\n\t}\n\treturn n\n}\n\n// GetPosition returns the position of the given key.\nfunc (t *Tree) GetPosition(key string) Position {\n\tif key == \"\" {\n\t\treturn t.position\n\t}\n\treturn t.GetPositionPath(strings.Split(key, \".\"))\n}\n\n// SetPositionPath sets the position of element in the tree indicated by 'keys'.\n// If keys is of length zero, the current tree position is set.\nfunc (t *Tree) SetPositionPath(keys []string, pos Position) {\n\tif len(keys) == 0 {\n\t\tt.position = pos\n\t\treturn\n\t}\n\tsubtree := t\n\tfor _, intermediateKey := range keys[:len(keys)-1] {\n\t\tvalue, exists := subtree.values[intermediateKey]\n\t\tif !exists {\n\t\t\treturn\n\t\t}\n\t\tswitch node := value.(type) {\n\t\tcase *Tree:\n\t\t\tsubtree = node\n\t\tcase []*Tree:\n\t\t\t// go to most recent element\n\t\t\tif len(node) == 0 {\n\t\t\t\treturn\n\t\t\t}\n\t\t\tsubtree = node[len(node)-1]\n\t\tdefault:\n\t\t\treturn\n\t\t}\n\t}\n\t// branch based on final node type\n\tswitch node := subtree.values[keys[len(keys)-1]].(type) {\n\tcase *tomlValue:\n\t\tnode.position = pos\n\t\treturn\n\tcase *Tree:\n\t\tnode.position = pos\n\t\treturn\n\tcase []*Tree:\n\t\t// go to most recent element\n\t\tif len(node) == 0 {\n\t\t\treturn\n\t\t}\n\t\tnode[len(node)-1].position = pos\n\t\treturn\n\t}\n}\n\n// GetPositionPath returns the element in the tree indicated by 'keys'.\n// If keys is of length zero, the current tree is returned.\nfunc (t *Tree) GetPositionPath(keys []string) Position {\n\tif len(keys) == 0 {\n\t\treturn t.position\n\t}\n\tsubtree := t\n\tfor _, intermediateKey := range keys[:len(keys)-1] {\n\t\tvalue, exists := subtree.values[intermediateKey]\n\t\tif !exists {\n\t\t\treturn Position{0, 0}\n\t\t}\n\t\tswitch node := value.(type) {\n\t\tcase *Tree:\n\t\t\tsubtree = node\n\t\tcase []*Tree:\n\t\t\t// go to most recent element\n\t\t\tif len(node) == 0 {\n\t\t\t\treturn Position{0, 0}\n\t\t\t}\n\t\t\tsubtree = node[len(node)-1]\n\t\tdefault:\n\t\t\treturn Position{0, 0}\n\t\t}\n\t}\n\t// branch based on final node type\n\tswitch node := subtree.values[keys[len(keys)-1]].(type) {\n\tcase *tomlValue:\n\t\treturn node.position\n\tcase *Tree:\n\t\treturn node.position\n\tcase []*Tree:\n\t\t// go to most recent element\n\t\tif len(node) == 0 {\n\t\t\treturn Position{0, 0}\n\t\t}\n\t\treturn node[len(node)-1].position\n\tdefault:\n\t\treturn Position{0, 0}\n\t}\n}\n\n// GetDefault works like Get but with a default value\nfunc (t *Tree) GetDefault(key string, def interface{}) interface{} {\n\tval := t.Get(key)\n\tif val == nil {\n\t\treturn def\n\t}\n\treturn val\n}\n\n// SetOptions arguments are supplied to the SetWithOptions and SetPathWithOptions functions to modify marshalling behaviour.\n// The default values within the struct are valid default options.\ntype SetOptions struct {\n\tComment string\n\tCommented bool\n\tMultiline bool\n\tLiteral bool\n}\n\n// SetWithOptions is the same as Set, but allows you to provide formatting\n// instructions to the key, that will be used by Marshal().\nfunc (t *Tree) SetWithOptions(key string, opts SetOptions, value interface{}) {\n\tt.SetPathWithOptions(strings.Split(key, \".\"), opts, value)\n}\n\n// SetPathWithOptions is the same as SetPath, but allows you to provide\n// formatting instructions to the key, that will be reused by Marshal().\nfunc (t *Tree) SetPathWithOptions(keys []string, opts SetOptions, value interface{}) {\n\tsubtree := t\n\tfor i, intermediateKey := range keys[:len(keys)-1] {\n\t\tnextTree, exists := subtree.values[intermediateKey]\n\t\tif !exists {\n\t\t\tnextTree = newTreeWithPosition(Position{Line: t.position.Line + i, Col: t.position.Col})\n\t\t\tsubtree.values[intermediateKey] = nextTree // add new element here\n\t\t}\n\t\tswitch node := nextTree.(type) {\n\t\tcase *Tree:\n\t\t\tsubtree = node\n\t\tcase []*Tree:\n\t\t\t// go to most recent element\n\t\t\tif len(node) == 0 {\n\t\t\t\t// create element if it does not exist\n\t\t\t\tnode = append(node, newTreeWithPosition(Position{Line: t.position.Line + i, Col: t.position.Col}))\n\t\t\t\tsubtree.values[intermediateKey] = node\n\t\t\t}\n\t\t\tsubtree = node[len(node)-1]\n\t\t}\n\t}\n\n\tvar toInsert interface{}\n\n\tswitch v := value.(type) {\n\tcase *Tree:\n\t\tv.comment = opts.Comment\n\t\tv.commented = opts.Commented\n\t\ttoInsert = value\n\tcase []*Tree:\n\t\tfor i := range v {\n\t\t\tv[i].commented = opts.Commented\n\t\t}\n\t\ttoInsert = value\n\tcase *tomlValue:\n\t\tv.comment = opts.Comment\n\t\tv.commented = opts.Commented\n\t\tv.multiline = opts.Multiline\n\t\tv.literal = opts.Literal\n\t\ttoInsert = v\n\tdefault:\n\t\ttoInsert = &tomlValue{value: value,\n\t\t\tcomment: opts.Comment,\n\t\t\tcommented: opts.Commented,\n\t\t\tmultiline: opts.Multiline,\n\t\t\tliteral: opts.Literal,\n\t\t\tposition: Position{Line: subtree.position.Line + len(subtree.values) + 1, Col: subtree.position.Col}}\n\t}\n\n\tsubtree.values[keys[len(keys)-1]] = toInsert\n}\n\n// Set an element in the tree.\n// Key is a dot-separated path (e.g. a.b.c).\n// Creates all necessary intermediate trees, if needed.\nfunc (t *Tree) Set(key string, value interface{}) {\n\tt.SetWithComment(key, \"\", false, value)\n}\n\n// SetWithComment is the same as Set, but allows you to provide comment\n// information to the key, that will be reused by Marshal().\nfunc (t *Tree) SetWithComment(key string, comment string, commented bool, value interface{}) {\n\tt.SetPathWithComment(strings.Split(key, \".\"), comment, commented, value)\n}\n\n// SetPath sets an element in the tree.\n// Keys is an array of path elements (e.g. {\"a\",\"b\",\"c\"}).\n// Creates all necessary intermediate trees, if needed.\nfunc (t *Tree) SetPath(keys []string, value interface{}) {\n\tt.SetPathWithComment(keys, \"\", false, value)\n}\n\n// SetPathWithComment is the same as SetPath, but allows you to provide comment\n// information to the key, that will be reused by Marshal().\nfunc (t *Tree) SetPathWithComment(keys []string, comment string, commented bool, value interface{}) {\n\tt.SetPathWithOptions(keys, SetOptions{Comment: comment, Commented: commented}, value)\n}\n\n// Delete removes a key from the tree.\n// Key is a dot-separated path (e.g. a.b.c).\nfunc (t *Tree) Delete(key string) error {\n\tkeys, err := parseKey(key)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn t.DeletePath(keys)\n}\n\n// DeletePath removes a key from the tree.\n// Keys is an array of path elements (e.g. {\"a\",\"b\",\"c\"}).\nfunc (t *Tree) DeletePath(keys []string) error {\n\tkeyLen := len(keys)\n\tif keyLen == 1 {\n\t\tdelete(t.values, keys[0])\n\t\treturn nil\n\t}\n\ttree := t.GetPath(keys[:keyLen-1])\n\titem := keys[keyLen-1]\n\tswitch node := tree.(type) {\n\tcase *Tree:\n\t\tdelete(node.values, item)\n\t\treturn nil\n\t}\n\treturn errors.New(\"no such key to delete\")\n}\n\n// createSubTree takes a tree and a key and create the necessary intermediate\n// subtrees to create a subtree at that point. In-place.\n//\n// e.g. passing a.b.c will create (assuming tree is empty) tree[a], tree[a][b]\n// and tree[a][b][c]\n//\n// Returns nil on success, error object on failure\nfunc (t *Tree) createSubTree(keys []string, pos Position) error {\n\tsubtree := t\n\tfor i, intermediateKey := range keys {\n\t\tnextTree, exists := subtree.values[intermediateKey]\n\t\tif !exists {\n\t\t\ttree := newTreeWithPosition(Position{Line: t.position.Line + i, Col: t.position.Col})\n\t\t\ttree.position = pos\n\t\t\ttree.inline = subtree.inline\n\t\t\tsubtree.values[intermediateKey] = tree\n\t\t\tnextTree = tree\n\t\t}\n\n\t\tswitch node := nextTree.(type) {\n\t\tcase []*Tree:\n\t\t\tsubtree = node[len(node)-1]\n\t\tcase *Tree:\n\t\t\tsubtree = node\n\t\tdefault:\n\t\t\treturn fmt.Errorf(\"unknown type for path %s (%s): %T (%#v)\",\n\t\t\t\tstrings.Join(keys, \".\"), intermediateKey, nextTree, nextTree)\n\t\t}\n\t}\n\treturn nil\n}\n\n// LoadBytes creates a Tree from a []byte.\nfunc LoadBytes(b []byte) (tree *Tree, err error) {\n\tdefer func() {\n\t\tif r := recover(); r != nil {\n\t\t\tif _, ok := r.(runtime.Error); ok {\n\t\t\t\tpanic(r)\n\t\t\t}\n\t\t\terr = fmt.Errorf(\"%s\", r)\n\t\t}\n\t}()\n\n\tif len(b) >= 4 && (hasUTF32BigEndianBOM4(b) || hasUTF32LittleEndianBOM4(b)) {\n\t\tb = b[4:]\n\t} else if len(b) >= 3 && hasUTF8BOM3(b) {\n\t\tb = b[3:]\n\t} else if len(b) >= 2 && (hasUTF16BigEndianBOM2(b) || hasUTF16LittleEndianBOM2(b)) {\n\t\tb = b[2:]\n\t}\n\n\ttree = parseToml(lexToml(b))\n\treturn\n}\n\nfunc hasUTF16BigEndianBOM2(b []byte) bool {\n\treturn b[0] == 0xFE && b[1] == 0xFF\n}\n\nfunc hasUTF16LittleEndianBOM2(b []byte) bool {\n\treturn b[0] == 0xFF && b[1] == 0xFE\n}\n\nfunc hasUTF8BOM3(b []byte) bool {\n\treturn b[0] == 0xEF && b[1] == 0xBB && b[2] == 0xBF\n}\n\nfunc hasUTF32BigEndianBOM4(b []byte) bool {\n\treturn b[0] == 0x00 && b[1] == 0x00 && b[2] == 0xFE && b[3] == 0xFF\n}\n\nfunc hasUTF32LittleEndianBOM4(b []byte) bool {\n\treturn b[0] == 0xFF && b[1] == 0xFE && b[2] == 0x00 && b[3] == 0x00\n}\n\n// LoadReader creates a Tree from any io.Reader.\nfunc LoadReader(reader io.Reader) (tree *Tree, err error) {\n\tinputBytes, err := ioutil.ReadAll(reader)\n\tif err != nil {\n\t\treturn\n\t}\n\ttree, err = LoadBytes(inputBytes)\n\treturn\n}\n\n// Load creates a Tree from a string.\nfunc Load(content string) (tree *Tree, err error) {\n\treturn LoadBytes([]byte(content))\n}\n\n// LoadFile creates a Tree from a file.\nfunc LoadFile(path string) (tree *Tree, err error) {\n\tfile, err := os.Open(path)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdefer file.Close()\n\treturn LoadReader(file)\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/tomlpub.go",
"content": "package toml\n\n// PubTOMLValue wrapping tomlValue in order to access all properties from outside.\ntype PubTOMLValue = tomlValue\n\nfunc (ptv *PubTOMLValue) Value() interface{} {\n\treturn ptv.value\n}\nfunc (ptv *PubTOMLValue) Comment() string {\n\treturn ptv.comment\n}\nfunc (ptv *PubTOMLValue) Commented() bool {\n\treturn ptv.commented\n}\nfunc (ptv *PubTOMLValue) Multiline() bool {\n\treturn ptv.multiline\n}\nfunc (ptv *PubTOMLValue) Position() Position {\n\treturn ptv.position\n}\n\nfunc (ptv *PubTOMLValue) SetValue(v interface{}) {\n\tptv.value = v\n}\nfunc (ptv *PubTOMLValue) SetComment(s string) {\n\tptv.comment = s\n}\nfunc (ptv *PubTOMLValue) SetCommented(c bool) {\n\tptv.commented = c\n}\nfunc (ptv *PubTOMLValue) SetMultiline(m bool) {\n\tptv.multiline = m\n}\nfunc (ptv *PubTOMLValue) SetPosition(p Position) {\n\tptv.position = p\n}\n\n// PubTree wrapping Tree in order to access all properties from outside.\ntype PubTree = Tree\n\nfunc (pt *PubTree) Values() map[string]interface{} {\n\treturn pt.values\n}\n\nfunc (pt *PubTree) Comment() string {\n\treturn pt.comment\n}\n\nfunc (pt *PubTree) Commented() bool {\n\treturn pt.commented\n}\n\nfunc (pt *PubTree) Inline() bool {\n\treturn pt.inline\n}\n\nfunc (pt *PubTree) SetValues(v map[string]interface{}) {\n\tpt.values = v\n}\n\nfunc (pt *PubTree) SetComment(c string) {\n\tpt.comment = c\n}\n\nfunc (pt *PubTree) SetCommented(c bool) {\n\tpt.commented = c\n}\n\nfunc (pt *PubTree) SetInline(i bool) {\n\tpt.inline = i\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/tomltree_create.go",
"content": "package toml\n\nimport (\n\t\"fmt\"\n\t\"reflect\"\n\t\"time\"\n)\n\nvar kindToType = [reflect.String + 1]reflect.Type{\n\treflect.Bool: reflect.TypeOf(true),\n\treflect.String: reflect.TypeOf(\"\"),\n\treflect.Float32: reflect.TypeOf(float64(1)),\n\treflect.Float64: reflect.TypeOf(float64(1)),\n\treflect.Int: reflect.TypeOf(int64(1)),\n\treflect.Int8: reflect.TypeOf(int64(1)),\n\treflect.Int16: reflect.TypeOf(int64(1)),\n\treflect.Int32: reflect.TypeOf(int64(1)),\n\treflect.Int64: reflect.TypeOf(int64(1)),\n\treflect.Uint: reflect.TypeOf(uint64(1)),\n\treflect.Uint8: reflect.TypeOf(uint64(1)),\n\treflect.Uint16: reflect.TypeOf(uint64(1)),\n\treflect.Uint32: reflect.TypeOf(uint64(1)),\n\treflect.Uint64: reflect.TypeOf(uint64(1)),\n}\n\n// typeFor returns a reflect.Type for a reflect.Kind, or nil if none is found.\n// supported values:\n// string, bool, int64, uint64, float64, time.Time, int, int8, int16, int32, uint, uint8, uint16, uint32, float32\nfunc typeFor(k reflect.Kind) reflect.Type {\n\tif k > 0 && int(k) < len(kindToType) {\n\t\treturn kindToType[k]\n\t}\n\treturn nil\n}\n\nfunc simpleValueCoercion(object interface{}) (interface{}, error) {\n\tswitch original := object.(type) {\n\tcase string, bool, int64, uint64, float64, time.Time:\n\t\treturn original, nil\n\tcase int:\n\t\treturn int64(original), nil\n\tcase int8:\n\t\treturn int64(original), nil\n\tcase int16:\n\t\treturn int64(original), nil\n\tcase int32:\n\t\treturn int64(original), nil\n\tcase uint:\n\t\treturn uint64(original), nil\n\tcase uint8:\n\t\treturn uint64(original), nil\n\tcase uint16:\n\t\treturn uint64(original), nil\n\tcase uint32:\n\t\treturn uint64(original), nil\n\tcase float32:\n\t\treturn float64(original), nil\n\tcase fmt.Stringer:\n\t\treturn original.String(), nil\n\tcase []interface{}:\n\t\tvalue := reflect.ValueOf(original)\n\t\tlength := value.Len()\n\t\tarrayValue := reflect.MakeSlice(value.Type(), 0, length)\n\t\tfor i := 0; i < length; i++ {\n\t\t\tval := value.Index(i).Interface()\n\t\t\tsimpleValue, err := simpleValueCoercion(val)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tarrayValue = reflect.Append(arrayValue, reflect.ValueOf(simpleValue))\n\t\t}\n\t\treturn arrayValue.Interface(), nil\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"cannot convert type %T to Tree\", object)\n\t}\n}\n\nfunc sliceToTree(object interface{}) (interface{}, error) {\n\t// arrays are a bit tricky, since they can represent either a\n\t// collection of simple values, which is represented by one\n\t// *tomlValue, or an array of tables, which is represented by an\n\t// array of *Tree.\n\n\t// holding the assumption that this function is called from toTree only when value.Kind() is Array or Slice\n\tvalue := reflect.ValueOf(object)\n\tinsideType := value.Type().Elem()\n\tlength := value.Len()\n\tif length > 0 {\n\t\tinsideType = reflect.ValueOf(value.Index(0).Interface()).Type()\n\t}\n\tif insideType.Kind() == reflect.Map {\n\t\t// this is considered as an array of tables\n\t\ttablesArray := make([]*Tree, 0, length)\n\t\tfor i := 0; i < length; i++ {\n\t\t\ttable := value.Index(i)\n\t\t\ttree, err := toTree(table.Interface())\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\ttablesArray = append(tablesArray, tree.(*Tree))\n\t\t}\n\t\treturn tablesArray, nil\n\t}\n\n\tsliceType := typeFor(insideType.Kind())\n\tif sliceType == nil {\n\t\tsliceType = insideType\n\t}\n\n\tarrayValue := reflect.MakeSlice(reflect.SliceOf(sliceType), 0, length)\n\n\tfor i := 0; i < length; i++ {\n\t\tval := value.Index(i).Interface()\n\t\tsimpleValue, err := simpleValueCoercion(val)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tarrayValue = reflect.Append(arrayValue, reflect.ValueOf(simpleValue))\n\t}\n\treturn &tomlValue{value: arrayValue.Interface(), position: Position{}}, nil\n}\n\nfunc toTree(object interface{}) (interface{}, error) {\n\tvalue := reflect.ValueOf(object)\n\n\tif value.Kind() == reflect.Map {\n\t\tvalues := map[string]interface{}{}\n\t\tkeys := value.MapKeys()\n\t\tfor _, key := range keys {\n\t\t\tif key.Kind() != reflect.String {\n\t\t\t\tif _, ok := key.Interface().(string); !ok {\n\t\t\t\t\treturn nil, fmt.Errorf(\"map key needs to be a string, not %T (%v)\", key.Interface(), key.Kind())\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tv := value.MapIndex(key)\n\t\t\tnewValue, err := toTree(v.Interface())\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tvalues[key.String()] = newValue\n\t\t}\n\t\treturn &Tree{values: values, position: Position{}}, nil\n\t}\n\n\tif value.Kind() == reflect.Array || value.Kind() == reflect.Slice {\n\t\treturn sliceToTree(object)\n\t}\n\n\tsimpleValue, err := simpleValueCoercion(object)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn &tomlValue{value: simpleValue, position: Position{}}, nil\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/tomltree_write.go",
"content": "package toml\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"math\"\n\t\"math/big\"\n\t\"reflect\"\n\t\"sort\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n)\n\ntype valueComplexity int\n\nconst (\n\tvalueSimple valueComplexity = iota + 1\n\tvalueComplex\n)\n\ntype sortNode struct {\n\tkey string\n\tcomplexity valueComplexity\n}\n\n// Encodes a string to a TOML-compliant multi-line string value\n// This function is a clone of the existing encodeTomlString function, except that whitespace characters\n// are preserved. Quotation marks and backslashes are also not escaped.\nfunc encodeMultilineTomlString(value string, commented string) string {\n\tvar b bytes.Buffer\n\tadjacentQuoteCount := 0\n\n\tb.WriteString(commented)\n\tfor i, rr := range value {\n\t\tif rr != '\"' {\n\t\t\tadjacentQuoteCount = 0\n\t\t} else {\n\t\t\tadjacentQuoteCount++\n\t\t}\n\t\tswitch rr {\n\t\tcase '\\b':\n\t\t\tb.WriteString(`\\b`)\n\t\tcase '\\t':\n\t\t\tb.WriteString(\"\\t\")\n\t\tcase '\\n':\n\t\t\tb.WriteString(\"\\n\" + commented)\n\t\tcase '\\f':\n\t\t\tb.WriteString(`\\f`)\n\t\tcase '\\r':\n\t\t\tb.WriteString(\"\\r\")\n\t\tcase '\"':\n\t\t\tif adjacentQuoteCount >= 3 || i == len(value)-1 {\n\t\t\t\tadjacentQuoteCount = 0\n\t\t\t\tb.WriteString(`\\\"`)\n\t\t\t} else {\n\t\t\t\tb.WriteString(`\"`)\n\t\t\t}\n\t\tcase '\\\\':\n\t\t\tb.WriteString(`\\`)\n\t\tdefault:\n\t\t\tintRr := uint16(rr)\n\t\t\tif intRr < 0x001F {\n\t\t\t\tb.WriteString(fmt.Sprintf(\"\\\\u%0.4X\", intRr))\n\t\t\t} else {\n\t\t\t\tb.WriteRune(rr)\n\t\t\t}\n\t\t}\n\t}\n\treturn b.String()\n}\n\n// Encodes a string to a TOML-compliant string value\nfunc encodeTomlString(value string) string {\n\tvar b bytes.Buffer\n\n\tfor _, rr := range value {\n\t\tswitch rr {\n\t\tcase '\\b':\n\t\t\tb.WriteString(`\\b`)\n\t\tcase '\\t':\n\t\t\tb.WriteString(`\\t`)\n\t\tcase '\\n':\n\t\t\tb.WriteString(`\\n`)\n\t\tcase '\\f':\n\t\t\tb.WriteString(`\\f`)\n\t\tcase '\\r':\n\t\t\tb.WriteString(`\\r`)\n\t\tcase '\"':\n\t\t\tb.WriteString(`\\\"`)\n\t\tcase '\\\\':\n\t\t\tb.WriteString(`\\\\`)\n\t\tdefault:\n\t\t\tintRr := uint16(rr)\n\t\t\tif intRr < 0x001F {\n\t\t\t\tb.WriteString(fmt.Sprintf(\"\\\\u%0.4X\", intRr))\n\t\t\t} else {\n\t\t\t\tb.WriteRune(rr)\n\t\t\t}\n\t\t}\n\t}\n\treturn b.String()\n}\n\nfunc tomlTreeStringRepresentation(t *Tree, ord MarshalOrder) (string, error) {\n\tvar orderedVals []sortNode\n\tswitch ord {\n\tcase OrderPreserve:\n\t\torderedVals = sortByLines(t)\n\tdefault:\n\t\torderedVals = sortAlphabetical(t)\n\t}\n\n\tvar values []string\n\tfor _, node := range orderedVals {\n\t\tk := node.key\n\t\tv := t.values[k]\n\n\t\trepr, err := tomlValueStringRepresentation(v, \"\", \"\", ord, false)\n\t\tif err != nil {\n\t\t\treturn \"\", err\n\t\t}\n\t\tvalues = append(values, quoteKeyIfNeeded(k)+\" = \"+repr)\n\t}\n\treturn \"{ \" + strings.Join(values, \", \") + \" }\", nil\n}\n\nfunc tomlValueStringRepresentation(v interface{}, commented string, indent string, ord MarshalOrder, arraysOneElementPerLine bool) (string, error) {\n\t// this interface check is added to dereference the change made in the writeTo function.\n\t// That change was made to allow this function to see formatting options.\n\ttv, ok := v.(*tomlValue)\n\tif ok {\n\t\tv = tv.value\n\t} else {\n\t\ttv = &tomlValue{}\n\t}\n\n\tswitch value := v.(type) {\n\tcase uint64:\n\t\treturn strconv.FormatUint(value, 10), nil\n\tcase int64:\n\t\treturn strconv.FormatInt(value, 10), nil\n\tcase float64:\n\t\t// Default bit length is full 64\n\t\tbits := 64\n\t\t// Float panics if nan is used\n\t\tif !math.IsNaN(value) {\n\t\t\t// if 32 bit accuracy is enough to exactly show, use 32\n\t\t\t_, acc := big.NewFloat(value).Float32()\n\t\t\tif acc == big.Exact {\n\t\t\t\tbits = 32\n\t\t\t}\n\t\t}\n\t\tif math.Trunc(value) == value {\n\t\t\treturn strings.ToLower(strconv.FormatFloat(value, 'f', 1, bits)), nil\n\t\t}\n\t\treturn strings.ToLower(strconv.FormatFloat(value, 'f', -1, bits)), nil\n\tcase string:\n\t\tif tv.multiline {\n\t\t\tif tv.literal {\n\t\t\t\tb := strings.Builder{}\n\t\t\t\tb.WriteString(\"'''\\n\")\n\t\t\t\tb.Write([]byte(value))\n\t\t\t\tb.WriteString(\"\\n'''\")\n\t\t\t\treturn b.String(), nil\n\t\t\t} else {\n\t\t\t\treturn \"\\\"\\\"\\\"\\n\" + encodeMultilineTomlString(value, commented) + \"\\\"\\\"\\\"\", nil\n\t\t\t}\n\t\t}\n\t\treturn \"\\\"\" + encodeTomlString(value) + \"\\\"\", nil\n\tcase []byte:\n\t\tb, _ := v.([]byte)\n\t\treturn string(b), nil\n\tcase bool:\n\t\tif value {\n\t\t\treturn \"true\", nil\n\t\t}\n\t\treturn \"false\", nil\n\tcase time.Time:\n\t\treturn value.Format(time.RFC3339), nil\n\tcase LocalDate:\n\t\treturn value.String(), nil\n\tcase LocalDateTime:\n\t\treturn value.String(), nil\n\tcase LocalTime:\n\t\treturn value.String(), nil\n\tcase *Tree:\n\t\treturn tomlTreeStringRepresentation(value, ord)\n\tcase nil:\n\t\treturn \"\", nil\n\t}\n\n\trv := reflect.ValueOf(v)\n\n\tif rv.Kind() == reflect.Slice {\n\t\tvar values []string\n\t\tfor i := 0; i < rv.Len(); i++ {\n\t\t\titem := rv.Index(i).Interface()\n\t\t\titemRepr, err := tomlValueStringRepresentation(item, commented, indent, ord, arraysOneElementPerLine)\n\t\t\tif err != nil {\n\t\t\t\treturn \"\", err\n\t\t\t}\n\t\t\tvalues = append(values, itemRepr)\n\t\t}\n\t\tif arraysOneElementPerLine && len(values) > 1 {\n\t\t\tstringBuffer := bytes.Buffer{}\n\t\t\tvalueIndent := indent + ` ` // TODO: move that to a shared encoder state\n\n\t\t\tstringBuffer.WriteString(\"[\\n\")\n\n\t\t\tfor _, value := range values {\n\t\t\t\tstringBuffer.WriteString(valueIndent)\n\t\t\t\tstringBuffer.WriteString(commented + value)\n\t\t\t\tstringBuffer.WriteString(`,`)\n\t\t\t\tstringBuffer.WriteString(\"\\n\")\n\t\t\t}\n\n\t\t\tstringBuffer.WriteString(indent + commented + \"]\")\n\n\t\t\treturn stringBuffer.String(), nil\n\t\t}\n\t\treturn \"[\" + strings.Join(values, \", \") + \"]\", nil\n\t}\n\treturn \"\", fmt.Errorf(\"unsupported value type %T: %v\", v, v)\n}\n\nfunc getTreeArrayLine(trees []*Tree) (line int) {\n\t// Prevent returning 0 for empty trees\n\tline = int(^uint(0) >> 1)\n\t// get lowest line number >= 0\n\tfor _, tv := range trees {\n\t\tif tv.position.Line < line || line == 0 {\n\t\t\tline = tv.position.Line\n\t\t}\n\t}\n\treturn\n}\n\nfunc sortByLines(t *Tree) (vals []sortNode) {\n\tvar (\n\t\tline int\n\t\tlines []int\n\t\ttv *Tree\n\t\ttom *tomlValue\n\t\tnode sortNode\n\t)\n\tvals = make([]sortNode, 0)\n\tm := make(map[int]sortNode)\n\n\tfor k := range t.values {\n\t\tv := t.values[k]\n\t\tswitch v.(type) {\n\t\tcase *Tree:\n\t\t\ttv = v.(*Tree)\n\t\t\tline = tv.position.Line\n\t\t\tnode = sortNode{key: k, complexity: valueComplex}\n\t\tcase []*Tree:\n\t\t\tline = getTreeArrayLine(v.([]*Tree))\n\t\t\tnode = sortNode{key: k, complexity: valueComplex}\n\t\tdefault:\n\t\t\ttom = v.(*tomlValue)\n\t\t\tline = tom.position.Line\n\t\t\tnode = sortNode{key: k, complexity: valueSimple}\n\t\t}\n\t\tlines = append(lines, line)\n\t\tvals = append(vals, node)\n\t\tm[line] = node\n\t}\n\tsort.Ints(lines)\n\n\tfor i, line := range lines {\n\t\tvals[i] = m[line]\n\t}\n\n\treturn vals\n}\n\nfunc sortAlphabetical(t *Tree) (vals []sortNode) {\n\tvar (\n\t\tnode sortNode\n\t\tsimpVals []string\n\t\tcompVals []string\n\t)\n\tvals = make([]sortNode, 0)\n\tm := make(map[string]sortNode)\n\n\tfor k := range t.values {\n\t\tv := t.values[k]\n\t\tswitch v.(type) {\n\t\tcase *Tree, []*Tree:\n\t\t\tnode = sortNode{key: k, complexity: valueComplex}\n\t\t\tcompVals = append(compVals, node.key)\n\t\tdefault:\n\t\t\tnode = sortNode{key: k, complexity: valueSimple}\n\t\t\tsimpVals = append(simpVals, node.key)\n\t\t}\n\t\tvals = append(vals, node)\n\t\tm[node.key] = node\n\t}\n\n\t// Simples first to match previous implementation\n\tsort.Strings(simpVals)\n\ti := 0\n\tfor _, key := range simpVals {\n\t\tvals[i] = m[key]\n\t\ti++\n\t}\n\n\tsort.Strings(compVals)\n\tfor _, key := range compVals {\n\t\tvals[i] = m[key]\n\t\ti++\n\t}\n\n\treturn vals\n}\n\nfunc (t *Tree) writeTo(w io.Writer, indent, keyspace string, bytesCount int64, arraysOneElementPerLine bool) (int64, error) {\n\treturn t.writeToOrdered(w, indent, keyspace, bytesCount, arraysOneElementPerLine, OrderAlphabetical, \" \", false, false)\n}\n\nfunc (t *Tree) writeToOrdered(w io.Writer, indent, keyspace string, bytesCount int64, arraysOneElementPerLine bool, ord MarshalOrder, indentString string, compactComments, parentCommented bool) (int64, error) {\n\tvar orderedVals []sortNode\n\n\tswitch ord {\n\tcase OrderPreserve:\n\t\torderedVals = sortByLines(t)\n\tdefault:\n\t\torderedVals = sortAlphabetical(t)\n\t}\n\n\tfor _, node := range orderedVals {\n\t\tswitch node.complexity {\n\t\tcase valueComplex:\n\t\t\tk := node.key\n\t\t\tv := t.values[k]\n\n\t\t\tcombinedKey := quoteKeyIfNeeded(k)\n\t\t\tif keyspace != \"\" {\n\t\t\t\tcombinedKey = keyspace + \".\" + combinedKey\n\t\t\t}\n\n\t\t\tswitch node := v.(type) {\n\t\t\t// node has to be of those two types given how keys are sorted above\n\t\t\tcase *Tree:\n\t\t\t\ttv, ok := t.values[k].(*Tree)\n\t\t\t\tif !ok {\n\t\t\t\t\treturn bytesCount, fmt.Errorf(\"invalid value type at %s: %T\", k, t.values[k])\n\t\t\t\t}\n\t\t\t\tif tv.comment != \"\" {\n\t\t\t\t\tcomment := strings.Replace(tv.comment, \"\\n\", \"\\n\"+indent+\"#\", -1)\n\t\t\t\t\tstart := \"# \"\n\t\t\t\t\tif strings.HasPrefix(comment, \"#\") {\n\t\t\t\t\t\tstart = \"\"\n\t\t\t\t\t}\n\t\t\t\t\twrittenBytesCountComment, errc := writeStrings(w, \"\\n\", indent, start, comment)\n\t\t\t\t\tbytesCount += int64(writtenBytesCountComment)\n\t\t\t\t\tif errc != nil {\n\t\t\t\t\t\treturn bytesCount, errc\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tvar commented string\n\t\t\t\tif parentCommented || t.commented || tv.commented {\n\t\t\t\t\tcommented = \"# \"\n\t\t\t\t}\n\t\t\t\twrittenBytesCount, err := writeStrings(w, \"\\n\", indent, commented, \"[\", combinedKey, \"]\\n\")\n\t\t\t\tbytesCount += int64(writtenBytesCount)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn bytesCount, err\n\t\t\t\t}\n\t\t\t\tbytesCount, err = node.writeToOrdered(w, indent+indentString, combinedKey, bytesCount, arraysOneElementPerLine, ord, indentString, compactComments, parentCommented || t.commented || tv.commented)\n\t\t\t\tif err != nil {\n\t\t\t\t\treturn bytesCount, err\n\t\t\t\t}\n\t\t\tcase []*Tree:\n\t\t\t\tfor _, subTree := range node {\n\t\t\t\t\tvar commented string\n\t\t\t\t\tif parentCommented || t.commented || subTree.commented {\n\t\t\t\t\t\tcommented = \"# \"\n\t\t\t\t\t}\n\t\t\t\t\twrittenBytesCount, err := writeStrings(w, \"\\n\", indent, commented, \"[[\", combinedKey, \"]]\\n\")\n\t\t\t\t\tbytesCount += int64(writtenBytesCount)\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn bytesCount, err\n\t\t\t\t\t}\n\n\t\t\t\t\tbytesCount, err = subTree.writeToOrdered(w, indent+indentString, combinedKey, bytesCount, arraysOneElementPerLine, ord, indentString, compactComments, parentCommented || t.commented || subTree.commented)\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn bytesCount, err\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\tdefault: // Simple\n\t\t\tk := node.key\n\t\t\tv, ok := t.values[k].(*tomlValue)\n\t\t\tif !ok {\n\t\t\t\treturn bytesCount, fmt.Errorf(\"invalid value type at %s: %T\", k, t.values[k])\n\t\t\t}\n\n\t\t\tvar commented string\n\t\t\tif parentCommented || t.commented || v.commented {\n\t\t\t\tcommented = \"# \"\n\t\t\t}\n\t\t\trepr, err := tomlValueStringRepresentation(v, commented, indent, ord, arraysOneElementPerLine)\n\t\t\tif err != nil {\n\t\t\t\treturn bytesCount, err\n\t\t\t}\n\n\t\t\tif v.comment != \"\" {\n\t\t\t\tcomment := strings.Replace(v.comment, \"\\n\", \"\\n\"+indent+\"#\", -1)\n\t\t\t\tstart := \"# \"\n\t\t\t\tif strings.HasPrefix(comment, \"#\") {\n\t\t\t\t\tstart = \"\"\n\t\t\t\t}\n\t\t\t\tif !compactComments {\n\t\t\t\t\twrittenBytesCountComment, errc := writeStrings(w, \"\\n\")\n\t\t\t\t\tbytesCount += int64(writtenBytesCountComment)\n\t\t\t\t\tif errc != nil {\n\t\t\t\t\t\treturn bytesCount, errc\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\twrittenBytesCountComment, errc := writeStrings(w, indent, start, comment, \"\\n\")\n\t\t\t\tbytesCount += int64(writtenBytesCountComment)\n\t\t\t\tif errc != nil {\n\t\t\t\t\treturn bytesCount, errc\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tquotedKey := quoteKeyIfNeeded(k)\n\t\t\twrittenBytesCount, err := writeStrings(w, indent, commented, quotedKey, \" = \", repr, \"\\n\")\n\t\t\tbytesCount += int64(writtenBytesCount)\n\t\t\tif err != nil {\n\t\t\t\treturn bytesCount, err\n\t\t\t}\n\t\t}\n\t}\n\n\treturn bytesCount, nil\n}\n\n// quote a key if it does not fit the bare key format (A-Za-z0-9_-)\n// quoted keys use the same rules as strings\nfunc quoteKeyIfNeeded(k string) string {\n\t// when encoding a map with the 'quoteMapKeys' option enabled, the tree will contain\n\t// keys that have already been quoted.\n\t// not an ideal situation, but good enough of a stop gap.\n\tif len(k) >= 2 && k[0] == '\"' && k[len(k)-1] == '\"' {\n\t\treturn k\n\t}\n\tisBare := true\n\tfor _, r := range k {\n\t\tif !isValidBareChar(r) {\n\t\t\tisBare = false\n\t\t\tbreak\n\t\t}\n\t}\n\tif isBare {\n\t\treturn k\n\t}\n\treturn quoteKey(k)\n}\n\nfunc quoteKey(k string) string {\n\treturn \"\\\"\" + encodeTomlString(k) + \"\\\"\"\n}\n\nfunc writeStrings(w io.Writer, s ...string) (int, error) {\n\tvar n int\n\tfor i := range s {\n\t\tb, err := io.WriteString(w, s[i])\n\t\tn += b\n\t\tif err != nil {\n\t\t\treturn n, err\n\t\t}\n\t}\n\treturn n, nil\n}\n\n// WriteTo encode the Tree as Toml and writes it to the writer w.\n// Returns the number of bytes written in case of success, or an error if anything happened.\nfunc (t *Tree) WriteTo(w io.Writer) (int64, error) {\n\treturn t.writeTo(w, \"\", \"\", 0, false)\n}\n\n// ToTomlString generates a human-readable representation of the current tree.\n// Output spans multiple lines, and is suitable for ingest by a TOML parser.\n// If the conversion cannot be performed, ToString returns a non-nil error.\nfunc (t *Tree) ToTomlString() (string, error) {\n\tb, err := t.Marshal()\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\treturn string(b), nil\n}\n\n// String generates a human-readable representation of the current tree.\n// Alias of ToString. Present to implement the fmt.Stringer interface.\nfunc (t *Tree) String() string {\n\tresult, _ := t.ToTomlString()\n\treturn result\n}\n\n// ToMap recursively generates a representation of the tree using Go built-in structures.\n// The following types are used:\n//\n//\t* bool\n//\t* float64\n//\t* int64\n//\t* string\n//\t* uint64\n//\t* time.Time\n//\t* map[string]interface{} (where interface{} is any of this list)\n//\t* []interface{} (where interface{} is any of this list)\nfunc (t *Tree) ToMap() map[string]interface{} {\n\tresult := map[string]interface{}{}\n\n\tfor k, v := range t.values {\n\t\tswitch node := v.(type) {\n\t\tcase []*Tree:\n\t\t\tvar array []interface{}\n\t\t\tfor _, item := range node {\n\t\t\t\tarray = append(array, item.ToMap())\n\t\t\t}\n\t\t\tresult[k] = array\n\t\tcase *Tree:\n\t\t\tresult[k] = node.ToMap()\n\t\tcase *tomlValue:\n\t\t\tresult[k] = tomlValueToGo(node.value)\n\t\t}\n\t}\n\treturn result\n}\n\nfunc tomlValueToGo(v interface{}) interface{} {\n\tif tree, ok := v.(*Tree); ok {\n\t\treturn tree.ToMap()\n\t}\n\n\trv := reflect.ValueOf(v)\n\n\tif rv.Kind() != reflect.Slice {\n\t\treturn v\n\t}\n\tvalues := make([]interface{}, rv.Len())\n\tfor i := 0; i < rv.Len(); i++ {\n\t\titem := rv.Index(i).Interface()\n\t\tvalues[i] = tomlValueToGo(item)\n\t}\n\treturn values\n}\n"
},
{
"path": "tests/vendor/github.com/pelletier/go-toml/tomltree_writepub.go",
"content": "package toml\n\n// ValueStringRepresentation transforms an interface{} value into its toml string representation.\nfunc ValueStringRepresentation(v interface{}, commented string, indent string, ord MarshalOrder, arraysOneElementPerLine bool) (string, error) {\n\treturn tomlValueStringRepresentation(v, commented, indent, ord, arraysOneElementPerLine)\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/LICENSE",
"content": "\nThis project is covered by two different licenses: MIT and Apache.\n\n#### MIT License ####\n\nThe following files were ported to Go from C files of libyaml, and thus\nare still covered by their original MIT license, with the additional\ncopyright staring in 2011 when the project was ported over:\n\n apic.go emitterc.go parserc.go readerc.go scannerc.go\n writerc.go yamlh.go yamlprivateh.go\n\nCopyright (c) 2006-2010 Kirill Simonov\nCopyright (c) 2006-2011 Kirill Simonov\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n### Apache License ###\n\nAll the remaining project files are covered by the Apache license:\n\nCopyright (c) 2011-2019 Canonical Ltd\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/NOTICE",
"content": "Copyright 2011-2016 Canonical Ltd.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/README.md",
"content": "go.yaml.in/yaml\n===============\n\nYAML Support for the Go Language\n\n\n## Introduction\n\nThe `yaml` package enables [Go](https://go.dev/) programs to comfortably encode\nand decode [YAML](https://yaml.org/) values.\n\nIt was originally developed within [Canonical](https://www.canonical.com) as\npart of the [juju](https://juju.ubuntu.com) project, and is based on a pure Go\nport of the well-known [libyaml](http://pyyaml.org/wiki/LibYAML) C library to\nparse and generate YAML data quickly and reliably.\n\n\n## Project Status\n\nThis project started as a fork of the extremely popular [go-yaml](\nhttps://github.com/go-yaml/yaml/)\nproject, and is being maintained by the official [YAML organization](\nhttps://github.com/yaml/).\n\nThe YAML team took over ongoing maintenance and development of the project after\ndiscussion with go-yaml's author, @niemeyer, following his decision to\n[label the project repository as \"unmaintained\"](\nhttps://github.com/go-yaml/yaml/blob/944c86a7d2/README.md) in April 2025.\n\nWe have put together a team of dedicated maintainers including representatives\nof go-yaml's most important downstream projects.\n\nWe will strive to earn the trust of the various go-yaml forks to switch back to\nthis repository as their upstream.\n\nPlease [contact us](https://cloud-native.slack.com/archives/C08PPAT8PS7) if you\nwould like to contribute or be involved.\n\n\n## Compatibility\n\nThe `yaml` package supports most of YAML 1.2, but preserves some behavior from\n1.1 for backwards compatibility.\n\nSpecifically, v3 of the `yaml` package:\n\n* Supports YAML 1.1 bools (`yes`/`no`, `on`/`off`) as long as they are being\n decoded into a typed bool value.\n Otherwise they behave as a string.\n Booleans in YAML 1.2 are `true`/`false` only.\n* Supports octals encoded and decoded as `0777` per YAML 1.1, rather than\n `0o777` as specified in YAML 1.2, because most parsers still use the old\n format.\n Octals in the `0o777` format are supported though, so new files work.\n* Does not support base-60 floats.\n These are gone from YAML 1.2, and were actually never supported by this\n package as it's clearly a poor choice.\n\n\n## Installation and Usage\n\nThe import path for the package is *go.yaml.in/yaml/v3*.\n\nTo install it, run:\n\n```bash\ngo get go.yaml.in/yaml/v3\n```\n\n\n## API Documentation\n\nSee: \n\n\n## API Stability\n\nThe package API for yaml v3 will remain stable as described in [gopkg.in](\nhttps://gopkg.in).\n\n\n## Example\n\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\n\t\"go.yaml.in/yaml/v3\"\n)\n\nvar data = `\na: Easy!\nb:\n c: 2\n d: [3, 4]\n`\n\n// Note: struct fields must be public in order for unmarshal to\n// correctly populate the data.\ntype T struct {\n\tA string\n\tB struct {\n\t\tRenamedC int `yaml:\"c\"`\n\t\tD\t[]int `yaml:\",flow\"`\n\t}\n}\n\nfunc main() {\n\tt := T{}\n\n\terr := yaml.Unmarshal([]byte(data), &t)\n\tif err != nil {\n\t\tlog.Fatalf(\"error: %v\", err)\n\t}\n\tfmt.Printf(\"--- t:\\n%v\\n\\n\", t)\n\n\td, err := yaml.Marshal(&t)\n\tif err != nil {\n\t\tlog.Fatalf(\"error: %v\", err)\n\t}\n\tfmt.Printf(\"--- t dump:\\n%s\\n\\n\", string(d))\n\n\tm := make(map[interface{}]interface{})\n\n\terr = yaml.Unmarshal([]byte(data), &m)\n\tif err != nil {\n\t\tlog.Fatalf(\"error: %v\", err)\n\t}\n\tfmt.Printf(\"--- m:\\n%v\\n\\n\", m)\n\n\td, err = yaml.Marshal(&m)\n\tif err != nil {\n\t\tlog.Fatalf(\"error: %v\", err)\n\t}\n\tfmt.Printf(\"--- m dump:\\n%s\\n\\n\", string(d))\n}\n```\n\nThis example will generate the following output:\n\n```\n--- t:\n{Easy! {2 [3 4]}}\n\n--- t dump:\na: Easy!\nb:\n c: 2\n d: [3, 4]\n\n\n--- m:\nmap[a:Easy! b:map[c:2 d:[3 4]]]\n\n--- m dump:\na: Easy!\nb:\n c: 2\n d:\n - 3\n - 4\n```\n\n\n## License\n\nThe yaml package is licensed under the MIT and Apache License 2.0 licenses.\nPlease see the LICENSE file for details.\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/apic.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n// Copyright (c) 2006-2010 Kirill Simonov\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy of\n// this software and associated documentation files (the \"Software\"), to deal in\n// the Software without restriction, including without limitation the rights to\n// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n// of the Software, and to permit persons to whom the Software is furnished to do\n// so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\npackage yaml\n\nimport (\n\t\"io\"\n)\n\nfunc yaml_insert_token(parser *yaml_parser_t, pos int, token *yaml_token_t) {\n\t//fmt.Println(\"yaml_insert_token\", \"pos:\", pos, \"typ:\", token.typ, \"head:\", parser.tokens_head, \"len:\", len(parser.tokens))\n\n\t// Check if we can move the queue at the beginning of the buffer.\n\tif parser.tokens_head > 0 && len(parser.tokens) == cap(parser.tokens) {\n\t\tif parser.tokens_head != len(parser.tokens) {\n\t\t\tcopy(parser.tokens, parser.tokens[parser.tokens_head:])\n\t\t}\n\t\tparser.tokens = parser.tokens[:len(parser.tokens)-parser.tokens_head]\n\t\tparser.tokens_head = 0\n\t}\n\tparser.tokens = append(parser.tokens, *token)\n\tif pos < 0 {\n\t\treturn\n\t}\n\tcopy(parser.tokens[parser.tokens_head+pos+1:], parser.tokens[parser.tokens_head+pos:])\n\tparser.tokens[parser.tokens_head+pos] = *token\n}\n\n// Create a new parser object.\nfunc yaml_parser_initialize(parser *yaml_parser_t) bool {\n\t*parser = yaml_parser_t{\n\t\traw_buffer: make([]byte, 0, input_raw_buffer_size),\n\t\tbuffer: make([]byte, 0, input_buffer_size),\n\t}\n\treturn true\n}\n\n// Destroy a parser object.\nfunc yaml_parser_delete(parser *yaml_parser_t) {\n\t*parser = yaml_parser_t{}\n}\n\n// String read handler.\nfunc yaml_string_read_handler(parser *yaml_parser_t, buffer []byte) (n int, err error) {\n\tif parser.input_pos == len(parser.input) {\n\t\treturn 0, io.EOF\n\t}\n\tn = copy(buffer, parser.input[parser.input_pos:])\n\tparser.input_pos += n\n\treturn n, nil\n}\n\n// Reader read handler.\nfunc yaml_reader_read_handler(parser *yaml_parser_t, buffer []byte) (n int, err error) {\n\treturn parser.input_reader.Read(buffer)\n}\n\n// Set a string input.\nfunc yaml_parser_set_input_string(parser *yaml_parser_t, input []byte) {\n\tif parser.read_handler != nil {\n\t\tpanic(\"must set the input source only once\")\n\t}\n\tparser.read_handler = yaml_string_read_handler\n\tparser.input = input\n\tparser.input_pos = 0\n}\n\n// Set a file input.\nfunc yaml_parser_set_input_reader(parser *yaml_parser_t, r io.Reader) {\n\tif parser.read_handler != nil {\n\t\tpanic(\"must set the input source only once\")\n\t}\n\tparser.read_handler = yaml_reader_read_handler\n\tparser.input_reader = r\n}\n\n// Set the source encoding.\nfunc yaml_parser_set_encoding(parser *yaml_parser_t, encoding yaml_encoding_t) {\n\tif parser.encoding != yaml_ANY_ENCODING {\n\t\tpanic(\"must set the encoding only once\")\n\t}\n\tparser.encoding = encoding\n}\n\n// Create a new emitter object.\nfunc yaml_emitter_initialize(emitter *yaml_emitter_t) {\n\t*emitter = yaml_emitter_t{\n\t\tbuffer: make([]byte, output_buffer_size),\n\t\traw_buffer: make([]byte, 0, output_raw_buffer_size),\n\t\tstates: make([]yaml_emitter_state_t, 0, initial_stack_size),\n\t\tevents: make([]yaml_event_t, 0, initial_queue_size),\n\t\tbest_width: -1,\n\t}\n}\n\n// Destroy an emitter object.\nfunc yaml_emitter_delete(emitter *yaml_emitter_t) {\n\t*emitter = yaml_emitter_t{}\n}\n\n// String write handler.\nfunc yaml_string_write_handler(emitter *yaml_emitter_t, buffer []byte) error {\n\t*emitter.output_buffer = append(*emitter.output_buffer, buffer...)\n\treturn nil\n}\n\n// yaml_writer_write_handler uses emitter.output_writer to write the\n// emitted text.\nfunc yaml_writer_write_handler(emitter *yaml_emitter_t, buffer []byte) error {\n\t_, err := emitter.output_writer.Write(buffer)\n\treturn err\n}\n\n// Set a string output.\nfunc yaml_emitter_set_output_string(emitter *yaml_emitter_t, output_buffer *[]byte) {\n\tif emitter.write_handler != nil {\n\t\tpanic(\"must set the output target only once\")\n\t}\n\temitter.write_handler = yaml_string_write_handler\n\temitter.output_buffer = output_buffer\n}\n\n// Set a file output.\nfunc yaml_emitter_set_output_writer(emitter *yaml_emitter_t, w io.Writer) {\n\tif emitter.write_handler != nil {\n\t\tpanic(\"must set the output target only once\")\n\t}\n\temitter.write_handler = yaml_writer_write_handler\n\temitter.output_writer = w\n}\n\n// Set the output encoding.\nfunc yaml_emitter_set_encoding(emitter *yaml_emitter_t, encoding yaml_encoding_t) {\n\tif emitter.encoding != yaml_ANY_ENCODING {\n\t\tpanic(\"must set the output encoding only once\")\n\t}\n\temitter.encoding = encoding\n}\n\n// Set the canonical output style.\nfunc yaml_emitter_set_canonical(emitter *yaml_emitter_t, canonical bool) {\n\temitter.canonical = canonical\n}\n\n// Set the indentation increment.\nfunc yaml_emitter_set_indent(emitter *yaml_emitter_t, indent int) {\n\tif indent < 2 || indent > 9 {\n\t\tindent = 2\n\t}\n\temitter.best_indent = indent\n}\n\n// Set the preferred line width.\nfunc yaml_emitter_set_width(emitter *yaml_emitter_t, width int) {\n\tif width < 0 {\n\t\twidth = -1\n\t}\n\temitter.best_width = width\n}\n\n// Set if unescaped non-ASCII characters are allowed.\nfunc yaml_emitter_set_unicode(emitter *yaml_emitter_t, unicode bool) {\n\temitter.unicode = unicode\n}\n\n// Set the preferred line break character.\nfunc yaml_emitter_set_break(emitter *yaml_emitter_t, line_break yaml_break_t) {\n\temitter.line_break = line_break\n}\n\n///*\n// * Destroy a token object.\n// */\n//\n//YAML_DECLARE(void)\n//yaml_token_delete(yaml_token_t *token)\n//{\n// assert(token); // Non-NULL token object expected.\n//\n// switch (token.type)\n// {\n// case YAML_TAG_DIRECTIVE_TOKEN:\n// yaml_free(token.data.tag_directive.handle);\n// yaml_free(token.data.tag_directive.prefix);\n// break;\n//\n// case YAML_ALIAS_TOKEN:\n// yaml_free(token.data.alias.value);\n// break;\n//\n// case YAML_ANCHOR_TOKEN:\n// yaml_free(token.data.anchor.value);\n// break;\n//\n// case YAML_TAG_TOKEN:\n// yaml_free(token.data.tag.handle);\n// yaml_free(token.data.tag.suffix);\n// break;\n//\n// case YAML_SCALAR_TOKEN:\n// yaml_free(token.data.scalar.value);\n// break;\n//\n// default:\n// break;\n// }\n//\n// memset(token, 0, sizeof(yaml_token_t));\n//}\n//\n///*\n// * Check if a string is a valid UTF-8 sequence.\n// *\n// * Check 'reader.c' for more details on UTF-8 encoding.\n// */\n//\n//static int\n//yaml_check_utf8(yaml_char_t *start, size_t length)\n//{\n// yaml_char_t *end = start+length;\n// yaml_char_t *pointer = start;\n//\n// while (pointer < end) {\n// unsigned char octet;\n// unsigned int width;\n// unsigned int value;\n// size_t k;\n//\n// octet = pointer[0];\n// width = (octet & 0x80) == 0x00 ? 1 :\n// (octet & 0xE0) == 0xC0 ? 2 :\n// (octet & 0xF0) == 0xE0 ? 3 :\n// (octet & 0xF8) == 0xF0 ? 4 : 0;\n// value = (octet & 0x80) == 0x00 ? octet & 0x7F :\n// (octet & 0xE0) == 0xC0 ? octet & 0x1F :\n// (octet & 0xF0) == 0xE0 ? octet & 0x0F :\n// (octet & 0xF8) == 0xF0 ? octet & 0x07 : 0;\n// if (!width) return 0;\n// if (pointer+width > end) return 0;\n// for (k = 1; k < width; k ++) {\n// octet = pointer[k];\n// if ((octet & 0xC0) != 0x80) return 0;\n// value = (value << 6) + (octet & 0x3F);\n// }\n// if (!((width == 1) ||\n// (width == 2 && value >= 0x80) ||\n// (width == 3 && value >= 0x800) ||\n// (width == 4 && value >= 0x10000))) return 0;\n//\n// pointer += width;\n// }\n//\n// return 1;\n//}\n//\n\n// Create STREAM-START.\nfunc yaml_stream_start_event_initialize(event *yaml_event_t, encoding yaml_encoding_t) {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_STREAM_START_EVENT,\n\t\tencoding: encoding,\n\t}\n}\n\n// Create STREAM-END.\nfunc yaml_stream_end_event_initialize(event *yaml_event_t) {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_STREAM_END_EVENT,\n\t}\n}\n\n// Create DOCUMENT-START.\nfunc yaml_document_start_event_initialize(\n\tevent *yaml_event_t,\n\tversion_directive *yaml_version_directive_t,\n\ttag_directives []yaml_tag_directive_t,\n\timplicit bool,\n) {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_DOCUMENT_START_EVENT,\n\t\tversion_directive: version_directive,\n\t\ttag_directives: tag_directives,\n\t\timplicit: implicit,\n\t}\n}\n\n// Create DOCUMENT-END.\nfunc yaml_document_end_event_initialize(event *yaml_event_t, implicit bool) {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_DOCUMENT_END_EVENT,\n\t\timplicit: implicit,\n\t}\n}\n\n// Create ALIAS.\nfunc yaml_alias_event_initialize(event *yaml_event_t, anchor []byte) bool {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_ALIAS_EVENT,\n\t\tanchor: anchor,\n\t}\n\treturn true\n}\n\n// Create SCALAR.\nfunc yaml_scalar_event_initialize(event *yaml_event_t, anchor, tag, value []byte, plain_implicit, quoted_implicit bool, style yaml_scalar_style_t) bool {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_SCALAR_EVENT,\n\t\tanchor: anchor,\n\t\ttag: tag,\n\t\tvalue: value,\n\t\timplicit: plain_implicit,\n\t\tquoted_implicit: quoted_implicit,\n\t\tstyle: yaml_style_t(style),\n\t}\n\treturn true\n}\n\n// Create SEQUENCE-START.\nfunc yaml_sequence_start_event_initialize(event *yaml_event_t, anchor, tag []byte, implicit bool, style yaml_sequence_style_t) bool {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_SEQUENCE_START_EVENT,\n\t\tanchor: anchor,\n\t\ttag: tag,\n\t\timplicit: implicit,\n\t\tstyle: yaml_style_t(style),\n\t}\n\treturn true\n}\n\n// Create SEQUENCE-END.\nfunc yaml_sequence_end_event_initialize(event *yaml_event_t) bool {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_SEQUENCE_END_EVENT,\n\t}\n\treturn true\n}\n\n// Create MAPPING-START.\nfunc yaml_mapping_start_event_initialize(event *yaml_event_t, anchor, tag []byte, implicit bool, style yaml_mapping_style_t) {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_MAPPING_START_EVENT,\n\t\tanchor: anchor,\n\t\ttag: tag,\n\t\timplicit: implicit,\n\t\tstyle: yaml_style_t(style),\n\t}\n}\n\n// Create MAPPING-END.\nfunc yaml_mapping_end_event_initialize(event *yaml_event_t) {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_MAPPING_END_EVENT,\n\t}\n}\n\n// Destroy an event object.\nfunc yaml_event_delete(event *yaml_event_t) {\n\t*event = yaml_event_t{}\n}\n\n///*\n// * Create a document object.\n// */\n//\n//YAML_DECLARE(int)\n//yaml_document_initialize(document *yaml_document_t,\n// version_directive *yaml_version_directive_t,\n// tag_directives_start *yaml_tag_directive_t,\n// tag_directives_end *yaml_tag_directive_t,\n// start_implicit int, end_implicit int)\n//{\n// struct {\n// error yaml_error_type_t\n// } context\n// struct {\n// start *yaml_node_t\n// end *yaml_node_t\n// top *yaml_node_t\n// } nodes = { NULL, NULL, NULL }\n// version_directive_copy *yaml_version_directive_t = NULL\n// struct {\n// start *yaml_tag_directive_t\n// end *yaml_tag_directive_t\n// top *yaml_tag_directive_t\n// } tag_directives_copy = { NULL, NULL, NULL }\n// value yaml_tag_directive_t = { NULL, NULL }\n// mark yaml_mark_t = { 0, 0, 0 }\n//\n// assert(document) // Non-NULL document object is expected.\n// assert((tag_directives_start && tag_directives_end) ||\n// (tag_directives_start == tag_directives_end))\n// // Valid tag directives are expected.\n//\n// if (!STACK_INIT(&context, nodes, INITIAL_STACK_SIZE)) goto error\n//\n// if (version_directive) {\n// version_directive_copy = yaml_malloc(sizeof(yaml_version_directive_t))\n// if (!version_directive_copy) goto error\n// version_directive_copy.major = version_directive.major\n// version_directive_copy.minor = version_directive.minor\n// }\n//\n// if (tag_directives_start != tag_directives_end) {\n// tag_directive *yaml_tag_directive_t\n// if (!STACK_INIT(&context, tag_directives_copy, INITIAL_STACK_SIZE))\n// goto error\n// for (tag_directive = tag_directives_start\n// tag_directive != tag_directives_end; tag_directive ++) {\n// assert(tag_directive.handle)\n// assert(tag_directive.prefix)\n// if (!yaml_check_utf8(tag_directive.handle,\n// strlen((char *)tag_directive.handle)))\n// goto error\n// if (!yaml_check_utf8(tag_directive.prefix,\n// strlen((char *)tag_directive.prefix)))\n// goto error\n// value.handle = yaml_strdup(tag_directive.handle)\n// value.prefix = yaml_strdup(tag_directive.prefix)\n// if (!value.handle || !value.prefix) goto error\n// if (!PUSH(&context, tag_directives_copy, value))\n// goto error\n// value.handle = NULL\n// value.prefix = NULL\n// }\n// }\n//\n// DOCUMENT_INIT(*document, nodes.start, nodes.end, version_directive_copy,\n// tag_directives_copy.start, tag_directives_copy.top,\n// start_implicit, end_implicit, mark, mark)\n//\n// return 1\n//\n//error:\n// STACK_DEL(&context, nodes)\n// yaml_free(version_directive_copy)\n// while (!STACK_EMPTY(&context, tag_directives_copy)) {\n// value yaml_tag_directive_t = POP(&context, tag_directives_copy)\n// yaml_free(value.handle)\n// yaml_free(value.prefix)\n// }\n// STACK_DEL(&context, tag_directives_copy)\n// yaml_free(value.handle)\n// yaml_free(value.prefix)\n//\n// return 0\n//}\n//\n///*\n// * Destroy a document object.\n// */\n//\n//YAML_DECLARE(void)\n//yaml_document_delete(document *yaml_document_t)\n//{\n// struct {\n// error yaml_error_type_t\n// } context\n// tag_directive *yaml_tag_directive_t\n//\n// context.error = YAML_NO_ERROR // Eliminate a compiler warning.\n//\n// assert(document) // Non-NULL document object is expected.\n//\n// while (!STACK_EMPTY(&context, document.nodes)) {\n// node yaml_node_t = POP(&context, document.nodes)\n// yaml_free(node.tag)\n// switch (node.type) {\n// case YAML_SCALAR_NODE:\n// yaml_free(node.data.scalar.value)\n// break\n// case YAML_SEQUENCE_NODE:\n// STACK_DEL(&context, node.data.sequence.items)\n// break\n// case YAML_MAPPING_NODE:\n// STACK_DEL(&context, node.data.mapping.pairs)\n// break\n// default:\n// assert(0) // Should not happen.\n// }\n// }\n// STACK_DEL(&context, document.nodes)\n//\n// yaml_free(document.version_directive)\n// for (tag_directive = document.tag_directives.start\n// tag_directive != document.tag_directives.end\n// tag_directive++) {\n// yaml_free(tag_directive.handle)\n// yaml_free(tag_directive.prefix)\n// }\n// yaml_free(document.tag_directives.start)\n//\n// memset(document, 0, sizeof(yaml_document_t))\n//}\n//\n///**\n// * Get a document node.\n// */\n//\n//YAML_DECLARE(yaml_node_t *)\n//yaml_document_get_node(document *yaml_document_t, index int)\n//{\n// assert(document) // Non-NULL document object is expected.\n//\n// if (index > 0 && document.nodes.start + index <= document.nodes.top) {\n// return document.nodes.start + index - 1\n// }\n// return NULL\n//}\n//\n///**\n// * Get the root object.\n// */\n//\n//YAML_DECLARE(yaml_node_t *)\n//yaml_document_get_root_node(document *yaml_document_t)\n//{\n// assert(document) // Non-NULL document object is expected.\n//\n// if (document.nodes.top != document.nodes.start) {\n// return document.nodes.start\n// }\n// return NULL\n//}\n//\n///*\n// * Add a scalar node to a document.\n// */\n//\n//YAML_DECLARE(int)\n//yaml_document_add_scalar(document *yaml_document_t,\n// tag *yaml_char_t, value *yaml_char_t, length int,\n// style yaml_scalar_style_t)\n//{\n// struct {\n// error yaml_error_type_t\n// } context\n// mark yaml_mark_t = { 0, 0, 0 }\n// tag_copy *yaml_char_t = NULL\n// value_copy *yaml_char_t = NULL\n// node yaml_node_t\n//\n// assert(document) // Non-NULL document object is expected.\n// assert(value) // Non-NULL value is expected.\n//\n// if (!tag) {\n// tag = (yaml_char_t *)YAML_DEFAULT_SCALAR_TAG\n// }\n//\n// if (!yaml_check_utf8(tag, strlen((char *)tag))) goto error\n// tag_copy = yaml_strdup(tag)\n// if (!tag_copy) goto error\n//\n// if (length < 0) {\n// length = strlen((char *)value)\n// }\n//\n// if (!yaml_check_utf8(value, length)) goto error\n// value_copy = yaml_malloc(length+1)\n// if (!value_copy) goto error\n// memcpy(value_copy, value, length)\n// value_copy[length] = '\\0'\n//\n// SCALAR_NODE_INIT(node, tag_copy, value_copy, length, style, mark, mark)\n// if (!PUSH(&context, document.nodes, node)) goto error\n//\n// return document.nodes.top - document.nodes.start\n//\n//error:\n// yaml_free(tag_copy)\n// yaml_free(value_copy)\n//\n// return 0\n//}\n//\n///*\n// * Add a sequence node to a document.\n// */\n//\n//YAML_DECLARE(int)\n//yaml_document_add_sequence(document *yaml_document_t,\n// tag *yaml_char_t, style yaml_sequence_style_t)\n//{\n// struct {\n// error yaml_error_type_t\n// } context\n// mark yaml_mark_t = { 0, 0, 0 }\n// tag_copy *yaml_char_t = NULL\n// struct {\n// start *yaml_node_item_t\n// end *yaml_node_item_t\n// top *yaml_node_item_t\n// } items = { NULL, NULL, NULL }\n// node yaml_node_t\n//\n// assert(document) // Non-NULL document object is expected.\n//\n// if (!tag) {\n// tag = (yaml_char_t *)YAML_DEFAULT_SEQUENCE_TAG\n// }\n//\n// if (!yaml_check_utf8(tag, strlen((char *)tag))) goto error\n// tag_copy = yaml_strdup(tag)\n// if (!tag_copy) goto error\n//\n// if (!STACK_INIT(&context, items, INITIAL_STACK_SIZE)) goto error\n//\n// SEQUENCE_NODE_INIT(node, tag_copy, items.start, items.end,\n// style, mark, mark)\n// if (!PUSH(&context, document.nodes, node)) goto error\n//\n// return document.nodes.top - document.nodes.start\n//\n//error:\n// STACK_DEL(&context, items)\n// yaml_free(tag_copy)\n//\n// return 0\n//}\n//\n///*\n// * Add a mapping node to a document.\n// */\n//\n//YAML_DECLARE(int)\n//yaml_document_add_mapping(document *yaml_document_t,\n// tag *yaml_char_t, style yaml_mapping_style_t)\n//{\n// struct {\n// error yaml_error_type_t\n// } context\n// mark yaml_mark_t = { 0, 0, 0 }\n// tag_copy *yaml_char_t = NULL\n// struct {\n// start *yaml_node_pair_t\n// end *yaml_node_pair_t\n// top *yaml_node_pair_t\n// } pairs = { NULL, NULL, NULL }\n// node yaml_node_t\n//\n// assert(document) // Non-NULL document object is expected.\n//\n// if (!tag) {\n// tag = (yaml_char_t *)YAML_DEFAULT_MAPPING_TAG\n// }\n//\n// if (!yaml_check_utf8(tag, strlen((char *)tag))) goto error\n// tag_copy = yaml_strdup(tag)\n// if (!tag_copy) goto error\n//\n// if (!STACK_INIT(&context, pairs, INITIAL_STACK_SIZE)) goto error\n//\n// MAPPING_NODE_INIT(node, tag_copy, pairs.start, pairs.end,\n// style, mark, mark)\n// if (!PUSH(&context, document.nodes, node)) goto error\n//\n// return document.nodes.top - document.nodes.start\n//\n//error:\n// STACK_DEL(&context, pairs)\n// yaml_free(tag_copy)\n//\n// return 0\n//}\n//\n///*\n// * Append an item to a sequence node.\n// */\n//\n//YAML_DECLARE(int)\n//yaml_document_append_sequence_item(document *yaml_document_t,\n// sequence int, item int)\n//{\n// struct {\n// error yaml_error_type_t\n// } context\n//\n// assert(document) // Non-NULL document is required.\n// assert(sequence > 0\n// && document.nodes.start + sequence <= document.nodes.top)\n// // Valid sequence id is required.\n// assert(document.nodes.start[sequence-1].type == YAML_SEQUENCE_NODE)\n// // A sequence node is required.\n// assert(item > 0 && document.nodes.start + item <= document.nodes.top)\n// // Valid item id is required.\n//\n// if (!PUSH(&context,\n// document.nodes.start[sequence-1].data.sequence.items, item))\n// return 0\n//\n// return 1\n//}\n//\n///*\n// * Append a pair of a key and a value to a mapping node.\n// */\n//\n//YAML_DECLARE(int)\n//yaml_document_append_mapping_pair(document *yaml_document_t,\n// mapping int, key int, value int)\n//{\n// struct {\n// error yaml_error_type_t\n// } context\n//\n// pair yaml_node_pair_t\n//\n// assert(document) // Non-NULL document is required.\n// assert(mapping > 0\n// && document.nodes.start + mapping <= document.nodes.top)\n// // Valid mapping id is required.\n// assert(document.nodes.start[mapping-1].type == YAML_MAPPING_NODE)\n// // A mapping node is required.\n// assert(key > 0 && document.nodes.start + key <= document.nodes.top)\n// // Valid key id is required.\n// assert(value > 0 && document.nodes.start + value <= document.nodes.top)\n// // Valid value id is required.\n//\n// pair.key = key\n// pair.value = value\n//\n// if (!PUSH(&context,\n// document.nodes.start[mapping-1].data.mapping.pairs, pair))\n// return 0\n//\n// return 1\n//}\n//\n//\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/decode.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage yaml\n\nimport (\n\t\"encoding\"\n\t\"encoding/base64\"\n\t\"fmt\"\n\t\"io\"\n\t\"math\"\n\t\"reflect\"\n\t\"strconv\"\n\t\"time\"\n)\n\n// ----------------------------------------------------------------------------\n// Parser, produces a node tree out of a libyaml event stream.\n\ntype parser struct {\n\tparser yaml_parser_t\n\tevent yaml_event_t\n\tdoc *Node\n\tanchors map[string]*Node\n\tdoneInit bool\n\ttextless bool\n}\n\nfunc newParser(b []byte) *parser {\n\tp := parser{}\n\tif !yaml_parser_initialize(&p.parser) {\n\t\tpanic(\"failed to initialize YAML emitter\")\n\t}\n\tif len(b) == 0 {\n\t\tb = []byte{'\\n'}\n\t}\n\tyaml_parser_set_input_string(&p.parser, b)\n\treturn &p\n}\n\nfunc newParserFromReader(r io.Reader) *parser {\n\tp := parser{}\n\tif !yaml_parser_initialize(&p.parser) {\n\t\tpanic(\"failed to initialize YAML emitter\")\n\t}\n\tyaml_parser_set_input_reader(&p.parser, r)\n\treturn &p\n}\n\nfunc (p *parser) init() {\n\tif p.doneInit {\n\t\treturn\n\t}\n\tp.anchors = make(map[string]*Node)\n\tp.expect(yaml_STREAM_START_EVENT)\n\tp.doneInit = true\n}\n\nfunc (p *parser) destroy() {\n\tif p.event.typ != yaml_NO_EVENT {\n\t\tyaml_event_delete(&p.event)\n\t}\n\tyaml_parser_delete(&p.parser)\n}\n\n// expect consumes an event from the event stream and\n// checks that it's of the expected type.\nfunc (p *parser) expect(e yaml_event_type_t) {\n\tif p.event.typ == yaml_NO_EVENT {\n\t\tif !yaml_parser_parse(&p.parser, &p.event) {\n\t\t\tp.fail()\n\t\t}\n\t}\n\tif p.event.typ == yaml_STREAM_END_EVENT {\n\t\tfailf(\"attempted to go past the end of stream; corrupted value?\")\n\t}\n\tif p.event.typ != e {\n\t\tp.parser.problem = fmt.Sprintf(\"expected %s event but got %s\", e, p.event.typ)\n\t\tp.fail()\n\t}\n\tyaml_event_delete(&p.event)\n\tp.event.typ = yaml_NO_EVENT\n}\n\n// peek peeks at the next event in the event stream,\n// puts the results into p.event and returns the event type.\nfunc (p *parser) peek() yaml_event_type_t {\n\tif p.event.typ != yaml_NO_EVENT {\n\t\treturn p.event.typ\n\t}\n\t// It's curious choice from the underlying API to generally return a\n\t// positive result on success, but on this case return true in an error\n\t// scenario. This was the source of bugs in the past (issue #666).\n\tif !yaml_parser_parse(&p.parser, &p.event) || p.parser.error != yaml_NO_ERROR {\n\t\tp.fail()\n\t}\n\treturn p.event.typ\n}\n\nfunc (p *parser) fail() {\n\tvar where string\n\tvar line int\n\tif p.parser.context_mark.line != 0 {\n\t\tline = p.parser.context_mark.line\n\t\t// Scanner errors don't iterate line before returning error\n\t\tif p.parser.error == yaml_SCANNER_ERROR {\n\t\t\tline++\n\t\t}\n\t} else if p.parser.problem_mark.line != 0 {\n\t\tline = p.parser.problem_mark.line\n\t\t// Scanner errors don't iterate line before returning error\n\t\tif p.parser.error == yaml_SCANNER_ERROR {\n\t\t\tline++\n\t\t}\n\t}\n\tif line != 0 {\n\t\twhere = \"line \" + strconv.Itoa(line) + \": \"\n\t}\n\tvar msg string\n\tif len(p.parser.problem) > 0 {\n\t\tmsg = p.parser.problem\n\t} else {\n\t\tmsg = \"unknown problem parsing YAML content\"\n\t}\n\tfailf(\"%s%s\", where, msg)\n}\n\nfunc (p *parser) anchor(n *Node, anchor []byte) {\n\tif anchor != nil {\n\t\tn.Anchor = string(anchor)\n\t\tp.anchors[n.Anchor] = n\n\t}\n}\n\nfunc (p *parser) parse() *Node {\n\tp.init()\n\tswitch p.peek() {\n\tcase yaml_SCALAR_EVENT:\n\t\treturn p.scalar()\n\tcase yaml_ALIAS_EVENT:\n\t\treturn p.alias()\n\tcase yaml_MAPPING_START_EVENT:\n\t\treturn p.mapping()\n\tcase yaml_SEQUENCE_START_EVENT:\n\t\treturn p.sequence()\n\tcase yaml_DOCUMENT_START_EVENT:\n\t\treturn p.document()\n\tcase yaml_STREAM_END_EVENT:\n\t\t// Happens when attempting to decode an empty buffer.\n\t\treturn nil\n\tcase yaml_TAIL_COMMENT_EVENT:\n\t\tpanic(\"internal error: unexpected tail comment event (please report)\")\n\tdefault:\n\t\tpanic(\"internal error: attempted to parse unknown event (please report): \" + p.event.typ.String())\n\t}\n}\n\nfunc (p *parser) node(kind Kind, defaultTag, tag, value string) *Node {\n\tvar style Style\n\tif tag != \"\" && tag != \"!\" {\n\t\ttag = shortTag(tag)\n\t\tstyle = TaggedStyle\n\t} else if defaultTag != \"\" {\n\t\ttag = defaultTag\n\t} else if kind == ScalarNode {\n\t\ttag, _ = resolve(\"\", value)\n\t}\n\tn := &Node{\n\t\tKind: kind,\n\t\tTag: tag,\n\t\tValue: value,\n\t\tStyle: style,\n\t}\n\tif !p.textless {\n\t\tn.Line = p.event.start_mark.line + 1\n\t\tn.Column = p.event.start_mark.column + 1\n\t\tn.HeadComment = string(p.event.head_comment)\n\t\tn.LineComment = string(p.event.line_comment)\n\t\tn.FootComment = string(p.event.foot_comment)\n\t}\n\treturn n\n}\n\nfunc (p *parser) parseChild(parent *Node) *Node {\n\tchild := p.parse()\n\tparent.Content = append(parent.Content, child)\n\treturn child\n}\n\nfunc (p *parser) document() *Node {\n\tn := p.node(DocumentNode, \"\", \"\", \"\")\n\tp.doc = n\n\tp.expect(yaml_DOCUMENT_START_EVENT)\n\tp.parseChild(n)\n\tif p.peek() == yaml_DOCUMENT_END_EVENT {\n\t\tn.FootComment = string(p.event.foot_comment)\n\t}\n\tp.expect(yaml_DOCUMENT_END_EVENT)\n\treturn n\n}\n\nfunc (p *parser) alias() *Node {\n\tn := p.node(AliasNode, \"\", \"\", string(p.event.anchor))\n\tn.Alias = p.anchors[n.Value]\n\tif n.Alias == nil {\n\t\tfailf(\"unknown anchor '%s' referenced\", n.Value)\n\t}\n\tp.expect(yaml_ALIAS_EVENT)\n\treturn n\n}\n\nfunc (p *parser) scalar() *Node {\n\tvar parsedStyle = p.event.scalar_style()\n\tvar nodeStyle Style\n\tswitch {\n\tcase parsedStyle&yaml_DOUBLE_QUOTED_SCALAR_STYLE != 0:\n\t\tnodeStyle = DoubleQuotedStyle\n\tcase parsedStyle&yaml_SINGLE_QUOTED_SCALAR_STYLE != 0:\n\t\tnodeStyle = SingleQuotedStyle\n\tcase parsedStyle&yaml_LITERAL_SCALAR_STYLE != 0:\n\t\tnodeStyle = LiteralStyle\n\tcase parsedStyle&yaml_FOLDED_SCALAR_STYLE != 0:\n\t\tnodeStyle = FoldedStyle\n\t}\n\tvar nodeValue = string(p.event.value)\n\tvar nodeTag = string(p.event.tag)\n\tvar defaultTag string\n\tif nodeStyle == 0 {\n\t\tif nodeValue == \"<<\" {\n\t\t\tdefaultTag = mergeTag\n\t\t}\n\t} else {\n\t\tdefaultTag = strTag\n\t}\n\tn := p.node(ScalarNode, defaultTag, nodeTag, nodeValue)\n\tn.Style |= nodeStyle\n\tp.anchor(n, p.event.anchor)\n\tp.expect(yaml_SCALAR_EVENT)\n\treturn n\n}\n\nfunc (p *parser) sequence() *Node {\n\tn := p.node(SequenceNode, seqTag, string(p.event.tag), \"\")\n\tif p.event.sequence_style()&yaml_FLOW_SEQUENCE_STYLE != 0 {\n\t\tn.Style |= FlowStyle\n\t}\n\tp.anchor(n, p.event.anchor)\n\tp.expect(yaml_SEQUENCE_START_EVENT)\n\tfor p.peek() != yaml_SEQUENCE_END_EVENT {\n\t\tp.parseChild(n)\n\t}\n\tn.LineComment = string(p.event.line_comment)\n\tn.FootComment = string(p.event.foot_comment)\n\tp.expect(yaml_SEQUENCE_END_EVENT)\n\treturn n\n}\n\nfunc (p *parser) mapping() *Node {\n\tn := p.node(MappingNode, mapTag, string(p.event.tag), \"\")\n\tblock := true\n\tif p.event.mapping_style()&yaml_FLOW_MAPPING_STYLE != 0 {\n\t\tblock = false\n\t\tn.Style |= FlowStyle\n\t}\n\tp.anchor(n, p.event.anchor)\n\tp.expect(yaml_MAPPING_START_EVENT)\n\tfor p.peek() != yaml_MAPPING_END_EVENT {\n\t\tk := p.parseChild(n)\n\t\tif block && k.FootComment != \"\" {\n\t\t\t// Must be a foot comment for the prior value when being dedented.\n\t\t\tif len(n.Content) > 2 {\n\t\t\t\tn.Content[len(n.Content)-3].FootComment = k.FootComment\n\t\t\t\tk.FootComment = \"\"\n\t\t\t}\n\t\t}\n\t\tv := p.parseChild(n)\n\t\tif k.FootComment == \"\" && v.FootComment != \"\" {\n\t\t\tk.FootComment = v.FootComment\n\t\t\tv.FootComment = \"\"\n\t\t}\n\t\tif p.peek() == yaml_TAIL_COMMENT_EVENT {\n\t\t\tif k.FootComment == \"\" {\n\t\t\t\tk.FootComment = string(p.event.foot_comment)\n\t\t\t}\n\t\t\tp.expect(yaml_TAIL_COMMENT_EVENT)\n\t\t}\n\t}\n\tn.LineComment = string(p.event.line_comment)\n\tn.FootComment = string(p.event.foot_comment)\n\tif n.Style&FlowStyle == 0 && n.FootComment != \"\" && len(n.Content) > 1 {\n\t\tn.Content[len(n.Content)-2].FootComment = n.FootComment\n\t\tn.FootComment = \"\"\n\t}\n\tp.expect(yaml_MAPPING_END_EVENT)\n\treturn n\n}\n\n// ----------------------------------------------------------------------------\n// Decoder, unmarshals a node into a provided value.\n\ntype decoder struct {\n\tdoc *Node\n\taliases map[*Node]bool\n\tterrors []string\n\n\tstringMapType reflect.Type\n\tgeneralMapType reflect.Type\n\n\tknownFields bool\n\tuniqueKeys bool\n\tdecodeCount int\n\taliasCount int\n\taliasDepth int\n\n\tmergedFields map[interface{}]bool\n}\n\nvar (\n\tnodeType = reflect.TypeOf(Node{})\n\tdurationType = reflect.TypeOf(time.Duration(0))\n\tstringMapType = reflect.TypeOf(map[string]interface{}{})\n\tgeneralMapType = reflect.TypeOf(map[interface{}]interface{}{})\n\tifaceType = generalMapType.Elem()\n\ttimeType = reflect.TypeOf(time.Time{})\n\tptrTimeType = reflect.TypeOf(&time.Time{})\n)\n\nfunc newDecoder() *decoder {\n\td := &decoder{\n\t\tstringMapType: stringMapType,\n\t\tgeneralMapType: generalMapType,\n\t\tuniqueKeys: true,\n\t}\n\td.aliases = make(map[*Node]bool)\n\treturn d\n}\n\nfunc (d *decoder) terror(n *Node, tag string, out reflect.Value) {\n\tif n.Tag != \"\" {\n\t\ttag = n.Tag\n\t}\n\tvalue := n.Value\n\tif tag != seqTag && tag != mapTag {\n\t\tif len(value) > 10 {\n\t\t\tvalue = \" `\" + value[:7] + \"...`\"\n\t\t} else {\n\t\t\tvalue = \" `\" + value + \"`\"\n\t\t}\n\t}\n\td.terrors = append(d.terrors, fmt.Sprintf(\"line %d: cannot unmarshal %s%s into %s\", n.Line, shortTag(tag), value, out.Type()))\n}\n\nfunc (d *decoder) callUnmarshaler(n *Node, u Unmarshaler) (good bool) {\n\terr := u.UnmarshalYAML(n)\n\tif e, ok := err.(*TypeError); ok {\n\t\td.terrors = append(d.terrors, e.Errors...)\n\t\treturn false\n\t}\n\tif err != nil {\n\t\tfail(err)\n\t}\n\treturn true\n}\n\nfunc (d *decoder) callObsoleteUnmarshaler(n *Node, u obsoleteUnmarshaler) (good bool) {\n\tterrlen := len(d.terrors)\n\terr := u.UnmarshalYAML(func(v interface{}) (err error) {\n\t\tdefer handleErr(&err)\n\t\td.unmarshal(n, reflect.ValueOf(v))\n\t\tif len(d.terrors) > terrlen {\n\t\t\tissues := d.terrors[terrlen:]\n\t\t\td.terrors = d.terrors[:terrlen]\n\t\t\treturn &TypeError{issues}\n\t\t}\n\t\treturn nil\n\t})\n\tif e, ok := err.(*TypeError); ok {\n\t\td.terrors = append(d.terrors, e.Errors...)\n\t\treturn false\n\t}\n\tif err != nil {\n\t\tfail(err)\n\t}\n\treturn true\n}\n\n// d.prepare initializes and dereferences pointers and calls UnmarshalYAML\n// if a value is found to implement it.\n// It returns the initialized and dereferenced out value, whether\n// unmarshalling was already done by UnmarshalYAML, and if so whether\n// its types unmarshalled appropriately.\n//\n// If n holds a null value, prepare returns before doing anything.\nfunc (d *decoder) prepare(n *Node, out reflect.Value) (newout reflect.Value, unmarshaled, good bool) {\n\tif n.ShortTag() == nullTag {\n\t\treturn out, false, false\n\t}\n\tagain := true\n\tfor again {\n\t\tagain = false\n\t\tif out.Kind() == reflect.Ptr {\n\t\t\tif out.IsNil() {\n\t\t\t\tout.Set(reflect.New(out.Type().Elem()))\n\t\t\t}\n\t\t\tout = out.Elem()\n\t\t\tagain = true\n\t\t}\n\t\tif out.CanAddr() {\n\t\t\touti := out.Addr().Interface()\n\t\t\tif u, ok := outi.(Unmarshaler); ok {\n\t\t\t\tgood = d.callUnmarshaler(n, u)\n\t\t\t\treturn out, true, good\n\t\t\t}\n\t\t\tif u, ok := outi.(obsoleteUnmarshaler); ok {\n\t\t\t\tgood = d.callObsoleteUnmarshaler(n, u)\n\t\t\t\treturn out, true, good\n\t\t\t}\n\t\t}\n\t}\n\treturn out, false, false\n}\n\nfunc (d *decoder) fieldByIndex(n *Node, v reflect.Value, index []int) (field reflect.Value) {\n\tif n.ShortTag() == nullTag {\n\t\treturn reflect.Value{}\n\t}\n\tfor _, num := range index {\n\t\tfor {\n\t\t\tif v.Kind() == reflect.Ptr {\n\t\t\t\tif v.IsNil() {\n\t\t\t\t\tv.Set(reflect.New(v.Type().Elem()))\n\t\t\t\t}\n\t\t\t\tv = v.Elem()\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tbreak\n\t\t}\n\t\tv = v.Field(num)\n\t}\n\treturn v\n}\n\nconst (\n\t// 400,000 decode operations is ~500kb of dense object declarations, or\n\t// ~5kb of dense object declarations with 10000% alias expansion\n\talias_ratio_range_low = 400000\n\n\t// 4,000,000 decode operations is ~5MB of dense object declarations, or\n\t// ~4.5MB of dense object declarations with 10% alias expansion\n\talias_ratio_range_high = 4000000\n\n\t// alias_ratio_range is the range over which we scale allowed alias ratios\n\talias_ratio_range = float64(alias_ratio_range_high - alias_ratio_range_low)\n)\n\nfunc allowedAliasRatio(decodeCount int) float64 {\n\tswitch {\n\tcase decodeCount <= alias_ratio_range_low:\n\t\t// allow 99% to come from alias expansion for small-to-medium documents\n\t\treturn 0.99\n\tcase decodeCount >= alias_ratio_range_high:\n\t\t// allow 10% to come from alias expansion for very large documents\n\t\treturn 0.10\n\tdefault:\n\t\t// scale smoothly from 99% down to 10% over the range.\n\t\t// this maps to 396,000 - 400,000 allowed alias-driven decodes over the range.\n\t\t// 400,000 decode operations is ~100MB of allocations in worst-case scenarios (single-item maps).\n\t\treturn 0.99 - 0.89*(float64(decodeCount-alias_ratio_range_low)/alias_ratio_range)\n\t}\n}\n\nfunc (d *decoder) unmarshal(n *Node, out reflect.Value) (good bool) {\n\td.decodeCount++\n\tif d.aliasDepth > 0 {\n\t\td.aliasCount++\n\t}\n\tif d.aliasCount > 100 && d.decodeCount > 1000 && float64(d.aliasCount)/float64(d.decodeCount) > allowedAliasRatio(d.decodeCount) {\n\t\tfailf(\"document contains excessive aliasing\")\n\t}\n\tif out.Type() == nodeType {\n\t\tout.Set(reflect.ValueOf(n).Elem())\n\t\treturn true\n\t}\n\tswitch n.Kind {\n\tcase DocumentNode:\n\t\treturn d.document(n, out)\n\tcase AliasNode:\n\t\treturn d.alias(n, out)\n\t}\n\tout, unmarshaled, good := d.prepare(n, out)\n\tif unmarshaled {\n\t\treturn good\n\t}\n\tswitch n.Kind {\n\tcase ScalarNode:\n\t\tgood = d.scalar(n, out)\n\tcase MappingNode:\n\t\tgood = d.mapping(n, out)\n\tcase SequenceNode:\n\t\tgood = d.sequence(n, out)\n\tcase 0:\n\t\tif n.IsZero() {\n\t\t\treturn d.null(out)\n\t\t}\n\t\tfallthrough\n\tdefault:\n\t\tfailf(\"cannot decode node with unknown kind %d\", n.Kind)\n\t}\n\treturn good\n}\n\nfunc (d *decoder) document(n *Node, out reflect.Value) (good bool) {\n\tif len(n.Content) == 1 {\n\t\td.doc = n\n\t\td.unmarshal(n.Content[0], out)\n\t\treturn true\n\t}\n\treturn false\n}\n\nfunc (d *decoder) alias(n *Node, out reflect.Value) (good bool) {\n\tif d.aliases[n] {\n\t\t// TODO this could actually be allowed in some circumstances.\n\t\tfailf(\"anchor '%s' value contains itself\", n.Value)\n\t}\n\td.aliases[n] = true\n\td.aliasDepth++\n\tgood = d.unmarshal(n.Alias, out)\n\td.aliasDepth--\n\tdelete(d.aliases, n)\n\treturn good\n}\n\nvar zeroValue reflect.Value\n\nfunc resetMap(out reflect.Value) {\n\tfor _, k := range out.MapKeys() {\n\t\tout.SetMapIndex(k, zeroValue)\n\t}\n}\n\nfunc (d *decoder) null(out reflect.Value) bool {\n\tif out.CanAddr() {\n\t\tswitch out.Kind() {\n\t\tcase reflect.Interface, reflect.Ptr, reflect.Map, reflect.Slice:\n\t\t\tout.Set(reflect.Zero(out.Type()))\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (d *decoder) scalar(n *Node, out reflect.Value) bool {\n\tvar tag string\n\tvar resolved interface{}\n\tif n.indicatedString() {\n\t\ttag = strTag\n\t\tresolved = n.Value\n\t} else {\n\t\ttag, resolved = resolve(n.Tag, n.Value)\n\t\tif tag == binaryTag {\n\t\t\tdata, err := base64.StdEncoding.DecodeString(resolved.(string))\n\t\t\tif err != nil {\n\t\t\t\tfailf(\"!!binary value contains invalid base64 data\")\n\t\t\t}\n\t\t\tresolved = string(data)\n\t\t}\n\t}\n\tif resolved == nil {\n\t\treturn d.null(out)\n\t}\n\tif resolvedv := reflect.ValueOf(resolved); out.Type() == resolvedv.Type() {\n\t\t// We've resolved to exactly the type we want, so use that.\n\t\tout.Set(resolvedv)\n\t\treturn true\n\t}\n\t// Perhaps we can use the value as a TextUnmarshaler to\n\t// set its value.\n\tif out.CanAddr() {\n\t\tu, ok := out.Addr().Interface().(encoding.TextUnmarshaler)\n\t\tif ok {\n\t\t\tvar text []byte\n\t\t\tif tag == binaryTag {\n\t\t\t\ttext = []byte(resolved.(string))\n\t\t\t} else {\n\t\t\t\t// We let any value be unmarshaled into TextUnmarshaler.\n\t\t\t\t// That might be more lax than we'd like, but the\n\t\t\t\t// TextUnmarshaler itself should bowl out any dubious values.\n\t\t\t\ttext = []byte(n.Value)\n\t\t\t}\n\t\t\terr := u.UnmarshalText(text)\n\t\t\tif err != nil {\n\t\t\t\tfail(err)\n\t\t\t}\n\t\t\treturn true\n\t\t}\n\t}\n\tswitch out.Kind() {\n\tcase reflect.String:\n\t\tif tag == binaryTag {\n\t\t\tout.SetString(resolved.(string))\n\t\t\treturn true\n\t\t}\n\t\tout.SetString(n.Value)\n\t\treturn true\n\tcase reflect.Interface:\n\t\tout.Set(reflect.ValueOf(resolved))\n\t\treturn true\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\t// This used to work in v2, but it's very unfriendly.\n\t\tisDuration := out.Type() == durationType\n\n\t\tswitch resolved := resolved.(type) {\n\t\tcase int:\n\t\t\tif !isDuration && !out.OverflowInt(int64(resolved)) {\n\t\t\t\tout.SetInt(int64(resolved))\n\t\t\t\treturn true\n\t\t\t}\n\t\tcase int64:\n\t\t\tif !isDuration && !out.OverflowInt(resolved) {\n\t\t\t\tout.SetInt(resolved)\n\t\t\t\treturn true\n\t\t\t}\n\t\tcase uint64:\n\t\t\tif !isDuration && resolved <= math.MaxInt64 && !out.OverflowInt(int64(resolved)) {\n\t\t\t\tout.SetInt(int64(resolved))\n\t\t\t\treturn true\n\t\t\t}\n\t\tcase float64:\n\t\t\tif !isDuration && resolved <= math.MaxInt64 && !out.OverflowInt(int64(resolved)) {\n\t\t\t\tout.SetInt(int64(resolved))\n\t\t\t\treturn true\n\t\t\t}\n\t\tcase string:\n\t\t\tif out.Type() == durationType {\n\t\t\t\td, err := time.ParseDuration(resolved)\n\t\t\t\tif err == nil {\n\t\t\t\t\tout.SetInt(int64(d))\n\t\t\t\t\treturn true\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\tswitch resolved := resolved.(type) {\n\t\tcase int:\n\t\t\tif resolved >= 0 && !out.OverflowUint(uint64(resolved)) {\n\t\t\t\tout.SetUint(uint64(resolved))\n\t\t\t\treturn true\n\t\t\t}\n\t\tcase int64:\n\t\t\tif resolved >= 0 && !out.OverflowUint(uint64(resolved)) {\n\t\t\t\tout.SetUint(uint64(resolved))\n\t\t\t\treturn true\n\t\t\t}\n\t\tcase uint64:\n\t\t\tif !out.OverflowUint(uint64(resolved)) {\n\t\t\t\tout.SetUint(uint64(resolved))\n\t\t\t\treturn true\n\t\t\t}\n\t\tcase float64:\n\t\t\tif resolved <= math.MaxUint64 && !out.OverflowUint(uint64(resolved)) {\n\t\t\t\tout.SetUint(uint64(resolved))\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\tcase reflect.Bool:\n\t\tswitch resolved := resolved.(type) {\n\t\tcase bool:\n\t\t\tout.SetBool(resolved)\n\t\t\treturn true\n\t\tcase string:\n\t\t\t// This offers some compatibility with the 1.1 spec (https://yaml.org/type/bool.html).\n\t\t\t// It only works if explicitly attempting to unmarshal into a typed bool value.\n\t\t\tswitch resolved {\n\t\t\tcase \"y\", \"Y\", \"yes\", \"Yes\", \"YES\", \"on\", \"On\", \"ON\":\n\t\t\t\tout.SetBool(true)\n\t\t\t\treturn true\n\t\t\tcase \"n\", \"N\", \"no\", \"No\", \"NO\", \"off\", \"Off\", \"OFF\":\n\t\t\t\tout.SetBool(false)\n\t\t\t\treturn true\n\t\t\t}\n\t\t}\n\tcase reflect.Float32, reflect.Float64:\n\t\tswitch resolved := resolved.(type) {\n\t\tcase int:\n\t\t\tout.SetFloat(float64(resolved))\n\t\t\treturn true\n\t\tcase int64:\n\t\t\tout.SetFloat(float64(resolved))\n\t\t\treturn true\n\t\tcase uint64:\n\t\t\tout.SetFloat(float64(resolved))\n\t\t\treturn true\n\t\tcase float64:\n\t\t\tout.SetFloat(resolved)\n\t\t\treturn true\n\t\t}\n\tcase reflect.Struct:\n\t\tif resolvedv := reflect.ValueOf(resolved); out.Type() == resolvedv.Type() {\n\t\t\tout.Set(resolvedv)\n\t\t\treturn true\n\t\t}\n\tcase reflect.Ptr:\n\t\tpanic(\"yaml internal error: please report the issue\")\n\t}\n\td.terror(n, tag, out)\n\treturn false\n}\n\nfunc settableValueOf(i interface{}) reflect.Value {\n\tv := reflect.ValueOf(i)\n\tsv := reflect.New(v.Type()).Elem()\n\tsv.Set(v)\n\treturn sv\n}\n\nfunc (d *decoder) sequence(n *Node, out reflect.Value) (good bool) {\n\tl := len(n.Content)\n\n\tvar iface reflect.Value\n\tswitch out.Kind() {\n\tcase reflect.Slice:\n\t\tout.Set(reflect.MakeSlice(out.Type(), l, l))\n\tcase reflect.Array:\n\t\tif l != out.Len() {\n\t\t\tfailf(\"invalid array: want %d elements but got %d\", out.Len(), l)\n\t\t}\n\tcase reflect.Interface:\n\t\t// No type hints. Will have to use a generic sequence.\n\t\tiface = out\n\t\tout = settableValueOf(make([]interface{}, l))\n\tdefault:\n\t\td.terror(n, seqTag, out)\n\t\treturn false\n\t}\n\tet := out.Type().Elem()\n\n\tj := 0\n\tfor i := 0; i < l; i++ {\n\t\te := reflect.New(et).Elem()\n\t\tif ok := d.unmarshal(n.Content[i], e); ok {\n\t\t\tout.Index(j).Set(e)\n\t\t\tj++\n\t\t}\n\t}\n\tif out.Kind() != reflect.Array {\n\t\tout.Set(out.Slice(0, j))\n\t}\n\tif iface.IsValid() {\n\t\tiface.Set(out)\n\t}\n\treturn true\n}\n\nfunc (d *decoder) mapping(n *Node, out reflect.Value) (good bool) {\n\tl := len(n.Content)\n\tif d.uniqueKeys {\n\t\tnerrs := len(d.terrors)\n\t\tfor i := 0; i < l; i += 2 {\n\t\t\tni := n.Content[i]\n\t\t\tfor j := i + 2; j < l; j += 2 {\n\t\t\t\tnj := n.Content[j]\n\t\t\t\tif ni.Kind == nj.Kind && ni.Value == nj.Value {\n\t\t\t\t\td.terrors = append(d.terrors, fmt.Sprintf(\"line %d: mapping key %#v already defined at line %d\", nj.Line, nj.Value, ni.Line))\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif len(d.terrors) > nerrs {\n\t\t\treturn false\n\t\t}\n\t}\n\tswitch out.Kind() {\n\tcase reflect.Struct:\n\t\treturn d.mappingStruct(n, out)\n\tcase reflect.Map:\n\t\t// okay\n\tcase reflect.Interface:\n\t\tiface := out\n\t\tif isStringMap(n) {\n\t\t\tout = reflect.MakeMap(d.stringMapType)\n\t\t} else {\n\t\t\tout = reflect.MakeMap(d.generalMapType)\n\t\t}\n\t\tiface.Set(out)\n\tdefault:\n\t\td.terror(n, mapTag, out)\n\t\treturn false\n\t}\n\n\toutt := out.Type()\n\tkt := outt.Key()\n\tet := outt.Elem()\n\n\tstringMapType := d.stringMapType\n\tgeneralMapType := d.generalMapType\n\tif outt.Elem() == ifaceType {\n\t\tif outt.Key().Kind() == reflect.String {\n\t\t\td.stringMapType = outt\n\t\t} else if outt.Key() == ifaceType {\n\t\t\td.generalMapType = outt\n\t\t}\n\t}\n\n\tmergedFields := d.mergedFields\n\td.mergedFields = nil\n\n\tvar mergeNode *Node\n\n\tmapIsNew := false\n\tif out.IsNil() {\n\t\tout.Set(reflect.MakeMap(outt))\n\t\tmapIsNew = true\n\t}\n\tfor i := 0; i < l; i += 2 {\n\t\tif isMerge(n.Content[i]) {\n\t\t\tmergeNode = n.Content[i+1]\n\t\t\tcontinue\n\t\t}\n\t\tk := reflect.New(kt).Elem()\n\t\tif d.unmarshal(n.Content[i], k) {\n\t\t\tif mergedFields != nil {\n\t\t\t\tki := k.Interface()\n\t\t\t\tif d.getPossiblyUnhashableKey(mergedFields, ki) {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\td.setPossiblyUnhashableKey(mergedFields, ki, true)\n\t\t\t}\n\t\t\tkkind := k.Kind()\n\t\t\tif kkind == reflect.Interface {\n\t\t\t\tkkind = k.Elem().Kind()\n\t\t\t}\n\t\t\tif kkind == reflect.Map || kkind == reflect.Slice {\n\t\t\t\tfailf(\"invalid map key: %#v\", k.Interface())\n\t\t\t}\n\t\t\te := reflect.New(et).Elem()\n\t\t\tif d.unmarshal(n.Content[i+1], e) || n.Content[i+1].ShortTag() == nullTag && (mapIsNew || !out.MapIndex(k).IsValid()) {\n\t\t\t\tout.SetMapIndex(k, e)\n\t\t\t}\n\t\t}\n\t}\n\n\td.mergedFields = mergedFields\n\tif mergeNode != nil {\n\t\td.merge(n, mergeNode, out)\n\t}\n\n\td.stringMapType = stringMapType\n\td.generalMapType = generalMapType\n\treturn true\n}\n\nfunc isStringMap(n *Node) bool {\n\tif n.Kind != MappingNode {\n\t\treturn false\n\t}\n\tl := len(n.Content)\n\tfor i := 0; i < l; i += 2 {\n\t\tshortTag := n.Content[i].ShortTag()\n\t\tif shortTag != strTag && shortTag != mergeTag {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\nfunc (d *decoder) mappingStruct(n *Node, out reflect.Value) (good bool) {\n\tsinfo, err := getStructInfo(out.Type())\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tvar inlineMap reflect.Value\n\tvar elemType reflect.Type\n\tif sinfo.InlineMap != -1 {\n\t\tinlineMap = out.Field(sinfo.InlineMap)\n\t\telemType = inlineMap.Type().Elem()\n\t}\n\n\tfor _, index := range sinfo.InlineUnmarshalers {\n\t\tfield := d.fieldByIndex(n, out, index)\n\t\td.prepare(n, field)\n\t}\n\n\tmergedFields := d.mergedFields\n\td.mergedFields = nil\n\tvar mergeNode *Node\n\tvar doneFields []bool\n\tif d.uniqueKeys {\n\t\tdoneFields = make([]bool, len(sinfo.FieldsList))\n\t}\n\tname := settableValueOf(\"\")\n\tl := len(n.Content)\n\tfor i := 0; i < l; i += 2 {\n\t\tni := n.Content[i]\n\t\tif isMerge(ni) {\n\t\t\tmergeNode = n.Content[i+1]\n\t\t\tcontinue\n\t\t}\n\t\tif !d.unmarshal(ni, name) {\n\t\t\tcontinue\n\t\t}\n\t\tsname := name.String()\n\t\tif mergedFields != nil {\n\t\t\tif mergedFields[sname] {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tmergedFields[sname] = true\n\t\t}\n\t\tif info, ok := sinfo.FieldsMap[sname]; ok {\n\t\t\tif d.uniqueKeys {\n\t\t\t\tif doneFields[info.Id] {\n\t\t\t\t\td.terrors = append(d.terrors, fmt.Sprintf(\"line %d: field %s already set in type %s\", ni.Line, name.String(), out.Type()))\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tdoneFields[info.Id] = true\n\t\t\t}\n\t\t\tvar field reflect.Value\n\t\t\tif info.Inline == nil {\n\t\t\t\tfield = out.Field(info.Num)\n\t\t\t} else {\n\t\t\t\tfield = d.fieldByIndex(n, out, info.Inline)\n\t\t\t}\n\t\t\td.unmarshal(n.Content[i+1], field)\n\t\t} else if sinfo.InlineMap != -1 {\n\t\t\tif inlineMap.IsNil() {\n\t\t\t\tinlineMap.Set(reflect.MakeMap(inlineMap.Type()))\n\t\t\t}\n\t\t\tvalue := reflect.New(elemType).Elem()\n\t\t\td.unmarshal(n.Content[i+1], value)\n\t\t\tinlineMap.SetMapIndex(name, value)\n\t\t} else if d.knownFields {\n\t\t\td.terrors = append(d.terrors, fmt.Sprintf(\"line %d: field %s not found in type %s\", ni.Line, name.String(), out.Type()))\n\t\t}\n\t}\n\n\td.mergedFields = mergedFields\n\tif mergeNode != nil {\n\t\td.merge(n, mergeNode, out)\n\t}\n\treturn true\n}\n\nfunc failWantMap() {\n\tfailf(\"map merge requires map or sequence of maps as the value\")\n}\n\nfunc (d *decoder) setPossiblyUnhashableKey(m map[interface{}]bool, key interface{}, value bool) {\n\tdefer func() {\n\t\tif err := recover(); err != nil {\n\t\t\tfailf(\"%v\", err)\n\t\t}\n\t}()\n\tm[key] = value\n}\n\nfunc (d *decoder) getPossiblyUnhashableKey(m map[interface{}]bool, key interface{}) bool {\n\tdefer func() {\n\t\tif err := recover(); err != nil {\n\t\t\tfailf(\"%v\", err)\n\t\t}\n\t}()\n\treturn m[key]\n}\n\nfunc (d *decoder) merge(parent *Node, merge *Node, out reflect.Value) {\n\tmergedFields := d.mergedFields\n\tif mergedFields == nil {\n\t\td.mergedFields = make(map[interface{}]bool)\n\t\tfor i := 0; i < len(parent.Content); i += 2 {\n\t\t\tk := reflect.New(ifaceType).Elem()\n\t\t\tif d.unmarshal(parent.Content[i], k) {\n\t\t\t\td.setPossiblyUnhashableKey(d.mergedFields, k.Interface(), true)\n\t\t\t}\n\t\t}\n\t}\n\n\tswitch merge.Kind {\n\tcase MappingNode:\n\t\td.unmarshal(merge, out)\n\tcase AliasNode:\n\t\tif merge.Alias != nil && merge.Alias.Kind != MappingNode {\n\t\t\tfailWantMap()\n\t\t}\n\t\td.unmarshal(merge, out)\n\tcase SequenceNode:\n\t\tfor i := 0; i < len(merge.Content); i++ {\n\t\t\tni := merge.Content[i]\n\t\t\tif ni.Kind == AliasNode {\n\t\t\t\tif ni.Alias != nil && ni.Alias.Kind != MappingNode {\n\t\t\t\t\tfailWantMap()\n\t\t\t\t}\n\t\t\t} else if ni.Kind != MappingNode {\n\t\t\t\tfailWantMap()\n\t\t\t}\n\t\t\td.unmarshal(ni, out)\n\t\t}\n\tdefault:\n\t\tfailWantMap()\n\t}\n\n\td.mergedFields = mergedFields\n}\n\nfunc isMerge(n *Node) bool {\n\treturn n.Kind == ScalarNode && n.Value == \"<<\" && (n.Tag == \"\" || n.Tag == \"!\" || shortTag(n.Tag) == mergeTag)\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/emitterc.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n// Copyright (c) 2006-2010 Kirill Simonov\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy of\n// this software and associated documentation files (the \"Software\"), to deal in\n// the Software without restriction, including without limitation the rights to\n// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n// of the Software, and to permit persons to whom the Software is furnished to do\n// so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\npackage yaml\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n)\n\n// Flush the buffer if needed.\nfunc flush(emitter *yaml_emitter_t) bool {\n\tif emitter.buffer_pos+5 >= len(emitter.buffer) {\n\t\treturn yaml_emitter_flush(emitter)\n\t}\n\treturn true\n}\n\n// Put a character to the output buffer.\nfunc put(emitter *yaml_emitter_t, value byte) bool {\n\tif emitter.buffer_pos+5 >= len(emitter.buffer) && !yaml_emitter_flush(emitter) {\n\t\treturn false\n\t}\n\temitter.buffer[emitter.buffer_pos] = value\n\temitter.buffer_pos++\n\temitter.column++\n\treturn true\n}\n\n// Put a line break to the output buffer.\nfunc put_break(emitter *yaml_emitter_t) bool {\n\tif emitter.buffer_pos+5 >= len(emitter.buffer) && !yaml_emitter_flush(emitter) {\n\t\treturn false\n\t}\n\tswitch emitter.line_break {\n\tcase yaml_CR_BREAK:\n\t\temitter.buffer[emitter.buffer_pos] = '\\r'\n\t\temitter.buffer_pos += 1\n\tcase yaml_LN_BREAK:\n\t\temitter.buffer[emitter.buffer_pos] = '\\n'\n\t\temitter.buffer_pos += 1\n\tcase yaml_CRLN_BREAK:\n\t\temitter.buffer[emitter.buffer_pos+0] = '\\r'\n\t\temitter.buffer[emitter.buffer_pos+1] = '\\n'\n\t\temitter.buffer_pos += 2\n\tdefault:\n\t\tpanic(\"unknown line break setting\")\n\t}\n\tif emitter.column == 0 {\n\t\temitter.space_above = true\n\t}\n\temitter.column = 0\n\temitter.line++\n\t// [Go] Do this here and below and drop from everywhere else (see commented lines).\n\temitter.indention = true\n\treturn true\n}\n\n// Copy a character from a string into buffer.\nfunc write(emitter *yaml_emitter_t, s []byte, i *int) bool {\n\tif emitter.buffer_pos+5 >= len(emitter.buffer) && !yaml_emitter_flush(emitter) {\n\t\treturn false\n\t}\n\tp := emitter.buffer_pos\n\tw := width(s[*i])\n\tswitch w {\n\tcase 4:\n\t\temitter.buffer[p+3] = s[*i+3]\n\t\tfallthrough\n\tcase 3:\n\t\temitter.buffer[p+2] = s[*i+2]\n\t\tfallthrough\n\tcase 2:\n\t\temitter.buffer[p+1] = s[*i+1]\n\t\tfallthrough\n\tcase 1:\n\t\temitter.buffer[p+0] = s[*i+0]\n\tdefault:\n\t\tpanic(\"unknown character width\")\n\t}\n\temitter.column++\n\temitter.buffer_pos += w\n\t*i += w\n\treturn true\n}\n\n// Write a whole string into buffer.\nfunc write_all(emitter *yaml_emitter_t, s []byte) bool {\n\tfor i := 0; i < len(s); {\n\t\tif !write(emitter, s, &i) {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\n// Copy a line break character from a string into buffer.\nfunc write_break(emitter *yaml_emitter_t, s []byte, i *int) bool {\n\tif s[*i] == '\\n' {\n\t\tif !put_break(emitter) {\n\t\t\treturn false\n\t\t}\n\t\t*i++\n\t} else {\n\t\tif !write(emitter, s, i) {\n\t\t\treturn false\n\t\t}\n\t\tif emitter.column == 0 {\n\t\t\temitter.space_above = true\n\t\t}\n\t\temitter.column = 0\n\t\temitter.line++\n\t\t// [Go] Do this here and above and drop from everywhere else (see commented lines).\n\t\temitter.indention = true\n\t}\n\treturn true\n}\n\n// Set an emitter error and return false.\nfunc yaml_emitter_set_emitter_error(emitter *yaml_emitter_t, problem string) bool {\n\temitter.error = yaml_EMITTER_ERROR\n\temitter.problem = problem\n\treturn false\n}\n\n// Emit an event.\nfunc yaml_emitter_emit(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\temitter.events = append(emitter.events, *event)\n\tfor !yaml_emitter_need_more_events(emitter) {\n\t\tevent := &emitter.events[emitter.events_head]\n\t\tif !yaml_emitter_analyze_event(emitter, event) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_state_machine(emitter, event) {\n\t\t\treturn false\n\t\t}\n\t\tyaml_event_delete(event)\n\t\temitter.events_head++\n\t}\n\treturn true\n}\n\n// Check if we need to accumulate more events before emitting.\n//\n// We accumulate extra\n// - 1 event for DOCUMENT-START\n// - 2 events for SEQUENCE-START\n// - 3 events for MAPPING-START\nfunc yaml_emitter_need_more_events(emitter *yaml_emitter_t) bool {\n\tif emitter.events_head == len(emitter.events) {\n\t\treturn true\n\t}\n\tvar accumulate int\n\tswitch emitter.events[emitter.events_head].typ {\n\tcase yaml_DOCUMENT_START_EVENT:\n\t\taccumulate = 1\n\t\tbreak\n\tcase yaml_SEQUENCE_START_EVENT:\n\t\taccumulate = 2\n\t\tbreak\n\tcase yaml_MAPPING_START_EVENT:\n\t\taccumulate = 3\n\t\tbreak\n\tdefault:\n\t\treturn false\n\t}\n\tif len(emitter.events)-emitter.events_head > accumulate {\n\t\treturn false\n\t}\n\tvar level int\n\tfor i := emitter.events_head; i < len(emitter.events); i++ {\n\t\tswitch emitter.events[i].typ {\n\t\tcase yaml_STREAM_START_EVENT, yaml_DOCUMENT_START_EVENT, yaml_SEQUENCE_START_EVENT, yaml_MAPPING_START_EVENT:\n\t\t\tlevel++\n\t\tcase yaml_STREAM_END_EVENT, yaml_DOCUMENT_END_EVENT, yaml_SEQUENCE_END_EVENT, yaml_MAPPING_END_EVENT:\n\t\t\tlevel--\n\t\t}\n\t\tif level == 0 {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\n// Append a directive to the directives stack.\nfunc yaml_emitter_append_tag_directive(emitter *yaml_emitter_t, value *yaml_tag_directive_t, allow_duplicates bool) bool {\n\tfor i := 0; i < len(emitter.tag_directives); i++ {\n\t\tif bytes.Equal(value.handle, emitter.tag_directives[i].handle) {\n\t\t\tif allow_duplicates {\n\t\t\t\treturn true\n\t\t\t}\n\t\t\treturn yaml_emitter_set_emitter_error(emitter, \"duplicate %TAG directive\")\n\t\t}\n\t}\n\n\t// [Go] Do we actually need to copy this given garbage collection\n\t// and the lack of deallocating destructors?\n\ttag_copy := yaml_tag_directive_t{\n\t\thandle: make([]byte, len(value.handle)),\n\t\tprefix: make([]byte, len(value.prefix)),\n\t}\n\tcopy(tag_copy.handle, value.handle)\n\tcopy(tag_copy.prefix, value.prefix)\n\temitter.tag_directives = append(emitter.tag_directives, tag_copy)\n\treturn true\n}\n\n// Increase the indentation level.\nfunc yaml_emitter_increase_indent_compact(emitter *yaml_emitter_t, flow, indentless bool, compact_seq bool) bool {\n\temitter.indents = append(emitter.indents, emitter.indent)\n\tif emitter.indent < 0 {\n\t\tif flow {\n\t\t\temitter.indent = emitter.best_indent\n\t\t} else {\n\t\t\temitter.indent = 0\n\t\t}\n\t} else if !indentless {\n\t\t// [Go] This was changed so that indentations are more regular.\n\t\tif emitter.states[len(emitter.states)-1] == yaml_EMIT_BLOCK_SEQUENCE_ITEM_STATE {\n\t\t\t// The first indent inside a sequence will just skip the \"- \" indicator.\n\t\t\temitter.indent += 2\n\t\t} else {\n\t\t\t// Everything else aligns to the chosen indentation.\n\t\t\temitter.indent = emitter.best_indent * ((emitter.indent + emitter.best_indent) / emitter.best_indent)\n\t\t\tif compact_seq {\n\t\t\t\t// The value compact_seq passed in is almost always set to `false` when this function is called,\n\t\t\t\t// except when we are dealing with sequence nodes. So this gets triggered to subtract 2 only when we\n\t\t\t\t// are increasing the indent to account for sequence nodes, which will be correct because we need to\n\t\t\t\t// subtract 2 to account for the - at the beginning of the sequence node.\n\t\t\t\temitter.indent = emitter.indent - 2\n\t\t\t}\n\t\t}\n\t}\n\treturn true\n}\n\n// State dispatcher.\nfunc yaml_emitter_state_machine(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\tswitch emitter.state {\n\tdefault:\n\tcase yaml_EMIT_STREAM_START_STATE:\n\t\treturn yaml_emitter_emit_stream_start(emitter, event)\n\n\tcase yaml_EMIT_FIRST_DOCUMENT_START_STATE:\n\t\treturn yaml_emitter_emit_document_start(emitter, event, true)\n\n\tcase yaml_EMIT_DOCUMENT_START_STATE:\n\t\treturn yaml_emitter_emit_document_start(emitter, event, false)\n\n\tcase yaml_EMIT_DOCUMENT_CONTENT_STATE:\n\t\treturn yaml_emitter_emit_document_content(emitter, event)\n\n\tcase yaml_EMIT_DOCUMENT_END_STATE:\n\t\treturn yaml_emitter_emit_document_end(emitter, event)\n\n\tcase yaml_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE:\n\t\treturn yaml_emitter_emit_flow_sequence_item(emitter, event, true, false)\n\n\tcase yaml_EMIT_FLOW_SEQUENCE_TRAIL_ITEM_STATE:\n\t\treturn yaml_emitter_emit_flow_sequence_item(emitter, event, false, true)\n\n\tcase yaml_EMIT_FLOW_SEQUENCE_ITEM_STATE:\n\t\treturn yaml_emitter_emit_flow_sequence_item(emitter, event, false, false)\n\n\tcase yaml_EMIT_FLOW_MAPPING_FIRST_KEY_STATE:\n\t\treturn yaml_emitter_emit_flow_mapping_key(emitter, event, true, false)\n\n\tcase yaml_EMIT_FLOW_MAPPING_TRAIL_KEY_STATE:\n\t\treturn yaml_emitter_emit_flow_mapping_key(emitter, event, false, true)\n\n\tcase yaml_EMIT_FLOW_MAPPING_KEY_STATE:\n\t\treturn yaml_emitter_emit_flow_mapping_key(emitter, event, false, false)\n\n\tcase yaml_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE:\n\t\treturn yaml_emitter_emit_flow_mapping_value(emitter, event, true)\n\n\tcase yaml_EMIT_FLOW_MAPPING_VALUE_STATE:\n\t\treturn yaml_emitter_emit_flow_mapping_value(emitter, event, false)\n\n\tcase yaml_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE:\n\t\treturn yaml_emitter_emit_block_sequence_item(emitter, event, true)\n\n\tcase yaml_EMIT_BLOCK_SEQUENCE_ITEM_STATE:\n\t\treturn yaml_emitter_emit_block_sequence_item(emitter, event, false)\n\n\tcase yaml_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE:\n\t\treturn yaml_emitter_emit_block_mapping_key(emitter, event, true)\n\n\tcase yaml_EMIT_BLOCK_MAPPING_KEY_STATE:\n\t\treturn yaml_emitter_emit_block_mapping_key(emitter, event, false)\n\n\tcase yaml_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE:\n\t\treturn yaml_emitter_emit_block_mapping_value(emitter, event, true)\n\n\tcase yaml_EMIT_BLOCK_MAPPING_VALUE_STATE:\n\t\treturn yaml_emitter_emit_block_mapping_value(emitter, event, false)\n\n\tcase yaml_EMIT_END_STATE:\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"expected nothing after STREAM-END\")\n\t}\n\tpanic(\"invalid emitter state\")\n}\n\n// Expect STREAM-START.\nfunc yaml_emitter_emit_stream_start(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\tif event.typ != yaml_STREAM_START_EVENT {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"expected STREAM-START\")\n\t}\n\tif emitter.encoding == yaml_ANY_ENCODING {\n\t\temitter.encoding = event.encoding\n\t\tif emitter.encoding == yaml_ANY_ENCODING {\n\t\t\temitter.encoding = yaml_UTF8_ENCODING\n\t\t}\n\t}\n\tif emitter.best_indent < 2 || emitter.best_indent > 9 {\n\t\temitter.best_indent = 2\n\t}\n\tif emitter.best_width >= 0 && emitter.best_width <= emitter.best_indent*2 {\n\t\temitter.best_width = 80\n\t}\n\tif emitter.best_width < 0 {\n\t\temitter.best_width = 1<<31 - 1\n\t}\n\tif emitter.line_break == yaml_ANY_BREAK {\n\t\temitter.line_break = yaml_LN_BREAK\n\t}\n\n\temitter.indent = -1\n\temitter.line = 0\n\temitter.column = 0\n\temitter.whitespace = true\n\temitter.indention = true\n\temitter.space_above = true\n\temitter.foot_indent = -1\n\n\tif emitter.encoding != yaml_UTF8_ENCODING {\n\t\tif !yaml_emitter_write_bom(emitter) {\n\t\t\treturn false\n\t\t}\n\t}\n\temitter.state = yaml_EMIT_FIRST_DOCUMENT_START_STATE\n\treturn true\n}\n\n// Expect DOCUMENT-START or STREAM-END.\nfunc yaml_emitter_emit_document_start(emitter *yaml_emitter_t, event *yaml_event_t, first bool) bool {\n\n\tif event.typ == yaml_DOCUMENT_START_EVENT {\n\n\t\tif event.version_directive != nil {\n\t\t\tif !yaml_emitter_analyze_version_directive(emitter, event.version_directive) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\tfor i := 0; i < len(event.tag_directives); i++ {\n\t\t\ttag_directive := &event.tag_directives[i]\n\t\t\tif !yaml_emitter_analyze_tag_directive(emitter, tag_directive) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif !yaml_emitter_append_tag_directive(emitter, tag_directive, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\tfor i := 0; i < len(default_tag_directives); i++ {\n\t\t\ttag_directive := &default_tag_directives[i]\n\t\t\tif !yaml_emitter_append_tag_directive(emitter, tag_directive, true) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\timplicit := event.implicit\n\t\tif !first || emitter.canonical {\n\t\t\timplicit = false\n\t\t}\n\n\t\tif emitter.open_ended && (event.version_directive != nil || len(event.tag_directives) > 0) {\n\t\t\tif !yaml_emitter_write_indicator(emitter, []byte(\"...\"), true, false, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\tif event.version_directive != nil {\n\t\t\timplicit = false\n\t\t\tif !yaml_emitter_write_indicator(emitter, []byte(\"%YAML\"), true, false, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif !yaml_emitter_write_indicator(emitter, []byte(\"1.1\"), true, false, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\tif len(event.tag_directives) > 0 {\n\t\t\timplicit = false\n\t\t\tfor i := 0; i < len(event.tag_directives); i++ {\n\t\t\t\ttag_directive := &event.tag_directives[i]\n\t\t\t\tif !yaml_emitter_write_indicator(emitter, []byte(\"%TAG\"), true, false, false) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tif !yaml_emitter_write_tag_handle(emitter, tag_directive.handle) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tif !yaml_emitter_write_tag_content(emitter, tag_directive.prefix, true) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif yaml_emitter_check_empty_document(emitter) {\n\t\t\timplicit = false\n\t\t}\n\t\tif !implicit {\n\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif !yaml_emitter_write_indicator(emitter, []byte(\"---\"), true, false, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif emitter.canonical || true {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif len(emitter.head_comment) > 0 {\n\t\t\tif !yaml_emitter_process_head_comment(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif !put_break(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\temitter.state = yaml_EMIT_DOCUMENT_CONTENT_STATE\n\t\treturn true\n\t}\n\n\tif event.typ == yaml_STREAM_END_EVENT {\n\t\tif emitter.open_ended {\n\t\t\tif !yaml_emitter_write_indicator(emitter, []byte(\"...\"), true, false, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif !yaml_emitter_flush(emitter) {\n\t\t\treturn false\n\t\t}\n\t\temitter.state = yaml_EMIT_END_STATE\n\t\treturn true\n\t}\n\n\treturn yaml_emitter_set_emitter_error(emitter, \"expected DOCUMENT-START or STREAM-END\")\n}\n\n// yaml_emitter_increase_indent preserves the original signature and delegates to\n// yaml_emitter_increase_indent_compact without compact-sequence indentation\nfunc yaml_emitter_increase_indent(emitter *yaml_emitter_t, flow, indentless bool) bool {\n\treturn yaml_emitter_increase_indent_compact(emitter, flow, indentless, false)\n}\n\n// yaml_emitter_process_line_comment preserves the original signature and delegates to\n// yaml_emitter_process_line_comment_linebreak passing false for linebreak\nfunc yaml_emitter_process_line_comment(emitter *yaml_emitter_t) bool {\n\treturn yaml_emitter_process_line_comment_linebreak(emitter, false)\n}\n\n// Expect the root node.\nfunc yaml_emitter_emit_document_content(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\temitter.states = append(emitter.states, yaml_EMIT_DOCUMENT_END_STATE)\n\n\tif !yaml_emitter_process_head_comment(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_emit_node(emitter, event, true, false, false, false) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_line_comment(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_foot_comment(emitter) {\n\t\treturn false\n\t}\n\treturn true\n}\n\n// Expect DOCUMENT-END.\nfunc yaml_emitter_emit_document_end(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\tif event.typ != yaml_DOCUMENT_END_EVENT {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"expected DOCUMENT-END\")\n\t}\n\t// [Go] Force document foot separation.\n\temitter.foot_indent = 0\n\tif !yaml_emitter_process_foot_comment(emitter) {\n\t\treturn false\n\t}\n\temitter.foot_indent = -1\n\tif !yaml_emitter_write_indent(emitter) {\n\t\treturn false\n\t}\n\tif !event.implicit {\n\t\t// [Go] Allocate the slice elsewhere.\n\t\tif !yaml_emitter_write_indicator(emitter, []byte(\"...\"), true, false, false) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif !yaml_emitter_flush(emitter) {\n\t\treturn false\n\t}\n\temitter.state = yaml_EMIT_DOCUMENT_START_STATE\n\temitter.tag_directives = emitter.tag_directives[:0]\n\treturn true\n}\n\n// Expect a flow item node.\nfunc yaml_emitter_emit_flow_sequence_item(emitter *yaml_emitter_t, event *yaml_event_t, first, trail bool) bool {\n\tif first {\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{'['}, true, true, false) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_increase_indent(emitter, true, false) {\n\t\t\treturn false\n\t\t}\n\t\temitter.flow_level++\n\t}\n\n\tif event.typ == yaml_SEQUENCE_END_EVENT {\n\t\tif emitter.canonical && !first && !trail {\n\t\t\tif !yaml_emitter_write_indicator(emitter, []byte{','}, false, false, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\temitter.flow_level--\n\t\temitter.indent = emitter.indents[len(emitter.indents)-1]\n\t\temitter.indents = emitter.indents[:len(emitter.indents)-1]\n\t\tif emitter.column == 0 || emitter.canonical && !first {\n\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{']'}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_process_line_comment(emitter) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_process_foot_comment(emitter) {\n\t\t\treturn false\n\t\t}\n\t\temitter.state = emitter.states[len(emitter.states)-1]\n\t\temitter.states = emitter.states[:len(emitter.states)-1]\n\n\t\treturn true\n\t}\n\n\tif !first && !trail {\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{','}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tif !yaml_emitter_process_head_comment(emitter) {\n\t\treturn false\n\t}\n\tif emitter.column == 0 {\n\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tif emitter.canonical || emitter.column > emitter.best_width {\n\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif len(emitter.line_comment)+len(emitter.foot_comment)+len(emitter.tail_comment) > 0 {\n\t\temitter.states = append(emitter.states, yaml_EMIT_FLOW_SEQUENCE_TRAIL_ITEM_STATE)\n\t} else {\n\t\temitter.states = append(emitter.states, yaml_EMIT_FLOW_SEQUENCE_ITEM_STATE)\n\t}\n\tif !yaml_emitter_emit_node(emitter, event, false, true, false, false) {\n\t\treturn false\n\t}\n\tif len(emitter.line_comment)+len(emitter.foot_comment)+len(emitter.tail_comment) > 0 {\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{','}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif !yaml_emitter_process_line_comment(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_foot_comment(emitter) {\n\t\treturn false\n\t}\n\treturn true\n}\n\n// Expect a flow key node.\nfunc yaml_emitter_emit_flow_mapping_key(emitter *yaml_emitter_t, event *yaml_event_t, first, trail bool) bool {\n\tif first {\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{'{'}, true, true, false) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_increase_indent(emitter, true, false) {\n\t\t\treturn false\n\t\t}\n\t\temitter.flow_level++\n\t}\n\n\tif event.typ == yaml_MAPPING_END_EVENT {\n\t\tif (emitter.canonical || len(emitter.head_comment)+len(emitter.foot_comment)+len(emitter.tail_comment) > 0) && !first && !trail {\n\t\t\tif !yaml_emitter_write_indicator(emitter, []byte{','}, false, false, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif !yaml_emitter_process_head_comment(emitter) {\n\t\t\treturn false\n\t\t}\n\t\temitter.flow_level--\n\t\temitter.indent = emitter.indents[len(emitter.indents)-1]\n\t\temitter.indents = emitter.indents[:len(emitter.indents)-1]\n\t\tif emitter.canonical && !first {\n\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{'}'}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_process_line_comment(emitter) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_process_foot_comment(emitter) {\n\t\t\treturn false\n\t\t}\n\t\temitter.state = emitter.states[len(emitter.states)-1]\n\t\temitter.states = emitter.states[:len(emitter.states)-1]\n\t\treturn true\n\t}\n\n\tif !first && !trail {\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{','}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tif !yaml_emitter_process_head_comment(emitter) {\n\t\treturn false\n\t}\n\n\tif emitter.column == 0 {\n\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tif emitter.canonical || emitter.column > emitter.best_width {\n\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tif !emitter.canonical && yaml_emitter_check_simple_key(emitter) {\n\t\temitter.states = append(emitter.states, yaml_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE)\n\t\treturn yaml_emitter_emit_node(emitter, event, false, false, true, true)\n\t}\n\tif !yaml_emitter_write_indicator(emitter, []byte{'?'}, true, false, false) {\n\t\treturn false\n\t}\n\temitter.states = append(emitter.states, yaml_EMIT_FLOW_MAPPING_VALUE_STATE)\n\treturn yaml_emitter_emit_node(emitter, event, false, false, true, false)\n}\n\n// Expect a flow value node.\nfunc yaml_emitter_emit_flow_mapping_value(emitter *yaml_emitter_t, event *yaml_event_t, simple bool) bool {\n\tif simple {\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{':'}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t} else {\n\t\tif emitter.canonical || emitter.column > emitter.best_width {\n\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{':'}, true, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif len(emitter.line_comment)+len(emitter.foot_comment)+len(emitter.tail_comment) > 0 {\n\t\temitter.states = append(emitter.states, yaml_EMIT_FLOW_MAPPING_TRAIL_KEY_STATE)\n\t} else {\n\t\temitter.states = append(emitter.states, yaml_EMIT_FLOW_MAPPING_KEY_STATE)\n\t}\n\tif !yaml_emitter_emit_node(emitter, event, false, false, true, false) {\n\t\treturn false\n\t}\n\tif len(emitter.line_comment)+len(emitter.foot_comment)+len(emitter.tail_comment) > 0 {\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{','}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif !yaml_emitter_process_line_comment(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_foot_comment(emitter) {\n\t\treturn false\n\t}\n\treturn true\n}\n\n// Expect a block item node.\nfunc yaml_emitter_emit_block_sequence_item(emitter *yaml_emitter_t, event *yaml_event_t, first bool) bool {\n\tif first {\n\t\t// emitter.mapping context tells us if we are currently in a mapping context.\n\t\t// emiiter.column tells us which column we are in in the yaml output. 0 is the first char of the column.\n\t\t// emitter.indentation tells us if the last character was an indentation character.\n\t\t// emitter.compact_sequence_indent tells us if '- ' is considered part of the indentation for sequence elements.\n\t\t// So, `seq` means that we are in a mapping context, and we are either at the first char of the column or\n\t\t// the last character was not an indentation character, and we consider '- ' part of the indentation\n\t\t// for sequence elements.\n\t\tseq := emitter.mapping_context && (emitter.column == 0 || !emitter.indention) &&\n\t\t\temitter.compact_sequence_indent\n\t\tif !yaml_emitter_increase_indent_compact(emitter, false, false, seq) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif event.typ == yaml_SEQUENCE_END_EVENT {\n\t\temitter.indent = emitter.indents[len(emitter.indents)-1]\n\t\temitter.indents = emitter.indents[:len(emitter.indents)-1]\n\t\temitter.state = emitter.states[len(emitter.states)-1]\n\t\temitter.states = emitter.states[:len(emitter.states)-1]\n\t\treturn true\n\t}\n\tif !yaml_emitter_process_head_comment(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_write_indent(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_write_indicator(emitter, []byte{'-'}, true, false, true) {\n\t\treturn false\n\t}\n\temitter.states = append(emitter.states, yaml_EMIT_BLOCK_SEQUENCE_ITEM_STATE)\n\tif !yaml_emitter_emit_node(emitter, event, false, true, false, false) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_line_comment(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_foot_comment(emitter) {\n\t\treturn false\n\t}\n\treturn true\n}\n\n// Expect a block key node.\nfunc yaml_emitter_emit_block_mapping_key(emitter *yaml_emitter_t, event *yaml_event_t, first bool) bool {\n\tif first {\n\t\tif !yaml_emitter_increase_indent(emitter, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif !yaml_emitter_process_head_comment(emitter) {\n\t\treturn false\n\t}\n\tif event.typ == yaml_MAPPING_END_EVENT {\n\t\temitter.indent = emitter.indents[len(emitter.indents)-1]\n\t\temitter.indents = emitter.indents[:len(emitter.indents)-1]\n\t\temitter.state = emitter.states[len(emitter.states)-1]\n\t\temitter.states = emitter.states[:len(emitter.states)-1]\n\t\treturn true\n\t}\n\tif !yaml_emitter_write_indent(emitter) {\n\t\treturn false\n\t}\n\tif len(emitter.line_comment) > 0 {\n\t\t// [Go] A line comment was provided for the key. That's unusual as the\n\t\t// scanner associates line comments with the value. Either way,\n\t\t// save the line comment and render it appropriately later.\n\t\temitter.key_line_comment = emitter.line_comment\n\t\temitter.line_comment = nil\n\t}\n\tif yaml_emitter_check_simple_key(emitter) {\n\t\temitter.states = append(emitter.states, yaml_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE)\n\t\treturn yaml_emitter_emit_node(emitter, event, false, false, true, true)\n\t}\n\tif !yaml_emitter_write_indicator(emitter, []byte{'?'}, true, false, true) {\n\t\treturn false\n\t}\n\temitter.states = append(emitter.states, yaml_EMIT_BLOCK_MAPPING_VALUE_STATE)\n\treturn yaml_emitter_emit_node(emitter, event, false, false, true, false)\n}\n\n// Expect a block value node.\nfunc yaml_emitter_emit_block_mapping_value(emitter *yaml_emitter_t, event *yaml_event_t, simple bool) bool {\n\tif simple {\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{':'}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t} else {\n\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{':'}, true, false, true) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif len(emitter.key_line_comment) > 0 {\n\t\t// [Go] Line comments are generally associated with the value, but when there's\n\t\t// no value on the same line as a mapping key they end up attached to the\n\t\t// key itself.\n\t\tif event.typ == yaml_SCALAR_EVENT {\n\t\t\tif len(emitter.line_comment) == 0 {\n\t\t\t\t// A scalar is coming and it has no line comments by itself yet,\n\t\t\t\t// so just let it handle the line comment as usual. If it has a\n\t\t\t\t// line comment, we can't have both so the one from the key is lost.\n\t\t\t\temitter.line_comment = emitter.key_line_comment\n\t\t\t\temitter.key_line_comment = nil\n\t\t\t}\n\t\t} else if event.sequence_style() != yaml_FLOW_SEQUENCE_STYLE && (event.typ == yaml_MAPPING_START_EVENT || event.typ == yaml_SEQUENCE_START_EVENT) {\n\t\t\t// An indented block follows, so write the comment right now.\n\t\t\temitter.line_comment, emitter.key_line_comment = emitter.key_line_comment, emitter.line_comment\n\t\t\tif !yaml_emitter_process_line_comment(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\temitter.line_comment, emitter.key_line_comment = emitter.key_line_comment, emitter.line_comment\n\t\t}\n\t}\n\temitter.states = append(emitter.states, yaml_EMIT_BLOCK_MAPPING_KEY_STATE)\n\tif !yaml_emitter_emit_node(emitter, event, false, false, true, false) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_line_comment(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_foot_comment(emitter) {\n\t\treturn false\n\t}\n\treturn true\n}\n\nfunc yaml_emitter_silent_nil_event(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\treturn event.typ == yaml_SCALAR_EVENT && event.implicit && !emitter.canonical && len(emitter.scalar_data.value) == 0\n}\n\n// Expect a node.\nfunc yaml_emitter_emit_node(emitter *yaml_emitter_t, event *yaml_event_t,\n\troot bool, sequence bool, mapping bool, simple_key bool) bool {\n\n\temitter.root_context = root\n\temitter.sequence_context = sequence\n\temitter.mapping_context = mapping\n\temitter.simple_key_context = simple_key\n\n\tswitch event.typ {\n\tcase yaml_ALIAS_EVENT:\n\t\treturn yaml_emitter_emit_alias(emitter, event)\n\tcase yaml_SCALAR_EVENT:\n\t\treturn yaml_emitter_emit_scalar(emitter, event)\n\tcase yaml_SEQUENCE_START_EVENT:\n\t\treturn yaml_emitter_emit_sequence_start(emitter, event)\n\tcase yaml_MAPPING_START_EVENT:\n\t\treturn yaml_emitter_emit_mapping_start(emitter, event)\n\tdefault:\n\t\treturn yaml_emitter_set_emitter_error(emitter,\n\t\t\tfmt.Sprintf(\"expected SCALAR, SEQUENCE-START, MAPPING-START, or ALIAS, but got %v\", event.typ))\n\t}\n}\n\n// Expect ALIAS.\nfunc yaml_emitter_emit_alias(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\tif !yaml_emitter_process_anchor(emitter) {\n\t\treturn false\n\t}\n\temitter.state = emitter.states[len(emitter.states)-1]\n\temitter.states = emitter.states[:len(emitter.states)-1]\n\treturn true\n}\n\n// Expect SCALAR.\nfunc yaml_emitter_emit_scalar(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\tif !yaml_emitter_select_scalar_style(emitter, event) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_anchor(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_tag(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_increase_indent(emitter, true, false) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_scalar(emitter) {\n\t\treturn false\n\t}\n\temitter.indent = emitter.indents[len(emitter.indents)-1]\n\temitter.indents = emitter.indents[:len(emitter.indents)-1]\n\temitter.state = emitter.states[len(emitter.states)-1]\n\temitter.states = emitter.states[:len(emitter.states)-1]\n\treturn true\n}\n\n// Expect SEQUENCE-START.\nfunc yaml_emitter_emit_sequence_start(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\tif !yaml_emitter_process_anchor(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_tag(emitter) {\n\t\treturn false\n\t}\n\tif emitter.flow_level > 0 || emitter.canonical || event.sequence_style() == yaml_FLOW_SEQUENCE_STYLE ||\n\t\tyaml_emitter_check_empty_sequence(emitter) {\n\t\temitter.state = yaml_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE\n\t} else {\n\t\temitter.state = yaml_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE\n\t}\n\treturn true\n}\n\n// Expect MAPPING-START.\nfunc yaml_emitter_emit_mapping_start(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\tif !yaml_emitter_process_anchor(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_tag(emitter) {\n\t\treturn false\n\t}\n\tif emitter.flow_level > 0 || emitter.canonical || event.mapping_style() == yaml_FLOW_MAPPING_STYLE ||\n\t\tyaml_emitter_check_empty_mapping(emitter) {\n\t\temitter.state = yaml_EMIT_FLOW_MAPPING_FIRST_KEY_STATE\n\t} else {\n\t\temitter.state = yaml_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE\n\t}\n\treturn true\n}\n\n// Check if the document content is an empty scalar.\nfunc yaml_emitter_check_empty_document(emitter *yaml_emitter_t) bool {\n\treturn false // [Go] Huh?\n}\n\n// Check if the next events represent an empty sequence.\nfunc yaml_emitter_check_empty_sequence(emitter *yaml_emitter_t) bool {\n\tif len(emitter.events)-emitter.events_head < 2 {\n\t\treturn false\n\t}\n\treturn emitter.events[emitter.events_head].typ == yaml_SEQUENCE_START_EVENT &&\n\t\temitter.events[emitter.events_head+1].typ == yaml_SEQUENCE_END_EVENT\n}\n\n// Check if the next events represent an empty mapping.\nfunc yaml_emitter_check_empty_mapping(emitter *yaml_emitter_t) bool {\n\tif len(emitter.events)-emitter.events_head < 2 {\n\t\treturn false\n\t}\n\treturn emitter.events[emitter.events_head].typ == yaml_MAPPING_START_EVENT &&\n\t\temitter.events[emitter.events_head+1].typ == yaml_MAPPING_END_EVENT\n}\n\n// Check if the next node can be expressed as a simple key.\nfunc yaml_emitter_check_simple_key(emitter *yaml_emitter_t) bool {\n\tlength := 0\n\tswitch emitter.events[emitter.events_head].typ {\n\tcase yaml_ALIAS_EVENT:\n\t\tlength += len(emitter.anchor_data.anchor)\n\tcase yaml_SCALAR_EVENT:\n\t\tif emitter.scalar_data.multiline {\n\t\t\treturn false\n\t\t}\n\t\tlength += len(emitter.anchor_data.anchor) +\n\t\t\tlen(emitter.tag_data.handle) +\n\t\t\tlen(emitter.tag_data.suffix) +\n\t\t\tlen(emitter.scalar_data.value)\n\tcase yaml_SEQUENCE_START_EVENT:\n\t\tif !yaml_emitter_check_empty_sequence(emitter) {\n\t\t\treturn false\n\t\t}\n\t\tlength += len(emitter.anchor_data.anchor) +\n\t\t\tlen(emitter.tag_data.handle) +\n\t\t\tlen(emitter.tag_data.suffix)\n\tcase yaml_MAPPING_START_EVENT:\n\t\tif !yaml_emitter_check_empty_mapping(emitter) {\n\t\t\treturn false\n\t\t}\n\t\tlength += len(emitter.anchor_data.anchor) +\n\t\t\tlen(emitter.tag_data.handle) +\n\t\t\tlen(emitter.tag_data.suffix)\n\tdefault:\n\t\treturn false\n\t}\n\treturn length <= 128\n}\n\n// Determine an acceptable scalar style.\nfunc yaml_emitter_select_scalar_style(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\n\tno_tag := len(emitter.tag_data.handle) == 0 && len(emitter.tag_data.suffix) == 0\n\tif no_tag && !event.implicit && !event.quoted_implicit {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"neither tag nor implicit flags are specified\")\n\t}\n\n\tstyle := event.scalar_style()\n\tif style == yaml_ANY_SCALAR_STYLE {\n\t\tstyle = yaml_PLAIN_SCALAR_STYLE\n\t}\n\tif emitter.canonical {\n\t\tstyle = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t}\n\tif emitter.simple_key_context && emitter.scalar_data.multiline {\n\t\tstyle = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t}\n\n\tif style == yaml_PLAIN_SCALAR_STYLE {\n\t\tif emitter.flow_level > 0 && !emitter.scalar_data.flow_plain_allowed ||\n\t\t\temitter.flow_level == 0 && !emitter.scalar_data.block_plain_allowed {\n\t\t\tstyle = yaml_SINGLE_QUOTED_SCALAR_STYLE\n\t\t}\n\t\tif len(emitter.scalar_data.value) == 0 && (emitter.flow_level > 0 || emitter.simple_key_context) {\n\t\t\tstyle = yaml_SINGLE_QUOTED_SCALAR_STYLE\n\t\t}\n\t\tif no_tag && !event.implicit {\n\t\t\tstyle = yaml_SINGLE_QUOTED_SCALAR_STYLE\n\t\t}\n\t}\n\tif style == yaml_SINGLE_QUOTED_SCALAR_STYLE {\n\t\tif !emitter.scalar_data.single_quoted_allowed {\n\t\t\tstyle = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t\t}\n\t}\n\tif style == yaml_LITERAL_SCALAR_STYLE || style == yaml_FOLDED_SCALAR_STYLE {\n\t\tif !emitter.scalar_data.block_allowed || emitter.flow_level > 0 || emitter.simple_key_context {\n\t\t\tstyle = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t\t}\n\t}\n\n\tif no_tag && !event.quoted_implicit && style != yaml_PLAIN_SCALAR_STYLE {\n\t\temitter.tag_data.handle = []byte{'!'}\n\t}\n\temitter.scalar_data.style = style\n\treturn true\n}\n\n// Write an anchor.\nfunc yaml_emitter_process_anchor(emitter *yaml_emitter_t) bool {\n\tif emitter.anchor_data.anchor == nil {\n\t\treturn true\n\t}\n\tc := []byte{'&'}\n\tif emitter.anchor_data.alias {\n\t\tc[0] = '*'\n\t}\n\tif !yaml_emitter_write_indicator(emitter, c, true, false, false) {\n\t\treturn false\n\t}\n\treturn yaml_emitter_write_anchor(emitter, emitter.anchor_data.anchor)\n}\n\n// Write a tag.\nfunc yaml_emitter_process_tag(emitter *yaml_emitter_t) bool {\n\tif len(emitter.tag_data.handle) == 0 && len(emitter.tag_data.suffix) == 0 {\n\t\treturn true\n\t}\n\tif len(emitter.tag_data.handle) > 0 {\n\t\tif !yaml_emitter_write_tag_handle(emitter, emitter.tag_data.handle) {\n\t\t\treturn false\n\t\t}\n\t\tif len(emitter.tag_data.suffix) > 0 {\n\t\t\tif !yaml_emitter_write_tag_content(emitter, emitter.tag_data.suffix, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// [Go] Allocate these slices elsewhere.\n\t\tif !yaml_emitter_write_indicator(emitter, []byte(\"!<\"), true, false, false) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_write_tag_content(emitter, emitter.tag_data.suffix, false) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_write_indicator(emitter, []byte{'>'}, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\n// Write a scalar.\nfunc yaml_emitter_process_scalar(emitter *yaml_emitter_t) bool {\n\tswitch emitter.scalar_data.style {\n\tcase yaml_PLAIN_SCALAR_STYLE:\n\t\treturn yaml_emitter_write_plain_scalar(emitter, emitter.scalar_data.value, !emitter.simple_key_context)\n\n\tcase yaml_SINGLE_QUOTED_SCALAR_STYLE:\n\t\treturn yaml_emitter_write_single_quoted_scalar(emitter, emitter.scalar_data.value, !emitter.simple_key_context)\n\n\tcase yaml_DOUBLE_QUOTED_SCALAR_STYLE:\n\t\treturn yaml_emitter_write_double_quoted_scalar(emitter, emitter.scalar_data.value, !emitter.simple_key_context)\n\n\tcase yaml_LITERAL_SCALAR_STYLE:\n\t\treturn yaml_emitter_write_literal_scalar(emitter, emitter.scalar_data.value)\n\n\tcase yaml_FOLDED_SCALAR_STYLE:\n\t\treturn yaml_emitter_write_folded_scalar(emitter, emitter.scalar_data.value)\n\t}\n\tpanic(\"unknown scalar style\")\n}\n\n// Write a head comment.\nfunc yaml_emitter_process_head_comment(emitter *yaml_emitter_t) bool {\n\tif len(emitter.tail_comment) > 0 {\n\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\treturn false\n\t\t}\n\t\tif !yaml_emitter_write_comment(emitter, emitter.tail_comment) {\n\t\t\treturn false\n\t\t}\n\t\temitter.tail_comment = emitter.tail_comment[:0]\n\t\temitter.foot_indent = emitter.indent\n\t\tif emitter.foot_indent < 0 {\n\t\t\temitter.foot_indent = 0\n\t\t}\n\t}\n\n\tif len(emitter.head_comment) == 0 {\n\t\treturn true\n\t}\n\tif !yaml_emitter_write_indent(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_write_comment(emitter, emitter.head_comment) {\n\t\treturn false\n\t}\n\temitter.head_comment = emitter.head_comment[:0]\n\treturn true\n}\n\n// Write an line comment.\nfunc yaml_emitter_process_line_comment_linebreak(emitter *yaml_emitter_t, linebreak bool) bool {\n\tif len(emitter.line_comment) == 0 {\n\t\t// The next 3 lines are needed to resolve an issue with leading newlines\n\t\t// See https://github.com/go-yaml/yaml/issues/755\n\t\t// When linebreak is set to true, put_break will be called and will add\n\t\t// the needed newline.\n\t\tif linebreak && !put_break(emitter) {\n\t\t\treturn false\n\t\t}\n\t\treturn true\n\t}\n\tif !emitter.whitespace {\n\t\tif !put(emitter, ' ') {\n\t\t\treturn false\n\t\t}\n\t}\n\tif !yaml_emitter_write_comment(emitter, emitter.line_comment) {\n\t\treturn false\n\t}\n\temitter.line_comment = emitter.line_comment[:0]\n\treturn true\n}\n\n// Write a foot comment.\nfunc yaml_emitter_process_foot_comment(emitter *yaml_emitter_t) bool {\n\tif len(emitter.foot_comment) == 0 {\n\t\treturn true\n\t}\n\tif !yaml_emitter_write_indent(emitter) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_write_comment(emitter, emitter.foot_comment) {\n\t\treturn false\n\t}\n\temitter.foot_comment = emitter.foot_comment[:0]\n\temitter.foot_indent = emitter.indent\n\tif emitter.foot_indent < 0 {\n\t\temitter.foot_indent = 0\n\t}\n\treturn true\n}\n\n// Check if a %YAML directive is valid.\nfunc yaml_emitter_analyze_version_directive(emitter *yaml_emitter_t, version_directive *yaml_version_directive_t) bool {\n\tif version_directive.major != 1 || version_directive.minor != 1 {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"incompatible %YAML directive\")\n\t}\n\treturn true\n}\n\n// Check if a %TAG directive is valid.\nfunc yaml_emitter_analyze_tag_directive(emitter *yaml_emitter_t, tag_directive *yaml_tag_directive_t) bool {\n\thandle := tag_directive.handle\n\tprefix := tag_directive.prefix\n\tif len(handle) == 0 {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"tag handle must not be empty\")\n\t}\n\tif handle[0] != '!' {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"tag handle must start with '!'\")\n\t}\n\tif handle[len(handle)-1] != '!' {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"tag handle must end with '!'\")\n\t}\n\tfor i := 1; i < len(handle)-1; i += width(handle[i]) {\n\t\tif !is_alpha(handle, i) {\n\t\t\treturn yaml_emitter_set_emitter_error(emitter, \"tag handle must contain alphanumerical characters only\")\n\t\t}\n\t}\n\tif len(prefix) == 0 {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"tag prefix must not be empty\")\n\t}\n\treturn true\n}\n\n// Check if an anchor is valid.\nfunc yaml_emitter_analyze_anchor(emitter *yaml_emitter_t, anchor []byte, alias bool) bool {\n\tif len(anchor) == 0 {\n\t\tproblem := \"anchor value must not be empty\"\n\t\tif alias {\n\t\t\tproblem = \"alias value must not be empty\"\n\t\t}\n\t\treturn yaml_emitter_set_emitter_error(emitter, problem)\n\t}\n\tfor i := 0; i < len(anchor); i += width(anchor[i]) {\n\t\tif !is_alpha(anchor, i) {\n\t\t\tproblem := \"anchor value must contain alphanumerical characters only\"\n\t\t\tif alias {\n\t\t\t\tproblem = \"alias value must contain alphanumerical characters only\"\n\t\t\t}\n\t\t\treturn yaml_emitter_set_emitter_error(emitter, problem)\n\t\t}\n\t}\n\temitter.anchor_data.anchor = anchor\n\temitter.anchor_data.alias = alias\n\treturn true\n}\n\n// Check if a tag is valid.\nfunc yaml_emitter_analyze_tag(emitter *yaml_emitter_t, tag []byte) bool {\n\tif len(tag) == 0 {\n\t\treturn yaml_emitter_set_emitter_error(emitter, \"tag value must not be empty\")\n\t}\n\tfor i := 0; i < len(emitter.tag_directives); i++ {\n\t\ttag_directive := &emitter.tag_directives[i]\n\t\tif bytes.HasPrefix(tag, tag_directive.prefix) {\n\t\t\temitter.tag_data.handle = tag_directive.handle\n\t\t\temitter.tag_data.suffix = tag[len(tag_directive.prefix):]\n\t\t\treturn true\n\t\t}\n\t}\n\temitter.tag_data.suffix = tag\n\treturn true\n}\n\n// Check if a scalar is valid.\nfunc yaml_emitter_analyze_scalar(emitter *yaml_emitter_t, value []byte) bool {\n\tvar (\n\t\tblock_indicators = false\n\t\tflow_indicators = false\n\t\tline_breaks = false\n\t\tspecial_characters = false\n\t\ttab_characters = false\n\n\t\tleading_space = false\n\t\tleading_break = false\n\t\ttrailing_space = false\n\t\ttrailing_break = false\n\t\tbreak_space = false\n\t\tspace_break = false\n\n\t\tpreceded_by_whitespace = false\n\t\tfollowed_by_whitespace = false\n\t\tprevious_space = false\n\t\tprevious_break = false\n\t)\n\n\temitter.scalar_data.value = value\n\n\tif len(value) == 0 {\n\t\temitter.scalar_data.multiline = false\n\t\temitter.scalar_data.flow_plain_allowed = false\n\t\temitter.scalar_data.block_plain_allowed = true\n\t\temitter.scalar_data.single_quoted_allowed = true\n\t\temitter.scalar_data.block_allowed = false\n\t\treturn true\n\t}\n\n\tif len(value) >= 3 && ((value[0] == '-' && value[1] == '-' && value[2] == '-') || (value[0] == '.' && value[1] == '.' && value[2] == '.')) {\n\t\tblock_indicators = true\n\t\tflow_indicators = true\n\t}\n\n\tpreceded_by_whitespace = true\n\tfor i, w := 0, 0; i < len(value); i += w {\n\t\tw = width(value[i])\n\t\tfollowed_by_whitespace = i+w >= len(value) || is_blank(value, i+w)\n\n\t\tif i == 0 {\n\t\t\tswitch value[i] {\n\t\t\tcase '#', ',', '[', ']', '{', '}', '&', '*', '!', '|', '>', '\\'', '\"', '%', '@', '`':\n\t\t\t\tflow_indicators = true\n\t\t\t\tblock_indicators = true\n\t\t\tcase '?', ':':\n\t\t\t\tflow_indicators = true\n\t\t\t\tif followed_by_whitespace {\n\t\t\t\t\tblock_indicators = true\n\t\t\t\t}\n\t\t\tcase '-':\n\t\t\t\tif followed_by_whitespace {\n\t\t\t\t\tflow_indicators = true\n\t\t\t\t\tblock_indicators = true\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tswitch value[i] {\n\t\t\tcase ',', '?', '[', ']', '{', '}':\n\t\t\t\tflow_indicators = true\n\t\t\tcase ':':\n\t\t\t\tflow_indicators = true\n\t\t\t\tif followed_by_whitespace {\n\t\t\t\t\tblock_indicators = true\n\t\t\t\t}\n\t\t\tcase '#':\n\t\t\t\tif preceded_by_whitespace {\n\t\t\t\t\tflow_indicators = true\n\t\t\t\t\tblock_indicators = true\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif value[i] == '\\t' {\n\t\t\ttab_characters = true\n\t\t} else if !is_printable(value, i) || !is_ascii(value, i) && !emitter.unicode {\n\t\t\tspecial_characters = true\n\t\t}\n\t\tif is_space(value, i) {\n\t\t\tif i == 0 {\n\t\t\t\tleading_space = true\n\t\t\t}\n\t\t\tif i+width(value[i]) == len(value) {\n\t\t\t\ttrailing_space = true\n\t\t\t}\n\t\t\tif previous_break {\n\t\t\t\tbreak_space = true\n\t\t\t}\n\t\t\tprevious_space = true\n\t\t\tprevious_break = false\n\t\t} else if is_break(value, i) {\n\t\t\tline_breaks = true\n\t\t\tif i == 0 {\n\t\t\t\tleading_break = true\n\t\t\t}\n\t\t\tif i+width(value[i]) == len(value) {\n\t\t\t\ttrailing_break = true\n\t\t\t}\n\t\t\tif previous_space {\n\t\t\t\tspace_break = true\n\t\t\t}\n\t\t\tprevious_space = false\n\t\t\tprevious_break = true\n\t\t} else {\n\t\t\tprevious_space = false\n\t\t\tprevious_break = false\n\t\t}\n\n\t\t// [Go]: Why 'z'? Couldn't be the end of the string as that's the loop condition.\n\t\tpreceded_by_whitespace = is_blankz(value, i)\n\t}\n\n\temitter.scalar_data.multiline = line_breaks\n\temitter.scalar_data.flow_plain_allowed = true\n\temitter.scalar_data.block_plain_allowed = true\n\temitter.scalar_data.single_quoted_allowed = true\n\temitter.scalar_data.block_allowed = true\n\n\tif leading_space || leading_break || trailing_space || trailing_break {\n\t\temitter.scalar_data.flow_plain_allowed = false\n\t\temitter.scalar_data.block_plain_allowed = false\n\t}\n\tif trailing_space {\n\t\temitter.scalar_data.block_allowed = false\n\t}\n\tif break_space {\n\t\temitter.scalar_data.flow_plain_allowed = false\n\t\temitter.scalar_data.block_plain_allowed = false\n\t\temitter.scalar_data.single_quoted_allowed = false\n\t}\n\tif space_break || tab_characters || special_characters {\n\t\temitter.scalar_data.flow_plain_allowed = false\n\t\temitter.scalar_data.block_plain_allowed = false\n\t\temitter.scalar_data.single_quoted_allowed = false\n\t}\n\tif space_break || special_characters {\n\t\temitter.scalar_data.block_allowed = false\n\t}\n\tif line_breaks {\n\t\temitter.scalar_data.flow_plain_allowed = false\n\t\temitter.scalar_data.block_plain_allowed = false\n\t}\n\tif flow_indicators {\n\t\temitter.scalar_data.flow_plain_allowed = false\n\t}\n\tif block_indicators {\n\t\temitter.scalar_data.block_plain_allowed = false\n\t}\n\treturn true\n}\n\n// Check if the event data is valid.\nfunc yaml_emitter_analyze_event(emitter *yaml_emitter_t, event *yaml_event_t) bool {\n\n\temitter.anchor_data.anchor = nil\n\temitter.tag_data.handle = nil\n\temitter.tag_data.suffix = nil\n\temitter.scalar_data.value = nil\n\n\tif len(event.head_comment) > 0 {\n\t\temitter.head_comment = event.head_comment\n\t}\n\tif len(event.line_comment) > 0 {\n\t\temitter.line_comment = event.line_comment\n\t}\n\tif len(event.foot_comment) > 0 {\n\t\temitter.foot_comment = event.foot_comment\n\t}\n\tif len(event.tail_comment) > 0 {\n\t\temitter.tail_comment = event.tail_comment\n\t}\n\n\tswitch event.typ {\n\tcase yaml_ALIAS_EVENT:\n\t\tif !yaml_emitter_analyze_anchor(emitter, event.anchor, true) {\n\t\t\treturn false\n\t\t}\n\n\tcase yaml_SCALAR_EVENT:\n\t\tif len(event.anchor) > 0 {\n\t\t\tif !yaml_emitter_analyze_anchor(emitter, event.anchor, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif len(event.tag) > 0 && (emitter.canonical || (!event.implicit && !event.quoted_implicit)) {\n\t\t\tif !yaml_emitter_analyze_tag(emitter, event.tag) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif !yaml_emitter_analyze_scalar(emitter, event.value) {\n\t\t\treturn false\n\t\t}\n\n\tcase yaml_SEQUENCE_START_EVENT:\n\t\tif len(event.anchor) > 0 {\n\t\t\tif !yaml_emitter_analyze_anchor(emitter, event.anchor, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif len(event.tag) > 0 && (emitter.canonical || !event.implicit) {\n\t\t\tif !yaml_emitter_analyze_tag(emitter, event.tag) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\tcase yaml_MAPPING_START_EVENT:\n\t\tif len(event.anchor) > 0 {\n\t\t\tif !yaml_emitter_analyze_anchor(emitter, event.anchor, false) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif len(event.tag) > 0 && (emitter.canonical || !event.implicit) {\n\t\t\tif !yaml_emitter_analyze_tag(emitter, event.tag) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t}\n\treturn true\n}\n\n// Write the BOM character.\nfunc yaml_emitter_write_bom(emitter *yaml_emitter_t) bool {\n\tif !flush(emitter) {\n\t\treturn false\n\t}\n\tpos := emitter.buffer_pos\n\temitter.buffer[pos+0] = '\\xEF'\n\temitter.buffer[pos+1] = '\\xBB'\n\temitter.buffer[pos+2] = '\\xBF'\n\temitter.buffer_pos += 3\n\treturn true\n}\n\nfunc yaml_emitter_write_indent(emitter *yaml_emitter_t) bool {\n\tindent := emitter.indent\n\tif indent < 0 {\n\t\tindent = 0\n\t}\n\tif !emitter.indention || emitter.column > indent || (emitter.column == indent && !emitter.whitespace) {\n\t\tif !put_break(emitter) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif emitter.foot_indent == indent {\n\t\tif !put_break(emitter) {\n\t\t\treturn false\n\t\t}\n\t}\n\tfor emitter.column < indent {\n\t\tif !put(emitter, ' ') {\n\t\t\treturn false\n\t\t}\n\t}\n\temitter.whitespace = true\n\t//emitter.indention = true\n\temitter.space_above = false\n\temitter.foot_indent = -1\n\treturn true\n}\n\nfunc yaml_emitter_write_indicator(emitter *yaml_emitter_t, indicator []byte, need_whitespace, is_whitespace, is_indention bool) bool {\n\tif need_whitespace && !emitter.whitespace {\n\t\tif !put(emitter, ' ') {\n\t\t\treturn false\n\t\t}\n\t}\n\tif !write_all(emitter, indicator) {\n\t\treturn false\n\t}\n\temitter.whitespace = is_whitespace\n\temitter.indention = (emitter.indention && is_indention)\n\temitter.open_ended = false\n\treturn true\n}\n\nfunc yaml_emitter_write_anchor(emitter *yaml_emitter_t, value []byte) bool {\n\tif !write_all(emitter, value) {\n\t\treturn false\n\t}\n\temitter.whitespace = false\n\temitter.indention = false\n\treturn true\n}\n\nfunc yaml_emitter_write_tag_handle(emitter *yaml_emitter_t, value []byte) bool {\n\tif !emitter.whitespace {\n\t\tif !put(emitter, ' ') {\n\t\t\treturn false\n\t\t}\n\t}\n\tif !write_all(emitter, value) {\n\t\treturn false\n\t}\n\temitter.whitespace = false\n\temitter.indention = false\n\treturn true\n}\n\nfunc yaml_emitter_write_tag_content(emitter *yaml_emitter_t, value []byte, need_whitespace bool) bool {\n\tif need_whitespace && !emitter.whitespace {\n\t\tif !put(emitter, ' ') {\n\t\t\treturn false\n\t\t}\n\t}\n\tfor i := 0; i < len(value); {\n\t\tvar must_write bool\n\t\tswitch value[i] {\n\t\tcase ';', '/', '?', ':', '@', '&', '=', '+', '$', ',', '_', '.', '~', '*', '\\'', '(', ')', '[', ']':\n\t\t\tmust_write = true\n\t\tdefault:\n\t\t\tmust_write = is_alpha(value, i)\n\t\t}\n\t\tif must_write {\n\t\t\tif !write(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t} else {\n\t\t\tw := width(value[i])\n\t\t\tfor k := 0; k < w; k++ {\n\t\t\t\toctet := value[i]\n\t\t\t\ti++\n\t\t\t\tif !put(emitter, '%') {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\n\t\t\t\tc := octet >> 4\n\t\t\t\tif c < 10 {\n\t\t\t\t\tc += '0'\n\t\t\t\t} else {\n\t\t\t\t\tc += 'A' - 10\n\t\t\t\t}\n\t\t\t\tif !put(emitter, c) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\n\t\t\t\tc = octet & 0x0f\n\t\t\t\tif c < 10 {\n\t\t\t\t\tc += '0'\n\t\t\t\t} else {\n\t\t\t\t\tc += 'A' - 10\n\t\t\t\t}\n\t\t\t\tif !put(emitter, c) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\temitter.whitespace = false\n\temitter.indention = false\n\treturn true\n}\n\nfunc yaml_emitter_write_plain_scalar(emitter *yaml_emitter_t, value []byte, allow_breaks bool) bool {\n\tif len(value) > 0 && !emitter.whitespace {\n\t\tif !put(emitter, ' ') {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tspaces := false\n\tbreaks := false\n\tfor i := 0; i < len(value); {\n\t\tif is_space(value, i) {\n\t\t\tif allow_breaks && !spaces && emitter.column > emitter.best_width && !is_space(value, i+1) {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\ti += width(value[i])\n\t\t\t} else {\n\t\t\t\tif !write(emitter, value, &i) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\tspaces = true\n\t\t} else if is_break(value, i) {\n\t\t\tif !breaks && value[i] == '\\n' {\n\t\t\t\tif !put_break(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !write_break(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\t//emitter.indention = true\n\t\t\tbreaks = true\n\t\t} else {\n\t\t\tif breaks {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !write(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\temitter.indention = false\n\t\t\tspaces = false\n\t\t\tbreaks = false\n\t\t}\n\t}\n\n\tif len(value) > 0 {\n\t\temitter.whitespace = false\n\t}\n\temitter.indention = false\n\tif emitter.root_context {\n\t\temitter.open_ended = true\n\t}\n\n\treturn true\n}\n\nfunc yaml_emitter_write_single_quoted_scalar(emitter *yaml_emitter_t, value []byte, allow_breaks bool) bool {\n\n\tif !yaml_emitter_write_indicator(emitter, []byte{'\\''}, true, false, false) {\n\t\treturn false\n\t}\n\n\tspaces := false\n\tbreaks := false\n\tfor i := 0; i < len(value); {\n\t\tif is_space(value, i) {\n\t\t\tif allow_breaks && !spaces && emitter.column > emitter.best_width && i > 0 && i < len(value)-1 && !is_space(value, i+1) {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\ti += width(value[i])\n\t\t\t} else {\n\t\t\t\tif !write(emitter, value, &i) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\tspaces = true\n\t\t} else if is_break(value, i) {\n\t\t\tif !breaks && value[i] == '\\n' {\n\t\t\t\tif !put_break(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !write_break(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\t//emitter.indention = true\n\t\t\tbreaks = true\n\t\t} else {\n\t\t\tif breaks {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\tif value[i] == '\\'' {\n\t\t\t\tif !put(emitter, '\\'') {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !write(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\temitter.indention = false\n\t\t\tspaces = false\n\t\t\tbreaks = false\n\t\t}\n\t}\n\tif !yaml_emitter_write_indicator(emitter, []byte{'\\''}, false, false, false) {\n\t\treturn false\n\t}\n\temitter.whitespace = false\n\temitter.indention = false\n\treturn true\n}\n\nfunc yaml_emitter_write_double_quoted_scalar(emitter *yaml_emitter_t, value []byte, allow_breaks bool) bool {\n\tspaces := false\n\tif !yaml_emitter_write_indicator(emitter, []byte{'\"'}, true, false, false) {\n\t\treturn false\n\t}\n\n\tfor i := 0; i < len(value); {\n\t\tif !is_printable(value, i) || (!emitter.unicode && !is_ascii(value, i)) ||\n\t\t\tis_bom(value, i) || is_break(value, i) ||\n\t\t\tvalue[i] == '\"' || value[i] == '\\\\' {\n\n\t\t\toctet := value[i]\n\n\t\t\tvar w int\n\t\t\tvar v rune\n\t\t\tswitch {\n\t\t\tcase octet&0x80 == 0x00:\n\t\t\t\tw, v = 1, rune(octet&0x7F)\n\t\t\tcase octet&0xE0 == 0xC0:\n\t\t\t\tw, v = 2, rune(octet&0x1F)\n\t\t\tcase octet&0xF0 == 0xE0:\n\t\t\t\tw, v = 3, rune(octet&0x0F)\n\t\t\tcase octet&0xF8 == 0xF0:\n\t\t\t\tw, v = 4, rune(octet&0x07)\n\t\t\t}\n\t\t\tfor k := 1; k < w; k++ {\n\t\t\t\toctet = value[i+k]\n\t\t\t\tv = (v << 6) + (rune(octet) & 0x3F)\n\t\t\t}\n\t\t\ti += w\n\n\t\t\tif !put(emitter, '\\\\') {\n\t\t\t\treturn false\n\t\t\t}\n\n\t\t\tvar ok bool\n\t\t\tswitch v {\n\t\t\tcase 0x00:\n\t\t\t\tok = put(emitter, '0')\n\t\t\tcase 0x07:\n\t\t\t\tok = put(emitter, 'a')\n\t\t\tcase 0x08:\n\t\t\t\tok = put(emitter, 'b')\n\t\t\tcase 0x09:\n\t\t\t\tok = put(emitter, 't')\n\t\t\tcase 0x0A:\n\t\t\t\tok = put(emitter, 'n')\n\t\t\tcase 0x0b:\n\t\t\t\tok = put(emitter, 'v')\n\t\t\tcase 0x0c:\n\t\t\t\tok = put(emitter, 'f')\n\t\t\tcase 0x0d:\n\t\t\t\tok = put(emitter, 'r')\n\t\t\tcase 0x1b:\n\t\t\t\tok = put(emitter, 'e')\n\t\t\tcase 0x22:\n\t\t\t\tok = put(emitter, '\"')\n\t\t\tcase 0x5c:\n\t\t\t\tok = put(emitter, '\\\\')\n\t\t\tcase 0x85:\n\t\t\t\tok = put(emitter, 'N')\n\t\t\tcase 0xA0:\n\t\t\t\tok = put(emitter, '_')\n\t\t\tcase 0x2028:\n\t\t\t\tok = put(emitter, 'L')\n\t\t\tcase 0x2029:\n\t\t\t\tok = put(emitter, 'P')\n\t\t\tdefault:\n\t\t\t\tif v <= 0xFF {\n\t\t\t\t\tok = put(emitter, 'x')\n\t\t\t\t\tw = 2\n\t\t\t\t} else if v <= 0xFFFF {\n\t\t\t\t\tok = put(emitter, 'u')\n\t\t\t\t\tw = 4\n\t\t\t\t} else {\n\t\t\t\t\tok = put(emitter, 'U')\n\t\t\t\t\tw = 8\n\t\t\t\t}\n\t\t\t\tfor k := (w - 1) * 4; ok && k >= 0; k -= 4 {\n\t\t\t\t\tdigit := byte((v >> uint(k)) & 0x0F)\n\t\t\t\t\tif digit < 10 {\n\t\t\t\t\t\tok = put(emitter, digit+'0')\n\t\t\t\t\t} else {\n\t\t\t\t\t\tok = put(emitter, digit+'A'-10)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !ok {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tspaces = false\n\t\t} else if is_space(value, i) {\n\t\t\tif allow_breaks && !spaces && emitter.column > emitter.best_width && i > 0 && i < len(value)-1 {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tif is_space(value, i+1) {\n\t\t\t\t\tif !put(emitter, '\\\\') {\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\ti += width(value[i])\n\t\t\t} else if !write(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tspaces = true\n\t\t} else {\n\t\t\tif !write(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tspaces = false\n\t\t}\n\t}\n\tif !yaml_emitter_write_indicator(emitter, []byte{'\"'}, false, false, false) {\n\t\treturn false\n\t}\n\temitter.whitespace = false\n\temitter.indention = false\n\treturn true\n}\n\nfunc yaml_emitter_write_block_scalar_hints(emitter *yaml_emitter_t, value []byte) bool {\n\tif is_space(value, 0) || is_break(value, 0) {\n\t\tindent_hint := []byte{'0' + byte(emitter.best_indent)}\n\t\tif !yaml_emitter_write_indicator(emitter, indent_hint, false, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\temitter.open_ended = false\n\n\tvar chomp_hint [1]byte\n\tif len(value) == 0 {\n\t\tchomp_hint[0] = '-'\n\t} else {\n\t\ti := len(value) - 1\n\t\tfor value[i]&0xC0 == 0x80 {\n\t\t\ti--\n\t\t}\n\t\tif !is_break(value, i) {\n\t\t\tchomp_hint[0] = '-'\n\t\t} else if i == 0 {\n\t\t\tchomp_hint[0] = '+'\n\t\t\temitter.open_ended = true\n\t\t} else {\n\t\t\ti--\n\t\t\tfor value[i]&0xC0 == 0x80 {\n\t\t\t\ti--\n\t\t\t}\n\t\t\tif is_break(value, i) {\n\t\t\t\tchomp_hint[0] = '+'\n\t\t\t\temitter.open_ended = true\n\t\t\t}\n\t\t}\n\t}\n\tif chomp_hint[0] != 0 {\n\t\tif !yaml_emitter_write_indicator(emitter, chomp_hint[:], false, false, false) {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\nfunc yaml_emitter_write_literal_scalar(emitter *yaml_emitter_t, value []byte) bool {\n\tif !yaml_emitter_write_indicator(emitter, []byte{'|'}, true, false, false) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_write_block_scalar_hints(emitter, value) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_line_comment_linebreak(emitter, true) {\n\t\treturn false\n\t}\n\t//emitter.indention = true\n\temitter.whitespace = true\n\tbreaks := true\n\tfor i := 0; i < len(value); {\n\t\tif is_break(value, i) {\n\t\t\tif !write_break(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\t//emitter.indention = true\n\t\t\tbreaks = true\n\t\t} else {\n\t\t\tif breaks {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !write(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\temitter.indention = false\n\t\t\tbreaks = false\n\t\t}\n\t}\n\n\treturn true\n}\n\nfunc yaml_emitter_write_folded_scalar(emitter *yaml_emitter_t, value []byte) bool {\n\tif !yaml_emitter_write_indicator(emitter, []byte{'>'}, true, false, false) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_write_block_scalar_hints(emitter, value) {\n\t\treturn false\n\t}\n\tif !yaml_emitter_process_line_comment_linebreak(emitter, true) {\n\t\treturn false\n\t}\n\n\t//emitter.indention = true\n\temitter.whitespace = true\n\n\tbreaks := true\n\tleading_spaces := true\n\tfor i := 0; i < len(value); {\n\t\tif is_break(value, i) {\n\t\t\tif !breaks && !leading_spaces && value[i] == '\\n' {\n\t\t\t\tk := 0\n\t\t\t\tfor is_break(value, k) {\n\t\t\t\t\tk += width(value[k])\n\t\t\t\t}\n\t\t\t\tif !is_blankz(value, k) {\n\t\t\t\t\tif !put_break(emitter) {\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !write_break(emitter, value, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\t//emitter.indention = true\n\t\t\tbreaks = true\n\t\t} else {\n\t\t\tif breaks {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tleading_spaces = is_blank(value, i)\n\t\t\t}\n\t\t\tif !breaks && is_space(value, i) && !is_space(value, i+1) && emitter.column > emitter.best_width {\n\t\t\t\tif !yaml_emitter_write_indent(emitter) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\ti += width(value[i])\n\t\t\t} else {\n\t\t\t\tif !write(emitter, value, &i) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t}\n\t\t\temitter.indention = false\n\t\t\tbreaks = false\n\t\t}\n\t}\n\treturn true\n}\n\nfunc yaml_emitter_write_comment(emitter *yaml_emitter_t, comment []byte) bool {\n\tbreaks := false\n\tpound := false\n\tfor i := 0; i < len(comment); {\n\t\tif is_break(comment, i) {\n\t\t\tif !write_break(emitter, comment, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\t//emitter.indention = true\n\t\t\tbreaks = true\n\t\t\tpound = false\n\t\t} else {\n\t\t\tif breaks && !yaml_emitter_write_indent(emitter) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif !pound {\n\t\t\t\tif comment[i] != '#' && (!put(emitter, '#') || !put(emitter, ' ')) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tpound = true\n\t\t\t}\n\t\t\tif !write(emitter, comment, &i) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\temitter.indention = false\n\t\t\tbreaks = false\n\t\t}\n\t}\n\tif !breaks && !put_break(emitter) {\n\t\treturn false\n\t}\n\n\temitter.whitespace = true\n\t//emitter.indention = true\n\treturn true\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/encode.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage yaml\n\nimport (\n\t\"encoding\"\n\t\"fmt\"\n\t\"io\"\n\t\"reflect\"\n\t\"regexp\"\n\t\"sort\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n\t\"unicode/utf8\"\n)\n\ntype encoder struct {\n\temitter yaml_emitter_t\n\tevent yaml_event_t\n\tout []byte\n\tflow bool\n\tindent int\n\tdoneInit bool\n}\n\nfunc newEncoder() *encoder {\n\te := &encoder{}\n\tyaml_emitter_initialize(&e.emitter)\n\tyaml_emitter_set_output_string(&e.emitter, &e.out)\n\tyaml_emitter_set_unicode(&e.emitter, true)\n\treturn e\n}\n\nfunc newEncoderWithWriter(w io.Writer) *encoder {\n\te := &encoder{}\n\tyaml_emitter_initialize(&e.emitter)\n\tyaml_emitter_set_output_writer(&e.emitter, w)\n\tyaml_emitter_set_unicode(&e.emitter, true)\n\treturn e\n}\n\nfunc (e *encoder) init() {\n\tif e.doneInit {\n\t\treturn\n\t}\n\tif e.indent == 0 {\n\t\te.indent = 4\n\t}\n\te.emitter.best_indent = e.indent\n\tyaml_stream_start_event_initialize(&e.event, yaml_UTF8_ENCODING)\n\te.emit()\n\te.doneInit = true\n}\n\nfunc (e *encoder) finish() {\n\te.emitter.open_ended = false\n\tyaml_stream_end_event_initialize(&e.event)\n\te.emit()\n}\n\nfunc (e *encoder) destroy() {\n\tyaml_emitter_delete(&e.emitter)\n}\n\nfunc (e *encoder) emit() {\n\t// This will internally delete the e.event value.\n\te.must(yaml_emitter_emit(&e.emitter, &e.event))\n}\n\nfunc (e *encoder) must(ok bool) {\n\tif !ok {\n\t\tmsg := e.emitter.problem\n\t\tif msg == \"\" {\n\t\t\tmsg = \"unknown problem generating YAML content\"\n\t\t}\n\t\tfailf(\"%s\", msg)\n\t}\n}\n\nfunc (e *encoder) marshalDoc(tag string, in reflect.Value) {\n\te.init()\n\tvar node *Node\n\tif in.IsValid() {\n\t\tnode, _ = in.Interface().(*Node)\n\t}\n\tif node != nil && node.Kind == DocumentNode {\n\t\te.nodev(in)\n\t} else {\n\t\tyaml_document_start_event_initialize(&e.event, nil, nil, true)\n\t\te.emit()\n\t\te.marshal(tag, in)\n\t\tyaml_document_end_event_initialize(&e.event, true)\n\t\te.emit()\n\t}\n}\n\nfunc (e *encoder) marshal(tag string, in reflect.Value) {\n\ttag = shortTag(tag)\n\tif !in.IsValid() || in.Kind() == reflect.Ptr && in.IsNil() {\n\t\te.nilv()\n\t\treturn\n\t}\n\tiface := in.Interface()\n\tswitch value := iface.(type) {\n\tcase *Node:\n\t\te.nodev(in)\n\t\treturn\n\tcase Node:\n\t\tif !in.CanAddr() {\n\t\t\tvar n = reflect.New(in.Type()).Elem()\n\t\t\tn.Set(in)\n\t\t\tin = n\n\t\t}\n\t\te.nodev(in.Addr())\n\t\treturn\n\tcase time.Time:\n\t\te.timev(tag, in)\n\t\treturn\n\tcase *time.Time:\n\t\te.timev(tag, in.Elem())\n\t\treturn\n\tcase time.Duration:\n\t\te.stringv(tag, reflect.ValueOf(value.String()))\n\t\treturn\n\tcase Marshaler:\n\t\tv, err := value.MarshalYAML()\n\t\tif err != nil {\n\t\t\tfail(err)\n\t\t}\n\t\tif v == nil {\n\t\t\te.nilv()\n\t\t\treturn\n\t\t}\n\t\te.marshal(tag, reflect.ValueOf(v))\n\t\treturn\n\tcase encoding.TextMarshaler:\n\t\ttext, err := value.MarshalText()\n\t\tif err != nil {\n\t\t\tfail(err)\n\t\t}\n\t\tin = reflect.ValueOf(string(text))\n\tcase nil:\n\t\te.nilv()\n\t\treturn\n\t}\n\tswitch in.Kind() {\n\tcase reflect.Interface:\n\t\te.marshal(tag, in.Elem())\n\tcase reflect.Map:\n\t\te.mapv(tag, in)\n\tcase reflect.Ptr:\n\t\te.marshal(tag, in.Elem())\n\tcase reflect.Struct:\n\t\te.structv(tag, in)\n\tcase reflect.Slice, reflect.Array:\n\t\te.slicev(tag, in)\n\tcase reflect.String:\n\t\te.stringv(tag, in)\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\te.intv(tag, in)\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\te.uintv(tag, in)\n\tcase reflect.Float32, reflect.Float64:\n\t\te.floatv(tag, in)\n\tcase reflect.Bool:\n\t\te.boolv(tag, in)\n\tdefault:\n\t\tpanic(\"cannot marshal type: \" + in.Type().String())\n\t}\n}\n\nfunc (e *encoder) mapv(tag string, in reflect.Value) {\n\te.mappingv(tag, func() {\n\t\tkeys := keyList(in.MapKeys())\n\t\tsort.Sort(keys)\n\t\tfor _, k := range keys {\n\t\t\te.marshal(\"\", k)\n\t\t\te.marshal(\"\", in.MapIndex(k))\n\t\t}\n\t})\n}\n\nfunc (e *encoder) fieldByIndex(v reflect.Value, index []int) (field reflect.Value) {\n\tfor _, num := range index {\n\t\tfor {\n\t\t\tif v.Kind() == reflect.Ptr {\n\t\t\t\tif v.IsNil() {\n\t\t\t\t\treturn reflect.Value{}\n\t\t\t\t}\n\t\t\t\tv = v.Elem()\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tbreak\n\t\t}\n\t\tv = v.Field(num)\n\t}\n\treturn v\n}\n\nfunc (e *encoder) structv(tag string, in reflect.Value) {\n\tsinfo, err := getStructInfo(in.Type())\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\te.mappingv(tag, func() {\n\t\tfor _, info := range sinfo.FieldsList {\n\t\t\tvar value reflect.Value\n\t\t\tif info.Inline == nil {\n\t\t\t\tvalue = in.Field(info.Num)\n\t\t\t} else {\n\t\t\t\tvalue = e.fieldByIndex(in, info.Inline)\n\t\t\t\tif !value.IsValid() {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t}\n\t\t\tif info.OmitEmpty && isZero(value) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\te.marshal(\"\", reflect.ValueOf(info.Key))\n\t\t\te.flow = info.Flow\n\t\t\te.marshal(\"\", value)\n\t\t}\n\t\tif sinfo.InlineMap >= 0 {\n\t\t\tm := in.Field(sinfo.InlineMap)\n\t\t\tif m.Len() > 0 {\n\t\t\t\te.flow = false\n\t\t\t\tkeys := keyList(m.MapKeys())\n\t\t\t\tsort.Sort(keys)\n\t\t\t\tfor _, k := range keys {\n\t\t\t\t\tif _, found := sinfo.FieldsMap[k.String()]; found {\n\t\t\t\t\t\tpanic(fmt.Sprintf(\"cannot have key %q in inlined map: conflicts with struct field\", k.String()))\n\t\t\t\t\t}\n\t\t\t\t\te.marshal(\"\", k)\n\t\t\t\t\te.flow = false\n\t\t\t\t\te.marshal(\"\", m.MapIndex(k))\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t})\n}\n\nfunc (e *encoder) mappingv(tag string, f func()) {\n\timplicit := tag == \"\"\n\tstyle := yaml_BLOCK_MAPPING_STYLE\n\tif e.flow {\n\t\te.flow = false\n\t\tstyle = yaml_FLOW_MAPPING_STYLE\n\t}\n\tyaml_mapping_start_event_initialize(&e.event, nil, []byte(tag), implicit, style)\n\te.emit()\n\tf()\n\tyaml_mapping_end_event_initialize(&e.event)\n\te.emit()\n}\n\nfunc (e *encoder) slicev(tag string, in reflect.Value) {\n\timplicit := tag == \"\"\n\tstyle := yaml_BLOCK_SEQUENCE_STYLE\n\tif e.flow {\n\t\te.flow = false\n\t\tstyle = yaml_FLOW_SEQUENCE_STYLE\n\t}\n\te.must(yaml_sequence_start_event_initialize(&e.event, nil, []byte(tag), implicit, style))\n\te.emit()\n\tn := in.Len()\n\tfor i := 0; i < n; i++ {\n\t\te.marshal(\"\", in.Index(i))\n\t}\n\te.must(yaml_sequence_end_event_initialize(&e.event))\n\te.emit()\n}\n\n// isBase60 returns whether s is in base 60 notation as defined in YAML 1.1.\n//\n// The base 60 float notation in YAML 1.1 is a terrible idea and is unsupported\n// in YAML 1.2 and by this package, but these should be marshalled quoted for\n// the time being for compatibility with other parsers.\nfunc isBase60Float(s string) (result bool) {\n\t// Fast path.\n\tif s == \"\" {\n\t\treturn false\n\t}\n\tc := s[0]\n\tif !(c == '+' || c == '-' || c >= '0' && c <= '9') || strings.IndexByte(s, ':') < 0 {\n\t\treturn false\n\t}\n\t// Do the full match.\n\treturn base60float.MatchString(s)\n}\n\n// From http://yaml.org/type/float.html, except the regular expression there\n// is bogus. In practice parsers do not enforce the \"\\.[0-9_]*\" suffix.\nvar base60float = regexp.MustCompile(`^[-+]?[0-9][0-9_]*(?::[0-5]?[0-9])+(?:\\.[0-9_]*)?$`)\n\n// isOldBool returns whether s is bool notation as defined in YAML 1.1.\n//\n// We continue to force strings that YAML 1.1 would interpret as booleans to be\n// rendered as quotes strings so that the marshalled output valid for YAML 1.1\n// parsing.\nfunc isOldBool(s string) (result bool) {\n\tswitch s {\n\tcase \"y\", \"Y\", \"yes\", \"Yes\", \"YES\", \"on\", \"On\", \"ON\",\n\t\t\"n\", \"N\", \"no\", \"No\", \"NO\", \"off\", \"Off\", \"OFF\":\n\t\treturn true\n\tdefault:\n\t\treturn false\n\t}\n}\n\nfunc (e *encoder) stringv(tag string, in reflect.Value) {\n\tvar style yaml_scalar_style_t\n\ts := in.String()\n\tcanUsePlain := true\n\tswitch {\n\tcase !utf8.ValidString(s):\n\t\tif tag == binaryTag {\n\t\t\tfailf(\"explicitly tagged !!binary data must be base64-encoded\")\n\t\t}\n\t\tif tag != \"\" {\n\t\t\tfailf(\"cannot marshal invalid UTF-8 data as %s\", shortTag(tag))\n\t\t}\n\t\t// It can't be encoded directly as YAML so use a binary tag\n\t\t// and encode it as base64.\n\t\ttag = binaryTag\n\t\ts = encodeBase64(s)\n\tcase tag == \"\":\n\t\t// Check to see if it would resolve to a specific\n\t\t// tag when encoded unquoted. If it doesn't,\n\t\t// there's no need to quote it.\n\t\trtag, _ := resolve(\"\", s)\n\t\tcanUsePlain = rtag == strTag && !(isBase60Float(s) || isOldBool(s))\n\t}\n\t// Note: it's possible for user code to emit invalid YAML\n\t// if they explicitly specify a tag and a string containing\n\t// text that's incompatible with that tag.\n\tswitch {\n\tcase strings.Contains(s, \"\\n\"):\n\t\tif e.flow {\n\t\t\tstyle = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t\t} else {\n\t\t\tstyle = yaml_LITERAL_SCALAR_STYLE\n\t\t}\n\tcase canUsePlain:\n\t\tstyle = yaml_PLAIN_SCALAR_STYLE\n\tdefault:\n\t\tstyle = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t}\n\te.emitScalar(s, \"\", tag, style, nil, nil, nil, nil)\n}\n\nfunc (e *encoder) boolv(tag string, in reflect.Value) {\n\tvar s string\n\tif in.Bool() {\n\t\ts = \"true\"\n\t} else {\n\t\ts = \"false\"\n\t}\n\te.emitScalar(s, \"\", tag, yaml_PLAIN_SCALAR_STYLE, nil, nil, nil, nil)\n}\n\nfunc (e *encoder) intv(tag string, in reflect.Value) {\n\ts := strconv.FormatInt(in.Int(), 10)\n\te.emitScalar(s, \"\", tag, yaml_PLAIN_SCALAR_STYLE, nil, nil, nil, nil)\n}\n\nfunc (e *encoder) uintv(tag string, in reflect.Value) {\n\ts := strconv.FormatUint(in.Uint(), 10)\n\te.emitScalar(s, \"\", tag, yaml_PLAIN_SCALAR_STYLE, nil, nil, nil, nil)\n}\n\nfunc (e *encoder) timev(tag string, in reflect.Value) {\n\tt := in.Interface().(time.Time)\n\ts := t.Format(time.RFC3339Nano)\n\te.emitScalar(s, \"\", tag, yaml_PLAIN_SCALAR_STYLE, nil, nil, nil, nil)\n}\n\nfunc (e *encoder) floatv(tag string, in reflect.Value) {\n\t// Issue #352: When formatting, use the precision of the underlying value\n\tprecision := 64\n\tif in.Kind() == reflect.Float32 {\n\t\tprecision = 32\n\t}\n\n\ts := strconv.FormatFloat(in.Float(), 'g', -1, precision)\n\tswitch s {\n\tcase \"+Inf\":\n\t\ts = \".inf\"\n\tcase \"-Inf\":\n\t\ts = \"-.inf\"\n\tcase \"NaN\":\n\t\ts = \".nan\"\n\t}\n\te.emitScalar(s, \"\", tag, yaml_PLAIN_SCALAR_STYLE, nil, nil, nil, nil)\n}\n\nfunc (e *encoder) nilv() {\n\te.emitScalar(\"null\", \"\", \"\", yaml_PLAIN_SCALAR_STYLE, nil, nil, nil, nil)\n}\n\nfunc (e *encoder) emitScalar(value, anchor, tag string, style yaml_scalar_style_t, head, line, foot, tail []byte) {\n\t// TODO Kill this function. Replace all initialize calls by their underlining Go literals.\n\timplicit := tag == \"\"\n\tif !implicit {\n\t\ttag = longTag(tag)\n\t}\n\te.must(yaml_scalar_event_initialize(&e.event, []byte(anchor), []byte(tag), []byte(value), implicit, implicit, style))\n\te.event.head_comment = head\n\te.event.line_comment = line\n\te.event.foot_comment = foot\n\te.event.tail_comment = tail\n\te.emit()\n}\n\nfunc (e *encoder) nodev(in reflect.Value) {\n\te.node(in.Interface().(*Node), \"\")\n}\n\nfunc (e *encoder) node(node *Node, tail string) {\n\t// Zero nodes behave as nil.\n\tif node.Kind == 0 && node.IsZero() {\n\t\te.nilv()\n\t\treturn\n\t}\n\n\t// If the tag was not explicitly requested, and dropping it won't change the\n\t// implicit tag of the value, don't include it in the presentation.\n\tvar tag = node.Tag\n\tvar stag = shortTag(tag)\n\tvar forceQuoting bool\n\tif tag != \"\" && node.Style&TaggedStyle == 0 {\n\t\tif node.Kind == ScalarNode {\n\t\t\tif stag == strTag && node.Style&(SingleQuotedStyle|DoubleQuotedStyle|LiteralStyle|FoldedStyle) != 0 {\n\t\t\t\ttag = \"\"\n\t\t\t} else {\n\t\t\t\trtag, _ := resolve(\"\", node.Value)\n\t\t\t\tif rtag == stag {\n\t\t\t\t\ttag = \"\"\n\t\t\t\t} else if stag == strTag {\n\t\t\t\t\ttag = \"\"\n\t\t\t\t\tforceQuoting = true\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tvar rtag string\n\t\t\tswitch node.Kind {\n\t\t\tcase MappingNode:\n\t\t\t\trtag = mapTag\n\t\t\tcase SequenceNode:\n\t\t\t\trtag = seqTag\n\t\t\t}\n\t\t\tif rtag == stag {\n\t\t\t\ttag = \"\"\n\t\t\t}\n\t\t}\n\t}\n\n\tswitch node.Kind {\n\tcase DocumentNode:\n\t\tyaml_document_start_event_initialize(&e.event, nil, nil, true)\n\t\te.event.head_comment = []byte(node.HeadComment)\n\t\te.emit()\n\t\tfor _, node := range node.Content {\n\t\t\te.node(node, \"\")\n\t\t}\n\t\tyaml_document_end_event_initialize(&e.event, true)\n\t\te.event.foot_comment = []byte(node.FootComment)\n\t\te.emit()\n\n\tcase SequenceNode:\n\t\tstyle := yaml_BLOCK_SEQUENCE_STYLE\n\t\tif node.Style&FlowStyle != 0 {\n\t\t\tstyle = yaml_FLOW_SEQUENCE_STYLE\n\t\t}\n\t\te.must(yaml_sequence_start_event_initialize(&e.event, []byte(node.Anchor), []byte(longTag(tag)), tag == \"\", style))\n\t\te.event.head_comment = []byte(node.HeadComment)\n\t\te.emit()\n\t\tfor _, node := range node.Content {\n\t\t\te.node(node, \"\")\n\t\t}\n\t\te.must(yaml_sequence_end_event_initialize(&e.event))\n\t\te.event.line_comment = []byte(node.LineComment)\n\t\te.event.foot_comment = []byte(node.FootComment)\n\t\te.emit()\n\n\tcase MappingNode:\n\t\tstyle := yaml_BLOCK_MAPPING_STYLE\n\t\tif node.Style&FlowStyle != 0 {\n\t\t\tstyle = yaml_FLOW_MAPPING_STYLE\n\t\t}\n\t\tyaml_mapping_start_event_initialize(&e.event, []byte(node.Anchor), []byte(longTag(tag)), tag == \"\", style)\n\t\te.event.tail_comment = []byte(tail)\n\t\te.event.head_comment = []byte(node.HeadComment)\n\t\te.emit()\n\n\t\t// The tail logic below moves the foot comment of prior keys to the following key,\n\t\t// since the value for each key may be a nested structure and the foot needs to be\n\t\t// processed only the entirety of the value is streamed. The last tail is processed\n\t\t// with the mapping end event.\n\t\tvar tail string\n\t\tfor i := 0; i+1 < len(node.Content); i += 2 {\n\t\t\tk := node.Content[i]\n\t\t\tfoot := k.FootComment\n\t\t\tif foot != \"\" {\n\t\t\t\tkopy := *k\n\t\t\t\tkopy.FootComment = \"\"\n\t\t\t\tk = &kopy\n\t\t\t}\n\t\t\te.node(k, tail)\n\t\t\ttail = foot\n\n\t\t\tv := node.Content[i+1]\n\t\t\te.node(v, \"\")\n\t\t}\n\n\t\tyaml_mapping_end_event_initialize(&e.event)\n\t\te.event.tail_comment = []byte(tail)\n\t\te.event.line_comment = []byte(node.LineComment)\n\t\te.event.foot_comment = []byte(node.FootComment)\n\t\te.emit()\n\n\tcase AliasNode:\n\t\tyaml_alias_event_initialize(&e.event, []byte(node.Value))\n\t\te.event.head_comment = []byte(node.HeadComment)\n\t\te.event.line_comment = []byte(node.LineComment)\n\t\te.event.foot_comment = []byte(node.FootComment)\n\t\te.emit()\n\n\tcase ScalarNode:\n\t\tvalue := node.Value\n\t\tif !utf8.ValidString(value) {\n\t\t\tif stag == binaryTag {\n\t\t\t\tfailf(\"explicitly tagged !!binary data must be base64-encoded\")\n\t\t\t}\n\t\t\tif stag != \"\" {\n\t\t\t\tfailf(\"cannot marshal invalid UTF-8 data as %s\", stag)\n\t\t\t}\n\t\t\t// It can't be encoded directly as YAML so use a binary tag\n\t\t\t// and encode it as base64.\n\t\t\ttag = binaryTag\n\t\t\tvalue = encodeBase64(value)\n\t\t}\n\n\t\tstyle := yaml_PLAIN_SCALAR_STYLE\n\t\tswitch {\n\t\tcase node.Style&DoubleQuotedStyle != 0:\n\t\t\tstyle = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t\tcase node.Style&SingleQuotedStyle != 0:\n\t\t\tstyle = yaml_SINGLE_QUOTED_SCALAR_STYLE\n\t\tcase node.Style&LiteralStyle != 0:\n\t\t\tstyle = yaml_LITERAL_SCALAR_STYLE\n\t\tcase node.Style&FoldedStyle != 0:\n\t\t\tstyle = yaml_FOLDED_SCALAR_STYLE\n\t\tcase strings.Contains(value, \"\\n\"):\n\t\t\tstyle = yaml_LITERAL_SCALAR_STYLE\n\t\tcase forceQuoting:\n\t\t\tstyle = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t\t}\n\n\t\te.emitScalar(value, node.Anchor, tag, style, []byte(node.HeadComment), []byte(node.LineComment), []byte(node.FootComment), []byte(tail))\n\tdefault:\n\t\tfailf(\"cannot encode node with unknown kind %d\", node.Kind)\n\t}\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/parserc.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n// Copyright (c) 2006-2010 Kirill Simonov\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy of\n// this software and associated documentation files (the \"Software\"), to deal in\n// the Software without restriction, including without limitation the rights to\n// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n// of the Software, and to permit persons to whom the Software is furnished to do\n// so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\npackage yaml\n\nimport (\n\t\"bytes\"\n)\n\n// The parser implements the following grammar:\n//\n// stream ::= STREAM-START implicit_document? explicit_document* STREAM-END\n// implicit_document ::= block_node DOCUMENT-END*\n// explicit_document ::= DIRECTIVE* DOCUMENT-START block_node? DOCUMENT-END*\n// block_node_or_indentless_sequence ::=\n// ALIAS\n// | properties (block_content | indentless_block_sequence)?\n// | block_content\n// | indentless_block_sequence\n// block_node ::= ALIAS\n// | properties block_content?\n// | block_content\n// flow_node ::= ALIAS\n// | properties flow_content?\n// | flow_content\n// properties ::= TAG ANCHOR? | ANCHOR TAG?\n// block_content ::= block_collection | flow_collection | SCALAR\n// flow_content ::= flow_collection | SCALAR\n// block_collection ::= block_sequence | block_mapping\n// flow_collection ::= flow_sequence | flow_mapping\n// block_sequence ::= BLOCK-SEQUENCE-START (BLOCK-ENTRY block_node?)* BLOCK-END\n// indentless_sequence ::= (BLOCK-ENTRY block_node?)+\n// block_mapping ::= BLOCK-MAPPING_START\n// ((KEY block_node_or_indentless_sequence?)?\n// (VALUE block_node_or_indentless_sequence?)?)*\n// BLOCK-END\n// flow_sequence ::= FLOW-SEQUENCE-START\n// (flow_sequence_entry FLOW-ENTRY)*\n// flow_sequence_entry?\n// FLOW-SEQUENCE-END\n// flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)?\n// flow_mapping ::= FLOW-MAPPING-START\n// (flow_mapping_entry FLOW-ENTRY)*\n// flow_mapping_entry?\n// FLOW-MAPPING-END\n// flow_mapping_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)?\n\n// Peek the next token in the token queue.\nfunc peek_token(parser *yaml_parser_t) *yaml_token_t {\n\tif parser.token_available || yaml_parser_fetch_more_tokens(parser) {\n\t\ttoken := &parser.tokens[parser.tokens_head]\n\t\tyaml_parser_unfold_comments(parser, token)\n\t\treturn token\n\t}\n\treturn nil\n}\n\n// yaml_parser_unfold_comments walks through the comments queue and joins all\n// comments behind the position of the provided token into the respective\n// top-level comment slices in the parser.\nfunc yaml_parser_unfold_comments(parser *yaml_parser_t, token *yaml_token_t) {\n\tfor parser.comments_head < len(parser.comments) && token.start_mark.index >= parser.comments[parser.comments_head].token_mark.index {\n\t\tcomment := &parser.comments[parser.comments_head]\n\t\tif len(comment.head) > 0 {\n\t\t\tif token.typ == yaml_BLOCK_END_TOKEN {\n\t\t\t\t// No heads on ends, so keep comment.head for a follow up token.\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tif len(parser.head_comment) > 0 {\n\t\t\t\tparser.head_comment = append(parser.head_comment, '\\n')\n\t\t\t}\n\t\t\tparser.head_comment = append(parser.head_comment, comment.head...)\n\t\t}\n\t\tif len(comment.foot) > 0 {\n\t\t\tif len(parser.foot_comment) > 0 {\n\t\t\t\tparser.foot_comment = append(parser.foot_comment, '\\n')\n\t\t\t}\n\t\t\tparser.foot_comment = append(parser.foot_comment, comment.foot...)\n\t\t}\n\t\tif len(comment.line) > 0 {\n\t\t\tif len(parser.line_comment) > 0 {\n\t\t\t\tparser.line_comment = append(parser.line_comment, '\\n')\n\t\t\t}\n\t\t\tparser.line_comment = append(parser.line_comment, comment.line...)\n\t\t}\n\t\t*comment = yaml_comment_t{}\n\t\tparser.comments_head++\n\t}\n}\n\n// Remove the next token from the queue (must be called after peek_token).\nfunc skip_token(parser *yaml_parser_t) {\n\tparser.token_available = false\n\tparser.tokens_parsed++\n\tparser.stream_end_produced = parser.tokens[parser.tokens_head].typ == yaml_STREAM_END_TOKEN\n\tparser.tokens_head++\n}\n\n// Get the next event.\nfunc yaml_parser_parse(parser *yaml_parser_t, event *yaml_event_t) bool {\n\t// Erase the event object.\n\t*event = yaml_event_t{}\n\n\t// No events after the end of the stream or error.\n\tif parser.stream_end_produced || parser.error != yaml_NO_ERROR || parser.state == yaml_PARSE_END_STATE {\n\t\treturn true\n\t}\n\n\t// Generate the next event.\n\treturn yaml_parser_state_machine(parser, event)\n}\n\n// Set parser error.\nfunc yaml_parser_set_parser_error(parser *yaml_parser_t, problem string, problem_mark yaml_mark_t) bool {\n\tparser.error = yaml_PARSER_ERROR\n\tparser.problem = problem\n\tparser.problem_mark = problem_mark\n\treturn false\n}\n\nfunc yaml_parser_set_parser_error_context(parser *yaml_parser_t, context string, context_mark yaml_mark_t, problem string, problem_mark yaml_mark_t) bool {\n\tparser.error = yaml_PARSER_ERROR\n\tparser.context = context\n\tparser.context_mark = context_mark\n\tparser.problem = problem\n\tparser.problem_mark = problem_mark\n\treturn false\n}\n\n// State dispatcher.\nfunc yaml_parser_state_machine(parser *yaml_parser_t, event *yaml_event_t) bool {\n\t//trace(\"yaml_parser_state_machine\", \"state:\", parser.state.String())\n\n\tswitch parser.state {\n\tcase yaml_PARSE_STREAM_START_STATE:\n\t\treturn yaml_parser_parse_stream_start(parser, event)\n\n\tcase yaml_PARSE_IMPLICIT_DOCUMENT_START_STATE:\n\t\treturn yaml_parser_parse_document_start(parser, event, true)\n\n\tcase yaml_PARSE_DOCUMENT_START_STATE:\n\t\treturn yaml_parser_parse_document_start(parser, event, false)\n\n\tcase yaml_PARSE_DOCUMENT_CONTENT_STATE:\n\t\treturn yaml_parser_parse_document_content(parser, event)\n\n\tcase yaml_PARSE_DOCUMENT_END_STATE:\n\t\treturn yaml_parser_parse_document_end(parser, event)\n\n\tcase yaml_PARSE_BLOCK_NODE_STATE:\n\t\treturn yaml_parser_parse_node(parser, event, true, false)\n\n\tcase yaml_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE:\n\t\treturn yaml_parser_parse_node(parser, event, true, true)\n\n\tcase yaml_PARSE_FLOW_NODE_STATE:\n\t\treturn yaml_parser_parse_node(parser, event, false, false)\n\n\tcase yaml_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE:\n\t\treturn yaml_parser_parse_block_sequence_entry(parser, event, true)\n\n\tcase yaml_PARSE_BLOCK_SEQUENCE_ENTRY_STATE:\n\t\treturn yaml_parser_parse_block_sequence_entry(parser, event, false)\n\n\tcase yaml_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE:\n\t\treturn yaml_parser_parse_indentless_sequence_entry(parser, event)\n\n\tcase yaml_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE:\n\t\treturn yaml_parser_parse_block_mapping_key(parser, event, true)\n\n\tcase yaml_PARSE_BLOCK_MAPPING_KEY_STATE:\n\t\treturn yaml_parser_parse_block_mapping_key(parser, event, false)\n\n\tcase yaml_PARSE_BLOCK_MAPPING_VALUE_STATE:\n\t\treturn yaml_parser_parse_block_mapping_value(parser, event)\n\n\tcase yaml_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE:\n\t\treturn yaml_parser_parse_flow_sequence_entry(parser, event, true)\n\n\tcase yaml_PARSE_FLOW_SEQUENCE_ENTRY_STATE:\n\t\treturn yaml_parser_parse_flow_sequence_entry(parser, event, false)\n\n\tcase yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE:\n\t\treturn yaml_parser_parse_flow_sequence_entry_mapping_key(parser, event)\n\n\tcase yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE:\n\t\treturn yaml_parser_parse_flow_sequence_entry_mapping_value(parser, event)\n\n\tcase yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE:\n\t\treturn yaml_parser_parse_flow_sequence_entry_mapping_end(parser, event)\n\n\tcase yaml_PARSE_FLOW_MAPPING_FIRST_KEY_STATE:\n\t\treturn yaml_parser_parse_flow_mapping_key(parser, event, true)\n\n\tcase yaml_PARSE_FLOW_MAPPING_KEY_STATE:\n\t\treturn yaml_parser_parse_flow_mapping_key(parser, event, false)\n\n\tcase yaml_PARSE_FLOW_MAPPING_VALUE_STATE:\n\t\treturn yaml_parser_parse_flow_mapping_value(parser, event, false)\n\n\tcase yaml_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE:\n\t\treturn yaml_parser_parse_flow_mapping_value(parser, event, true)\n\n\tdefault:\n\t\tpanic(\"invalid parser state\")\n\t}\n}\n\n// Parse the production:\n// stream ::= STREAM-START implicit_document? explicit_document* STREAM-END\n//\n//\t************\nfunc yaml_parser_parse_stream_start(parser *yaml_parser_t, event *yaml_event_t) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\tif token.typ != yaml_STREAM_START_TOKEN {\n\t\treturn yaml_parser_set_parser_error(parser, \"did not find expected \", token.start_mark)\n\t}\n\tparser.state = yaml_PARSE_IMPLICIT_DOCUMENT_START_STATE\n\t*event = yaml_event_t{\n\t\ttyp: yaml_STREAM_START_EVENT,\n\t\tstart_mark: token.start_mark,\n\t\tend_mark: token.end_mark,\n\t\tencoding: token.encoding,\n\t}\n\tskip_token(parser)\n\treturn true\n}\n\n// Parse the productions:\n// implicit_document ::= block_node DOCUMENT-END*\n//\n//\t*\n//\n// explicit_document ::= DIRECTIVE* DOCUMENT-START block_node? DOCUMENT-END*\n//\n//\t*************************\nfunc yaml_parser_parse_document_start(parser *yaml_parser_t, event *yaml_event_t, implicit bool) bool {\n\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\t// Parse extra document end indicators.\n\tif !implicit {\n\t\tfor token.typ == yaml_DOCUMENT_END_TOKEN {\n\t\t\tskip_token(parser)\n\t\t\ttoken = peek_token(parser)\n\t\t\tif token == nil {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t}\n\n\tif implicit && token.typ != yaml_VERSION_DIRECTIVE_TOKEN &&\n\t\ttoken.typ != yaml_TAG_DIRECTIVE_TOKEN &&\n\t\ttoken.typ != yaml_DOCUMENT_START_TOKEN &&\n\t\ttoken.typ != yaml_STREAM_END_TOKEN {\n\t\t// Parse an implicit document.\n\t\tif !yaml_parser_process_directives(parser, nil, nil) {\n\t\t\treturn false\n\t\t}\n\t\tparser.states = append(parser.states, yaml_PARSE_DOCUMENT_END_STATE)\n\t\tparser.state = yaml_PARSE_BLOCK_NODE_STATE\n\n\t\tvar head_comment []byte\n\t\tif len(parser.head_comment) > 0 {\n\t\t\t// [Go] Scan the header comment backwards, and if an empty line is found, break\n\t\t\t// the header so the part before the last empty line goes into the\n\t\t\t// document header, while the bottom of it goes into a follow up event.\n\t\t\tfor i := len(parser.head_comment) - 1; i > 0; i-- {\n\t\t\t\tif parser.head_comment[i] == '\\n' {\n\t\t\t\t\tif i == len(parser.head_comment)-1 {\n\t\t\t\t\t\thead_comment = parser.head_comment[:i]\n\t\t\t\t\t\tparser.head_comment = parser.head_comment[i+1:]\n\t\t\t\t\t\tbreak\n\t\t\t\t\t} else if parser.head_comment[i-1] == '\\n' {\n\t\t\t\t\t\thead_comment = parser.head_comment[:i-1]\n\t\t\t\t\t\tparser.head_comment = parser.head_comment[i+1:]\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_DOCUMENT_START_EVENT,\n\t\t\tstart_mark: token.start_mark,\n\t\t\tend_mark: token.end_mark,\n\n\t\t\thead_comment: head_comment,\n\t\t}\n\n\t} else if token.typ != yaml_STREAM_END_TOKEN {\n\t\t// Parse an explicit document.\n\t\tvar version_directive *yaml_version_directive_t\n\t\tvar tag_directives []yaml_tag_directive_t\n\t\tstart_mark := token.start_mark\n\t\tif !yaml_parser_process_directives(parser, &version_directive, &tag_directives) {\n\t\t\treturn false\n\t\t}\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ != yaml_DOCUMENT_START_TOKEN {\n\t\t\tyaml_parser_set_parser_error(parser,\n\t\t\t\t\"did not find expected \", token.start_mark)\n\t\t\treturn false\n\t\t}\n\t\tparser.states = append(parser.states, yaml_PARSE_DOCUMENT_END_STATE)\n\t\tparser.state = yaml_PARSE_DOCUMENT_CONTENT_STATE\n\t\tend_mark := token.end_mark\n\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_DOCUMENT_START_EVENT,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tversion_directive: version_directive,\n\t\t\ttag_directives: tag_directives,\n\t\t\timplicit: false,\n\t\t}\n\t\tskip_token(parser)\n\n\t} else {\n\t\t// Parse the stream end.\n\t\tparser.state = yaml_PARSE_END_STATE\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_STREAM_END_EVENT,\n\t\t\tstart_mark: token.start_mark,\n\t\t\tend_mark: token.end_mark,\n\t\t}\n\t\tskip_token(parser)\n\t}\n\n\treturn true\n}\n\n// Parse the productions:\n// explicit_document ::= DIRECTIVE* DOCUMENT-START block_node? DOCUMENT-END*\n//\n//\t***********\nfunc yaml_parser_parse_document_content(parser *yaml_parser_t, event *yaml_event_t) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\tif token.typ == yaml_VERSION_DIRECTIVE_TOKEN ||\n\t\ttoken.typ == yaml_TAG_DIRECTIVE_TOKEN ||\n\t\ttoken.typ == yaml_DOCUMENT_START_TOKEN ||\n\t\ttoken.typ == yaml_DOCUMENT_END_TOKEN ||\n\t\ttoken.typ == yaml_STREAM_END_TOKEN {\n\t\tparser.state = parser.states[len(parser.states)-1]\n\t\tparser.states = parser.states[:len(parser.states)-1]\n\t\treturn yaml_parser_process_empty_scalar(parser, event,\n\t\t\ttoken.start_mark)\n\t}\n\treturn yaml_parser_parse_node(parser, event, true, false)\n}\n\n// Parse the productions:\n// implicit_document ::= block_node DOCUMENT-END*\n//\n//\t*************\n//\n// explicit_document ::= DIRECTIVE* DOCUMENT-START block_node? DOCUMENT-END*\nfunc yaml_parser_parse_document_end(parser *yaml_parser_t, event *yaml_event_t) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\tstart_mark := token.start_mark\n\tend_mark := token.start_mark\n\n\timplicit := true\n\tif token.typ == yaml_DOCUMENT_END_TOKEN {\n\t\tend_mark = token.end_mark\n\t\tskip_token(parser)\n\t\timplicit = false\n\t}\n\n\tparser.tag_directives = parser.tag_directives[:0]\n\n\tparser.state = yaml_PARSE_DOCUMENT_START_STATE\n\t*event = yaml_event_t{\n\t\ttyp: yaml_DOCUMENT_END_EVENT,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t\timplicit: implicit,\n\t}\n\tyaml_parser_set_event_comments(parser, event)\n\tif len(event.head_comment) > 0 && len(event.foot_comment) == 0 {\n\t\tevent.foot_comment = event.head_comment\n\t\tevent.head_comment = nil\n\t}\n\treturn true\n}\n\nfunc yaml_parser_set_event_comments(parser *yaml_parser_t, event *yaml_event_t) {\n\tevent.head_comment = parser.head_comment\n\tevent.line_comment = parser.line_comment\n\tevent.foot_comment = parser.foot_comment\n\tparser.head_comment = nil\n\tparser.line_comment = nil\n\tparser.foot_comment = nil\n\tparser.tail_comment = nil\n\tparser.stem_comment = nil\n}\n\n// Parse the productions:\n// block_node_or_indentless_sequence ::=\n//\n//\tALIAS\n//\t*****\n//\t| properties (block_content | indentless_block_sequence)?\n//\t ********** *\n//\t| block_content | indentless_block_sequence\n//\t *\n//\n// block_node ::= ALIAS\n//\n//\t*****\n//\t| properties block_content?\n//\t ********** *\n//\t| block_content\n//\t *\n//\n// flow_node ::= ALIAS\n//\n//\t*****\n//\t| properties flow_content?\n//\t ********** *\n//\t| flow_content\n//\t *\n//\n// properties ::= TAG ANCHOR? | ANCHOR TAG?\n//\n//\t*************************\n//\n// block_content ::= block_collection | flow_collection | SCALAR\n//\n//\t******\n//\n// flow_content ::= flow_collection | SCALAR\n//\n//\t******\nfunc yaml_parser_parse_node(parser *yaml_parser_t, event *yaml_event_t, block, indentless_sequence bool) bool {\n\t//defer trace(\"yaml_parser_parse_node\", \"block:\", block, \"indentless_sequence:\", indentless_sequence)()\n\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\tif token.typ == yaml_ALIAS_TOKEN {\n\t\tparser.state = parser.states[len(parser.states)-1]\n\t\tparser.states = parser.states[:len(parser.states)-1]\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_ALIAS_EVENT,\n\t\t\tstart_mark: token.start_mark,\n\t\t\tend_mark: token.end_mark,\n\t\t\tanchor: token.value,\n\t\t}\n\t\tyaml_parser_set_event_comments(parser, event)\n\t\tskip_token(parser)\n\t\treturn true\n\t}\n\n\tstart_mark := token.start_mark\n\tend_mark := token.start_mark\n\n\tvar tag_token bool\n\tvar tag_handle, tag_suffix, anchor []byte\n\tvar tag_mark yaml_mark_t\n\tif token.typ == yaml_ANCHOR_TOKEN {\n\t\tanchor = token.value\n\t\tstart_mark = token.start_mark\n\t\tend_mark = token.end_mark\n\t\tskip_token(parser)\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ == yaml_TAG_TOKEN {\n\t\t\ttag_token = true\n\t\t\ttag_handle = token.value\n\t\t\ttag_suffix = token.suffix\n\t\t\ttag_mark = token.start_mark\n\t\t\tend_mark = token.end_mark\n\t\t\tskip_token(parser)\n\t\t\ttoken = peek_token(parser)\n\t\t\tif token == nil {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t} else if token.typ == yaml_TAG_TOKEN {\n\t\ttag_token = true\n\t\ttag_handle = token.value\n\t\ttag_suffix = token.suffix\n\t\tstart_mark = token.start_mark\n\t\ttag_mark = token.start_mark\n\t\tend_mark = token.end_mark\n\t\tskip_token(parser)\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ == yaml_ANCHOR_TOKEN {\n\t\t\tanchor = token.value\n\t\t\tend_mark = token.end_mark\n\t\t\tskip_token(parser)\n\t\t\ttoken = peek_token(parser)\n\t\t\tif token == nil {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t}\n\n\tvar tag []byte\n\tif tag_token {\n\t\tif len(tag_handle) == 0 {\n\t\t\ttag = tag_suffix\n\t\t\ttag_suffix = nil\n\t\t} else {\n\t\t\tfor i := range parser.tag_directives {\n\t\t\t\tif bytes.Equal(parser.tag_directives[i].handle, tag_handle) {\n\t\t\t\t\ttag = append([]byte(nil), parser.tag_directives[i].prefix...)\n\t\t\t\t\ttag = append(tag, tag_suffix...)\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t\tif len(tag) == 0 {\n\t\t\t\tyaml_parser_set_parser_error_context(parser,\n\t\t\t\t\t\"while parsing a node\", start_mark,\n\t\t\t\t\t\"found undefined tag handle\", tag_mark)\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t}\n\n\timplicit := len(tag) == 0\n\tif indentless_sequence && token.typ == yaml_BLOCK_ENTRY_TOKEN {\n\t\tend_mark = token.end_mark\n\t\tparser.state = yaml_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_SEQUENCE_START_EVENT,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tanchor: anchor,\n\t\t\ttag: tag,\n\t\t\timplicit: implicit,\n\t\t\tstyle: yaml_style_t(yaml_BLOCK_SEQUENCE_STYLE),\n\t\t}\n\t\treturn true\n\t}\n\tif token.typ == yaml_SCALAR_TOKEN {\n\t\tvar plain_implicit, quoted_implicit bool\n\t\tend_mark = token.end_mark\n\t\tif (len(tag) == 0 && token.style == yaml_PLAIN_SCALAR_STYLE) || (len(tag) == 1 && tag[0] == '!') {\n\t\t\tplain_implicit = true\n\t\t} else if len(tag) == 0 {\n\t\t\tquoted_implicit = true\n\t\t}\n\t\tparser.state = parser.states[len(parser.states)-1]\n\t\tparser.states = parser.states[:len(parser.states)-1]\n\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_SCALAR_EVENT,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tanchor: anchor,\n\t\t\ttag: tag,\n\t\t\tvalue: token.value,\n\t\t\timplicit: plain_implicit,\n\t\t\tquoted_implicit: quoted_implicit,\n\t\t\tstyle: yaml_style_t(token.style),\n\t\t}\n\t\tyaml_parser_set_event_comments(parser, event)\n\t\tskip_token(parser)\n\t\treturn true\n\t}\n\tif token.typ == yaml_FLOW_SEQUENCE_START_TOKEN {\n\t\t// [Go] Some of the events below can be merged as they differ only on style.\n\t\tend_mark = token.end_mark\n\t\tparser.state = yaml_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_SEQUENCE_START_EVENT,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tanchor: anchor,\n\t\t\ttag: tag,\n\t\t\timplicit: implicit,\n\t\t\tstyle: yaml_style_t(yaml_FLOW_SEQUENCE_STYLE),\n\t\t}\n\t\tyaml_parser_set_event_comments(parser, event)\n\t\treturn true\n\t}\n\tif token.typ == yaml_FLOW_MAPPING_START_TOKEN {\n\t\tend_mark = token.end_mark\n\t\tparser.state = yaml_PARSE_FLOW_MAPPING_FIRST_KEY_STATE\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_MAPPING_START_EVENT,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tanchor: anchor,\n\t\t\ttag: tag,\n\t\t\timplicit: implicit,\n\t\t\tstyle: yaml_style_t(yaml_FLOW_MAPPING_STYLE),\n\t\t}\n\t\tyaml_parser_set_event_comments(parser, event)\n\t\treturn true\n\t}\n\tif block && token.typ == yaml_BLOCK_SEQUENCE_START_TOKEN {\n\t\tend_mark = token.end_mark\n\t\tparser.state = yaml_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_SEQUENCE_START_EVENT,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tanchor: anchor,\n\t\t\ttag: tag,\n\t\t\timplicit: implicit,\n\t\t\tstyle: yaml_style_t(yaml_BLOCK_SEQUENCE_STYLE),\n\t\t}\n\t\tif parser.stem_comment != nil {\n\t\t\tevent.head_comment = parser.stem_comment\n\t\t\tparser.stem_comment = nil\n\t\t}\n\t\treturn true\n\t}\n\tif block && token.typ == yaml_BLOCK_MAPPING_START_TOKEN {\n\t\tend_mark = token.end_mark\n\t\tparser.state = yaml_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_MAPPING_START_EVENT,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tanchor: anchor,\n\t\t\ttag: tag,\n\t\t\timplicit: implicit,\n\t\t\tstyle: yaml_style_t(yaml_BLOCK_MAPPING_STYLE),\n\t\t}\n\t\tif parser.stem_comment != nil {\n\t\t\tevent.head_comment = parser.stem_comment\n\t\t\tparser.stem_comment = nil\n\t\t}\n\t\treturn true\n\t}\n\tif len(anchor) > 0 || len(tag) > 0 {\n\t\tparser.state = parser.states[len(parser.states)-1]\n\t\tparser.states = parser.states[:len(parser.states)-1]\n\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_SCALAR_EVENT,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tanchor: anchor,\n\t\t\ttag: tag,\n\t\t\timplicit: implicit,\n\t\t\tquoted_implicit: false,\n\t\t\tstyle: yaml_style_t(yaml_PLAIN_SCALAR_STYLE),\n\t\t}\n\t\treturn true\n\t}\n\n\tcontext := \"while parsing a flow node\"\n\tif block {\n\t\tcontext = \"while parsing a block node\"\n\t}\n\tyaml_parser_set_parser_error_context(parser, context, start_mark,\n\t\t\"did not find expected node content\", token.start_mark)\n\treturn false\n}\n\n// Parse the productions:\n// block_sequence ::= BLOCK-SEQUENCE-START (BLOCK-ENTRY block_node?)* BLOCK-END\n//\n//\t******************** *********** * *********\nfunc yaml_parser_parse_block_sequence_entry(parser *yaml_parser_t, event *yaml_event_t, first bool) bool {\n\tif first {\n\t\ttoken := peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tparser.marks = append(parser.marks, token.start_mark)\n\t\tskip_token(parser)\n\t}\n\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\tif token.typ == yaml_BLOCK_ENTRY_TOKEN {\n\t\tmark := token.end_mark\n\t\tprior_head_len := len(parser.head_comment)\n\t\tskip_token(parser)\n\t\tyaml_parser_split_stem_comment(parser, prior_head_len)\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ != yaml_BLOCK_ENTRY_TOKEN && token.typ != yaml_BLOCK_END_TOKEN {\n\t\t\tparser.states = append(parser.states, yaml_PARSE_BLOCK_SEQUENCE_ENTRY_STATE)\n\t\t\treturn yaml_parser_parse_node(parser, event, true, false)\n\t\t} else {\n\t\t\tparser.state = yaml_PARSE_BLOCK_SEQUENCE_ENTRY_STATE\n\t\t\treturn yaml_parser_process_empty_scalar(parser, event, mark)\n\t\t}\n\t}\n\tif token.typ == yaml_BLOCK_END_TOKEN {\n\t\tparser.state = parser.states[len(parser.states)-1]\n\t\tparser.states = parser.states[:len(parser.states)-1]\n\t\tparser.marks = parser.marks[:len(parser.marks)-1]\n\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_SEQUENCE_END_EVENT,\n\t\t\tstart_mark: token.start_mark,\n\t\t\tend_mark: token.end_mark,\n\t\t}\n\n\t\tskip_token(parser)\n\t\treturn true\n\t}\n\n\tcontext_mark := parser.marks[len(parser.marks)-1]\n\tparser.marks = parser.marks[:len(parser.marks)-1]\n\treturn yaml_parser_set_parser_error_context(parser,\n\t\t\"while parsing a block collection\", context_mark,\n\t\t\"did not find expected '-' indicator\", token.start_mark)\n}\n\n// Parse the productions:\n// indentless_sequence ::= (BLOCK-ENTRY block_node?)+\n//\n//\t*********** *\nfunc yaml_parser_parse_indentless_sequence_entry(parser *yaml_parser_t, event *yaml_event_t) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\tif token.typ == yaml_BLOCK_ENTRY_TOKEN {\n\t\tmark := token.end_mark\n\t\tprior_head_len := len(parser.head_comment)\n\t\tskip_token(parser)\n\t\tyaml_parser_split_stem_comment(parser, prior_head_len)\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ != yaml_BLOCK_ENTRY_TOKEN &&\n\t\t\ttoken.typ != yaml_KEY_TOKEN &&\n\t\t\ttoken.typ != yaml_VALUE_TOKEN &&\n\t\t\ttoken.typ != yaml_BLOCK_END_TOKEN {\n\t\t\tparser.states = append(parser.states, yaml_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE)\n\t\t\treturn yaml_parser_parse_node(parser, event, true, false)\n\t\t}\n\t\tparser.state = yaml_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE\n\t\treturn yaml_parser_process_empty_scalar(parser, event, mark)\n\t}\n\tparser.state = parser.states[len(parser.states)-1]\n\tparser.states = parser.states[:len(parser.states)-1]\n\n\t*event = yaml_event_t{\n\t\ttyp: yaml_SEQUENCE_END_EVENT,\n\t\tstart_mark: token.start_mark,\n\t\tend_mark: token.start_mark, // [Go] Shouldn't this be token.end_mark?\n\t}\n\treturn true\n}\n\n// Split stem comment from head comment.\n//\n// When a sequence or map is found under a sequence entry, the former head comment\n// is assigned to the underlying sequence or map as a whole, not the individual\n// sequence or map entry as would be expected otherwise. To handle this case the\n// previous head comment is moved aside as the stem comment.\nfunc yaml_parser_split_stem_comment(parser *yaml_parser_t, stem_len int) {\n\tif stem_len == 0 {\n\t\treturn\n\t}\n\n\ttoken := peek_token(parser)\n\tif token == nil || token.typ != yaml_BLOCK_SEQUENCE_START_TOKEN && token.typ != yaml_BLOCK_MAPPING_START_TOKEN {\n\t\treturn\n\t}\n\n\tparser.stem_comment = parser.head_comment[:stem_len]\n\tif len(parser.head_comment) == stem_len {\n\t\tparser.head_comment = nil\n\t} else {\n\t\t// Copy suffix to prevent very strange bugs if someone ever appends\n\t\t// further bytes to the prefix in the stem_comment slice above.\n\t\tparser.head_comment = append([]byte(nil), parser.head_comment[stem_len+1:]...)\n\t}\n}\n\n// Parse the productions:\n// block_mapping ::= BLOCK-MAPPING_START\n//\n//\t*******************\n//\t((KEY block_node_or_indentless_sequence?)?\n//\t *** *\n//\t(VALUE block_node_or_indentless_sequence?)?)*\n//\n//\tBLOCK-END\n//\t*********\nfunc yaml_parser_parse_block_mapping_key(parser *yaml_parser_t, event *yaml_event_t, first bool) bool {\n\tif first {\n\t\ttoken := peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tparser.marks = append(parser.marks, token.start_mark)\n\t\tskip_token(parser)\n\t}\n\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\t// [Go] A tail comment was left from the prior mapping value processed. Emit an event\n\t// as it needs to be processed with that value and not the following key.\n\tif len(parser.tail_comment) > 0 {\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_TAIL_COMMENT_EVENT,\n\t\t\tstart_mark: token.start_mark,\n\t\t\tend_mark: token.end_mark,\n\t\t\tfoot_comment: parser.tail_comment,\n\t\t}\n\t\tparser.tail_comment = nil\n\t\treturn true\n\t}\n\n\tif token.typ == yaml_KEY_TOKEN {\n\t\tmark := token.end_mark\n\t\tskip_token(parser)\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ != yaml_KEY_TOKEN &&\n\t\t\ttoken.typ != yaml_VALUE_TOKEN &&\n\t\t\ttoken.typ != yaml_BLOCK_END_TOKEN {\n\t\t\tparser.states = append(parser.states, yaml_PARSE_BLOCK_MAPPING_VALUE_STATE)\n\t\t\treturn yaml_parser_parse_node(parser, event, true, true)\n\t\t} else {\n\t\t\tparser.state = yaml_PARSE_BLOCK_MAPPING_VALUE_STATE\n\t\t\treturn yaml_parser_process_empty_scalar(parser, event, mark)\n\t\t}\n\t} else if token.typ == yaml_BLOCK_END_TOKEN {\n\t\tparser.state = parser.states[len(parser.states)-1]\n\t\tparser.states = parser.states[:len(parser.states)-1]\n\t\tparser.marks = parser.marks[:len(parser.marks)-1]\n\t\t*event = yaml_event_t{\n\t\t\ttyp: yaml_MAPPING_END_EVENT,\n\t\t\tstart_mark: token.start_mark,\n\t\t\tend_mark: token.end_mark,\n\t\t}\n\t\tyaml_parser_set_event_comments(parser, event)\n\t\tskip_token(parser)\n\t\treturn true\n\t}\n\n\tcontext_mark := parser.marks[len(parser.marks)-1]\n\tparser.marks = parser.marks[:len(parser.marks)-1]\n\treturn yaml_parser_set_parser_error_context(parser,\n\t\t\"while parsing a block mapping\", context_mark,\n\t\t\"did not find expected key\", token.start_mark)\n}\n\n// Parse the productions:\n// block_mapping ::= BLOCK-MAPPING_START\n//\n//\t((KEY block_node_or_indentless_sequence?)?\n//\n//\t(VALUE block_node_or_indentless_sequence?)?)*\n//\t ***** *\n//\tBLOCK-END\nfunc yaml_parser_parse_block_mapping_value(parser *yaml_parser_t, event *yaml_event_t) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\tif token.typ == yaml_VALUE_TOKEN {\n\t\tmark := token.end_mark\n\t\tskip_token(parser)\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ != yaml_KEY_TOKEN &&\n\t\t\ttoken.typ != yaml_VALUE_TOKEN &&\n\t\t\ttoken.typ != yaml_BLOCK_END_TOKEN {\n\t\t\tparser.states = append(parser.states, yaml_PARSE_BLOCK_MAPPING_KEY_STATE)\n\t\t\treturn yaml_parser_parse_node(parser, event, true, true)\n\t\t}\n\t\tparser.state = yaml_PARSE_BLOCK_MAPPING_KEY_STATE\n\t\treturn yaml_parser_process_empty_scalar(parser, event, mark)\n\t}\n\tparser.state = yaml_PARSE_BLOCK_MAPPING_KEY_STATE\n\treturn yaml_parser_process_empty_scalar(parser, event, token.start_mark)\n}\n\n// Parse the productions:\n// flow_sequence ::= FLOW-SEQUENCE-START\n//\n//\t*******************\n//\t(flow_sequence_entry FLOW-ENTRY)*\n//\t * **********\n//\tflow_sequence_entry?\n//\t*\n//\tFLOW-SEQUENCE-END\n//\t*****************\n//\n// flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)?\n//\n//\t*\nfunc yaml_parser_parse_flow_sequence_entry(parser *yaml_parser_t, event *yaml_event_t, first bool) bool {\n\tif first {\n\t\ttoken := peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tparser.marks = append(parser.marks, token.start_mark)\n\t\tskip_token(parser)\n\t}\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\tif token.typ != yaml_FLOW_SEQUENCE_END_TOKEN {\n\t\tif !first {\n\t\t\tif token.typ == yaml_FLOW_ENTRY_TOKEN {\n\t\t\t\tskip_token(parser)\n\t\t\t\ttoken = peek_token(parser)\n\t\t\t\tif token == nil {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tcontext_mark := parser.marks[len(parser.marks)-1]\n\t\t\t\tparser.marks = parser.marks[:len(parser.marks)-1]\n\t\t\t\treturn yaml_parser_set_parser_error_context(parser,\n\t\t\t\t\t\"while parsing a flow sequence\", context_mark,\n\t\t\t\t\t\"did not find expected ',' or ']'\", token.start_mark)\n\t\t\t}\n\t\t}\n\n\t\tif token.typ == yaml_KEY_TOKEN {\n\t\t\tparser.state = yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE\n\t\t\t*event = yaml_event_t{\n\t\t\t\ttyp: yaml_MAPPING_START_EVENT,\n\t\t\t\tstart_mark: token.start_mark,\n\t\t\t\tend_mark: token.end_mark,\n\t\t\t\timplicit: true,\n\t\t\t\tstyle: yaml_style_t(yaml_FLOW_MAPPING_STYLE),\n\t\t\t}\n\t\t\tskip_token(parser)\n\t\t\treturn true\n\t\t} else if token.typ != yaml_FLOW_SEQUENCE_END_TOKEN {\n\t\t\tparser.states = append(parser.states, yaml_PARSE_FLOW_SEQUENCE_ENTRY_STATE)\n\t\t\treturn yaml_parser_parse_node(parser, event, false, false)\n\t\t}\n\t}\n\n\tparser.state = parser.states[len(parser.states)-1]\n\tparser.states = parser.states[:len(parser.states)-1]\n\tparser.marks = parser.marks[:len(parser.marks)-1]\n\n\t*event = yaml_event_t{\n\t\ttyp: yaml_SEQUENCE_END_EVENT,\n\t\tstart_mark: token.start_mark,\n\t\tend_mark: token.end_mark,\n\t}\n\tyaml_parser_set_event_comments(parser, event)\n\n\tskip_token(parser)\n\treturn true\n}\n\n// Parse the productions:\n// flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)?\n//\n//\t*** *\nfunc yaml_parser_parse_flow_sequence_entry_mapping_key(parser *yaml_parser_t, event *yaml_event_t) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\tif token.typ != yaml_VALUE_TOKEN &&\n\t\ttoken.typ != yaml_FLOW_ENTRY_TOKEN &&\n\t\ttoken.typ != yaml_FLOW_SEQUENCE_END_TOKEN {\n\t\tparser.states = append(parser.states, yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE)\n\t\treturn yaml_parser_parse_node(parser, event, false, false)\n\t}\n\tmark := token.end_mark\n\tskip_token(parser)\n\tparser.state = yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE\n\treturn yaml_parser_process_empty_scalar(parser, event, mark)\n}\n\n// Parse the productions:\n// flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)?\n//\n//\t***** *\nfunc yaml_parser_parse_flow_sequence_entry_mapping_value(parser *yaml_parser_t, event *yaml_event_t) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\tif token.typ == yaml_VALUE_TOKEN {\n\t\tskip_token(parser)\n\t\ttoken := peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ != yaml_FLOW_ENTRY_TOKEN && token.typ != yaml_FLOW_SEQUENCE_END_TOKEN {\n\t\t\tparser.states = append(parser.states, yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE)\n\t\t\treturn yaml_parser_parse_node(parser, event, false, false)\n\t\t}\n\t}\n\tparser.state = yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE\n\treturn yaml_parser_process_empty_scalar(parser, event, token.start_mark)\n}\n\n// Parse the productions:\n// flow_sequence_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)?\n//\n//\t*\nfunc yaml_parser_parse_flow_sequence_entry_mapping_end(parser *yaml_parser_t, event *yaml_event_t) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\tparser.state = yaml_PARSE_FLOW_SEQUENCE_ENTRY_STATE\n\t*event = yaml_event_t{\n\t\ttyp: yaml_MAPPING_END_EVENT,\n\t\tstart_mark: token.start_mark,\n\t\tend_mark: token.start_mark, // [Go] Shouldn't this be end_mark?\n\t}\n\treturn true\n}\n\n// Parse the productions:\n// flow_mapping ::= FLOW-MAPPING-START\n//\n//\t******************\n//\t(flow_mapping_entry FLOW-ENTRY)*\n//\t * **********\n//\tflow_mapping_entry?\n//\t******************\n//\tFLOW-MAPPING-END\n//\t****************\n//\n// flow_mapping_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)?\n// - *** *\nfunc yaml_parser_parse_flow_mapping_key(parser *yaml_parser_t, event *yaml_event_t, first bool) bool {\n\tif first {\n\t\ttoken := peek_token(parser)\n\t\tparser.marks = append(parser.marks, token.start_mark)\n\t\tskip_token(parser)\n\t}\n\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\tif token.typ != yaml_FLOW_MAPPING_END_TOKEN {\n\t\tif !first {\n\t\t\tif token.typ == yaml_FLOW_ENTRY_TOKEN {\n\t\t\t\tskip_token(parser)\n\t\t\t\ttoken = peek_token(parser)\n\t\t\t\tif token == nil {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tcontext_mark := parser.marks[len(parser.marks)-1]\n\t\t\t\tparser.marks = parser.marks[:len(parser.marks)-1]\n\t\t\t\treturn yaml_parser_set_parser_error_context(parser,\n\t\t\t\t\t\"while parsing a flow mapping\", context_mark,\n\t\t\t\t\t\"did not find expected ',' or '}'\", token.start_mark)\n\t\t\t}\n\t\t}\n\n\t\tif token.typ == yaml_KEY_TOKEN {\n\t\t\tskip_token(parser)\n\t\t\ttoken = peek_token(parser)\n\t\t\tif token == nil {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif token.typ != yaml_VALUE_TOKEN &&\n\t\t\t\ttoken.typ != yaml_FLOW_ENTRY_TOKEN &&\n\t\t\t\ttoken.typ != yaml_FLOW_MAPPING_END_TOKEN {\n\t\t\t\tparser.states = append(parser.states, yaml_PARSE_FLOW_MAPPING_VALUE_STATE)\n\t\t\t\treturn yaml_parser_parse_node(parser, event, false, false)\n\t\t\t} else {\n\t\t\t\tparser.state = yaml_PARSE_FLOW_MAPPING_VALUE_STATE\n\t\t\t\treturn yaml_parser_process_empty_scalar(parser, event, token.start_mark)\n\t\t\t}\n\t\t} else if token.typ != yaml_FLOW_MAPPING_END_TOKEN {\n\t\t\tparser.states = append(parser.states, yaml_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE)\n\t\t\treturn yaml_parser_parse_node(parser, event, false, false)\n\t\t}\n\t}\n\n\tparser.state = parser.states[len(parser.states)-1]\n\tparser.states = parser.states[:len(parser.states)-1]\n\tparser.marks = parser.marks[:len(parser.marks)-1]\n\t*event = yaml_event_t{\n\t\ttyp: yaml_MAPPING_END_EVENT,\n\t\tstart_mark: token.start_mark,\n\t\tend_mark: token.end_mark,\n\t}\n\tyaml_parser_set_event_comments(parser, event)\n\tskip_token(parser)\n\treturn true\n}\n\n// Parse the productions:\n// flow_mapping_entry ::= flow_node | KEY flow_node? (VALUE flow_node?)?\n// - ***** *\nfunc yaml_parser_parse_flow_mapping_value(parser *yaml_parser_t, event *yaml_event_t, empty bool) bool {\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\tif empty {\n\t\tparser.state = yaml_PARSE_FLOW_MAPPING_KEY_STATE\n\t\treturn yaml_parser_process_empty_scalar(parser, event, token.start_mark)\n\t}\n\tif token.typ == yaml_VALUE_TOKEN {\n\t\tskip_token(parser)\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t\tif token.typ != yaml_FLOW_ENTRY_TOKEN && token.typ != yaml_FLOW_MAPPING_END_TOKEN {\n\t\t\tparser.states = append(parser.states, yaml_PARSE_FLOW_MAPPING_KEY_STATE)\n\t\t\treturn yaml_parser_parse_node(parser, event, false, false)\n\t\t}\n\t}\n\tparser.state = yaml_PARSE_FLOW_MAPPING_KEY_STATE\n\treturn yaml_parser_process_empty_scalar(parser, event, token.start_mark)\n}\n\n// Generate an empty scalar event.\nfunc yaml_parser_process_empty_scalar(parser *yaml_parser_t, event *yaml_event_t, mark yaml_mark_t) bool {\n\t*event = yaml_event_t{\n\t\ttyp: yaml_SCALAR_EVENT,\n\t\tstart_mark: mark,\n\t\tend_mark: mark,\n\t\tvalue: nil, // Empty\n\t\timplicit: true,\n\t\tstyle: yaml_style_t(yaml_PLAIN_SCALAR_STYLE),\n\t}\n\treturn true\n}\n\nvar default_tag_directives = []yaml_tag_directive_t{\n\t{[]byte(\"!\"), []byte(\"!\")},\n\t{[]byte(\"!!\"), []byte(\"tag:yaml.org,2002:\")},\n}\n\n// Parse directives.\nfunc yaml_parser_process_directives(parser *yaml_parser_t,\n\tversion_directive_ref **yaml_version_directive_t,\n\ttag_directives_ref *[]yaml_tag_directive_t) bool {\n\n\tvar version_directive *yaml_version_directive_t\n\tvar tag_directives []yaml_tag_directive_t\n\n\ttoken := peek_token(parser)\n\tif token == nil {\n\t\treturn false\n\t}\n\n\tfor token.typ == yaml_VERSION_DIRECTIVE_TOKEN || token.typ == yaml_TAG_DIRECTIVE_TOKEN {\n\t\tif token.typ == yaml_VERSION_DIRECTIVE_TOKEN {\n\t\t\tif version_directive != nil {\n\t\t\t\tyaml_parser_set_parser_error(parser,\n\t\t\t\t\t\"found duplicate %YAML directive\", token.start_mark)\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif token.major != 1 || token.minor != 1 {\n\t\t\t\tyaml_parser_set_parser_error(parser,\n\t\t\t\t\t\"found incompatible YAML document\", token.start_mark)\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tversion_directive = &yaml_version_directive_t{\n\t\t\t\tmajor: token.major,\n\t\t\t\tminor: token.minor,\n\t\t\t}\n\t\t} else if token.typ == yaml_TAG_DIRECTIVE_TOKEN {\n\t\t\tvalue := yaml_tag_directive_t{\n\t\t\t\thandle: token.value,\n\t\t\t\tprefix: token.prefix,\n\t\t\t}\n\t\t\tif !yaml_parser_append_tag_directive(parser, value, false, token.start_mark) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\ttag_directives = append(tag_directives, value)\n\t\t}\n\n\t\tskip_token(parser)\n\t\ttoken = peek_token(parser)\n\t\tif token == nil {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tfor i := range default_tag_directives {\n\t\tif !yaml_parser_append_tag_directive(parser, default_tag_directives[i], true, token.start_mark) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tif version_directive_ref != nil {\n\t\t*version_directive_ref = version_directive\n\t}\n\tif tag_directives_ref != nil {\n\t\t*tag_directives_ref = tag_directives\n\t}\n\treturn true\n}\n\n// Append a tag directive to the directives stack.\nfunc yaml_parser_append_tag_directive(parser *yaml_parser_t, value yaml_tag_directive_t, allow_duplicates bool, mark yaml_mark_t) bool {\n\tfor i := range parser.tag_directives {\n\t\tif bytes.Equal(value.handle, parser.tag_directives[i].handle) {\n\t\t\tif allow_duplicates {\n\t\t\t\treturn true\n\t\t\t}\n\t\t\treturn yaml_parser_set_parser_error(parser, \"found duplicate %TAG directive\", mark)\n\t\t}\n\t}\n\n\t// [Go] I suspect the copy is unnecessary. This was likely done\n\t// because there was no way to track ownership of the data.\n\tvalue_copy := yaml_tag_directive_t{\n\t\thandle: make([]byte, len(value.handle)),\n\t\tprefix: make([]byte, len(value.prefix)),\n\t}\n\tcopy(value_copy.handle, value.handle)\n\tcopy(value_copy.prefix, value.prefix)\n\tparser.tag_directives = append(parser.tag_directives, value_copy)\n\treturn true\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/readerc.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n// Copyright (c) 2006-2010 Kirill Simonov\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy of\n// this software and associated documentation files (the \"Software\"), to deal in\n// the Software without restriction, including without limitation the rights to\n// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n// of the Software, and to permit persons to whom the Software is furnished to do\n// so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\npackage yaml\n\nimport (\n\t\"io\"\n)\n\n// Set the reader error and return 0.\nfunc yaml_parser_set_reader_error(parser *yaml_parser_t, problem string, offset int, value int) bool {\n\tparser.error = yaml_READER_ERROR\n\tparser.problem = problem\n\tparser.problem_offset = offset\n\tparser.problem_value = value\n\treturn false\n}\n\n// Byte order marks.\nconst (\n\tbom_UTF8 = \"\\xef\\xbb\\xbf\"\n\tbom_UTF16LE = \"\\xff\\xfe\"\n\tbom_UTF16BE = \"\\xfe\\xff\"\n)\n\n// Determine the input stream encoding by checking the BOM symbol. If no BOM is\n// found, the UTF-8 encoding is assumed. Return 1 on success, 0 on failure.\nfunc yaml_parser_determine_encoding(parser *yaml_parser_t) bool {\n\t// Ensure that we had enough bytes in the raw buffer.\n\tfor !parser.eof && len(parser.raw_buffer)-parser.raw_buffer_pos < 3 {\n\t\tif !yaml_parser_update_raw_buffer(parser) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Determine the encoding.\n\tbuf := parser.raw_buffer\n\tpos := parser.raw_buffer_pos\n\tavail := len(buf) - pos\n\tif avail >= 2 && buf[pos] == bom_UTF16LE[0] && buf[pos+1] == bom_UTF16LE[1] {\n\t\tparser.encoding = yaml_UTF16LE_ENCODING\n\t\tparser.raw_buffer_pos += 2\n\t\tparser.offset += 2\n\t} else if avail >= 2 && buf[pos] == bom_UTF16BE[0] && buf[pos+1] == bom_UTF16BE[1] {\n\t\tparser.encoding = yaml_UTF16BE_ENCODING\n\t\tparser.raw_buffer_pos += 2\n\t\tparser.offset += 2\n\t} else if avail >= 3 && buf[pos] == bom_UTF8[0] && buf[pos+1] == bom_UTF8[1] && buf[pos+2] == bom_UTF8[2] {\n\t\tparser.encoding = yaml_UTF8_ENCODING\n\t\tparser.raw_buffer_pos += 3\n\t\tparser.offset += 3\n\t} else {\n\t\tparser.encoding = yaml_UTF8_ENCODING\n\t}\n\treturn true\n}\n\n// Update the raw buffer.\nfunc yaml_parser_update_raw_buffer(parser *yaml_parser_t) bool {\n\tsize_read := 0\n\n\t// Return if the raw buffer is full.\n\tif parser.raw_buffer_pos == 0 && len(parser.raw_buffer) == cap(parser.raw_buffer) {\n\t\treturn true\n\t}\n\n\t// Return on EOF.\n\tif parser.eof {\n\t\treturn true\n\t}\n\n\t// Move the remaining bytes in the raw buffer to the beginning.\n\tif parser.raw_buffer_pos > 0 && parser.raw_buffer_pos < len(parser.raw_buffer) {\n\t\tcopy(parser.raw_buffer, parser.raw_buffer[parser.raw_buffer_pos:])\n\t}\n\tparser.raw_buffer = parser.raw_buffer[:len(parser.raw_buffer)-parser.raw_buffer_pos]\n\tparser.raw_buffer_pos = 0\n\n\t// Call the read handler to fill the buffer.\n\tsize_read, err := parser.read_handler(parser, parser.raw_buffer[len(parser.raw_buffer):cap(parser.raw_buffer)])\n\tparser.raw_buffer = parser.raw_buffer[:len(parser.raw_buffer)+size_read]\n\tif err == io.EOF {\n\t\tparser.eof = true\n\t} else if err != nil {\n\t\treturn yaml_parser_set_reader_error(parser, \"input error: \"+err.Error(), parser.offset, -1)\n\t}\n\treturn true\n}\n\n// Ensure that the buffer contains at least `length` characters.\n// Return true on success, false on failure.\n//\n// The length is supposed to be significantly less that the buffer size.\nfunc yaml_parser_update_buffer(parser *yaml_parser_t, length int) bool {\n\tif parser.read_handler == nil {\n\t\tpanic(\"read handler must be set\")\n\t}\n\n\t// [Go] This function was changed to guarantee the requested length size at EOF.\n\t// The fact we need to do this is pretty awful, but the description above implies\n\t// for that to be the case, and there are tests\n\n\t// If the EOF flag is set and the raw buffer is empty, do nothing.\n\tif parser.eof && parser.raw_buffer_pos == len(parser.raw_buffer) {\n\t\t// [Go] ACTUALLY! Read the documentation of this function above.\n\t\t// This is just broken. To return true, we need to have the\n\t\t// given length in the buffer. Not doing that means every single\n\t\t// check that calls this function to make sure the buffer has a\n\t\t// given length is Go) panicking; or C) accessing invalid memory.\n\t\t//return true\n\t}\n\n\t// Return if the buffer contains enough characters.\n\tif parser.unread >= length {\n\t\treturn true\n\t}\n\n\t// Determine the input encoding if it is not known yet.\n\tif parser.encoding == yaml_ANY_ENCODING {\n\t\tif !yaml_parser_determine_encoding(parser) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Move the unread characters to the beginning of the buffer.\n\tbuffer_len := len(parser.buffer)\n\tif parser.buffer_pos > 0 && parser.buffer_pos < buffer_len {\n\t\tcopy(parser.buffer, parser.buffer[parser.buffer_pos:])\n\t\tbuffer_len -= parser.buffer_pos\n\t\tparser.buffer_pos = 0\n\t} else if parser.buffer_pos == buffer_len {\n\t\tbuffer_len = 0\n\t\tparser.buffer_pos = 0\n\t}\n\n\t// Open the whole buffer for writing, and cut it before returning.\n\tparser.buffer = parser.buffer[:cap(parser.buffer)]\n\n\t// Fill the buffer until it has enough characters.\n\tfirst := true\n\tfor parser.unread < length {\n\n\t\t// Fill the raw buffer if necessary.\n\t\tif !first || parser.raw_buffer_pos == len(parser.raw_buffer) {\n\t\t\tif !yaml_parser_update_raw_buffer(parser) {\n\t\t\t\tparser.buffer = parser.buffer[:buffer_len]\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tfirst = false\n\n\t\t// Decode the raw buffer.\n\tinner:\n\t\tfor parser.raw_buffer_pos != len(parser.raw_buffer) {\n\t\t\tvar value rune\n\t\t\tvar width int\n\n\t\t\traw_unread := len(parser.raw_buffer) - parser.raw_buffer_pos\n\n\t\t\t// Decode the next character.\n\t\t\tswitch parser.encoding {\n\t\t\tcase yaml_UTF8_ENCODING:\n\t\t\t\t// Decode a UTF-8 character. Check RFC 3629\n\t\t\t\t// (http://www.ietf.org/rfc/rfc3629.txt) for more details.\n\t\t\t\t//\n\t\t\t\t// The following table (taken from the RFC) is used for\n\t\t\t\t// decoding.\n\t\t\t\t//\n\t\t\t\t// Char. number range | UTF-8 octet sequence\n\t\t\t\t// (hexadecimal) | (binary)\n\t\t\t\t// --------------------+------------------------------------\n\t\t\t\t// 0000 0000-0000 007F | 0xxxxxxx\n\t\t\t\t// 0000 0080-0000 07FF | 110xxxxx 10xxxxxx\n\t\t\t\t// 0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx\n\t\t\t\t// 0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx\n\t\t\t\t//\n\t\t\t\t// Additionally, the characters in the range 0xD800-0xDFFF\n\t\t\t\t// are prohibited as they are reserved for use with UTF-16\n\t\t\t\t// surrogate pairs.\n\n\t\t\t\t// Determine the length of the UTF-8 sequence.\n\t\t\t\toctet := parser.raw_buffer[parser.raw_buffer_pos]\n\t\t\t\tswitch {\n\t\t\t\tcase octet&0x80 == 0x00:\n\t\t\t\t\twidth = 1\n\t\t\t\tcase octet&0xE0 == 0xC0:\n\t\t\t\t\twidth = 2\n\t\t\t\tcase octet&0xF0 == 0xE0:\n\t\t\t\t\twidth = 3\n\t\t\t\tcase octet&0xF8 == 0xF0:\n\t\t\t\t\twidth = 4\n\t\t\t\tdefault:\n\t\t\t\t\t// The leading octet is invalid.\n\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\"invalid leading UTF-8 octet\",\n\t\t\t\t\t\tparser.offset, int(octet))\n\t\t\t\t}\n\n\t\t\t\t// Check if the raw buffer contains an incomplete character.\n\t\t\t\tif width > raw_unread {\n\t\t\t\t\tif parser.eof {\n\t\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\t\"incomplete UTF-8 octet sequence\",\n\t\t\t\t\t\t\tparser.offset, -1)\n\t\t\t\t\t}\n\t\t\t\t\tbreak inner\n\t\t\t\t}\n\n\t\t\t\t// Decode the leading octet.\n\t\t\t\tswitch {\n\t\t\t\tcase octet&0x80 == 0x00:\n\t\t\t\t\tvalue = rune(octet & 0x7F)\n\t\t\t\tcase octet&0xE0 == 0xC0:\n\t\t\t\t\tvalue = rune(octet & 0x1F)\n\t\t\t\tcase octet&0xF0 == 0xE0:\n\t\t\t\t\tvalue = rune(octet & 0x0F)\n\t\t\t\tcase octet&0xF8 == 0xF0:\n\t\t\t\t\tvalue = rune(octet & 0x07)\n\t\t\t\tdefault:\n\t\t\t\t\tvalue = 0\n\t\t\t\t}\n\n\t\t\t\t// Check and decode the trailing octets.\n\t\t\t\tfor k := 1; k < width; k++ {\n\t\t\t\t\toctet = parser.raw_buffer[parser.raw_buffer_pos+k]\n\n\t\t\t\t\t// Check if the octet is valid.\n\t\t\t\t\tif (octet & 0xC0) != 0x80 {\n\t\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\t\"invalid trailing UTF-8 octet\",\n\t\t\t\t\t\t\tparser.offset+k, int(octet))\n\t\t\t\t\t}\n\n\t\t\t\t\t// Decode the octet.\n\t\t\t\t\tvalue = (value << 6) + rune(octet&0x3F)\n\t\t\t\t}\n\n\t\t\t\t// Check the length of the sequence against the value.\n\t\t\t\tswitch {\n\t\t\t\tcase width == 1:\n\t\t\t\tcase width == 2 && value >= 0x80:\n\t\t\t\tcase width == 3 && value >= 0x800:\n\t\t\t\tcase width == 4 && value >= 0x10000:\n\t\t\t\tdefault:\n\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\"invalid length of a UTF-8 sequence\",\n\t\t\t\t\t\tparser.offset, -1)\n\t\t\t\t}\n\n\t\t\t\t// Check the range of the value.\n\t\t\t\tif value >= 0xD800 && value <= 0xDFFF || value > 0x10FFFF {\n\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\"invalid Unicode character\",\n\t\t\t\t\t\tparser.offset, int(value))\n\t\t\t\t}\n\n\t\t\tcase yaml_UTF16LE_ENCODING, yaml_UTF16BE_ENCODING:\n\t\t\t\tvar low, high int\n\t\t\t\tif parser.encoding == yaml_UTF16LE_ENCODING {\n\t\t\t\t\tlow, high = 0, 1\n\t\t\t\t} else {\n\t\t\t\t\tlow, high = 1, 0\n\t\t\t\t}\n\n\t\t\t\t// The UTF-16 encoding is not as simple as one might\n\t\t\t\t// naively think. Check RFC 2781\n\t\t\t\t// (http://www.ietf.org/rfc/rfc2781.txt).\n\t\t\t\t//\n\t\t\t\t// Normally, two subsequent bytes describe a Unicode\n\t\t\t\t// character. However a special technique (called a\n\t\t\t\t// surrogate pair) is used for specifying character\n\t\t\t\t// values larger than 0xFFFF.\n\t\t\t\t//\n\t\t\t\t// A surrogate pair consists of two pseudo-characters:\n\t\t\t\t// high surrogate area (0xD800-0xDBFF)\n\t\t\t\t// low surrogate area (0xDC00-0xDFFF)\n\t\t\t\t//\n\t\t\t\t// The following formulas are used for decoding\n\t\t\t\t// and encoding characters using surrogate pairs:\n\t\t\t\t//\n\t\t\t\t// U = U' + 0x10000 (0x01 00 00 <= U <= 0x10 FF FF)\n\t\t\t\t// U' = yyyyyyyyyyxxxxxxxxxx (0 <= U' <= 0x0F FF FF)\n\t\t\t\t// W1 = 110110yyyyyyyyyy\n\t\t\t\t// W2 = 110111xxxxxxxxxx\n\t\t\t\t//\n\t\t\t\t// where U is the character value, W1 is the high surrogate\n\t\t\t\t// area, W2 is the low surrogate area.\n\n\t\t\t\t// Check for incomplete UTF-16 character.\n\t\t\t\tif raw_unread < 2 {\n\t\t\t\t\tif parser.eof {\n\t\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\t\"incomplete UTF-16 character\",\n\t\t\t\t\t\t\tparser.offset, -1)\n\t\t\t\t\t}\n\t\t\t\t\tbreak inner\n\t\t\t\t}\n\n\t\t\t\t// Get the character.\n\t\t\t\tvalue = rune(parser.raw_buffer[parser.raw_buffer_pos+low]) +\n\t\t\t\t\t(rune(parser.raw_buffer[parser.raw_buffer_pos+high]) << 8)\n\n\t\t\t\t// Check for unexpected low surrogate area.\n\t\t\t\tif value&0xFC00 == 0xDC00 {\n\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\"unexpected low surrogate area\",\n\t\t\t\t\t\tparser.offset, int(value))\n\t\t\t\t}\n\n\t\t\t\t// Check for a high surrogate area.\n\t\t\t\tif value&0xFC00 == 0xD800 {\n\t\t\t\t\twidth = 4\n\n\t\t\t\t\t// Check for incomplete surrogate pair.\n\t\t\t\t\tif raw_unread < 4 {\n\t\t\t\t\t\tif parser.eof {\n\t\t\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\t\t\"incomplete UTF-16 surrogate pair\",\n\t\t\t\t\t\t\t\tparser.offset, -1)\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak inner\n\t\t\t\t\t}\n\n\t\t\t\t\t// Get the next character.\n\t\t\t\t\tvalue2 := rune(parser.raw_buffer[parser.raw_buffer_pos+low+2]) +\n\t\t\t\t\t\t(rune(parser.raw_buffer[parser.raw_buffer_pos+high+2]) << 8)\n\n\t\t\t\t\t// Check for a low surrogate area.\n\t\t\t\t\tif value2&0xFC00 != 0xDC00 {\n\t\t\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\t\t\"expected low surrogate area\",\n\t\t\t\t\t\t\tparser.offset+2, int(value2))\n\t\t\t\t\t}\n\n\t\t\t\t\t// Generate the value of the surrogate pair.\n\t\t\t\t\tvalue = 0x10000 + ((value & 0x3FF) << 10) + (value2 & 0x3FF)\n\t\t\t\t} else {\n\t\t\t\t\twidth = 2\n\t\t\t\t}\n\n\t\t\tdefault:\n\t\t\t\tpanic(\"impossible\")\n\t\t\t}\n\n\t\t\t// Check if the character is in the allowed range:\n\t\t\t// #x9 | #xA | #xD | [#x20-#x7E] (8 bit)\n\t\t\t// | #x85 | [#xA0-#xD7FF] | [#xE000-#xFFFD] (16 bit)\n\t\t\t// | [#x10000-#x10FFFF] (32 bit)\n\t\t\tswitch {\n\t\t\tcase value == 0x09:\n\t\t\tcase value == 0x0A:\n\t\t\tcase value == 0x0D:\n\t\t\tcase value >= 0x20 && value <= 0x7E:\n\t\t\tcase value == 0x85:\n\t\t\tcase value >= 0xA0 && value <= 0xD7FF:\n\t\t\tcase value >= 0xE000 && value <= 0xFFFD:\n\t\t\tcase value >= 0x10000 && value <= 0x10FFFF:\n\t\t\tdefault:\n\t\t\t\treturn yaml_parser_set_reader_error(parser,\n\t\t\t\t\t\"control characters are not allowed\",\n\t\t\t\t\tparser.offset, int(value))\n\t\t\t}\n\n\t\t\t// Move the raw pointers.\n\t\t\tparser.raw_buffer_pos += width\n\t\t\tparser.offset += width\n\n\t\t\t// Finally put the character into the buffer.\n\t\t\tif value <= 0x7F {\n\t\t\t\t// 0000 0000-0000 007F . 0xxxxxxx\n\t\t\t\tparser.buffer[buffer_len+0] = byte(value)\n\t\t\t\tbuffer_len += 1\n\t\t\t} else if value <= 0x7FF {\n\t\t\t\t// 0000 0080-0000 07FF . 110xxxxx 10xxxxxx\n\t\t\t\tparser.buffer[buffer_len+0] = byte(0xC0 + (value >> 6))\n\t\t\t\tparser.buffer[buffer_len+1] = byte(0x80 + (value & 0x3F))\n\t\t\t\tbuffer_len += 2\n\t\t\t} else if value <= 0xFFFF {\n\t\t\t\t// 0000 0800-0000 FFFF . 1110xxxx 10xxxxxx 10xxxxxx\n\t\t\t\tparser.buffer[buffer_len+0] = byte(0xE0 + (value >> 12))\n\t\t\t\tparser.buffer[buffer_len+1] = byte(0x80 + ((value >> 6) & 0x3F))\n\t\t\t\tparser.buffer[buffer_len+2] = byte(0x80 + (value & 0x3F))\n\t\t\t\tbuffer_len += 3\n\t\t\t} else {\n\t\t\t\t// 0001 0000-0010 FFFF . 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx\n\t\t\t\tparser.buffer[buffer_len+0] = byte(0xF0 + (value >> 18))\n\t\t\t\tparser.buffer[buffer_len+1] = byte(0x80 + ((value >> 12) & 0x3F))\n\t\t\t\tparser.buffer[buffer_len+2] = byte(0x80 + ((value >> 6) & 0x3F))\n\t\t\t\tparser.buffer[buffer_len+3] = byte(0x80 + (value & 0x3F))\n\t\t\t\tbuffer_len += 4\n\t\t\t}\n\n\t\t\tparser.unread++\n\t\t}\n\n\t\t// On EOF, put NUL into the buffer and return.\n\t\tif parser.eof {\n\t\t\tparser.buffer[buffer_len] = 0\n\t\t\tbuffer_len++\n\t\t\tparser.unread++\n\t\t\tbreak\n\t\t}\n\t}\n\t// [Go] Read the documentation of this function above. To return true,\n\t// we need to have the given length in the buffer. Not doing that means\n\t// every single check that calls this function to make sure the buffer\n\t// has a given length is Go) panicking; or C) accessing invalid memory.\n\t// This happens here due to the EOF above breaking early.\n\tfor buffer_len < length {\n\t\tparser.buffer[buffer_len] = 0\n\t\tbuffer_len++\n\t}\n\tparser.buffer = parser.buffer[:buffer_len]\n\treturn true\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/resolve.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage yaml\n\nimport (\n\t\"encoding/base64\"\n\t\"math\"\n\t\"regexp\"\n\t\"strconv\"\n\t\"strings\"\n\t\"time\"\n)\n\ntype resolveMapItem struct {\n\tvalue interface{}\n\ttag string\n}\n\nvar resolveTable = make([]byte, 256)\nvar resolveMap = make(map[string]resolveMapItem)\n\nfunc init() {\n\tt := resolveTable\n\tt[int('+')] = 'S' // Sign\n\tt[int('-')] = 'S'\n\tfor _, c := range \"0123456789\" {\n\t\tt[int(c)] = 'D' // Digit\n\t}\n\tfor _, c := range \"yYnNtTfFoO~\" {\n\t\tt[int(c)] = 'M' // In map\n\t}\n\tt[int('.')] = '.' // Float (potentially in map)\n\n\tvar resolveMapList = []struct {\n\t\tv interface{}\n\t\ttag string\n\t\tl []string\n\t}{\n\t\t{true, boolTag, []string{\"true\", \"True\", \"TRUE\"}},\n\t\t{false, boolTag, []string{\"false\", \"False\", \"FALSE\"}},\n\t\t{nil, nullTag, []string{\"\", \"~\", \"null\", \"Null\", \"NULL\"}},\n\t\t{math.NaN(), floatTag, []string{\".nan\", \".NaN\", \".NAN\"}},\n\t\t{math.Inf(+1), floatTag, []string{\".inf\", \".Inf\", \".INF\"}},\n\t\t{math.Inf(+1), floatTag, []string{\"+.inf\", \"+.Inf\", \"+.INF\"}},\n\t\t{math.Inf(-1), floatTag, []string{\"-.inf\", \"-.Inf\", \"-.INF\"}},\n\t\t{\"<<\", mergeTag, []string{\"<<\"}},\n\t}\n\n\tm := resolveMap\n\tfor _, item := range resolveMapList {\n\t\tfor _, s := range item.l {\n\t\t\tm[s] = resolveMapItem{item.v, item.tag}\n\t\t}\n\t}\n}\n\nconst (\n\tnullTag = \"!!null\"\n\tboolTag = \"!!bool\"\n\tstrTag = \"!!str\"\n\tintTag = \"!!int\"\n\tfloatTag = \"!!float\"\n\ttimestampTag = \"!!timestamp\"\n\tseqTag = \"!!seq\"\n\tmapTag = \"!!map\"\n\tbinaryTag = \"!!binary\"\n\tmergeTag = \"!!merge\"\n)\n\nvar longTags = make(map[string]string)\nvar shortTags = make(map[string]string)\n\nfunc init() {\n\tfor _, stag := range []string{nullTag, boolTag, strTag, intTag, floatTag, timestampTag, seqTag, mapTag, binaryTag, mergeTag} {\n\t\tltag := longTag(stag)\n\t\tlongTags[stag] = ltag\n\t\tshortTags[ltag] = stag\n\t}\n}\n\nconst longTagPrefix = \"tag:yaml.org,2002:\"\n\nfunc shortTag(tag string) string {\n\tif strings.HasPrefix(tag, longTagPrefix) {\n\t\tif stag, ok := shortTags[tag]; ok {\n\t\t\treturn stag\n\t\t}\n\t\treturn \"!!\" + tag[len(longTagPrefix):]\n\t}\n\treturn tag\n}\n\nfunc longTag(tag string) string {\n\tif strings.HasPrefix(tag, \"!!\") {\n\t\tif ltag, ok := longTags[tag]; ok {\n\t\t\treturn ltag\n\t\t}\n\t\treturn longTagPrefix + tag[2:]\n\t}\n\treturn tag\n}\n\nfunc resolvableTag(tag string) bool {\n\tswitch tag {\n\tcase \"\", strTag, boolTag, intTag, floatTag, nullTag, timestampTag:\n\t\treturn true\n\t}\n\treturn false\n}\n\nvar yamlStyleFloat = regexp.MustCompile(`^[-+]?(\\.[0-9]+|[0-9]+(\\.[0-9]*)?)([eE][-+]?[0-9]+)?$`)\n\nfunc resolve(tag string, in string) (rtag string, out interface{}) {\n\ttag = shortTag(tag)\n\tif !resolvableTag(tag) {\n\t\treturn tag, in\n\t}\n\n\tdefer func() {\n\t\tswitch tag {\n\t\tcase \"\", rtag, strTag, binaryTag:\n\t\t\treturn\n\t\tcase floatTag:\n\t\t\tif rtag == intTag {\n\t\t\t\tswitch v := out.(type) {\n\t\t\t\tcase int64:\n\t\t\t\t\trtag = floatTag\n\t\t\t\t\tout = float64(v)\n\t\t\t\t\treturn\n\t\t\t\tcase int:\n\t\t\t\t\trtag = floatTag\n\t\t\t\t\tout = float64(v)\n\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tfailf(\"cannot decode %s `%s` as a %s\", shortTag(rtag), in, shortTag(tag))\n\t}()\n\n\t// Any data is accepted as a !!str or !!binary.\n\t// Otherwise, the prefix is enough of a hint about what it might be.\n\thint := byte('N')\n\tif in != \"\" {\n\t\thint = resolveTable[in[0]]\n\t}\n\tif hint != 0 && tag != strTag && tag != binaryTag {\n\t\t// Handle things we can lookup in a map.\n\t\tif item, ok := resolveMap[in]; ok {\n\t\t\treturn item.tag, item.value\n\t\t}\n\n\t\t// Base 60 floats are a bad idea, were dropped in YAML 1.2, and\n\t\t// are purposefully unsupported here. They're still quoted on\n\t\t// the way out for compatibility with other parser, though.\n\n\t\tswitch hint {\n\t\tcase 'M':\n\t\t\t// We've already checked the map above.\n\n\t\tcase '.':\n\t\t\t// Not in the map, so maybe a normal float.\n\t\t\tfloatv, err := strconv.ParseFloat(in, 64)\n\t\t\tif err == nil {\n\t\t\t\treturn floatTag, floatv\n\t\t\t}\n\n\t\tcase 'D', 'S':\n\t\t\t// Int, float, or timestamp.\n\t\t\t// Only try values as a timestamp if the value is unquoted or there's an explicit\n\t\t\t// !!timestamp tag.\n\t\t\tif tag == \"\" || tag == timestampTag {\n\t\t\t\tt, ok := parseTimestamp(in)\n\t\t\t\tif ok {\n\t\t\t\t\treturn timestampTag, t\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tplain := strings.Replace(in, \"_\", \"\", -1)\n\t\t\tintv, err := strconv.ParseInt(plain, 0, 64)\n\t\t\tif err == nil {\n\t\t\t\tif intv == int64(int(intv)) {\n\t\t\t\t\treturn intTag, int(intv)\n\t\t\t\t} else {\n\t\t\t\t\treturn intTag, intv\n\t\t\t\t}\n\t\t\t}\n\t\t\tuintv, err := strconv.ParseUint(plain, 0, 64)\n\t\t\tif err == nil {\n\t\t\t\treturn intTag, uintv\n\t\t\t}\n\t\t\tif yamlStyleFloat.MatchString(plain) {\n\t\t\t\tfloatv, err := strconv.ParseFloat(plain, 64)\n\t\t\t\tif err == nil {\n\t\t\t\t\treturn floatTag, floatv\n\t\t\t\t}\n\t\t\t}\n\t\t\tif strings.HasPrefix(plain, \"0b\") {\n\t\t\t\tintv, err := strconv.ParseInt(plain[2:], 2, 64)\n\t\t\t\tif err == nil {\n\t\t\t\t\tif intv == int64(int(intv)) {\n\t\t\t\t\t\treturn intTag, int(intv)\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn intTag, intv\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tuintv, err := strconv.ParseUint(plain[2:], 2, 64)\n\t\t\t\tif err == nil {\n\t\t\t\t\treturn intTag, uintv\n\t\t\t\t}\n\t\t\t} else if strings.HasPrefix(plain, \"-0b\") {\n\t\t\t\tintv, err := strconv.ParseInt(\"-\"+plain[3:], 2, 64)\n\t\t\t\tif err == nil {\n\t\t\t\t\tif true || intv == int64(int(intv)) {\n\t\t\t\t\t\treturn intTag, int(intv)\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn intTag, intv\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\t// Octals as introduced in version 1.2 of the spec.\n\t\t\t// Octals from the 1.1 spec, spelled as 0777, are still\n\t\t\t// decoded by default in v3 as well for compatibility.\n\t\t\t// May be dropped in v4 depending on how usage evolves.\n\t\t\tif strings.HasPrefix(plain, \"0o\") {\n\t\t\t\tintv, err := strconv.ParseInt(plain[2:], 8, 64)\n\t\t\t\tif err == nil {\n\t\t\t\t\tif intv == int64(int(intv)) {\n\t\t\t\t\t\treturn intTag, int(intv)\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn intTag, intv\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tuintv, err := strconv.ParseUint(plain[2:], 8, 64)\n\t\t\t\tif err == nil {\n\t\t\t\t\treturn intTag, uintv\n\t\t\t\t}\n\t\t\t} else if strings.HasPrefix(plain, \"-0o\") {\n\t\t\t\tintv, err := strconv.ParseInt(\"-\"+plain[3:], 8, 64)\n\t\t\t\tif err == nil {\n\t\t\t\t\tif true || intv == int64(int(intv)) {\n\t\t\t\t\t\treturn intTag, int(intv)\n\t\t\t\t\t} else {\n\t\t\t\t\t\treturn intTag, intv\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\tdefault:\n\t\t\tpanic(\"internal error: missing handler for resolver table: \" + string(rune(hint)) + \" (with \" + in + \")\")\n\t\t}\n\t}\n\treturn strTag, in\n}\n\n// encodeBase64 encodes s as base64 that is broken up into multiple lines\n// as appropriate for the resulting length.\nfunc encodeBase64(s string) string {\n\tconst lineLen = 70\n\tencLen := base64.StdEncoding.EncodedLen(len(s))\n\tlines := encLen/lineLen + 1\n\tbuf := make([]byte, encLen*2+lines)\n\tin := buf[0:encLen]\n\tout := buf[encLen:]\n\tbase64.StdEncoding.Encode(in, []byte(s))\n\tk := 0\n\tfor i := 0; i < len(in); i += lineLen {\n\t\tj := i + lineLen\n\t\tif j > len(in) {\n\t\t\tj = len(in)\n\t\t}\n\t\tk += copy(out[k:], in[i:j])\n\t\tif lines > 1 {\n\t\t\tout[k] = '\\n'\n\t\t\tk++\n\t\t}\n\t}\n\treturn string(out[:k])\n}\n\n// This is a subset of the formats allowed by the regular expression\n// defined at http://yaml.org/type/timestamp.html.\nvar allowedTimestampFormats = []string{\n\t\"2006-1-2T15:4:5.999999999Z07:00\", // RCF3339Nano with short date fields.\n\t\"2006-1-2t15:4:5.999999999Z07:00\", // RFC3339Nano with short date fields and lower-case \"t\".\n\t\"2006-1-2 15:4:5.999999999\", // space separated with no time zone\n\t\"2006-1-2\", // date only\n\t// Notable exception: time.Parse cannot handle: \"2001-12-14 21:59:43.10 -5\"\n\t// from the set of examples.\n}\n\n// parseTimestamp parses s as a timestamp string and\n// returns the timestamp and reports whether it succeeded.\n// Timestamp formats are defined at http://yaml.org/type/timestamp.html\nfunc parseTimestamp(s string) (time.Time, bool) {\n\t// TODO write code to check all the formats supported by\n\t// http://yaml.org/type/timestamp.html instead of using time.Parse.\n\n\t// Quick check: all date formats start with YYYY-.\n\ti := 0\n\tfor ; i < len(s); i++ {\n\t\tif c := s[i]; c < '0' || c > '9' {\n\t\t\tbreak\n\t\t}\n\t}\n\tif i != 4 || i == len(s) || s[i] != '-' {\n\t\treturn time.Time{}, false\n\t}\n\tfor _, format := range allowedTimestampFormats {\n\t\tif t, err := time.Parse(format, s); err == nil {\n\t\t\treturn t, true\n\t\t}\n\t}\n\treturn time.Time{}, false\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/scannerc.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n// Copyright (c) 2006-2010 Kirill Simonov\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy of\n// this software and associated documentation files (the \"Software\"), to deal in\n// the Software without restriction, including without limitation the rights to\n// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n// of the Software, and to permit persons to whom the Software is furnished to do\n// so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\npackage yaml\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n)\n\n// Introduction\n// ************\n//\n// The following notes assume that you are familiar with the YAML specification\n// (http://yaml.org/spec/1.2/spec.html). We mostly follow it, although in\n// some cases we are less restrictive that it requires.\n//\n// The process of transforming a YAML stream into a sequence of events is\n// divided on two steps: Scanning and Parsing.\n//\n// The Scanner transforms the input stream into a sequence of tokens, while the\n// parser transform the sequence of tokens produced by the Scanner into a\n// sequence of parsing events.\n//\n// The Scanner is rather clever and complicated. The Parser, on the contrary,\n// is a straightforward implementation of a recursive-descendant parser (or,\n// LL(1) parser, as it is usually called).\n//\n// Actually there are two issues of Scanning that might be called \"clever\", the\n// rest is quite straightforward. The issues are \"block collection start\" and\n// \"simple keys\". Both issues are explained below in details.\n//\n// Here the Scanning step is explained and implemented. We start with the list\n// of all the tokens produced by the Scanner together with short descriptions.\n//\n// Now, tokens:\n//\n// STREAM-START(encoding) # The stream start.\n// STREAM-END # The stream end.\n// VERSION-DIRECTIVE(major,minor) # The '%YAML' directive.\n// TAG-DIRECTIVE(handle,prefix) # The '%TAG' directive.\n// DOCUMENT-START # '---'\n// DOCUMENT-END # '...'\n// BLOCK-SEQUENCE-START # Indentation increase denoting a block\n// BLOCK-MAPPING-START # sequence or a block mapping.\n// BLOCK-END # Indentation decrease.\n// FLOW-SEQUENCE-START # '['\n// FLOW-SEQUENCE-END # ']'\n// BLOCK-SEQUENCE-START # '{'\n// BLOCK-SEQUENCE-END # '}'\n// BLOCK-ENTRY # '-'\n// FLOW-ENTRY # ','\n// KEY # '?' or nothing (simple keys).\n// VALUE # ':'\n// ALIAS(anchor) # '*anchor'\n// ANCHOR(anchor) # '&anchor'\n// TAG(handle,suffix) # '!handle!suffix'\n// SCALAR(value,style) # A scalar.\n//\n// The following two tokens are \"virtual\" tokens denoting the beginning and the\n// end of the stream:\n//\n// STREAM-START(encoding)\n// STREAM-END\n//\n// We pass the information about the input stream encoding with the\n// STREAM-START token.\n//\n// The next two tokens are responsible for tags:\n//\n// VERSION-DIRECTIVE(major,minor)\n// TAG-DIRECTIVE(handle,prefix)\n//\n// Example:\n//\n// %YAML 1.1\n// %TAG ! !foo\n// %TAG !yaml! tag:yaml.org,2002:\n// ---\n//\n// The correspoding sequence of tokens:\n//\n// STREAM-START(utf-8)\n// VERSION-DIRECTIVE(1,1)\n// TAG-DIRECTIVE(\"!\",\"!foo\")\n// TAG-DIRECTIVE(\"!yaml\",\"tag:yaml.org,2002:\")\n// DOCUMENT-START\n// STREAM-END\n//\n// Note that the VERSION-DIRECTIVE and TAG-DIRECTIVE tokens occupy a whole\n// line.\n//\n// The document start and end indicators are represented by:\n//\n// DOCUMENT-START\n// DOCUMENT-END\n//\n// Note that if a YAML stream contains an implicit document (without '---'\n// and '...' indicators), no DOCUMENT-START and DOCUMENT-END tokens will be\n// produced.\n//\n// In the following examples, we present whole documents together with the\n// produced tokens.\n//\n// 1. An implicit document:\n//\n// 'a scalar'\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// SCALAR(\"a scalar\",single-quoted)\n// STREAM-END\n//\n// 2. An explicit document:\n//\n// ---\n// 'a scalar'\n// ...\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// DOCUMENT-START\n// SCALAR(\"a scalar\",single-quoted)\n// DOCUMENT-END\n// STREAM-END\n//\n// 3. Several documents in a stream:\n//\n// 'a scalar'\n// ---\n// 'another scalar'\n// ---\n// 'yet another scalar'\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// SCALAR(\"a scalar\",single-quoted)\n// DOCUMENT-START\n// SCALAR(\"another scalar\",single-quoted)\n// DOCUMENT-START\n// SCALAR(\"yet another scalar\",single-quoted)\n// STREAM-END\n//\n// We have already introduced the SCALAR token above. The following tokens are\n// used to describe aliases, anchors, tag, and scalars:\n//\n// ALIAS(anchor)\n// ANCHOR(anchor)\n// TAG(handle,suffix)\n// SCALAR(value,style)\n//\n// The following series of examples illustrate the usage of these tokens:\n//\n// 1. A recursive sequence:\n//\n// &A [ *A ]\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// ANCHOR(\"A\")\n// FLOW-SEQUENCE-START\n// ALIAS(\"A\")\n// FLOW-SEQUENCE-END\n// STREAM-END\n//\n// 2. A tagged scalar:\n//\n// !!float \"3.14\" # A good approximation.\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// TAG(\"!!\",\"float\")\n// SCALAR(\"3.14\",double-quoted)\n// STREAM-END\n//\n// 3. Various scalar styles:\n//\n// --- # Implicit empty plain scalars do not produce tokens.\n// --- a plain scalar\n// --- 'a single-quoted scalar'\n// --- \"a double-quoted scalar\"\n// --- |-\n// a literal scalar\n// --- >-\n// a folded\n// scalar\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// DOCUMENT-START\n// DOCUMENT-START\n// SCALAR(\"a plain scalar\",plain)\n// DOCUMENT-START\n// SCALAR(\"a single-quoted scalar\",single-quoted)\n// DOCUMENT-START\n// SCALAR(\"a double-quoted scalar\",double-quoted)\n// DOCUMENT-START\n// SCALAR(\"a literal scalar\",literal)\n// DOCUMENT-START\n// SCALAR(\"a folded scalar\",folded)\n// STREAM-END\n//\n// Now it's time to review collection-related tokens. We will start with\n// flow collections:\n//\n// FLOW-SEQUENCE-START\n// FLOW-SEQUENCE-END\n// FLOW-MAPPING-START\n// FLOW-MAPPING-END\n// FLOW-ENTRY\n// KEY\n// VALUE\n//\n// The tokens FLOW-SEQUENCE-START, FLOW-SEQUENCE-END, FLOW-MAPPING-START, and\n// FLOW-MAPPING-END represent the indicators '[', ']', '{', and '}'\n// correspondingly. FLOW-ENTRY represent the ',' indicator. Finally the\n// indicators '?' and ':', which are used for denoting mapping keys and values,\n// are represented by the KEY and VALUE tokens.\n//\n// The following examples show flow collections:\n//\n// 1. A flow sequence:\n//\n// [item 1, item 2, item 3]\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// FLOW-SEQUENCE-START\n// SCALAR(\"item 1\",plain)\n// FLOW-ENTRY\n// SCALAR(\"item 2\",plain)\n// FLOW-ENTRY\n// SCALAR(\"item 3\",plain)\n// FLOW-SEQUENCE-END\n// STREAM-END\n//\n// 2. A flow mapping:\n//\n// {\n// a simple key: a value, # Note that the KEY token is produced.\n// ? a complex key: another value,\n// }\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// FLOW-MAPPING-START\n// KEY\n// SCALAR(\"a simple key\",plain)\n// VALUE\n// SCALAR(\"a value\",plain)\n// FLOW-ENTRY\n// KEY\n// SCALAR(\"a complex key\",plain)\n// VALUE\n// SCALAR(\"another value\",plain)\n// FLOW-ENTRY\n// FLOW-MAPPING-END\n// STREAM-END\n//\n// A simple key is a key which is not denoted by the '?' indicator. Note that\n// the Scanner still produce the KEY token whenever it encounters a simple key.\n//\n// For scanning block collections, the following tokens are used (note that we\n// repeat KEY and VALUE here):\n//\n// BLOCK-SEQUENCE-START\n// BLOCK-MAPPING-START\n// BLOCK-END\n// BLOCK-ENTRY\n// KEY\n// VALUE\n//\n// The tokens BLOCK-SEQUENCE-START and BLOCK-MAPPING-START denote indentation\n// increase that precedes a block collection (cf. the INDENT token in Python).\n// The token BLOCK-END denote indentation decrease that ends a block collection\n// (cf. the DEDENT token in Python). However YAML has some syntax pecularities\n// that makes detections of these tokens more complex.\n//\n// The tokens BLOCK-ENTRY, KEY, and VALUE are used to represent the indicators\n// '-', '?', and ':' correspondingly.\n//\n// The following examples show how the tokens BLOCK-SEQUENCE-START,\n// BLOCK-MAPPING-START, and BLOCK-END are emitted by the Scanner:\n//\n// 1. Block sequences:\n//\n// - item 1\n// - item 2\n// -\n// - item 3.1\n// - item 3.2\n// -\n// key 1: value 1\n// key 2: value 2\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// BLOCK-SEQUENCE-START\n// BLOCK-ENTRY\n// SCALAR(\"item 1\",plain)\n// BLOCK-ENTRY\n// SCALAR(\"item 2\",plain)\n// BLOCK-ENTRY\n// BLOCK-SEQUENCE-START\n// BLOCK-ENTRY\n// SCALAR(\"item 3.1\",plain)\n// BLOCK-ENTRY\n// SCALAR(\"item 3.2\",plain)\n// BLOCK-END\n// BLOCK-ENTRY\n// BLOCK-MAPPING-START\n// KEY\n// SCALAR(\"key 1\",plain)\n// VALUE\n// SCALAR(\"value 1\",plain)\n// KEY\n// SCALAR(\"key 2\",plain)\n// VALUE\n// SCALAR(\"value 2\",plain)\n// BLOCK-END\n// BLOCK-END\n// STREAM-END\n//\n// 2. Block mappings:\n//\n// a simple key: a value # The KEY token is produced here.\n// ? a complex key\n// : another value\n// a mapping:\n// key 1: value 1\n// key 2: value 2\n// a sequence:\n// - item 1\n// - item 2\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// BLOCK-MAPPING-START\n// KEY\n// SCALAR(\"a simple key\",plain)\n// VALUE\n// SCALAR(\"a value\",plain)\n// KEY\n// SCALAR(\"a complex key\",plain)\n// VALUE\n// SCALAR(\"another value\",plain)\n// KEY\n// SCALAR(\"a mapping\",plain)\n// BLOCK-MAPPING-START\n// KEY\n// SCALAR(\"key 1\",plain)\n// VALUE\n// SCALAR(\"value 1\",plain)\n// KEY\n// SCALAR(\"key 2\",plain)\n// VALUE\n// SCALAR(\"value 2\",plain)\n// BLOCK-END\n// KEY\n// SCALAR(\"a sequence\",plain)\n// VALUE\n// BLOCK-SEQUENCE-START\n// BLOCK-ENTRY\n// SCALAR(\"item 1\",plain)\n// BLOCK-ENTRY\n// SCALAR(\"item 2\",plain)\n// BLOCK-END\n// BLOCK-END\n// STREAM-END\n//\n// YAML does not always require to start a new block collection from a new\n// line. If the current line contains only '-', '?', and ':' indicators, a new\n// block collection may start at the current line. The following examples\n// illustrate this case:\n//\n// 1. Collections in a sequence:\n//\n// - - item 1\n// - item 2\n// - key 1: value 1\n// key 2: value 2\n// - ? complex key\n// : complex value\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// BLOCK-SEQUENCE-START\n// BLOCK-ENTRY\n// BLOCK-SEQUENCE-START\n// BLOCK-ENTRY\n// SCALAR(\"item 1\",plain)\n// BLOCK-ENTRY\n// SCALAR(\"item 2\",plain)\n// BLOCK-END\n// BLOCK-ENTRY\n// BLOCK-MAPPING-START\n// KEY\n// SCALAR(\"key 1\",plain)\n// VALUE\n// SCALAR(\"value 1\",plain)\n// KEY\n// SCALAR(\"key 2\",plain)\n// VALUE\n// SCALAR(\"value 2\",plain)\n// BLOCK-END\n// BLOCK-ENTRY\n// BLOCK-MAPPING-START\n// KEY\n// SCALAR(\"complex key\")\n// VALUE\n// SCALAR(\"complex value\")\n// BLOCK-END\n// BLOCK-END\n// STREAM-END\n//\n// 2. Collections in a mapping:\n//\n// ? a sequence\n// : - item 1\n// - item 2\n// ? a mapping\n// : key 1: value 1\n// key 2: value 2\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// BLOCK-MAPPING-START\n// KEY\n// SCALAR(\"a sequence\",plain)\n// VALUE\n// BLOCK-SEQUENCE-START\n// BLOCK-ENTRY\n// SCALAR(\"item 1\",plain)\n// BLOCK-ENTRY\n// SCALAR(\"item 2\",plain)\n// BLOCK-END\n// KEY\n// SCALAR(\"a mapping\",plain)\n// VALUE\n// BLOCK-MAPPING-START\n// KEY\n// SCALAR(\"key 1\",plain)\n// VALUE\n// SCALAR(\"value 1\",plain)\n// KEY\n// SCALAR(\"key 2\",plain)\n// VALUE\n// SCALAR(\"value 2\",plain)\n// BLOCK-END\n// BLOCK-END\n// STREAM-END\n//\n// YAML also permits non-indented sequences if they are included into a block\n// mapping. In this case, the token BLOCK-SEQUENCE-START is not produced:\n//\n// key:\n// - item 1 # BLOCK-SEQUENCE-START is NOT produced here.\n// - item 2\n//\n// Tokens:\n//\n// STREAM-START(utf-8)\n// BLOCK-MAPPING-START\n// KEY\n// SCALAR(\"key\",plain)\n// VALUE\n// BLOCK-ENTRY\n// SCALAR(\"item 1\",plain)\n// BLOCK-ENTRY\n// SCALAR(\"item 2\",plain)\n// BLOCK-END\n//\n\n// Ensure that the buffer contains the required number of characters.\n// Return true on success, false on failure (reader error or memory error).\nfunc cache(parser *yaml_parser_t, length int) bool {\n\t// [Go] This was inlined: !cache(A, B) -> unread < B && !update(A, B)\n\treturn parser.unread >= length || yaml_parser_update_buffer(parser, length)\n}\n\n// Advance the buffer pointer.\nfunc skip(parser *yaml_parser_t) {\n\tif !is_blank(parser.buffer, parser.buffer_pos) {\n\t\tparser.newlines = 0\n\t}\n\tparser.mark.index++\n\tparser.mark.column++\n\tparser.unread--\n\tparser.buffer_pos += width(parser.buffer[parser.buffer_pos])\n}\n\nfunc skip_line(parser *yaml_parser_t) {\n\tif is_crlf(parser.buffer, parser.buffer_pos) {\n\t\tparser.mark.index += 2\n\t\tparser.mark.column = 0\n\t\tparser.mark.line++\n\t\tparser.unread -= 2\n\t\tparser.buffer_pos += 2\n\t\tparser.newlines++\n\t} else if is_break(parser.buffer, parser.buffer_pos) {\n\t\tparser.mark.index++\n\t\tparser.mark.column = 0\n\t\tparser.mark.line++\n\t\tparser.unread--\n\t\tparser.buffer_pos += width(parser.buffer[parser.buffer_pos])\n\t\tparser.newlines++\n\t}\n}\n\n// Copy a character to a string buffer and advance pointers.\nfunc read(parser *yaml_parser_t, s []byte) []byte {\n\tif !is_blank(parser.buffer, parser.buffer_pos) {\n\t\tparser.newlines = 0\n\t}\n\tw := width(parser.buffer[parser.buffer_pos])\n\tif w == 0 {\n\t\tpanic(\"invalid character sequence\")\n\t}\n\tif len(s) == 0 {\n\t\ts = make([]byte, 0, 32)\n\t}\n\tif w == 1 && len(s)+w <= cap(s) {\n\t\ts = s[:len(s)+1]\n\t\ts[len(s)-1] = parser.buffer[parser.buffer_pos]\n\t\tparser.buffer_pos++\n\t} else {\n\t\ts = append(s, parser.buffer[parser.buffer_pos:parser.buffer_pos+w]...)\n\t\tparser.buffer_pos += w\n\t}\n\tparser.mark.index++\n\tparser.mark.column++\n\tparser.unread--\n\treturn s\n}\n\n// Copy a line break character to a string buffer and advance pointers.\nfunc read_line(parser *yaml_parser_t, s []byte) []byte {\n\tbuf := parser.buffer\n\tpos := parser.buffer_pos\n\tswitch {\n\tcase buf[pos] == '\\r' && buf[pos+1] == '\\n':\n\t\t// CR LF . LF\n\t\ts = append(s, '\\n')\n\t\tparser.buffer_pos += 2\n\t\tparser.mark.index++\n\t\tparser.unread--\n\tcase buf[pos] == '\\r' || buf[pos] == '\\n':\n\t\t// CR|LF . LF\n\t\ts = append(s, '\\n')\n\t\tparser.buffer_pos += 1\n\tcase buf[pos] == '\\xC2' && buf[pos+1] == '\\x85':\n\t\t// NEL . LF\n\t\ts = append(s, '\\n')\n\t\tparser.buffer_pos += 2\n\tcase buf[pos] == '\\xE2' && buf[pos+1] == '\\x80' && (buf[pos+2] == '\\xA8' || buf[pos+2] == '\\xA9'):\n\t\t// LS|PS . LS|PS\n\t\ts = append(s, buf[parser.buffer_pos:pos+3]...)\n\t\tparser.buffer_pos += 3\n\tdefault:\n\t\treturn s\n\t}\n\tparser.mark.index++\n\tparser.mark.column = 0\n\tparser.mark.line++\n\tparser.unread--\n\tparser.newlines++\n\treturn s\n}\n\n// Get the next token.\nfunc yaml_parser_scan(parser *yaml_parser_t, token *yaml_token_t) bool {\n\t// Erase the token object.\n\t*token = yaml_token_t{} // [Go] Is this necessary?\n\n\t// No tokens after STREAM-END or error.\n\tif parser.stream_end_produced || parser.error != yaml_NO_ERROR {\n\t\treturn true\n\t}\n\n\t// Ensure that the tokens queue contains enough tokens.\n\tif !parser.token_available {\n\t\tif !yaml_parser_fetch_more_tokens(parser) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Fetch the next token from the queue.\n\t*token = parser.tokens[parser.tokens_head]\n\tparser.tokens_head++\n\tparser.tokens_parsed++\n\tparser.token_available = false\n\n\tif token.typ == yaml_STREAM_END_TOKEN {\n\t\tparser.stream_end_produced = true\n\t}\n\treturn true\n}\n\n// Set the scanner error and return false.\nfunc yaml_parser_set_scanner_error(parser *yaml_parser_t, context string, context_mark yaml_mark_t, problem string) bool {\n\tparser.error = yaml_SCANNER_ERROR\n\tparser.context = context\n\tparser.context_mark = context_mark\n\tparser.problem = problem\n\tparser.problem_mark = parser.mark\n\treturn false\n}\n\nfunc yaml_parser_set_scanner_tag_error(parser *yaml_parser_t, directive bool, context_mark yaml_mark_t, problem string) bool {\n\tcontext := \"while parsing a tag\"\n\tif directive {\n\t\tcontext = \"while parsing a %TAG directive\"\n\t}\n\treturn yaml_parser_set_scanner_error(parser, context, context_mark, problem)\n}\n\nfunc trace(args ...interface{}) func() {\n\tpargs := append([]interface{}{\"+++\"}, args...)\n\tfmt.Println(pargs...)\n\tpargs = append([]interface{}{\"---\"}, args...)\n\treturn func() { fmt.Println(pargs...) }\n}\n\n// Ensure that the tokens queue contains at least one token which can be\n// returned to the Parser.\nfunc yaml_parser_fetch_more_tokens(parser *yaml_parser_t) bool {\n\t// While we need more tokens to fetch, do it.\n\tfor {\n\t\t// [Go] The comment parsing logic requires a lookahead of two tokens\n\t\t// so that foot comments may be parsed in time of associating them\n\t\t// with the tokens that are parsed before them, and also for line\n\t\t// comments to be transformed into head comments in some edge cases.\n\t\tif parser.tokens_head < len(parser.tokens)-2 {\n\t\t\t// If a potential simple key is at the head position, we need to fetch\n\t\t\t// the next token to disambiguate it.\n\t\t\thead_tok_idx, ok := parser.simple_keys_by_tok[parser.tokens_parsed]\n\t\t\tif !ok {\n\t\t\t\tbreak\n\t\t\t} else if valid, ok := yaml_simple_key_is_valid(parser, &parser.simple_keys[head_tok_idx]); !ok {\n\t\t\t\treturn false\n\t\t\t} else if !valid {\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\t// Fetch the next token.\n\t\tif !yaml_parser_fetch_next_token(parser) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tparser.token_available = true\n\treturn true\n}\n\n// The dispatcher for token fetchers.\nfunc yaml_parser_fetch_next_token(parser *yaml_parser_t) (ok bool) {\n\t// Ensure that the buffer is initialized.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\n\t// Check if we just started scanning. Fetch STREAM-START then.\n\tif !parser.stream_start_produced {\n\t\treturn yaml_parser_fetch_stream_start(parser)\n\t}\n\n\tscan_mark := parser.mark\n\n\t// Eat whitespaces and comments until we reach the next token.\n\tif !yaml_parser_scan_to_next_token(parser) {\n\t\treturn false\n\t}\n\n\t// [Go] While unrolling indents, transform the head comments of prior\n\t// indentation levels observed after scan_start into foot comments at\n\t// the respective indexes.\n\n\t// Check the indentation level against the current column.\n\tif !yaml_parser_unroll_indent(parser, parser.mark.column, scan_mark) {\n\t\treturn false\n\t}\n\n\t// Ensure that the buffer contains at least 4 characters. 4 is the length\n\t// of the longest indicators ('--- ' and '... ').\n\tif parser.unread < 4 && !yaml_parser_update_buffer(parser, 4) {\n\t\treturn false\n\t}\n\n\t// Is it the end of the stream?\n\tif is_z(parser.buffer, parser.buffer_pos) {\n\t\treturn yaml_parser_fetch_stream_end(parser)\n\t}\n\n\t// Is it a directive?\n\tif parser.mark.column == 0 && parser.buffer[parser.buffer_pos] == '%' {\n\t\treturn yaml_parser_fetch_directive(parser)\n\t}\n\n\tbuf := parser.buffer\n\tpos := parser.buffer_pos\n\n\t// Is it the document start indicator?\n\tif parser.mark.column == 0 && buf[pos] == '-' && buf[pos+1] == '-' && buf[pos+2] == '-' && is_blankz(buf, pos+3) {\n\t\treturn yaml_parser_fetch_document_indicator(parser, yaml_DOCUMENT_START_TOKEN)\n\t}\n\n\t// Is it the document end indicator?\n\tif parser.mark.column == 0 && buf[pos] == '.' && buf[pos+1] == '.' && buf[pos+2] == '.' && is_blankz(buf, pos+3) {\n\t\treturn yaml_parser_fetch_document_indicator(parser, yaml_DOCUMENT_END_TOKEN)\n\t}\n\n\tcomment_mark := parser.mark\n\tif len(parser.tokens) > 0 && (parser.flow_level == 0 && buf[pos] == ':' || parser.flow_level > 0 && buf[pos] == ',') {\n\t\t// Associate any following comments with the prior token.\n\t\tcomment_mark = parser.tokens[len(parser.tokens)-1].start_mark\n\t}\n\tdefer func() {\n\t\tif !ok {\n\t\t\treturn\n\t\t}\n\t\tif len(parser.tokens) > 0 && parser.tokens[len(parser.tokens)-1].typ == yaml_BLOCK_ENTRY_TOKEN {\n\t\t\t// Sequence indicators alone have no line comments. It becomes\n\t\t\t// a head comment for whatever follows.\n\t\t\treturn\n\t\t}\n\t\tif !yaml_parser_scan_line_comment(parser, comment_mark) {\n\t\t\tok = false\n\t\t\treturn\n\t\t}\n\t}()\n\n\t// Is it the flow sequence start indicator?\n\tif buf[pos] == '[' {\n\t\treturn yaml_parser_fetch_flow_collection_start(parser, yaml_FLOW_SEQUENCE_START_TOKEN)\n\t}\n\n\t// Is it the flow mapping start indicator?\n\tif parser.buffer[parser.buffer_pos] == '{' {\n\t\treturn yaml_parser_fetch_flow_collection_start(parser, yaml_FLOW_MAPPING_START_TOKEN)\n\t}\n\n\t// Is it the flow sequence end indicator?\n\tif parser.buffer[parser.buffer_pos] == ']' {\n\t\treturn yaml_parser_fetch_flow_collection_end(parser,\n\t\t\tyaml_FLOW_SEQUENCE_END_TOKEN)\n\t}\n\n\t// Is it the flow mapping end indicator?\n\tif parser.buffer[parser.buffer_pos] == '}' {\n\t\treturn yaml_parser_fetch_flow_collection_end(parser,\n\t\t\tyaml_FLOW_MAPPING_END_TOKEN)\n\t}\n\n\t// Is it the flow entry indicator?\n\tif parser.buffer[parser.buffer_pos] == ',' {\n\t\treturn yaml_parser_fetch_flow_entry(parser)\n\t}\n\n\t// Is it the block entry indicator?\n\tif parser.buffer[parser.buffer_pos] == '-' && is_blankz(parser.buffer, parser.buffer_pos+1) {\n\t\treturn yaml_parser_fetch_block_entry(parser)\n\t}\n\n\t// Is it the key indicator?\n\tif parser.buffer[parser.buffer_pos] == '?' && (parser.flow_level > 0 || is_blankz(parser.buffer, parser.buffer_pos+1)) {\n\t\treturn yaml_parser_fetch_key(parser)\n\t}\n\n\t// Is it the value indicator?\n\tif parser.buffer[parser.buffer_pos] == ':' && (parser.flow_level > 0 || is_blankz(parser.buffer, parser.buffer_pos+1)) {\n\t\treturn yaml_parser_fetch_value(parser)\n\t}\n\n\t// Is it an alias?\n\tif parser.buffer[parser.buffer_pos] == '*' {\n\t\treturn yaml_parser_fetch_anchor(parser, yaml_ALIAS_TOKEN)\n\t}\n\n\t// Is it an anchor?\n\tif parser.buffer[parser.buffer_pos] == '&' {\n\t\treturn yaml_parser_fetch_anchor(parser, yaml_ANCHOR_TOKEN)\n\t}\n\n\t// Is it a tag?\n\tif parser.buffer[parser.buffer_pos] == '!' {\n\t\treturn yaml_parser_fetch_tag(parser)\n\t}\n\n\t// Is it a literal scalar?\n\tif parser.buffer[parser.buffer_pos] == '|' && parser.flow_level == 0 {\n\t\treturn yaml_parser_fetch_block_scalar(parser, true)\n\t}\n\n\t// Is it a folded scalar?\n\tif parser.buffer[parser.buffer_pos] == '>' && parser.flow_level == 0 {\n\t\treturn yaml_parser_fetch_block_scalar(parser, false)\n\t}\n\n\t// Is it a single-quoted scalar?\n\tif parser.buffer[parser.buffer_pos] == '\\'' {\n\t\treturn yaml_parser_fetch_flow_scalar(parser, true)\n\t}\n\n\t// Is it a double-quoted scalar?\n\tif parser.buffer[parser.buffer_pos] == '\"' {\n\t\treturn yaml_parser_fetch_flow_scalar(parser, false)\n\t}\n\n\t// Is it a plain scalar?\n\t//\n\t// A plain scalar may start with any non-blank characters except\n\t//\n\t// '-', '?', ':', ',', '[', ']', '{', '}',\n\t// '#', '&', '*', '!', '|', '>', '\\'', '\\\"',\n\t// '%', '@', '`'.\n\t//\n\t// In the block context (and, for the '-' indicator, in the flow context\n\t// too), it may also start with the characters\n\t//\n\t// '-', '?', ':'\n\t//\n\t// if it is followed by a non-space character.\n\t//\n\t// The last rule is more restrictive than the specification requires.\n\t// [Go] TODO Make this logic more reasonable.\n\t//switch parser.buffer[parser.buffer_pos] {\n\t//case '-', '?', ':', ',', '?', '-', ',', ':', ']', '[', '}', '{', '&', '#', '!', '*', '>', '|', '\"', '\\'', '@', '%', '-', '`':\n\t//}\n\tif !(is_blankz(parser.buffer, parser.buffer_pos) || parser.buffer[parser.buffer_pos] == '-' ||\n\t\tparser.buffer[parser.buffer_pos] == '?' || parser.buffer[parser.buffer_pos] == ':' ||\n\t\tparser.buffer[parser.buffer_pos] == ',' || parser.buffer[parser.buffer_pos] == '[' ||\n\t\tparser.buffer[parser.buffer_pos] == ']' || parser.buffer[parser.buffer_pos] == '{' ||\n\t\tparser.buffer[parser.buffer_pos] == '}' || parser.buffer[parser.buffer_pos] == '#' ||\n\t\tparser.buffer[parser.buffer_pos] == '&' || parser.buffer[parser.buffer_pos] == '*' ||\n\t\tparser.buffer[parser.buffer_pos] == '!' || parser.buffer[parser.buffer_pos] == '|' ||\n\t\tparser.buffer[parser.buffer_pos] == '>' || parser.buffer[parser.buffer_pos] == '\\'' ||\n\t\tparser.buffer[parser.buffer_pos] == '\"' || parser.buffer[parser.buffer_pos] == '%' ||\n\t\tparser.buffer[parser.buffer_pos] == '@' || parser.buffer[parser.buffer_pos] == '`') ||\n\t\t(parser.buffer[parser.buffer_pos] == '-' && !is_blank(parser.buffer, parser.buffer_pos+1)) ||\n\t\t(parser.flow_level == 0 &&\n\t\t\t(parser.buffer[parser.buffer_pos] == '?' || parser.buffer[parser.buffer_pos] == ':') &&\n\t\t\t!is_blankz(parser.buffer, parser.buffer_pos+1)) {\n\t\treturn yaml_parser_fetch_plain_scalar(parser)\n\t}\n\n\t// If we don't determine the token type so far, it is an error.\n\treturn yaml_parser_set_scanner_error(parser,\n\t\t\"while scanning for the next token\", parser.mark,\n\t\t\"found character that cannot start any token\")\n}\n\nfunc yaml_simple_key_is_valid(parser *yaml_parser_t, simple_key *yaml_simple_key_t) (valid, ok bool) {\n\tif !simple_key.possible {\n\t\treturn false, true\n\t}\n\n\t// The 1.2 specification says:\n\t//\n\t// \"If the ? indicator is omitted, parsing needs to see past the\n\t// implicit key to recognize it as such. To limit the amount of\n\t// lookahead required, the “:” indicator must appear at most 1024\n\t// Unicode characters beyond the start of the key. In addition, the key\n\t// is restricted to a single line.\"\n\t//\n\tif simple_key.mark.line < parser.mark.line || simple_key.mark.index+1024 < parser.mark.index {\n\t\t// Check if the potential simple key to be removed is required.\n\t\tif simple_key.required {\n\t\t\treturn false, yaml_parser_set_scanner_error(parser,\n\t\t\t\t\"while scanning a simple key\", simple_key.mark,\n\t\t\t\t\"could not find expected ':'\")\n\t\t}\n\t\tsimple_key.possible = false\n\t\treturn false, true\n\t}\n\treturn true, true\n}\n\n// Check if a simple key may start at the current position and add it if\n// needed.\nfunc yaml_parser_save_simple_key(parser *yaml_parser_t) bool {\n\t// A simple key is required at the current position if the scanner is in\n\t// the block context and the current column coincides with the indentation\n\t// level.\n\n\trequired := parser.flow_level == 0 && parser.indent == parser.mark.column\n\n\t//\n\t// If the current position may start a simple key, save it.\n\t//\n\tif parser.simple_key_allowed {\n\t\tsimple_key := yaml_simple_key_t{\n\t\t\tpossible: true,\n\t\t\trequired: required,\n\t\t\ttoken_number: parser.tokens_parsed + (len(parser.tokens) - parser.tokens_head),\n\t\t\tmark: parser.mark,\n\t\t}\n\n\t\tif !yaml_parser_remove_simple_key(parser) {\n\t\t\treturn false\n\t\t}\n\t\tparser.simple_keys[len(parser.simple_keys)-1] = simple_key\n\t\tparser.simple_keys_by_tok[simple_key.token_number] = len(parser.simple_keys) - 1\n\t}\n\treturn true\n}\n\n// Remove a potential simple key at the current flow level.\nfunc yaml_parser_remove_simple_key(parser *yaml_parser_t) bool {\n\ti := len(parser.simple_keys) - 1\n\tif parser.simple_keys[i].possible {\n\t\t// If the key is required, it is an error.\n\t\tif parser.simple_keys[i].required {\n\t\t\treturn yaml_parser_set_scanner_error(parser,\n\t\t\t\t\"while scanning a simple key\", parser.simple_keys[i].mark,\n\t\t\t\t\"could not find expected ':'\")\n\t\t}\n\t\t// Remove the key from the stack.\n\t\tparser.simple_keys[i].possible = false\n\t\tdelete(parser.simple_keys_by_tok, parser.simple_keys[i].token_number)\n\t}\n\treturn true\n}\n\n// max_flow_level limits the flow_level\nconst max_flow_level = 10000\n\n// Increase the flow level and resize the simple key list if needed.\nfunc yaml_parser_increase_flow_level(parser *yaml_parser_t) bool {\n\t// Reset the simple key on the next level.\n\tparser.simple_keys = append(parser.simple_keys, yaml_simple_key_t{\n\t\tpossible: false,\n\t\trequired: false,\n\t\ttoken_number: parser.tokens_parsed + (len(parser.tokens) - parser.tokens_head),\n\t\tmark: parser.mark,\n\t})\n\n\t// Increase the flow level.\n\tparser.flow_level++\n\tif parser.flow_level > max_flow_level {\n\t\treturn yaml_parser_set_scanner_error(parser,\n\t\t\t\"while increasing flow level\", parser.simple_keys[len(parser.simple_keys)-1].mark,\n\t\t\tfmt.Sprintf(\"exceeded max depth of %d\", max_flow_level))\n\t}\n\treturn true\n}\n\n// Decrease the flow level.\nfunc yaml_parser_decrease_flow_level(parser *yaml_parser_t) bool {\n\tif parser.flow_level > 0 {\n\t\tparser.flow_level--\n\t\tlast := len(parser.simple_keys) - 1\n\t\tdelete(parser.simple_keys_by_tok, parser.simple_keys[last].token_number)\n\t\tparser.simple_keys = parser.simple_keys[:last]\n\t}\n\treturn true\n}\n\n// max_indents limits the indents stack size\nconst max_indents = 10000\n\n// Push the current indentation level to the stack and set the new level\n// the current column is greater than the indentation level. In this case,\n// append or insert the specified token into the token queue.\nfunc yaml_parser_roll_indent(parser *yaml_parser_t, column, number int, typ yaml_token_type_t, mark yaml_mark_t) bool {\n\t// In the flow context, do nothing.\n\tif parser.flow_level > 0 {\n\t\treturn true\n\t}\n\n\tif parser.indent < column {\n\t\t// Push the current indentation level to the stack and set the new\n\t\t// indentation level.\n\t\tparser.indents = append(parser.indents, parser.indent)\n\t\tparser.indent = column\n\t\tif len(parser.indents) > max_indents {\n\t\t\treturn yaml_parser_set_scanner_error(parser,\n\t\t\t\t\"while increasing indent level\", parser.simple_keys[len(parser.simple_keys)-1].mark,\n\t\t\t\tfmt.Sprintf(\"exceeded max depth of %d\", max_indents))\n\t\t}\n\n\t\t// Create a token and insert it into the queue.\n\t\ttoken := yaml_token_t{\n\t\t\ttyp: typ,\n\t\t\tstart_mark: mark,\n\t\t\tend_mark: mark,\n\t\t}\n\t\tif number > -1 {\n\t\t\tnumber -= parser.tokens_parsed\n\t\t}\n\t\tyaml_insert_token(parser, number, &token)\n\t}\n\treturn true\n}\n\n// Pop indentation levels from the indents stack until the current level\n// becomes less or equal to the column. For each indentation level, append\n// the BLOCK-END token.\nfunc yaml_parser_unroll_indent(parser *yaml_parser_t, column int, scan_mark yaml_mark_t) bool {\n\t// In the flow context, do nothing.\n\tif parser.flow_level > 0 {\n\t\treturn true\n\t}\n\n\tblock_mark := scan_mark\n\tblock_mark.index--\n\n\t// Loop through the indentation levels in the stack.\n\tfor parser.indent > column {\n\n\t\t// [Go] Reposition the end token before potential following\n\t\t// foot comments of parent blocks. For that, search\n\t\t// backwards for recent comments that were at the same\n\t\t// indent as the block that is ending now.\n\t\tstop_index := block_mark.index\n\t\tfor i := len(parser.comments) - 1; i >= 0; i-- {\n\t\t\tcomment := &parser.comments[i]\n\n\t\t\tif comment.end_mark.index < stop_index {\n\t\t\t\t// Don't go back beyond the start of the comment/whitespace scan, unless column < 0.\n\t\t\t\t// If requested indent column is < 0, then the document is over and everything else\n\t\t\t\t// is a foot anyway.\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tif comment.start_mark.column == parser.indent+1 {\n\t\t\t\t// This is a good match. But maybe there's a former comment\n\t\t\t\t// at that same indent level, so keep searching.\n\t\t\t\tblock_mark = comment.start_mark\n\t\t\t}\n\n\t\t\t// While the end of the former comment matches with\n\t\t\t// the start of the following one, we know there's\n\t\t\t// nothing in between and scanning is still safe.\n\t\t\tstop_index = comment.scan_mark.index\n\t\t}\n\n\t\t// Create a token and append it to the queue.\n\t\ttoken := yaml_token_t{\n\t\t\ttyp: yaml_BLOCK_END_TOKEN,\n\t\t\tstart_mark: block_mark,\n\t\t\tend_mark: block_mark,\n\t\t}\n\t\tyaml_insert_token(parser, -1, &token)\n\n\t\t// Pop the indentation level.\n\t\tparser.indent = parser.indents[len(parser.indents)-1]\n\t\tparser.indents = parser.indents[:len(parser.indents)-1]\n\t}\n\treturn true\n}\n\n// Initialize the scanner and produce the STREAM-START token.\nfunc yaml_parser_fetch_stream_start(parser *yaml_parser_t) bool {\n\n\t// Set the initial indentation.\n\tparser.indent = -1\n\n\t// Initialize the simple key stack.\n\tparser.simple_keys = append(parser.simple_keys, yaml_simple_key_t{})\n\n\tparser.simple_keys_by_tok = make(map[int]int)\n\n\t// A simple key is allowed at the beginning of the stream.\n\tparser.simple_key_allowed = true\n\n\t// We have started.\n\tparser.stream_start_produced = true\n\n\t// Create the STREAM-START token and append it to the queue.\n\ttoken := yaml_token_t{\n\t\ttyp: yaml_STREAM_START_TOKEN,\n\t\tstart_mark: parser.mark,\n\t\tend_mark: parser.mark,\n\t\tencoding: parser.encoding,\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the STREAM-END token and shut down the scanner.\nfunc yaml_parser_fetch_stream_end(parser *yaml_parser_t) bool {\n\n\t// Force new line.\n\tif parser.mark.column != 0 {\n\t\tparser.mark.column = 0\n\t\tparser.mark.line++\n\t}\n\n\t// Reset the indentation level.\n\tif !yaml_parser_unroll_indent(parser, -1, parser.mark) {\n\t\treturn false\n\t}\n\n\t// Reset simple keys.\n\tif !yaml_parser_remove_simple_key(parser) {\n\t\treturn false\n\t}\n\n\tparser.simple_key_allowed = false\n\n\t// Create the STREAM-END token and append it to the queue.\n\ttoken := yaml_token_t{\n\t\ttyp: yaml_STREAM_END_TOKEN,\n\t\tstart_mark: parser.mark,\n\t\tend_mark: parser.mark,\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce a VERSION-DIRECTIVE or TAG-DIRECTIVE token.\nfunc yaml_parser_fetch_directive(parser *yaml_parser_t) bool {\n\t// Reset the indentation level.\n\tif !yaml_parser_unroll_indent(parser, -1, parser.mark) {\n\t\treturn false\n\t}\n\n\t// Reset simple keys.\n\tif !yaml_parser_remove_simple_key(parser) {\n\t\treturn false\n\t}\n\n\tparser.simple_key_allowed = false\n\n\t// Create the YAML-DIRECTIVE or TAG-DIRECTIVE token.\n\ttoken := yaml_token_t{}\n\tif !yaml_parser_scan_directive(parser, &token) {\n\t\treturn false\n\t}\n\t// Append the token to the queue.\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the DOCUMENT-START or DOCUMENT-END token.\nfunc yaml_parser_fetch_document_indicator(parser *yaml_parser_t, typ yaml_token_type_t) bool {\n\t// Reset the indentation level.\n\tif !yaml_parser_unroll_indent(parser, -1, parser.mark) {\n\t\treturn false\n\t}\n\n\t// Reset simple keys.\n\tif !yaml_parser_remove_simple_key(parser) {\n\t\treturn false\n\t}\n\n\tparser.simple_key_allowed = false\n\n\t// Consume the token.\n\tstart_mark := parser.mark\n\n\tskip(parser)\n\tskip(parser)\n\tskip(parser)\n\n\tend_mark := parser.mark\n\n\t// Create the DOCUMENT-START or DOCUMENT-END token.\n\ttoken := yaml_token_t{\n\t\ttyp: typ,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t}\n\t// Append the token to the queue.\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the FLOW-SEQUENCE-START or FLOW-MAPPING-START token.\nfunc yaml_parser_fetch_flow_collection_start(parser *yaml_parser_t, typ yaml_token_type_t) bool {\n\n\t// The indicators '[' and '{' may start a simple key.\n\tif !yaml_parser_save_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// Increase the flow level.\n\tif !yaml_parser_increase_flow_level(parser) {\n\t\treturn false\n\t}\n\n\t// A simple key may follow the indicators '[' and '{'.\n\tparser.simple_key_allowed = true\n\n\t// Consume the token.\n\tstart_mark := parser.mark\n\tskip(parser)\n\tend_mark := parser.mark\n\n\t// Create the FLOW-SEQUENCE-START of FLOW-MAPPING-START token.\n\ttoken := yaml_token_t{\n\t\ttyp: typ,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t}\n\t// Append the token to the queue.\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the FLOW-SEQUENCE-END or FLOW-MAPPING-END token.\nfunc yaml_parser_fetch_flow_collection_end(parser *yaml_parser_t, typ yaml_token_type_t) bool {\n\t// Reset any potential simple key on the current flow level.\n\tif !yaml_parser_remove_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// Decrease the flow level.\n\tif !yaml_parser_decrease_flow_level(parser) {\n\t\treturn false\n\t}\n\n\t// No simple keys after the indicators ']' and '}'.\n\tparser.simple_key_allowed = false\n\n\t// Consume the token.\n\n\tstart_mark := parser.mark\n\tskip(parser)\n\tend_mark := parser.mark\n\n\t// Create the FLOW-SEQUENCE-END of FLOW-MAPPING-END token.\n\ttoken := yaml_token_t{\n\t\ttyp: typ,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t}\n\t// Append the token to the queue.\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the FLOW-ENTRY token.\nfunc yaml_parser_fetch_flow_entry(parser *yaml_parser_t) bool {\n\t// Reset any potential simple keys on the current flow level.\n\tif !yaml_parser_remove_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// Simple keys are allowed after ','.\n\tparser.simple_key_allowed = true\n\n\t// Consume the token.\n\tstart_mark := parser.mark\n\tskip(parser)\n\tend_mark := parser.mark\n\n\t// Create the FLOW-ENTRY token and append it to the queue.\n\ttoken := yaml_token_t{\n\t\ttyp: yaml_FLOW_ENTRY_TOKEN,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the BLOCK-ENTRY token.\nfunc yaml_parser_fetch_block_entry(parser *yaml_parser_t) bool {\n\t// Check if the scanner is in the block context.\n\tif parser.flow_level == 0 {\n\t\t// Check if we are allowed to start a new entry.\n\t\tif !parser.simple_key_allowed {\n\t\t\treturn yaml_parser_set_scanner_error(parser, \"\", parser.mark,\n\t\t\t\t\"block sequence entries are not allowed in this context\")\n\t\t}\n\t\t// Add the BLOCK-SEQUENCE-START token if needed.\n\t\tif !yaml_parser_roll_indent(parser, parser.mark.column, -1, yaml_BLOCK_SEQUENCE_START_TOKEN, parser.mark) {\n\t\t\treturn false\n\t\t}\n\t} else {\n\t\t// It is an error for the '-' indicator to occur in the flow context,\n\t\t// but we let the Parser detect and report about it because the Parser\n\t\t// is able to point to the context.\n\t}\n\n\t// Reset any potential simple keys on the current flow level.\n\tif !yaml_parser_remove_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// Simple keys are allowed after '-'.\n\tparser.simple_key_allowed = true\n\n\t// Consume the token.\n\tstart_mark := parser.mark\n\tskip(parser)\n\tend_mark := parser.mark\n\n\t// Create the BLOCK-ENTRY token and append it to the queue.\n\ttoken := yaml_token_t{\n\t\ttyp: yaml_BLOCK_ENTRY_TOKEN,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the KEY token.\nfunc yaml_parser_fetch_key(parser *yaml_parser_t) bool {\n\n\t// In the block context, additional checks are required.\n\tif parser.flow_level == 0 {\n\t\t// Check if we are allowed to start a new key (not nessesary simple).\n\t\tif !parser.simple_key_allowed {\n\t\t\treturn yaml_parser_set_scanner_error(parser, \"\", parser.mark,\n\t\t\t\t\"mapping keys are not allowed in this context\")\n\t\t}\n\t\t// Add the BLOCK-MAPPING-START token if needed.\n\t\tif !yaml_parser_roll_indent(parser, parser.mark.column, -1, yaml_BLOCK_MAPPING_START_TOKEN, parser.mark) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Reset any potential simple keys on the current flow level.\n\tif !yaml_parser_remove_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// Simple keys are allowed after '?' in the block context.\n\tparser.simple_key_allowed = parser.flow_level == 0\n\n\t// Consume the token.\n\tstart_mark := parser.mark\n\tskip(parser)\n\tend_mark := parser.mark\n\n\t// Create the KEY token and append it to the queue.\n\ttoken := yaml_token_t{\n\t\ttyp: yaml_KEY_TOKEN,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the VALUE token.\nfunc yaml_parser_fetch_value(parser *yaml_parser_t) bool {\n\n\tsimple_key := &parser.simple_keys[len(parser.simple_keys)-1]\n\n\t// Have we found a simple key?\n\tif valid, ok := yaml_simple_key_is_valid(parser, simple_key); !ok {\n\t\treturn false\n\n\t} else if valid {\n\n\t\t// Create the KEY token and insert it into the queue.\n\t\ttoken := yaml_token_t{\n\t\t\ttyp: yaml_KEY_TOKEN,\n\t\t\tstart_mark: simple_key.mark,\n\t\t\tend_mark: simple_key.mark,\n\t\t}\n\t\tyaml_insert_token(parser, simple_key.token_number-parser.tokens_parsed, &token)\n\n\t\t// In the block context, we may need to add the BLOCK-MAPPING-START token.\n\t\tif !yaml_parser_roll_indent(parser, simple_key.mark.column,\n\t\t\tsimple_key.token_number,\n\t\t\tyaml_BLOCK_MAPPING_START_TOKEN, simple_key.mark) {\n\t\t\treturn false\n\t\t}\n\n\t\t// Remove the simple key.\n\t\tsimple_key.possible = false\n\t\tdelete(parser.simple_keys_by_tok, simple_key.token_number)\n\n\t\t// A simple key cannot follow another simple key.\n\t\tparser.simple_key_allowed = false\n\n\t} else {\n\t\t// The ':' indicator follows a complex key.\n\n\t\t// In the block context, extra checks are required.\n\t\tif parser.flow_level == 0 {\n\n\t\t\t// Check if we are allowed to start a complex value.\n\t\t\tif !parser.simple_key_allowed {\n\t\t\t\treturn yaml_parser_set_scanner_error(parser, \"\", parser.mark,\n\t\t\t\t\t\"mapping values are not allowed in this context\")\n\t\t\t}\n\n\t\t\t// Add the BLOCK-MAPPING-START token if needed.\n\t\t\tif !yaml_parser_roll_indent(parser, parser.mark.column, -1, yaml_BLOCK_MAPPING_START_TOKEN, parser.mark) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\t// Simple keys after ':' are allowed in the block context.\n\t\tparser.simple_key_allowed = parser.flow_level == 0\n\t}\n\n\t// Consume the token.\n\tstart_mark := parser.mark\n\tskip(parser)\n\tend_mark := parser.mark\n\n\t// Create the VALUE token and append it to the queue.\n\ttoken := yaml_token_t{\n\t\ttyp: yaml_VALUE_TOKEN,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the ALIAS or ANCHOR token.\nfunc yaml_parser_fetch_anchor(parser *yaml_parser_t, typ yaml_token_type_t) bool {\n\t// An anchor or an alias could be a simple key.\n\tif !yaml_parser_save_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// A simple key cannot follow an anchor or an alias.\n\tparser.simple_key_allowed = false\n\n\t// Create the ALIAS or ANCHOR token and append it to the queue.\n\tvar token yaml_token_t\n\tif !yaml_parser_scan_anchor(parser, &token, typ) {\n\t\treturn false\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the TAG token.\nfunc yaml_parser_fetch_tag(parser *yaml_parser_t) bool {\n\t// A tag could be a simple key.\n\tif !yaml_parser_save_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// A simple key cannot follow a tag.\n\tparser.simple_key_allowed = false\n\n\t// Create the TAG token and append it to the queue.\n\tvar token yaml_token_t\n\tif !yaml_parser_scan_tag(parser, &token) {\n\t\treturn false\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the SCALAR(...,literal) or SCALAR(...,folded) tokens.\nfunc yaml_parser_fetch_block_scalar(parser *yaml_parser_t, literal bool) bool {\n\t// Remove any potential simple keys.\n\tif !yaml_parser_remove_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// A simple key may follow a block scalar.\n\tparser.simple_key_allowed = true\n\n\t// Create the SCALAR token and append it to the queue.\n\tvar token yaml_token_t\n\tif !yaml_parser_scan_block_scalar(parser, &token, literal) {\n\t\treturn false\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the SCALAR(...,single-quoted) or SCALAR(...,double-quoted) tokens.\nfunc yaml_parser_fetch_flow_scalar(parser *yaml_parser_t, single bool) bool {\n\t// A plain scalar could be a simple key.\n\tif !yaml_parser_save_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// A simple key cannot follow a flow scalar.\n\tparser.simple_key_allowed = false\n\n\t// Create the SCALAR token and append it to the queue.\n\tvar token yaml_token_t\n\tif !yaml_parser_scan_flow_scalar(parser, &token, single) {\n\t\treturn false\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Produce the SCALAR(...,plain) token.\nfunc yaml_parser_fetch_plain_scalar(parser *yaml_parser_t) bool {\n\t// A plain scalar could be a simple key.\n\tif !yaml_parser_save_simple_key(parser) {\n\t\treturn false\n\t}\n\n\t// A simple key cannot follow a flow scalar.\n\tparser.simple_key_allowed = false\n\n\t// Create the SCALAR token and append it to the queue.\n\tvar token yaml_token_t\n\tif !yaml_parser_scan_plain_scalar(parser, &token) {\n\t\treturn false\n\t}\n\tyaml_insert_token(parser, -1, &token)\n\treturn true\n}\n\n// Eat whitespaces and comments until the next token is found.\nfunc yaml_parser_scan_to_next_token(parser *yaml_parser_t) bool {\n\n\tscan_mark := parser.mark\n\n\t// Until the next token is not found.\n\tfor {\n\t\t// Allow the BOM mark to start a line.\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t\tif parser.mark.column == 0 && is_bom(parser.buffer, parser.buffer_pos) {\n\t\t\tskip(parser)\n\t\t}\n\n\t\t// Eat whitespaces.\n\t\t// Tabs are allowed:\n\t\t// - in the flow context\n\t\t// - in the block context, but not at the beginning of the line or\n\t\t// after '-', '?', or ':' (complex value).\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\n\t\tfor parser.buffer[parser.buffer_pos] == ' ' || ((parser.flow_level > 0 || !parser.simple_key_allowed) && parser.buffer[parser.buffer_pos] == '\\t') {\n\t\t\tskip(parser)\n\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\t// Check if we just had a line comment under a sequence entry that\n\t\t// looks more like a header to the following content. Similar to this:\n\t\t//\n\t\t// - # The comment\n\t\t// - Some data\n\t\t//\n\t\t// If so, transform the line comment to a head comment and reposition.\n\t\tif len(parser.comments) > 0 && len(parser.tokens) > 1 {\n\t\t\ttokenA := parser.tokens[len(parser.tokens)-2]\n\t\t\ttokenB := parser.tokens[len(parser.tokens)-1]\n\t\t\tcomment := &parser.comments[len(parser.comments)-1]\n\t\t\tif tokenA.typ == yaml_BLOCK_SEQUENCE_START_TOKEN && tokenB.typ == yaml_BLOCK_ENTRY_TOKEN && len(comment.line) > 0 && !is_break(parser.buffer, parser.buffer_pos) {\n\t\t\t\t// If it was in the prior line, reposition so it becomes a\n\t\t\t\t// header of the follow up token. Otherwise, keep it in place\n\t\t\t\t// so it becomes a header of the former.\n\t\t\t\tcomment.head = comment.line\n\t\t\t\tcomment.line = nil\n\t\t\t\tif comment.start_mark.line == parser.mark.line-1 {\n\t\t\t\t\tcomment.token_mark = parser.mark\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\t// Eat a comment until a line break.\n\t\tif parser.buffer[parser.buffer_pos] == '#' {\n\t\t\tif !yaml_parser_scan_comments(parser, scan_mark) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\t// If it is a line break, eat it.\n\t\tif is_break(parser.buffer, parser.buffer_pos) {\n\t\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tskip_line(parser)\n\n\t\t\t// In the block context, a new line may start a simple key.\n\t\t\tif parser.flow_level == 0 {\n\t\t\t\tparser.simple_key_allowed = true\n\t\t\t}\n\t\t} else {\n\t\t\tbreak // We have found a token.\n\t\t}\n\t}\n\n\treturn true\n}\n\n// Scan a YAML-DIRECTIVE or TAG-DIRECTIVE token.\n//\n// Scope:\n//\n//\t%YAML 1.1 # a comment \\n\n//\t^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n//\t%TAG !yaml! tag:yaml.org,2002: \\n\n//\t^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nfunc yaml_parser_scan_directive(parser *yaml_parser_t, token *yaml_token_t) bool {\n\t// Eat '%'.\n\tstart_mark := parser.mark\n\tskip(parser)\n\n\t// Scan the directive name.\n\tvar name []byte\n\tif !yaml_parser_scan_directive_name(parser, start_mark, &name) {\n\t\treturn false\n\t}\n\n\t// Is it a YAML directive?\n\tif bytes.Equal(name, []byte(\"YAML\")) {\n\t\t// Scan the VERSION directive value.\n\t\tvar major, minor int8\n\t\tif !yaml_parser_scan_version_directive_value(parser, start_mark, &major, &minor) {\n\t\t\treturn false\n\t\t}\n\t\tend_mark := parser.mark\n\n\t\t// Create a VERSION-DIRECTIVE token.\n\t\t*token = yaml_token_t{\n\t\t\ttyp: yaml_VERSION_DIRECTIVE_TOKEN,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tmajor: major,\n\t\t\tminor: minor,\n\t\t}\n\n\t\t// Is it a TAG directive?\n\t} else if bytes.Equal(name, []byte(\"TAG\")) {\n\t\t// Scan the TAG directive value.\n\t\tvar handle, prefix []byte\n\t\tif !yaml_parser_scan_tag_directive_value(parser, start_mark, &handle, &prefix) {\n\t\t\treturn false\n\t\t}\n\t\tend_mark := parser.mark\n\n\t\t// Create a TAG-DIRECTIVE token.\n\t\t*token = yaml_token_t{\n\t\t\ttyp: yaml_TAG_DIRECTIVE_TOKEN,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: end_mark,\n\t\t\tvalue: handle,\n\t\t\tprefix: prefix,\n\t\t}\n\n\t\t// Unknown directive.\n\t} else {\n\t\tyaml_parser_set_scanner_error(parser, \"while scanning a directive\",\n\t\t\tstart_mark, \"found unknown directive name\")\n\t\treturn false\n\t}\n\n\t// Eat the rest of the line including any comments.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\n\tfor is_blank(parser.buffer, parser.buffer_pos) {\n\t\tskip(parser)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tif parser.buffer[parser.buffer_pos] == '#' {\n\t\t// [Go] Discard this inline comment for the time being.\n\t\t//if !yaml_parser_scan_line_comment(parser, start_mark) {\n\t\t//\treturn false\n\t\t//}\n\t\tfor !is_breakz(parser.buffer, parser.buffer_pos) {\n\t\t\tskip(parser)\n\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t}\n\n\t// Check if we are at the end of the line.\n\tif !is_breakz(parser.buffer, parser.buffer_pos) {\n\t\tyaml_parser_set_scanner_error(parser, \"while scanning a directive\",\n\t\t\tstart_mark, \"did not find expected comment or line break\")\n\t\treturn false\n\t}\n\n\t// Eat a line break.\n\tif is_break(parser.buffer, parser.buffer_pos) {\n\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\treturn false\n\t\t}\n\t\tskip_line(parser)\n\t}\n\n\treturn true\n}\n\n// Scan the directive name.\n//\n// Scope:\n//\n//\t%YAML 1.1 # a comment \\n\n//\t ^^^^\n//\t%TAG !yaml! tag:yaml.org,2002: \\n\n//\t ^^^\nfunc yaml_parser_scan_directive_name(parser *yaml_parser_t, start_mark yaml_mark_t, name *[]byte) bool {\n\t// Consume the directive name.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\n\tvar s []byte\n\tfor is_alpha(parser.buffer, parser.buffer_pos) {\n\t\ts = read(parser, s)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Check if the name is empty.\n\tif len(s) == 0 {\n\t\tyaml_parser_set_scanner_error(parser, \"while scanning a directive\",\n\t\t\tstart_mark, \"could not find expected directive name\")\n\t\treturn false\n\t}\n\n\t// Check for an blank character after the name.\n\tif !is_blankz(parser.buffer, parser.buffer_pos) {\n\t\tyaml_parser_set_scanner_error(parser, \"while scanning a directive\",\n\t\t\tstart_mark, \"found unexpected non-alphabetical character\")\n\t\treturn false\n\t}\n\t*name = s\n\treturn true\n}\n\n// Scan the value of VERSION-DIRECTIVE.\n//\n// Scope:\n//\n//\t%YAML 1.1 # a comment \\n\n//\t ^^^^^^\nfunc yaml_parser_scan_version_directive_value(parser *yaml_parser_t, start_mark yaml_mark_t, major, minor *int8) bool {\n\t// Eat whitespaces.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tfor is_blank(parser.buffer, parser.buffer_pos) {\n\t\tskip(parser)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Consume the major version number.\n\tif !yaml_parser_scan_version_directive_number(parser, start_mark, major) {\n\t\treturn false\n\t}\n\n\t// Eat '.'.\n\tif parser.buffer[parser.buffer_pos] != '.' {\n\t\treturn yaml_parser_set_scanner_error(parser, \"while scanning a %YAML directive\",\n\t\t\tstart_mark, \"did not find expected digit or '.' character\")\n\t}\n\n\tskip(parser)\n\n\t// Consume the minor version number.\n\tif !yaml_parser_scan_version_directive_number(parser, start_mark, minor) {\n\t\treturn false\n\t}\n\treturn true\n}\n\nconst max_number_length = 2\n\n// Scan the version number of VERSION-DIRECTIVE.\n//\n// Scope:\n//\n//\t%YAML 1.1 # a comment \\n\n//\t ^\n//\t%YAML 1.1 # a comment \\n\n//\t ^\nfunc yaml_parser_scan_version_directive_number(parser *yaml_parser_t, start_mark yaml_mark_t, number *int8) bool {\n\n\t// Repeat while the next character is digit.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tvar value, length int8\n\tfor is_digit(parser.buffer, parser.buffer_pos) {\n\t\t// Check if the number is too long.\n\t\tlength++\n\t\tif length > max_number_length {\n\t\t\treturn yaml_parser_set_scanner_error(parser, \"while scanning a %YAML directive\",\n\t\t\t\tstart_mark, \"found extremely long version number\")\n\t\t}\n\t\tvalue = value*10 + int8(as_digit(parser.buffer, parser.buffer_pos))\n\t\tskip(parser)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Check if the number was present.\n\tif length == 0 {\n\t\treturn yaml_parser_set_scanner_error(parser, \"while scanning a %YAML directive\",\n\t\t\tstart_mark, \"did not find expected version number\")\n\t}\n\t*number = value\n\treturn true\n}\n\n// Scan the value of a TAG-DIRECTIVE token.\n//\n// Scope:\n//\n//\t%TAG !yaml! tag:yaml.org,2002: \\n\n//\t ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nfunc yaml_parser_scan_tag_directive_value(parser *yaml_parser_t, start_mark yaml_mark_t, handle, prefix *[]byte) bool {\n\tvar handle_value, prefix_value []byte\n\n\t// Eat whitespaces.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\n\tfor is_blank(parser.buffer, parser.buffer_pos) {\n\t\tskip(parser)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Scan a handle.\n\tif !yaml_parser_scan_tag_handle(parser, true, start_mark, &handle_value) {\n\t\treturn false\n\t}\n\n\t// Expect a whitespace.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tif !is_blank(parser.buffer, parser.buffer_pos) {\n\t\tyaml_parser_set_scanner_error(parser, \"while scanning a %TAG directive\",\n\t\t\tstart_mark, \"did not find expected whitespace\")\n\t\treturn false\n\t}\n\n\t// Eat whitespaces.\n\tfor is_blank(parser.buffer, parser.buffer_pos) {\n\t\tskip(parser)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Scan a prefix.\n\tif !yaml_parser_scan_tag_uri(parser, true, nil, start_mark, &prefix_value) {\n\t\treturn false\n\t}\n\n\t// Expect a whitespace or line break.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tif !is_blankz(parser.buffer, parser.buffer_pos) {\n\t\tyaml_parser_set_scanner_error(parser, \"while scanning a %TAG directive\",\n\t\t\tstart_mark, \"did not find expected whitespace or line break\")\n\t\treturn false\n\t}\n\n\t*handle = handle_value\n\t*prefix = prefix_value\n\treturn true\n}\n\nfunc yaml_parser_scan_anchor(parser *yaml_parser_t, token *yaml_token_t, typ yaml_token_type_t) bool {\n\tvar s []byte\n\n\t// Eat the indicator character.\n\tstart_mark := parser.mark\n\tskip(parser)\n\n\t// Consume the value.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\n\tfor is_alpha(parser.buffer, parser.buffer_pos) {\n\t\ts = read(parser, s)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\tend_mark := parser.mark\n\n\t/*\n\t * Check if length of the anchor is greater than 0 and it is followed by\n\t * a whitespace character or one of the indicators:\n\t *\n\t * '?', ':', ',', ']', '}', '%', '@', '`'.\n\t */\n\n\tif len(s) == 0 ||\n\t\t!(is_blankz(parser.buffer, parser.buffer_pos) || parser.buffer[parser.buffer_pos] == '?' ||\n\t\t\tparser.buffer[parser.buffer_pos] == ':' || parser.buffer[parser.buffer_pos] == ',' ||\n\t\t\tparser.buffer[parser.buffer_pos] == ']' || parser.buffer[parser.buffer_pos] == '}' ||\n\t\t\tparser.buffer[parser.buffer_pos] == '%' || parser.buffer[parser.buffer_pos] == '@' ||\n\t\t\tparser.buffer[parser.buffer_pos] == '`') {\n\t\tcontext := \"while scanning an alias\"\n\t\tif typ == yaml_ANCHOR_TOKEN {\n\t\t\tcontext = \"while scanning an anchor\"\n\t\t}\n\t\tyaml_parser_set_scanner_error(parser, context, start_mark,\n\t\t\t\"did not find expected alphabetic or numeric character\")\n\t\treturn false\n\t}\n\n\t// Create a token.\n\t*token = yaml_token_t{\n\t\ttyp: typ,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t\tvalue: s,\n\t}\n\n\treturn true\n}\n\n/*\n * Scan a TAG token.\n */\n\nfunc yaml_parser_scan_tag(parser *yaml_parser_t, token *yaml_token_t) bool {\n\tvar handle, suffix []byte\n\n\tstart_mark := parser.mark\n\n\t// Check if the tag is in the canonical form.\n\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\treturn false\n\t}\n\n\tif parser.buffer[parser.buffer_pos+1] == '<' {\n\t\t// Keep the handle as ''\n\n\t\t// Eat '!<'\n\t\tskip(parser)\n\t\tskip(parser)\n\n\t\t// Consume the tag value.\n\t\tif !yaml_parser_scan_tag_uri(parser, false, nil, start_mark, &suffix) {\n\t\t\treturn false\n\t\t}\n\n\t\t// Check for '>' and eat it.\n\t\tif parser.buffer[parser.buffer_pos] != '>' {\n\t\t\tyaml_parser_set_scanner_error(parser, \"while scanning a tag\",\n\t\t\t\tstart_mark, \"did not find the expected '>'\")\n\t\t\treturn false\n\t\t}\n\n\t\tskip(parser)\n\t} else {\n\t\t// The tag has either the '!suffix' or the '!handle!suffix' form.\n\n\t\t// First, try to scan a handle.\n\t\tif !yaml_parser_scan_tag_handle(parser, false, start_mark, &handle) {\n\t\t\treturn false\n\t\t}\n\n\t\t// Check if it is, indeed, handle.\n\t\tif handle[0] == '!' && len(handle) > 1 && handle[len(handle)-1] == '!' {\n\t\t\t// Scan the suffix now.\n\t\t\tif !yaml_parser_scan_tag_uri(parser, false, nil, start_mark, &suffix) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t} else {\n\t\t\t// It wasn't a handle after all. Scan the rest of the tag.\n\t\t\tif !yaml_parser_scan_tag_uri(parser, false, handle, start_mark, &suffix) {\n\t\t\t\treturn false\n\t\t\t}\n\n\t\t\t// Set the handle to '!'.\n\t\t\thandle = []byte{'!'}\n\n\t\t\t// A special case: the '!' tag. Set the handle to '' and the\n\t\t\t// suffix to '!'.\n\t\t\tif len(suffix) == 0 {\n\t\t\t\thandle, suffix = suffix, handle\n\t\t\t}\n\t\t}\n\t}\n\n\t// Check the character which ends the tag.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tif !is_blankz(parser.buffer, parser.buffer_pos) {\n\t\tyaml_parser_set_scanner_error(parser, \"while scanning a tag\",\n\t\t\tstart_mark, \"did not find expected whitespace or line break\")\n\t\treturn false\n\t}\n\n\tend_mark := parser.mark\n\n\t// Create a token.\n\t*token = yaml_token_t{\n\t\ttyp: yaml_TAG_TOKEN,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t\tvalue: handle,\n\t\tsuffix: suffix,\n\t}\n\treturn true\n}\n\n// Scan a tag handle.\nfunc yaml_parser_scan_tag_handle(parser *yaml_parser_t, directive bool, start_mark yaml_mark_t, handle *[]byte) bool {\n\t// Check the initial '!' character.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tif parser.buffer[parser.buffer_pos] != '!' {\n\t\tyaml_parser_set_scanner_tag_error(parser, directive,\n\t\t\tstart_mark, \"did not find expected '!'\")\n\t\treturn false\n\t}\n\n\tvar s []byte\n\n\t// Copy the '!' character.\n\ts = read(parser, s)\n\n\t// Copy all subsequent alphabetical and numerical characters.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tfor is_alpha(parser.buffer, parser.buffer_pos) {\n\t\ts = read(parser, s)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Check if the trailing character is '!' and copy it.\n\tif parser.buffer[parser.buffer_pos] == '!' {\n\t\ts = read(parser, s)\n\t} else {\n\t\t// It's either the '!' tag or not really a tag handle. If it's a %TAG\n\t\t// directive, it's an error. If it's a tag token, it must be a part of URI.\n\t\tif directive && string(s) != \"!\" {\n\t\t\tyaml_parser_set_scanner_tag_error(parser, directive,\n\t\t\t\tstart_mark, \"did not find expected '!'\")\n\t\t\treturn false\n\t\t}\n\t}\n\n\t*handle = s\n\treturn true\n}\n\n// Scan a tag.\nfunc yaml_parser_scan_tag_uri(parser *yaml_parser_t, directive bool, head []byte, start_mark yaml_mark_t, uri *[]byte) bool {\n\t//size_t length = head ? strlen((char *)head) : 0\n\tvar s []byte\n\thasTag := len(head) > 0\n\n\t// Copy the head if needed.\n\t//\n\t// Note that we don't copy the leading '!' character.\n\tif len(head) > 1 {\n\t\ts = append(s, head[1:]...)\n\t}\n\n\t// Scan the tag.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\n\t// The set of characters that may appear in URI is as follows:\n\t//\n\t// '0'-'9', 'A'-'Z', 'a'-'z', '_', '-', ';', '/', '?', ':', '@', '&',\n\t// '=', '+', '$', ',', '.', '!', '~', '*', '\\'', '(', ')', '[', ']',\n\t// '%'.\n\t// [Go] TODO Convert this into more reasonable logic.\n\tfor is_alpha(parser.buffer, parser.buffer_pos) || parser.buffer[parser.buffer_pos] == ';' ||\n\t\tparser.buffer[parser.buffer_pos] == '/' || parser.buffer[parser.buffer_pos] == '?' ||\n\t\tparser.buffer[parser.buffer_pos] == ':' || parser.buffer[parser.buffer_pos] == '@' ||\n\t\tparser.buffer[parser.buffer_pos] == '&' || parser.buffer[parser.buffer_pos] == '=' ||\n\t\tparser.buffer[parser.buffer_pos] == '+' || parser.buffer[parser.buffer_pos] == '$' ||\n\t\tparser.buffer[parser.buffer_pos] == ',' || parser.buffer[parser.buffer_pos] == '.' ||\n\t\tparser.buffer[parser.buffer_pos] == '!' || parser.buffer[parser.buffer_pos] == '~' ||\n\t\tparser.buffer[parser.buffer_pos] == '*' || parser.buffer[parser.buffer_pos] == '\\'' ||\n\t\tparser.buffer[parser.buffer_pos] == '(' || parser.buffer[parser.buffer_pos] == ')' ||\n\t\tparser.buffer[parser.buffer_pos] == '[' || parser.buffer[parser.buffer_pos] == ']' ||\n\t\tparser.buffer[parser.buffer_pos] == '%' {\n\t\t// Check if it is a URI-escape sequence.\n\t\tif parser.buffer[parser.buffer_pos] == '%' {\n\t\t\tif !yaml_parser_scan_uri_escapes(parser, directive, start_mark, &s) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t} else {\n\t\t\ts = read(parser, s)\n\t\t}\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t\thasTag = true\n\t}\n\n\tif !hasTag {\n\t\tyaml_parser_set_scanner_tag_error(parser, directive,\n\t\t\tstart_mark, \"did not find expected tag URI\")\n\t\treturn false\n\t}\n\t*uri = s\n\treturn true\n}\n\n// Decode an URI-escape sequence corresponding to a single UTF-8 character.\nfunc yaml_parser_scan_uri_escapes(parser *yaml_parser_t, directive bool, start_mark yaml_mark_t, s *[]byte) bool {\n\n\t// Decode the required number of characters.\n\tw := 1024\n\tfor w > 0 {\n\t\t// Check for a URI-escaped octet.\n\t\tif parser.unread < 3 && !yaml_parser_update_buffer(parser, 3) {\n\t\t\treturn false\n\t\t}\n\n\t\tif !(parser.buffer[parser.buffer_pos] == '%' &&\n\t\t\tis_hex(parser.buffer, parser.buffer_pos+1) &&\n\t\t\tis_hex(parser.buffer, parser.buffer_pos+2)) {\n\t\t\treturn yaml_parser_set_scanner_tag_error(parser, directive,\n\t\t\t\tstart_mark, \"did not find URI escaped octet\")\n\t\t}\n\n\t\t// Get the octet.\n\t\toctet := byte((as_hex(parser.buffer, parser.buffer_pos+1) << 4) + as_hex(parser.buffer, parser.buffer_pos+2))\n\n\t\t// If it is the leading octet, determine the length of the UTF-8 sequence.\n\t\tif w == 1024 {\n\t\t\tw = width(octet)\n\t\t\tif w == 0 {\n\t\t\t\treturn yaml_parser_set_scanner_tag_error(parser, directive,\n\t\t\t\t\tstart_mark, \"found an incorrect leading UTF-8 octet\")\n\t\t\t}\n\t\t} else {\n\t\t\t// Check if the trailing octet is correct.\n\t\t\tif octet&0xC0 != 0x80 {\n\t\t\t\treturn yaml_parser_set_scanner_tag_error(parser, directive,\n\t\t\t\t\tstart_mark, \"found an incorrect trailing UTF-8 octet\")\n\t\t\t}\n\t\t}\n\n\t\t// Copy the octet and move the pointers.\n\t\t*s = append(*s, octet)\n\t\tskip(parser)\n\t\tskip(parser)\n\t\tskip(parser)\n\t\tw--\n\t}\n\treturn true\n}\n\n// Scan a block scalar.\nfunc yaml_parser_scan_block_scalar(parser *yaml_parser_t, token *yaml_token_t, literal bool) bool {\n\t// Eat the indicator '|' or '>'.\n\tstart_mark := parser.mark\n\tskip(parser)\n\n\t// Scan the additional block scalar indicators.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\n\t// Check for a chomping indicator.\n\tvar chomping, increment int\n\tif parser.buffer[parser.buffer_pos] == '+' || parser.buffer[parser.buffer_pos] == '-' {\n\t\t// Set the chomping method and eat the indicator.\n\t\tif parser.buffer[parser.buffer_pos] == '+' {\n\t\t\tchomping = +1\n\t\t} else {\n\t\t\tchomping = -1\n\t\t}\n\t\tskip(parser)\n\n\t\t// Check for an indentation indicator.\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t\tif is_digit(parser.buffer, parser.buffer_pos) {\n\t\t\t// Check that the indentation is greater than 0.\n\t\t\tif parser.buffer[parser.buffer_pos] == '0' {\n\t\t\t\tyaml_parser_set_scanner_error(parser, \"while scanning a block scalar\",\n\t\t\t\t\tstart_mark, \"found an indentation indicator equal to 0\")\n\t\t\t\treturn false\n\t\t\t}\n\n\t\t\t// Get the indentation level and eat the indicator.\n\t\t\tincrement = as_digit(parser.buffer, parser.buffer_pos)\n\t\t\tskip(parser)\n\t\t}\n\n\t} else if is_digit(parser.buffer, parser.buffer_pos) {\n\t\t// Do the same as above, but in the opposite order.\n\n\t\tif parser.buffer[parser.buffer_pos] == '0' {\n\t\t\tyaml_parser_set_scanner_error(parser, \"while scanning a block scalar\",\n\t\t\t\tstart_mark, \"found an indentation indicator equal to 0\")\n\t\t\treturn false\n\t\t}\n\t\tincrement = as_digit(parser.buffer, parser.buffer_pos)\n\t\tskip(parser)\n\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t\tif parser.buffer[parser.buffer_pos] == '+' || parser.buffer[parser.buffer_pos] == '-' {\n\t\t\tif parser.buffer[parser.buffer_pos] == '+' {\n\t\t\t\tchomping = +1\n\t\t\t} else {\n\t\t\t\tchomping = -1\n\t\t\t}\n\t\t\tskip(parser)\n\t\t}\n\t}\n\n\t// Eat whitespaces and comments to the end of the line.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tfor is_blank(parser.buffer, parser.buffer_pos) {\n\t\tskip(parser)\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t}\n\tif parser.buffer[parser.buffer_pos] == '#' {\n\t\tif !yaml_parser_scan_line_comment(parser, start_mark) {\n\t\t\treturn false\n\t\t}\n\t\tfor !is_breakz(parser.buffer, parser.buffer_pos) {\n\t\t\tskip(parser)\n\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t}\n\n\t// Check if we are at the end of the line.\n\tif !is_breakz(parser.buffer, parser.buffer_pos) {\n\t\tyaml_parser_set_scanner_error(parser, \"while scanning a block scalar\",\n\t\t\tstart_mark, \"did not find expected comment or line break\")\n\t\treturn false\n\t}\n\n\t// Eat a line break.\n\tif is_break(parser.buffer, parser.buffer_pos) {\n\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\treturn false\n\t\t}\n\t\tskip_line(parser)\n\t}\n\n\tend_mark := parser.mark\n\n\t// Set the indentation level if it was specified.\n\tvar indent int\n\tif increment > 0 {\n\t\tif parser.indent >= 0 {\n\t\t\tindent = parser.indent + increment\n\t\t} else {\n\t\t\tindent = increment\n\t\t}\n\t}\n\n\t// Scan the leading line breaks and determine the indentation level if needed.\n\tvar s, leading_break, trailing_breaks []byte\n\tif !yaml_parser_scan_block_scalar_breaks(parser, &indent, &trailing_breaks, start_mark, &end_mark) {\n\t\treturn false\n\t}\n\n\t// Scan the block scalar content.\n\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\treturn false\n\t}\n\tvar leading_blank, trailing_blank bool\n\tfor parser.mark.column == indent && !is_z(parser.buffer, parser.buffer_pos) {\n\t\t// We are at the beginning of a non-empty line.\n\n\t\t// Is it a trailing whitespace?\n\t\ttrailing_blank = is_blank(parser.buffer, parser.buffer_pos)\n\n\t\t// Check if we need to fold the leading line break.\n\t\tif !literal && !leading_blank && !trailing_blank && len(leading_break) > 0 && leading_break[0] == '\\n' {\n\t\t\t// Do we need to join the lines by space?\n\t\t\tif len(trailing_breaks) == 0 {\n\t\t\t\ts = append(s, ' ')\n\t\t\t}\n\t\t} else {\n\t\t\ts = append(s, leading_break...)\n\t\t}\n\t\tleading_break = leading_break[:0]\n\n\t\t// Append the remaining line breaks.\n\t\ts = append(s, trailing_breaks...)\n\t\ttrailing_breaks = trailing_breaks[:0]\n\n\t\t// Is it a leading whitespace?\n\t\tleading_blank = is_blank(parser.buffer, parser.buffer_pos)\n\n\t\t// Consume the current line.\n\t\tfor !is_breakz(parser.buffer, parser.buffer_pos) {\n\t\t\ts = read(parser, s)\n\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\t// Consume the line break.\n\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\treturn false\n\t\t}\n\n\t\tleading_break = read_line(parser, leading_break)\n\n\t\t// Eat the following indentation spaces and line breaks.\n\t\tif !yaml_parser_scan_block_scalar_breaks(parser, &indent, &trailing_breaks, start_mark, &end_mark) {\n\t\t\treturn false\n\t\t}\n\t}\n\n\t// Chomp the tail.\n\tif chomping != -1 {\n\t\ts = append(s, leading_break...)\n\t}\n\tif chomping == 1 {\n\t\ts = append(s, trailing_breaks...)\n\t}\n\n\t// Create a token.\n\t*token = yaml_token_t{\n\t\ttyp: yaml_SCALAR_TOKEN,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t\tvalue: s,\n\t\tstyle: yaml_LITERAL_SCALAR_STYLE,\n\t}\n\tif !literal {\n\t\ttoken.style = yaml_FOLDED_SCALAR_STYLE\n\t}\n\treturn true\n}\n\n// Scan indentation spaces and line breaks for a block scalar. Determine the\n// indentation level if needed.\nfunc yaml_parser_scan_block_scalar_breaks(parser *yaml_parser_t, indent *int, breaks *[]byte, start_mark yaml_mark_t, end_mark *yaml_mark_t) bool {\n\t*end_mark = parser.mark\n\n\t// Eat the indentation spaces and line breaks.\n\tmax_indent := 0\n\tfor {\n\t\t// Eat the indentation spaces.\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\t\tfor (*indent == 0 || parser.mark.column < *indent) && is_space(parser.buffer, parser.buffer_pos) {\n\t\t\tskip(parser)\n\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\tif parser.mark.column > max_indent {\n\t\t\tmax_indent = parser.mark.column\n\t\t}\n\n\t\t// Check for a tab character messing the indentation.\n\t\tif (*indent == 0 || parser.mark.column < *indent) && is_tab(parser.buffer, parser.buffer_pos) {\n\t\t\treturn yaml_parser_set_scanner_error(parser, \"while scanning a block scalar\",\n\t\t\t\tstart_mark, \"found a tab character where an indentation space is expected\")\n\t\t}\n\n\t\t// Have we found a non-empty line?\n\t\tif !is_break(parser.buffer, parser.buffer_pos) {\n\t\t\tbreak\n\t\t}\n\n\t\t// Consume the line break.\n\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\treturn false\n\t\t}\n\t\t// [Go] Should really be returning breaks instead.\n\t\t*breaks = read_line(parser, *breaks)\n\t\t*end_mark = parser.mark\n\t}\n\n\t// Determine the indentation level if needed.\n\tif *indent == 0 {\n\t\t*indent = max_indent\n\t\tif *indent < parser.indent+1 {\n\t\t\t*indent = parser.indent + 1\n\t\t}\n\t\tif *indent < 1 {\n\t\t\t*indent = 1\n\t\t}\n\t}\n\treturn true\n}\n\n// Scan a quoted scalar.\nfunc yaml_parser_scan_flow_scalar(parser *yaml_parser_t, token *yaml_token_t, single bool) bool {\n\t// Eat the left quote.\n\tstart_mark := parser.mark\n\tskip(parser)\n\n\t// Consume the content of the quoted scalar.\n\tvar s, leading_break, trailing_breaks, whitespaces []byte\n\tfor {\n\t\t// Check that there are no document indicators at the beginning of the line.\n\t\tif parser.unread < 4 && !yaml_parser_update_buffer(parser, 4) {\n\t\t\treturn false\n\t\t}\n\n\t\tif parser.mark.column == 0 &&\n\t\t\t((parser.buffer[parser.buffer_pos+0] == '-' &&\n\t\t\t\tparser.buffer[parser.buffer_pos+1] == '-' &&\n\t\t\t\tparser.buffer[parser.buffer_pos+2] == '-') ||\n\t\t\t\t(parser.buffer[parser.buffer_pos+0] == '.' &&\n\t\t\t\t\tparser.buffer[parser.buffer_pos+1] == '.' &&\n\t\t\t\t\tparser.buffer[parser.buffer_pos+2] == '.')) &&\n\t\t\tis_blankz(parser.buffer, parser.buffer_pos+3) {\n\t\t\tyaml_parser_set_scanner_error(parser, \"while scanning a quoted scalar\",\n\t\t\t\tstart_mark, \"found unexpected document indicator\")\n\t\t\treturn false\n\t\t}\n\n\t\t// Check for EOF.\n\t\tif is_z(parser.buffer, parser.buffer_pos) {\n\t\t\tyaml_parser_set_scanner_error(parser, \"while scanning a quoted scalar\",\n\t\t\t\tstart_mark, \"found unexpected end of stream\")\n\t\t\treturn false\n\t\t}\n\n\t\t// Consume non-blank characters.\n\t\tleading_blanks := false\n\t\tfor !is_blankz(parser.buffer, parser.buffer_pos) {\n\t\t\tif single && parser.buffer[parser.buffer_pos] == '\\'' && parser.buffer[parser.buffer_pos+1] == '\\'' {\n\t\t\t\t// Is is an escaped single quote.\n\t\t\t\ts = append(s, '\\'')\n\t\t\t\tskip(parser)\n\t\t\t\tskip(parser)\n\n\t\t\t} else if single && parser.buffer[parser.buffer_pos] == '\\'' {\n\t\t\t\t// It is a right single quote.\n\t\t\t\tbreak\n\t\t\t} else if !single && parser.buffer[parser.buffer_pos] == '\"' {\n\t\t\t\t// It is a right double quote.\n\t\t\t\tbreak\n\n\t\t\t} else if !single && parser.buffer[parser.buffer_pos] == '\\\\' && is_break(parser.buffer, parser.buffer_pos+1) {\n\t\t\t\t// It is an escaped line break.\n\t\t\t\tif parser.unread < 3 && !yaml_parser_update_buffer(parser, 3) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tskip(parser)\n\t\t\t\tskip_line(parser)\n\t\t\t\tleading_blanks = true\n\t\t\t\tbreak\n\n\t\t\t} else if !single && parser.buffer[parser.buffer_pos] == '\\\\' {\n\t\t\t\t// It is an escape sequence.\n\t\t\t\tcode_length := 0\n\n\t\t\t\t// Check the escape character.\n\t\t\t\tswitch parser.buffer[parser.buffer_pos+1] {\n\t\t\t\tcase '0':\n\t\t\t\t\ts = append(s, 0)\n\t\t\t\tcase 'a':\n\t\t\t\t\ts = append(s, '\\x07')\n\t\t\t\tcase 'b':\n\t\t\t\t\ts = append(s, '\\x08')\n\t\t\t\tcase 't', '\\t':\n\t\t\t\t\ts = append(s, '\\x09')\n\t\t\t\tcase 'n':\n\t\t\t\t\ts = append(s, '\\x0A')\n\t\t\t\tcase 'v':\n\t\t\t\t\ts = append(s, '\\x0B')\n\t\t\t\tcase 'f':\n\t\t\t\t\ts = append(s, '\\x0C')\n\t\t\t\tcase 'r':\n\t\t\t\t\ts = append(s, '\\x0D')\n\t\t\t\tcase 'e':\n\t\t\t\t\ts = append(s, '\\x1B')\n\t\t\t\tcase ' ':\n\t\t\t\t\ts = append(s, '\\x20')\n\t\t\t\tcase '\"':\n\t\t\t\t\ts = append(s, '\"')\n\t\t\t\tcase '\\'':\n\t\t\t\t\ts = append(s, '\\'')\n\t\t\t\tcase '\\\\':\n\t\t\t\t\ts = append(s, '\\\\')\n\t\t\t\tcase 'N': // NEL (#x85)\n\t\t\t\t\ts = append(s, '\\xC2')\n\t\t\t\t\ts = append(s, '\\x85')\n\t\t\t\tcase '_': // #xA0\n\t\t\t\t\ts = append(s, '\\xC2')\n\t\t\t\t\ts = append(s, '\\xA0')\n\t\t\t\tcase 'L': // LS (#x2028)\n\t\t\t\t\ts = append(s, '\\xE2')\n\t\t\t\t\ts = append(s, '\\x80')\n\t\t\t\t\ts = append(s, '\\xA8')\n\t\t\t\tcase 'P': // PS (#x2029)\n\t\t\t\t\ts = append(s, '\\xE2')\n\t\t\t\t\ts = append(s, '\\x80')\n\t\t\t\t\ts = append(s, '\\xA9')\n\t\t\t\tcase 'x':\n\t\t\t\t\tcode_length = 2\n\t\t\t\tcase 'u':\n\t\t\t\t\tcode_length = 4\n\t\t\t\tcase 'U':\n\t\t\t\t\tcode_length = 8\n\t\t\t\tdefault:\n\t\t\t\t\tyaml_parser_set_scanner_error(parser, \"while parsing a quoted scalar\",\n\t\t\t\t\t\tstart_mark, \"found unknown escape character\")\n\t\t\t\t\treturn false\n\t\t\t\t}\n\n\t\t\t\tskip(parser)\n\t\t\t\tskip(parser)\n\n\t\t\t\t// Consume an arbitrary escape code.\n\t\t\t\tif code_length > 0 {\n\t\t\t\t\tvar value int\n\n\t\t\t\t\t// Scan the character value.\n\t\t\t\t\tif parser.unread < code_length && !yaml_parser_update_buffer(parser, code_length) {\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\t\t\t\t\tfor k := 0; k < code_length; k++ {\n\t\t\t\t\t\tif !is_hex(parser.buffer, parser.buffer_pos+k) {\n\t\t\t\t\t\t\tyaml_parser_set_scanner_error(parser, \"while parsing a quoted scalar\",\n\t\t\t\t\t\t\t\tstart_mark, \"did not find expected hexdecimal number\")\n\t\t\t\t\t\t\treturn false\n\t\t\t\t\t\t}\n\t\t\t\t\t\tvalue = (value << 4) + as_hex(parser.buffer, parser.buffer_pos+k)\n\t\t\t\t\t}\n\n\t\t\t\t\t// Check the value and write the character.\n\t\t\t\t\tif (value >= 0xD800 && value <= 0xDFFF) || value > 0x10FFFF {\n\t\t\t\t\t\tyaml_parser_set_scanner_error(parser, \"while parsing a quoted scalar\",\n\t\t\t\t\t\t\tstart_mark, \"found invalid Unicode character escape code\")\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\t\t\t\t\tif value <= 0x7F {\n\t\t\t\t\t\ts = append(s, byte(value))\n\t\t\t\t\t} else if value <= 0x7FF {\n\t\t\t\t\t\ts = append(s, byte(0xC0+(value>>6)))\n\t\t\t\t\t\ts = append(s, byte(0x80+(value&0x3F)))\n\t\t\t\t\t} else if value <= 0xFFFF {\n\t\t\t\t\t\ts = append(s, byte(0xE0+(value>>12)))\n\t\t\t\t\t\ts = append(s, byte(0x80+((value>>6)&0x3F)))\n\t\t\t\t\t\ts = append(s, byte(0x80+(value&0x3F)))\n\t\t\t\t\t} else {\n\t\t\t\t\t\ts = append(s, byte(0xF0+(value>>18)))\n\t\t\t\t\t\ts = append(s, byte(0x80+((value>>12)&0x3F)))\n\t\t\t\t\t\ts = append(s, byte(0x80+((value>>6)&0x3F)))\n\t\t\t\t\t\ts = append(s, byte(0x80+(value&0x3F)))\n\t\t\t\t\t}\n\n\t\t\t\t\t// Advance the pointer.\n\t\t\t\t\tfor k := 0; k < code_length; k++ {\n\t\t\t\t\t\tskip(parser)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\t// It is a non-escaped non-blank character.\n\t\t\t\ts = read(parser, s)\n\t\t\t}\n\t\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\n\t\t// Check if we are at the end of the scalar.\n\t\tif single {\n\t\t\tif parser.buffer[parser.buffer_pos] == '\\'' {\n\t\t\t\tbreak\n\t\t\t}\n\t\t} else {\n\t\t\tif parser.buffer[parser.buffer_pos] == '\"' {\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\n\t\t// Consume blank characters.\n\t\tfor is_blank(parser.buffer, parser.buffer_pos) || is_break(parser.buffer, parser.buffer_pos) {\n\t\t\tif is_blank(parser.buffer, parser.buffer_pos) {\n\t\t\t\t// Consume a space or a tab character.\n\t\t\t\tif !leading_blanks {\n\t\t\t\t\twhitespaces = read(parser, whitespaces)\n\t\t\t\t} else {\n\t\t\t\t\tskip(parser)\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\n\t\t\t\t// Check if it is a first line break.\n\t\t\t\tif !leading_blanks {\n\t\t\t\t\twhitespaces = whitespaces[:0]\n\t\t\t\t\tleading_break = read_line(parser, leading_break)\n\t\t\t\t\tleading_blanks = true\n\t\t\t\t} else {\n\t\t\t\t\ttrailing_breaks = read_line(parser, trailing_breaks)\n\t\t\t\t}\n\t\t\t}\n\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\t// Join the whitespaces or fold line breaks.\n\t\tif leading_blanks {\n\t\t\t// Do we need to fold line breaks?\n\t\t\tif len(leading_break) > 0 && leading_break[0] == '\\n' {\n\t\t\t\tif len(trailing_breaks) == 0 {\n\t\t\t\t\ts = append(s, ' ')\n\t\t\t\t} else {\n\t\t\t\t\ts = append(s, trailing_breaks...)\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\ts = append(s, leading_break...)\n\t\t\t\ts = append(s, trailing_breaks...)\n\t\t\t}\n\t\t\ttrailing_breaks = trailing_breaks[:0]\n\t\t\tleading_break = leading_break[:0]\n\t\t} else {\n\t\t\ts = append(s, whitespaces...)\n\t\t\twhitespaces = whitespaces[:0]\n\t\t}\n\t}\n\n\t// Eat the right quote.\n\tskip(parser)\n\tend_mark := parser.mark\n\n\t// Create a token.\n\t*token = yaml_token_t{\n\t\ttyp: yaml_SCALAR_TOKEN,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t\tvalue: s,\n\t\tstyle: yaml_SINGLE_QUOTED_SCALAR_STYLE,\n\t}\n\tif !single {\n\t\ttoken.style = yaml_DOUBLE_QUOTED_SCALAR_STYLE\n\t}\n\treturn true\n}\n\n// Scan a plain scalar.\nfunc yaml_parser_scan_plain_scalar(parser *yaml_parser_t, token *yaml_token_t) bool {\n\n\tvar s, leading_break, trailing_breaks, whitespaces []byte\n\tvar leading_blanks bool\n\tvar indent = parser.indent + 1\n\n\tstart_mark := parser.mark\n\tend_mark := parser.mark\n\n\t// Consume the content of the plain scalar.\n\tfor {\n\t\t// Check for a document indicator.\n\t\tif parser.unread < 4 && !yaml_parser_update_buffer(parser, 4) {\n\t\t\treturn false\n\t\t}\n\t\tif parser.mark.column == 0 &&\n\t\t\t((parser.buffer[parser.buffer_pos+0] == '-' &&\n\t\t\t\tparser.buffer[parser.buffer_pos+1] == '-' &&\n\t\t\t\tparser.buffer[parser.buffer_pos+2] == '-') ||\n\t\t\t\t(parser.buffer[parser.buffer_pos+0] == '.' &&\n\t\t\t\t\tparser.buffer[parser.buffer_pos+1] == '.' &&\n\t\t\t\t\tparser.buffer[parser.buffer_pos+2] == '.')) &&\n\t\t\tis_blankz(parser.buffer, parser.buffer_pos+3) {\n\t\t\tbreak\n\t\t}\n\n\t\t// Check for a comment.\n\t\tif parser.buffer[parser.buffer_pos] == '#' {\n\t\t\tbreak\n\t\t}\n\n\t\t// Consume non-blank characters.\n\t\tfor !is_blankz(parser.buffer, parser.buffer_pos) {\n\n\t\t\t// Check for indicators that may end a plain scalar.\n\t\t\tif (parser.buffer[parser.buffer_pos] == ':' && is_blankz(parser.buffer, parser.buffer_pos+1)) ||\n\t\t\t\t(parser.flow_level > 0 &&\n\t\t\t\t\t(parser.buffer[parser.buffer_pos] == ',' ||\n\t\t\t\t\t\tparser.buffer[parser.buffer_pos] == '?' || parser.buffer[parser.buffer_pos] == '[' ||\n\t\t\t\t\t\tparser.buffer[parser.buffer_pos] == ']' || parser.buffer[parser.buffer_pos] == '{' ||\n\t\t\t\t\t\tparser.buffer[parser.buffer_pos] == '}')) {\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\t// Check if we need to join whitespaces and breaks.\n\t\t\tif leading_blanks || len(whitespaces) > 0 {\n\t\t\t\tif leading_blanks {\n\t\t\t\t\t// Do we need to fold line breaks?\n\t\t\t\t\tif leading_break[0] == '\\n' {\n\t\t\t\t\t\tif len(trailing_breaks) == 0 {\n\t\t\t\t\t\t\ts = append(s, ' ')\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\ts = append(s, trailing_breaks...)\n\t\t\t\t\t\t}\n\t\t\t\t\t} else {\n\t\t\t\t\t\ts = append(s, leading_break...)\n\t\t\t\t\t\ts = append(s, trailing_breaks...)\n\t\t\t\t\t}\n\t\t\t\t\ttrailing_breaks = trailing_breaks[:0]\n\t\t\t\t\tleading_break = leading_break[:0]\n\t\t\t\t\tleading_blanks = false\n\t\t\t\t} else {\n\t\t\t\t\ts = append(s, whitespaces...)\n\t\t\t\t\twhitespaces = whitespaces[:0]\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Copy the character.\n\t\t\ts = read(parser, s)\n\n\t\t\tend_mark = parser.mark\n\t\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\t// Is it the end?\n\t\tif !(is_blank(parser.buffer, parser.buffer_pos) || is_break(parser.buffer, parser.buffer_pos)) {\n\t\t\tbreak\n\t\t}\n\n\t\t// Consume blank characters.\n\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\treturn false\n\t\t}\n\n\t\tfor is_blank(parser.buffer, parser.buffer_pos) || is_break(parser.buffer, parser.buffer_pos) {\n\t\t\tif is_blank(parser.buffer, parser.buffer_pos) {\n\n\t\t\t\t// Check for tab characters that abuse indentation.\n\t\t\t\tif leading_blanks && parser.mark.column < indent && is_tab(parser.buffer, parser.buffer_pos) {\n\t\t\t\t\tyaml_parser_set_scanner_error(parser, \"while scanning a plain scalar\",\n\t\t\t\t\t\tstart_mark, \"found a tab character that violates indentation\")\n\t\t\t\t\treturn false\n\t\t\t\t}\n\n\t\t\t\t// Consume a space or a tab character.\n\t\t\t\tif !leading_blanks {\n\t\t\t\t\twhitespaces = read(parser, whitespaces)\n\t\t\t\t} else {\n\t\t\t\t\tskip(parser)\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\n\t\t\t\t// Check if it is a first line break.\n\t\t\t\tif !leading_blanks {\n\t\t\t\t\twhitespaces = whitespaces[:0]\n\t\t\t\t\tleading_break = read_line(parser, leading_break)\n\t\t\t\t\tleading_blanks = true\n\t\t\t\t} else {\n\t\t\t\t\ttrailing_breaks = read_line(parser, trailing_breaks)\n\t\t\t\t}\n\t\t\t}\n\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\n\t\t// Check indentation level.\n\t\tif parser.flow_level == 0 && parser.mark.column < indent {\n\t\t\tbreak\n\t\t}\n\t}\n\n\t// Create a token.\n\t*token = yaml_token_t{\n\t\ttyp: yaml_SCALAR_TOKEN,\n\t\tstart_mark: start_mark,\n\t\tend_mark: end_mark,\n\t\tvalue: s,\n\t\tstyle: yaml_PLAIN_SCALAR_STYLE,\n\t}\n\n\t// Note that we change the 'simple_key_allowed' flag.\n\tif leading_blanks {\n\t\tparser.simple_key_allowed = true\n\t}\n\treturn true\n}\n\nfunc yaml_parser_scan_line_comment(parser *yaml_parser_t, token_mark yaml_mark_t) bool {\n\tif parser.newlines > 0 {\n\t\treturn true\n\t}\n\n\tvar start_mark yaml_mark_t\n\tvar text []byte\n\n\tfor peek := 0; peek < 512; peek++ {\n\t\tif parser.unread < peek+1 && !yaml_parser_update_buffer(parser, peek+1) {\n\t\t\tbreak\n\t\t}\n\t\tif is_blank(parser.buffer, parser.buffer_pos+peek) {\n\t\t\tcontinue\n\t\t}\n\t\tif parser.buffer[parser.buffer_pos+peek] == '#' {\n\t\t\tseen := parser.mark.index + peek\n\t\t\tfor {\n\t\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tif is_breakz(parser.buffer, parser.buffer_pos) {\n\t\t\t\t\tif parser.mark.index >= seen {\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\t\t\t\treturn false\n\t\t\t\t\t}\n\t\t\t\t\tskip_line(parser)\n\t\t\t\t} else if parser.mark.index >= seen {\n\t\t\t\t\tif len(text) == 0 {\n\t\t\t\t\t\tstart_mark = parser.mark\n\t\t\t\t\t}\n\t\t\t\t\ttext = read(parser, text)\n\t\t\t\t} else {\n\t\t\t\t\tskip(parser)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tbreak\n\t}\n\tif len(text) > 0 {\n\t\tparser.comments = append(parser.comments, yaml_comment_t{\n\t\t\ttoken_mark: token_mark,\n\t\t\tstart_mark: start_mark,\n\t\t\tline: text,\n\t\t})\n\t}\n\treturn true\n}\n\nfunc yaml_parser_scan_comments(parser *yaml_parser_t, scan_mark yaml_mark_t) bool {\n\ttoken := parser.tokens[len(parser.tokens)-1]\n\n\tif token.typ == yaml_FLOW_ENTRY_TOKEN && len(parser.tokens) > 1 {\n\t\ttoken = parser.tokens[len(parser.tokens)-2]\n\t}\n\n\tvar token_mark = token.start_mark\n\tvar start_mark yaml_mark_t\n\tvar next_indent = parser.indent\n\tif next_indent < 0 {\n\t\tnext_indent = 0\n\t}\n\n\tvar recent_empty = false\n\tvar first_empty = parser.newlines <= 1\n\n\tvar line = parser.mark.line\n\tvar column = parser.mark.column\n\n\tvar text []byte\n\n\t// The foot line is the place where a comment must start to\n\t// still be considered as a foot of the prior content.\n\t// If there's some content in the currently parsed line, then\n\t// the foot is the line below it.\n\tvar foot_line = -1\n\tif scan_mark.line > 0 {\n\t\tfoot_line = parser.mark.line - parser.newlines + 1\n\t\tif parser.newlines == 0 && parser.mark.column > 1 {\n\t\t\tfoot_line++\n\t\t}\n\t}\n\n\tvar peek = 0\n\tfor ; peek < 512; peek++ {\n\t\tif parser.unread < peek+1 && !yaml_parser_update_buffer(parser, peek+1) {\n\t\t\tbreak\n\t\t}\n\t\tcolumn++\n\t\tif is_blank(parser.buffer, parser.buffer_pos+peek) {\n\t\t\tcontinue\n\t\t}\n\t\tc := parser.buffer[parser.buffer_pos+peek]\n\t\tvar close_flow = parser.flow_level > 0 && (c == ']' || c == '}')\n\t\tif close_flow || is_breakz(parser.buffer, parser.buffer_pos+peek) {\n\t\t\t// Got line break or terminator.\n\t\t\tif close_flow || !recent_empty {\n\t\t\t\tif close_flow || first_empty && (start_mark.line == foot_line && token.typ != yaml_VALUE_TOKEN || start_mark.column-1 < next_indent) {\n\t\t\t\t\t// This is the first empty line and there were no empty lines before,\n\t\t\t\t\t// so this initial part of the comment is a foot of the prior token\n\t\t\t\t\t// instead of being a head for the following one. Split it up.\n\t\t\t\t\t// Alternatively, this might also be the last comment inside a flow\n\t\t\t\t\t// scope, so it must be a footer.\n\t\t\t\t\tif len(text) > 0 {\n\t\t\t\t\t\tif start_mark.column-1 < next_indent {\n\t\t\t\t\t\t\t// If dedented it's unrelated to the prior token.\n\t\t\t\t\t\t\ttoken_mark = start_mark\n\t\t\t\t\t\t}\n\t\t\t\t\t\tparser.comments = append(parser.comments, yaml_comment_t{\n\t\t\t\t\t\t\tscan_mark: scan_mark,\n\t\t\t\t\t\t\ttoken_mark: token_mark,\n\t\t\t\t\t\t\tstart_mark: start_mark,\n\t\t\t\t\t\t\tend_mark: yaml_mark_t{parser.mark.index + peek, line, column},\n\t\t\t\t\t\t\tfoot: text,\n\t\t\t\t\t\t})\n\t\t\t\t\t\tscan_mark = yaml_mark_t{parser.mark.index + peek, line, column}\n\t\t\t\t\t\ttoken_mark = scan_mark\n\t\t\t\t\t\ttext = nil\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\tif len(text) > 0 && parser.buffer[parser.buffer_pos+peek] != 0 {\n\t\t\t\t\t\ttext = append(text, '\\n')\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !is_break(parser.buffer, parser.buffer_pos+peek) {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tfirst_empty = false\n\t\t\trecent_empty = true\n\t\t\tcolumn = 0\n\t\t\tline++\n\t\t\tcontinue\n\t\t}\n\n\t\tif len(text) > 0 && (close_flow || column-1 < next_indent && column != start_mark.column) {\n\t\t\t// The comment at the different indentation is a foot of the\n\t\t\t// preceding data rather than a head of the upcoming one.\n\t\t\tparser.comments = append(parser.comments, yaml_comment_t{\n\t\t\t\tscan_mark: scan_mark,\n\t\t\t\ttoken_mark: token_mark,\n\t\t\t\tstart_mark: start_mark,\n\t\t\t\tend_mark: yaml_mark_t{parser.mark.index + peek, line, column},\n\t\t\t\tfoot: text,\n\t\t\t})\n\t\t\tscan_mark = yaml_mark_t{parser.mark.index + peek, line, column}\n\t\t\ttoken_mark = scan_mark\n\t\t\ttext = nil\n\t\t}\n\n\t\tif parser.buffer[parser.buffer_pos+peek] != '#' {\n\t\t\tbreak\n\t\t}\n\n\t\tif len(text) == 0 {\n\t\t\tstart_mark = yaml_mark_t{parser.mark.index + peek, line, column}\n\t\t} else {\n\t\t\ttext = append(text, '\\n')\n\t\t}\n\n\t\trecent_empty = false\n\n\t\t// Consume until after the consumed comment line.\n\t\tseen := parser.mark.index + peek\n\t\tfor {\n\t\t\tif parser.unread < 1 && !yaml_parser_update_buffer(parser, 1) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t\tif is_breakz(parser.buffer, parser.buffer_pos) {\n\t\t\t\tif parser.mark.index >= seen {\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tif parser.unread < 2 && !yaml_parser_update_buffer(parser, 2) {\n\t\t\t\t\treturn false\n\t\t\t\t}\n\t\t\t\tskip_line(parser)\n\t\t\t} else if parser.mark.index >= seen {\n\t\t\t\ttext = read(parser, text)\n\t\t\t} else {\n\t\t\t\tskip(parser)\n\t\t\t}\n\t\t}\n\n\t\tpeek = 0\n\t\tcolumn = 0\n\t\tline = parser.mark.line\n\t\tnext_indent = parser.indent\n\t\tif next_indent < 0 {\n\t\t\tnext_indent = 0\n\t\t}\n\t}\n\n\tif len(text) > 0 {\n\t\tparser.comments = append(parser.comments, yaml_comment_t{\n\t\t\tscan_mark: scan_mark,\n\t\t\ttoken_mark: start_mark,\n\t\t\tstart_mark: start_mark,\n\t\t\tend_mark: yaml_mark_t{parser.mark.index + peek - 1, line, column},\n\t\t\thead: text,\n\t\t})\n\t}\n\treturn true\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/sorter.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage yaml\n\nimport (\n\t\"reflect\"\n\t\"unicode\"\n)\n\ntype keyList []reflect.Value\n\nfunc (l keyList) Len() int { return len(l) }\nfunc (l keyList) Swap(i, j int) { l[i], l[j] = l[j], l[i] }\nfunc (l keyList) Less(i, j int) bool {\n\ta := l[i]\n\tb := l[j]\n\tak := a.Kind()\n\tbk := b.Kind()\n\tfor (ak == reflect.Interface || ak == reflect.Ptr) && !a.IsNil() {\n\t\ta = a.Elem()\n\t\tak = a.Kind()\n\t}\n\tfor (bk == reflect.Interface || bk == reflect.Ptr) && !b.IsNil() {\n\t\tb = b.Elem()\n\t\tbk = b.Kind()\n\t}\n\taf, aok := keyFloat(a)\n\tbf, bok := keyFloat(b)\n\tif aok && bok {\n\t\tif af != bf {\n\t\t\treturn af < bf\n\t\t}\n\t\tif ak != bk {\n\t\t\treturn ak < bk\n\t\t}\n\t\treturn numLess(a, b)\n\t}\n\tif ak != reflect.String || bk != reflect.String {\n\t\treturn ak < bk\n\t}\n\tar, br := []rune(a.String()), []rune(b.String())\n\tdigits := false\n\tfor i := 0; i < len(ar) && i < len(br); i++ {\n\t\tif ar[i] == br[i] {\n\t\t\tdigits = unicode.IsDigit(ar[i])\n\t\t\tcontinue\n\t\t}\n\t\tal := unicode.IsLetter(ar[i])\n\t\tbl := unicode.IsLetter(br[i])\n\t\tif al && bl {\n\t\t\treturn ar[i] < br[i]\n\t\t}\n\t\tif al || bl {\n\t\t\tif digits {\n\t\t\t\treturn al\n\t\t\t} else {\n\t\t\t\treturn bl\n\t\t\t}\n\t\t}\n\t\tvar ai, bi int\n\t\tvar an, bn int64\n\t\tif ar[i] == '0' || br[i] == '0' {\n\t\t\tfor j := i - 1; j >= 0 && unicode.IsDigit(ar[j]); j-- {\n\t\t\t\tif ar[j] != '0' {\n\t\t\t\t\tan = 1\n\t\t\t\t\tbn = 1\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tfor ai = i; ai < len(ar) && unicode.IsDigit(ar[ai]); ai++ {\n\t\t\tan = an*10 + int64(ar[ai]-'0')\n\t\t}\n\t\tfor bi = i; bi < len(br) && unicode.IsDigit(br[bi]); bi++ {\n\t\t\tbn = bn*10 + int64(br[bi]-'0')\n\t\t}\n\t\tif an != bn {\n\t\t\treturn an < bn\n\t\t}\n\t\tif ai != bi {\n\t\t\treturn ai < bi\n\t\t}\n\t\treturn ar[i] < br[i]\n\t}\n\treturn len(ar) < len(br)\n}\n\n// keyFloat returns a float value for v if it is a number/bool\n// and whether it is a number/bool or not.\nfunc keyFloat(v reflect.Value) (f float64, ok bool) {\n\tswitch v.Kind() {\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn float64(v.Int()), true\n\tcase reflect.Float32, reflect.Float64:\n\t\treturn v.Float(), true\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\treturn float64(v.Uint()), true\n\tcase reflect.Bool:\n\t\tif v.Bool() {\n\t\t\treturn 1, true\n\t\t}\n\t\treturn 0, true\n\t}\n\treturn 0, false\n}\n\n// numLess returns whether a < b.\n// a and b must necessarily have the same kind.\nfunc numLess(a, b reflect.Value) bool {\n\tswitch a.Kind() {\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn a.Int() < b.Int()\n\tcase reflect.Float32, reflect.Float64:\n\t\treturn a.Float() < b.Float()\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\treturn a.Uint() < b.Uint()\n\tcase reflect.Bool:\n\t\treturn !a.Bool() && b.Bool()\n\t}\n\tpanic(\"not a number\")\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/writerc.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n// Copyright (c) 2006-2010 Kirill Simonov\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy of\n// this software and associated documentation files (the \"Software\"), to deal in\n// the Software without restriction, including without limitation the rights to\n// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n// of the Software, and to permit persons to whom the Software is furnished to do\n// so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\npackage yaml\n\n// Set the writer error and return false.\nfunc yaml_emitter_set_writer_error(emitter *yaml_emitter_t, problem string) bool {\n\temitter.error = yaml_WRITER_ERROR\n\temitter.problem = problem\n\treturn false\n}\n\n// Flush the output buffer.\nfunc yaml_emitter_flush(emitter *yaml_emitter_t) bool {\n\tif emitter.write_handler == nil {\n\t\tpanic(\"write handler not set\")\n\t}\n\n\t// Check if the buffer is empty.\n\tif emitter.buffer_pos == 0 {\n\t\treturn true\n\t}\n\n\tif err := emitter.write_handler(emitter, emitter.buffer[:emitter.buffer_pos]); err != nil {\n\t\treturn yaml_emitter_set_writer_error(emitter, \"write error: \"+err.Error())\n\t}\n\temitter.buffer_pos = 0\n\treturn true\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/yaml.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n// Package yaml implements YAML support for the Go language.\n//\n// Source code and other details for the project are available at GitHub:\n//\n//\thttps://github.com/yaml/go-yaml\npackage yaml\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"reflect\"\n\t\"strings\"\n\t\"sync\"\n\t\"unicode/utf8\"\n)\n\n// The Unmarshaler interface may be implemented by types to customize their\n// behavior when being unmarshaled from a YAML document.\ntype Unmarshaler interface {\n\tUnmarshalYAML(value *Node) error\n}\n\ntype obsoleteUnmarshaler interface {\n\tUnmarshalYAML(unmarshal func(interface{}) error) error\n}\n\n// The Marshaler interface may be implemented by types to customize their\n// behavior when being marshaled into a YAML document. The returned value\n// is marshaled in place of the original value implementing Marshaler.\n//\n// If an error is returned by MarshalYAML, the marshaling procedure stops\n// and returns with the provided error.\ntype Marshaler interface {\n\tMarshalYAML() (interface{}, error)\n}\n\n// Unmarshal decodes the first document found within the in byte slice\n// and assigns decoded values into the out value.\n//\n// Maps and pointers (to a struct, string, int, etc) are accepted as out\n// values. If an internal pointer within a struct is not initialized,\n// the yaml package will initialize it if necessary for unmarshalling\n// the provided data. The out parameter must not be nil.\n//\n// The type of the decoded values should be compatible with the respective\n// values in out. If one or more values cannot be decoded due to a type\n// mismatches, decoding continues partially until the end of the YAML\n// content, and a *yaml.TypeError is returned with details for all\n// missed values.\n//\n// Struct fields are only unmarshalled if they are exported (have an\n// upper case first letter), and are unmarshalled using the field name\n// lowercased as the default key. Custom keys may be defined via the\n// \"yaml\" name in the field tag: the content preceding the first comma\n// is used as the key, and the following comma-separated options are\n// used to tweak the marshalling process (see Marshal).\n// Conflicting names result in a runtime error.\n//\n// For example:\n//\n//\ttype T struct {\n//\t F int `yaml:\"a,omitempty\"`\n//\t B int\n//\t}\n//\tvar t T\n//\tyaml.Unmarshal([]byte(\"a: 1\\nb: 2\"), &t)\n//\n// See the documentation of Marshal for the format of tags and a list of\n// supported tag options.\nfunc Unmarshal(in []byte, out interface{}) (err error) {\n\treturn unmarshal(in, out, false)\n}\n\n// A Decoder reads and decodes YAML values from an input stream.\ntype Decoder struct {\n\tparser *parser\n\tknownFields bool\n}\n\n// NewDecoder returns a new decoder that reads from r.\n//\n// The decoder introduces its own buffering and may read\n// data from r beyond the YAML values requested.\nfunc NewDecoder(r io.Reader) *Decoder {\n\treturn &Decoder{\n\t\tparser: newParserFromReader(r),\n\t}\n}\n\n// KnownFields ensures that the keys in decoded mappings to\n// exist as fields in the struct being decoded into.\nfunc (dec *Decoder) KnownFields(enable bool) {\n\tdec.knownFields = enable\n}\n\n// Decode reads the next YAML-encoded value from its input\n// and stores it in the value pointed to by v.\n//\n// See the documentation for Unmarshal for details about the\n// conversion of YAML into a Go value.\nfunc (dec *Decoder) Decode(v interface{}) (err error) {\n\td := newDecoder()\n\td.knownFields = dec.knownFields\n\tdefer handleErr(&err)\n\tnode := dec.parser.parse()\n\tif node == nil {\n\t\treturn io.EOF\n\t}\n\tout := reflect.ValueOf(v)\n\tif out.Kind() == reflect.Ptr && !out.IsNil() {\n\t\tout = out.Elem()\n\t}\n\td.unmarshal(node, out)\n\tif len(d.terrors) > 0 {\n\t\treturn &TypeError{d.terrors}\n\t}\n\treturn nil\n}\n\n// Decode decodes the node and stores its data into the value pointed to by v.\n//\n// See the documentation for Unmarshal for details about the\n// conversion of YAML into a Go value.\nfunc (n *Node) Decode(v interface{}) (err error) {\n\td := newDecoder()\n\tdefer handleErr(&err)\n\tout := reflect.ValueOf(v)\n\tif out.Kind() == reflect.Ptr && !out.IsNil() {\n\t\tout = out.Elem()\n\t}\n\td.unmarshal(n, out)\n\tif len(d.terrors) > 0 {\n\t\treturn &TypeError{d.terrors}\n\t}\n\treturn nil\n}\n\nfunc unmarshal(in []byte, out interface{}, strict bool) (err error) {\n\tdefer handleErr(&err)\n\td := newDecoder()\n\tp := newParser(in)\n\tdefer p.destroy()\n\tnode := p.parse()\n\tif node != nil {\n\t\tv := reflect.ValueOf(out)\n\t\tif v.Kind() == reflect.Ptr && !v.IsNil() {\n\t\t\tv = v.Elem()\n\t\t}\n\t\td.unmarshal(node, v)\n\t}\n\tif len(d.terrors) > 0 {\n\t\treturn &TypeError{d.terrors}\n\t}\n\treturn nil\n}\n\n// Marshal serializes the value provided into a YAML document. The structure\n// of the generated document will reflect the structure of the value itself.\n// Maps and pointers (to struct, string, int, etc) are accepted as the in value.\n//\n// Struct fields are only marshalled if they are exported (have an upper case\n// first letter), and are marshalled using the field name lowercased as the\n// default key. Custom keys may be defined via the \"yaml\" name in the field\n// tag: the content preceding the first comma is used as the key, and the\n// following comma-separated options are used to tweak the marshalling process.\n// Conflicting names result in a runtime error.\n//\n// The field tag format accepted is:\n//\n//\t`(...) yaml:\"[][,[,]]\" (...)`\n//\n// The following flags are currently supported:\n//\n//\tomitempty Only include the field if it's not set to the zero\n//\t value for the type or to empty slices or maps.\n//\t Zero valued structs will be omitted if all their public\n//\t fields are zero, unless they implement an IsZero\n//\t method (see the IsZeroer interface type), in which\n//\t case the field will be excluded if IsZero returns true.\n//\n//\tflow Marshal using a flow style (useful for structs,\n//\t sequences and maps).\n//\n//\tinline Inline the field, which must be a struct or a map,\n//\t causing all of its fields or keys to be processed as if\n//\t they were part of the outer struct. For maps, keys must\n//\t not conflict with the yaml keys of other struct fields.\n//\n// In addition, if the key is \"-\", the field is ignored.\n//\n// For example:\n//\n//\ttype T struct {\n//\t F int `yaml:\"a,omitempty\"`\n//\t B int\n//\t}\n//\tyaml.Marshal(&T{B: 2}) // Returns \"b: 2\\n\"\n//\tyaml.Marshal(&T{F: 1}} // Returns \"a: 1\\nb: 0\\n\"\nfunc Marshal(in interface{}) (out []byte, err error) {\n\tdefer handleErr(&err)\n\te := newEncoder()\n\tdefer e.destroy()\n\te.marshalDoc(\"\", reflect.ValueOf(in))\n\te.finish()\n\tout = e.out\n\treturn\n}\n\n// An Encoder writes YAML values to an output stream.\ntype Encoder struct {\n\tencoder *encoder\n}\n\n// NewEncoder returns a new encoder that writes to w.\n// The Encoder should be closed after use to flush all data\n// to w.\nfunc NewEncoder(w io.Writer) *Encoder {\n\treturn &Encoder{\n\t\tencoder: newEncoderWithWriter(w),\n\t}\n}\n\n// Encode writes the YAML encoding of v to the stream.\n// If multiple items are encoded to the stream, the\n// second and subsequent document will be preceded\n// with a \"---\" document separator, but the first will not.\n//\n// See the documentation for Marshal for details about the conversion of Go\n// values to YAML.\nfunc (e *Encoder) Encode(v interface{}) (err error) {\n\tdefer handleErr(&err)\n\te.encoder.marshalDoc(\"\", reflect.ValueOf(v))\n\treturn nil\n}\n\n// Encode encodes value v and stores its representation in n.\n//\n// See the documentation for Marshal for details about the\n// conversion of Go values into YAML.\nfunc (n *Node) Encode(v interface{}) (err error) {\n\tdefer handleErr(&err)\n\te := newEncoder()\n\tdefer e.destroy()\n\te.marshalDoc(\"\", reflect.ValueOf(v))\n\te.finish()\n\tp := newParser(e.out)\n\tp.textless = true\n\tdefer p.destroy()\n\tdoc := p.parse()\n\t*n = *doc.Content[0]\n\treturn nil\n}\n\n// SetIndent changes the used indentation used when encoding.\nfunc (e *Encoder) SetIndent(spaces int) {\n\tif spaces < 0 {\n\t\tpanic(\"yaml: cannot indent to a negative number of spaces\")\n\t}\n\te.encoder.indent = spaces\n}\n\n// CompactSeqIndent makes it so that '- ' is considered part of the indentation.\nfunc (e *Encoder) CompactSeqIndent() {\n\te.encoder.emitter.compact_sequence_indent = true\n}\n\n// DefaultSeqIndent makes it so that '- ' is not considered part of the indentation.\nfunc (e *Encoder) DefaultSeqIndent() {\n\te.encoder.emitter.compact_sequence_indent = false\n}\n\n// Close closes the encoder by writing any remaining data.\n// It does not write a stream terminating string \"...\".\nfunc (e *Encoder) Close() (err error) {\n\tdefer handleErr(&err)\n\te.encoder.finish()\n\treturn nil\n}\n\nfunc handleErr(err *error) {\n\tif v := recover(); v != nil {\n\t\tif e, ok := v.(yamlError); ok {\n\t\t\t*err = e.err\n\t\t} else {\n\t\t\tpanic(v)\n\t\t}\n\t}\n}\n\ntype yamlError struct {\n\terr error\n}\n\nfunc fail(err error) {\n\tpanic(yamlError{err})\n}\n\nfunc failf(format string, args ...interface{}) {\n\tpanic(yamlError{fmt.Errorf(\"yaml: \"+format, args...)})\n}\n\n// A TypeError is returned by Unmarshal when one or more fields in\n// the YAML document cannot be properly decoded into the requested\n// types. When this error is returned, the value is still\n// unmarshaled partially.\ntype TypeError struct {\n\tErrors []string\n}\n\nfunc (e *TypeError) Error() string {\n\treturn fmt.Sprintf(\"yaml: unmarshal errors:\\n %s\", strings.Join(e.Errors, \"\\n \"))\n}\n\ntype Kind uint32\n\nconst (\n\tDocumentNode Kind = 1 << iota\n\tSequenceNode\n\tMappingNode\n\tScalarNode\n\tAliasNode\n)\n\ntype Style uint32\n\nconst (\n\tTaggedStyle Style = 1 << iota\n\tDoubleQuotedStyle\n\tSingleQuotedStyle\n\tLiteralStyle\n\tFoldedStyle\n\tFlowStyle\n)\n\n// Node represents an element in the YAML document hierarchy. While documents\n// are typically encoded and decoded into higher level types, such as structs\n// and maps, Node is an intermediate representation that allows detailed\n// control over the content being decoded or encoded.\n//\n// It's worth noting that although Node offers access into details such as\n// line numbers, colums, and comments, the content when re-encoded will not\n// have its original textual representation preserved. An effort is made to\n// render the data plesantly, and to preserve comments near the data they\n// describe, though.\n//\n// Values that make use of the Node type interact with the yaml package in the\n// same way any other type would do, by encoding and decoding yaml data\n// directly or indirectly into them.\n//\n// For example:\n//\n//\tvar person struct {\n//\t Name string\n//\t Address yaml.Node\n//\t}\n//\terr := yaml.Unmarshal(data, &person)\n//\n// Or by itself:\n//\n//\tvar person Node\n//\terr := yaml.Unmarshal(data, &person)\ntype Node struct {\n\t// Kind defines whether the node is a document, a mapping, a sequence,\n\t// a scalar value, or an alias to another node. The specific data type of\n\t// scalar nodes may be obtained via the ShortTag and LongTag methods.\n\tKind Kind\n\n\t// Style allows customizing the apperance of the node in the tree.\n\tStyle Style\n\n\t// Tag holds the YAML tag defining the data type for the value.\n\t// When decoding, this field will always be set to the resolved tag,\n\t// even when it wasn't explicitly provided in the YAML content.\n\t// When encoding, if this field is unset the value type will be\n\t// implied from the node properties, and if it is set, it will only\n\t// be serialized into the representation if TaggedStyle is used or\n\t// the implicit tag diverges from the provided one.\n\tTag string\n\n\t// Value holds the unescaped and unquoted represenation of the value.\n\tValue string\n\n\t// Anchor holds the anchor name for this node, which allows aliases to point to it.\n\tAnchor string\n\n\t// Alias holds the node that this alias points to. Only valid when Kind is AliasNode.\n\tAlias *Node\n\n\t// Content holds contained nodes for documents, mappings, and sequences.\n\tContent []*Node\n\n\t// HeadComment holds any comments in the lines preceding the node and\n\t// not separated by an empty line.\n\tHeadComment string\n\n\t// LineComment holds any comments at the end of the line where the node is in.\n\tLineComment string\n\n\t// FootComment holds any comments following the node and before empty lines.\n\tFootComment string\n\n\t// Line and Column hold the node position in the decoded YAML text.\n\t// These fields are not respected when encoding the node.\n\tLine int\n\tColumn int\n}\n\n// IsZero returns whether the node has all of its fields unset.\nfunc (n *Node) IsZero() bool {\n\treturn n.Kind == 0 && n.Style == 0 && n.Tag == \"\" && n.Value == \"\" && n.Anchor == \"\" && n.Alias == nil && n.Content == nil &&\n\t\tn.HeadComment == \"\" && n.LineComment == \"\" && n.FootComment == \"\" && n.Line == 0 && n.Column == 0\n}\n\n// LongTag returns the long form of the tag that indicates the data type for\n// the node. If the Tag field isn't explicitly defined, one will be computed\n// based on the node properties.\nfunc (n *Node) LongTag() string {\n\treturn longTag(n.ShortTag())\n}\n\n// ShortTag returns the short form of the YAML tag that indicates data type for\n// the node. If the Tag field isn't explicitly defined, one will be computed\n// based on the node properties.\nfunc (n *Node) ShortTag() string {\n\tif n.indicatedString() {\n\t\treturn strTag\n\t}\n\tif n.Tag == \"\" || n.Tag == \"!\" {\n\t\tswitch n.Kind {\n\t\tcase MappingNode:\n\t\t\treturn mapTag\n\t\tcase SequenceNode:\n\t\t\treturn seqTag\n\t\tcase AliasNode:\n\t\t\tif n.Alias != nil {\n\t\t\t\treturn n.Alias.ShortTag()\n\t\t\t}\n\t\tcase ScalarNode:\n\t\t\ttag, _ := resolve(\"\", n.Value)\n\t\t\treturn tag\n\t\tcase 0:\n\t\t\t// Special case to make the zero value convenient.\n\t\t\tif n.IsZero() {\n\t\t\t\treturn nullTag\n\t\t\t}\n\t\t}\n\t\treturn \"\"\n\t}\n\treturn shortTag(n.Tag)\n}\n\nfunc (n *Node) indicatedString() bool {\n\treturn n.Kind == ScalarNode &&\n\t\t(shortTag(n.Tag) == strTag ||\n\t\t\t(n.Tag == \"\" || n.Tag == \"!\") && n.Style&(SingleQuotedStyle|DoubleQuotedStyle|LiteralStyle|FoldedStyle) != 0)\n}\n\n// SetString is a convenience function that sets the node to a string value\n// and defines its style in a pleasant way depending on its content.\nfunc (n *Node) SetString(s string) {\n\tn.Kind = ScalarNode\n\tif utf8.ValidString(s) {\n\t\tn.Value = s\n\t\tn.Tag = strTag\n\t} else {\n\t\tn.Value = encodeBase64(s)\n\t\tn.Tag = binaryTag\n\t}\n\tif strings.Contains(n.Value, \"\\n\") {\n\t\tn.Style = LiteralStyle\n\t}\n}\n\n// --------------------------------------------------------------------------\n// Maintain a mapping of keys to structure field indexes\n\n// The code in this section was copied from mgo/bson.\n\n// structInfo holds details for the serialization of fields of\n// a given struct.\ntype structInfo struct {\n\tFieldsMap map[string]fieldInfo\n\tFieldsList []fieldInfo\n\n\t// InlineMap is the number of the field in the struct that\n\t// contains an ,inline map, or -1 if there's none.\n\tInlineMap int\n\n\t// InlineUnmarshalers holds indexes to inlined fields that\n\t// contain unmarshaler values.\n\tInlineUnmarshalers [][]int\n}\n\ntype fieldInfo struct {\n\tKey string\n\tNum int\n\tOmitEmpty bool\n\tFlow bool\n\t// Id holds the unique field identifier, so we can cheaply\n\t// check for field duplicates without maintaining an extra map.\n\tId int\n\n\t// Inline holds the field index if the field is part of an inlined struct.\n\tInline []int\n}\n\nvar structMap = make(map[reflect.Type]*structInfo)\nvar fieldMapMutex sync.RWMutex\nvar unmarshalerType reflect.Type\n\nfunc init() {\n\tvar v Unmarshaler\n\tunmarshalerType = reflect.ValueOf(&v).Elem().Type()\n}\n\nfunc getStructInfo(st reflect.Type) (*structInfo, error) {\n\tfieldMapMutex.RLock()\n\tsinfo, found := structMap[st]\n\tfieldMapMutex.RUnlock()\n\tif found {\n\t\treturn sinfo, nil\n\t}\n\n\tn := st.NumField()\n\tfieldsMap := make(map[string]fieldInfo)\n\tfieldsList := make([]fieldInfo, 0, n)\n\tinlineMap := -1\n\tinlineUnmarshalers := [][]int(nil)\n\tfor i := 0; i != n; i++ {\n\t\tfield := st.Field(i)\n\t\tif field.PkgPath != \"\" && !field.Anonymous {\n\t\t\tcontinue // Private field\n\t\t}\n\n\t\tinfo := fieldInfo{Num: i}\n\n\t\ttag := field.Tag.Get(\"yaml\")\n\t\tif tag == \"\" && strings.Index(string(field.Tag), \":\") < 0 {\n\t\t\ttag = string(field.Tag)\n\t\t}\n\t\tif tag == \"-\" {\n\t\t\tcontinue\n\t\t}\n\n\t\tinline := false\n\t\tfields := strings.Split(tag, \",\")\n\t\tif len(fields) > 1 {\n\t\t\tfor _, flag := range fields[1:] {\n\t\t\t\tswitch flag {\n\t\t\t\tcase \"omitempty\":\n\t\t\t\t\tinfo.OmitEmpty = true\n\t\t\t\tcase \"flow\":\n\t\t\t\t\tinfo.Flow = true\n\t\t\t\tcase \"inline\":\n\t\t\t\t\tinline = true\n\t\t\t\tdefault:\n\t\t\t\t\treturn nil, errors.New(fmt.Sprintf(\"unsupported flag %q in tag %q of type %s\", flag, tag, st))\n\t\t\t\t}\n\t\t\t}\n\t\t\ttag = fields[0]\n\t\t}\n\n\t\tif inline {\n\t\t\tswitch field.Type.Kind() {\n\t\t\tcase reflect.Map:\n\t\t\t\tif inlineMap >= 0 {\n\t\t\t\t\treturn nil, errors.New(\"multiple ,inline maps in struct \" + st.String())\n\t\t\t\t}\n\t\t\t\tif field.Type.Key() != reflect.TypeOf(\"\") {\n\t\t\t\t\treturn nil, errors.New(\"option ,inline needs a map with string keys in struct \" + st.String())\n\t\t\t\t}\n\t\t\t\tinlineMap = info.Num\n\t\t\tcase reflect.Struct, reflect.Ptr:\n\t\t\t\tftype := field.Type\n\t\t\t\tfor ftype.Kind() == reflect.Ptr {\n\t\t\t\t\tftype = ftype.Elem()\n\t\t\t\t}\n\t\t\t\tif ftype.Kind() != reflect.Struct {\n\t\t\t\t\treturn nil, errors.New(\"option ,inline may only be used on a struct or map field\")\n\t\t\t\t}\n\t\t\t\tif reflect.PtrTo(ftype).Implements(unmarshalerType) {\n\t\t\t\t\tinlineUnmarshalers = append(inlineUnmarshalers, []int{i})\n\t\t\t\t} else {\n\t\t\t\t\tsinfo, err := getStructInfo(ftype)\n\t\t\t\t\tif err != nil {\n\t\t\t\t\t\treturn nil, err\n\t\t\t\t\t}\n\t\t\t\t\tfor _, index := range sinfo.InlineUnmarshalers {\n\t\t\t\t\t\tinlineUnmarshalers = append(inlineUnmarshalers, append([]int{i}, index...))\n\t\t\t\t\t}\n\t\t\t\t\tfor _, finfo := range sinfo.FieldsList {\n\t\t\t\t\t\tif _, found := fieldsMap[finfo.Key]; found {\n\t\t\t\t\t\t\tmsg := \"duplicated key '\" + finfo.Key + \"' in struct \" + st.String()\n\t\t\t\t\t\t\treturn nil, errors.New(msg)\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif finfo.Inline == nil {\n\t\t\t\t\t\t\tfinfo.Inline = []int{i, finfo.Num}\n\t\t\t\t\t\t} else {\n\t\t\t\t\t\t\tfinfo.Inline = append([]int{i}, finfo.Inline...)\n\t\t\t\t\t\t}\n\t\t\t\t\t\tfinfo.Id = len(fieldsList)\n\t\t\t\t\t\tfieldsMap[finfo.Key] = finfo\n\t\t\t\t\t\tfieldsList = append(fieldsList, finfo)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\tdefault:\n\t\t\t\treturn nil, errors.New(\"option ,inline may only be used on a struct or map field\")\n\t\t\t}\n\t\t\tcontinue\n\t\t}\n\n\t\tif tag != \"\" {\n\t\t\tinfo.Key = tag\n\t\t} else {\n\t\t\tinfo.Key = strings.ToLower(field.Name)\n\t\t}\n\n\t\tif _, found = fieldsMap[info.Key]; found {\n\t\t\tmsg := \"duplicated key '\" + info.Key + \"' in struct \" + st.String()\n\t\t\treturn nil, errors.New(msg)\n\t\t}\n\n\t\tinfo.Id = len(fieldsList)\n\t\tfieldsList = append(fieldsList, info)\n\t\tfieldsMap[info.Key] = info\n\t}\n\n\tsinfo = &structInfo{\n\t\tFieldsMap: fieldsMap,\n\t\tFieldsList: fieldsList,\n\t\tInlineMap: inlineMap,\n\t\tInlineUnmarshalers: inlineUnmarshalers,\n\t}\n\n\tfieldMapMutex.Lock()\n\tstructMap[st] = sinfo\n\tfieldMapMutex.Unlock()\n\treturn sinfo, nil\n}\n\n// IsZeroer is used to check whether an object is zero to\n// determine whether it should be omitted when marshaling\n// with the omitempty flag. One notable implementation\n// is time.Time.\ntype IsZeroer interface {\n\tIsZero() bool\n}\n\nfunc isZero(v reflect.Value) bool {\n\tkind := v.Kind()\n\tif z, ok := v.Interface().(IsZeroer); ok {\n\t\tif (kind == reflect.Ptr || kind == reflect.Interface) && v.IsNil() {\n\t\t\treturn true\n\t\t}\n\t\treturn z.IsZero()\n\t}\n\tswitch kind {\n\tcase reflect.String:\n\t\treturn len(v.String()) == 0\n\tcase reflect.Interface, reflect.Ptr:\n\t\treturn v.IsNil()\n\tcase reflect.Slice:\n\t\treturn v.Len() == 0\n\tcase reflect.Map:\n\t\treturn v.Len() == 0\n\tcase reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:\n\t\treturn v.Int() == 0\n\tcase reflect.Float32, reflect.Float64:\n\t\treturn v.Float() == 0\n\tcase reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:\n\t\treturn v.Uint() == 0\n\tcase reflect.Bool:\n\t\treturn !v.Bool()\n\tcase reflect.Struct:\n\t\tvt := v.Type()\n\t\tfor i := v.NumField() - 1; i >= 0; i-- {\n\t\t\tif vt.Field(i).PkgPath != \"\" {\n\t\t\t\tcontinue // Private field\n\t\t\t}\n\t\t\tif !isZero(v.Field(i)) {\n\t\t\t\treturn false\n\t\t\t}\n\t\t}\n\t\treturn true\n\t}\n\treturn false\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/yamlh.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n// Copyright (c) 2006-2010 Kirill Simonov\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy of\n// this software and associated documentation files (the \"Software\"), to deal in\n// the Software without restriction, including without limitation the rights to\n// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n// of the Software, and to permit persons to whom the Software is furnished to do\n// so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\npackage yaml\n\nimport (\n\t\"fmt\"\n\t\"io\"\n)\n\n// The version directive data.\ntype yaml_version_directive_t struct {\n\tmajor int8 // The major version number.\n\tminor int8 // The minor version number.\n}\n\n// The tag directive data.\ntype yaml_tag_directive_t struct {\n\thandle []byte // The tag handle.\n\tprefix []byte // The tag prefix.\n}\n\ntype yaml_encoding_t int\n\n// The stream encoding.\nconst (\n\t// Let the parser choose the encoding.\n\tyaml_ANY_ENCODING yaml_encoding_t = iota\n\n\tyaml_UTF8_ENCODING // The default UTF-8 encoding.\n\tyaml_UTF16LE_ENCODING // The UTF-16-LE encoding with BOM.\n\tyaml_UTF16BE_ENCODING // The UTF-16-BE encoding with BOM.\n)\n\ntype yaml_break_t int\n\n// Line break types.\nconst (\n\t// Let the parser choose the break type.\n\tyaml_ANY_BREAK yaml_break_t = iota\n\n\tyaml_CR_BREAK // Use CR for line breaks (Mac style).\n\tyaml_LN_BREAK // Use LN for line breaks (Unix style).\n\tyaml_CRLN_BREAK // Use CR LN for line breaks (DOS style).\n)\n\ntype yaml_error_type_t int\n\n// Many bad things could happen with the parser and emitter.\nconst (\n\t// No error is produced.\n\tyaml_NO_ERROR yaml_error_type_t = iota\n\n\tyaml_MEMORY_ERROR // Cannot allocate or reallocate a block of memory.\n\tyaml_READER_ERROR // Cannot read or decode the input stream.\n\tyaml_SCANNER_ERROR // Cannot scan the input stream.\n\tyaml_PARSER_ERROR // Cannot parse the input stream.\n\tyaml_COMPOSER_ERROR // Cannot compose a YAML document.\n\tyaml_WRITER_ERROR // Cannot write to the output stream.\n\tyaml_EMITTER_ERROR // Cannot emit a YAML stream.\n)\n\n// The pointer position.\ntype yaml_mark_t struct {\n\tindex int // The position index.\n\tline int // The position line.\n\tcolumn int // The position column.\n}\n\n// Node Styles\n\ntype yaml_style_t int8\n\ntype yaml_scalar_style_t yaml_style_t\n\n// Scalar styles.\nconst (\n\t// Let the emitter choose the style.\n\tyaml_ANY_SCALAR_STYLE yaml_scalar_style_t = 0\n\n\tyaml_PLAIN_SCALAR_STYLE yaml_scalar_style_t = 1 << iota // The plain scalar style.\n\tyaml_SINGLE_QUOTED_SCALAR_STYLE // The single-quoted scalar style.\n\tyaml_DOUBLE_QUOTED_SCALAR_STYLE // The double-quoted scalar style.\n\tyaml_LITERAL_SCALAR_STYLE // The literal scalar style.\n\tyaml_FOLDED_SCALAR_STYLE // The folded scalar style.\n)\n\ntype yaml_sequence_style_t yaml_style_t\n\n// Sequence styles.\nconst (\n\t// Let the emitter choose the style.\n\tyaml_ANY_SEQUENCE_STYLE yaml_sequence_style_t = iota\n\n\tyaml_BLOCK_SEQUENCE_STYLE // The block sequence style.\n\tyaml_FLOW_SEQUENCE_STYLE // The flow sequence style.\n)\n\ntype yaml_mapping_style_t yaml_style_t\n\n// Mapping styles.\nconst (\n\t// Let the emitter choose the style.\n\tyaml_ANY_MAPPING_STYLE yaml_mapping_style_t = iota\n\n\tyaml_BLOCK_MAPPING_STYLE // The block mapping style.\n\tyaml_FLOW_MAPPING_STYLE // The flow mapping style.\n)\n\n// Tokens\n\ntype yaml_token_type_t int\n\n// Token types.\nconst (\n\t// An empty token.\n\tyaml_NO_TOKEN yaml_token_type_t = iota\n\n\tyaml_STREAM_START_TOKEN // A STREAM-START token.\n\tyaml_STREAM_END_TOKEN // A STREAM-END token.\n\n\tyaml_VERSION_DIRECTIVE_TOKEN // A VERSION-DIRECTIVE token.\n\tyaml_TAG_DIRECTIVE_TOKEN // A TAG-DIRECTIVE token.\n\tyaml_DOCUMENT_START_TOKEN // A DOCUMENT-START token.\n\tyaml_DOCUMENT_END_TOKEN // A DOCUMENT-END token.\n\n\tyaml_BLOCK_SEQUENCE_START_TOKEN // A BLOCK-SEQUENCE-START token.\n\tyaml_BLOCK_MAPPING_START_TOKEN // A BLOCK-SEQUENCE-END token.\n\tyaml_BLOCK_END_TOKEN // A BLOCK-END token.\n\n\tyaml_FLOW_SEQUENCE_START_TOKEN // A FLOW-SEQUENCE-START token.\n\tyaml_FLOW_SEQUENCE_END_TOKEN // A FLOW-SEQUENCE-END token.\n\tyaml_FLOW_MAPPING_START_TOKEN // A FLOW-MAPPING-START token.\n\tyaml_FLOW_MAPPING_END_TOKEN // A FLOW-MAPPING-END token.\n\n\tyaml_BLOCK_ENTRY_TOKEN // A BLOCK-ENTRY token.\n\tyaml_FLOW_ENTRY_TOKEN // A FLOW-ENTRY token.\n\tyaml_KEY_TOKEN // A KEY token.\n\tyaml_VALUE_TOKEN // A VALUE token.\n\n\tyaml_ALIAS_TOKEN // An ALIAS token.\n\tyaml_ANCHOR_TOKEN // An ANCHOR token.\n\tyaml_TAG_TOKEN // A TAG token.\n\tyaml_SCALAR_TOKEN // A SCALAR token.\n)\n\nfunc (tt yaml_token_type_t) String() string {\n\tswitch tt {\n\tcase yaml_NO_TOKEN:\n\t\treturn \"yaml_NO_TOKEN\"\n\tcase yaml_STREAM_START_TOKEN:\n\t\treturn \"yaml_STREAM_START_TOKEN\"\n\tcase yaml_STREAM_END_TOKEN:\n\t\treturn \"yaml_STREAM_END_TOKEN\"\n\tcase yaml_VERSION_DIRECTIVE_TOKEN:\n\t\treturn \"yaml_VERSION_DIRECTIVE_TOKEN\"\n\tcase yaml_TAG_DIRECTIVE_TOKEN:\n\t\treturn \"yaml_TAG_DIRECTIVE_TOKEN\"\n\tcase yaml_DOCUMENT_START_TOKEN:\n\t\treturn \"yaml_DOCUMENT_START_TOKEN\"\n\tcase yaml_DOCUMENT_END_TOKEN:\n\t\treturn \"yaml_DOCUMENT_END_TOKEN\"\n\tcase yaml_BLOCK_SEQUENCE_START_TOKEN:\n\t\treturn \"yaml_BLOCK_SEQUENCE_START_TOKEN\"\n\tcase yaml_BLOCK_MAPPING_START_TOKEN:\n\t\treturn \"yaml_BLOCK_MAPPING_START_TOKEN\"\n\tcase yaml_BLOCK_END_TOKEN:\n\t\treturn \"yaml_BLOCK_END_TOKEN\"\n\tcase yaml_FLOW_SEQUENCE_START_TOKEN:\n\t\treturn \"yaml_FLOW_SEQUENCE_START_TOKEN\"\n\tcase yaml_FLOW_SEQUENCE_END_TOKEN:\n\t\treturn \"yaml_FLOW_SEQUENCE_END_TOKEN\"\n\tcase yaml_FLOW_MAPPING_START_TOKEN:\n\t\treturn \"yaml_FLOW_MAPPING_START_TOKEN\"\n\tcase yaml_FLOW_MAPPING_END_TOKEN:\n\t\treturn \"yaml_FLOW_MAPPING_END_TOKEN\"\n\tcase yaml_BLOCK_ENTRY_TOKEN:\n\t\treturn \"yaml_BLOCK_ENTRY_TOKEN\"\n\tcase yaml_FLOW_ENTRY_TOKEN:\n\t\treturn \"yaml_FLOW_ENTRY_TOKEN\"\n\tcase yaml_KEY_TOKEN:\n\t\treturn \"yaml_KEY_TOKEN\"\n\tcase yaml_VALUE_TOKEN:\n\t\treturn \"yaml_VALUE_TOKEN\"\n\tcase yaml_ALIAS_TOKEN:\n\t\treturn \"yaml_ALIAS_TOKEN\"\n\tcase yaml_ANCHOR_TOKEN:\n\t\treturn \"yaml_ANCHOR_TOKEN\"\n\tcase yaml_TAG_TOKEN:\n\t\treturn \"yaml_TAG_TOKEN\"\n\tcase yaml_SCALAR_TOKEN:\n\t\treturn \"yaml_SCALAR_TOKEN\"\n\t}\n\treturn \"\"\n}\n\n// The token structure.\ntype yaml_token_t struct {\n\t// The token type.\n\ttyp yaml_token_type_t\n\n\t// The start/end of the token.\n\tstart_mark, end_mark yaml_mark_t\n\n\t// The stream encoding (for yaml_STREAM_START_TOKEN).\n\tencoding yaml_encoding_t\n\n\t// The alias/anchor/scalar value or tag/tag directive handle\n\t// (for yaml_ALIAS_TOKEN, yaml_ANCHOR_TOKEN, yaml_SCALAR_TOKEN, yaml_TAG_TOKEN, yaml_TAG_DIRECTIVE_TOKEN).\n\tvalue []byte\n\n\t// The tag suffix (for yaml_TAG_TOKEN).\n\tsuffix []byte\n\n\t// The tag directive prefix (for yaml_TAG_DIRECTIVE_TOKEN).\n\tprefix []byte\n\n\t// The scalar style (for yaml_SCALAR_TOKEN).\n\tstyle yaml_scalar_style_t\n\n\t// The version directive major/minor (for yaml_VERSION_DIRECTIVE_TOKEN).\n\tmajor, minor int8\n}\n\n// Events\n\ntype yaml_event_type_t int8\n\n// Event types.\nconst (\n\t// An empty event.\n\tyaml_NO_EVENT yaml_event_type_t = iota\n\n\tyaml_STREAM_START_EVENT // A STREAM-START event.\n\tyaml_STREAM_END_EVENT // A STREAM-END event.\n\tyaml_DOCUMENT_START_EVENT // A DOCUMENT-START event.\n\tyaml_DOCUMENT_END_EVENT // A DOCUMENT-END event.\n\tyaml_ALIAS_EVENT // An ALIAS event.\n\tyaml_SCALAR_EVENT // A SCALAR event.\n\tyaml_SEQUENCE_START_EVENT // A SEQUENCE-START event.\n\tyaml_SEQUENCE_END_EVENT // A SEQUENCE-END event.\n\tyaml_MAPPING_START_EVENT // A MAPPING-START event.\n\tyaml_MAPPING_END_EVENT // A MAPPING-END event.\n\tyaml_TAIL_COMMENT_EVENT\n)\n\nvar eventStrings = []string{\n\tyaml_NO_EVENT: \"none\",\n\tyaml_STREAM_START_EVENT: \"stream start\",\n\tyaml_STREAM_END_EVENT: \"stream end\",\n\tyaml_DOCUMENT_START_EVENT: \"document start\",\n\tyaml_DOCUMENT_END_EVENT: \"document end\",\n\tyaml_ALIAS_EVENT: \"alias\",\n\tyaml_SCALAR_EVENT: \"scalar\",\n\tyaml_SEQUENCE_START_EVENT: \"sequence start\",\n\tyaml_SEQUENCE_END_EVENT: \"sequence end\",\n\tyaml_MAPPING_START_EVENT: \"mapping start\",\n\tyaml_MAPPING_END_EVENT: \"mapping end\",\n\tyaml_TAIL_COMMENT_EVENT: \"tail comment\",\n}\n\nfunc (e yaml_event_type_t) String() string {\n\tif e < 0 || int(e) >= len(eventStrings) {\n\t\treturn fmt.Sprintf(\"unknown event %d\", e)\n\t}\n\treturn eventStrings[e]\n}\n\n// The event structure.\ntype yaml_event_t struct {\n\n\t// The event type.\n\ttyp yaml_event_type_t\n\n\t// The start and end of the event.\n\tstart_mark, end_mark yaml_mark_t\n\n\t// The document encoding (for yaml_STREAM_START_EVENT).\n\tencoding yaml_encoding_t\n\n\t// The version directive (for yaml_DOCUMENT_START_EVENT).\n\tversion_directive *yaml_version_directive_t\n\n\t// The list of tag directives (for yaml_DOCUMENT_START_EVENT).\n\ttag_directives []yaml_tag_directive_t\n\n\t// The comments\n\thead_comment []byte\n\tline_comment []byte\n\tfoot_comment []byte\n\ttail_comment []byte\n\n\t// The anchor (for yaml_SCALAR_EVENT, yaml_SEQUENCE_START_EVENT, yaml_MAPPING_START_EVENT, yaml_ALIAS_EVENT).\n\tanchor []byte\n\n\t// The tag (for yaml_SCALAR_EVENT, yaml_SEQUENCE_START_EVENT, yaml_MAPPING_START_EVENT).\n\ttag []byte\n\n\t// The scalar value (for yaml_SCALAR_EVENT).\n\tvalue []byte\n\n\t// Is the document start/end indicator implicit, or the tag optional?\n\t// (for yaml_DOCUMENT_START_EVENT, yaml_DOCUMENT_END_EVENT, yaml_SEQUENCE_START_EVENT, yaml_MAPPING_START_EVENT, yaml_SCALAR_EVENT).\n\timplicit bool\n\n\t// Is the tag optional for any non-plain style? (for yaml_SCALAR_EVENT).\n\tquoted_implicit bool\n\n\t// The style (for yaml_SCALAR_EVENT, yaml_SEQUENCE_START_EVENT, yaml_MAPPING_START_EVENT).\n\tstyle yaml_style_t\n}\n\nfunc (e *yaml_event_t) scalar_style() yaml_scalar_style_t { return yaml_scalar_style_t(e.style) }\nfunc (e *yaml_event_t) sequence_style() yaml_sequence_style_t { return yaml_sequence_style_t(e.style) }\nfunc (e *yaml_event_t) mapping_style() yaml_mapping_style_t { return yaml_mapping_style_t(e.style) }\n\n// Nodes\n\nconst (\n\tyaml_NULL_TAG = \"tag:yaml.org,2002:null\" // The tag !!null with the only possible value: null.\n\tyaml_BOOL_TAG = \"tag:yaml.org,2002:bool\" // The tag !!bool with the values: true and false.\n\tyaml_STR_TAG = \"tag:yaml.org,2002:str\" // The tag !!str for string values.\n\tyaml_INT_TAG = \"tag:yaml.org,2002:int\" // The tag !!int for integer values.\n\tyaml_FLOAT_TAG = \"tag:yaml.org,2002:float\" // The tag !!float for float values.\n\tyaml_TIMESTAMP_TAG = \"tag:yaml.org,2002:timestamp\" // The tag !!timestamp for date and time values.\n\n\tyaml_SEQ_TAG = \"tag:yaml.org,2002:seq\" // The tag !!seq is used to denote sequences.\n\tyaml_MAP_TAG = \"tag:yaml.org,2002:map\" // The tag !!map is used to denote mapping.\n\n\t// Not in original libyaml.\n\tyaml_BINARY_TAG = \"tag:yaml.org,2002:binary\"\n\tyaml_MERGE_TAG = \"tag:yaml.org,2002:merge\"\n\n\tyaml_DEFAULT_SCALAR_TAG = yaml_STR_TAG // The default scalar tag is !!str.\n\tyaml_DEFAULT_SEQUENCE_TAG = yaml_SEQ_TAG // The default sequence tag is !!seq.\n\tyaml_DEFAULT_MAPPING_TAG = yaml_MAP_TAG // The default mapping tag is !!map.\n)\n\ntype yaml_node_type_t int\n\n// Node types.\nconst (\n\t// An empty node.\n\tyaml_NO_NODE yaml_node_type_t = iota\n\n\tyaml_SCALAR_NODE // A scalar node.\n\tyaml_SEQUENCE_NODE // A sequence node.\n\tyaml_MAPPING_NODE // A mapping node.\n)\n\n// An element of a sequence node.\ntype yaml_node_item_t int\n\n// An element of a mapping node.\ntype yaml_node_pair_t struct {\n\tkey int // The key of the element.\n\tvalue int // The value of the element.\n}\n\n// The node structure.\ntype yaml_node_t struct {\n\ttyp yaml_node_type_t // The node type.\n\ttag []byte // The node tag.\n\n\t// The node data.\n\n\t// The scalar parameters (for yaml_SCALAR_NODE).\n\tscalar struct {\n\t\tvalue []byte // The scalar value.\n\t\tlength int // The length of the scalar value.\n\t\tstyle yaml_scalar_style_t // The scalar style.\n\t}\n\n\t// The sequence parameters (for YAML_SEQUENCE_NODE).\n\tsequence struct {\n\t\titems_data []yaml_node_item_t // The stack of sequence items.\n\t\tstyle yaml_sequence_style_t // The sequence style.\n\t}\n\n\t// The mapping parameters (for yaml_MAPPING_NODE).\n\tmapping struct {\n\t\tpairs_data []yaml_node_pair_t // The stack of mapping pairs (key, value).\n\t\tpairs_start *yaml_node_pair_t // The beginning of the stack.\n\t\tpairs_end *yaml_node_pair_t // The end of the stack.\n\t\tpairs_top *yaml_node_pair_t // The top of the stack.\n\t\tstyle yaml_mapping_style_t // The mapping style.\n\t}\n\n\tstart_mark yaml_mark_t // The beginning of the node.\n\tend_mark yaml_mark_t // The end of the node.\n\n}\n\n// The document structure.\ntype yaml_document_t struct {\n\n\t// The document nodes.\n\tnodes []yaml_node_t\n\n\t// The version directive.\n\tversion_directive *yaml_version_directive_t\n\n\t// The list of tag directives.\n\ttag_directives_data []yaml_tag_directive_t\n\ttag_directives_start int // The beginning of the tag directives list.\n\ttag_directives_end int // The end of the tag directives list.\n\n\tstart_implicit int // Is the document start indicator implicit?\n\tend_implicit int // Is the document end indicator implicit?\n\n\t// The start/end of the document.\n\tstart_mark, end_mark yaml_mark_t\n}\n\n// The prototype of a read handler.\n//\n// The read handler is called when the parser needs to read more bytes from the\n// source. The handler should write not more than size bytes to the buffer.\n// The number of written bytes should be set to the size_read variable.\n//\n// [in,out] data A pointer to an application data specified by\n//\n//\tyaml_parser_set_input().\n//\n// [out] buffer The buffer to write the data from the source.\n// [in] size The size of the buffer.\n// [out] size_read The actual number of bytes read from the source.\n//\n// On success, the handler should return 1. If the handler failed,\n// the returned value should be 0. On EOF, the handler should set the\n// size_read to 0 and return 1.\ntype yaml_read_handler_t func(parser *yaml_parser_t, buffer []byte) (n int, err error)\n\n// This structure holds information about a potential simple key.\ntype yaml_simple_key_t struct {\n\tpossible bool // Is a simple key possible?\n\trequired bool // Is a simple key required?\n\ttoken_number int // The number of the token.\n\tmark yaml_mark_t // The position mark.\n}\n\n// The states of the parser.\ntype yaml_parser_state_t int\n\nconst (\n\tyaml_PARSE_STREAM_START_STATE yaml_parser_state_t = iota\n\n\tyaml_PARSE_IMPLICIT_DOCUMENT_START_STATE // Expect the beginning of an implicit document.\n\tyaml_PARSE_DOCUMENT_START_STATE // Expect DOCUMENT-START.\n\tyaml_PARSE_DOCUMENT_CONTENT_STATE // Expect the content of a document.\n\tyaml_PARSE_DOCUMENT_END_STATE // Expect DOCUMENT-END.\n\tyaml_PARSE_BLOCK_NODE_STATE // Expect a block node.\n\tyaml_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE // Expect a block node or indentless sequence.\n\tyaml_PARSE_FLOW_NODE_STATE // Expect a flow node.\n\tyaml_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE // Expect the first entry of a block sequence.\n\tyaml_PARSE_BLOCK_SEQUENCE_ENTRY_STATE // Expect an entry of a block sequence.\n\tyaml_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE // Expect an entry of an indentless sequence.\n\tyaml_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE // Expect the first key of a block mapping.\n\tyaml_PARSE_BLOCK_MAPPING_KEY_STATE // Expect a block mapping key.\n\tyaml_PARSE_BLOCK_MAPPING_VALUE_STATE // Expect a block mapping value.\n\tyaml_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE // Expect the first entry of a flow sequence.\n\tyaml_PARSE_FLOW_SEQUENCE_ENTRY_STATE // Expect an entry of a flow sequence.\n\tyaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE // Expect a key of an ordered mapping.\n\tyaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE // Expect a value of an ordered mapping.\n\tyaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE // Expect the and of an ordered mapping entry.\n\tyaml_PARSE_FLOW_MAPPING_FIRST_KEY_STATE // Expect the first key of a flow mapping.\n\tyaml_PARSE_FLOW_MAPPING_KEY_STATE // Expect a key of a flow mapping.\n\tyaml_PARSE_FLOW_MAPPING_VALUE_STATE // Expect a value of a flow mapping.\n\tyaml_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE // Expect an empty value of a flow mapping.\n\tyaml_PARSE_END_STATE // Expect nothing.\n)\n\nfunc (ps yaml_parser_state_t) String() string {\n\tswitch ps {\n\tcase yaml_PARSE_STREAM_START_STATE:\n\t\treturn \"yaml_PARSE_STREAM_START_STATE\"\n\tcase yaml_PARSE_IMPLICIT_DOCUMENT_START_STATE:\n\t\treturn \"yaml_PARSE_IMPLICIT_DOCUMENT_START_STATE\"\n\tcase yaml_PARSE_DOCUMENT_START_STATE:\n\t\treturn \"yaml_PARSE_DOCUMENT_START_STATE\"\n\tcase yaml_PARSE_DOCUMENT_CONTENT_STATE:\n\t\treturn \"yaml_PARSE_DOCUMENT_CONTENT_STATE\"\n\tcase yaml_PARSE_DOCUMENT_END_STATE:\n\t\treturn \"yaml_PARSE_DOCUMENT_END_STATE\"\n\tcase yaml_PARSE_BLOCK_NODE_STATE:\n\t\treturn \"yaml_PARSE_BLOCK_NODE_STATE\"\n\tcase yaml_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE:\n\t\treturn \"yaml_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE\"\n\tcase yaml_PARSE_FLOW_NODE_STATE:\n\t\treturn \"yaml_PARSE_FLOW_NODE_STATE\"\n\tcase yaml_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE:\n\t\treturn \"yaml_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE\"\n\tcase yaml_PARSE_BLOCK_SEQUENCE_ENTRY_STATE:\n\t\treturn \"yaml_PARSE_BLOCK_SEQUENCE_ENTRY_STATE\"\n\tcase yaml_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE:\n\t\treturn \"yaml_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE\"\n\tcase yaml_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE:\n\t\treturn \"yaml_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE\"\n\tcase yaml_PARSE_BLOCK_MAPPING_KEY_STATE:\n\t\treturn \"yaml_PARSE_BLOCK_MAPPING_KEY_STATE\"\n\tcase yaml_PARSE_BLOCK_MAPPING_VALUE_STATE:\n\t\treturn \"yaml_PARSE_BLOCK_MAPPING_VALUE_STATE\"\n\tcase yaml_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE:\n\t\treturn \"yaml_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE\"\n\tcase yaml_PARSE_FLOW_SEQUENCE_ENTRY_STATE:\n\t\treturn \"yaml_PARSE_FLOW_SEQUENCE_ENTRY_STATE\"\n\tcase yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE:\n\t\treturn \"yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE\"\n\tcase yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE:\n\t\treturn \"yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE\"\n\tcase yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE:\n\t\treturn \"yaml_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE\"\n\tcase yaml_PARSE_FLOW_MAPPING_FIRST_KEY_STATE:\n\t\treturn \"yaml_PARSE_FLOW_MAPPING_FIRST_KEY_STATE\"\n\tcase yaml_PARSE_FLOW_MAPPING_KEY_STATE:\n\t\treturn \"yaml_PARSE_FLOW_MAPPING_KEY_STATE\"\n\tcase yaml_PARSE_FLOW_MAPPING_VALUE_STATE:\n\t\treturn \"yaml_PARSE_FLOW_MAPPING_VALUE_STATE\"\n\tcase yaml_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE:\n\t\treturn \"yaml_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE\"\n\tcase yaml_PARSE_END_STATE:\n\t\treturn \"yaml_PARSE_END_STATE\"\n\t}\n\treturn \"\"\n}\n\n// This structure holds aliases data.\ntype yaml_alias_data_t struct {\n\tanchor []byte // The anchor.\n\tindex int // The node id.\n\tmark yaml_mark_t // The anchor mark.\n}\n\n// The parser structure.\n//\n// All members are internal. Manage the structure using the\n// yaml_parser_ family of functions.\ntype yaml_parser_t struct {\n\n\t// Error handling\n\n\terror yaml_error_type_t // Error type.\n\n\tproblem string // Error description.\n\n\t// The byte about which the problem occurred.\n\tproblem_offset int\n\tproblem_value int\n\tproblem_mark yaml_mark_t\n\n\t// The error context.\n\tcontext string\n\tcontext_mark yaml_mark_t\n\n\t// Reader stuff\n\n\tread_handler yaml_read_handler_t // Read handler.\n\n\tinput_reader io.Reader // File input data.\n\tinput []byte // String input data.\n\tinput_pos int\n\n\teof bool // EOF flag\n\n\tbuffer []byte // The working buffer.\n\tbuffer_pos int // The current position of the buffer.\n\n\tunread int // The number of unread characters in the buffer.\n\n\tnewlines int // The number of line breaks since last non-break/non-blank character\n\n\traw_buffer []byte // The raw buffer.\n\traw_buffer_pos int // The current position of the buffer.\n\n\tencoding yaml_encoding_t // The input encoding.\n\n\toffset int // The offset of the current position (in bytes).\n\tmark yaml_mark_t // The mark of the current position.\n\n\t// Comments\n\n\thead_comment []byte // The current head comments\n\tline_comment []byte // The current line comments\n\tfoot_comment []byte // The current foot comments\n\ttail_comment []byte // Foot comment that happens at the end of a block.\n\tstem_comment []byte // Comment in item preceding a nested structure (list inside list item, etc)\n\n\tcomments []yaml_comment_t // The folded comments for all parsed tokens\n\tcomments_head int\n\n\t// Scanner stuff\n\n\tstream_start_produced bool // Have we started to scan the input stream?\n\tstream_end_produced bool // Have we reached the end of the input stream?\n\n\tflow_level int // The number of unclosed '[' and '{' indicators.\n\n\ttokens []yaml_token_t // The tokens queue.\n\ttokens_head int // The head of the tokens queue.\n\ttokens_parsed int // The number of tokens fetched from the queue.\n\ttoken_available bool // Does the tokens queue contain a token ready for dequeueing.\n\n\tindent int // The current indentation level.\n\tindents []int // The indentation levels stack.\n\n\tsimple_key_allowed bool // May a simple key occur at the current position?\n\tsimple_keys []yaml_simple_key_t // The stack of simple keys.\n\tsimple_keys_by_tok map[int]int // possible simple_key indexes indexed by token_number\n\n\t// Parser stuff\n\n\tstate yaml_parser_state_t // The current parser state.\n\tstates []yaml_parser_state_t // The parser states stack.\n\tmarks []yaml_mark_t // The stack of marks.\n\ttag_directives []yaml_tag_directive_t // The list of TAG directives.\n\n\t// Dumper stuff\n\n\taliases []yaml_alias_data_t // The alias data.\n\n\tdocument *yaml_document_t // The currently parsed document.\n}\n\ntype yaml_comment_t struct {\n\tscan_mark yaml_mark_t // Position where scanning for comments started\n\ttoken_mark yaml_mark_t // Position after which tokens will be associated with this comment\n\tstart_mark yaml_mark_t // Position of '#' comment mark\n\tend_mark yaml_mark_t // Position where comment terminated\n\n\thead []byte\n\tline []byte\n\tfoot []byte\n}\n\n// Emitter Definitions\n\n// The prototype of a write handler.\n//\n// The write handler is called when the emitter needs to flush the accumulated\n// characters to the output. The handler should write @a size bytes of the\n// @a buffer to the output.\n//\n// @param[in,out] data A pointer to an application data specified by\n//\n//\tyaml_emitter_set_output().\n//\n// @param[in] buffer The buffer with bytes to be written.\n// @param[in] size The size of the buffer.\n//\n// @returns On success, the handler should return @c 1. If the handler failed,\n// the returned value should be @c 0.\ntype yaml_write_handler_t func(emitter *yaml_emitter_t, buffer []byte) error\n\ntype yaml_emitter_state_t int\n\n// The emitter states.\nconst (\n\t// Expect STREAM-START.\n\tyaml_EMIT_STREAM_START_STATE yaml_emitter_state_t = iota\n\n\tyaml_EMIT_FIRST_DOCUMENT_START_STATE // Expect the first DOCUMENT-START or STREAM-END.\n\tyaml_EMIT_DOCUMENT_START_STATE // Expect DOCUMENT-START or STREAM-END.\n\tyaml_EMIT_DOCUMENT_CONTENT_STATE // Expect the content of a document.\n\tyaml_EMIT_DOCUMENT_END_STATE // Expect DOCUMENT-END.\n\tyaml_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE // Expect the first item of a flow sequence.\n\tyaml_EMIT_FLOW_SEQUENCE_TRAIL_ITEM_STATE // Expect the next item of a flow sequence, with the comma already written out\n\tyaml_EMIT_FLOW_SEQUENCE_ITEM_STATE // Expect an item of a flow sequence.\n\tyaml_EMIT_FLOW_MAPPING_FIRST_KEY_STATE // Expect the first key of a flow mapping.\n\tyaml_EMIT_FLOW_MAPPING_TRAIL_KEY_STATE // Expect the next key of a flow mapping, with the comma already written out\n\tyaml_EMIT_FLOW_MAPPING_KEY_STATE // Expect a key of a flow mapping.\n\tyaml_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE // Expect a value for a simple key of a flow mapping.\n\tyaml_EMIT_FLOW_MAPPING_VALUE_STATE // Expect a value of a flow mapping.\n\tyaml_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE // Expect the first item of a block sequence.\n\tyaml_EMIT_BLOCK_SEQUENCE_ITEM_STATE // Expect an item of a block sequence.\n\tyaml_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE // Expect the first key of a block mapping.\n\tyaml_EMIT_BLOCK_MAPPING_KEY_STATE // Expect the key of a block mapping.\n\tyaml_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE // Expect a value for a simple key of a block mapping.\n\tyaml_EMIT_BLOCK_MAPPING_VALUE_STATE // Expect a value of a block mapping.\n\tyaml_EMIT_END_STATE // Expect nothing.\n)\n\n// The emitter structure.\n//\n// All members are internal. Manage the structure using the @c yaml_emitter_\n// family of functions.\ntype yaml_emitter_t struct {\n\n\t// Error handling\n\n\terror yaml_error_type_t // Error type.\n\tproblem string // Error description.\n\n\t// Writer stuff\n\n\twrite_handler yaml_write_handler_t // Write handler.\n\n\toutput_buffer *[]byte // String output data.\n\toutput_writer io.Writer // File output data.\n\n\tbuffer []byte // The working buffer.\n\tbuffer_pos int // The current position of the buffer.\n\n\traw_buffer []byte // The raw buffer.\n\traw_buffer_pos int // The current position of the buffer.\n\n\tencoding yaml_encoding_t // The stream encoding.\n\n\t// Emitter stuff\n\n\tcanonical bool // If the output is in the canonical style?\n\tbest_indent int // The number of indentation spaces.\n\tbest_width int // The preferred width of the output lines.\n\tunicode bool // Allow unescaped non-ASCII characters?\n\tline_break yaml_break_t // The preferred line break.\n\n\tstate yaml_emitter_state_t // The current emitter state.\n\tstates []yaml_emitter_state_t // The stack of states.\n\n\tevents []yaml_event_t // The event queue.\n\tevents_head int // The head of the event queue.\n\n\tindents []int // The stack of indentation levels.\n\n\ttag_directives []yaml_tag_directive_t // The list of tag directives.\n\n\tindent int // The current indentation level.\n\n\tcompact_sequence_indent bool // Is '- ' is considered part of the indentation for sequence elements?\n\n\tflow_level int // The current flow level.\n\n\troot_context bool // Is it the document root context?\n\tsequence_context bool // Is it a sequence context?\n\tmapping_context bool // Is it a mapping context?\n\tsimple_key_context bool // Is it a simple mapping key context?\n\n\tline int // The current line.\n\tcolumn int // The current column.\n\twhitespace bool // If the last character was a whitespace?\n\tindention bool // If the last character was an indentation character (' ', '-', '?', ':')?\n\topen_ended bool // If an explicit document end is required?\n\n\tspace_above bool // Is there's an empty line above?\n\tfoot_indent int // The indent used to write the foot comment above, or -1 if none.\n\n\t// Anchor analysis.\n\tanchor_data struct {\n\t\tanchor []byte // The anchor value.\n\t\talias bool // Is it an alias?\n\t}\n\n\t// Tag analysis.\n\ttag_data struct {\n\t\thandle []byte // The tag handle.\n\t\tsuffix []byte // The tag suffix.\n\t}\n\n\t// Scalar analysis.\n\tscalar_data struct {\n\t\tvalue []byte // The scalar value.\n\t\tmultiline bool // Does the scalar contain line breaks?\n\t\tflow_plain_allowed bool // Can the scalar be expessed in the flow plain style?\n\t\tblock_plain_allowed bool // Can the scalar be expressed in the block plain style?\n\t\tsingle_quoted_allowed bool // Can the scalar be expressed in the single quoted style?\n\t\tblock_allowed bool // Can the scalar be expressed in the literal or folded styles?\n\t\tstyle yaml_scalar_style_t // The output style.\n\t}\n\n\t// Comments\n\thead_comment []byte\n\tline_comment []byte\n\tfoot_comment []byte\n\ttail_comment []byte\n\n\tkey_line_comment []byte\n\n\t// Dumper stuff\n\n\topened bool // If the stream was already opened?\n\tclosed bool // If the stream was already closed?\n\n\t// The information associated with the document nodes.\n\tanchors *struct {\n\t\treferences int // The number of references.\n\t\tanchor int // The anchor id.\n\t\tserialized bool // If the node has been emitted?\n\t}\n\n\tlast_anchor_id int // The last assigned anchor id.\n\n\tdocument *yaml_document_t // The currently emitted document.\n}\n"
},
{
"path": "tests/vendor/go.yaml.in/yaml/v3/yamlprivateh.go",
"content": "//\n// Copyright (c) 2011-2019 Canonical Ltd\n// Copyright (c) 2006-2010 Kirill Simonov\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy of\n// this software and associated documentation files (the \"Software\"), to deal in\n// the Software without restriction, including without limitation the rights to\n// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n// of the Software, and to permit persons to whom the Software is furnished to do\n// so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\npackage yaml\n\nconst (\n\t// The size of the input raw buffer.\n\tinput_raw_buffer_size = 512\n\n\t// The size of the input buffer.\n\t// It should be possible to decode the whole raw buffer.\n\tinput_buffer_size = input_raw_buffer_size * 3\n\n\t// The size of the output buffer.\n\toutput_buffer_size = 128\n\n\t// The size of the output raw buffer.\n\t// It should be possible to encode the whole output buffer.\n\toutput_raw_buffer_size = (output_buffer_size*2 + 2)\n\n\t// The size of other stacks and queues.\n\tinitial_stack_size = 16\n\tinitial_queue_size = 16\n\tinitial_string_size = 16\n)\n\n// Check if the character at the specified position is an alphabetical\n// character, a digit, '_', or '-'.\nfunc is_alpha(b []byte, i int) bool {\n\treturn b[i] >= '0' && b[i] <= '9' || b[i] >= 'A' && b[i] <= 'Z' || b[i] >= 'a' && b[i] <= 'z' || b[i] == '_' || b[i] == '-'\n}\n\n// Check if the character at the specified position is a digit.\nfunc is_digit(b []byte, i int) bool {\n\treturn b[i] >= '0' && b[i] <= '9'\n}\n\n// Get the value of a digit.\nfunc as_digit(b []byte, i int) int {\n\treturn int(b[i]) - '0'\n}\n\n// Check if the character at the specified position is a hex-digit.\nfunc is_hex(b []byte, i int) bool {\n\treturn b[i] >= '0' && b[i] <= '9' || b[i] >= 'A' && b[i] <= 'F' || b[i] >= 'a' && b[i] <= 'f'\n}\n\n// Get the value of a hex-digit.\nfunc as_hex(b []byte, i int) int {\n\tbi := b[i]\n\tif bi >= 'A' && bi <= 'F' {\n\t\treturn int(bi) - 'A' + 10\n\t}\n\tif bi >= 'a' && bi <= 'f' {\n\t\treturn int(bi) - 'a' + 10\n\t}\n\treturn int(bi) - '0'\n}\n\n// Check if the character is ASCII.\nfunc is_ascii(b []byte, i int) bool {\n\treturn b[i] <= 0x7F\n}\n\n// Check if the character at the start of the buffer can be printed unescaped.\nfunc is_printable(b []byte, i int) bool {\n\treturn ((b[i] == 0x0A) || // . == #x0A\n\t\t(b[i] >= 0x20 && b[i] <= 0x7E) || // #x20 <= . <= #x7E\n\t\t(b[i] == 0xC2 && b[i+1] >= 0xA0) || // #0xA0 <= . <= #xD7FF\n\t\t(b[i] > 0xC2 && b[i] < 0xED) ||\n\t\t(b[i] == 0xED && b[i+1] < 0xA0) ||\n\t\t(b[i] == 0xEE) ||\n\t\t(b[i] == 0xEF && // #xE000 <= . <= #xFFFD\n\t\t\t!(b[i+1] == 0xBB && b[i+2] == 0xBF) && // && . != #xFEFF\n\t\t\t!(b[i+1] == 0xBF && (b[i+2] == 0xBE || b[i+2] == 0xBF))))\n}\n\n// Check if the character at the specified position is NUL.\nfunc is_z(b []byte, i int) bool {\n\treturn b[i] == 0x00\n}\n\n// Check if the beginning of the buffer is a BOM.\nfunc is_bom(b []byte, i int) bool {\n\treturn b[0] == 0xEF && b[1] == 0xBB && b[2] == 0xBF\n}\n\n// Check if the character at the specified position is space.\nfunc is_space(b []byte, i int) bool {\n\treturn b[i] == ' '\n}\n\n// Check if the character at the specified position is tab.\nfunc is_tab(b []byte, i int) bool {\n\treturn b[i] == '\\t'\n}\n\n// Check if the character at the specified position is blank (space or tab).\nfunc is_blank(b []byte, i int) bool {\n\t//return is_space(b, i) || is_tab(b, i)\n\treturn b[i] == ' ' || b[i] == '\\t'\n}\n\n// Check if the character at the specified position is a line break.\nfunc is_break(b []byte, i int) bool {\n\treturn (b[i] == '\\r' || // CR (#xD)\n\t\tb[i] == '\\n' || // LF (#xA)\n\t\tb[i] == 0xC2 && b[i+1] == 0x85 || // NEL (#x85)\n\t\tb[i] == 0xE2 && b[i+1] == 0x80 && b[i+2] == 0xA8 || // LS (#x2028)\n\t\tb[i] == 0xE2 && b[i+1] == 0x80 && b[i+2] == 0xA9) // PS (#x2029)\n}\n\nfunc is_crlf(b []byte, i int) bool {\n\treturn b[i] == '\\r' && b[i+1] == '\\n'\n}\n\n// Check if the character is a line break or NUL.\nfunc is_breakz(b []byte, i int) bool {\n\t//return is_break(b, i) || is_z(b, i)\n\treturn (\n\t// is_break:\n\tb[i] == '\\r' || // CR (#xD)\n\t\tb[i] == '\\n' || // LF (#xA)\n\t\tb[i] == 0xC2 && b[i+1] == 0x85 || // NEL (#x85)\n\t\tb[i] == 0xE2 && b[i+1] == 0x80 && b[i+2] == 0xA8 || // LS (#x2028)\n\t\tb[i] == 0xE2 && b[i+1] == 0x80 && b[i+2] == 0xA9 || // PS (#x2029)\n\t\t// is_z:\n\t\tb[i] == 0)\n}\n\n// Check if the character is a line break, space, or NUL.\nfunc is_spacez(b []byte, i int) bool {\n\t//return is_space(b, i) || is_breakz(b, i)\n\treturn (\n\t// is_space:\n\tb[i] == ' ' ||\n\t\t// is_breakz:\n\t\tb[i] == '\\r' || // CR (#xD)\n\t\tb[i] == '\\n' || // LF (#xA)\n\t\tb[i] == 0xC2 && b[i+1] == 0x85 || // NEL (#x85)\n\t\tb[i] == 0xE2 && b[i+1] == 0x80 && b[i+2] == 0xA8 || // LS (#x2028)\n\t\tb[i] == 0xE2 && b[i+1] == 0x80 && b[i+2] == 0xA9 || // PS (#x2029)\n\t\tb[i] == 0)\n}\n\n// Check if the character is a line break, space, tab, or NUL.\nfunc is_blankz(b []byte, i int) bool {\n\t//return is_blank(b, i) || is_breakz(b, i)\n\treturn (\n\t// is_blank:\n\tb[i] == ' ' || b[i] == '\\t' ||\n\t\t// is_breakz:\n\t\tb[i] == '\\r' || // CR (#xD)\n\t\tb[i] == '\\n' || // LF (#xA)\n\t\tb[i] == 0xC2 && b[i+1] == 0x85 || // NEL (#x85)\n\t\tb[i] == 0xE2 && b[i+1] == 0x80 && b[i+2] == 0xA8 || // LS (#x2028)\n\t\tb[i] == 0xE2 && b[i+1] == 0x80 && b[i+2] == 0xA9 || // PS (#x2029)\n\t\tb[i] == 0)\n}\n\n// Determine the width of the character.\nfunc width(b byte) int {\n\t// Don't replace these by a switch without first\n\t// confirming that it is being inlined.\n\tif b&0x80 == 0x00 {\n\t\treturn 1\n\t}\n\tif b&0xE0 == 0xC0 {\n\t\treturn 2\n\t}\n\tif b&0xF0 == 0xE0 {\n\t\treturn 3\n\t}\n\tif b&0xF8 == 0xF0 {\n\t\treturn 4\n\t}\n\treturn 0\n\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/LICENSE",
"content": "Copyright 2009 The Go Authors.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n * Redistributions of source code must retain the above copyright\nnotice, this list of conditions and the following disclaimer.\n * Redistributions in binary form must reproduce the above\ncopyright notice, this list of conditions and the following disclaimer\nin the documentation and/or other materials provided with the\ndistribution.\n * Neither the name of Google LLC nor the names of its\ncontributors may be used to endorse or promote products derived from\nthis software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\nLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\nDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\nTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/PATENTS",
"content": "Additional IP Rights Grant (Patents)\n\n\"This implementation\" means the copyrightable works distributed by\nGoogle as part of the Go project.\n\nGoogle hereby grants to You a perpetual, worldwide, non-exclusive,\nno-charge, royalty-free, irrevocable (except as stated in this section)\npatent license to make, have made, use, offer to sell, sell, import,\ntransfer and otherwise run, modify and propagate the contents of this\nimplementation of Go, where such license applies only to those patent\nclaims, both currently owned or controlled by Google and acquired in\nthe future, licensable by Google that are necessarily infringed by this\nimplementation of Go. This grant does not include claims that would be\ninfringed only as a consequence of further modification of this\nimplementation. If you or your agent or exclusive licensee institute or\norder or agree to the institution of patent litigation against any\nentity (including a cross-claim or counterclaim in a lawsuit) alleging\nthat this implementation of Go or any code incorporated within this\nimplementation of Go constitutes direct or contributory patent\ninfringement, or inducement of patent infringement, then any patent\nrights granted to you under this License for this implementation of Go\nshall terminate as of the date such litigation is filed.\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/blowfish/block.go",
"content": "// Copyright 2010 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage blowfish\n\n// getNextWord returns the next big-endian uint32 value from the byte slice\n// at the given position in a circular manner, updating the position.\nfunc getNextWord(b []byte, pos *int) uint32 {\n\tvar w uint32\n\tj := *pos\n\tfor i := 0; i < 4; i++ {\n\t\tw = w<<8 | uint32(b[j])\n\t\tj++\n\t\tif j >= len(b) {\n\t\t\tj = 0\n\t\t}\n\t}\n\t*pos = j\n\treturn w\n}\n\n// ExpandKey performs a key expansion on the given *Cipher. Specifically, it\n// performs the Blowfish algorithm's key schedule which sets up the *Cipher's\n// pi and substitution tables for calls to Encrypt. This is used, primarily,\n// by the bcrypt package to reuse the Blowfish key schedule during its\n// set up. It's unlikely that you need to use this directly.\nfunc ExpandKey(key []byte, c *Cipher) {\n\tj := 0\n\tfor i := 0; i < 18; i++ {\n\t\t// Using inlined getNextWord for performance.\n\t\tvar d uint32\n\t\tfor k := 0; k < 4; k++ {\n\t\t\td = d<<8 | uint32(key[j])\n\t\t\tj++\n\t\t\tif j >= len(key) {\n\t\t\t\tj = 0\n\t\t\t}\n\t\t}\n\t\tc.p[i] ^= d\n\t}\n\n\tvar l, r uint32\n\tfor i := 0; i < 18; i += 2 {\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.p[i], c.p[i+1] = l, r\n\t}\n\n\tfor i := 0; i < 256; i += 2 {\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.s0[i], c.s0[i+1] = l, r\n\t}\n\tfor i := 0; i < 256; i += 2 {\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.s1[i], c.s1[i+1] = l, r\n\t}\n\tfor i := 0; i < 256; i += 2 {\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.s2[i], c.s2[i+1] = l, r\n\t}\n\tfor i := 0; i < 256; i += 2 {\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.s3[i], c.s3[i+1] = l, r\n\t}\n}\n\n// This is similar to ExpandKey, but folds the salt during the key\n// schedule. While ExpandKey is essentially expandKeyWithSalt with an all-zero\n// salt passed in, reusing ExpandKey turns out to be a place of inefficiency\n// and specializing it here is useful.\nfunc expandKeyWithSalt(key []byte, salt []byte, c *Cipher) {\n\tj := 0\n\tfor i := 0; i < 18; i++ {\n\t\tc.p[i] ^= getNextWord(key, &j)\n\t}\n\n\tj = 0\n\tvar l, r uint32\n\tfor i := 0; i < 18; i += 2 {\n\t\tl ^= getNextWord(salt, &j)\n\t\tr ^= getNextWord(salt, &j)\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.p[i], c.p[i+1] = l, r\n\t}\n\n\tfor i := 0; i < 256; i += 2 {\n\t\tl ^= getNextWord(salt, &j)\n\t\tr ^= getNextWord(salt, &j)\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.s0[i], c.s0[i+1] = l, r\n\t}\n\n\tfor i := 0; i < 256; i += 2 {\n\t\tl ^= getNextWord(salt, &j)\n\t\tr ^= getNextWord(salt, &j)\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.s1[i], c.s1[i+1] = l, r\n\t}\n\n\tfor i := 0; i < 256; i += 2 {\n\t\tl ^= getNextWord(salt, &j)\n\t\tr ^= getNextWord(salt, &j)\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.s2[i], c.s2[i+1] = l, r\n\t}\n\n\tfor i := 0; i < 256; i += 2 {\n\t\tl ^= getNextWord(salt, &j)\n\t\tr ^= getNextWord(salt, &j)\n\t\tl, r = encryptBlock(l, r, c)\n\t\tc.s3[i], c.s3[i+1] = l, r\n\t}\n}\n\nfunc encryptBlock(l, r uint32, c *Cipher) (uint32, uint32) {\n\txl, xr := l, r\n\txl ^= c.p[0]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[1]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[2]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[3]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[4]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[5]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[6]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[7]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[8]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[9]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[10]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[11]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[12]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[13]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[14]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[15]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[16]\n\txr ^= c.p[17]\n\treturn xr, xl\n}\n\nfunc decryptBlock(l, r uint32, c *Cipher) (uint32, uint32) {\n\txl, xr := l, r\n\txl ^= c.p[17]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[16]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[15]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[14]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[13]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[12]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[11]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[10]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[9]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[8]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[7]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[6]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[5]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[4]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[3]\n\txr ^= ((c.s0[byte(xl>>24)] + c.s1[byte(xl>>16)]) ^ c.s2[byte(xl>>8)]) + c.s3[byte(xl)] ^ c.p[2]\n\txl ^= ((c.s0[byte(xr>>24)] + c.s1[byte(xr>>16)]) ^ c.s2[byte(xr>>8)]) + c.s3[byte(xr)] ^ c.p[1]\n\txr ^= c.p[0]\n\treturn xr, xl\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/blowfish/cipher.go",
"content": "// Copyright 2010 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package blowfish implements Bruce Schneier's Blowfish encryption algorithm.\n//\n// Blowfish is a legacy cipher and its short block size makes it vulnerable to\n// birthday bound attacks (see https://sweet32.info). It should only be used\n// where compatibility with legacy systems, not security, is the goal.\n//\n// Deprecated: any new system should use AES (from crypto/aes, if necessary in\n// an AEAD mode like crypto/cipher.NewGCM) or XChaCha20-Poly1305 (from\n// golang.org/x/crypto/chacha20poly1305).\npackage blowfish\n\n// The code is a port of Bruce Schneier's C implementation.\n// See https://www.schneier.com/blowfish.html.\n\nimport \"strconv\"\n\n// The Blowfish block size in bytes.\nconst BlockSize = 8\n\n// A Cipher is an instance of Blowfish encryption using a particular key.\ntype Cipher struct {\n\tp [18]uint32\n\ts0, s1, s2, s3 [256]uint32\n}\n\ntype KeySizeError int\n\nfunc (k KeySizeError) Error() string {\n\treturn \"crypto/blowfish: invalid key size \" + strconv.Itoa(int(k))\n}\n\n// NewCipher creates and returns a Cipher.\n// The key argument should be the Blowfish key, from 1 to 56 bytes.\nfunc NewCipher(key []byte) (*Cipher, error) {\n\tvar result Cipher\n\tif k := len(key); k < 1 || k > 56 {\n\t\treturn nil, KeySizeError(k)\n\t}\n\tinitCipher(&result)\n\tExpandKey(key, &result)\n\treturn &result, nil\n}\n\n// NewSaltedCipher creates a returns a Cipher that folds a salt into its key\n// schedule. For most purposes, NewCipher, instead of NewSaltedCipher, is\n// sufficient and desirable. For bcrypt compatibility, the key can be over 56\n// bytes.\nfunc NewSaltedCipher(key, salt []byte) (*Cipher, error) {\n\tif len(salt) == 0 {\n\t\treturn NewCipher(key)\n\t}\n\tvar result Cipher\n\tif k := len(key); k < 1 {\n\t\treturn nil, KeySizeError(k)\n\t}\n\tinitCipher(&result)\n\texpandKeyWithSalt(key, salt, &result)\n\treturn &result, nil\n}\n\n// BlockSize returns the Blowfish block size, 8 bytes.\n// It is necessary to satisfy the Block interface in the\n// package \"crypto/cipher\".\nfunc (c *Cipher) BlockSize() int { return BlockSize }\n\n// Encrypt encrypts the 8-byte buffer src using the key k\n// and stores the result in dst.\n// Note that for amounts of data larger than a block,\n// it is not safe to just call Encrypt on successive blocks;\n// instead, use an encryption mode like CBC (see crypto/cipher/cbc.go).\nfunc (c *Cipher) Encrypt(dst, src []byte) {\n\tl := uint32(src[0])<<24 | uint32(src[1])<<16 | uint32(src[2])<<8 | uint32(src[3])\n\tr := uint32(src[4])<<24 | uint32(src[5])<<16 | uint32(src[6])<<8 | uint32(src[7])\n\tl, r = encryptBlock(l, r, c)\n\tdst[0], dst[1], dst[2], dst[3] = byte(l>>24), byte(l>>16), byte(l>>8), byte(l)\n\tdst[4], dst[5], dst[6], dst[7] = byte(r>>24), byte(r>>16), byte(r>>8), byte(r)\n}\n\n// Decrypt decrypts the 8-byte buffer src using the key k\n// and stores the result in dst.\nfunc (c *Cipher) Decrypt(dst, src []byte) {\n\tl := uint32(src[0])<<24 | uint32(src[1])<<16 | uint32(src[2])<<8 | uint32(src[3])\n\tr := uint32(src[4])<<24 | uint32(src[5])<<16 | uint32(src[6])<<8 | uint32(src[7])\n\tl, r = decryptBlock(l, r, c)\n\tdst[0], dst[1], dst[2], dst[3] = byte(l>>24), byte(l>>16), byte(l>>8), byte(l)\n\tdst[4], dst[5], dst[6], dst[7] = byte(r>>24), byte(r>>16), byte(r>>8), byte(r)\n}\n\nfunc initCipher(c *Cipher) {\n\tcopy(c.p[0:], p[0:])\n\tcopy(c.s0[0:], s0[0:])\n\tcopy(c.s1[0:], s1[0:])\n\tcopy(c.s2[0:], s2[0:])\n\tcopy(c.s3[0:], s3[0:])\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/blowfish/const.go",
"content": "// Copyright 2010 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// The startup permutation array and substitution boxes.\n// They are the hexadecimal digits of PI; see:\n// https://www.schneier.com/code/constants.txt.\n\npackage blowfish\n\nvar s0 = [256]uint32{\n\t0xd1310ba6, 0x98dfb5ac, 0x2ffd72db, 0xd01adfb7, 0xb8e1afed, 0x6a267e96,\n\t0xba7c9045, 0xf12c7f99, 0x24a19947, 0xb3916cf7, 0x0801f2e2, 0x858efc16,\n\t0x636920d8, 0x71574e69, 0xa458fea3, 0xf4933d7e, 0x0d95748f, 0x728eb658,\n\t0x718bcd58, 0x82154aee, 0x7b54a41d, 0xc25a59b5, 0x9c30d539, 0x2af26013,\n\t0xc5d1b023, 0x286085f0, 0xca417918, 0xb8db38ef, 0x8e79dcb0, 0x603a180e,\n\t0x6c9e0e8b, 0xb01e8a3e, 0xd71577c1, 0xbd314b27, 0x78af2fda, 0x55605c60,\n\t0xe65525f3, 0xaa55ab94, 0x57489862, 0x63e81440, 0x55ca396a, 0x2aab10b6,\n\t0xb4cc5c34, 0x1141e8ce, 0xa15486af, 0x7c72e993, 0xb3ee1411, 0x636fbc2a,\n\t0x2ba9c55d, 0x741831f6, 0xce5c3e16, 0x9b87931e, 0xafd6ba33, 0x6c24cf5c,\n\t0x7a325381, 0x28958677, 0x3b8f4898, 0x6b4bb9af, 0xc4bfe81b, 0x66282193,\n\t0x61d809cc, 0xfb21a991, 0x487cac60, 0x5dec8032, 0xef845d5d, 0xe98575b1,\n\t0xdc262302, 0xeb651b88, 0x23893e81, 0xd396acc5, 0x0f6d6ff3, 0x83f44239,\n\t0x2e0b4482, 0xa4842004, 0x69c8f04a, 0x9e1f9b5e, 0x21c66842, 0xf6e96c9a,\n\t0x670c9c61, 0xabd388f0, 0x6a51a0d2, 0xd8542f68, 0x960fa728, 0xab5133a3,\n\t0x6eef0b6c, 0x137a3be4, 0xba3bf050, 0x7efb2a98, 0xa1f1651d, 0x39af0176,\n\t0x66ca593e, 0x82430e88, 0x8cee8619, 0x456f9fb4, 0x7d84a5c3, 0x3b8b5ebe,\n\t0xe06f75d8, 0x85c12073, 0x401a449f, 0x56c16aa6, 0x4ed3aa62, 0x363f7706,\n\t0x1bfedf72, 0x429b023d, 0x37d0d724, 0xd00a1248, 0xdb0fead3, 0x49f1c09b,\n\t0x075372c9, 0x80991b7b, 0x25d479d8, 0xf6e8def7, 0xe3fe501a, 0xb6794c3b,\n\t0x976ce0bd, 0x04c006ba, 0xc1a94fb6, 0x409f60c4, 0x5e5c9ec2, 0x196a2463,\n\t0x68fb6faf, 0x3e6c53b5, 0x1339b2eb, 0x3b52ec6f, 0x6dfc511f, 0x9b30952c,\n\t0xcc814544, 0xaf5ebd09, 0xbee3d004, 0xde334afd, 0x660f2807, 0x192e4bb3,\n\t0xc0cba857, 0x45c8740f, 0xd20b5f39, 0xb9d3fbdb, 0x5579c0bd, 0x1a60320a,\n\t0xd6a100c6, 0x402c7279, 0x679f25fe, 0xfb1fa3cc, 0x8ea5e9f8, 0xdb3222f8,\n\t0x3c7516df, 0xfd616b15, 0x2f501ec8, 0xad0552ab, 0x323db5fa, 0xfd238760,\n\t0x53317b48, 0x3e00df82, 0x9e5c57bb, 0xca6f8ca0, 0x1a87562e, 0xdf1769db,\n\t0xd542a8f6, 0x287effc3, 0xac6732c6, 0x8c4f5573, 0x695b27b0, 0xbbca58c8,\n\t0xe1ffa35d, 0xb8f011a0, 0x10fa3d98, 0xfd2183b8, 0x4afcb56c, 0x2dd1d35b,\n\t0x9a53e479, 0xb6f84565, 0xd28e49bc, 0x4bfb9790, 0xe1ddf2da, 0xa4cb7e33,\n\t0x62fb1341, 0xcee4c6e8, 0xef20cada, 0x36774c01, 0xd07e9efe, 0x2bf11fb4,\n\t0x95dbda4d, 0xae909198, 0xeaad8e71, 0x6b93d5a0, 0xd08ed1d0, 0xafc725e0,\n\t0x8e3c5b2f, 0x8e7594b7, 0x8ff6e2fb, 0xf2122b64, 0x8888b812, 0x900df01c,\n\t0x4fad5ea0, 0x688fc31c, 0xd1cff191, 0xb3a8c1ad, 0x2f2f2218, 0xbe0e1777,\n\t0xea752dfe, 0x8b021fa1, 0xe5a0cc0f, 0xb56f74e8, 0x18acf3d6, 0xce89e299,\n\t0xb4a84fe0, 0xfd13e0b7, 0x7cc43b81, 0xd2ada8d9, 0x165fa266, 0x80957705,\n\t0x93cc7314, 0x211a1477, 0xe6ad2065, 0x77b5fa86, 0xc75442f5, 0xfb9d35cf,\n\t0xebcdaf0c, 0x7b3e89a0, 0xd6411bd3, 0xae1e7e49, 0x00250e2d, 0x2071b35e,\n\t0x226800bb, 0x57b8e0af, 0x2464369b, 0xf009b91e, 0x5563911d, 0x59dfa6aa,\n\t0x78c14389, 0xd95a537f, 0x207d5ba2, 0x02e5b9c5, 0x83260376, 0x6295cfa9,\n\t0x11c81968, 0x4e734a41, 0xb3472dca, 0x7b14a94a, 0x1b510052, 0x9a532915,\n\t0xd60f573f, 0xbc9bc6e4, 0x2b60a476, 0x81e67400, 0x08ba6fb5, 0x571be91f,\n\t0xf296ec6b, 0x2a0dd915, 0xb6636521, 0xe7b9f9b6, 0xff34052e, 0xc5855664,\n\t0x53b02d5d, 0xa99f8fa1, 0x08ba4799, 0x6e85076a,\n}\n\nvar s1 = [256]uint32{\n\t0x4b7a70e9, 0xb5b32944, 0xdb75092e, 0xc4192623, 0xad6ea6b0, 0x49a7df7d,\n\t0x9cee60b8, 0x8fedb266, 0xecaa8c71, 0x699a17ff, 0x5664526c, 0xc2b19ee1,\n\t0x193602a5, 0x75094c29, 0xa0591340, 0xe4183a3e, 0x3f54989a, 0x5b429d65,\n\t0x6b8fe4d6, 0x99f73fd6, 0xa1d29c07, 0xefe830f5, 0x4d2d38e6, 0xf0255dc1,\n\t0x4cdd2086, 0x8470eb26, 0x6382e9c6, 0x021ecc5e, 0x09686b3f, 0x3ebaefc9,\n\t0x3c971814, 0x6b6a70a1, 0x687f3584, 0x52a0e286, 0xb79c5305, 0xaa500737,\n\t0x3e07841c, 0x7fdeae5c, 0x8e7d44ec, 0x5716f2b8, 0xb03ada37, 0xf0500c0d,\n\t0xf01c1f04, 0x0200b3ff, 0xae0cf51a, 0x3cb574b2, 0x25837a58, 0xdc0921bd,\n\t0xd19113f9, 0x7ca92ff6, 0x94324773, 0x22f54701, 0x3ae5e581, 0x37c2dadc,\n\t0xc8b57634, 0x9af3dda7, 0xa9446146, 0x0fd0030e, 0xecc8c73e, 0xa4751e41,\n\t0xe238cd99, 0x3bea0e2f, 0x3280bba1, 0x183eb331, 0x4e548b38, 0x4f6db908,\n\t0x6f420d03, 0xf60a04bf, 0x2cb81290, 0x24977c79, 0x5679b072, 0xbcaf89af,\n\t0xde9a771f, 0xd9930810, 0xb38bae12, 0xdccf3f2e, 0x5512721f, 0x2e6b7124,\n\t0x501adde6, 0x9f84cd87, 0x7a584718, 0x7408da17, 0xbc9f9abc, 0xe94b7d8c,\n\t0xec7aec3a, 0xdb851dfa, 0x63094366, 0xc464c3d2, 0xef1c1847, 0x3215d908,\n\t0xdd433b37, 0x24c2ba16, 0x12a14d43, 0x2a65c451, 0x50940002, 0x133ae4dd,\n\t0x71dff89e, 0x10314e55, 0x81ac77d6, 0x5f11199b, 0x043556f1, 0xd7a3c76b,\n\t0x3c11183b, 0x5924a509, 0xf28fe6ed, 0x97f1fbfa, 0x9ebabf2c, 0x1e153c6e,\n\t0x86e34570, 0xeae96fb1, 0x860e5e0a, 0x5a3e2ab3, 0x771fe71c, 0x4e3d06fa,\n\t0x2965dcb9, 0x99e71d0f, 0x803e89d6, 0x5266c825, 0x2e4cc978, 0x9c10b36a,\n\t0xc6150eba, 0x94e2ea78, 0xa5fc3c53, 0x1e0a2df4, 0xf2f74ea7, 0x361d2b3d,\n\t0x1939260f, 0x19c27960, 0x5223a708, 0xf71312b6, 0xebadfe6e, 0xeac31f66,\n\t0xe3bc4595, 0xa67bc883, 0xb17f37d1, 0x018cff28, 0xc332ddef, 0xbe6c5aa5,\n\t0x65582185, 0x68ab9802, 0xeecea50f, 0xdb2f953b, 0x2aef7dad, 0x5b6e2f84,\n\t0x1521b628, 0x29076170, 0xecdd4775, 0x619f1510, 0x13cca830, 0xeb61bd96,\n\t0x0334fe1e, 0xaa0363cf, 0xb5735c90, 0x4c70a239, 0xd59e9e0b, 0xcbaade14,\n\t0xeecc86bc, 0x60622ca7, 0x9cab5cab, 0xb2f3846e, 0x648b1eaf, 0x19bdf0ca,\n\t0xa02369b9, 0x655abb50, 0x40685a32, 0x3c2ab4b3, 0x319ee9d5, 0xc021b8f7,\n\t0x9b540b19, 0x875fa099, 0x95f7997e, 0x623d7da8, 0xf837889a, 0x97e32d77,\n\t0x11ed935f, 0x16681281, 0x0e358829, 0xc7e61fd6, 0x96dedfa1, 0x7858ba99,\n\t0x57f584a5, 0x1b227263, 0x9b83c3ff, 0x1ac24696, 0xcdb30aeb, 0x532e3054,\n\t0x8fd948e4, 0x6dbc3128, 0x58ebf2ef, 0x34c6ffea, 0xfe28ed61, 0xee7c3c73,\n\t0x5d4a14d9, 0xe864b7e3, 0x42105d14, 0x203e13e0, 0x45eee2b6, 0xa3aaabea,\n\t0xdb6c4f15, 0xfacb4fd0, 0xc742f442, 0xef6abbb5, 0x654f3b1d, 0x41cd2105,\n\t0xd81e799e, 0x86854dc7, 0xe44b476a, 0x3d816250, 0xcf62a1f2, 0x5b8d2646,\n\t0xfc8883a0, 0xc1c7b6a3, 0x7f1524c3, 0x69cb7492, 0x47848a0b, 0x5692b285,\n\t0x095bbf00, 0xad19489d, 0x1462b174, 0x23820e00, 0x58428d2a, 0x0c55f5ea,\n\t0x1dadf43e, 0x233f7061, 0x3372f092, 0x8d937e41, 0xd65fecf1, 0x6c223bdb,\n\t0x7cde3759, 0xcbee7460, 0x4085f2a7, 0xce77326e, 0xa6078084, 0x19f8509e,\n\t0xe8efd855, 0x61d99735, 0xa969a7aa, 0xc50c06c2, 0x5a04abfc, 0x800bcadc,\n\t0x9e447a2e, 0xc3453484, 0xfdd56705, 0x0e1e9ec9, 0xdb73dbd3, 0x105588cd,\n\t0x675fda79, 0xe3674340, 0xc5c43465, 0x713e38d8, 0x3d28f89e, 0xf16dff20,\n\t0x153e21e7, 0x8fb03d4a, 0xe6e39f2b, 0xdb83adf7,\n}\n\nvar s2 = [256]uint32{\n\t0xe93d5a68, 0x948140f7, 0xf64c261c, 0x94692934, 0x411520f7, 0x7602d4f7,\n\t0xbcf46b2e, 0xd4a20068, 0xd4082471, 0x3320f46a, 0x43b7d4b7, 0x500061af,\n\t0x1e39f62e, 0x97244546, 0x14214f74, 0xbf8b8840, 0x4d95fc1d, 0x96b591af,\n\t0x70f4ddd3, 0x66a02f45, 0xbfbc09ec, 0x03bd9785, 0x7fac6dd0, 0x31cb8504,\n\t0x96eb27b3, 0x55fd3941, 0xda2547e6, 0xabca0a9a, 0x28507825, 0x530429f4,\n\t0x0a2c86da, 0xe9b66dfb, 0x68dc1462, 0xd7486900, 0x680ec0a4, 0x27a18dee,\n\t0x4f3ffea2, 0xe887ad8c, 0xb58ce006, 0x7af4d6b6, 0xaace1e7c, 0xd3375fec,\n\t0xce78a399, 0x406b2a42, 0x20fe9e35, 0xd9f385b9, 0xee39d7ab, 0x3b124e8b,\n\t0x1dc9faf7, 0x4b6d1856, 0x26a36631, 0xeae397b2, 0x3a6efa74, 0xdd5b4332,\n\t0x6841e7f7, 0xca7820fb, 0xfb0af54e, 0xd8feb397, 0x454056ac, 0xba489527,\n\t0x55533a3a, 0x20838d87, 0xfe6ba9b7, 0xd096954b, 0x55a867bc, 0xa1159a58,\n\t0xcca92963, 0x99e1db33, 0xa62a4a56, 0x3f3125f9, 0x5ef47e1c, 0x9029317c,\n\t0xfdf8e802, 0x04272f70, 0x80bb155c, 0x05282ce3, 0x95c11548, 0xe4c66d22,\n\t0x48c1133f, 0xc70f86dc, 0x07f9c9ee, 0x41041f0f, 0x404779a4, 0x5d886e17,\n\t0x325f51eb, 0xd59bc0d1, 0xf2bcc18f, 0x41113564, 0x257b7834, 0x602a9c60,\n\t0xdff8e8a3, 0x1f636c1b, 0x0e12b4c2, 0x02e1329e, 0xaf664fd1, 0xcad18115,\n\t0x6b2395e0, 0x333e92e1, 0x3b240b62, 0xeebeb922, 0x85b2a20e, 0xe6ba0d99,\n\t0xde720c8c, 0x2da2f728, 0xd0127845, 0x95b794fd, 0x647d0862, 0xe7ccf5f0,\n\t0x5449a36f, 0x877d48fa, 0xc39dfd27, 0xf33e8d1e, 0x0a476341, 0x992eff74,\n\t0x3a6f6eab, 0xf4f8fd37, 0xa812dc60, 0xa1ebddf8, 0x991be14c, 0xdb6e6b0d,\n\t0xc67b5510, 0x6d672c37, 0x2765d43b, 0xdcd0e804, 0xf1290dc7, 0xcc00ffa3,\n\t0xb5390f92, 0x690fed0b, 0x667b9ffb, 0xcedb7d9c, 0xa091cf0b, 0xd9155ea3,\n\t0xbb132f88, 0x515bad24, 0x7b9479bf, 0x763bd6eb, 0x37392eb3, 0xcc115979,\n\t0x8026e297, 0xf42e312d, 0x6842ada7, 0xc66a2b3b, 0x12754ccc, 0x782ef11c,\n\t0x6a124237, 0xb79251e7, 0x06a1bbe6, 0x4bfb6350, 0x1a6b1018, 0x11caedfa,\n\t0x3d25bdd8, 0xe2e1c3c9, 0x44421659, 0x0a121386, 0xd90cec6e, 0xd5abea2a,\n\t0x64af674e, 0xda86a85f, 0xbebfe988, 0x64e4c3fe, 0x9dbc8057, 0xf0f7c086,\n\t0x60787bf8, 0x6003604d, 0xd1fd8346, 0xf6381fb0, 0x7745ae04, 0xd736fccc,\n\t0x83426b33, 0xf01eab71, 0xb0804187, 0x3c005e5f, 0x77a057be, 0xbde8ae24,\n\t0x55464299, 0xbf582e61, 0x4e58f48f, 0xf2ddfda2, 0xf474ef38, 0x8789bdc2,\n\t0x5366f9c3, 0xc8b38e74, 0xb475f255, 0x46fcd9b9, 0x7aeb2661, 0x8b1ddf84,\n\t0x846a0e79, 0x915f95e2, 0x466e598e, 0x20b45770, 0x8cd55591, 0xc902de4c,\n\t0xb90bace1, 0xbb8205d0, 0x11a86248, 0x7574a99e, 0xb77f19b6, 0xe0a9dc09,\n\t0x662d09a1, 0xc4324633, 0xe85a1f02, 0x09f0be8c, 0x4a99a025, 0x1d6efe10,\n\t0x1ab93d1d, 0x0ba5a4df, 0xa186f20f, 0x2868f169, 0xdcb7da83, 0x573906fe,\n\t0xa1e2ce9b, 0x4fcd7f52, 0x50115e01, 0xa70683fa, 0xa002b5c4, 0x0de6d027,\n\t0x9af88c27, 0x773f8641, 0xc3604c06, 0x61a806b5, 0xf0177a28, 0xc0f586e0,\n\t0x006058aa, 0x30dc7d62, 0x11e69ed7, 0x2338ea63, 0x53c2dd94, 0xc2c21634,\n\t0xbbcbee56, 0x90bcb6de, 0xebfc7da1, 0xce591d76, 0x6f05e409, 0x4b7c0188,\n\t0x39720a3d, 0x7c927c24, 0x86e3725f, 0x724d9db9, 0x1ac15bb4, 0xd39eb8fc,\n\t0xed545578, 0x08fca5b5, 0xd83d7cd3, 0x4dad0fc4, 0x1e50ef5e, 0xb161e6f8,\n\t0xa28514d9, 0x6c51133c, 0x6fd5c7e7, 0x56e14ec4, 0x362abfce, 0xddc6c837,\n\t0xd79a3234, 0x92638212, 0x670efa8e, 0x406000e0,\n}\n\nvar s3 = [256]uint32{\n\t0x3a39ce37, 0xd3faf5cf, 0xabc27737, 0x5ac52d1b, 0x5cb0679e, 0x4fa33742,\n\t0xd3822740, 0x99bc9bbe, 0xd5118e9d, 0xbf0f7315, 0xd62d1c7e, 0xc700c47b,\n\t0xb78c1b6b, 0x21a19045, 0xb26eb1be, 0x6a366eb4, 0x5748ab2f, 0xbc946e79,\n\t0xc6a376d2, 0x6549c2c8, 0x530ff8ee, 0x468dde7d, 0xd5730a1d, 0x4cd04dc6,\n\t0x2939bbdb, 0xa9ba4650, 0xac9526e8, 0xbe5ee304, 0xa1fad5f0, 0x6a2d519a,\n\t0x63ef8ce2, 0x9a86ee22, 0xc089c2b8, 0x43242ef6, 0xa51e03aa, 0x9cf2d0a4,\n\t0x83c061ba, 0x9be96a4d, 0x8fe51550, 0xba645bd6, 0x2826a2f9, 0xa73a3ae1,\n\t0x4ba99586, 0xef5562e9, 0xc72fefd3, 0xf752f7da, 0x3f046f69, 0x77fa0a59,\n\t0x80e4a915, 0x87b08601, 0x9b09e6ad, 0x3b3ee593, 0xe990fd5a, 0x9e34d797,\n\t0x2cf0b7d9, 0x022b8b51, 0x96d5ac3a, 0x017da67d, 0xd1cf3ed6, 0x7c7d2d28,\n\t0x1f9f25cf, 0xadf2b89b, 0x5ad6b472, 0x5a88f54c, 0xe029ac71, 0xe019a5e6,\n\t0x47b0acfd, 0xed93fa9b, 0xe8d3c48d, 0x283b57cc, 0xf8d56629, 0x79132e28,\n\t0x785f0191, 0xed756055, 0xf7960e44, 0xe3d35e8c, 0x15056dd4, 0x88f46dba,\n\t0x03a16125, 0x0564f0bd, 0xc3eb9e15, 0x3c9057a2, 0x97271aec, 0xa93a072a,\n\t0x1b3f6d9b, 0x1e6321f5, 0xf59c66fb, 0x26dcf319, 0x7533d928, 0xb155fdf5,\n\t0x03563482, 0x8aba3cbb, 0x28517711, 0xc20ad9f8, 0xabcc5167, 0xccad925f,\n\t0x4de81751, 0x3830dc8e, 0x379d5862, 0x9320f991, 0xea7a90c2, 0xfb3e7bce,\n\t0x5121ce64, 0x774fbe32, 0xa8b6e37e, 0xc3293d46, 0x48de5369, 0x6413e680,\n\t0xa2ae0810, 0xdd6db224, 0x69852dfd, 0x09072166, 0xb39a460a, 0x6445c0dd,\n\t0x586cdecf, 0x1c20c8ae, 0x5bbef7dd, 0x1b588d40, 0xccd2017f, 0x6bb4e3bb,\n\t0xdda26a7e, 0x3a59ff45, 0x3e350a44, 0xbcb4cdd5, 0x72eacea8, 0xfa6484bb,\n\t0x8d6612ae, 0xbf3c6f47, 0xd29be463, 0x542f5d9e, 0xaec2771b, 0xf64e6370,\n\t0x740e0d8d, 0xe75b1357, 0xf8721671, 0xaf537d5d, 0x4040cb08, 0x4eb4e2cc,\n\t0x34d2466a, 0x0115af84, 0xe1b00428, 0x95983a1d, 0x06b89fb4, 0xce6ea048,\n\t0x6f3f3b82, 0x3520ab82, 0x011a1d4b, 0x277227f8, 0x611560b1, 0xe7933fdc,\n\t0xbb3a792b, 0x344525bd, 0xa08839e1, 0x51ce794b, 0x2f32c9b7, 0xa01fbac9,\n\t0xe01cc87e, 0xbcc7d1f6, 0xcf0111c3, 0xa1e8aac7, 0x1a908749, 0xd44fbd9a,\n\t0xd0dadecb, 0xd50ada38, 0x0339c32a, 0xc6913667, 0x8df9317c, 0xe0b12b4f,\n\t0xf79e59b7, 0x43f5bb3a, 0xf2d519ff, 0x27d9459c, 0xbf97222c, 0x15e6fc2a,\n\t0x0f91fc71, 0x9b941525, 0xfae59361, 0xceb69ceb, 0xc2a86459, 0x12baa8d1,\n\t0xb6c1075e, 0xe3056a0c, 0x10d25065, 0xcb03a442, 0xe0ec6e0e, 0x1698db3b,\n\t0x4c98a0be, 0x3278e964, 0x9f1f9532, 0xe0d392df, 0xd3a0342b, 0x8971f21e,\n\t0x1b0a7441, 0x4ba3348c, 0xc5be7120, 0xc37632d8, 0xdf359f8d, 0x9b992f2e,\n\t0xe60b6f47, 0x0fe3f11d, 0xe54cda54, 0x1edad891, 0xce6279cf, 0xcd3e7e6f,\n\t0x1618b166, 0xfd2c1d05, 0x848fd2c5, 0xf6fb2299, 0xf523f357, 0xa6327623,\n\t0x93a83531, 0x56cccd02, 0xacf08162, 0x5a75ebb5, 0x6e163697, 0x88d273cc,\n\t0xde966292, 0x81b949d0, 0x4c50901b, 0x71c65614, 0xe6c6c7bd, 0x327a140a,\n\t0x45e1d006, 0xc3f27b9a, 0xc9aa53fd, 0x62a80f00, 0xbb25bfe2, 0x35bdd2f6,\n\t0x71126905, 0xb2040222, 0xb6cbcf7c, 0xcd769c2b, 0x53113ec0, 0x1640e3d3,\n\t0x38abbd60, 0x2547adf0, 0xba38209c, 0xf746ce76, 0x77afa1c5, 0x20756060,\n\t0x85cbfe4e, 0x8ae88dd8, 0x7aaaf9b0, 0x4cf9aa7e, 0x1948c25c, 0x02fb8a8c,\n\t0x01c36ae4, 0xd6ebe1f9, 0x90d4f869, 0xa65cdea0, 0x3f09252d, 0xc208e69f,\n\t0xb74e6132, 0xce77e25b, 0x578fdfe3, 0x3ac372e6,\n}\n\nvar p = [18]uint32{\n\t0x243f6a88, 0x85a308d3, 0x13198a2e, 0x03707344, 0xa4093822, 0x299f31d0,\n\t0x082efa98, 0xec4e6c89, 0x452821e6, 0x38d01377, 0xbe5466cf, 0x34e90c6c,\n\t0xc0ac29b7, 0xc97c50dd, 0x3f84d5b5, 0xb5470917, 0x9216d5d9, 0x8979fb1b,\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/chacha_arm64.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego\n\npackage chacha20\n\nconst bufSize = 256\n\n//go:noescape\nfunc xorKeyStreamVX(dst, src []byte, key *[8]uint32, nonce *[3]uint32, counter *uint32)\n\nfunc (c *Cipher) xorKeyStreamBlocks(dst, src []byte) {\n\txorKeyStreamVX(dst, src, &c.key, &c.nonce, &c.counter)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/chacha_arm64.s",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego\n\n#include \"textflag.h\"\n\n#define NUM_ROUNDS 10\n\n// func xorKeyStreamVX(dst, src []byte, key *[8]uint32, nonce *[3]uint32, counter *uint32)\nTEXT ·xorKeyStreamVX(SB), NOSPLIT, $0\n\tMOVD\tdst+0(FP), R1\n\tMOVD\tsrc+24(FP), R2\n\tMOVD\tsrc_len+32(FP), R3\n\tMOVD\tkey+48(FP), R4\n\tMOVD\tnonce+56(FP), R6\n\tMOVD\tcounter+64(FP), R7\n\n\tMOVD\t$·constants(SB), R10\n\tMOVD\t$·incRotMatrix(SB), R11\n\n\tMOVW\t(R7), R20\n\n\tAND\t$~255, R3, R13\n\tADD\tR2, R13, R12 // R12 for block end\n\tAND\t$255, R3, R13\nloop:\n\tMOVD\t$NUM_ROUNDS, R21\n\tVLD1\t(R11), [V30.S4, V31.S4]\n\n\t// load constants\n\t// VLD4R (R10), [V0.S4, V1.S4, V2.S4, V3.S4]\n\tWORD\t$0x4D60E940\n\n\t// load keys\n\t// VLD4R 16(R4), [V4.S4, V5.S4, V6.S4, V7.S4]\n\tWORD\t$0x4DFFE884\n\t// VLD4R 16(R4), [V8.S4, V9.S4, V10.S4, V11.S4]\n\tWORD\t$0x4DFFE888\n\tSUB\t$32, R4\n\n\t// load counter + nonce\n\t// VLD1R (R7), [V12.S4]\n\tWORD\t$0x4D40C8EC\n\n\t// VLD3R (R6), [V13.S4, V14.S4, V15.S4]\n\tWORD\t$0x4D40E8CD\n\n\t// update counter\n\tVADD\tV30.S4, V12.S4, V12.S4\n\nchacha:\n\t// V0..V3 += V4..V7\n\t// V12..V15 <<<= ((V12..V15 XOR V0..V3), 16)\n\tVADD\tV0.S4, V4.S4, V0.S4\n\tVADD\tV1.S4, V5.S4, V1.S4\n\tVADD\tV2.S4, V6.S4, V2.S4\n\tVADD\tV3.S4, V7.S4, V3.S4\n\tVEOR\tV12.B16, V0.B16, V12.B16\n\tVEOR\tV13.B16, V1.B16, V13.B16\n\tVEOR\tV14.B16, V2.B16, V14.B16\n\tVEOR\tV15.B16, V3.B16, V15.B16\n\tVREV32\tV12.H8, V12.H8\n\tVREV32\tV13.H8, V13.H8\n\tVREV32\tV14.H8, V14.H8\n\tVREV32\tV15.H8, V15.H8\n\t// V8..V11 += V12..V15\n\t// V4..V7 <<<= ((V4..V7 XOR V8..V11), 12)\n\tVADD\tV8.S4, V12.S4, V8.S4\n\tVADD\tV9.S4, V13.S4, V9.S4\n\tVADD\tV10.S4, V14.S4, V10.S4\n\tVADD\tV11.S4, V15.S4, V11.S4\n\tVEOR\tV8.B16, V4.B16, V16.B16\n\tVEOR\tV9.B16, V5.B16, V17.B16\n\tVEOR\tV10.B16, V6.B16, V18.B16\n\tVEOR\tV11.B16, V7.B16, V19.B16\n\tVSHL\t$12, V16.S4, V4.S4\n\tVSHL\t$12, V17.S4, V5.S4\n\tVSHL\t$12, V18.S4, V6.S4\n\tVSHL\t$12, V19.S4, V7.S4\n\tVSRI\t$20, V16.S4, V4.S4\n\tVSRI\t$20, V17.S4, V5.S4\n\tVSRI\t$20, V18.S4, V6.S4\n\tVSRI\t$20, V19.S4, V7.S4\n\n\t// V0..V3 += V4..V7\n\t// V12..V15 <<<= ((V12..V15 XOR V0..V3), 8)\n\tVADD\tV0.S4, V4.S4, V0.S4\n\tVADD\tV1.S4, V5.S4, V1.S4\n\tVADD\tV2.S4, V6.S4, V2.S4\n\tVADD\tV3.S4, V7.S4, V3.S4\n\tVEOR\tV12.B16, V0.B16, V12.B16\n\tVEOR\tV13.B16, V1.B16, V13.B16\n\tVEOR\tV14.B16, V2.B16, V14.B16\n\tVEOR\tV15.B16, V3.B16, V15.B16\n\tVTBL\tV31.B16, [V12.B16], V12.B16\n\tVTBL\tV31.B16, [V13.B16], V13.B16\n\tVTBL\tV31.B16, [V14.B16], V14.B16\n\tVTBL\tV31.B16, [V15.B16], V15.B16\n\n\t// V8..V11 += V12..V15\n\t// V4..V7 <<<= ((V4..V7 XOR V8..V11), 7)\n\tVADD\tV12.S4, V8.S4, V8.S4\n\tVADD\tV13.S4, V9.S4, V9.S4\n\tVADD\tV14.S4, V10.S4, V10.S4\n\tVADD\tV15.S4, V11.S4, V11.S4\n\tVEOR\tV8.B16, V4.B16, V16.B16\n\tVEOR\tV9.B16, V5.B16, V17.B16\n\tVEOR\tV10.B16, V6.B16, V18.B16\n\tVEOR\tV11.B16, V7.B16, V19.B16\n\tVSHL\t$7, V16.S4, V4.S4\n\tVSHL\t$7, V17.S4, V5.S4\n\tVSHL\t$7, V18.S4, V6.S4\n\tVSHL\t$7, V19.S4, V7.S4\n\tVSRI\t$25, V16.S4, V4.S4\n\tVSRI\t$25, V17.S4, V5.S4\n\tVSRI\t$25, V18.S4, V6.S4\n\tVSRI\t$25, V19.S4, V7.S4\n\n\t// V0..V3 += V5..V7, V4\n\t// V15,V12-V14 <<<= ((V15,V12-V14 XOR V0..V3), 16)\n\tVADD\tV0.S4, V5.S4, V0.S4\n\tVADD\tV1.S4, V6.S4, V1.S4\n\tVADD\tV2.S4, V7.S4, V2.S4\n\tVADD\tV3.S4, V4.S4, V3.S4\n\tVEOR\tV15.B16, V0.B16, V15.B16\n\tVEOR\tV12.B16, V1.B16, V12.B16\n\tVEOR\tV13.B16, V2.B16, V13.B16\n\tVEOR\tV14.B16, V3.B16, V14.B16\n\tVREV32\tV12.H8, V12.H8\n\tVREV32\tV13.H8, V13.H8\n\tVREV32\tV14.H8, V14.H8\n\tVREV32\tV15.H8, V15.H8\n\n\t// V10 += V15; V5 <<<= ((V10 XOR V5), 12)\n\t// ...\n\tVADD\tV15.S4, V10.S4, V10.S4\n\tVADD\tV12.S4, V11.S4, V11.S4\n\tVADD\tV13.S4, V8.S4, V8.S4\n\tVADD\tV14.S4, V9.S4, V9.S4\n\tVEOR\tV10.B16, V5.B16, V16.B16\n\tVEOR\tV11.B16, V6.B16, V17.B16\n\tVEOR\tV8.B16, V7.B16, V18.B16\n\tVEOR\tV9.B16, V4.B16, V19.B16\n\tVSHL\t$12, V16.S4, V5.S4\n\tVSHL\t$12, V17.S4, V6.S4\n\tVSHL\t$12, V18.S4, V7.S4\n\tVSHL\t$12, V19.S4, V4.S4\n\tVSRI\t$20, V16.S4, V5.S4\n\tVSRI\t$20, V17.S4, V6.S4\n\tVSRI\t$20, V18.S4, V7.S4\n\tVSRI\t$20, V19.S4, V4.S4\n\n\t// V0 += V5; V15 <<<= ((V0 XOR V15), 8)\n\t// ...\n\tVADD\tV5.S4, V0.S4, V0.S4\n\tVADD\tV6.S4, V1.S4, V1.S4\n\tVADD\tV7.S4, V2.S4, V2.S4\n\tVADD\tV4.S4, V3.S4, V3.S4\n\tVEOR\tV0.B16, V15.B16, V15.B16\n\tVEOR\tV1.B16, V12.B16, V12.B16\n\tVEOR\tV2.B16, V13.B16, V13.B16\n\tVEOR\tV3.B16, V14.B16, V14.B16\n\tVTBL\tV31.B16, [V12.B16], V12.B16\n\tVTBL\tV31.B16, [V13.B16], V13.B16\n\tVTBL\tV31.B16, [V14.B16], V14.B16\n\tVTBL\tV31.B16, [V15.B16], V15.B16\n\n\t// V10 += V15; V5 <<<= ((V10 XOR V5), 7)\n\t// ...\n\tVADD\tV15.S4, V10.S4, V10.S4\n\tVADD\tV12.S4, V11.S4, V11.S4\n\tVADD\tV13.S4, V8.S4, V8.S4\n\tVADD\tV14.S4, V9.S4, V9.S4\n\tVEOR\tV10.B16, V5.B16, V16.B16\n\tVEOR\tV11.B16, V6.B16, V17.B16\n\tVEOR\tV8.B16, V7.B16, V18.B16\n\tVEOR\tV9.B16, V4.B16, V19.B16\n\tVSHL\t$7, V16.S4, V5.S4\n\tVSHL\t$7, V17.S4, V6.S4\n\tVSHL\t$7, V18.S4, V7.S4\n\tVSHL\t$7, V19.S4, V4.S4\n\tVSRI\t$25, V16.S4, V5.S4\n\tVSRI\t$25, V17.S4, V6.S4\n\tVSRI\t$25, V18.S4, V7.S4\n\tVSRI\t$25, V19.S4, V4.S4\n\n\tSUB\t$1, R21\n\tCBNZ\tR21, chacha\n\n\t// VLD4R (R10), [V16.S4, V17.S4, V18.S4, V19.S4]\n\tWORD\t$0x4D60E950\n\n\t// VLD4R 16(R4), [V20.S4, V21.S4, V22.S4, V23.S4]\n\tWORD\t$0x4DFFE894\n\tVADD\tV30.S4, V12.S4, V12.S4\n\tVADD\tV16.S4, V0.S4, V0.S4\n\tVADD\tV17.S4, V1.S4, V1.S4\n\tVADD\tV18.S4, V2.S4, V2.S4\n\tVADD\tV19.S4, V3.S4, V3.S4\n\t// VLD4R 16(R4), [V24.S4, V25.S4, V26.S4, V27.S4]\n\tWORD\t$0x4DFFE898\n\t// restore R4\n\tSUB\t$32, R4\n\n\t// load counter + nonce\n\t// VLD1R (R7), [V28.S4]\n\tWORD\t$0x4D40C8FC\n\t// VLD3R (R6), [V29.S4, V30.S4, V31.S4]\n\tWORD\t$0x4D40E8DD\n\n\tVADD\tV20.S4, V4.S4, V4.S4\n\tVADD\tV21.S4, V5.S4, V5.S4\n\tVADD\tV22.S4, V6.S4, V6.S4\n\tVADD\tV23.S4, V7.S4, V7.S4\n\tVADD\tV24.S4, V8.S4, V8.S4\n\tVADD\tV25.S4, V9.S4, V9.S4\n\tVADD\tV26.S4, V10.S4, V10.S4\n\tVADD\tV27.S4, V11.S4, V11.S4\n\tVADD\tV28.S4, V12.S4, V12.S4\n\tVADD\tV29.S4, V13.S4, V13.S4\n\tVADD\tV30.S4, V14.S4, V14.S4\n\tVADD\tV31.S4, V15.S4, V15.S4\n\n\tVZIP1\tV1.S4, V0.S4, V16.S4\n\tVZIP2\tV1.S4, V0.S4, V17.S4\n\tVZIP1\tV3.S4, V2.S4, V18.S4\n\tVZIP2\tV3.S4, V2.S4, V19.S4\n\tVZIP1\tV5.S4, V4.S4, V20.S4\n\tVZIP2\tV5.S4, V4.S4, V21.S4\n\tVZIP1\tV7.S4, V6.S4, V22.S4\n\tVZIP2\tV7.S4, V6.S4, V23.S4\n\tVZIP1\tV9.S4, V8.S4, V24.S4\n\tVZIP2\tV9.S4, V8.S4, V25.S4\n\tVZIP1\tV11.S4, V10.S4, V26.S4\n\tVZIP2\tV11.S4, V10.S4, V27.S4\n\tVZIP1\tV13.S4, V12.S4, V28.S4\n\tVZIP2\tV13.S4, V12.S4, V29.S4\n\tVZIP1\tV15.S4, V14.S4, V30.S4\n\tVZIP2\tV15.S4, V14.S4, V31.S4\n\tVZIP1\tV18.D2, V16.D2, V0.D2\n\tVZIP2\tV18.D2, V16.D2, V4.D2\n\tVZIP1\tV19.D2, V17.D2, V8.D2\n\tVZIP2\tV19.D2, V17.D2, V12.D2\n\tVLD1.P\t64(R2), [V16.B16, V17.B16, V18.B16, V19.B16]\n\n\tVZIP1\tV22.D2, V20.D2, V1.D2\n\tVZIP2\tV22.D2, V20.D2, V5.D2\n\tVZIP1\tV23.D2, V21.D2, V9.D2\n\tVZIP2\tV23.D2, V21.D2, V13.D2\n\tVLD1.P\t64(R2), [V20.B16, V21.B16, V22.B16, V23.B16]\n\tVZIP1\tV26.D2, V24.D2, V2.D2\n\tVZIP2\tV26.D2, V24.D2, V6.D2\n\tVZIP1\tV27.D2, V25.D2, V10.D2\n\tVZIP2\tV27.D2, V25.D2, V14.D2\n\tVLD1.P\t64(R2), [V24.B16, V25.B16, V26.B16, V27.B16]\n\tVZIP1\tV30.D2, V28.D2, V3.D2\n\tVZIP2\tV30.D2, V28.D2, V7.D2\n\tVZIP1\tV31.D2, V29.D2, V11.D2\n\tVZIP2\tV31.D2, V29.D2, V15.D2\n\tVLD1.P\t64(R2), [V28.B16, V29.B16, V30.B16, V31.B16]\n\tVEOR\tV0.B16, V16.B16, V16.B16\n\tVEOR\tV1.B16, V17.B16, V17.B16\n\tVEOR\tV2.B16, V18.B16, V18.B16\n\tVEOR\tV3.B16, V19.B16, V19.B16\n\tVST1.P\t[V16.B16, V17.B16, V18.B16, V19.B16], 64(R1)\n\tVEOR\tV4.B16, V20.B16, V20.B16\n\tVEOR\tV5.B16, V21.B16, V21.B16\n\tVEOR\tV6.B16, V22.B16, V22.B16\n\tVEOR\tV7.B16, V23.B16, V23.B16\n\tVST1.P\t[V20.B16, V21.B16, V22.B16, V23.B16], 64(R1)\n\tVEOR\tV8.B16, V24.B16, V24.B16\n\tVEOR\tV9.B16, V25.B16, V25.B16\n\tVEOR\tV10.B16, V26.B16, V26.B16\n\tVEOR\tV11.B16, V27.B16, V27.B16\n\tVST1.P\t[V24.B16, V25.B16, V26.B16, V27.B16], 64(R1)\n\tVEOR\tV12.B16, V28.B16, V28.B16\n\tVEOR\tV13.B16, V29.B16, V29.B16\n\tVEOR\tV14.B16, V30.B16, V30.B16\n\tVEOR\tV15.B16, V31.B16, V31.B16\n\tVST1.P\t[V28.B16, V29.B16, V30.B16, V31.B16], 64(R1)\n\n\tADD\t$4, R20\n\tMOVW\tR20, (R7) // update counter\n\n\tCMP\tR2, R12\n\tBGT\tloop\n\n\tRET\n\n\nDATA\t·constants+0x00(SB)/4, $0x61707865\nDATA\t·constants+0x04(SB)/4, $0x3320646e\nDATA\t·constants+0x08(SB)/4, $0x79622d32\nDATA\t·constants+0x0c(SB)/4, $0x6b206574\nGLOBL\t·constants(SB), NOPTR|RODATA, $32\n\nDATA\t·incRotMatrix+0x00(SB)/4, $0x00000000\nDATA\t·incRotMatrix+0x04(SB)/4, $0x00000001\nDATA\t·incRotMatrix+0x08(SB)/4, $0x00000002\nDATA\t·incRotMatrix+0x0c(SB)/4, $0x00000003\nDATA\t·incRotMatrix+0x10(SB)/4, $0x02010003\nDATA\t·incRotMatrix+0x14(SB)/4, $0x06050407\nDATA\t·incRotMatrix+0x18(SB)/4, $0x0A09080B\nDATA\t·incRotMatrix+0x1c(SB)/4, $0x0E0D0C0F\nGLOBL\t·incRotMatrix(SB), NOPTR|RODATA, $32\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/chacha_generic.go",
"content": "// Copyright 2016 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package chacha20 implements the ChaCha20 and XChaCha20 encryption algorithms\n// as specified in RFC 8439 and draft-irtf-cfrg-xchacha-01.\npackage chacha20\n\nimport (\n\t\"crypto/cipher\"\n\t\"encoding/binary\"\n\t\"errors\"\n\t\"math/bits\"\n\n\t\"golang.org/x/crypto/internal/alias\"\n)\n\nconst (\n\t// KeySize is the size of the key used by this cipher, in bytes.\n\tKeySize = 32\n\n\t// NonceSize is the size of the nonce used with the standard variant of this\n\t// cipher, in bytes.\n\t//\n\t// Note that this is too short to be safely generated at random if the same\n\t// key is reused more than 2³² times.\n\tNonceSize = 12\n\n\t// NonceSizeX is the size of the nonce used with the XChaCha20 variant of\n\t// this cipher, in bytes.\n\tNonceSizeX = 24\n)\n\n// Cipher is a stateful instance of ChaCha20 or XChaCha20 using a particular key\n// and nonce. A *Cipher implements the cipher.Stream interface.\ntype Cipher struct {\n\t// The ChaCha20 state is 16 words: 4 constant, 8 of key, 1 of counter\n\t// (incremented after each block), and 3 of nonce.\n\tkey [8]uint32\n\tcounter uint32\n\tnonce [3]uint32\n\n\t// The last len bytes of buf are leftover key stream bytes from the previous\n\t// XORKeyStream invocation. The size of buf depends on how many blocks are\n\t// computed at a time by xorKeyStreamBlocks.\n\tbuf [bufSize]byte\n\tlen int\n\n\t// overflow is set when the counter overflowed, no more blocks can be\n\t// generated, and the next XORKeyStream call should panic.\n\toverflow bool\n\n\t// The counter-independent results of the first round are cached after they\n\t// are computed the first time.\n\tprecompDone bool\n\tp1, p5, p9, p13 uint32\n\tp2, p6, p10, p14 uint32\n\tp3, p7, p11, p15 uint32\n}\n\nvar _ cipher.Stream = (*Cipher)(nil)\n\n// NewUnauthenticatedCipher creates a new ChaCha20 stream cipher with the given\n// 32 bytes key and a 12 or 24 bytes nonce. If a nonce of 24 bytes is provided,\n// the XChaCha20 construction will be used. It returns an error if key or nonce\n// have any other length.\n//\n// Note that ChaCha20, like all stream ciphers, is not authenticated and allows\n// attackers to silently tamper with the plaintext. For this reason, it is more\n// appropriate as a building block than as a standalone encryption mechanism.\n// Instead, consider using package golang.org/x/crypto/chacha20poly1305.\nfunc NewUnauthenticatedCipher(key, nonce []byte) (*Cipher, error) {\n\t// This function is split into a wrapper so that the Cipher allocation will\n\t// be inlined, and depending on how the caller uses the return value, won't\n\t// escape to the heap.\n\tc := &Cipher{}\n\treturn newUnauthenticatedCipher(c, key, nonce)\n}\n\nfunc newUnauthenticatedCipher(c *Cipher, key, nonce []byte) (*Cipher, error) {\n\tif len(key) != KeySize {\n\t\treturn nil, errors.New(\"chacha20: wrong key size\")\n\t}\n\tif len(nonce) == NonceSizeX {\n\t\t// XChaCha20 uses the ChaCha20 core to mix 16 bytes of the nonce into a\n\t\t// derived key, allowing it to operate on a nonce of 24 bytes. See\n\t\t// draft-irtf-cfrg-xchacha-01, Section 2.3.\n\t\tkey, _ = HChaCha20(key, nonce[0:16])\n\t\tcNonce := make([]byte, NonceSize)\n\t\tcopy(cNonce[4:12], nonce[16:24])\n\t\tnonce = cNonce\n\t} else if len(nonce) != NonceSize {\n\t\treturn nil, errors.New(\"chacha20: wrong nonce size\")\n\t}\n\n\tkey, nonce = key[:KeySize], nonce[:NonceSize] // bounds check elimination hint\n\tc.key = [8]uint32{\n\t\tbinary.LittleEndian.Uint32(key[0:4]),\n\t\tbinary.LittleEndian.Uint32(key[4:8]),\n\t\tbinary.LittleEndian.Uint32(key[8:12]),\n\t\tbinary.LittleEndian.Uint32(key[12:16]),\n\t\tbinary.LittleEndian.Uint32(key[16:20]),\n\t\tbinary.LittleEndian.Uint32(key[20:24]),\n\t\tbinary.LittleEndian.Uint32(key[24:28]),\n\t\tbinary.LittleEndian.Uint32(key[28:32]),\n\t}\n\tc.nonce = [3]uint32{\n\t\tbinary.LittleEndian.Uint32(nonce[0:4]),\n\t\tbinary.LittleEndian.Uint32(nonce[4:8]),\n\t\tbinary.LittleEndian.Uint32(nonce[8:12]),\n\t}\n\treturn c, nil\n}\n\n// The constant first 4 words of the ChaCha20 state.\nconst (\n\tj0 uint32 = 0x61707865 // expa\n\tj1 uint32 = 0x3320646e // nd 3\n\tj2 uint32 = 0x79622d32 // 2-by\n\tj3 uint32 = 0x6b206574 // te k\n)\n\nconst blockSize = 64\n\n// quarterRound is the core of ChaCha20. It shuffles the bits of 4 state words.\n// It's executed 4 times for each of the 20 ChaCha20 rounds, operating on all 16\n// words each round, in columnar or diagonal groups of 4 at a time.\nfunc quarterRound(a, b, c, d uint32) (uint32, uint32, uint32, uint32) {\n\ta += b\n\td ^= a\n\td = bits.RotateLeft32(d, 16)\n\tc += d\n\tb ^= c\n\tb = bits.RotateLeft32(b, 12)\n\ta += b\n\td ^= a\n\td = bits.RotateLeft32(d, 8)\n\tc += d\n\tb ^= c\n\tb = bits.RotateLeft32(b, 7)\n\treturn a, b, c, d\n}\n\n// SetCounter sets the Cipher counter. The next invocation of XORKeyStream will\n// behave as if (64 * counter) bytes had been encrypted so far.\n//\n// To prevent accidental counter reuse, SetCounter panics if counter is less\n// than the current value.\n//\n// Note that the execution time of XORKeyStream is not independent of the\n// counter value.\nfunc (s *Cipher) SetCounter(counter uint32) {\n\t// Internally, s may buffer multiple blocks, which complicates this\n\t// implementation slightly. When checking whether the counter has rolled\n\t// back, we must use both s.counter and s.len to determine how many blocks\n\t// we have already output.\n\toutputCounter := s.counter - uint32(s.len)/blockSize\n\tif s.overflow || counter < outputCounter {\n\t\tpanic(\"chacha20: SetCounter attempted to rollback counter\")\n\t}\n\n\t// In the general case, we set the new counter value and reset s.len to 0,\n\t// causing the next call to XORKeyStream to refill the buffer. However, if\n\t// we're advancing within the existing buffer, we can save work by simply\n\t// setting s.len.\n\tif counter < s.counter {\n\t\ts.len = int(s.counter-counter) * blockSize\n\t} else {\n\t\ts.counter = counter\n\t\ts.len = 0\n\t}\n}\n\n// XORKeyStream XORs each byte in the given slice with a byte from the\n// cipher's key stream. Dst and src must overlap entirely or not at all.\n//\n// If len(dst) < len(src), XORKeyStream will panic. It is acceptable\n// to pass a dst bigger than src, and in that case, XORKeyStream will\n// only update dst[:len(src)] and will not touch the rest of dst.\n//\n// Multiple calls to XORKeyStream behave as if the concatenation of\n// the src buffers was passed in a single run. That is, Cipher\n// maintains state and does not reset at each XORKeyStream call.\nfunc (s *Cipher) XORKeyStream(dst, src []byte) {\n\tif len(src) == 0 {\n\t\treturn\n\t}\n\tif len(dst) < len(src) {\n\t\tpanic(\"chacha20: output smaller than input\")\n\t}\n\tdst = dst[:len(src)]\n\tif alias.InexactOverlap(dst, src) {\n\t\tpanic(\"chacha20: invalid buffer overlap\")\n\t}\n\n\t// First, drain any remaining key stream from a previous XORKeyStream.\n\tif s.len != 0 {\n\t\tkeyStream := s.buf[bufSize-s.len:]\n\t\tif len(src) < len(keyStream) {\n\t\t\tkeyStream = keyStream[:len(src)]\n\t\t}\n\t\t_ = src[len(keyStream)-1] // bounds check elimination hint\n\t\tfor i, b := range keyStream {\n\t\t\tdst[i] = src[i] ^ b\n\t\t}\n\t\ts.len -= len(keyStream)\n\t\tdst, src = dst[len(keyStream):], src[len(keyStream):]\n\t}\n\tif len(src) == 0 {\n\t\treturn\n\t}\n\n\t// If we'd need to let the counter overflow and keep generating output,\n\t// panic immediately. If instead we'd only reach the last block, remember\n\t// not to generate any more output after the buffer is drained.\n\tnumBlocks := (uint64(len(src)) + blockSize - 1) / blockSize\n\tif s.overflow || uint64(s.counter)+numBlocks > 1<<32 {\n\t\tpanic(\"chacha20: counter overflow\")\n\t} else if uint64(s.counter)+numBlocks == 1<<32 {\n\t\ts.overflow = true\n\t}\n\n\t// xorKeyStreamBlocks implementations expect input lengths that are a\n\t// multiple of bufSize. Platform-specific ones process multiple blocks at a\n\t// time, so have bufSizes that are a multiple of blockSize.\n\n\tfull := len(src) - len(src)%bufSize\n\tif full > 0 {\n\t\ts.xorKeyStreamBlocks(dst[:full], src[:full])\n\t}\n\tdst, src = dst[full:], src[full:]\n\n\t// If using a multi-block xorKeyStreamBlocks would overflow, use the generic\n\t// one that does one block at a time.\n\tconst blocksPerBuf = bufSize / blockSize\n\tif uint64(s.counter)+blocksPerBuf > 1<<32 {\n\t\ts.buf = [bufSize]byte{}\n\t\tnumBlocks := (len(src) + blockSize - 1) / blockSize\n\t\tbuf := s.buf[bufSize-numBlocks*blockSize:]\n\t\tcopy(buf, src)\n\t\ts.xorKeyStreamBlocksGeneric(buf, buf)\n\t\ts.len = len(buf) - copy(dst, buf)\n\t\treturn\n\t}\n\n\t// If we have a partial (multi-)block, pad it for xorKeyStreamBlocks, and\n\t// keep the leftover keystream for the next XORKeyStream invocation.\n\tif len(src) > 0 {\n\t\ts.buf = [bufSize]byte{}\n\t\tcopy(s.buf[:], src)\n\t\ts.xorKeyStreamBlocks(s.buf[:], s.buf[:])\n\t\ts.len = bufSize - copy(dst, s.buf[:])\n\t}\n}\n\nfunc (s *Cipher) xorKeyStreamBlocksGeneric(dst, src []byte) {\n\tif len(dst) != len(src) || len(dst)%blockSize != 0 {\n\t\tpanic(\"chacha20: internal error: wrong dst and/or src length\")\n\t}\n\n\t// To generate each block of key stream, the initial cipher state\n\t// (represented below) is passed through 20 rounds of shuffling,\n\t// alternatively applying quarterRounds by columns (like 1, 5, 9, 13)\n\t// or by diagonals (like 1, 6, 11, 12).\n\t//\n\t// 0:cccccccc 1:cccccccc 2:cccccccc 3:cccccccc\n\t// 4:kkkkkkkk 5:kkkkkkkk 6:kkkkkkkk 7:kkkkkkkk\n\t// 8:kkkkkkkk 9:kkkkkkkk 10:kkkkkkkk 11:kkkkkkkk\n\t// 12:bbbbbbbb 13:nnnnnnnn 14:nnnnnnnn 15:nnnnnnnn\n\t//\n\t// c=constant k=key b=blockcount n=nonce\n\tvar (\n\t\tc0, c1, c2, c3 = j0, j1, j2, j3\n\t\tc4, c5, c6, c7 = s.key[0], s.key[1], s.key[2], s.key[3]\n\t\tc8, c9, c10, c11 = s.key[4], s.key[5], s.key[6], s.key[7]\n\t\t_, c13, c14, c15 = s.counter, s.nonce[0], s.nonce[1], s.nonce[2]\n\t)\n\n\t// Three quarters of the first round don't depend on the counter, so we can\n\t// calculate them here, and reuse them for multiple blocks in the loop, and\n\t// for future XORKeyStream invocations.\n\tif !s.precompDone {\n\t\ts.p1, s.p5, s.p9, s.p13 = quarterRound(c1, c5, c9, c13)\n\t\ts.p2, s.p6, s.p10, s.p14 = quarterRound(c2, c6, c10, c14)\n\t\ts.p3, s.p7, s.p11, s.p15 = quarterRound(c3, c7, c11, c15)\n\t\ts.precompDone = true\n\t}\n\n\t// A condition of len(src) > 0 would be sufficient, but this also\n\t// acts as a bounds check elimination hint.\n\tfor len(src) >= 64 && len(dst) >= 64 {\n\t\t// The remainder of the first column round.\n\t\tfcr0, fcr4, fcr8, fcr12 := quarterRound(c0, c4, c8, s.counter)\n\n\t\t// The second diagonal round.\n\t\tx0, x5, x10, x15 := quarterRound(fcr0, s.p5, s.p10, s.p15)\n\t\tx1, x6, x11, x12 := quarterRound(s.p1, s.p6, s.p11, fcr12)\n\t\tx2, x7, x8, x13 := quarterRound(s.p2, s.p7, fcr8, s.p13)\n\t\tx3, x4, x9, x14 := quarterRound(s.p3, fcr4, s.p9, s.p14)\n\n\t\t// The remaining 18 rounds.\n\t\tfor i := 0; i < 9; i++ {\n\t\t\t// Column round.\n\t\t\tx0, x4, x8, x12 = quarterRound(x0, x4, x8, x12)\n\t\t\tx1, x5, x9, x13 = quarterRound(x1, x5, x9, x13)\n\t\t\tx2, x6, x10, x14 = quarterRound(x2, x6, x10, x14)\n\t\t\tx3, x7, x11, x15 = quarterRound(x3, x7, x11, x15)\n\n\t\t\t// Diagonal round.\n\t\t\tx0, x5, x10, x15 = quarterRound(x0, x5, x10, x15)\n\t\t\tx1, x6, x11, x12 = quarterRound(x1, x6, x11, x12)\n\t\t\tx2, x7, x8, x13 = quarterRound(x2, x7, x8, x13)\n\t\t\tx3, x4, x9, x14 = quarterRound(x3, x4, x9, x14)\n\t\t}\n\n\t\t// Add back the initial state to generate the key stream, then\n\t\t// XOR the key stream with the source and write out the result.\n\t\taddXor(dst[0:4], src[0:4], x0, c0)\n\t\taddXor(dst[4:8], src[4:8], x1, c1)\n\t\taddXor(dst[8:12], src[8:12], x2, c2)\n\t\taddXor(dst[12:16], src[12:16], x3, c3)\n\t\taddXor(dst[16:20], src[16:20], x4, c4)\n\t\taddXor(dst[20:24], src[20:24], x5, c5)\n\t\taddXor(dst[24:28], src[24:28], x6, c6)\n\t\taddXor(dst[28:32], src[28:32], x7, c7)\n\t\taddXor(dst[32:36], src[32:36], x8, c8)\n\t\taddXor(dst[36:40], src[36:40], x9, c9)\n\t\taddXor(dst[40:44], src[40:44], x10, c10)\n\t\taddXor(dst[44:48], src[44:48], x11, c11)\n\t\taddXor(dst[48:52], src[48:52], x12, s.counter)\n\t\taddXor(dst[52:56], src[52:56], x13, c13)\n\t\taddXor(dst[56:60], src[56:60], x14, c14)\n\t\taddXor(dst[60:64], src[60:64], x15, c15)\n\n\t\ts.counter += 1\n\n\t\tsrc, dst = src[blockSize:], dst[blockSize:]\n\t}\n}\n\n// HChaCha20 uses the ChaCha20 core to generate a derived key from a 32 bytes\n// key and a 16 bytes nonce. It returns an error if key or nonce have any other\n// length. It is used as part of the XChaCha20 construction.\nfunc HChaCha20(key, nonce []byte) ([]byte, error) {\n\t// This function is split into a wrapper so that the slice allocation will\n\t// be inlined, and depending on how the caller uses the return value, won't\n\t// escape to the heap.\n\tout := make([]byte, 32)\n\treturn hChaCha20(out, key, nonce)\n}\n\nfunc hChaCha20(out, key, nonce []byte) ([]byte, error) {\n\tif len(key) != KeySize {\n\t\treturn nil, errors.New(\"chacha20: wrong HChaCha20 key size\")\n\t}\n\tif len(nonce) != 16 {\n\t\treturn nil, errors.New(\"chacha20: wrong HChaCha20 nonce size\")\n\t}\n\n\tx0, x1, x2, x3 := j0, j1, j2, j3\n\tx4 := binary.LittleEndian.Uint32(key[0:4])\n\tx5 := binary.LittleEndian.Uint32(key[4:8])\n\tx6 := binary.LittleEndian.Uint32(key[8:12])\n\tx7 := binary.LittleEndian.Uint32(key[12:16])\n\tx8 := binary.LittleEndian.Uint32(key[16:20])\n\tx9 := binary.LittleEndian.Uint32(key[20:24])\n\tx10 := binary.LittleEndian.Uint32(key[24:28])\n\tx11 := binary.LittleEndian.Uint32(key[28:32])\n\tx12 := binary.LittleEndian.Uint32(nonce[0:4])\n\tx13 := binary.LittleEndian.Uint32(nonce[4:8])\n\tx14 := binary.LittleEndian.Uint32(nonce[8:12])\n\tx15 := binary.LittleEndian.Uint32(nonce[12:16])\n\n\tfor i := 0; i < 10; i++ {\n\t\t// Diagonal round.\n\t\tx0, x4, x8, x12 = quarterRound(x0, x4, x8, x12)\n\t\tx1, x5, x9, x13 = quarterRound(x1, x5, x9, x13)\n\t\tx2, x6, x10, x14 = quarterRound(x2, x6, x10, x14)\n\t\tx3, x7, x11, x15 = quarterRound(x3, x7, x11, x15)\n\n\t\t// Column round.\n\t\tx0, x5, x10, x15 = quarterRound(x0, x5, x10, x15)\n\t\tx1, x6, x11, x12 = quarterRound(x1, x6, x11, x12)\n\t\tx2, x7, x8, x13 = quarterRound(x2, x7, x8, x13)\n\t\tx3, x4, x9, x14 = quarterRound(x3, x4, x9, x14)\n\t}\n\n\t_ = out[31] // bounds check elimination hint\n\tbinary.LittleEndian.PutUint32(out[0:4], x0)\n\tbinary.LittleEndian.PutUint32(out[4:8], x1)\n\tbinary.LittleEndian.PutUint32(out[8:12], x2)\n\tbinary.LittleEndian.PutUint32(out[12:16], x3)\n\tbinary.LittleEndian.PutUint32(out[16:20], x12)\n\tbinary.LittleEndian.PutUint32(out[20:24], x13)\n\tbinary.LittleEndian.PutUint32(out[24:28], x14)\n\tbinary.LittleEndian.PutUint32(out[28:32], x15)\n\treturn out, nil\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/chacha_noasm.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build (!arm64 && !s390x && !ppc64 && !ppc64le) || !gc || purego\n\npackage chacha20\n\nconst bufSize = blockSize\n\nfunc (s *Cipher) xorKeyStreamBlocks(dst, src []byte) {\n\ts.xorKeyStreamBlocksGeneric(dst, src)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/chacha_ppc64x.go",
"content": "// Copyright 2019 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego && (ppc64 || ppc64le)\n\npackage chacha20\n\nconst bufSize = 256\n\n//go:noescape\nfunc chaCha20_ctr32_vsx(out, inp *byte, len int, key *[8]uint32, counter *uint32)\n\nfunc (c *Cipher) xorKeyStreamBlocks(dst, src []byte) {\n\tchaCha20_ctr32_vsx(&dst[0], &src[0], len(src), &c.key, &c.counter)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/chacha_ppc64x.s",
"content": "// Copyright 2019 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Based on CRYPTOGAMS code with the following comment:\n// # ====================================================================\n// # Written by Andy Polyakov for the OpenSSL\n// # project. The module is, however, dual licensed under OpenSSL and\n// # CRYPTOGAMS licenses depending on where you obtain it. For further\n// # details see http://www.openssl.org/~appro/cryptogams/.\n// # ====================================================================\n\n// Code for the perl script that generates the ppc64 assembler\n// can be found in the cryptogams repository at the link below. It is based on\n// the original from openssl.\n\n// https://github.com/dot-asm/cryptogams/commit/a60f5b50ed908e91\n\n// The differences in this and the original implementation are\n// due to the calling conventions and initialization of constants.\n\n//go:build gc && !purego && (ppc64 || ppc64le)\n\n#include \"textflag.h\"\n\n#define OUT R3\n#define INP R4\n#define LEN R5\n#define KEY R6\n#define CNT R7\n#define TMP R15\n\n#define CONSTBASE R16\n#define BLOCKS R17\n\n// for VPERMXOR\n#define MASK R18\n\nDATA consts<>+0x00(SB)/4, $0x61707865\nDATA consts<>+0x04(SB)/4, $0x3320646e\nDATA consts<>+0x08(SB)/4, $0x79622d32\nDATA consts<>+0x0c(SB)/4, $0x6b206574\nDATA consts<>+0x10(SB)/4, $0x00000001\nDATA consts<>+0x14(SB)/4, $0x00000000\nDATA consts<>+0x18(SB)/4, $0x00000000\nDATA consts<>+0x1c(SB)/4, $0x00000000\nDATA consts<>+0x20(SB)/4, $0x00000004\nDATA consts<>+0x24(SB)/4, $0x00000000\nDATA consts<>+0x28(SB)/4, $0x00000000\nDATA consts<>+0x2c(SB)/4, $0x00000000\nDATA consts<>+0x30(SB)/4, $0x0e0f0c0d\nDATA consts<>+0x34(SB)/4, $0x0a0b0809\nDATA consts<>+0x38(SB)/4, $0x06070405\nDATA consts<>+0x3c(SB)/4, $0x02030001\nDATA consts<>+0x40(SB)/4, $0x0d0e0f0c\nDATA consts<>+0x44(SB)/4, $0x090a0b08\nDATA consts<>+0x48(SB)/4, $0x05060704\nDATA consts<>+0x4c(SB)/4, $0x01020300\nDATA consts<>+0x50(SB)/4, $0x61707865\nDATA consts<>+0x54(SB)/4, $0x61707865\nDATA consts<>+0x58(SB)/4, $0x61707865\nDATA consts<>+0x5c(SB)/4, $0x61707865\nDATA consts<>+0x60(SB)/4, $0x3320646e\nDATA consts<>+0x64(SB)/4, $0x3320646e\nDATA consts<>+0x68(SB)/4, $0x3320646e\nDATA consts<>+0x6c(SB)/4, $0x3320646e\nDATA consts<>+0x70(SB)/4, $0x79622d32\nDATA consts<>+0x74(SB)/4, $0x79622d32\nDATA consts<>+0x78(SB)/4, $0x79622d32\nDATA consts<>+0x7c(SB)/4, $0x79622d32\nDATA consts<>+0x80(SB)/4, $0x6b206574\nDATA consts<>+0x84(SB)/4, $0x6b206574\nDATA consts<>+0x88(SB)/4, $0x6b206574\nDATA consts<>+0x8c(SB)/4, $0x6b206574\nDATA consts<>+0x90(SB)/4, $0x00000000\nDATA consts<>+0x94(SB)/4, $0x00000001\nDATA consts<>+0x98(SB)/4, $0x00000002\nDATA consts<>+0x9c(SB)/4, $0x00000003\nDATA consts<>+0xa0(SB)/4, $0x11223300\nDATA consts<>+0xa4(SB)/4, $0x55667744\nDATA consts<>+0xa8(SB)/4, $0x99aabb88\nDATA consts<>+0xac(SB)/4, $0xddeeffcc\nDATA consts<>+0xb0(SB)/4, $0x22330011\nDATA consts<>+0xb4(SB)/4, $0x66774455\nDATA consts<>+0xb8(SB)/4, $0xaabb8899\nDATA consts<>+0xbc(SB)/4, $0xeeffccdd\nGLOBL consts<>(SB), RODATA, $0xc0\n\n#ifdef GOARCH_ppc64\n#define BE_XXBRW_INIT() \\\n\t\tLVSL (R0)(R0), V24 \\\n\t\tVSPLTISB $3, V25 \\\n\t\tVXOR V24, V25, V24 \\\n\n#define BE_XXBRW(vr) VPERM vr, vr, V24, vr\n#else\n#define BE_XXBRW_INIT()\n#define BE_XXBRW(vr)\n#endif\n\n//func chaCha20_ctr32_vsx(out, inp *byte, len int, key *[8]uint32, counter *uint32)\nTEXT ·chaCha20_ctr32_vsx(SB),NOSPLIT,$64-40\n\tMOVD out+0(FP), OUT\n\tMOVD inp+8(FP), INP\n\tMOVD len+16(FP), LEN\n\tMOVD key+24(FP), KEY\n\tMOVD counter+32(FP), CNT\n\n\t// Addressing for constants\n\tMOVD $consts<>+0x00(SB), CONSTBASE\n\tMOVD $16, R8\n\tMOVD $32, R9\n\tMOVD $48, R10\n\tMOVD $64, R11\n\tSRD $6, LEN, BLOCKS\n\t// for VPERMXOR\n\tMOVD $consts<>+0xa0(SB), MASK\n\tMOVD $16, R20\n\t// V16\n\tLXVW4X (CONSTBASE)(R0), VS48\n\tADD $80,CONSTBASE\n\n\t// Load key into V17,V18\n\tLXVW4X (KEY)(R0), VS49\n\tLXVW4X (KEY)(R8), VS50\n\n\t// Load CNT, NONCE into V19\n\tLXVW4X (CNT)(R0), VS51\n\n\t// Clear V27\n\tVXOR V27, V27, V27\n\n\tBE_XXBRW_INIT()\n\n\t// V28\n\tLXVW4X (CONSTBASE)(R11), VS60\n\n\t// Load mask constants for VPERMXOR\n\tLXVW4X (MASK)(R0), V20\n\tLXVW4X (MASK)(R20), V21\n\n\t// splat slot from V19 -> V26\n\tVSPLTW $0, V19, V26\n\n\tVSLDOI $4, V19, V27, V19\n\tVSLDOI $12, V27, V19, V19\n\n\tVADDUWM V26, V28, V26\n\n\tMOVD $10, R14\n\tMOVD R14, CTR\n\tPCALIGN $16\nloop_outer_vsx:\n\t// V0, V1, V2, V3\n\tLXVW4X (R0)(CONSTBASE), VS32\n\tLXVW4X (R8)(CONSTBASE), VS33\n\tLXVW4X (R9)(CONSTBASE), VS34\n\tLXVW4X (R10)(CONSTBASE), VS35\n\n\t// splat values from V17, V18 into V4-V11\n\tVSPLTW $0, V17, V4\n\tVSPLTW $1, V17, V5\n\tVSPLTW $2, V17, V6\n\tVSPLTW $3, V17, V7\n\tVSPLTW $0, V18, V8\n\tVSPLTW $1, V18, V9\n\tVSPLTW $2, V18, V10\n\tVSPLTW $3, V18, V11\n\n\t// VOR\n\tVOR V26, V26, V12\n\n\t// splat values from V19 -> V13, V14, V15\n\tVSPLTW $1, V19, V13\n\tVSPLTW $2, V19, V14\n\tVSPLTW $3, V19, V15\n\n\t// splat const values\n\tVSPLTISW $-16, V27\n\tVSPLTISW $12, V28\n\tVSPLTISW $8, V29\n\tVSPLTISW $7, V30\n\tPCALIGN $16\nloop_vsx:\n\tVADDUWM V0, V4, V0\n\tVADDUWM V1, V5, V1\n\tVADDUWM V2, V6, V2\n\tVADDUWM V3, V7, V3\n\n\tVPERMXOR V12, V0, V21, V12\n\tVPERMXOR V13, V1, V21, V13\n\tVPERMXOR V14, V2, V21, V14\n\tVPERMXOR V15, V3, V21, V15\n\n\tVADDUWM V8, V12, V8\n\tVADDUWM V9, V13, V9\n\tVADDUWM V10, V14, V10\n\tVADDUWM V11, V15, V11\n\n\tVXOR V4, V8, V4\n\tVXOR V5, V9, V5\n\tVXOR V6, V10, V6\n\tVXOR V7, V11, V7\n\n\tVRLW V4, V28, V4\n\tVRLW V5, V28, V5\n\tVRLW V6, V28, V6\n\tVRLW V7, V28, V7\n\n\tVADDUWM V0, V4, V0\n\tVADDUWM V1, V5, V1\n\tVADDUWM V2, V6, V2\n\tVADDUWM V3, V7, V3\n\n\tVPERMXOR V12, V0, V20, V12\n\tVPERMXOR V13, V1, V20, V13\n\tVPERMXOR V14, V2, V20, V14\n\tVPERMXOR V15, V3, V20, V15\n\n\tVADDUWM V8, V12, V8\n\tVADDUWM V9, V13, V9\n\tVADDUWM V10, V14, V10\n\tVADDUWM V11, V15, V11\n\n\tVXOR V4, V8, V4\n\tVXOR V5, V9, V5\n\tVXOR V6, V10, V6\n\tVXOR V7, V11, V7\n\n\tVRLW V4, V30, V4\n\tVRLW V5, V30, V5\n\tVRLW V6, V30, V6\n\tVRLW V7, V30, V7\n\n\tVADDUWM V0, V5, V0\n\tVADDUWM V1, V6, V1\n\tVADDUWM V2, V7, V2\n\tVADDUWM V3, V4, V3\n\n\tVPERMXOR V15, V0, V21, V15\n\tVPERMXOR V12, V1, V21, V12\n\tVPERMXOR V13, V2, V21, V13\n\tVPERMXOR V14, V3, V21, V14\n\n\tVADDUWM V10, V15, V10\n\tVADDUWM V11, V12, V11\n\tVADDUWM V8, V13, V8\n\tVADDUWM V9, V14, V9\n\n\tVXOR V5, V10, V5\n\tVXOR V6, V11, V6\n\tVXOR V7, V8, V7\n\tVXOR V4, V9, V4\n\n\tVRLW V5, V28, V5\n\tVRLW V6, V28, V6\n\tVRLW V7, V28, V7\n\tVRLW V4, V28, V4\n\n\tVADDUWM V0, V5, V0\n\tVADDUWM V1, V6, V1\n\tVADDUWM V2, V7, V2\n\tVADDUWM V3, V4, V3\n\n\tVPERMXOR V15, V0, V20, V15\n\tVPERMXOR V12, V1, V20, V12\n\tVPERMXOR V13, V2, V20, V13\n\tVPERMXOR V14, V3, V20, V14\n\n\tVADDUWM V10, V15, V10\n\tVADDUWM V11, V12, V11\n\tVADDUWM V8, V13, V8\n\tVADDUWM V9, V14, V9\n\n\tVXOR V5, V10, V5\n\tVXOR V6, V11, V6\n\tVXOR V7, V8, V7\n\tVXOR V4, V9, V4\n\n\tVRLW V5, V30, V5\n\tVRLW V6, V30, V6\n\tVRLW V7, V30, V7\n\tVRLW V4, V30, V4\n\tBDNZ loop_vsx\n\n\tVADDUWM V12, V26, V12\n\n\tVMRGEW V0, V1, V27\n\tVMRGEW V2, V3, V28\n\n\tVMRGOW V0, V1, V0\n\tVMRGOW V2, V3, V2\n\n\tVMRGEW V4, V5, V29\n\tVMRGEW V6, V7, V30\n\n\tXXPERMDI VS32, VS34, $0, VS33\n\tXXPERMDI VS32, VS34, $3, VS35\n\tXXPERMDI VS59, VS60, $0, VS32\n\tXXPERMDI VS59, VS60, $3, VS34\n\n\tVMRGOW V4, V5, V4\n\tVMRGOW V6, V7, V6\n\n\tVMRGEW V8, V9, V27\n\tVMRGEW V10, V11, V28\n\n\tXXPERMDI VS36, VS38, $0, VS37\n\tXXPERMDI VS36, VS38, $3, VS39\n\tXXPERMDI VS61, VS62, $0, VS36\n\tXXPERMDI VS61, VS62, $3, VS38\n\n\tVMRGOW V8, V9, V8\n\tVMRGOW V10, V11, V10\n\n\tVMRGEW V12, V13, V29\n\tVMRGEW V14, V15, V30\n\n\tXXPERMDI VS40, VS42, $0, VS41\n\tXXPERMDI VS40, VS42, $3, VS43\n\tXXPERMDI VS59, VS60, $0, VS40\n\tXXPERMDI VS59, VS60, $3, VS42\n\n\tVMRGOW V12, V13, V12\n\tVMRGOW V14, V15, V14\n\n\tVSPLTISW $4, V27\n\tVADDUWM V26, V27, V26\n\n\tXXPERMDI VS44, VS46, $0, VS45\n\tXXPERMDI VS44, VS46, $3, VS47\n\tXXPERMDI VS61, VS62, $0, VS44\n\tXXPERMDI VS61, VS62, $3, VS46\n\n\tVADDUWM V0, V16, V0\n\tVADDUWM V4, V17, V4\n\tVADDUWM V8, V18, V8\n\tVADDUWM V12, V19, V12\n\n\tBE_XXBRW(V0)\n\tBE_XXBRW(V4)\n\tBE_XXBRW(V8)\n\tBE_XXBRW(V12)\n\n\tCMPU LEN, $64\n\tBLT tail_vsx\n\n\t// Bottom of loop\n\tLXVW4X (INP)(R0), VS59\n\tLXVW4X (INP)(R8), VS60\n\tLXVW4X (INP)(R9), VS61\n\tLXVW4X (INP)(R10), VS62\n\n\tVXOR V27, V0, V27\n\tVXOR V28, V4, V28\n\tVXOR V29, V8, V29\n\tVXOR V30, V12, V30\n\n\tSTXVW4X VS59, (OUT)(R0)\n\tSTXVW4X VS60, (OUT)(R8)\n\tADD $64, INP\n\tSTXVW4X VS61, (OUT)(R9)\n\tADD $-64, LEN\n\tSTXVW4X VS62, (OUT)(R10)\n\tADD $64, OUT\n\tBEQ done_vsx\n\n\tVADDUWM V1, V16, V0\n\tVADDUWM V5, V17, V4\n\tVADDUWM V9, V18, V8\n\tVADDUWM V13, V19, V12\n\n\tBE_XXBRW(V0)\n\tBE_XXBRW(V4)\n\tBE_XXBRW(V8)\n\tBE_XXBRW(V12)\n\n\tCMPU LEN, $64\n\tBLT tail_vsx\n\n\tLXVW4X (INP)(R0), VS59\n\tLXVW4X (INP)(R8), VS60\n\tLXVW4X (INP)(R9), VS61\n\tLXVW4X (INP)(R10), VS62\n\n\tVXOR V27, V0, V27\n\tVXOR V28, V4, V28\n\tVXOR V29, V8, V29\n\tVXOR V30, V12, V30\n\n\tSTXVW4X VS59, (OUT)(R0)\n\tSTXVW4X VS60, (OUT)(R8)\n\tADD $64, INP\n\tSTXVW4X VS61, (OUT)(R9)\n\tADD $-64, LEN\n\tSTXVW4X VS62, (OUT)(V10)\n\tADD $64, OUT\n\tBEQ done_vsx\n\n\tVADDUWM V2, V16, V0\n\tVADDUWM V6, V17, V4\n\tVADDUWM V10, V18, V8\n\tVADDUWM V14, V19, V12\n\n\tBE_XXBRW(V0)\n\tBE_XXBRW(V4)\n\tBE_XXBRW(V8)\n\tBE_XXBRW(V12)\n\n\tCMPU LEN, $64\n\tBLT tail_vsx\n\n\tLXVW4X (INP)(R0), VS59\n\tLXVW4X (INP)(R8), VS60\n\tLXVW4X (INP)(R9), VS61\n\tLXVW4X (INP)(R10), VS62\n\n\tVXOR V27, V0, V27\n\tVXOR V28, V4, V28\n\tVXOR V29, V8, V29\n\tVXOR V30, V12, V30\n\n\tSTXVW4X VS59, (OUT)(R0)\n\tSTXVW4X VS60, (OUT)(R8)\n\tADD $64, INP\n\tSTXVW4X VS61, (OUT)(R9)\n\tADD $-64, LEN\n\tSTXVW4X VS62, (OUT)(R10)\n\tADD $64, OUT\n\tBEQ done_vsx\n\n\tVADDUWM V3, V16, V0\n\tVADDUWM V7, V17, V4\n\tVADDUWM V11, V18, V8\n\tVADDUWM V15, V19, V12\n\n\tBE_XXBRW(V0)\n\tBE_XXBRW(V4)\n\tBE_XXBRW(V8)\n\tBE_XXBRW(V12)\n\n\tCMPU LEN, $64\n\tBLT tail_vsx\n\n\tLXVW4X (INP)(R0), VS59\n\tLXVW4X (INP)(R8), VS60\n\tLXVW4X (INP)(R9), VS61\n\tLXVW4X (INP)(R10), VS62\n\n\tVXOR V27, V0, V27\n\tVXOR V28, V4, V28\n\tVXOR V29, V8, V29\n\tVXOR V30, V12, V30\n\n\tSTXVW4X VS59, (OUT)(R0)\n\tSTXVW4X VS60, (OUT)(R8)\n\tADD $64, INP\n\tSTXVW4X VS61, (OUT)(R9)\n\tADD $-64, LEN\n\tSTXVW4X VS62, (OUT)(R10)\n\tADD $64, OUT\n\n\tMOVD $10, R14\n\tMOVD R14, CTR\n\tBNE loop_outer_vsx\n\ndone_vsx:\n\t// Increment counter by number of 64 byte blocks\n\tMOVWZ (CNT), R14\n\tADD BLOCKS, R14\n\tMOVWZ R14, (CNT)\n\tRET\n\ntail_vsx:\n\tADD $32, R1, R11\n\tMOVD LEN, CTR\n\n\t// Save values on stack to copy from\n\tSTXVW4X VS32, (R11)(R0)\n\tSTXVW4X VS36, (R11)(R8)\n\tSTXVW4X VS40, (R11)(R9)\n\tSTXVW4X VS44, (R11)(R10)\n\tADD $-1, R11, R12\n\tADD $-1, INP\n\tADD $-1, OUT\n\tPCALIGN $16\nlooptail_vsx:\n\t// Copying the result to OUT\n\t// in bytes.\n\tMOVBZU 1(R12), KEY\n\tMOVBZU 1(INP), TMP\n\tXOR KEY, TMP, KEY\n\tMOVBU KEY, 1(OUT)\n\tBDNZ looptail_vsx\n\n\t// Clear the stack values\n\tSTXVW4X VS48, (R11)(R0)\n\tSTXVW4X VS48, (R11)(R8)\n\tSTXVW4X VS48, (R11)(R9)\n\tSTXVW4X VS48, (R11)(R10)\n\tBR done_vsx\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/chacha_s390x.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego\n\npackage chacha20\n\nimport \"golang.org/x/sys/cpu\"\n\nvar haveAsm = cpu.S390X.HasVX\n\nconst bufSize = 256\n\n// xorKeyStreamVX is an assembly implementation of XORKeyStream. It must only\n// be called when the vector facility is available. Implementation in asm_s390x.s.\n//\n//go:noescape\nfunc xorKeyStreamVX(dst, src []byte, key *[8]uint32, nonce *[3]uint32, counter *uint32)\n\nfunc (c *Cipher) xorKeyStreamBlocks(dst, src []byte) {\n\tif cpu.S390X.HasVX {\n\t\txorKeyStreamVX(dst, src, &c.key, &c.nonce, &c.counter)\n\t} else {\n\t\tc.xorKeyStreamBlocksGeneric(dst, src)\n\t}\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/chacha_s390x.s",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego\n\n#include \"go_asm.h\"\n#include \"textflag.h\"\n\n// This is an implementation of the ChaCha20 encryption algorithm as\n// specified in RFC 7539. It uses vector instructions to compute\n// 4 keystream blocks in parallel (256 bytes) which are then XORed\n// with the bytes in the input slice.\n\nGLOBL ·constants<>(SB), RODATA|NOPTR, $32\n// BSWAP: swap bytes in each 4-byte element\nDATA ·constants<>+0x00(SB)/4, $0x03020100\nDATA ·constants<>+0x04(SB)/4, $0x07060504\nDATA ·constants<>+0x08(SB)/4, $0x0b0a0908\nDATA ·constants<>+0x0c(SB)/4, $0x0f0e0d0c\n// J0: [j0, j1, j2, j3]\nDATA ·constants<>+0x10(SB)/4, $0x61707865\nDATA ·constants<>+0x14(SB)/4, $0x3320646e\nDATA ·constants<>+0x18(SB)/4, $0x79622d32\nDATA ·constants<>+0x1c(SB)/4, $0x6b206574\n\n#define BSWAP V5\n#define J0 V6\n#define KEY0 V7\n#define KEY1 V8\n#define NONCE V9\n#define CTR V10\n#define M0 V11\n#define M1 V12\n#define M2 V13\n#define M3 V14\n#define INC V15\n#define X0 V16\n#define X1 V17\n#define X2 V18\n#define X3 V19\n#define X4 V20\n#define X5 V21\n#define X6 V22\n#define X7 V23\n#define X8 V24\n#define X9 V25\n#define X10 V26\n#define X11 V27\n#define X12 V28\n#define X13 V29\n#define X14 V30\n#define X15 V31\n\n#define NUM_ROUNDS 20\n\n#define ROUND4(a0, a1, a2, a3, b0, b1, b2, b3, c0, c1, c2, c3, d0, d1, d2, d3) \\\n\tVAF a1, a0, a0 \\\n\tVAF b1, b0, b0 \\\n\tVAF c1, c0, c0 \\\n\tVAF d1, d0, d0 \\\n\tVX a0, a2, a2 \\\n\tVX b0, b2, b2 \\\n\tVX c0, c2, c2 \\\n\tVX d0, d2, d2 \\\n\tVERLLF $16, a2, a2 \\\n\tVERLLF $16, b2, b2 \\\n\tVERLLF $16, c2, c2 \\\n\tVERLLF $16, d2, d2 \\\n\tVAF a2, a3, a3 \\\n\tVAF b2, b3, b3 \\\n\tVAF c2, c3, c3 \\\n\tVAF d2, d3, d3 \\\n\tVX a3, a1, a1 \\\n\tVX b3, b1, b1 \\\n\tVX c3, c1, c1 \\\n\tVX d3, d1, d1 \\\n\tVERLLF $12, a1, a1 \\\n\tVERLLF $12, b1, b1 \\\n\tVERLLF $12, c1, c1 \\\n\tVERLLF $12, d1, d1 \\\n\tVAF a1, a0, a0 \\\n\tVAF b1, b0, b0 \\\n\tVAF c1, c0, c0 \\\n\tVAF d1, d0, d0 \\\n\tVX a0, a2, a2 \\\n\tVX b0, b2, b2 \\\n\tVX c0, c2, c2 \\\n\tVX d0, d2, d2 \\\n\tVERLLF $8, a2, a2 \\\n\tVERLLF $8, b2, b2 \\\n\tVERLLF $8, c2, c2 \\\n\tVERLLF $8, d2, d2 \\\n\tVAF a2, a3, a3 \\\n\tVAF b2, b3, b3 \\\n\tVAF c2, c3, c3 \\\n\tVAF d2, d3, d3 \\\n\tVX a3, a1, a1 \\\n\tVX b3, b1, b1 \\\n\tVX c3, c1, c1 \\\n\tVX d3, d1, d1 \\\n\tVERLLF $7, a1, a1 \\\n\tVERLLF $7, b1, b1 \\\n\tVERLLF $7, c1, c1 \\\n\tVERLLF $7, d1, d1\n\n#define PERMUTE(mask, v0, v1, v2, v3) \\\n\tVPERM v0, v0, mask, v0 \\\n\tVPERM v1, v1, mask, v1 \\\n\tVPERM v2, v2, mask, v2 \\\n\tVPERM v3, v3, mask, v3\n\n#define ADDV(x, v0, v1, v2, v3) \\\n\tVAF x, v0, v0 \\\n\tVAF x, v1, v1 \\\n\tVAF x, v2, v2 \\\n\tVAF x, v3, v3\n\n#define XORV(off, dst, src, v0, v1, v2, v3) \\\n\tVLM off(src), M0, M3 \\\n\tPERMUTE(BSWAP, v0, v1, v2, v3) \\\n\tVX v0, M0, M0 \\\n\tVX v1, M1, M1 \\\n\tVX v2, M2, M2 \\\n\tVX v3, M3, M3 \\\n\tVSTM M0, M3, off(dst)\n\n#define SHUFFLE(a, b, c, d, t, u, v, w) \\\n\tVMRHF a, c, t \\ // t = {a[0], c[0], a[1], c[1]}\n\tVMRHF b, d, u \\ // u = {b[0], d[0], b[1], d[1]}\n\tVMRLF a, c, v \\ // v = {a[2], c[2], a[3], c[3]}\n\tVMRLF b, d, w \\ // w = {b[2], d[2], b[3], d[3]}\n\tVMRHF t, u, a \\ // a = {a[0], b[0], c[0], d[0]}\n\tVMRLF t, u, b \\ // b = {a[1], b[1], c[1], d[1]}\n\tVMRHF v, w, c \\ // c = {a[2], b[2], c[2], d[2]}\n\tVMRLF v, w, d // d = {a[3], b[3], c[3], d[3]}\n\n// func xorKeyStreamVX(dst, src []byte, key *[8]uint32, nonce *[3]uint32, counter *uint32)\nTEXT ·xorKeyStreamVX(SB), NOSPLIT, $0\n\tMOVD $·constants<>(SB), R1\n\tMOVD dst+0(FP), R2 // R2=&dst[0]\n\tLMG src+24(FP), R3, R4 // R3=&src[0] R4=len(src)\n\tMOVD key+48(FP), R5 // R5=key\n\tMOVD nonce+56(FP), R6 // R6=nonce\n\tMOVD counter+64(FP), R7 // R7=counter\n\n\t// load BSWAP and J0\n\tVLM (R1), BSWAP, J0\n\n\t// setup\n\tMOVD $95, R0\n\tVLM (R5), KEY0, KEY1\n\tVLL R0, (R6), NONCE\n\tVZERO M0\n\tVLEIB $7, $32, M0\n\tVSRLB M0, NONCE, NONCE\n\n\t// initialize counter values\n\tVLREPF (R7), CTR\n\tVZERO INC\n\tVLEIF $1, $1, INC\n\tVLEIF $2, $2, INC\n\tVLEIF $3, $3, INC\n\tVAF INC, CTR, CTR\n\tVREPIF $4, INC\n\nchacha:\n\tVREPF $0, J0, X0\n\tVREPF $1, J0, X1\n\tVREPF $2, J0, X2\n\tVREPF $3, J0, X3\n\tVREPF $0, KEY0, X4\n\tVREPF $1, KEY0, X5\n\tVREPF $2, KEY0, X6\n\tVREPF $3, KEY0, X7\n\tVREPF $0, KEY1, X8\n\tVREPF $1, KEY1, X9\n\tVREPF $2, KEY1, X10\n\tVREPF $3, KEY1, X11\n\tVLR CTR, X12\n\tVREPF $1, NONCE, X13\n\tVREPF $2, NONCE, X14\n\tVREPF $3, NONCE, X15\n\n\tMOVD $(NUM_ROUNDS/2), R1\n\nloop:\n\tROUND4(X0, X4, X12, X8, X1, X5, X13, X9, X2, X6, X14, X10, X3, X7, X15, X11)\n\tROUND4(X0, X5, X15, X10, X1, X6, X12, X11, X2, X7, X13, X8, X3, X4, X14, X9)\n\n\tADD $-1, R1\n\tBNE loop\n\n\t// decrement length\n\tADD $-256, R4\n\n\t// rearrange vectors\n\tSHUFFLE(X0, X1, X2, X3, M0, M1, M2, M3)\n\tADDV(J0, X0, X1, X2, X3)\n\tSHUFFLE(X4, X5, X6, X7, M0, M1, M2, M3)\n\tADDV(KEY0, X4, X5, X6, X7)\n\tSHUFFLE(X8, X9, X10, X11, M0, M1, M2, M3)\n\tADDV(KEY1, X8, X9, X10, X11)\n\tVAF CTR, X12, X12\n\tSHUFFLE(X12, X13, X14, X15, M0, M1, M2, M3)\n\tADDV(NONCE, X12, X13, X14, X15)\n\n\t// increment counters\n\tVAF INC, CTR, CTR\n\n\t// xor keystream with plaintext\n\tXORV(0*64, R2, R3, X0, X4, X8, X12)\n\tXORV(1*64, R2, R3, X1, X5, X9, X13)\n\tXORV(2*64, R2, R3, X2, X6, X10, X14)\n\tXORV(3*64, R2, R3, X3, X7, X11, X15)\n\n\t// increment pointers\n\tMOVD $256(R2), R2\n\tMOVD $256(R3), R3\n\n\tCMPBNE R4, $0, chacha\n\n\tVSTEF $0, CTR, (R7)\n\tRET\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/chacha20/xor.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found src the LICENSE file.\n\npackage chacha20\n\nimport \"runtime\"\n\n// Platforms that have fast unaligned 32-bit little endian accesses.\nconst unaligned = runtime.GOARCH == \"386\" ||\n\truntime.GOARCH == \"amd64\" ||\n\truntime.GOARCH == \"arm64\" ||\n\truntime.GOARCH == \"ppc64le\" ||\n\truntime.GOARCH == \"s390x\"\n\n// addXor reads a little endian uint32 from src, XORs it with (a + b) and\n// places the result in little endian byte order in dst.\nfunc addXor(dst, src []byte, a, b uint32) {\n\t_, _ = src[3], dst[3] // bounds check elimination hint\n\tif unaligned {\n\t\t// The compiler should optimize this code into\n\t\t// 32-bit unaligned little endian loads and stores.\n\t\t// TODO: delete once the compiler does a reliably\n\t\t// good job with the generic code below.\n\t\t// See issue #25111 for more details.\n\t\tv := uint32(src[0])\n\t\tv |= uint32(src[1]) << 8\n\t\tv |= uint32(src[2]) << 16\n\t\tv |= uint32(src[3]) << 24\n\t\tv ^= a + b\n\t\tdst[0] = byte(v)\n\t\tdst[1] = byte(v >> 8)\n\t\tdst[2] = byte(v >> 16)\n\t\tdst[3] = byte(v >> 24)\n\t} else {\n\t\ta += b\n\t\tdst[0] = src[0] ^ byte(a)\n\t\tdst[1] = src[1] ^ byte(a>>8)\n\t\tdst[2] = src[2] ^ byte(a>>16)\n\t\tdst[3] = src[3] ^ byte(a>>24)\n\t}\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/curve25519/curve25519.go",
"content": "// Copyright 2019 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package curve25519 provides an implementation of the X25519 function, which\n// performs scalar multiplication on the elliptic curve known as Curve25519\n// according to [RFC 7748].\n//\n// The curve25519 package is a wrapper for the X25519 implementation in the\n// crypto/ecdh package. It is [frozen] and is not accepting new features.\n//\n// [RFC 7748]: https://datatracker.ietf.org/doc/html/rfc7748\n// [frozen]: https://go.dev/wiki/Frozen\npackage curve25519\n\nimport \"crypto/ecdh\"\n\n// ScalarMult sets dst to the product scalar * point.\n//\n// Deprecated: when provided a low-order point, ScalarMult will set dst to all\n// zeroes, irrespective of the scalar. Instead, use the X25519 function, which\n// will return an error.\nfunc ScalarMult(dst, scalar, point *[32]byte) {\n\tif _, err := x25519(dst, scalar[:], point[:]); err != nil {\n\t\t// The only error condition for x25519 when the inputs are 32 bytes long\n\t\t// is if the output would have been the all-zero value.\n\t\tfor i := range dst {\n\t\t\tdst[i] = 0\n\t\t}\n\t}\n}\n\n// ScalarBaseMult sets dst to the product scalar * base where base is the\n// standard generator.\n//\n// It is recommended to use the X25519 function with Basepoint instead, as\n// copying into fixed size arrays can lead to unexpected bugs.\nfunc ScalarBaseMult(dst, scalar *[32]byte) {\n\tcurve := ecdh.X25519()\n\tpriv, err := curve.NewPrivateKey(scalar[:])\n\tif err != nil {\n\t\tpanic(\"curve25519: \" + err.Error())\n\t}\n\tcopy(dst[:], priv.PublicKey().Bytes())\n}\n\nconst (\n\t// ScalarSize is the size of the scalar input to X25519.\n\tScalarSize = 32\n\t// PointSize is the size of the point input to X25519.\n\tPointSize = 32\n)\n\n// Basepoint is the canonical Curve25519 generator.\nvar Basepoint []byte\n\nvar basePoint = [32]byte{9}\n\nfunc init() { Basepoint = basePoint[:] }\n\n// X25519 returns the result of the scalar multiplication (scalar * point),\n// according to RFC 7748, Section 5. scalar, point and the return value are\n// slices of 32 bytes.\n//\n// scalar can be generated at random, for example with crypto/rand. point should\n// be either Basepoint or the output of another X25519 call.\n//\n// If point is Basepoint (but not if it's a different slice with the same\n// contents) a precomputed implementation might be used for performance.\nfunc X25519(scalar, point []byte) ([]byte, error) {\n\t// Outline the body of function, to let the allocation be inlined in the\n\t// caller, and possibly avoid escaping to the heap.\n\tvar dst [32]byte\n\treturn x25519(&dst, scalar, point)\n}\n\nfunc x25519(dst *[32]byte, scalar, point []byte) ([]byte, error) {\n\tcurve := ecdh.X25519()\n\tpub, err := curve.NewPublicKey(point)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tpriv, err := curve.NewPrivateKey(scalar)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tout, err := priv.ECDH(pub)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tcopy(dst[:], out)\n\treturn dst[:], nil\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/alias/alias.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build !purego\n\n// Package alias implements memory aliasing tests.\npackage alias\n\nimport \"unsafe\"\n\n// AnyOverlap reports whether x and y share memory at any (not necessarily\n// corresponding) index. The memory beyond the slice length is ignored.\nfunc AnyOverlap(x, y []byte) bool {\n\treturn len(x) > 0 && len(y) > 0 &&\n\t\tuintptr(unsafe.Pointer(&x[0])) <= uintptr(unsafe.Pointer(&y[len(y)-1])) &&\n\t\tuintptr(unsafe.Pointer(&y[0])) <= uintptr(unsafe.Pointer(&x[len(x)-1]))\n}\n\n// InexactOverlap reports whether x and y share memory at any non-corresponding\n// index. The memory beyond the slice length is ignored. Note that x and y can\n// have different lengths and still not have any inexact overlap.\n//\n// InexactOverlap can be used to implement the requirements of the crypto/cipher\n// AEAD, Block, BlockMode and Stream interfaces.\nfunc InexactOverlap(x, y []byte) bool {\n\tif len(x) == 0 || len(y) == 0 || &x[0] == &y[0] {\n\t\treturn false\n\t}\n\treturn AnyOverlap(x, y)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/alias/alias_purego.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build purego\n\n// Package alias implements memory aliasing tests.\npackage alias\n\n// This is the Google App Engine standard variant based on reflect\n// because the unsafe package and cgo are disallowed.\n\nimport \"reflect\"\n\n// AnyOverlap reports whether x and y share memory at any (not necessarily\n// corresponding) index. The memory beyond the slice length is ignored.\nfunc AnyOverlap(x, y []byte) bool {\n\treturn len(x) > 0 && len(y) > 0 &&\n\t\treflect.ValueOf(&x[0]).Pointer() <= reflect.ValueOf(&y[len(y)-1]).Pointer() &&\n\t\treflect.ValueOf(&y[0]).Pointer() <= reflect.ValueOf(&x[len(x)-1]).Pointer()\n}\n\n// InexactOverlap reports whether x and y share memory at any non-corresponding\n// index. The memory beyond the slice length is ignored. Note that x and y can\n// have different lengths and still not have any inexact overlap.\n//\n// InexactOverlap can be used to implement the requirements of the crypto/cipher\n// AEAD, Block, BlockMode and Stream interfaces.\nfunc InexactOverlap(x, y []byte) bool {\n\tif len(x) == 0 || len(y) == 0 || &x[0] == &y[0] {\n\t\treturn false\n\t}\n\treturn AnyOverlap(x, y)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/mac_noasm.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build (!amd64 && !loong64 && !ppc64le && !ppc64 && !s390x) || !gc || purego\n\npackage poly1305\n\ntype mac struct{ macGeneric }\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/poly1305.go",
"content": "// Copyright 2012 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package poly1305 implements Poly1305 one-time message authentication code as\n// specified in https://cr.yp.to/mac/poly1305-20050329.pdf.\n//\n// Poly1305 is a fast, one-time authentication function. It is infeasible for an\n// attacker to generate an authenticator for a message without the key. However, a\n// key must only be used for a single message. Authenticating two different\n// messages with the same key allows an attacker to forge authenticators for other\n// messages with the same key.\n//\n// Poly1305 was originally coupled with AES in order to make Poly1305-AES. AES was\n// used with a fixed key in order to generate one-time keys from an nonce.\n// However, in this package AES isn't used and the one-time key is specified\n// directly.\npackage poly1305\n\nimport \"crypto/subtle\"\n\n// TagSize is the size, in bytes, of a poly1305 authenticator.\nconst TagSize = 16\n\n// Sum generates an authenticator for msg using a one-time key and puts the\n// 16-byte result into out. Authenticating two different messages with the same\n// key allows an attacker to forge messages at will.\nfunc Sum(out *[16]byte, m []byte, key *[32]byte) {\n\th := New(key)\n\th.Write(m)\n\th.Sum(out[:0])\n}\n\n// Verify returns true if mac is a valid authenticator for m with the given key.\nfunc Verify(mac *[16]byte, m []byte, key *[32]byte) bool {\n\tvar tmp [16]byte\n\tSum(&tmp, m, key)\n\treturn subtle.ConstantTimeCompare(tmp[:], mac[:]) == 1\n}\n\n// New returns a new MAC computing an authentication\n// tag of all data written to it with the given key.\n// This allows writing the message progressively instead\n// of passing it as a single slice. Common users should use\n// the Sum function instead.\n//\n// The key must be unique for each message, as authenticating\n// two different messages with the same key allows an attacker\n// to forge messages at will.\nfunc New(key *[32]byte) *MAC {\n\tm := &MAC{}\n\tinitialize(key, &m.macState)\n\treturn m\n}\n\n// MAC is an io.Writer computing an authentication tag\n// of the data written to it.\n//\n// MAC cannot be used like common hash.Hash implementations,\n// because using a poly1305 key twice breaks its security.\n// Therefore writing data to a running MAC after calling\n// Sum or Verify causes it to panic.\ntype MAC struct {\n\tmac // platform-dependent implementation\n\n\tfinalized bool\n}\n\n// Size returns the number of bytes Sum will return.\nfunc (h *MAC) Size() int { return TagSize }\n\n// Write adds more data to the running message authentication code.\n// It never returns an error.\n//\n// It must not be called after the first call of Sum or Verify.\nfunc (h *MAC) Write(p []byte) (n int, err error) {\n\tif h.finalized {\n\t\tpanic(\"poly1305: write to MAC after Sum or Verify\")\n\t}\n\treturn h.mac.Write(p)\n}\n\n// Sum computes the authenticator of all data written to the\n// message authentication code.\nfunc (h *MAC) Sum(b []byte) []byte {\n\tvar mac [TagSize]byte\n\th.mac.Sum(&mac)\n\th.finalized = true\n\treturn append(b, mac[:]...)\n}\n\n// Verify returns whether the authenticator of all data written to\n// the message authentication code matches the expected value.\nfunc (h *MAC) Verify(expected []byte) bool {\n\tvar mac [TagSize]byte\n\th.mac.Sum(&mac)\n\th.finalized = true\n\treturn subtle.ConstantTimeCompare(expected, mac[:]) == 1\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/sum_amd64.s",
"content": "// Code generated by command: go run sum_amd64_asm.go -out ../sum_amd64.s -pkg poly1305. DO NOT EDIT.\n\n//go:build gc && !purego\n\n// func update(state *macState, msg []byte)\nTEXT ·update(SB), $0-32\n\tMOVQ state+0(FP), DI\n\tMOVQ msg_base+8(FP), SI\n\tMOVQ msg_len+16(FP), R15\n\tMOVQ (DI), R8\n\tMOVQ 8(DI), R9\n\tMOVQ 16(DI), R10\n\tMOVQ 24(DI), R11\n\tMOVQ 32(DI), R12\n\tCMPQ R15, $0x10\n\tJB bytes_between_0_and_15\n\nloop:\n\tADDQ (SI), R8\n\tADCQ 8(SI), R9\n\tADCQ $0x01, R10\n\tLEAQ 16(SI), SI\n\nmultiply:\n\tMOVQ R11, AX\n\tMULQ R8\n\tMOVQ AX, BX\n\tMOVQ DX, CX\n\tMOVQ R11, AX\n\tMULQ R9\n\tADDQ AX, CX\n\tADCQ $0x00, DX\n\tMOVQ R11, R13\n\tIMULQ R10, R13\n\tADDQ DX, R13\n\tMOVQ R12, AX\n\tMULQ R8\n\tADDQ AX, CX\n\tADCQ $0x00, DX\n\tMOVQ DX, R8\n\tMOVQ R12, R14\n\tIMULQ R10, R14\n\tMOVQ R12, AX\n\tMULQ R9\n\tADDQ AX, R13\n\tADCQ DX, R14\n\tADDQ R8, R13\n\tADCQ $0x00, R14\n\tMOVQ BX, R8\n\tMOVQ CX, R9\n\tMOVQ R13, R10\n\tANDQ $0x03, R10\n\tMOVQ R13, BX\n\tANDQ $-4, BX\n\tADDQ BX, R8\n\tADCQ R14, R9\n\tADCQ $0x00, R10\n\tSHRQ $0x02, R14, R13\n\tSHRQ $0x02, R14\n\tADDQ R13, R8\n\tADCQ R14, R9\n\tADCQ $0x00, R10\n\tSUBQ $0x10, R15\n\tCMPQ R15, $0x10\n\tJAE loop\n\nbytes_between_0_and_15:\n\tTESTQ R15, R15\n\tJZ done\n\tMOVQ $0x00000001, BX\n\tXORQ CX, CX\n\tXORQ R13, R13\n\tADDQ R15, SI\n\nflush_buffer:\n\tSHLQ $0x08, BX, CX\n\tSHLQ $0x08, BX\n\tMOVB -1(SI), R13\n\tXORQ R13, BX\n\tDECQ SI\n\tDECQ R15\n\tJNZ flush_buffer\n\tADDQ BX, R8\n\tADCQ CX, R9\n\tADCQ $0x00, R10\n\tMOVQ $0x00000010, R15\n\tJMP multiply\n\ndone:\n\tMOVQ R8, (DI)\n\tMOVQ R9, 8(DI)\n\tMOVQ R10, 16(DI)\n\tRET\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/sum_asm.go",
"content": "// Copyright 2012 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego && (amd64 || loong64 || ppc64 || ppc64le)\n\npackage poly1305\n\n//go:noescape\nfunc update(state *macState, msg []byte)\n\n// mac is a wrapper for macGeneric that redirects calls that would have gone to\n// updateGeneric to update.\n//\n// Its Write and Sum methods are otherwise identical to the macGeneric ones, but\n// using function pointers would carry a major performance cost.\ntype mac struct{ macGeneric }\n\nfunc (h *mac) Write(p []byte) (int, error) {\n\tnn := len(p)\n\tif h.offset > 0 {\n\t\tn := copy(h.buffer[h.offset:], p)\n\t\tif h.offset+n < TagSize {\n\t\t\th.offset += n\n\t\t\treturn nn, nil\n\t\t}\n\t\tp = p[n:]\n\t\th.offset = 0\n\t\tupdate(&h.macState, h.buffer[:])\n\t}\n\tif n := len(p) - (len(p) % TagSize); n > 0 {\n\t\tupdate(&h.macState, p[:n])\n\t\tp = p[n:]\n\t}\n\tif len(p) > 0 {\n\t\th.offset += copy(h.buffer[h.offset:], p)\n\t}\n\treturn nn, nil\n}\n\nfunc (h *mac) Sum(out *[16]byte) {\n\tstate := h.macState\n\tif h.offset > 0 {\n\t\tupdate(&state, h.buffer[:h.offset])\n\t}\n\tfinalize(out, &state.h, &state.s)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/sum_generic.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// This file provides the generic implementation of Sum and MAC. Other files\n// might provide optimized assembly implementations of some of this code.\n\npackage poly1305\n\nimport (\n\t\"encoding/binary\"\n\t\"math/bits\"\n)\n\n// Poly1305 [RFC 7539] is a relatively simple algorithm: the authentication tag\n// for a 64 bytes message is approximately\n//\n// s + m[0:16] * r⁴ + m[16:32] * r³ + m[32:48] * r² + m[48:64] * r mod 2¹³⁰ - 5\n//\n// for some secret r and s. It can be computed sequentially like\n//\n// for len(msg) > 0:\n// h += read(msg, 16)\n// h *= r\n// h %= 2¹³⁰ - 5\n// return h + s\n//\n// All the complexity is about doing performant constant-time math on numbers\n// larger than any available numeric type.\n\nfunc sumGeneric(out *[TagSize]byte, msg []byte, key *[32]byte) {\n\th := newMACGeneric(key)\n\th.Write(msg)\n\th.Sum(out)\n}\n\nfunc newMACGeneric(key *[32]byte) macGeneric {\n\tm := macGeneric{}\n\tinitialize(key, &m.macState)\n\treturn m\n}\n\n// macState holds numbers in saturated 64-bit little-endian limbs. That is,\n// the value of [x0, x1, x2] is x[0] + x[1] * 2⁶⁴ + x[2] * 2¹²⁸.\ntype macState struct {\n\t// h is the main accumulator. It is to be interpreted modulo 2¹³⁰ - 5, but\n\t// can grow larger during and after rounds. It must, however, remain below\n\t// 2 * (2¹³⁰ - 5).\n\th [3]uint64\n\t// r and s are the private key components.\n\tr [2]uint64\n\ts [2]uint64\n}\n\ntype macGeneric struct {\n\tmacState\n\n\tbuffer [TagSize]byte\n\toffset int\n}\n\n// Write splits the incoming message into TagSize chunks, and passes them to\n// update. It buffers incomplete chunks.\nfunc (h *macGeneric) Write(p []byte) (int, error) {\n\tnn := len(p)\n\tif h.offset > 0 {\n\t\tn := copy(h.buffer[h.offset:], p)\n\t\tif h.offset+n < TagSize {\n\t\t\th.offset += n\n\t\t\treturn nn, nil\n\t\t}\n\t\tp = p[n:]\n\t\th.offset = 0\n\t\tupdateGeneric(&h.macState, h.buffer[:])\n\t}\n\tif n := len(p) - (len(p) % TagSize); n > 0 {\n\t\tupdateGeneric(&h.macState, p[:n])\n\t\tp = p[n:]\n\t}\n\tif len(p) > 0 {\n\t\th.offset += copy(h.buffer[h.offset:], p)\n\t}\n\treturn nn, nil\n}\n\n// Sum flushes the last incomplete chunk from the buffer, if any, and generates\n// the MAC output. It does not modify its state, in order to allow for multiple\n// calls to Sum, even if no Write is allowed after Sum.\nfunc (h *macGeneric) Sum(out *[TagSize]byte) {\n\tstate := h.macState\n\tif h.offset > 0 {\n\t\tupdateGeneric(&state, h.buffer[:h.offset])\n\t}\n\tfinalize(out, &state.h, &state.s)\n}\n\n// [rMask0, rMask1] is the specified Poly1305 clamping mask in little-endian. It\n// clears some bits of the secret coefficient to make it possible to implement\n// multiplication more efficiently.\nconst (\n\trMask0 = 0x0FFFFFFC0FFFFFFF\n\trMask1 = 0x0FFFFFFC0FFFFFFC\n)\n\n// initialize loads the 256-bit key into the two 128-bit secret values r and s.\nfunc initialize(key *[32]byte, m *macState) {\n\tm.r[0] = binary.LittleEndian.Uint64(key[0:8]) & rMask0\n\tm.r[1] = binary.LittleEndian.Uint64(key[8:16]) & rMask1\n\tm.s[0] = binary.LittleEndian.Uint64(key[16:24])\n\tm.s[1] = binary.LittleEndian.Uint64(key[24:32])\n}\n\n// uint128 holds a 128-bit number as two 64-bit limbs, for use with the\n// bits.Mul64 and bits.Add64 intrinsics.\ntype uint128 struct {\n\tlo, hi uint64\n}\n\nfunc mul64(a, b uint64) uint128 {\n\thi, lo := bits.Mul64(a, b)\n\treturn uint128{lo, hi}\n}\n\nfunc add128(a, b uint128) uint128 {\n\tlo, c := bits.Add64(a.lo, b.lo, 0)\n\thi, c := bits.Add64(a.hi, b.hi, c)\n\tif c != 0 {\n\t\tpanic(\"poly1305: unexpected overflow\")\n\t}\n\treturn uint128{lo, hi}\n}\n\nfunc shiftRightBy2(a uint128) uint128 {\n\ta.lo = a.lo>>2 | (a.hi&3)<<62\n\ta.hi = a.hi >> 2\n\treturn a\n}\n\n// updateGeneric absorbs msg into the state.h accumulator. For each chunk m of\n// 128 bits of message, it computes\n//\n//\th₊ = (h + m) * r mod 2¹³⁰ - 5\n//\n// If the msg length is not a multiple of TagSize, it assumes the last\n// incomplete chunk is the final one.\nfunc updateGeneric(state *macState, msg []byte) {\n\th0, h1, h2 := state.h[0], state.h[1], state.h[2]\n\tr0, r1 := state.r[0], state.r[1]\n\n\tfor len(msg) > 0 {\n\t\tvar c uint64\n\n\t\t// For the first step, h + m, we use a chain of bits.Add64 intrinsics.\n\t\t// The resulting value of h might exceed 2¹³⁰ - 5, but will be partially\n\t\t// reduced at the end of the multiplication below.\n\t\t//\n\t\t// The spec requires us to set a bit just above the message size, not to\n\t\t// hide leading zeroes. For full chunks, that's 1 << 128, so we can just\n\t\t// add 1 to the most significant (2¹²⁸) limb, h2.\n\t\tif len(msg) >= TagSize {\n\t\t\th0, c = bits.Add64(h0, binary.LittleEndian.Uint64(msg[0:8]), 0)\n\t\t\th1, c = bits.Add64(h1, binary.LittleEndian.Uint64(msg[8:16]), c)\n\t\t\th2 += c + 1\n\n\t\t\tmsg = msg[TagSize:]\n\t\t} else {\n\t\t\tvar buf [TagSize]byte\n\t\t\tcopy(buf[:], msg)\n\t\t\tbuf[len(msg)] = 1\n\n\t\t\th0, c = bits.Add64(h0, binary.LittleEndian.Uint64(buf[0:8]), 0)\n\t\t\th1, c = bits.Add64(h1, binary.LittleEndian.Uint64(buf[8:16]), c)\n\t\t\th2 += c\n\n\t\t\tmsg = nil\n\t\t}\n\n\t\t// Multiplication of big number limbs is similar to elementary school\n\t\t// columnar multiplication. Instead of digits, there are 64-bit limbs.\n\t\t//\n\t\t// We are multiplying a 3 limbs number, h, by a 2 limbs number, r.\n\t\t//\n\t\t// h2 h1 h0 x\n\t\t// r1 r0 =\n\t\t// ----------------\n\t\t// h2r0 h1r0 h0r0 <-- individual 128-bit products\n\t\t// + h2r1 h1r1 h0r1\n\t\t// ------------------------\n\t\t// m3 m2 m1 m0 <-- result in 128-bit overlapping limbs\n\t\t// ------------------------\n\t\t// m3.hi m2.hi m1.hi m0.hi <-- carry propagation\n\t\t// + m3.lo m2.lo m1.lo m0.lo\n\t\t// -------------------------------\n\t\t// t4 t3 t2 t1 t0 <-- final result in 64-bit limbs\n\t\t//\n\t\t// The main difference from pen-and-paper multiplication is that we do\n\t\t// carry propagation in a separate step, as if we wrote two digit sums\n\t\t// at first (the 128-bit limbs), and then carried the tens all at once.\n\n\t\th0r0 := mul64(h0, r0)\n\t\th1r0 := mul64(h1, r0)\n\t\th2r0 := mul64(h2, r0)\n\t\th0r1 := mul64(h0, r1)\n\t\th1r1 := mul64(h1, r1)\n\t\th2r1 := mul64(h2, r1)\n\n\t\t// Since h2 is known to be at most 7 (5 + 1 + 1), and r0 and r1 have their\n\t\t// top 4 bits cleared by rMask{0,1}, we know that their product is not going\n\t\t// to overflow 64 bits, so we can ignore the high part of the products.\n\t\t//\n\t\t// This also means that the product doesn't have a fifth limb (t4).\n\t\tif h2r0.hi != 0 {\n\t\t\tpanic(\"poly1305: unexpected overflow\")\n\t\t}\n\t\tif h2r1.hi != 0 {\n\t\t\tpanic(\"poly1305: unexpected overflow\")\n\t\t}\n\n\t\tm0 := h0r0\n\t\tm1 := add128(h1r0, h0r1) // These two additions don't overflow thanks again\n\t\tm2 := add128(h2r0, h1r1) // to the 4 masked bits at the top of r0 and r1.\n\t\tm3 := h2r1\n\n\t\tt0 := m0.lo\n\t\tt1, c := bits.Add64(m1.lo, m0.hi, 0)\n\t\tt2, c := bits.Add64(m2.lo, m1.hi, c)\n\t\tt3, _ := bits.Add64(m3.lo, m2.hi, c)\n\n\t\t// Now we have the result as 4 64-bit limbs, and we need to reduce it\n\t\t// modulo 2¹³⁰ - 5. The special shape of this Crandall prime lets us do\n\t\t// a cheap partial reduction according to the reduction identity\n\t\t//\n\t\t// c * 2¹³⁰ + n = c * 5 + n mod 2¹³⁰ - 5\n\t\t//\n\t\t// because 2¹³⁰ = 5 mod 2¹³⁰ - 5. Partial reduction since the result is\n\t\t// likely to be larger than 2¹³⁰ - 5, but still small enough to fit the\n\t\t// assumptions we make about h in the rest of the code.\n\t\t//\n\t\t// See also https://speakerdeck.com/gtank/engineering-prime-numbers?slide=23\n\n\t\t// We split the final result at the 2¹³⁰ mark into h and cc, the carry.\n\t\t// Note that the carry bits are effectively shifted left by 2, in other\n\t\t// words, cc = c * 4 for the c in the reduction identity.\n\t\th0, h1, h2 = t0, t1, t2&maskLow2Bits\n\t\tcc := uint128{t2 & maskNotLow2Bits, t3}\n\n\t\t// To add c * 5 to h, we first add cc = c * 4, and then add (cc >> 2) = c.\n\n\t\th0, c = bits.Add64(h0, cc.lo, 0)\n\t\th1, c = bits.Add64(h1, cc.hi, c)\n\t\th2 += c\n\n\t\tcc = shiftRightBy2(cc)\n\n\t\th0, c = bits.Add64(h0, cc.lo, 0)\n\t\th1, c = bits.Add64(h1, cc.hi, c)\n\t\th2 += c\n\n\t\t// h2 is at most 3 + 1 + 1 = 5, making the whole of h at most\n\t\t//\n\t\t// 5 * 2¹²⁸ + (2¹²⁸ - 1) = 6 * 2¹²⁸ - 1\n\t}\n\n\tstate.h[0], state.h[1], state.h[2] = h0, h1, h2\n}\n\nconst (\n\tmaskLow2Bits uint64 = 0x0000000000000003\n\tmaskNotLow2Bits uint64 = ^maskLow2Bits\n)\n\n// select64 returns x if v == 1 and y if v == 0, in constant time.\nfunc select64(v, x, y uint64) uint64 { return ^(v-1)&x | (v-1)&y }\n\n// [p0, p1, p2] is 2¹³⁰ - 5 in little endian order.\nconst (\n\tp0 = 0xFFFFFFFFFFFFFFFB\n\tp1 = 0xFFFFFFFFFFFFFFFF\n\tp2 = 0x0000000000000003\n)\n\n// finalize completes the modular reduction of h and computes\n//\n//\tout = h + s mod 2¹²⁸\nfunc finalize(out *[TagSize]byte, h *[3]uint64, s *[2]uint64) {\n\th0, h1, h2 := h[0], h[1], h[2]\n\n\t// After the partial reduction in updateGeneric, h might be more than\n\t// 2¹³⁰ - 5, but will be less than 2 * (2¹³⁰ - 5). To complete the reduction\n\t// in constant time, we compute t = h - (2¹³⁰ - 5), and select h as the\n\t// result if the subtraction underflows, and t otherwise.\n\n\thMinusP0, b := bits.Sub64(h0, p0, 0)\n\thMinusP1, b := bits.Sub64(h1, p1, b)\n\t_, b = bits.Sub64(h2, p2, b)\n\n\t// h = h if h < p else h - p\n\th0 = select64(b, h0, hMinusP0)\n\th1 = select64(b, h1, hMinusP1)\n\n\t// Finally, we compute the last Poly1305 step\n\t//\n\t// tag = h + s mod 2¹²⁸\n\t//\n\t// by just doing a wide addition with the 128 low bits of h and discarding\n\t// the overflow.\n\th0, c := bits.Add64(h0, s[0], 0)\n\th1, _ = bits.Add64(h1, s[1], c)\n\n\tbinary.LittleEndian.PutUint64(out[0:8], h0)\n\tbinary.LittleEndian.PutUint64(out[8:16], h1)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/sum_loong64.s",
"content": "// Copyright 2025 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego\n\n// func update(state *macState, msg []byte)\nTEXT ·update(SB), $0-32\n\tMOVV\tstate+0(FP), R4\n\tMOVV\tmsg_base+8(FP), R5\n\tMOVV\tmsg_len+16(FP), R6\n\n\tMOVV\t$0x10, R7\n\n\tMOVV\t(R4), R8\t// h0\n\tMOVV\t8(R4), R9\t// h1\n\tMOVV\t16(R4), R10\t// h2\n\tMOVV\t24(R4), R11\t// r0\n\tMOVV\t32(R4), R12\t// r1\n\n\tBLT\tR6, R7, bytes_between_0_and_15\n\nloop:\n\tMOVV\t(R5), R14\t// msg[0:8]\n\tMOVV\t8(R5), R16\t// msg[8:16]\n\tADDV\tR14, R8, R8\t// h0 (x1 + y1 = z1', if z1' < x1 then z1' overflow)\n\tADDV\tR16, R9, R27\n\tSGTU\tR14, R8, R24\t// h0.carry\n\tSGTU\tR9, R27, R28\n\tADDV\tR27, R24, R9\t// h1\n\tSGTU\tR27, R9, R24\n\tOR\tR24, R28, R24\t// h1.carry\n\tADDV\t$0x01, R24, R24\n\tADDV\tR10, R24, R10\t// h2\n\n\tADDV\t$16, R5, R5\t// msg = msg[16:]\n\nmultiply:\n\tMULV\tR8, R11, R14\t// h0r0.lo\n\tMULHVU\tR8, R11, R15\t// h0r0.hi\n\tMULV\tR9, R11, R13\t// h1r0.lo\n\tMULHVU\tR9, R11, R16\t// h1r0.hi\n\tADDV\tR13, R15, R15\n\tSGTU\tR13, R15, R24\n\tADDV\tR24, R16, R16\n\tMULV\tR10, R11, R25\n\tADDV\tR16, R25, R25\n\tMULV\tR8, R12, R13\t// h0r1.lo\n\tMULHVU\tR8, R12, R16\t// h0r1.hi\n\tADDV\tR13, R15, R15\n\tSGTU\tR13, R15, R24\n\tADDV\tR24, R16, R16\n\tMOVV\tR16, R8\n\tMULV\tR10, R12, R26\t// h2r1\n\tMULV\tR9, R12, R13\t// h1r1.lo\n\tMULHVU\tR9, R12, R16\t// h1r1.hi\n\tADDV\tR13, R25, R25\n\tADDV\tR16, R26, R27\n\tSGTU\tR13, R25, R24\n\tADDV\tR27, R24, R26\n\tADDV\tR8, R25, R25\n\tSGTU\tR8, R25, R24\n\tADDV\tR24, R26, R26\n\tAND\t$3, R25, R10\n\tAND\t$-4, R25, R17\n\tADDV\tR17, R14, R8\n\tADDV\tR26, R15, R27\n\tSGTU\tR17, R8, R24\n\tSGTU\tR26, R27, R28\n\tADDV\tR27, R24, R9\n\tSGTU\tR27, R9, R24\n\tOR\tR24, R28, R24\n\tADDV\tR24, R10, R10\n\tSLLV\t$62, R26, R27\n\tSRLV\t$2, R25, R28\n\tSRLV\t$2, R26, R26\n\tOR\tR27, R28, R25\n\tADDV\tR25, R8, R8\n\tADDV\tR26, R9, R27\n\tSGTU\tR25, R8, R24\n\tSGTU\tR26, R27, R28\n\tADDV\tR27, R24, R9\n\tSGTU\tR27, R9, R24\n\tOR\tR24, R28, R24\n\tADDV\tR24, R10, R10\n\n\tSUBV\t$16, R6, R6\n\tBGE\tR6, R7, loop\n\nbytes_between_0_and_15:\n\tBEQ\tR6, R0, done\n\tMOVV\t$1, R14\n\tXOR\tR15, R15\n\tADDV\tR6, R5, R5\n\nflush_buffer:\n\tMOVBU\t-1(R5), R25\n\tSRLV\t$56, R14, R24\n\tSLLV\t$8, R15, R28\n\tSLLV\t$8, R14, R14\n\tOR\tR24, R28, R15\n\tXOR\tR25, R14, R14\n\tSUBV\t$1, R6, R6\n\tSUBV\t$1, R5, R5\n\tBNE\tR6, R0, flush_buffer\n\n\tADDV\tR14, R8, R8\n\tSGTU\tR14, R8, R24\n\tADDV\tR15, R9, R27\n\tSGTU\tR15, R27, R28\n\tADDV\tR27, R24, R9\n\tSGTU\tR27, R9, R24\n\tOR\tR24, R28, R24\n\tADDV\tR10, R24, R10\n\n\tMOVV\t$16, R6\n\tJMP\tmultiply\n\ndone:\n\tMOVV\tR8, (R4)\n\tMOVV\tR9, 8(R4)\n\tMOVV\tR10, 16(R4)\n\tRET\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/sum_ppc64x.s",
"content": "// Copyright 2019 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego && (ppc64 || ppc64le)\n\n#include \"textflag.h\"\n\n// This was ported from the amd64 implementation.\n\n#ifdef GOARCH_ppc64le\n#define LE_MOVD MOVD\n#define LE_MOVWZ MOVWZ\n#define LE_MOVHZ MOVHZ\n#else\n#define LE_MOVD MOVDBR\n#define LE_MOVWZ MOVWBR\n#define LE_MOVHZ MOVHBR\n#endif\n\n#define POLY1305_ADD(msg, h0, h1, h2, t0, t1, t2) \\\n\tLE_MOVD (msg)( R0), t0; \\\n\tLE_MOVD (msg)(R24), t1; \\\n\tMOVD $1, t2; \\\n\tADDC t0, h0, h0; \\\n\tADDE t1, h1, h1; \\\n\tADDE t2, h2; \\\n\tADD $16, msg\n\n#define POLY1305_MUL(h0, h1, h2, r0, r1, t0, t1, t2, t3, t4, t5) \\\n\tMULLD r0, h0, t0; \\\n\tMULHDU r0, h0, t1; \\\n\tMULLD r0, h1, t4; \\\n\tMULHDU r0, h1, t5; \\\n\tADDC t4, t1, t1; \\\n\tMULLD r0, h2, t2; \\\n\tMULHDU r1, h0, t4; \\\n\tMULLD r1, h0, h0; \\\n\tADDE t5, t2, t2; \\\n\tADDC h0, t1, t1; \\\n\tMULLD h2, r1, t3; \\\n\tADDZE t4, h0; \\\n\tMULHDU r1, h1, t5; \\\n\tMULLD r1, h1, t4; \\\n\tADDC t4, t2, t2; \\\n\tADDE t5, t3, t3; \\\n\tADDC h0, t2, t2; \\\n\tMOVD $-4, t4; \\\n\tADDZE t3; \\\n\tRLDICL $0, t2, $62, h2; \\\n\tAND t2, t4, h0; \\\n\tADDC t0, h0, h0; \\\n\tADDE t3, t1, h1; \\\n\tSLD $62, t3, t4; \\\n\tSRD $2, t2; \\\n\tADDZE h2; \\\n\tOR t4, t2, t2; \\\n\tSRD $2, t3; \\\n\tADDC t2, h0, h0; \\\n\tADDE t3, h1, h1; \\\n\tADDZE h2\n\n// func update(state *[7]uint64, msg []byte)\nTEXT ·update(SB), $0-32\n\tMOVD state+0(FP), R3\n\tMOVD msg_base+8(FP), R4\n\tMOVD msg_len+16(FP), R5\n\n\tMOVD 0(R3), R8 // h0\n\tMOVD 8(R3), R9 // h1\n\tMOVD 16(R3), R10 // h2\n\tMOVD 24(R3), R11 // r0\n\tMOVD 32(R3), R12 // r1\n\n\tMOVD $8, R24\n\n\tCMP R5, $16\n\tBLT bytes_between_0_and_15\n\nloop:\n\tPOLY1305_ADD(R4, R8, R9, R10, R20, R21, R22)\n\n\tPCALIGN $16\nmultiply:\n\tPOLY1305_MUL(R8, R9, R10, R11, R12, R16, R17, R18, R14, R20, R21)\n\tADD $-16, R5\n\tCMP R5, $16\n\tBGE loop\n\nbytes_between_0_and_15:\n\tCMP R5, $0\n\tBEQ done\n\tMOVD $0, R16 // h0\n\tMOVD $0, R17 // h1\n\nflush_buffer:\n\tCMP R5, $8\n\tBLE just1\n\n\tMOVD $8, R21\n\tSUB R21, R5, R21\n\n\t// Greater than 8 -- load the rightmost remaining bytes in msg\n\t// and put into R17 (h1)\n\tLE_MOVD (R4)(R21), R17\n\tMOVD $16, R22\n\n\t// Find the offset to those bytes\n\tSUB R5, R22, R22\n\tSLD $3, R22\n\n\t// Shift to get only the bytes in msg\n\tSRD R22, R17, R17\n\n\t// Put 1 at high end\n\tMOVD $1, R23\n\tSLD $3, R21\n\tSLD R21, R23, R23\n\tOR R23, R17, R17\n\n\t// Remainder is 8\n\tMOVD $8, R5\n\njust1:\n\tCMP R5, $8\n\tBLT less8\n\n\t// Exactly 8\n\tLE_MOVD (R4), R16\n\n\tCMP R17, $0\n\n\t// Check if we've already set R17; if not\n\t// set 1 to indicate end of msg.\n\tBNE carry\n\tMOVD $1, R17\n\tBR carry\n\nless8:\n\tMOVD $0, R16 // h0\n\tMOVD $0, R22 // shift count\n\tCMP R5, $4\n\tBLT less4\n\tLE_MOVWZ (R4), R16\n\tADD $4, R4\n\tADD $-4, R5\n\tMOVD $32, R22\n\nless4:\n\tCMP R5, $2\n\tBLT less2\n\tLE_MOVHZ (R4), R21\n\tSLD R22, R21, R21\n\tOR R16, R21, R16\n\tADD $16, R22\n\tADD $-2, R5\n\tADD $2, R4\n\nless2:\n\tCMP R5, $0\n\tBEQ insert1\n\tMOVBZ (R4), R21\n\tSLD R22, R21, R21\n\tOR R16, R21, R16\n\tADD $8, R22\n\ninsert1:\n\t// Insert 1 at end of msg\n\tMOVD $1, R21\n\tSLD R22, R21, R21\n\tOR R16, R21, R16\n\ncarry:\n\t// Add new values to h0, h1, h2\n\tADDC R16, R8\n\tADDE R17, R9\n\tADDZE R10, R10\n\tMOVD $16, R5\n\tADD R5, R4\n\tBR multiply\n\ndone:\n\t// Save h0, h1, h2 in state\n\tMOVD R8, 0(R3)\n\tMOVD R9, 8(R3)\n\tMOVD R10, 16(R3)\n\tRET\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/sum_s390x.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego\n\npackage poly1305\n\nimport (\n\t\"golang.org/x/sys/cpu\"\n)\n\n// updateVX is an assembly implementation of Poly1305 that uses vector\n// instructions. It must only be called if the vector facility (vx) is\n// available.\n//\n//go:noescape\nfunc updateVX(state *macState, msg []byte)\n\n// mac is a replacement for macGeneric that uses a larger buffer and redirects\n// calls that would have gone to updateGeneric to updateVX if the vector\n// facility is installed.\n//\n// A larger buffer is required for good performance because the vector\n// implementation has a higher fixed cost per call than the generic\n// implementation.\ntype mac struct {\n\tmacState\n\n\tbuffer [16 * TagSize]byte // size must be a multiple of block size (16)\n\toffset int\n}\n\nfunc (h *mac) Write(p []byte) (int, error) {\n\tnn := len(p)\n\tif h.offset > 0 {\n\t\tn := copy(h.buffer[h.offset:], p)\n\t\tif h.offset+n < len(h.buffer) {\n\t\t\th.offset += n\n\t\t\treturn nn, nil\n\t\t}\n\t\tp = p[n:]\n\t\th.offset = 0\n\t\tif cpu.S390X.HasVX {\n\t\t\tupdateVX(&h.macState, h.buffer[:])\n\t\t} else {\n\t\t\tupdateGeneric(&h.macState, h.buffer[:])\n\t\t}\n\t}\n\n\ttail := len(p) % len(h.buffer) // number of bytes to copy into buffer\n\tbody := len(p) - tail // number of bytes to process now\n\tif body > 0 {\n\t\tif cpu.S390X.HasVX {\n\t\t\tupdateVX(&h.macState, p[:body])\n\t\t} else {\n\t\t\tupdateGeneric(&h.macState, p[:body])\n\t\t}\n\t}\n\th.offset = copy(h.buffer[:], p[body:]) // copy tail bytes - can be 0\n\treturn nn, nil\n}\n\nfunc (h *mac) Sum(out *[TagSize]byte) {\n\tstate := h.macState\n\tremainder := h.buffer[:h.offset]\n\n\t// Use the generic implementation if we have 2 or fewer blocks left\n\t// to sum. The vector implementation has a higher startup time.\n\tif cpu.S390X.HasVX && len(remainder) > 2*TagSize {\n\t\tupdateVX(&state, remainder)\n\t} else if len(remainder) > 0 {\n\t\tupdateGeneric(&state, remainder)\n\t}\n\tfinalize(out, &state.h, &state.s)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/internal/poly1305/sum_s390x.s",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n//go:build gc && !purego\n\n#include \"textflag.h\"\n\n// This implementation of Poly1305 uses the vector facility (vx)\n// to process up to 2 blocks (32 bytes) per iteration using an\n// algorithm based on the one described in:\n//\n// NEON crypto, Daniel J. Bernstein & Peter Schwabe\n// https://cryptojedi.org/papers/neoncrypto-20120320.pdf\n//\n// This algorithm uses 5 26-bit limbs to represent a 130-bit\n// value. These limbs are, for the most part, zero extended and\n// placed into 64-bit vector register elements. Each vector\n// register is 128-bits wide and so holds 2 of these elements.\n// Using 26-bit limbs allows us plenty of headroom to accommodate\n// accumulations before and after multiplication without\n// overflowing either 32-bits (before multiplication) or 64-bits\n// (after multiplication).\n//\n// In order to parallelise the operations required to calculate\n// the sum we use two separate accumulators and then sum those\n// in an extra final step. For compatibility with the generic\n// implementation we perform this summation at the end of every\n// updateVX call.\n//\n// To use two accumulators we must multiply the message blocks\n// by r² rather than r. Only the final message block should be\n// multiplied by r.\n//\n// Example:\n//\n// We want to calculate the sum (h) for a 64 byte message (m):\n//\n// h = m[0:16]r⁴ + m[16:32]r³ + m[32:48]r² + m[48:64]r\n//\n// To do this we split the calculation into the even indices\n// and odd indices of the message. These form our SIMD 'lanes':\n//\n// h = m[ 0:16]r⁴ + m[32:48]r² + <- lane 0\n// m[16:32]r³ + m[48:64]r <- lane 1\n//\n// To calculate this iteratively we refactor so that both lanes\n// are written in terms of r² and r:\n//\n// h = (m[ 0:16]r² + m[32:48])r² + <- lane 0\n// (m[16:32]r² + m[48:64])r <- lane 1\n// ^ ^\n// | coefficients for second iteration\n// coefficients for first iteration\n//\n// So in this case we would have two iterations. In the first\n// both lanes are multiplied by r². In the second only the\n// first lane is multiplied by r² and the second lane is\n// instead multiplied by r. This gives use the odd and even\n// powers of r that we need from the original equation.\n//\n// Notation:\n//\n// h - accumulator\n// r - key\n// m - message\n//\n// [a, b] - SIMD register holding two 64-bit values\n// [a, b, c, d] - SIMD register holding four 32-bit values\n// xᵢ[n] - limb n of variable x with bit width i\n//\n// Limbs are expressed in little endian order, so for 26-bit\n// limbs x₂₆[4] will be the most significant limb and x₂₆[0]\n// will be the least significant limb.\n\n// masking constants\n#define MOD24 V0 // [0x0000000000ffffff, 0x0000000000ffffff] - mask low 24-bits\n#define MOD26 V1 // [0x0000000003ffffff, 0x0000000003ffffff] - mask low 26-bits\n\n// expansion constants (see EXPAND macro)\n#define EX0 V2\n#define EX1 V3\n#define EX2 V4\n\n// key (r², r or 1 depending on context)\n#define R_0 V5\n#define R_1 V6\n#define R_2 V7\n#define R_3 V8\n#define R_4 V9\n\n// precalculated coefficients (5r², 5r or 0 depending on context)\n#define R5_1 V10\n#define R5_2 V11\n#define R5_3 V12\n#define R5_4 V13\n\n// message block (m)\n#define M_0 V14\n#define M_1 V15\n#define M_2 V16\n#define M_3 V17\n#define M_4 V18\n\n// accumulator (h)\n#define H_0 V19\n#define H_1 V20\n#define H_2 V21\n#define H_3 V22\n#define H_4 V23\n\n// temporary registers (for short-lived values)\n#define T_0 V24\n#define T_1 V25\n#define T_2 V26\n#define T_3 V27\n#define T_4 V28\n\nGLOBL ·constants<>(SB), RODATA, $0x30\n// EX0\nDATA ·constants<>+0x00(SB)/8, $0x0006050403020100\nDATA ·constants<>+0x08(SB)/8, $0x1016151413121110\n// EX1\nDATA ·constants<>+0x10(SB)/8, $0x060c0b0a09080706\nDATA ·constants<>+0x18(SB)/8, $0x161c1b1a19181716\n// EX2\nDATA ·constants<>+0x20(SB)/8, $0x0d0d0d0d0d0f0e0d\nDATA ·constants<>+0x28(SB)/8, $0x1d1d1d1d1d1f1e1d\n\n// MULTIPLY multiplies each lane of f and g, partially reduced\n// modulo 2¹³⁰ - 5. The result, h, consists of partial products\n// in each lane that need to be reduced further to produce the\n// final result.\n//\n// h₁₃₀ = (f₁₃₀g₁₃₀) % 2¹³⁰ + (5f₁₃₀g₁₃₀) / 2¹³⁰\n//\n// Note that the multiplication by 5 of the high bits is\n// achieved by precalculating the multiplication of four of the\n// g coefficients by 5. These are g51-g54.\n#define MULTIPLY(f0, f1, f2, f3, f4, g0, g1, g2, g3, g4, g51, g52, g53, g54, h0, h1, h2, h3, h4) \\\n\tVMLOF f0, g0, h0 \\\n\tVMLOF f0, g3, h3 \\\n\tVMLOF f0, g1, h1 \\\n\tVMLOF f0, g4, h4 \\\n\tVMLOF f0, g2, h2 \\\n\tVMLOF f1, g54, T_0 \\\n\tVMLOF f1, g2, T_3 \\\n\tVMLOF f1, g0, T_1 \\\n\tVMLOF f1, g3, T_4 \\\n\tVMLOF f1, g1, T_2 \\\n\tVMALOF f2, g53, h0, h0 \\\n\tVMALOF f2, g1, h3, h3 \\\n\tVMALOF f2, g54, h1, h1 \\\n\tVMALOF f2, g2, h4, h4 \\\n\tVMALOF f2, g0, h2, h2 \\\n\tVMALOF f3, g52, T_0, T_0 \\\n\tVMALOF f3, g0, T_3, T_3 \\\n\tVMALOF f3, g53, T_1, T_1 \\\n\tVMALOF f3, g1, T_4, T_4 \\\n\tVMALOF f3, g54, T_2, T_2 \\\n\tVMALOF f4, g51, h0, h0 \\\n\tVMALOF f4, g54, h3, h3 \\\n\tVMALOF f4, g52, h1, h1 \\\n\tVMALOF f4, g0, h4, h4 \\\n\tVMALOF f4, g53, h2, h2 \\\n\tVAG T_0, h0, h0 \\\n\tVAG T_3, h3, h3 \\\n\tVAG T_1, h1, h1 \\\n\tVAG T_4, h4, h4 \\\n\tVAG T_2, h2, h2\n\n// REDUCE performs the following carry operations in four\n// stages, as specified in Bernstein & Schwabe:\n//\n// 1: h₂₆[0]->h₂₆[1] h₂₆[3]->h₂₆[4]\n// 2: h₂₆[1]->h₂₆[2] h₂₆[4]->h₂₆[0]\n// 3: h₂₆[0]->h₂₆[1] h₂₆[2]->h₂₆[3]\n// 4: h₂₆[3]->h₂₆[4]\n//\n// The result is that all of the limbs are limited to 26-bits\n// except for h₂₆[1] and h₂₆[4] which are limited to 27-bits.\n//\n// Note that although each limb is aligned at 26-bit intervals\n// they may contain values that exceed 2²⁶ - 1, hence the need\n// to carry the excess bits in each limb.\n#define REDUCE(h0, h1, h2, h3, h4) \\\n\tVESRLG $26, h0, T_0 \\\n\tVESRLG $26, h3, T_1 \\\n\tVN MOD26, h0, h0 \\\n\tVN MOD26, h3, h3 \\\n\tVAG T_0, h1, h1 \\\n\tVAG T_1, h4, h4 \\\n\tVESRLG $26, h1, T_2 \\\n\tVESRLG $26, h4, T_3 \\\n\tVN MOD26, h1, h1 \\\n\tVN MOD26, h4, h4 \\\n\tVESLG $2, T_3, T_4 \\\n\tVAG T_3, T_4, T_4 \\\n\tVAG T_2, h2, h2 \\\n\tVAG T_4, h0, h0 \\\n\tVESRLG $26, h2, T_0 \\\n\tVESRLG $26, h0, T_1 \\\n\tVN MOD26, h2, h2 \\\n\tVN MOD26, h0, h0 \\\n\tVAG T_0, h3, h3 \\\n\tVAG T_1, h1, h1 \\\n\tVESRLG $26, h3, T_2 \\\n\tVN MOD26, h3, h3 \\\n\tVAG T_2, h4, h4\n\n// EXPAND splits the 128-bit little-endian values in0 and in1\n// into 26-bit big-endian limbs and places the results into\n// the first and second lane of d₂₆[0:4] respectively.\n//\n// The EX0, EX1 and EX2 constants are arrays of byte indices\n// for permutation. The permutation both reverses the bytes\n// in the input and ensures the bytes are copied into the\n// destination limb ready to be shifted into their final\n// position.\n#define EXPAND(in0, in1, d0, d1, d2, d3, d4) \\\n\tVPERM in0, in1, EX0, d0 \\\n\tVPERM in0, in1, EX1, d2 \\\n\tVPERM in0, in1, EX2, d4 \\\n\tVESRLG $26, d0, d1 \\\n\tVESRLG $30, d2, d3 \\\n\tVESRLG $4, d2, d2 \\\n\tVN MOD26, d0, d0 \\ // [in0₂₆[0], in1₂₆[0]]\n\tVN MOD26, d3, d3 \\ // [in0₂₆[3], in1₂₆[3]]\n\tVN MOD26, d1, d1 \\ // [in0₂₆[1], in1₂₆[1]]\n\tVN MOD24, d4, d4 \\ // [in0₂₆[4], in1₂₆[4]]\n\tVN MOD26, d2, d2 // [in0₂₆[2], in1₂₆[2]]\n\n// func updateVX(state *macState, msg []byte)\nTEXT ·updateVX(SB), NOSPLIT, $0\n\tMOVD state+0(FP), R1\n\tLMG msg+8(FP), R2, R3 // R2=msg_base, R3=msg_len\n\n\t// load EX0, EX1 and EX2\n\tMOVD $·constants<>(SB), R5\n\tVLM (R5), EX0, EX2\n\n\t// generate masks\n\tVGMG $(64-24), $63, MOD24 // [0x00ffffff, 0x00ffffff]\n\tVGMG $(64-26), $63, MOD26 // [0x03ffffff, 0x03ffffff]\n\n\t// load h (accumulator) and r (key) from state\n\tVZERO T_1 // [0, 0]\n\tVL 0(R1), T_0 // [h₆₄[0], h₆₄[1]]\n\tVLEG $0, 16(R1), T_1 // [h₆₄[2], 0]\n\tVL 24(R1), T_2 // [r₆₄[0], r₆₄[1]]\n\tVPDI $0, T_0, T_2, T_3 // [h₆₄[0], r₆₄[0]]\n\tVPDI $5, T_0, T_2, T_4 // [h₆₄[1], r₆₄[1]]\n\n\t// unpack h and r into 26-bit limbs\n\t// note: h₆₄[2] may have the low 3 bits set, so h₂₆[4] is a 27-bit value\n\tVN MOD26, T_3, H_0 // [h₂₆[0], r₂₆[0]]\n\tVZERO H_1 // [0, 0]\n\tVZERO H_3 // [0, 0]\n\tVGMG $(64-12-14), $(63-12), T_0 // [0x03fff000, 0x03fff000] - 26-bit mask with low 12 bits masked out\n\tVESLG $24, T_1, T_1 // [h₆₄[2]<<24, 0]\n\tVERIMG $-26&63, T_3, MOD26, H_1 // [h₂₆[1], r₂₆[1]]\n\tVESRLG $+52&63, T_3, H_2 // [h₂₆[2], r₂₆[2]] - low 12 bits only\n\tVERIMG $-14&63, T_4, MOD26, H_3 // [h₂₆[1], r₂₆[1]]\n\tVESRLG $40, T_4, H_4 // [h₂₆[4], r₂₆[4]] - low 24 bits only\n\tVERIMG $+12&63, T_4, T_0, H_2 // [h₂₆[2], r₂₆[2]] - complete\n\tVO T_1, H_4, H_4 // [h₂₆[4], r₂₆[4]] - complete\n\n\t// replicate r across all 4 vector elements\n\tVREPF $3, H_0, R_0 // [r₂₆[0], r₂₆[0], r₂₆[0], r₂₆[0]]\n\tVREPF $3, H_1, R_1 // [r₂₆[1], r₂₆[1], r₂₆[1], r₂₆[1]]\n\tVREPF $3, H_2, R_2 // [r₂₆[2], r₂₆[2], r₂₆[2], r₂₆[2]]\n\tVREPF $3, H_3, R_3 // [r₂₆[3], r₂₆[3], r₂₆[3], r₂₆[3]]\n\tVREPF $3, H_4, R_4 // [r₂₆[4], r₂₆[4], r₂₆[4], r₂₆[4]]\n\n\t// zero out lane 1 of h\n\tVLEIG $1, $0, H_0 // [h₂₆[0], 0]\n\tVLEIG $1, $0, H_1 // [h₂₆[1], 0]\n\tVLEIG $1, $0, H_2 // [h₂₆[2], 0]\n\tVLEIG $1, $0, H_3 // [h₂₆[3], 0]\n\tVLEIG $1, $0, H_4 // [h₂₆[4], 0]\n\n\t// calculate 5r (ignore least significant limb)\n\tVREPIF $5, T_0\n\tVMLF T_0, R_1, R5_1 // [5r₂₆[1], 5r₂₆[1], 5r₂₆[1], 5r₂₆[1]]\n\tVMLF T_0, R_2, R5_2 // [5r₂₆[2], 5r₂₆[2], 5r₂₆[2], 5r₂₆[2]]\n\tVMLF T_0, R_3, R5_3 // [5r₂₆[3], 5r₂₆[3], 5r₂₆[3], 5r₂₆[3]]\n\tVMLF T_0, R_4, R5_4 // [5r₂₆[4], 5r₂₆[4], 5r₂₆[4], 5r₂₆[4]]\n\n\t// skip r² calculation if we are only calculating one block\n\tCMPBLE R3, $16, skip\n\n\t// calculate r²\n\tMULTIPLY(R_0, R_1, R_2, R_3, R_4, R_0, R_1, R_2, R_3, R_4, R5_1, R5_2, R5_3, R5_4, M_0, M_1, M_2, M_3, M_4)\n\tREDUCE(M_0, M_1, M_2, M_3, M_4)\n\tVGBM $0x0f0f, T_0\n\tVERIMG $0, M_0, T_0, R_0 // [r₂₆[0], r²₂₆[0], r₂₆[0], r²₂₆[0]]\n\tVERIMG $0, M_1, T_0, R_1 // [r₂₆[1], r²₂₆[1], r₂₆[1], r²₂₆[1]]\n\tVERIMG $0, M_2, T_0, R_2 // [r₂₆[2], r²₂₆[2], r₂₆[2], r²₂₆[2]]\n\tVERIMG $0, M_3, T_0, R_3 // [r₂₆[3], r²₂₆[3], r₂₆[3], r²₂₆[3]]\n\tVERIMG $0, M_4, T_0, R_4 // [r₂₆[4], r²₂₆[4], r₂₆[4], r²₂₆[4]]\n\n\t// calculate 5r² (ignore least significant limb)\n\tVREPIF $5, T_0\n\tVMLF T_0, R_1, R5_1 // [5r₂₆[1], 5r²₂₆[1], 5r₂₆[1], 5r²₂₆[1]]\n\tVMLF T_0, R_2, R5_2 // [5r₂₆[2], 5r²₂₆[2], 5r₂₆[2], 5r²₂₆[2]]\n\tVMLF T_0, R_3, R5_3 // [5r₂₆[3], 5r²₂₆[3], 5r₂₆[3], 5r²₂₆[3]]\n\tVMLF T_0, R_4, R5_4 // [5r₂₆[4], 5r²₂₆[4], 5r₂₆[4], 5r²₂₆[4]]\n\nloop:\n\tCMPBLE R3, $32, b2 // 2 or fewer blocks remaining, need to change key coefficients\n\n\t// load next 2 blocks from message\n\tVLM (R2), T_0, T_1\n\n\t// update message slice\n\tSUB $32, R3\n\tMOVD $32(R2), R2\n\n\t// unpack message blocks into 26-bit big-endian limbs\n\tEXPAND(T_0, T_1, M_0, M_1, M_2, M_3, M_4)\n\n\t// add 2¹²⁸ to each message block value\n\tVLEIB $4, $1, M_4\n\tVLEIB $12, $1, M_4\n\nmultiply:\n\t// accumulate the incoming message\n\tVAG H_0, M_0, M_0\n\tVAG H_3, M_3, M_3\n\tVAG H_1, M_1, M_1\n\tVAG H_4, M_4, M_4\n\tVAG H_2, M_2, M_2\n\n\t// multiply the accumulator by the key coefficient\n\tMULTIPLY(M_0, M_1, M_2, M_3, M_4, R_0, R_1, R_2, R_3, R_4, R5_1, R5_2, R5_3, R5_4, H_0, H_1, H_2, H_3, H_4)\n\n\t// carry and partially reduce the partial products\n\tREDUCE(H_0, H_1, H_2, H_3, H_4)\n\n\tCMPBNE R3, $0, loop\n\nfinish:\n\t// sum lane 0 and lane 1 and put the result in lane 1\n\tVZERO T_0\n\tVSUMQG H_0, T_0, H_0\n\tVSUMQG H_3, T_0, H_3\n\tVSUMQG H_1, T_0, H_1\n\tVSUMQG H_4, T_0, H_4\n\tVSUMQG H_2, T_0, H_2\n\n\t// reduce again after summation\n\t// TODO(mundaym): there might be a more efficient way to do this\n\t// now that we only have 1 active lane. For example, we could\n\t// simultaneously pack the values as we reduce them.\n\tREDUCE(H_0, H_1, H_2, H_3, H_4)\n\n\t// carry h[1] through to h[4] so that only h[4] can exceed 2²⁶ - 1\n\t// TODO(mundaym): in testing this final carry was unnecessary.\n\t// Needs a proof before it can be removed though.\n\tVESRLG $26, H_1, T_1\n\tVN MOD26, H_1, H_1\n\tVAQ T_1, H_2, H_2\n\tVESRLG $26, H_2, T_2\n\tVN MOD26, H_2, H_2\n\tVAQ T_2, H_3, H_3\n\tVESRLG $26, H_3, T_3\n\tVN MOD26, H_3, H_3\n\tVAQ T_3, H_4, H_4\n\n\t// h is now < 2(2¹³⁰ - 5)\n\t// Pack each lane in h₂₆[0:4] into h₁₂₈[0:1].\n\tVESLG $26, H_1, H_1\n\tVESLG $26, H_3, H_3\n\tVO H_0, H_1, H_0\n\tVO H_2, H_3, H_2\n\tVESLG $4, H_2, H_2\n\tVLEIB $7, $48, H_1\n\tVSLB H_1, H_2, H_2\n\tVO H_0, H_2, H_0\n\tVLEIB $7, $104, H_1\n\tVSLB H_1, H_4, H_3\n\tVO H_3, H_0, H_0\n\tVLEIB $7, $24, H_1\n\tVSRLB H_1, H_4, H_1\n\n\t// update state\n\tVSTEG $1, H_0, 0(R1)\n\tVSTEG $0, H_0, 8(R1)\n\tVSTEG $1, H_1, 16(R1)\n\tRET\n\nb2: // 2 or fewer blocks remaining\n\tCMPBLE R3, $16, b1\n\n\t// Load the 2 remaining blocks (17-32 bytes remaining).\n\tMOVD $-17(R3), R0 // index of final byte to load modulo 16\n\tVL (R2), T_0 // load full 16 byte block\n\tVLL R0, 16(R2), T_1 // load final (possibly partial) block and pad with zeros to 16 bytes\n\n\t// The Poly1305 algorithm requires that a 1 bit be appended to\n\t// each message block. If the final block is less than 16 bytes\n\t// long then it is easiest to insert the 1 before the message\n\t// block is split into 26-bit limbs. If, on the other hand, the\n\t// final message block is 16 bytes long then we append the 1 bit\n\t// after expansion as normal.\n\tMOVBZ $1, R0\n\tMOVD $-16(R3), R3 // index of byte in last block to insert 1 at (could be 16)\n\tCMPBEQ R3, $16, 2(PC) // skip the insertion if the final block is 16 bytes long\n\tVLVGB R3, R0, T_1 // insert 1 into the byte at index R3\n\n\t// Split both blocks into 26-bit limbs in the appropriate lanes.\n\tEXPAND(T_0, T_1, M_0, M_1, M_2, M_3, M_4)\n\n\t// Append a 1 byte to the end of the second to last block.\n\tVLEIB $4, $1, M_4\n\n\t// Append a 1 byte to the end of the last block only if it is a\n\t// full 16 byte block.\n\tCMPBNE R3, $16, 2(PC)\n\tVLEIB $12, $1, M_4\n\n\t// Finally, set up the coefficients for the final multiplication.\n\t// We have previously saved r and 5r in the 32-bit even indexes\n\t// of the R_[0-4] and R5_[1-4] coefficient registers.\n\t//\n\t// We want lane 0 to be multiplied by r² so that can be kept the\n\t// same. We want lane 1 to be multiplied by r so we need to move\n\t// the saved r value into the 32-bit odd index in lane 1 by\n\t// rotating the 64-bit lane by 32.\n\tVGBM $0x00ff, T_0 // [0, 0xffffffffffffffff] - mask lane 1 only\n\tVERIMG $32, R_0, T_0, R_0 // [_, r²₂₆[0], _, r₂₆[0]]\n\tVERIMG $32, R_1, T_0, R_1 // [_, r²₂₆[1], _, r₂₆[1]]\n\tVERIMG $32, R_2, T_0, R_2 // [_, r²₂₆[2], _, r₂₆[2]]\n\tVERIMG $32, R_3, T_0, R_3 // [_, r²₂₆[3], _, r₂₆[3]]\n\tVERIMG $32, R_4, T_0, R_4 // [_, r²₂₆[4], _, r₂₆[4]]\n\tVERIMG $32, R5_1, T_0, R5_1 // [_, 5r²₂₆[1], _, 5r₂₆[1]]\n\tVERIMG $32, R5_2, T_0, R5_2 // [_, 5r²₂₆[2], _, 5r₂₆[2]]\n\tVERIMG $32, R5_3, T_0, R5_3 // [_, 5r²₂₆[3], _, 5r₂₆[3]]\n\tVERIMG $32, R5_4, T_0, R5_4 // [_, 5r²₂₆[4], _, 5r₂₆[4]]\n\n\tMOVD $0, R3\n\tBR multiply\n\nskip:\n\tCMPBEQ R3, $0, finish\n\nb1: // 1 block remaining\n\n\t// Load the final block (1-16 bytes). This will be placed into\n\t// lane 0.\n\tMOVD $-1(R3), R0\n\tVLL R0, (R2), T_0 // pad to 16 bytes with zeros\n\n\t// The Poly1305 algorithm requires that a 1 bit be appended to\n\t// each message block. If the final block is less than 16 bytes\n\t// long then it is easiest to insert the 1 before the message\n\t// block is split into 26-bit limbs. If, on the other hand, the\n\t// final message block is 16 bytes long then we append the 1 bit\n\t// after expansion as normal.\n\tMOVBZ $1, R0\n\tCMPBEQ R3, $16, 2(PC)\n\tVLVGB R3, R0, T_0\n\n\t// Set the message block in lane 1 to the value 0 so that it\n\t// can be accumulated without affecting the final result.\n\tVZERO T_1\n\n\t// Split the final message block into 26-bit limbs in lane 0.\n\t// Lane 1 will be contain 0.\n\tEXPAND(T_0, T_1, M_0, M_1, M_2, M_3, M_4)\n\n\t// Append a 1 byte to the end of the last block only if it is a\n\t// full 16 byte block.\n\tCMPBNE R3, $16, 2(PC)\n\tVLEIB $4, $1, M_4\n\n\t// We have previously saved r and 5r in the 32-bit even indexes\n\t// of the R_[0-4] and R5_[1-4] coefficient registers.\n\t//\n\t// We want lane 0 to be multiplied by r so we need to move the\n\t// saved r value into the 32-bit odd index in lane 0. We want\n\t// lane 1 to be set to the value 1. This makes multiplication\n\t// a no-op. We do this by setting lane 1 in every register to 0\n\t// and then just setting the 32-bit index 3 in R_0 to 1.\n\tVZERO T_0\n\tMOVD $0, R0\n\tMOVD $0x10111213, R12\n\tVLVGP R12, R0, T_1 // [_, 0x10111213, _, 0x00000000]\n\tVPERM T_0, R_0, T_1, R_0 // [_, r₂₆[0], _, 0]\n\tVPERM T_0, R_1, T_1, R_1 // [_, r₂₆[1], _, 0]\n\tVPERM T_0, R_2, T_1, R_2 // [_, r₂₆[2], _, 0]\n\tVPERM T_0, R_3, T_1, R_3 // [_, r₂₆[3], _, 0]\n\tVPERM T_0, R_4, T_1, R_4 // [_, r₂₆[4], _, 0]\n\tVPERM T_0, R5_1, T_1, R5_1 // [_, 5r₂₆[1], _, 0]\n\tVPERM T_0, R5_2, T_1, R5_2 // [_, 5r₂₆[2], _, 0]\n\tVPERM T_0, R5_3, T_1, R5_3 // [_, 5r₂₆[3], _, 0]\n\tVPERM T_0, R5_4, T_1, R5_4 // [_, 5r₂₆[4], _, 0]\n\n\t// Set the value of lane 1 to be 1.\n\tVLEIF $3, $1, R_0 // [_, r₂₆[0], _, 1]\n\n\tMOVD $0, R3\n\tBR multiply\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/buffer.go",
"content": "// Copyright 2012 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"io\"\n\t\"sync\"\n)\n\n// buffer provides a linked list buffer for data exchange\n// between producer and consumer. Theoretically the buffer is\n// of unlimited capacity as it does no allocation of its own.\ntype buffer struct {\n\t// protects concurrent access to head, tail and closed\n\t*sync.Cond\n\n\thead *element // the buffer that will be read first\n\ttail *element // the buffer that will be read last\n\n\tclosed bool\n}\n\n// An element represents a single link in a linked list.\ntype element struct {\n\tbuf []byte\n\tnext *element\n}\n\n// newBuffer returns an empty buffer that is not closed.\nfunc newBuffer() *buffer {\n\te := new(element)\n\tb := &buffer{\n\t\tCond: newCond(),\n\t\thead: e,\n\t\ttail: e,\n\t}\n\treturn b\n}\n\n// write makes buf available for Read to receive.\n// buf must not be modified after the call to write.\nfunc (b *buffer) write(buf []byte) {\n\tb.Cond.L.Lock()\n\te := &element{buf: buf}\n\tb.tail.next = e\n\tb.tail = e\n\tb.Cond.Signal()\n\tb.Cond.L.Unlock()\n}\n\n// eof closes the buffer. Reads from the buffer once all\n// the data has been consumed will receive io.EOF.\nfunc (b *buffer) eof() {\n\tb.Cond.L.Lock()\n\tb.closed = true\n\tb.Cond.Signal()\n\tb.Cond.L.Unlock()\n}\n\n// Read reads data from the internal buffer in buf. Reads will block\n// if no data is available, or until the buffer is closed.\nfunc (b *buffer) Read(buf []byte) (n int, err error) {\n\tb.Cond.L.Lock()\n\tdefer b.Cond.L.Unlock()\n\n\tfor len(buf) > 0 {\n\t\t// if there is data in b.head, copy it\n\t\tif len(b.head.buf) > 0 {\n\t\t\tr := copy(buf, b.head.buf)\n\t\t\tbuf, b.head.buf = buf[r:], b.head.buf[r:]\n\t\t\tn += r\n\t\t\tcontinue\n\t\t}\n\t\t// if there is a next buffer, make it the head\n\t\tif len(b.head.buf) == 0 && b.head != b.tail {\n\t\t\tb.head = b.head.next\n\t\t\tcontinue\n\t\t}\n\n\t\t// if at least one byte has been copied, return\n\t\tif n > 0 {\n\t\t\tbreak\n\t\t}\n\n\t\t// if nothing was read, and there is nothing outstanding\n\t\t// check to see if the buffer is closed.\n\t\tif b.closed {\n\t\t\terr = io.EOF\n\t\t\tbreak\n\t\t}\n\t\t// out of buffers, wait for producer\n\t\tb.Cond.Wait()\n\t}\n\treturn\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/certs.go",
"content": "// Copyright 2012 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net\"\n\t\"sort\"\n\t\"time\"\n)\n\n// Certificate algorithm names from [PROTOCOL.certkeys]. These values can appear\n// in Certificate.Type, PublicKey.Type, and ClientConfig.HostKeyAlgorithms.\n// Unlike key algorithm names, these are not passed to AlgorithmSigner nor\n// returned by MultiAlgorithmSigner and don't appear in the Signature.Format\n// field.\nconst (\n\tCertAlgoRSAv01 = \"ssh-rsa-cert-v01@openssh.com\"\n\t// Deprecated: DSA is only supported at insecure key sizes, and was removed\n\t// from major implementations.\n\tCertAlgoDSAv01 = InsecureCertAlgoDSAv01\n\t// Deprecated: DSA is only supported at insecure key sizes, and was removed\n\t// from major implementations.\n\tInsecureCertAlgoDSAv01 = \"ssh-dss-cert-v01@openssh.com\"\n\tCertAlgoECDSA256v01 = \"ecdsa-sha2-nistp256-cert-v01@openssh.com\"\n\tCertAlgoECDSA384v01 = \"ecdsa-sha2-nistp384-cert-v01@openssh.com\"\n\tCertAlgoECDSA521v01 = \"ecdsa-sha2-nistp521-cert-v01@openssh.com\"\n\tCertAlgoSKECDSA256v01 = \"sk-ecdsa-sha2-nistp256-cert-v01@openssh.com\"\n\tCertAlgoED25519v01 = \"ssh-ed25519-cert-v01@openssh.com\"\n\tCertAlgoSKED25519v01 = \"sk-ssh-ed25519-cert-v01@openssh.com\"\n\n\t// CertAlgoRSASHA256v01 and CertAlgoRSASHA512v01 can't appear as a\n\t// Certificate.Type (or PublicKey.Type), but only in\n\t// ClientConfig.HostKeyAlgorithms.\n\tCertAlgoRSASHA256v01 = \"rsa-sha2-256-cert-v01@openssh.com\"\n\tCertAlgoRSASHA512v01 = \"rsa-sha2-512-cert-v01@openssh.com\"\n)\n\nconst (\n\t// Deprecated: use CertAlgoRSAv01.\n\tCertSigAlgoRSAv01 = CertAlgoRSAv01\n\t// Deprecated: use CertAlgoRSASHA256v01.\n\tCertSigAlgoRSASHA2256v01 = CertAlgoRSASHA256v01\n\t// Deprecated: use CertAlgoRSASHA512v01.\n\tCertSigAlgoRSASHA2512v01 = CertAlgoRSASHA512v01\n)\n\n// Certificate types distinguish between host and user\n// certificates. The values can be set in the CertType field of\n// Certificate.\nconst (\n\tUserCert = 1\n\tHostCert = 2\n)\n\n// Signature represents a cryptographic signature.\ntype Signature struct {\n\tFormat string\n\tBlob []byte\n\tRest []byte `ssh:\"rest\"`\n}\n\n// CertTimeInfinity can be used for OpenSSHCertV01.ValidBefore to indicate that\n// a certificate does not expire.\nconst CertTimeInfinity = 1<<64 - 1\n\n// An Certificate represents an OpenSSH certificate as defined in\n// [PROTOCOL.certkeys]?rev=1.8. The Certificate type implements the\n// PublicKey interface, so it can be unmarshaled using\n// ParsePublicKey.\ntype Certificate struct {\n\tNonce []byte\n\tKey PublicKey\n\tSerial uint64\n\tCertType uint32\n\tKeyId string\n\tValidPrincipals []string\n\tValidAfter uint64\n\tValidBefore uint64\n\tPermissions\n\tReserved []byte\n\tSignatureKey PublicKey\n\tSignature *Signature\n}\n\n// genericCertData holds the key-independent part of the certificate data.\n// Overall, certificates contain an nonce, public key fields and\n// key-independent fields.\ntype genericCertData struct {\n\tSerial uint64\n\tCertType uint32\n\tKeyId string\n\tValidPrincipals []byte\n\tValidAfter uint64\n\tValidBefore uint64\n\tCriticalOptions []byte\n\tExtensions []byte\n\tReserved []byte\n\tSignatureKey []byte\n\tSignature []byte\n}\n\nfunc marshalStringList(namelist []string) []byte {\n\tvar to []byte\n\tfor _, name := range namelist {\n\t\ts := struct{ N string }{name}\n\t\tto = append(to, Marshal(&s)...)\n\t}\n\treturn to\n}\n\ntype optionsTuple struct {\n\tKey string\n\tValue []byte\n}\n\ntype optionsTupleValue struct {\n\tValue string\n}\n\n// serialize a map of critical options or extensions\n// issue #10569 - per [PROTOCOL.certkeys] and SSH implementation,\n// we need two length prefixes for a non-empty string value\nfunc marshalTuples(tups map[string]string) []byte {\n\tkeys := make([]string, 0, len(tups))\n\tfor key := range tups {\n\t\tkeys = append(keys, key)\n\t}\n\tsort.Strings(keys)\n\n\tvar ret []byte\n\tfor _, key := range keys {\n\t\ts := optionsTuple{Key: key}\n\t\tif value := tups[key]; len(value) > 0 {\n\t\t\ts.Value = Marshal(&optionsTupleValue{value})\n\t\t}\n\t\tret = append(ret, Marshal(&s)...)\n\t}\n\treturn ret\n}\n\n// issue #10569 - per [PROTOCOL.certkeys] and SSH implementation,\n// we need two length prefixes for a non-empty option value\nfunc parseTuples(in []byte) (map[string]string, error) {\n\ttups := map[string]string{}\n\tvar lastKey string\n\tvar haveLastKey bool\n\n\tfor len(in) > 0 {\n\t\tvar key, val, extra []byte\n\t\tvar ok bool\n\n\t\tif key, in, ok = parseString(in); !ok {\n\t\t\treturn nil, errShortRead\n\t\t}\n\t\tkeyStr := string(key)\n\t\t// according to [PROTOCOL.certkeys], the names must be in\n\t\t// lexical order.\n\t\tif haveLastKey && keyStr <= lastKey {\n\t\t\treturn nil, fmt.Errorf(\"ssh: certificate options are not in lexical order\")\n\t\t}\n\t\tlastKey, haveLastKey = keyStr, true\n\t\t// the next field is a data field, which if non-empty has a string embedded\n\t\tif val, in, ok = parseString(in); !ok {\n\t\t\treturn nil, errShortRead\n\t\t}\n\t\tif len(val) > 0 {\n\t\t\tval, extra, ok = parseString(val)\n\t\t\tif !ok {\n\t\t\t\treturn nil, errShortRead\n\t\t\t}\n\t\t\tif len(extra) > 0 {\n\t\t\t\treturn nil, fmt.Errorf(\"ssh: unexpected trailing data after certificate option value\")\n\t\t\t}\n\t\t\ttups[keyStr] = string(val)\n\t\t} else {\n\t\t\ttups[keyStr] = \"\"\n\t\t}\n\t}\n\treturn tups, nil\n}\n\nfunc parseCert(in []byte, privAlgo string) (*Certificate, error) {\n\tnonce, rest, ok := parseString(in)\n\tif !ok {\n\t\treturn nil, errShortRead\n\t}\n\n\tkey, rest, err := parsePubKey(rest, privAlgo)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar g genericCertData\n\tif err := Unmarshal(rest, &g); err != nil {\n\t\treturn nil, err\n\t}\n\n\tc := &Certificate{\n\t\tNonce: nonce,\n\t\tKey: key,\n\t\tSerial: g.Serial,\n\t\tCertType: g.CertType,\n\t\tKeyId: g.KeyId,\n\t\tValidAfter: g.ValidAfter,\n\t\tValidBefore: g.ValidBefore,\n\t}\n\n\tfor principals := g.ValidPrincipals; len(principals) > 0; {\n\t\tprincipal, rest, ok := parseString(principals)\n\t\tif !ok {\n\t\t\treturn nil, errShortRead\n\t\t}\n\t\tc.ValidPrincipals = append(c.ValidPrincipals, string(principal))\n\t\tprincipals = rest\n\t}\n\n\tc.CriticalOptions, err = parseTuples(g.CriticalOptions)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tc.Extensions, err = parseTuples(g.Extensions)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tc.Reserved = g.Reserved\n\tk, err := ParsePublicKey(g.SignatureKey)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\t// The Type() function is intended to return only certificate key types, but\n\t// we use certKeyAlgoNames anyway for safety, to match [Certificate.Type].\n\tif _, ok := certKeyAlgoNames[k.Type()]; ok {\n\t\treturn nil, fmt.Errorf(\"ssh: the signature key type %q is invalid for certificates\", k.Type())\n\t}\n\tc.SignatureKey = k\n\tc.Signature, rest, ok = parseSignatureBody(g.Signature)\n\tif !ok || len(rest) > 0 {\n\t\treturn nil, errors.New(\"ssh: signature parse error\")\n\t}\n\n\treturn c, nil\n}\n\ntype openSSHCertSigner struct {\n\tpub *Certificate\n\tsigner Signer\n}\n\ntype algorithmOpenSSHCertSigner struct {\n\t*openSSHCertSigner\n\talgorithmSigner AlgorithmSigner\n}\n\n// NewCertSigner returns a Signer that signs with the given Certificate, whose\n// private key is held by signer. It returns an error if the public key in cert\n// doesn't match the key used by signer.\nfunc NewCertSigner(cert *Certificate, signer Signer) (Signer, error) {\n\tif !bytes.Equal(cert.Key.Marshal(), signer.PublicKey().Marshal()) {\n\t\treturn nil, errors.New(\"ssh: signer and cert have different public key\")\n\t}\n\n\tswitch s := signer.(type) {\n\tcase MultiAlgorithmSigner:\n\t\treturn &multiAlgorithmSigner{\n\t\t\tAlgorithmSigner: &algorithmOpenSSHCertSigner{\n\t\t\t\t&openSSHCertSigner{cert, signer}, s},\n\t\t\tsupportedAlgorithms: s.Algorithms(),\n\t\t}, nil\n\tcase AlgorithmSigner:\n\t\treturn &algorithmOpenSSHCertSigner{\n\t\t\t&openSSHCertSigner{cert, signer}, s}, nil\n\tdefault:\n\t\treturn &openSSHCertSigner{cert, signer}, nil\n\t}\n}\n\nfunc (s *openSSHCertSigner) Sign(rand io.Reader, data []byte) (*Signature, error) {\n\treturn s.signer.Sign(rand, data)\n}\n\nfunc (s *openSSHCertSigner) PublicKey() PublicKey {\n\treturn s.pub\n}\n\nfunc (s *algorithmOpenSSHCertSigner) SignWithAlgorithm(rand io.Reader, data []byte, algorithm string) (*Signature, error) {\n\treturn s.algorithmSigner.SignWithAlgorithm(rand, data, algorithm)\n}\n\nconst sourceAddressCriticalOption = \"source-address\"\n\n// CertChecker does the work of verifying a certificate. Its methods\n// can be plugged into ClientConfig.HostKeyCallback and\n// ServerConfig.PublicKeyCallback. For the CertChecker to work,\n// minimally, the IsAuthority callback should be set.\ntype CertChecker struct {\n\t// SupportedCriticalOptions lists the CriticalOptions that the\n\t// server application layer understands. These are only used\n\t// for user certificates.\n\tSupportedCriticalOptions []string\n\n\t// IsUserAuthority should return true if the key is recognized as an\n\t// authority for user certificate. This must be set if this CertChecker\n\t// will be checking user certificates.\n\tIsUserAuthority func(auth PublicKey) bool\n\n\t// IsHostAuthority should report whether the key is recognized as\n\t// an authority for this host. This must be set if this CertChecker\n\t// will be checking host certificates.\n\tIsHostAuthority func(auth PublicKey, address string) bool\n\n\t// Clock is used for verifying time stamps. If nil, time.Now\n\t// is used.\n\tClock func() time.Time\n\n\t// UserKeyFallback is called when CertChecker.Authenticate encounters a\n\t// public key that is not a certificate. It must implement validation\n\t// of user keys or else, if nil, all such keys are rejected.\n\tUserKeyFallback func(conn ConnMetadata, key PublicKey) (*Permissions, error)\n\n\t// HostKeyFallback is called when CertChecker.CheckHostKey encounters a\n\t// public key that is not a certificate. It must implement host key\n\t// validation or else, if nil, all such keys are rejected.\n\tHostKeyFallback HostKeyCallback\n\n\t// IsRevoked is called for each certificate so that revocation checking\n\t// can be implemented. It should return true if the given certificate\n\t// is revoked and false otherwise. If nil, no certificates are\n\t// considered to have been revoked.\n\tIsRevoked func(cert *Certificate) bool\n}\n\n// CheckHostKey checks a host key certificate. This method can be\n// plugged into ClientConfig.HostKeyCallback.\nfunc (c *CertChecker) CheckHostKey(addr string, remote net.Addr, key PublicKey) error {\n\tcert, ok := key.(*Certificate)\n\tif !ok {\n\t\tif c.HostKeyFallback != nil {\n\t\t\treturn c.HostKeyFallback(addr, remote, key)\n\t\t}\n\t\treturn errors.New(\"ssh: non-certificate host key\")\n\t}\n\tif cert.CertType != HostCert {\n\t\treturn fmt.Errorf(\"ssh: certificate presented as a host key has type %d\", cert.CertType)\n\t}\n\tif !c.IsHostAuthority(cert.SignatureKey, addr) {\n\t\treturn fmt.Errorf(\"ssh: no authorities for hostname: %v\", addr)\n\t}\n\n\thostname, _, err := net.SplitHostPort(addr)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// Pass hostname only as principal for host certificates (consistent with OpenSSH)\n\treturn c.CheckCert(hostname, cert)\n}\n\n// Authenticate checks a user certificate. Authenticate can be used as\n// a value for ServerConfig.PublicKeyCallback.\nfunc (c *CertChecker) Authenticate(conn ConnMetadata, pubKey PublicKey) (*Permissions, error) {\n\tcert, ok := pubKey.(*Certificate)\n\tif !ok {\n\t\tif c.UserKeyFallback != nil {\n\t\t\treturn c.UserKeyFallback(conn, pubKey)\n\t\t}\n\t\treturn nil, errors.New(\"ssh: normal key pairs not accepted\")\n\t}\n\n\tif cert.CertType != UserCert {\n\t\treturn nil, fmt.Errorf(\"ssh: cert has type %d\", cert.CertType)\n\t}\n\tif !c.IsUserAuthority(cert.SignatureKey) {\n\t\treturn nil, fmt.Errorf(\"ssh: certificate signed by unrecognized authority\")\n\t}\n\n\tif err := c.CheckCert(conn.User(), cert); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn &cert.Permissions, nil\n}\n\n// CheckCert checks CriticalOptions, ValidPrincipals, revocation, timestamp and\n// the signature of the certificate.\nfunc (c *CertChecker) CheckCert(principal string, cert *Certificate) error {\n\tif c.IsRevoked != nil && c.IsRevoked(cert) {\n\t\treturn fmt.Errorf(\"ssh: certificate serial %d revoked\", cert.Serial)\n\t}\n\n\tfor opt := range cert.CriticalOptions {\n\t\t// sourceAddressCriticalOption will be enforced by\n\t\t// serverAuthenticate\n\t\tif opt == sourceAddressCriticalOption {\n\t\t\tcontinue\n\t\t}\n\n\t\tfound := false\n\t\tfor _, supp := range c.SupportedCriticalOptions {\n\t\t\tif supp == opt {\n\t\t\t\tfound = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !found {\n\t\t\treturn fmt.Errorf(\"ssh: unsupported critical option %q in certificate\", opt)\n\t\t}\n\t}\n\n\tif len(cert.ValidPrincipals) > 0 {\n\t\t// By default, certs are valid for all users/hosts.\n\t\tfound := false\n\t\tfor _, p := range cert.ValidPrincipals {\n\t\t\tif p == principal {\n\t\t\t\tfound = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !found {\n\t\t\treturn fmt.Errorf(\"ssh: principal %q not in the set of valid principals for given certificate: %q\", principal, cert.ValidPrincipals)\n\t\t}\n\t}\n\n\tclock := c.Clock\n\tif clock == nil {\n\t\tclock = time.Now\n\t}\n\n\tunixNow := clock().Unix()\n\tif after := int64(cert.ValidAfter); after < 0 || unixNow < int64(cert.ValidAfter) {\n\t\treturn fmt.Errorf(\"ssh: cert is not yet valid\")\n\t}\n\tif before := int64(cert.ValidBefore); cert.ValidBefore != uint64(CertTimeInfinity) && (unixNow >= before || before < 0) {\n\t\treturn fmt.Errorf(\"ssh: cert has expired\")\n\t}\n\tif err := cert.SignatureKey.Verify(cert.bytesForSigning(), cert.Signature); err != nil {\n\t\treturn fmt.Errorf(\"ssh: certificate signature does not verify\")\n\t}\n\n\treturn nil\n}\n\n// SignCert signs the certificate with an authority, setting the Nonce,\n// SignatureKey, and Signature fields. If the authority implements the\n// MultiAlgorithmSigner interface the first algorithm in the list is used. This\n// is useful if you want to sign with a specific algorithm. As specified in\n// [SSH-CERTS], Section 2.1.1, authority can't be a [Certificate].\nfunc (c *Certificate) SignCert(rand io.Reader, authority Signer) error {\n\tc.Nonce = make([]byte, 32)\n\tif _, err := io.ReadFull(rand, c.Nonce); err != nil {\n\t\treturn err\n\t}\n\t// The Type() function is intended to return only certificate key types, but\n\t// we use certKeyAlgoNames anyway for safety, to match [Certificate.Type].\n\tif _, ok := certKeyAlgoNames[authority.PublicKey().Type()]; ok {\n\t\treturn fmt.Errorf(\"ssh: certificates cannot be used as authority (public key type %q)\",\n\t\t\tauthority.PublicKey().Type())\n\t}\n\tc.SignatureKey = authority.PublicKey()\n\n\tif v, ok := authority.(MultiAlgorithmSigner); ok {\n\t\tif len(v.Algorithms()) == 0 {\n\t\t\treturn errors.New(\"the provided authority has no signature algorithm\")\n\t\t}\n\t\t// Use the first algorithm in the list.\n\t\tsig, err := v.SignWithAlgorithm(rand, c.bytesForSigning(), v.Algorithms()[0])\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tc.Signature = sig\n\t\treturn nil\n\t} else if v, ok := authority.(AlgorithmSigner); ok && v.PublicKey().Type() == KeyAlgoRSA {\n\t\t// Default to KeyAlgoRSASHA512 for ssh-rsa signers.\n\t\t// TODO: consider using KeyAlgoRSASHA256 as default.\n\t\tsig, err := v.SignWithAlgorithm(rand, c.bytesForSigning(), KeyAlgoRSASHA512)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tc.Signature = sig\n\t\treturn nil\n\t}\n\n\tsig, err := authority.Sign(rand, c.bytesForSigning())\n\tif err != nil {\n\t\treturn err\n\t}\n\tc.Signature = sig\n\treturn nil\n}\n\n// certKeyAlgoNames is a mapping from known certificate algorithm names to the\n// corresponding public key signature algorithm.\n//\n// This map must be kept in sync with the one in agent/client.go.\nvar certKeyAlgoNames = map[string]string{\n\tCertAlgoRSAv01: KeyAlgoRSA,\n\tCertAlgoRSASHA256v01: KeyAlgoRSASHA256,\n\tCertAlgoRSASHA512v01: KeyAlgoRSASHA512,\n\tInsecureCertAlgoDSAv01: InsecureKeyAlgoDSA,\n\tCertAlgoECDSA256v01: KeyAlgoECDSA256,\n\tCertAlgoECDSA384v01: KeyAlgoECDSA384,\n\tCertAlgoECDSA521v01: KeyAlgoECDSA521,\n\tCertAlgoSKECDSA256v01: KeyAlgoSKECDSA256,\n\tCertAlgoED25519v01: KeyAlgoED25519,\n\tCertAlgoSKED25519v01: KeyAlgoSKED25519,\n}\n\n// underlyingAlgo returns the signature algorithm associated with algo (which is\n// an advertised or negotiated public key or host key algorithm). These are\n// usually the same, except for certificate algorithms.\nfunc underlyingAlgo(algo string) string {\n\tif a, ok := certKeyAlgoNames[algo]; ok {\n\t\treturn a\n\t}\n\treturn algo\n}\n\n// certificateAlgo returns the certificate algorithms that uses the provided\n// underlying signature algorithm.\nfunc certificateAlgo(algo string) (certAlgo string, ok bool) {\n\tfor certName, algoName := range certKeyAlgoNames {\n\t\tif algoName == algo {\n\t\t\treturn certName, true\n\t\t}\n\t}\n\treturn \"\", false\n}\n\nfunc (cert *Certificate) bytesForSigning() []byte {\n\tc2 := *cert\n\tc2.Signature = nil\n\tout := c2.Marshal()\n\t// Drop trailing signature length.\n\treturn out[:len(out)-4]\n}\n\n// Marshal serializes c into OpenSSH's wire format. It is part of the\n// PublicKey interface.\nfunc (c *Certificate) Marshal() []byte {\n\tgeneric := genericCertData{\n\t\tSerial: c.Serial,\n\t\tCertType: c.CertType,\n\t\tKeyId: c.KeyId,\n\t\tValidPrincipals: marshalStringList(c.ValidPrincipals),\n\t\tValidAfter: uint64(c.ValidAfter),\n\t\tValidBefore: uint64(c.ValidBefore),\n\t\tCriticalOptions: marshalTuples(c.CriticalOptions),\n\t\tExtensions: marshalTuples(c.Extensions),\n\t\tReserved: c.Reserved,\n\t\tSignatureKey: c.SignatureKey.Marshal(),\n\t}\n\tif c.Signature != nil {\n\t\tgeneric.Signature = Marshal(c.Signature)\n\t}\n\tgenericBytes := Marshal(&generic)\n\tkeyBytes := c.Key.Marshal()\n\t_, keyBytes, _ = parseString(keyBytes)\n\tprefix := Marshal(&struct {\n\t\tName string\n\t\tNonce []byte\n\t\tKey []byte `ssh:\"rest\"`\n\t}{c.Type(), c.Nonce, keyBytes})\n\n\tresult := make([]byte, 0, len(prefix)+len(genericBytes))\n\tresult = append(result, prefix...)\n\tresult = append(result, genericBytes...)\n\treturn result\n}\n\n// Type returns the certificate algorithm name. It is part of the PublicKey interface.\nfunc (c *Certificate) Type() string {\n\tcertName, ok := certificateAlgo(c.Key.Type())\n\tif !ok {\n\t\tpanic(\"unknown certificate type for key type \" + c.Key.Type())\n\t}\n\treturn certName\n}\n\n// Verify verifies a signature against the certificate's public\n// key. It is part of the PublicKey interface.\nfunc (c *Certificate) Verify(data []byte, sig *Signature) error {\n\treturn c.Key.Verify(data, sig)\n}\n\nfunc parseSignatureBody(in []byte) (out *Signature, rest []byte, ok bool) {\n\tformat, in, ok := parseString(in)\n\tif !ok {\n\t\treturn\n\t}\n\n\tout = &Signature{\n\t\tFormat: string(format),\n\t}\n\n\tif out.Blob, in, ok = parseString(in); !ok {\n\t\treturn\n\t}\n\n\tswitch out.Format {\n\tcase KeyAlgoSKECDSA256, CertAlgoSKECDSA256v01, KeyAlgoSKED25519, CertAlgoSKED25519v01:\n\t\tout.Rest = in\n\t\treturn out, nil, ok\n\t}\n\n\treturn out, in, ok\n}\n\nfunc parseSignature(in []byte) (out *Signature, rest []byte, ok bool) {\n\tsigBytes, rest, ok := parseString(in)\n\tif !ok {\n\t\treturn\n\t}\n\n\tout, trailing, ok := parseSignatureBody(sigBytes)\n\tif !ok || len(trailing) > 0 {\n\t\treturn nil, nil, false\n\t}\n\treturn\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/channel.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"encoding/binary\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"sync\"\n)\n\nconst (\n\tminPacketLength = 9\n\t// channelMaxPacket contains the maximum number of bytes that will be\n\t// sent in a single packet. As per RFC 4253, section 6.1, 32k is also\n\t// the minimum.\n\tchannelMaxPacket = 1 << 15\n\t// We follow OpenSSH here.\n\tchannelWindowSize = 64 * channelMaxPacket\n)\n\n// NewChannel represents an incoming request to a channel. It must either be\n// accepted for use by calling Accept, or rejected by calling Reject.\ntype NewChannel interface {\n\t// Accept accepts the channel creation request. It returns the Channel\n\t// and a Go channel containing SSH requests. The Go channel must be\n\t// serviced otherwise the Channel will hang.\n\tAccept() (Channel, <-chan *Request, error)\n\n\t// Reject rejects the channel creation request. After calling\n\t// this, no other methods on the Channel may be called.\n\tReject(reason RejectionReason, message string) error\n\n\t// ChannelType returns the type of the channel, as supplied by the\n\t// client.\n\tChannelType() string\n\n\t// ExtraData returns the arbitrary payload for this channel, as supplied\n\t// by the client. This data is specific to the channel type.\n\tExtraData() []byte\n}\n\n// A Channel is an ordered, reliable, flow-controlled, duplex stream\n// that is multiplexed over an SSH connection.\ntype Channel interface {\n\t// Read reads up to len(data) bytes from the channel.\n\tRead(data []byte) (int, error)\n\n\t// Write writes len(data) bytes to the channel.\n\tWrite(data []byte) (int, error)\n\n\t// Close signals end of channel use. No data may be sent after this\n\t// call.\n\tClose() error\n\n\t// CloseWrite signals the end of sending in-band\n\t// data. Requests may still be sent, and the other side may\n\t// still send data\n\tCloseWrite() error\n\n\t// SendRequest sends a channel request. If wantReply is true,\n\t// it will wait for a reply and return the result as a\n\t// boolean, otherwise the return value will be false. Channel\n\t// requests are out-of-band messages so they may be sent even\n\t// if the data stream is closed or blocked by flow control.\n\t// If the channel is closed before a reply is returned, io.EOF\n\t// is returned.\n\tSendRequest(name string, wantReply bool, payload []byte) (bool, error)\n\n\t// Stderr returns an io.ReadWriter that writes to this channel\n\t// with the extended data type set to stderr. Stderr may\n\t// safely be read and written from a different goroutine than\n\t// Read and Write respectively.\n\tStderr() io.ReadWriter\n}\n\n// Request is a request sent outside of the normal stream of\n// data. Requests can either be specific to an SSH channel, or they\n// can be global.\ntype Request struct {\n\tType string\n\tWantReply bool\n\tPayload []byte\n\n\tch *channel\n\tmux *mux\n}\n\n// Reply sends a response to a request. It must be called for all requests\n// where WantReply is true and is a no-op otherwise. The payload argument is\n// ignored for replies to channel-specific requests.\nfunc (r *Request) Reply(ok bool, payload []byte) error {\n\tif !r.WantReply {\n\t\treturn nil\n\t}\n\n\tif r.ch == nil {\n\t\treturn r.mux.ackRequest(ok, payload)\n\t}\n\n\treturn r.ch.ackRequest(ok)\n}\n\n// RejectionReason is an enumeration used when rejecting channel creation\n// requests. See RFC 4254, section 5.1.\ntype RejectionReason uint32\n\nconst (\n\tProhibited RejectionReason = iota + 1\n\tConnectionFailed\n\tUnknownChannelType\n\tResourceShortage\n)\n\n// String converts the rejection reason to human readable form.\nfunc (r RejectionReason) String() string {\n\tswitch r {\n\tcase Prohibited:\n\t\treturn \"administratively prohibited\"\n\tcase ConnectionFailed:\n\t\treturn \"connect failed\"\n\tcase UnknownChannelType:\n\t\treturn \"unknown channel type\"\n\tcase ResourceShortage:\n\t\treturn \"resource shortage\"\n\t}\n\treturn fmt.Sprintf(\"unknown reason %d\", int(r))\n}\n\nfunc min(a uint32, b int) uint32 {\n\tif a < uint32(b) {\n\t\treturn a\n\t}\n\treturn uint32(b)\n}\n\ntype channelDirection uint8\n\nconst (\n\tchannelInbound channelDirection = iota\n\tchannelOutbound\n)\n\n// channel is an implementation of the Channel interface that works\n// with the mux class.\ntype channel struct {\n\t// R/O after creation\n\tchanType string\n\textraData []byte\n\tlocalId, remoteId uint32\n\n\t// maxIncomingPayload and maxRemotePayload are the maximum\n\t// payload sizes of normal and extended data packets for\n\t// receiving and sending, respectively. The wire packet will\n\t// be 9 or 13 bytes larger (excluding encryption overhead).\n\tmaxIncomingPayload uint32\n\tmaxRemotePayload uint32\n\n\tmux *mux\n\n\t// decided is set to true if an accept or reject message has been sent\n\t// (for outbound channels) or received (for inbound channels).\n\tdecided bool\n\n\t// direction contains either channelOutbound, for channels created\n\t// locally, or channelInbound, for channels created by the peer.\n\tdirection channelDirection\n\n\t// Pending internal channel messages.\n\tmsg chan interface{}\n\n\t// Since requests have no ID, there can be only one request\n\t// with WantReply=true outstanding. This lock is held by a\n\t// goroutine that has such an outgoing request pending.\n\tsentRequestMu sync.Mutex\n\n\tincomingRequests chan *Request\n\n\tsentEOF bool\n\n\t// thread-safe data\n\tremoteWin window\n\tpending *buffer\n\textPending *buffer\n\n\t// windowMu protects myWindow, the flow-control window, and myConsumed,\n\t// the number of bytes consumed since we last increased myWindow\n\twindowMu sync.Mutex\n\tmyWindow uint32\n\tmyConsumed uint32\n\n\t// writeMu serializes calls to mux.conn.writePacket() and\n\t// protects sentClose and packetPool. This mutex must be\n\t// different from windowMu, as writePacket can block if there\n\t// is a key exchange pending.\n\twriteMu sync.Mutex\n\tsentClose bool\n\n\t// packetPool has a buffer for each extended channel ID to\n\t// save allocations during writes.\n\tpacketPool map[uint32][]byte\n}\n\n// writePacket sends a packet. If the packet is a channel close, it updates\n// sentClose. This method takes the lock c.writeMu.\nfunc (ch *channel) writePacket(packet []byte) error {\n\tch.writeMu.Lock()\n\tif ch.sentClose {\n\t\tch.writeMu.Unlock()\n\t\treturn io.EOF\n\t}\n\tch.sentClose = (packet[0] == msgChannelClose)\n\terr := ch.mux.conn.writePacket(packet)\n\tch.writeMu.Unlock()\n\treturn err\n}\n\nfunc (ch *channel) sendMessage(msg interface{}) error {\n\tif debugMux {\n\t\tlog.Printf(\"send(%d): %#v\", ch.mux.chanList.offset, msg)\n\t}\n\n\tp := Marshal(msg)\n\tbinary.BigEndian.PutUint32(p[1:], ch.remoteId)\n\treturn ch.writePacket(p)\n}\n\n// WriteExtended writes data to a specific extended stream. These streams are\n// used, for example, for stderr.\nfunc (ch *channel) WriteExtended(data []byte, extendedCode uint32) (n int, err error) {\n\tif ch.sentEOF {\n\t\treturn 0, io.EOF\n\t}\n\t// 1 byte message type, 4 bytes remoteId, 4 bytes data length\n\topCode := byte(msgChannelData)\n\theaderLength := uint32(9)\n\tif extendedCode > 0 {\n\t\theaderLength += 4\n\t\topCode = msgChannelExtendedData\n\t}\n\n\tch.writeMu.Lock()\n\tpacket := ch.packetPool[extendedCode]\n\t// We don't remove the buffer from packetPool, so\n\t// WriteExtended calls from different goroutines will be\n\t// flagged as errors by the race detector.\n\tch.writeMu.Unlock()\n\n\tfor len(data) > 0 {\n\t\tspace := min(ch.maxRemotePayload, len(data))\n\t\tif space, err = ch.remoteWin.reserve(space); err != nil {\n\t\t\treturn n, err\n\t\t}\n\t\tif want := headerLength + space; uint32(cap(packet)) < want {\n\t\t\tpacket = make([]byte, want)\n\t\t} else {\n\t\t\tpacket = packet[:want]\n\t\t}\n\n\t\ttodo := data[:space]\n\n\t\tpacket[0] = opCode\n\t\tbinary.BigEndian.PutUint32(packet[1:], ch.remoteId)\n\t\tif extendedCode > 0 {\n\t\t\tbinary.BigEndian.PutUint32(packet[5:], uint32(extendedCode))\n\t\t}\n\t\tbinary.BigEndian.PutUint32(packet[headerLength-4:], uint32(len(todo)))\n\t\tcopy(packet[headerLength:], todo)\n\t\tif err = ch.writePacket(packet); err != nil {\n\t\t\treturn n, err\n\t\t}\n\n\t\tn += len(todo)\n\t\tdata = data[len(todo):]\n\t}\n\n\tch.writeMu.Lock()\n\tch.packetPool[extendedCode] = packet\n\tch.writeMu.Unlock()\n\n\treturn n, err\n}\n\nfunc (ch *channel) handleData(packet []byte) error {\n\theaderLen := 9\n\tisExtendedData := packet[0] == msgChannelExtendedData\n\tif isExtendedData {\n\t\theaderLen = 13\n\t}\n\tif len(packet) < headerLen {\n\t\t// malformed data packet\n\t\treturn parseError(packet[0])\n\t}\n\n\tvar extended uint32\n\tif isExtendedData {\n\t\textended = binary.BigEndian.Uint32(packet[5:])\n\t}\n\n\tlength := binary.BigEndian.Uint32(packet[headerLen-4 : headerLen])\n\tif length == 0 {\n\t\treturn nil\n\t}\n\tif length > ch.maxIncomingPayload {\n\t\t// TODO(hanwen): should send Disconnect?\n\t\treturn errors.New(\"ssh: incoming packet exceeds maximum payload size\")\n\t}\n\n\tdata := packet[headerLen:]\n\tif length != uint32(len(data)) {\n\t\treturn errors.New(\"ssh: wrong packet length\")\n\t}\n\n\tch.windowMu.Lock()\n\tif ch.myWindow < length {\n\t\tch.windowMu.Unlock()\n\t\t// TODO(hanwen): should send Disconnect with reason?\n\t\treturn errors.New(\"ssh: remote side wrote too much\")\n\t}\n\tch.myWindow -= length\n\tch.windowMu.Unlock()\n\n\tif extended == 1 {\n\t\tch.extPending.write(data)\n\t} else if extended > 0 {\n\t\t// discard other extended data.\n\t} else {\n\t\tch.pending.write(data)\n\t}\n\treturn nil\n}\n\nfunc (c *channel) adjustWindow(adj uint32) error {\n\tc.windowMu.Lock()\n\t// Since myConsumed and myWindow are managed on our side, and can never\n\t// exceed the initial window setting, we don't worry about overflow.\n\tc.myConsumed += adj\n\tvar sendAdj uint32\n\tif (channelWindowSize-c.myWindow > 3*c.maxIncomingPayload) ||\n\t\t(c.myWindow < channelWindowSize/2) {\n\t\tsendAdj = c.myConsumed\n\t\tc.myConsumed = 0\n\t\tc.myWindow += sendAdj\n\t}\n\tc.windowMu.Unlock()\n\tif sendAdj == 0 {\n\t\treturn nil\n\t}\n\treturn c.sendMessage(windowAdjustMsg{\n\t\tAdditionalBytes: sendAdj,\n\t})\n}\n\nfunc (c *channel) ReadExtended(data []byte, extended uint32) (n int, err error) {\n\tswitch extended {\n\tcase 1:\n\t\tn, err = c.extPending.Read(data)\n\tcase 0:\n\t\tn, err = c.pending.Read(data)\n\tdefault:\n\t\treturn 0, fmt.Errorf(\"ssh: extended code %d unimplemented\", extended)\n\t}\n\n\tif n > 0 {\n\t\terr = c.adjustWindow(uint32(n))\n\t\t// sendWindowAdjust can return io.EOF if the remote\n\t\t// peer has closed the connection, however we want to\n\t\t// defer forwarding io.EOF to the caller of Read until\n\t\t// the buffer has been drained.\n\t\tif n > 0 && err == io.EOF {\n\t\t\terr = nil\n\t\t}\n\t}\n\n\treturn n, err\n}\n\nfunc (c *channel) close() {\n\tc.pending.eof()\n\tc.extPending.eof()\n\tclose(c.msg)\n\tclose(c.incomingRequests)\n\tc.writeMu.Lock()\n\t// This is not necessary for a normal channel teardown, but if\n\t// there was another error, it is.\n\tc.sentClose = true\n\tc.writeMu.Unlock()\n\t// Unblock writers.\n\tc.remoteWin.close()\n}\n\n// responseMessageReceived is called when a success or failure message is\n// received on a channel to check that such a message is reasonable for the\n// given channel.\nfunc (ch *channel) responseMessageReceived() error {\n\tif ch.direction == channelInbound {\n\t\treturn errors.New(\"ssh: channel response message received on inbound channel\")\n\t}\n\tif ch.decided {\n\t\treturn errors.New(\"ssh: duplicate response received for channel\")\n\t}\n\tch.decided = true\n\treturn nil\n}\n\nfunc (ch *channel) handlePacket(packet []byte) error {\n\tswitch packet[0] {\n\tcase msgChannelData, msgChannelExtendedData:\n\t\treturn ch.handleData(packet)\n\tcase msgChannelClose:\n\t\tch.sendMessage(channelCloseMsg{PeersID: ch.remoteId})\n\t\tch.mux.chanList.remove(ch.localId)\n\t\tch.close()\n\t\treturn nil\n\tcase msgChannelEOF:\n\t\t// RFC 4254 is mute on how EOF affects dataExt messages but\n\t\t// it is logical to signal EOF at the same time.\n\t\tch.extPending.eof()\n\t\tch.pending.eof()\n\t\treturn nil\n\t}\n\n\tdecoded, err := decode(packet)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tswitch msg := decoded.(type) {\n\tcase *channelOpenFailureMsg:\n\t\tif err := ch.responseMessageReceived(); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tch.mux.chanList.remove(msg.PeersID)\n\t\tch.msg <- msg\n\tcase *channelOpenConfirmMsg:\n\t\tif err := ch.responseMessageReceived(); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif msg.MaxPacketSize < minPacketLength || msg.MaxPacketSize > 1<<31 {\n\t\t\treturn fmt.Errorf(\"ssh: invalid MaxPacketSize %d from peer\", msg.MaxPacketSize)\n\t\t}\n\t\tch.remoteId = msg.MyID\n\t\tch.maxRemotePayload = msg.MaxPacketSize\n\t\tch.remoteWin.add(msg.MyWindow)\n\t\tch.msg <- msg\n\tcase *windowAdjustMsg:\n\t\tif !ch.remoteWin.add(msg.AdditionalBytes) {\n\t\t\treturn fmt.Errorf(\"ssh: invalid window update for %d bytes\", msg.AdditionalBytes)\n\t\t}\n\tcase *channelRequestMsg:\n\t\treq := Request{\n\t\t\tType: msg.Request,\n\t\t\tWantReply: msg.WantReply,\n\t\t\tPayload: msg.RequestSpecificData,\n\t\t\tch: ch,\n\t\t}\n\n\t\tch.incomingRequests <- &req\n\tdefault:\n\t\tch.msg <- msg\n\t}\n\treturn nil\n}\n\nfunc (m *mux) newChannel(chanType string, direction channelDirection, extraData []byte) *channel {\n\tch := &channel{\n\t\tremoteWin: window{Cond: newCond()},\n\t\tmyWindow: channelWindowSize,\n\t\tpending: newBuffer(),\n\t\textPending: newBuffer(),\n\t\tdirection: direction,\n\t\tincomingRequests: make(chan *Request, chanSize),\n\t\tmsg: make(chan interface{}, chanSize),\n\t\tchanType: chanType,\n\t\textraData: extraData,\n\t\tmux: m,\n\t\tpacketPool: make(map[uint32][]byte),\n\t}\n\tch.localId = m.chanList.add(ch)\n\treturn ch\n}\n\nvar errUndecided = errors.New(\"ssh: must Accept or Reject channel\")\nvar errDecidedAlready = errors.New(\"ssh: can call Accept or Reject only once\")\n\ntype extChannel struct {\n\tcode uint32\n\tch *channel\n}\n\nfunc (e *extChannel) Write(data []byte) (n int, err error) {\n\treturn e.ch.WriteExtended(data, e.code)\n}\n\nfunc (e *extChannel) Read(data []byte) (n int, err error) {\n\treturn e.ch.ReadExtended(data, e.code)\n}\n\nfunc (ch *channel) Accept() (Channel, <-chan *Request, error) {\n\tif ch.decided {\n\t\treturn nil, nil, errDecidedAlready\n\t}\n\tch.maxIncomingPayload = channelMaxPacket\n\tconfirm := channelOpenConfirmMsg{\n\t\tPeersID: ch.remoteId,\n\t\tMyID: ch.localId,\n\t\tMyWindow: ch.myWindow,\n\t\tMaxPacketSize: ch.maxIncomingPayload,\n\t}\n\tch.decided = true\n\tif err := ch.sendMessage(confirm); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\treturn ch, ch.incomingRequests, nil\n}\n\nfunc (ch *channel) Reject(reason RejectionReason, message string) error {\n\tif ch.decided {\n\t\treturn errDecidedAlready\n\t}\n\treject := channelOpenFailureMsg{\n\t\tPeersID: ch.remoteId,\n\t\tReason: reason,\n\t\tMessage: message,\n\t\tLanguage: \"en\",\n\t}\n\tch.decided = true\n\treturn ch.sendMessage(reject)\n}\n\nfunc (ch *channel) Read(data []byte) (int, error) {\n\tif !ch.decided {\n\t\treturn 0, errUndecided\n\t}\n\treturn ch.ReadExtended(data, 0)\n}\n\nfunc (ch *channel) Write(data []byte) (int, error) {\n\tif !ch.decided {\n\t\treturn 0, errUndecided\n\t}\n\treturn ch.WriteExtended(data, 0)\n}\n\nfunc (ch *channel) CloseWrite() error {\n\tif !ch.decided {\n\t\treturn errUndecided\n\t}\n\tch.sentEOF = true\n\treturn ch.sendMessage(channelEOFMsg{\n\t\tPeersID: ch.remoteId})\n}\n\nfunc (ch *channel) Close() error {\n\tif !ch.decided {\n\t\treturn errUndecided\n\t}\n\n\treturn ch.sendMessage(channelCloseMsg{\n\t\tPeersID: ch.remoteId})\n}\n\n// Extended returns an io.ReadWriter that sends and receives data on the given,\n// SSH extended stream. Such streams are used, for example, for stderr.\nfunc (ch *channel) Extended(code uint32) io.ReadWriter {\n\tif !ch.decided {\n\t\treturn nil\n\t}\n\treturn &extChannel{code, ch}\n}\n\nfunc (ch *channel) Stderr() io.ReadWriter {\n\treturn ch.Extended(1)\n}\n\nfunc (ch *channel) SendRequest(name string, wantReply bool, payload []byte) (bool, error) {\n\tif !ch.decided {\n\t\treturn false, errUndecided\n\t}\n\n\tif wantReply {\n\t\tch.sentRequestMu.Lock()\n\t\tdefer ch.sentRequestMu.Unlock()\n\t}\n\n\tmsg := channelRequestMsg{\n\t\tPeersID: ch.remoteId,\n\t\tRequest: name,\n\t\tWantReply: wantReply,\n\t\tRequestSpecificData: payload,\n\t}\n\n\tif err := ch.sendMessage(msg); err != nil {\n\t\treturn false, err\n\t}\n\n\tif wantReply {\n\t\tm, ok := (<-ch.msg)\n\t\tif !ok {\n\t\t\treturn false, io.EOF\n\t\t}\n\t\tswitch m.(type) {\n\t\tcase *channelRequestFailureMsg:\n\t\t\treturn false, nil\n\t\tcase *channelRequestSuccessMsg:\n\t\t\treturn true, nil\n\t\tdefault:\n\t\t\treturn false, fmt.Errorf(\"ssh: unexpected response to channel request: %#v\", m)\n\t\t}\n\t}\n\n\treturn false, nil\n}\n\n// ackRequest either sends an ack or nack to the channel request.\nfunc (ch *channel) ackRequest(ok bool) error {\n\tif !ch.decided {\n\t\treturn errUndecided\n\t}\n\n\tvar msg interface{}\n\tif !ok {\n\t\tmsg = channelRequestFailureMsg{\n\t\t\tPeersID: ch.remoteId,\n\t\t}\n\t} else {\n\t\tmsg = channelRequestSuccessMsg{\n\t\t\tPeersID: ch.remoteId,\n\t\t}\n\t}\n\treturn ch.sendMessage(msg)\n}\n\nfunc (ch *channel) ChannelType() string {\n\treturn ch.chanType\n}\n\nfunc (ch *channel) ExtraData() []byte {\n\treturn ch.extraData\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/cipher.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"crypto/aes\"\n\t\"crypto/cipher\"\n\t\"crypto/des\"\n\t\"crypto/fips140\"\n\t\"crypto/rc4\"\n\t\"crypto/subtle\"\n\t\"encoding/binary\"\n\t\"errors\"\n\t\"fmt\"\n\t\"hash\"\n\t\"io\"\n\t\"slices\"\n\n\t\"golang.org/x/crypto/chacha20\"\n\t\"golang.org/x/crypto/internal/poly1305\"\n)\n\nconst (\n\tpacketSizeMultiple = 16 // TODO(huin) this should be determined by the cipher.\n\n\t// RFC 4253 section 6.1 defines a minimum packet size of 32768 that implementations\n\t// MUST be able to process (plus a few more kilobytes for padding and mac). The RFC\n\t// indicates implementations SHOULD be able to handle larger packet sizes, but then\n\t// waffles on about reasonable limits.\n\t//\n\t// OpenSSH caps their maxPacket at 256kB so we choose to do\n\t// the same. maxPacket is also used to ensure that uint32\n\t// length fields do not overflow, so it should remain well\n\t// below 4G.\n\tmaxPacket = 256 * 1024\n)\n\n// noneCipher implements cipher.Stream and provides no encryption. It is used\n// by the transport before the first key-exchange.\ntype noneCipher struct{}\n\nfunc (c noneCipher) XORKeyStream(dst, src []byte) {\n\tcopy(dst, src)\n}\n\nfunc newAESCTR(key, iv []byte) (cipher.Stream, error) {\n\tc, err := aes.NewCipher(key)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn cipher.NewCTR(c, iv), nil\n}\n\nfunc newRC4(key, iv []byte) (cipher.Stream, error) {\n\treturn rc4.NewCipher(key)\n}\n\ntype cipherMode struct {\n\tkeySize int\n\tivSize int\n\tcreate func(key, iv []byte, macKey []byte, algs DirectionAlgorithms) (packetCipher, error)\n}\n\nfunc streamCipherMode(skip int, createFunc func(key, iv []byte) (cipher.Stream, error)) func(key, iv []byte, macKey []byte, algs DirectionAlgorithms) (packetCipher, error) {\n\treturn func(key, iv, macKey []byte, algs DirectionAlgorithms) (packetCipher, error) {\n\t\tstream, err := createFunc(key, iv)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tvar streamDump []byte\n\t\tif skip > 0 {\n\t\t\tstreamDump = make([]byte, 512)\n\t\t}\n\n\t\tfor remainingToDump := skip; remainingToDump > 0; {\n\t\t\tdumpThisTime := remainingToDump\n\t\t\tif dumpThisTime > len(streamDump) {\n\t\t\t\tdumpThisTime = len(streamDump)\n\t\t\t}\n\t\t\tstream.XORKeyStream(streamDump[:dumpThisTime], streamDump[:dumpThisTime])\n\t\t\tremainingToDump -= dumpThisTime\n\t\t}\n\n\t\tmac := macModes[algs.MAC].new(macKey)\n\t\treturn &streamPacketCipher{\n\t\t\tmac: mac,\n\t\t\tetm: macModes[algs.MAC].etm,\n\t\t\tmacResult: make([]byte, mac.Size()),\n\t\t\tcipher: stream,\n\t\t}, nil\n\t}\n}\n\n// cipherModes documents properties of supported ciphers. Ciphers not included\n// are not supported and will not be negotiated, even if explicitly configured.\n// When FIPS mode is enabled, only FIPS-approved algorithms are included.\nvar cipherModes = map[string]*cipherMode{}\n\nfunc init() {\n\tcipherModes[CipherAES128CTR] = &cipherMode{16, aes.BlockSize, streamCipherMode(0, newAESCTR)}\n\tcipherModes[CipherAES192CTR] = &cipherMode{24, aes.BlockSize, streamCipherMode(0, newAESCTR)}\n\tcipherModes[CipherAES256CTR] = &cipherMode{32, aes.BlockSize, streamCipherMode(0, newAESCTR)}\n\t// Use of GCM with arbitrary IVs is not allowed in FIPS 140-only mode,\n\t// we'll wire it up to NewGCMForSSH in Go 1.26.\n\t//\n\t// For now it means we'll work with fips140=on but not fips140=only.\n\tcipherModes[CipherAES128GCM] = &cipherMode{16, 12, newGCMCipher}\n\tcipherModes[CipherAES256GCM] = &cipherMode{32, 12, newGCMCipher}\n\n\tif fips140.Enabled() {\n\t\tdefaultCiphers = slices.DeleteFunc(defaultCiphers, func(algo string) bool {\n\t\t\t_, ok := cipherModes[algo]\n\t\t\treturn !ok\n\t\t})\n\t\treturn\n\t}\n\n\tcipherModes[CipherChaCha20Poly1305] = &cipherMode{64, 0, newChaCha20Cipher}\n\t// Insecure ciphers not included in the default configuration.\n\tcipherModes[InsecureCipherRC4128] = &cipherMode{16, 0, streamCipherMode(1536, newRC4)}\n\tcipherModes[InsecureCipherRC4256] = &cipherMode{32, 0, streamCipherMode(1536, newRC4)}\n\tcipherModes[InsecureCipherRC4] = &cipherMode{16, 0, streamCipherMode(0, newRC4)}\n\t// CBC mode is insecure and so is not included in the default config.\n\t// (See https://www.ieee-security.org/TC/SP2013/papers/4977a526.pdf). If absolutely\n\t// needed, it's possible to specify a custom Config to enable it.\n\t// You should expect that an active attacker can recover plaintext if\n\t// you do.\n\tcipherModes[InsecureCipherAES128CBC] = &cipherMode{16, aes.BlockSize, newAESCBCCipher}\n\tcipherModes[InsecureCipherTripleDESCBC] = &cipherMode{24, des.BlockSize, newTripleDESCBCCipher}\n}\n\n// prefixLen is the length of the packet prefix that contains the packet length\n// and number of padding bytes.\nconst prefixLen = 5\n\n// streamPacketCipher is a packetCipher using a stream cipher.\ntype streamPacketCipher struct {\n\tmac hash.Hash\n\tcipher cipher.Stream\n\tetm bool\n\n\t// The following members are to avoid per-packet allocations.\n\tprefix [prefixLen]byte\n\tseqNumBytes [4]byte\n\tpadding [2 * packetSizeMultiple]byte\n\tpacketData []byte\n\tmacResult []byte\n}\n\n// readCipherPacket reads and decrypt a single packet from the reader argument.\nfunc (s *streamPacketCipher) readCipherPacket(seqNum uint32, r io.Reader) ([]byte, error) {\n\tif _, err := io.ReadFull(r, s.prefix[:]); err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar encryptedPaddingLength [1]byte\n\tif s.mac != nil && s.etm {\n\t\tcopy(encryptedPaddingLength[:], s.prefix[4:5])\n\t\ts.cipher.XORKeyStream(s.prefix[4:5], s.prefix[4:5])\n\t} else {\n\t\ts.cipher.XORKeyStream(s.prefix[:], s.prefix[:])\n\t}\n\n\tlength := binary.BigEndian.Uint32(s.prefix[0:4])\n\tpaddingLength := uint32(s.prefix[4])\n\n\tvar macSize uint32\n\tif s.mac != nil {\n\t\ts.mac.Reset()\n\t\tbinary.BigEndian.PutUint32(s.seqNumBytes[:], seqNum)\n\t\ts.mac.Write(s.seqNumBytes[:])\n\t\tif s.etm {\n\t\t\ts.mac.Write(s.prefix[:4])\n\t\t\ts.mac.Write(encryptedPaddingLength[:])\n\t\t} else {\n\t\t\ts.mac.Write(s.prefix[:])\n\t\t}\n\t\tmacSize = uint32(s.mac.Size())\n\t}\n\n\tif length <= paddingLength+1 {\n\t\treturn nil, errors.New(\"ssh: invalid packet length, packet too small\")\n\t}\n\n\tif length > maxPacket {\n\t\treturn nil, errors.New(\"ssh: invalid packet length, packet too large\")\n\t}\n\n\t// the maxPacket check above ensures that length-1+macSize\n\t// does not overflow.\n\tif uint32(cap(s.packetData)) < length-1+macSize {\n\t\ts.packetData = make([]byte, length-1+macSize)\n\t} else {\n\t\ts.packetData = s.packetData[:length-1+macSize]\n\t}\n\n\tif _, err := io.ReadFull(r, s.packetData); err != nil {\n\t\treturn nil, err\n\t}\n\tmac := s.packetData[length-1:]\n\tdata := s.packetData[:length-1]\n\n\tif s.mac != nil && s.etm {\n\t\ts.mac.Write(data)\n\t}\n\n\ts.cipher.XORKeyStream(data, data)\n\n\tif s.mac != nil {\n\t\tif !s.etm {\n\t\t\ts.mac.Write(data)\n\t\t}\n\t\ts.macResult = s.mac.Sum(s.macResult[:0])\n\t\tif subtle.ConstantTimeCompare(s.macResult, mac) != 1 {\n\t\t\treturn nil, errors.New(\"ssh: MAC failure\")\n\t\t}\n\t}\n\n\treturn s.packetData[:length-paddingLength-1], nil\n}\n\n// writeCipherPacket encrypts and sends a packet of data to the writer argument\nfunc (s *streamPacketCipher) writeCipherPacket(seqNum uint32, w io.Writer, rand io.Reader, packet []byte) error {\n\tif len(packet) > maxPacket {\n\t\treturn errors.New(\"ssh: packet too large\")\n\t}\n\n\taadlen := 0\n\tif s.mac != nil && s.etm {\n\t\t// packet length is not encrypted for EtM modes\n\t\taadlen = 4\n\t}\n\n\tpaddingLength := packetSizeMultiple - (prefixLen+len(packet)-aadlen)%packetSizeMultiple\n\tif paddingLength < 4 {\n\t\tpaddingLength += packetSizeMultiple\n\t}\n\n\tlength := len(packet) + 1 + paddingLength\n\tbinary.BigEndian.PutUint32(s.prefix[:], uint32(length))\n\ts.prefix[4] = byte(paddingLength)\n\tpadding := s.padding[:paddingLength]\n\tif _, err := io.ReadFull(rand, padding); err != nil {\n\t\treturn err\n\t}\n\n\tif s.mac != nil {\n\t\ts.mac.Reset()\n\t\tbinary.BigEndian.PutUint32(s.seqNumBytes[:], seqNum)\n\t\ts.mac.Write(s.seqNumBytes[:])\n\n\t\tif s.etm {\n\t\t\t// For EtM algorithms, the packet length must stay unencrypted,\n\t\t\t// but the following data (padding length) must be encrypted\n\t\t\ts.cipher.XORKeyStream(s.prefix[4:5], s.prefix[4:5])\n\t\t}\n\n\t\ts.mac.Write(s.prefix[:])\n\n\t\tif !s.etm {\n\t\t\t// For non-EtM algorithms, the algorithm is applied on unencrypted data\n\t\t\ts.mac.Write(packet)\n\t\t\ts.mac.Write(padding)\n\t\t}\n\t}\n\n\tif !(s.mac != nil && s.etm) {\n\t\t// For EtM algorithms, the padding length has already been encrypted\n\t\t// and the packet length must remain unencrypted\n\t\ts.cipher.XORKeyStream(s.prefix[:], s.prefix[:])\n\t}\n\n\ts.cipher.XORKeyStream(packet, packet)\n\ts.cipher.XORKeyStream(padding, padding)\n\n\tif s.mac != nil && s.etm {\n\t\t// For EtM algorithms, packet and padding must be encrypted\n\t\ts.mac.Write(packet)\n\t\ts.mac.Write(padding)\n\t}\n\n\tif _, err := w.Write(s.prefix[:]); err != nil {\n\t\treturn err\n\t}\n\tif _, err := w.Write(packet); err != nil {\n\t\treturn err\n\t}\n\tif _, err := w.Write(padding); err != nil {\n\t\treturn err\n\t}\n\n\tif s.mac != nil {\n\t\ts.macResult = s.mac.Sum(s.macResult[:0])\n\t\tif _, err := w.Write(s.macResult); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\treturn nil\n}\n\ntype gcmCipher struct {\n\taead cipher.AEAD\n\tprefix [4]byte\n\tiv []byte\n\tbuf []byte\n}\n\nfunc newGCMCipher(key, iv, unusedMacKey []byte, unusedAlgs DirectionAlgorithms) (packetCipher, error) {\n\tc, err := aes.NewCipher(key)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\taead, err := cipher.NewGCM(c)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn &gcmCipher{\n\t\taead: aead,\n\t\tiv: iv,\n\t}, nil\n}\n\nconst gcmTagSize = 16\n\nfunc (c *gcmCipher) writeCipherPacket(seqNum uint32, w io.Writer, rand io.Reader, packet []byte) error {\n\t// Pad out to multiple of 16 bytes. This is different from the\n\t// stream cipher because that encrypts the length too.\n\tpadding := byte(packetSizeMultiple - (1+len(packet))%packetSizeMultiple)\n\tif padding < 4 {\n\t\tpadding += packetSizeMultiple\n\t}\n\n\tlength := uint32(len(packet) + int(padding) + 1)\n\tbinary.BigEndian.PutUint32(c.prefix[:], length)\n\tif _, err := w.Write(c.prefix[:]); err != nil {\n\t\treturn err\n\t}\n\n\tif cap(c.buf) < int(length) {\n\t\tc.buf = make([]byte, length)\n\t} else {\n\t\tc.buf = c.buf[:length]\n\t}\n\n\tc.buf[0] = padding\n\tcopy(c.buf[1:], packet)\n\tif _, err := io.ReadFull(rand, c.buf[1+len(packet):]); err != nil {\n\t\treturn err\n\t}\n\tc.buf = c.aead.Seal(c.buf[:0], c.iv, c.buf, c.prefix[:])\n\tif _, err := w.Write(c.buf); err != nil {\n\t\treturn err\n\t}\n\tc.incIV()\n\n\treturn nil\n}\n\nfunc (c *gcmCipher) incIV() {\n\tfor i := 4 + 7; i >= 4; i-- {\n\t\tc.iv[i]++\n\t\tif c.iv[i] != 0 {\n\t\t\tbreak\n\t\t}\n\t}\n}\n\nfunc (c *gcmCipher) readCipherPacket(seqNum uint32, r io.Reader) ([]byte, error) {\n\tif _, err := io.ReadFull(r, c.prefix[:]); err != nil {\n\t\treturn nil, err\n\t}\n\tlength := binary.BigEndian.Uint32(c.prefix[:])\n\tif length > maxPacket {\n\t\treturn nil, errors.New(\"ssh: max packet length exceeded\")\n\t}\n\n\tif cap(c.buf) < int(length+gcmTagSize) {\n\t\tc.buf = make([]byte, length+gcmTagSize)\n\t} else {\n\t\tc.buf = c.buf[:length+gcmTagSize]\n\t}\n\n\tif _, err := io.ReadFull(r, c.buf); err != nil {\n\t\treturn nil, err\n\t}\n\n\tplain, err := c.aead.Open(c.buf[:0], c.iv, c.buf, c.prefix[:])\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tc.incIV()\n\n\tif len(plain) == 0 {\n\t\treturn nil, errors.New(\"ssh: empty packet\")\n\t}\n\n\tpadding := plain[0]\n\tif padding < 4 {\n\t\t// padding is a byte, so it automatically satisfies\n\t\t// the maximum size, which is 255.\n\t\treturn nil, fmt.Errorf(\"ssh: illegal padding %d\", padding)\n\t}\n\n\tif int(padding+1) >= len(plain) {\n\t\treturn nil, fmt.Errorf(\"ssh: padding %d too large\", padding)\n\t}\n\tplain = plain[1 : length-uint32(padding)]\n\treturn plain, nil\n}\n\n// cbcCipher implements aes128-cbc cipher defined in RFC 4253 section 6.1\ntype cbcCipher struct {\n\tmac hash.Hash\n\tmacSize uint32\n\tdecrypter cipher.BlockMode\n\tencrypter cipher.BlockMode\n\n\t// The following members are to avoid per-packet allocations.\n\tseqNumBytes [4]byte\n\tpacketData []byte\n\tmacResult []byte\n\n\t// Amount of data we should still read to hide which\n\t// verification error triggered.\n\toracleCamouflage uint32\n}\n\nfunc newCBCCipher(c cipher.Block, key, iv, macKey []byte, algs DirectionAlgorithms) (packetCipher, error) {\n\tcbc := &cbcCipher{\n\t\tmac: macModes[algs.MAC].new(macKey),\n\t\tdecrypter: cipher.NewCBCDecrypter(c, iv),\n\t\tencrypter: cipher.NewCBCEncrypter(c, iv),\n\t\tpacketData: make([]byte, 1024),\n\t}\n\tif cbc.mac != nil {\n\t\tcbc.macSize = uint32(cbc.mac.Size())\n\t}\n\n\treturn cbc, nil\n}\n\nfunc newAESCBCCipher(key, iv, macKey []byte, algs DirectionAlgorithms) (packetCipher, error) {\n\tc, err := aes.NewCipher(key)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tcbc, err := newCBCCipher(c, key, iv, macKey, algs)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn cbc, nil\n}\n\nfunc newTripleDESCBCCipher(key, iv, macKey []byte, algs DirectionAlgorithms) (packetCipher, error) {\n\tc, err := des.NewTripleDESCipher(key)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tcbc, err := newCBCCipher(c, key, iv, macKey, algs)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn cbc, nil\n}\n\nfunc maxUInt32(a, b int) uint32 {\n\tif a > b {\n\t\treturn uint32(a)\n\t}\n\treturn uint32(b)\n}\n\nconst (\n\tcbcMinPacketSizeMultiple = 8\n\tcbcMinPacketSize = 16\n\tcbcMinPaddingSize = 4\n)\n\n// cbcError represents a verification error that may leak information.\ntype cbcError string\n\nfunc (e cbcError) Error() string { return string(e) }\n\nfunc (c *cbcCipher) readCipherPacket(seqNum uint32, r io.Reader) ([]byte, error) {\n\tp, err := c.readCipherPacketLeaky(seqNum, r)\n\tif err != nil {\n\t\tif _, ok := err.(cbcError); ok {\n\t\t\t// Verification error: read a fixed amount of\n\t\t\t// data, to make distinguishing between\n\t\t\t// failing MAC and failing length check more\n\t\t\t// difficult.\n\t\t\tio.CopyN(io.Discard, r, int64(c.oracleCamouflage))\n\t\t}\n\t}\n\treturn p, err\n}\n\nfunc (c *cbcCipher) readCipherPacketLeaky(seqNum uint32, r io.Reader) ([]byte, error) {\n\tblockSize := c.decrypter.BlockSize()\n\n\t// Read the header, which will include some of the subsequent data in the\n\t// case of block ciphers - this is copied back to the payload later.\n\t// How many bytes of payload/padding will be read with this first read.\n\tfirstBlockLength := uint32((prefixLen + blockSize - 1) / blockSize * blockSize)\n\tfirstBlock := c.packetData[:firstBlockLength]\n\tif _, err := io.ReadFull(r, firstBlock); err != nil {\n\t\treturn nil, err\n\t}\n\n\tc.oracleCamouflage = maxPacket + 4 + c.macSize - firstBlockLength\n\n\tc.decrypter.CryptBlocks(firstBlock, firstBlock)\n\tlength := binary.BigEndian.Uint32(firstBlock[:4])\n\tif length > maxPacket {\n\t\treturn nil, cbcError(\"ssh: packet too large\")\n\t}\n\tif length+4 < maxUInt32(cbcMinPacketSize, blockSize) {\n\t\t// The minimum size of a packet is 16 (or the cipher block size, whichever\n\t\t// is larger) bytes.\n\t\treturn nil, cbcError(\"ssh: packet too small\")\n\t}\n\t// The length of the packet (including the length field but not the MAC) must\n\t// be a multiple of the block size or 8, whichever is larger.\n\tif (length+4)%maxUInt32(cbcMinPacketSizeMultiple, blockSize) != 0 {\n\t\treturn nil, cbcError(\"ssh: invalid packet length multiple\")\n\t}\n\n\tpaddingLength := uint32(firstBlock[4])\n\tif paddingLength < cbcMinPaddingSize || length <= paddingLength+1 {\n\t\treturn nil, cbcError(\"ssh: invalid packet length\")\n\t}\n\n\t// Positions within the c.packetData buffer:\n\tmacStart := 4 + length\n\tpaddingStart := macStart - paddingLength\n\n\t// Entire packet size, starting before length, ending at end of mac.\n\tentirePacketSize := macStart + c.macSize\n\n\t// Ensure c.packetData is large enough for the entire packet data.\n\tif uint32(cap(c.packetData)) < entirePacketSize {\n\t\t// Still need to upsize and copy, but this should be rare at runtime, only\n\t\t// on upsizing the packetData buffer.\n\t\tc.packetData = make([]byte, entirePacketSize)\n\t\tcopy(c.packetData, firstBlock)\n\t} else {\n\t\tc.packetData = c.packetData[:entirePacketSize]\n\t}\n\n\tn, err := io.ReadFull(r, c.packetData[firstBlockLength:])\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tc.oracleCamouflage -= uint32(n)\n\n\tremainingCrypted := c.packetData[firstBlockLength:macStart]\n\tc.decrypter.CryptBlocks(remainingCrypted, remainingCrypted)\n\n\tmac := c.packetData[macStart:]\n\tif c.mac != nil {\n\t\tc.mac.Reset()\n\t\tbinary.BigEndian.PutUint32(c.seqNumBytes[:], seqNum)\n\t\tc.mac.Write(c.seqNumBytes[:])\n\t\tc.mac.Write(c.packetData[:macStart])\n\t\tc.macResult = c.mac.Sum(c.macResult[:0])\n\t\tif subtle.ConstantTimeCompare(c.macResult, mac) != 1 {\n\t\t\treturn nil, cbcError(\"ssh: MAC failure\")\n\t\t}\n\t}\n\n\treturn c.packetData[prefixLen:paddingStart], nil\n}\n\nfunc (c *cbcCipher) writeCipherPacket(seqNum uint32, w io.Writer, rand io.Reader, packet []byte) error {\n\teffectiveBlockSize := maxUInt32(cbcMinPacketSizeMultiple, c.encrypter.BlockSize())\n\n\t// Length of encrypted portion of the packet (header, payload, padding).\n\t// Enforce minimum padding and packet size.\n\tencLength := maxUInt32(prefixLen+len(packet)+cbcMinPaddingSize, cbcMinPaddingSize)\n\t// Enforce block size.\n\tencLength = (encLength + effectiveBlockSize - 1) / effectiveBlockSize * effectiveBlockSize\n\n\tlength := encLength - 4\n\tpaddingLength := int(length) - (1 + len(packet))\n\n\t// Overall buffer contains: header, payload, padding, mac.\n\t// Space for the MAC is reserved in the capacity but not the slice length.\n\tbufferSize := encLength + c.macSize\n\tif uint32(cap(c.packetData)) < bufferSize {\n\t\tc.packetData = make([]byte, encLength, bufferSize)\n\t} else {\n\t\tc.packetData = c.packetData[:encLength]\n\t}\n\n\tp := c.packetData\n\n\t// Packet header.\n\tbinary.BigEndian.PutUint32(p, length)\n\tp = p[4:]\n\tp[0] = byte(paddingLength)\n\n\t// Payload.\n\tp = p[1:]\n\tcopy(p, packet)\n\n\t// Padding.\n\tp = p[len(packet):]\n\tif _, err := io.ReadFull(rand, p); err != nil {\n\t\treturn err\n\t}\n\n\tif c.mac != nil {\n\t\tc.mac.Reset()\n\t\tbinary.BigEndian.PutUint32(c.seqNumBytes[:], seqNum)\n\t\tc.mac.Write(c.seqNumBytes[:])\n\t\tc.mac.Write(c.packetData)\n\t\t// The MAC is now appended into the capacity reserved for it earlier.\n\t\tc.packetData = c.mac.Sum(c.packetData)\n\t}\n\n\tc.encrypter.CryptBlocks(c.packetData[:encLength], c.packetData[:encLength])\n\n\tif _, err := w.Write(c.packetData); err != nil {\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// chacha20Poly1305Cipher implements the chacha20-poly1305@openssh.com\n// AEAD, which is described here:\n//\n//\thttps://tools.ietf.org/html/draft-josefsson-ssh-chacha20-poly1305-openssh-00\n//\n// the methods here also implement padding, which RFC 4253 Section 6\n// also requires of stream ciphers.\ntype chacha20Poly1305Cipher struct {\n\tlengthKey [32]byte\n\tcontentKey [32]byte\n\tbuf []byte\n}\n\nfunc newChaCha20Cipher(key, unusedIV, unusedMACKey []byte, unusedAlgs DirectionAlgorithms) (packetCipher, error) {\n\tif len(key) != 64 {\n\t\tpanic(len(key))\n\t}\n\n\tc := &chacha20Poly1305Cipher{\n\t\tbuf: make([]byte, 256),\n\t}\n\n\tcopy(c.contentKey[:], key[:32])\n\tcopy(c.lengthKey[:], key[32:])\n\treturn c, nil\n}\n\nfunc (c *chacha20Poly1305Cipher) readCipherPacket(seqNum uint32, r io.Reader) ([]byte, error) {\n\tnonce := make([]byte, 12)\n\tbinary.BigEndian.PutUint32(nonce[8:], seqNum)\n\ts, err := chacha20.NewUnauthenticatedCipher(c.contentKey[:], nonce)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar polyKey, discardBuf [32]byte\n\ts.XORKeyStream(polyKey[:], polyKey[:])\n\ts.XORKeyStream(discardBuf[:], discardBuf[:]) // skip the next 32 bytes\n\n\tencryptedLength := c.buf[:4]\n\tif _, err := io.ReadFull(r, encryptedLength); err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar lenBytes [4]byte\n\tls, err := chacha20.NewUnauthenticatedCipher(c.lengthKey[:], nonce)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tls.XORKeyStream(lenBytes[:], encryptedLength)\n\n\tlength := binary.BigEndian.Uint32(lenBytes[:])\n\tif length > maxPacket {\n\t\treturn nil, errors.New(\"ssh: invalid packet length, packet too large\")\n\t}\n\n\tcontentEnd := 4 + length\n\tpacketEnd := contentEnd + poly1305.TagSize\n\tif uint32(cap(c.buf)) < packetEnd {\n\t\tc.buf = make([]byte, packetEnd)\n\t\tcopy(c.buf[:], encryptedLength)\n\t} else {\n\t\tc.buf = c.buf[:packetEnd]\n\t}\n\n\tif _, err := io.ReadFull(r, c.buf[4:packetEnd]); err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar mac [poly1305.TagSize]byte\n\tcopy(mac[:], c.buf[contentEnd:packetEnd])\n\tif !poly1305.Verify(&mac, c.buf[:contentEnd], &polyKey) {\n\t\treturn nil, errors.New(\"ssh: MAC failure\")\n\t}\n\n\tplain := c.buf[4:contentEnd]\n\ts.XORKeyStream(plain, plain)\n\n\tif len(plain) == 0 {\n\t\treturn nil, errors.New(\"ssh: empty packet\")\n\t}\n\n\tpadding := plain[0]\n\tif padding < 4 {\n\t\t// padding is a byte, so it automatically satisfies\n\t\t// the maximum size, which is 255.\n\t\treturn nil, fmt.Errorf(\"ssh: illegal padding %d\", padding)\n\t}\n\n\tif int(padding)+1 >= len(plain) {\n\t\treturn nil, fmt.Errorf(\"ssh: padding %d too large\", padding)\n\t}\n\n\tplain = plain[1 : len(plain)-int(padding)]\n\n\treturn plain, nil\n}\n\nfunc (c *chacha20Poly1305Cipher) writeCipherPacket(seqNum uint32, w io.Writer, rand io.Reader, payload []byte) error {\n\tnonce := make([]byte, 12)\n\tbinary.BigEndian.PutUint32(nonce[8:], seqNum)\n\ts, err := chacha20.NewUnauthenticatedCipher(c.contentKey[:], nonce)\n\tif err != nil {\n\t\treturn err\n\t}\n\tvar polyKey, discardBuf [32]byte\n\ts.XORKeyStream(polyKey[:], polyKey[:])\n\ts.XORKeyStream(discardBuf[:], discardBuf[:]) // skip the next 32 bytes\n\n\t// There is no blocksize, so fall back to multiple of 8 byte\n\t// padding, as described in RFC 4253, Sec 6.\n\tconst packetSizeMultiple = 8\n\n\tpadding := packetSizeMultiple - (1+len(payload))%packetSizeMultiple\n\tif padding < 4 {\n\t\tpadding += packetSizeMultiple\n\t}\n\n\t// size (4 bytes), padding (1), payload, padding, tag.\n\ttotalLength := 4 + 1 + len(payload) + padding + poly1305.TagSize\n\tif cap(c.buf) < totalLength {\n\t\tc.buf = make([]byte, totalLength)\n\t} else {\n\t\tc.buf = c.buf[:totalLength]\n\t}\n\n\tbinary.BigEndian.PutUint32(c.buf, uint32(1+len(payload)+padding))\n\tls, err := chacha20.NewUnauthenticatedCipher(c.lengthKey[:], nonce)\n\tif err != nil {\n\t\treturn err\n\t}\n\tls.XORKeyStream(c.buf, c.buf[:4])\n\tc.buf[4] = byte(padding)\n\tcopy(c.buf[5:], payload)\n\tpacketEnd := 5 + len(payload) + padding\n\tif _, err := io.ReadFull(rand, c.buf[5+len(payload):packetEnd]); err != nil {\n\t\treturn err\n\t}\n\n\ts.XORKeyStream(c.buf[4:], c.buf[4:packetEnd])\n\n\tvar mac [poly1305.TagSize]byte\n\tpoly1305.Sum(&mac, c.buf[:packetEnd], &polyKey)\n\n\tcopy(c.buf[packetEnd:], mac[:])\n\n\tif _, err := w.Write(c.buf); err != nil {\n\t\treturn err\n\t}\n\treturn nil\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/client.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\t\"net\"\n\t\"os\"\n\t\"sync\"\n\t\"time\"\n)\n\n// Client implements a traditional SSH client that supports shells,\n// subprocesses, TCP port/streamlocal forwarding and tunneled dialing.\ntype Client struct {\n\tConn\n\n\thandleForwardsOnce sync.Once // guards calling (*Client).handleForwards\n\n\tforwards forwardList // forwarded tcpip connections from the remote side\n\tmu sync.Mutex\n\tchannelHandlers map[string]chan NewChannel\n}\n\n// HandleChannelOpen returns a channel on which NewChannel requests\n// for the given type are sent. If the type already is being handled,\n// nil is returned. The channel is closed when the connection is closed.\nfunc (c *Client) HandleChannelOpen(channelType string) <-chan NewChannel {\n\tc.mu.Lock()\n\tdefer c.mu.Unlock()\n\tif c.channelHandlers == nil {\n\t\t// The SSH channel has been closed.\n\t\tc := make(chan NewChannel)\n\t\tclose(c)\n\t\treturn c\n\t}\n\n\tch := c.channelHandlers[channelType]\n\tif ch != nil {\n\t\treturn nil\n\t}\n\n\tch = make(chan NewChannel, chanSize)\n\tc.channelHandlers[channelType] = ch\n\treturn ch\n}\n\n// NewClient creates a Client on top of the given connection.\nfunc NewClient(c Conn, chans <-chan NewChannel, reqs <-chan *Request) *Client {\n\tconn := &Client{\n\t\tConn: c,\n\t\tchannelHandlers: make(map[string]chan NewChannel, 1),\n\t}\n\n\tgo conn.handleGlobalRequests(reqs)\n\tgo conn.handleChannelOpens(chans)\n\tgo func() {\n\t\tconn.Wait()\n\t\tconn.forwards.closeAll()\n\t}()\n\treturn conn\n}\n\n// NewClientConn establishes an authenticated SSH connection using c\n// as the underlying transport. The Request and NewChannel channels\n// must be serviced or the connection will hang.\nfunc NewClientConn(c net.Conn, addr string, config *ClientConfig) (Conn, <-chan NewChannel, <-chan *Request, error) {\n\tfullConf := *config\n\tfullConf.SetDefaults()\n\tif fullConf.HostKeyCallback == nil {\n\t\tc.Close()\n\t\treturn nil, nil, nil, errors.New(\"ssh: must specify HostKeyCallback\")\n\t}\n\n\tconn := &connection{\n\t\tsshConn: sshConn{conn: c, user: fullConf.User},\n\t}\n\n\tif err := conn.clientHandshake(addr, &fullConf); err != nil {\n\t\tc.Close()\n\t\treturn nil, nil, nil, fmt.Errorf(\"ssh: handshake failed: %w\", err)\n\t}\n\tconn.mux = newMux(conn.transport)\n\treturn conn, conn.mux.incomingChannels, conn.mux.incomingRequests, nil\n}\n\n// clientHandshake performs the client side key exchange. See RFC 4253 Section\n// 7.\nfunc (c *connection) clientHandshake(dialAddress string, config *ClientConfig) error {\n\tif config.ClientVersion != \"\" {\n\t\tc.clientVersion = []byte(config.ClientVersion)\n\t} else {\n\t\tc.clientVersion = []byte(packageVersion)\n\t}\n\tvar err error\n\tc.serverVersion, err = exchangeVersions(c.sshConn.conn, c.clientVersion)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tc.transport = newClientTransport(\n\t\tnewTransport(c.sshConn.conn, config.Rand, true /* is client */),\n\t\tc.clientVersion, c.serverVersion, config, dialAddress, c.sshConn.RemoteAddr())\n\tif err := c.transport.waitSession(); err != nil {\n\t\treturn err\n\t}\n\n\tc.sessionID = c.transport.getSessionID()\n\tc.algorithms = c.transport.getAlgorithms()\n\treturn c.clientAuthenticate(config)\n}\n\n// verifyHostKeySignature verifies the host key obtained in the key exchange.\n// algo is the negotiated algorithm, and may be a certificate type.\nfunc verifyHostKeySignature(hostKey PublicKey, algo string, result *kexResult) error {\n\tsig, rest, ok := parseSignatureBody(result.Signature)\n\tif len(rest) > 0 || !ok {\n\t\treturn errors.New(\"ssh: signature parse error\")\n\t}\n\n\tif a := underlyingAlgo(algo); sig.Format != a {\n\t\treturn fmt.Errorf(\"ssh: invalid signature algorithm %q, expected %q\", sig.Format, a)\n\t}\n\n\treturn hostKey.Verify(result.H, sig)\n}\n\n// NewSession opens a new Session for this client. (A session is a remote\n// execution of a program.)\nfunc (c *Client) NewSession() (*Session, error) {\n\tch, in, err := c.OpenChannel(\"session\", nil)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn newSession(ch, in)\n}\n\nfunc (c *Client) handleGlobalRequests(incoming <-chan *Request) {\n\tfor r := range incoming {\n\t\t// This handles keepalive messages and matches\n\t\t// the behaviour of OpenSSH.\n\t\tr.Reply(false, nil)\n\t}\n}\n\n// handleChannelOpens channel open messages from the remote side.\nfunc (c *Client) handleChannelOpens(in <-chan NewChannel) {\n\tfor ch := range in {\n\t\tc.mu.Lock()\n\t\thandler := c.channelHandlers[ch.ChannelType()]\n\t\tc.mu.Unlock()\n\n\t\tif handler != nil {\n\t\t\thandler <- ch\n\t\t} else {\n\t\t\tch.Reject(UnknownChannelType, fmt.Sprintf(\"unknown channel type: %v\", ch.ChannelType()))\n\t\t}\n\t}\n\n\tc.mu.Lock()\n\tfor _, ch := range c.channelHandlers {\n\t\tclose(ch)\n\t}\n\tc.channelHandlers = nil\n\tc.mu.Unlock()\n}\n\n// Dial starts a client connection to the given SSH server. It is a\n// convenience function that connects to the given network address,\n// initiates the SSH handshake, and then sets up a Client. For access\n// to incoming channels and requests, use net.Dial with NewClientConn\n// instead.\nfunc Dial(network, addr string, config *ClientConfig) (*Client, error) {\n\tconn, err := net.DialTimeout(network, addr, config.Timeout)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tc, chans, reqs, err := NewClientConn(conn, addr, config)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn NewClient(c, chans, reqs), nil\n}\n\n// HostKeyCallback is the function type used for verifying server\n// keys. A HostKeyCallback must return nil if the host key is OK, or\n// an error to reject it. It receives the hostname as passed to Dial\n// or NewClientConn. The remote address is the RemoteAddr of the\n// net.Conn underlying the SSH connection.\ntype HostKeyCallback func(hostname string, remote net.Addr, key PublicKey) error\n\n// BannerCallback is the function type used for treat the banner sent by\n// the server. A BannerCallback receives the message sent by the remote server.\ntype BannerCallback func(message string) error\n\n// A ClientConfig structure is used to configure a Client. It must not be\n// modified after having been passed to an SSH function.\ntype ClientConfig struct {\n\t// Config contains configuration that is shared between clients and\n\t// servers.\n\tConfig\n\n\t// User contains the username to authenticate as.\n\tUser string\n\n\t// Auth contains possible authentication methods to use with the\n\t// server. Only the first instance of a particular RFC 4252 method will\n\t// be used during authentication.\n\tAuth []AuthMethod\n\n\t// HostKeyCallback is called during the cryptographic\n\t// handshake to validate the server's host key. The client\n\t// configuration must supply this callback for the connection\n\t// to succeed. The functions InsecureIgnoreHostKey or\n\t// FixedHostKey can be used for simplistic host key checks.\n\tHostKeyCallback HostKeyCallback\n\n\t// BannerCallback is called during the SSH dance to display a custom\n\t// server's message. The client configuration can supply this callback to\n\t// handle it as wished. The function BannerDisplayStderr can be used for\n\t// simplistic display on Stderr.\n\tBannerCallback BannerCallback\n\n\t// ClientVersion contains the version identification string that will\n\t// be used for the connection. If empty, a reasonable default is used.\n\tClientVersion string\n\n\t// HostKeyAlgorithms lists the public key algorithms that the client will\n\t// accept from the server for host key authentication, in order of\n\t// preference. If empty, a reasonable default is used. Any\n\t// string returned from a PublicKey.Type method may be used, or\n\t// any of the CertAlgo and KeyAlgo constants.\n\tHostKeyAlgorithms []string\n\n\t// Timeout is the maximum amount of time for the TCP connection to establish.\n\t//\n\t// A Timeout of zero means no timeout.\n\tTimeout time.Duration\n}\n\n// InsecureIgnoreHostKey returns a function that can be used for\n// ClientConfig.HostKeyCallback to accept any host key. It should\n// not be used for production code.\nfunc InsecureIgnoreHostKey() HostKeyCallback {\n\treturn func(hostname string, remote net.Addr, key PublicKey) error {\n\t\treturn nil\n\t}\n}\n\ntype fixedHostKey struct {\n\tkey PublicKey\n}\n\nfunc (f *fixedHostKey) check(hostname string, remote net.Addr, key PublicKey) error {\n\tif f.key == nil {\n\t\treturn fmt.Errorf(\"ssh: required host key was nil\")\n\t}\n\tif !bytes.Equal(key.Marshal(), f.key.Marshal()) {\n\t\treturn fmt.Errorf(\"ssh: host key mismatch\")\n\t}\n\treturn nil\n}\n\n// FixedHostKey returns a function for use in\n// ClientConfig.HostKeyCallback to accept only a specific host key.\nfunc FixedHostKey(key PublicKey) HostKeyCallback {\n\thk := &fixedHostKey{key}\n\treturn hk.check\n}\n\n// BannerDisplayStderr returns a function that can be used for\n// ClientConfig.BannerCallback to display banners on os.Stderr.\nfunc BannerDisplayStderr() BannerCallback {\n\treturn func(banner string) error {\n\t\t_, err := os.Stderr.WriteString(banner)\n\n\t\treturn err\n\t}\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/client_auth.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"slices\"\n\t\"strings\"\n)\n\ntype authResult int\n\nconst (\n\tauthFailure authResult = iota\n\tauthPartialSuccess\n\tauthSuccess\n)\n\n// clientAuthenticate authenticates with the remote server. See RFC 4252.\nfunc (c *connection) clientAuthenticate(config *ClientConfig) error {\n\t// initiate user auth session\n\tif err := c.transport.writePacket(Marshal(&serviceRequestMsg{serviceUserAuth})); err != nil {\n\t\treturn err\n\t}\n\tpacket, err := c.transport.readPacket()\n\tif err != nil {\n\t\treturn err\n\t}\n\t// The server may choose to send a SSH_MSG_EXT_INFO at this point (if we\n\t// advertised willingness to receive one, which we always do) or not. See\n\t// RFC 8308, Section 2.4.\n\textensions := make(map[string][]byte)\n\tif len(packet) > 0 && packet[0] == msgExtInfo {\n\t\tvar extInfo extInfoMsg\n\t\tif err := Unmarshal(packet, &extInfo); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tpayload := extInfo.Payload\n\t\tfor i := uint32(0); i < extInfo.NumExtensions; i++ {\n\t\t\tname, rest, ok := parseString(payload)\n\t\t\tif !ok {\n\t\t\t\treturn parseError(msgExtInfo)\n\t\t\t}\n\t\t\tvalue, rest, ok := parseString(rest)\n\t\t\tif !ok {\n\t\t\t\treturn parseError(msgExtInfo)\n\t\t\t}\n\t\t\textensions[string(name)] = value\n\t\t\tpayload = rest\n\t\t}\n\t\tpacket, err = c.transport.readPacket()\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tvar serviceAccept serviceAcceptMsg\n\tif err := Unmarshal(packet, &serviceAccept); err != nil {\n\t\treturn err\n\t}\n\n\t// during the authentication phase the client first attempts the \"none\" method\n\t// then any untried methods suggested by the server.\n\tvar tried []string\n\tvar lastMethods []string\n\n\tsessionID := c.transport.getSessionID()\n\tfor auth := AuthMethod(new(noneAuth)); auth != nil; {\n\t\tok, methods, err := auth.auth(sessionID, config.User, c.transport, config.Rand, extensions)\n\t\tif err != nil {\n\t\t\t// On disconnect, return error immediately\n\t\t\tif _, ok := err.(*disconnectMsg); ok {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\t// We return the error later if there is no other method left to\n\t\t\t// try.\n\t\t\tok = authFailure\n\t\t}\n\t\tif ok == authSuccess {\n\t\t\t// success\n\t\t\treturn nil\n\t\t} else if ok == authFailure {\n\t\t\tif m := auth.method(); !slices.Contains(tried, m) {\n\t\t\t\ttried = append(tried, m)\n\t\t\t}\n\t\t}\n\t\tif methods == nil {\n\t\t\tmethods = lastMethods\n\t\t}\n\t\tlastMethods = methods\n\n\t\tauth = nil\n\n\tfindNext:\n\t\tfor _, a := range config.Auth {\n\t\t\tcandidateMethod := a.method()\n\t\t\tif slices.Contains(tried, candidateMethod) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tfor _, meth := range methods {\n\t\t\t\tif meth == candidateMethod {\n\t\t\t\t\tauth = a\n\t\t\t\t\tbreak findNext\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif auth == nil && err != nil {\n\t\t\t// We have an error and there are no other authentication methods to\n\t\t\t// try, so we return it.\n\t\t\treturn err\n\t\t}\n\t}\n\treturn fmt.Errorf(\"ssh: unable to authenticate, attempted methods %v, no supported methods remain\", tried)\n}\n\n// An AuthMethod represents an instance of an RFC 4252 authentication method.\ntype AuthMethod interface {\n\t// auth authenticates user over transport t.\n\t// Returns true if authentication is successful.\n\t// If authentication is not successful, a []string of alternative\n\t// method names is returned. If the slice is nil, it will be ignored\n\t// and the previous set of possible methods will be reused.\n\tauth(session []byte, user string, p packetConn, rand io.Reader, extensions map[string][]byte) (authResult, []string, error)\n\n\t// method returns the RFC 4252 method name.\n\tmethod() string\n}\n\n// \"none\" authentication, RFC 4252 section 5.2.\ntype noneAuth int\n\nfunc (n *noneAuth) auth(session []byte, user string, c packetConn, rand io.Reader, _ map[string][]byte) (authResult, []string, error) {\n\tif err := c.writePacket(Marshal(&userAuthRequestMsg{\n\t\tUser: user,\n\t\tService: serviceSSH,\n\t\tMethod: \"none\",\n\t})); err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\n\treturn handleAuthResponse(c)\n}\n\nfunc (n *noneAuth) method() string {\n\treturn \"none\"\n}\n\n// passwordCallback is an AuthMethod that fetches the password through\n// a function call, e.g. by prompting the user.\ntype passwordCallback func() (password string, err error)\n\nfunc (cb passwordCallback) auth(session []byte, user string, c packetConn, rand io.Reader, _ map[string][]byte) (authResult, []string, error) {\n\ttype passwordAuthMsg struct {\n\t\tUser string `sshtype:\"50\"`\n\t\tService string\n\t\tMethod string\n\t\tReply bool\n\t\tPassword string\n\t}\n\n\tpw, err := cb()\n\t// REVIEW NOTE: is there a need to support skipping a password attempt?\n\t// The program may only find out that the user doesn't have a password\n\t// when prompting.\n\tif err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\n\tif err := c.writePacket(Marshal(&passwordAuthMsg{\n\t\tUser: user,\n\t\tService: serviceSSH,\n\t\tMethod: cb.method(),\n\t\tReply: false,\n\t\tPassword: pw,\n\t})); err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\n\treturn handleAuthResponse(c)\n}\n\nfunc (cb passwordCallback) method() string {\n\treturn \"password\"\n}\n\n// Password returns an AuthMethod using the given password.\nfunc Password(secret string) AuthMethod {\n\treturn passwordCallback(func() (string, error) { return secret, nil })\n}\n\n// PasswordCallback returns an AuthMethod that uses a callback for\n// fetching a password.\nfunc PasswordCallback(prompt func() (secret string, err error)) AuthMethod {\n\treturn passwordCallback(prompt)\n}\n\ntype publickeyAuthMsg struct {\n\tUser string `sshtype:\"50\"`\n\tService string\n\tMethod string\n\t// HasSig indicates to the receiver packet that the auth request is signed and\n\t// should be used for authentication of the request.\n\tHasSig bool\n\tAlgoname string\n\tPubKey []byte\n\t// Sig is tagged with \"rest\" so Marshal will exclude it during\n\t// validateKey\n\tSig []byte `ssh:\"rest\"`\n}\n\n// publicKeyCallback is an AuthMethod that uses a set of key\n// pairs for authentication.\ntype publicKeyCallback func() ([]Signer, error)\n\nfunc (cb publicKeyCallback) method() string {\n\treturn \"publickey\"\n}\n\nfunc pickSignatureAlgorithm(signer Signer, extensions map[string][]byte) (MultiAlgorithmSigner, string, error) {\n\tvar as MultiAlgorithmSigner\n\tkeyFormat := signer.PublicKey().Type()\n\n\t// If the signer implements MultiAlgorithmSigner we use the algorithms it\n\t// support, if it implements AlgorithmSigner we assume it supports all\n\t// algorithms, otherwise only the key format one.\n\tswitch s := signer.(type) {\n\tcase MultiAlgorithmSigner:\n\t\tas = s\n\tcase AlgorithmSigner:\n\t\tas = &multiAlgorithmSigner{\n\t\t\tAlgorithmSigner: s,\n\t\t\tsupportedAlgorithms: algorithmsForKeyFormat(underlyingAlgo(keyFormat)),\n\t\t}\n\tdefault:\n\t\tas = &multiAlgorithmSigner{\n\t\t\tAlgorithmSigner: algorithmSignerWrapper{signer},\n\t\t\tsupportedAlgorithms: []string{underlyingAlgo(keyFormat)},\n\t\t}\n\t}\n\n\tgetFallbackAlgo := func() (string, error) {\n\t\t// Fallback to use if there is no \"server-sig-algs\" extension or a\n\t\t// common algorithm cannot be found. We use the public key format if the\n\t\t// MultiAlgorithmSigner supports it, otherwise we return an error.\n\t\tif !slices.Contains(as.Algorithms(), underlyingAlgo(keyFormat)) {\n\t\t\treturn \"\", fmt.Errorf(\"ssh: no common public key signature algorithm, server only supports %q for key type %q, signer only supports %v\",\n\t\t\t\tunderlyingAlgo(keyFormat), keyFormat, as.Algorithms())\n\t\t}\n\t\treturn keyFormat, nil\n\t}\n\n\textPayload, ok := extensions[\"server-sig-algs\"]\n\tif !ok {\n\t\t// If there is no \"server-sig-algs\" extension use the fallback\n\t\t// algorithm.\n\t\talgo, err := getFallbackAlgo()\n\t\treturn as, algo, err\n\t}\n\n\t// The server-sig-algs extension only carries underlying signature\n\t// algorithm, but we are trying to select a protocol-level public key\n\t// algorithm, which might be a certificate type. Extend the list of server\n\t// supported algorithms to include the corresponding certificate algorithms.\n\tserverAlgos := strings.Split(string(extPayload), \",\")\n\tfor _, algo := range serverAlgos {\n\t\tif certAlgo, ok := certificateAlgo(algo); ok {\n\t\t\tserverAlgos = append(serverAlgos, certAlgo)\n\t\t}\n\t}\n\n\t// Filter algorithms based on those supported by MultiAlgorithmSigner.\n\tvar keyAlgos []string\n\tfor _, algo := range algorithmsForKeyFormat(keyFormat) {\n\t\tif slices.Contains(as.Algorithms(), underlyingAlgo(algo)) {\n\t\t\tkeyAlgos = append(keyAlgos, algo)\n\t\t}\n\t}\n\n\talgo, err := findCommon(\"public key signature algorithm\", keyAlgos, serverAlgos, true)\n\tif err != nil {\n\t\t// If there is no overlap, return the fallback algorithm to support\n\t\t// servers that fail to list all supported algorithms.\n\t\talgo, err := getFallbackAlgo()\n\t\treturn as, algo, err\n\t}\n\treturn as, algo, nil\n}\n\nfunc (cb publicKeyCallback) auth(session []byte, user string, c packetConn, rand io.Reader, extensions map[string][]byte) (authResult, []string, error) {\n\t// Authentication is performed by sending an enquiry to test if a key is\n\t// acceptable to the remote. If the key is acceptable, the client will\n\t// attempt to authenticate with the valid key. If not the client will repeat\n\t// the process with the remaining keys.\n\n\tsigners, err := cb()\n\tif err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\tvar methods []string\n\tvar errSigAlgo error\n\n\torigSignersLen := len(signers)\n\tfor idx := 0; idx < len(signers); idx++ {\n\t\tsigner := signers[idx]\n\t\tpub := signer.PublicKey()\n\t\tas, algo, err := pickSignatureAlgorithm(signer, extensions)\n\t\tif err != nil && errSigAlgo == nil {\n\t\t\t// If we cannot negotiate a signature algorithm store the first\n\t\t\t// error so we can return it to provide a more meaningful message if\n\t\t\t// no other signers work.\n\t\t\terrSigAlgo = err\n\t\t\tcontinue\n\t\t}\n\t\tok, err := validateKey(pub, algo, user, c)\n\t\tif err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\t\t// OpenSSH 7.2-7.7 advertises support for rsa-sha2-256 and rsa-sha2-512\n\t\t// in the \"server-sig-algs\" extension but doesn't support these\n\t\t// algorithms for certificate authentication, so if the server rejects\n\t\t// the key try to use the obtained algorithm as if \"server-sig-algs\" had\n\t\t// not been implemented if supported from the algorithm signer.\n\t\tif !ok && idx < origSignersLen && isRSACert(algo) && algo != CertAlgoRSAv01 {\n\t\t\tif slices.Contains(as.Algorithms(), KeyAlgoRSA) {\n\t\t\t\t// We retry using the compat algorithm after all signers have\n\t\t\t\t// been tried normally.\n\t\t\t\tsigners = append(signers, &multiAlgorithmSigner{\n\t\t\t\t\tAlgorithmSigner: as,\n\t\t\t\t\tsupportedAlgorithms: []string{KeyAlgoRSA},\n\t\t\t\t})\n\t\t\t}\n\t\t}\n\t\tif !ok {\n\t\t\tcontinue\n\t\t}\n\n\t\tpubKey := pub.Marshal()\n\t\tdata := buildDataSignedForAuth(session, userAuthRequestMsg{\n\t\t\tUser: user,\n\t\t\tService: serviceSSH,\n\t\t\tMethod: cb.method(),\n\t\t}, algo, pubKey)\n\t\tsign, err := as.SignWithAlgorithm(rand, data, underlyingAlgo(algo))\n\t\tif err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\n\t\t// manually wrap the serialized signature in a string\n\t\ts := Marshal(sign)\n\t\tsig := make([]byte, stringLength(len(s)))\n\t\tmarshalString(sig, s)\n\t\tmsg := publickeyAuthMsg{\n\t\t\tUser: user,\n\t\t\tService: serviceSSH,\n\t\t\tMethod: cb.method(),\n\t\t\tHasSig: true,\n\t\t\tAlgoname: algo,\n\t\t\tPubKey: pubKey,\n\t\t\tSig: sig,\n\t\t}\n\t\tp := Marshal(&msg)\n\t\tif err := c.writePacket(p); err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\t\tvar success authResult\n\t\tsuccess, methods, err = handleAuthResponse(c)\n\t\tif err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\n\t\t// If authentication succeeds or the list of available methods does not\n\t\t// contain the \"publickey\" method, do not attempt to authenticate with any\n\t\t// other keys. According to RFC 4252 Section 7, the latter can occur when\n\t\t// additional authentication methods are required.\n\t\tif success == authSuccess || !slices.Contains(methods, cb.method()) {\n\t\t\treturn success, methods, err\n\t\t}\n\t}\n\n\treturn authFailure, methods, errSigAlgo\n}\n\n// validateKey validates the key provided is acceptable to the server.\nfunc validateKey(key PublicKey, algo string, user string, c packetConn) (bool, error) {\n\tpubKey := key.Marshal()\n\tmsg := publickeyAuthMsg{\n\t\tUser: user,\n\t\tService: serviceSSH,\n\t\tMethod: \"publickey\",\n\t\tHasSig: false,\n\t\tAlgoname: algo,\n\t\tPubKey: pubKey,\n\t}\n\tif err := c.writePacket(Marshal(&msg)); err != nil {\n\t\treturn false, err\n\t}\n\n\treturn confirmKeyAck(key, c)\n}\n\nfunc confirmKeyAck(key PublicKey, c packetConn) (bool, error) {\n\tpubKey := key.Marshal()\n\n\tfor {\n\t\tpacket, err := c.readPacket()\n\t\tif err != nil {\n\t\t\treturn false, err\n\t\t}\n\t\tswitch packet[0] {\n\t\tcase msgUserAuthBanner:\n\t\t\tif err := handleBannerResponse(c, packet); err != nil {\n\t\t\t\treturn false, err\n\t\t\t}\n\t\tcase msgUserAuthPubKeyOk:\n\t\t\tvar msg userAuthPubKeyOkMsg\n\t\t\tif err := Unmarshal(packet, &msg); err != nil {\n\t\t\t\treturn false, err\n\t\t\t}\n\t\t\t// According to RFC 4252 Section 7 the algorithm in\n\t\t\t// SSH_MSG_USERAUTH_PK_OK should match that of the request but some\n\t\t\t// servers send the key type instead. OpenSSH allows any algorithm\n\t\t\t// that matches the public key, so we do the same.\n\t\t\t// https://github.com/openssh/openssh-portable/blob/86bdd385/sshconnect2.c#L709\n\t\t\tif !slices.Contains(algorithmsForKeyFormat(key.Type()), msg.Algo) {\n\t\t\t\treturn false, nil\n\t\t\t}\n\t\t\tif !bytes.Equal(msg.PubKey, pubKey) {\n\t\t\t\treturn false, nil\n\t\t\t}\n\t\t\treturn true, nil\n\t\tcase msgUserAuthFailure:\n\t\t\treturn false, nil\n\t\tdefault:\n\t\t\treturn false, unexpectedMessageError(msgUserAuthPubKeyOk, packet[0])\n\t\t}\n\t}\n}\n\n// PublicKeys returns an AuthMethod that uses the given key\n// pairs.\nfunc PublicKeys(signers ...Signer) AuthMethod {\n\treturn publicKeyCallback(func() ([]Signer, error) { return signers, nil })\n}\n\n// PublicKeysCallback returns an AuthMethod that runs the given\n// function to obtain a list of key pairs.\nfunc PublicKeysCallback(getSigners func() (signers []Signer, err error)) AuthMethod {\n\treturn publicKeyCallback(getSigners)\n}\n\n// handleAuthResponse returns whether the preceding authentication request succeeded\n// along with a list of remaining authentication methods to try next and\n// an error if an unexpected response was received.\nfunc handleAuthResponse(c packetConn) (authResult, []string, error) {\n\tgotMsgExtInfo := false\n\tfor {\n\t\tpacket, err := c.readPacket()\n\t\tif err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\n\t\tswitch packet[0] {\n\t\tcase msgUserAuthBanner:\n\t\t\tif err := handleBannerResponse(c, packet); err != nil {\n\t\t\t\treturn authFailure, nil, err\n\t\t\t}\n\t\tcase msgExtInfo:\n\t\t\t// Ignore post-authentication RFC 8308 extensions, once.\n\t\t\tif gotMsgExtInfo {\n\t\t\t\treturn authFailure, nil, unexpectedMessageError(msgUserAuthSuccess, packet[0])\n\t\t\t}\n\t\t\tgotMsgExtInfo = true\n\t\tcase msgUserAuthFailure:\n\t\t\tvar msg userAuthFailureMsg\n\t\t\tif err := Unmarshal(packet, &msg); err != nil {\n\t\t\t\treturn authFailure, nil, err\n\t\t\t}\n\t\t\tif msg.PartialSuccess {\n\t\t\t\treturn authPartialSuccess, msg.Methods, nil\n\t\t\t}\n\t\t\treturn authFailure, msg.Methods, nil\n\t\tcase msgUserAuthSuccess:\n\t\t\treturn authSuccess, nil, nil\n\t\tdefault:\n\t\t\treturn authFailure, nil, unexpectedMessageError(msgUserAuthSuccess, packet[0])\n\t\t}\n\t}\n}\n\nfunc handleBannerResponse(c packetConn, packet []byte) error {\n\tvar msg userAuthBannerMsg\n\tif err := Unmarshal(packet, &msg); err != nil {\n\t\treturn err\n\t}\n\n\ttransport, ok := c.(*handshakeTransport)\n\tif !ok {\n\t\treturn nil\n\t}\n\n\tif transport.bannerCallback != nil {\n\t\treturn transport.bannerCallback(msg.Message)\n\t}\n\n\treturn nil\n}\n\n// KeyboardInteractiveChallenge should print questions, optionally\n// disabling echoing (e.g. for passwords), and return all the answers.\n// Challenge may be called multiple times in a single session. After\n// successful authentication, the server may send a challenge with no\n// questions, for which the name and instruction messages should be\n// printed. RFC 4256 section 3.3 details how the UI should behave for\n// both CLI and GUI environments.\ntype KeyboardInteractiveChallenge func(name, instruction string, questions []string, echos []bool) (answers []string, err error)\n\n// KeyboardInteractive returns an AuthMethod using a prompt/response\n// sequence controlled by the server.\nfunc KeyboardInteractive(challenge KeyboardInteractiveChallenge) AuthMethod {\n\treturn challenge\n}\n\nfunc (cb KeyboardInteractiveChallenge) method() string {\n\treturn \"keyboard-interactive\"\n}\n\nfunc (cb KeyboardInteractiveChallenge) auth(session []byte, user string, c packetConn, rand io.Reader, _ map[string][]byte) (authResult, []string, error) {\n\ttype initiateMsg struct {\n\t\tUser string `sshtype:\"50\"`\n\t\tService string\n\t\tMethod string\n\t\tLanguage string\n\t\tSubmethods string\n\t}\n\n\tif err := c.writePacket(Marshal(&initiateMsg{\n\t\tUser: user,\n\t\tService: serviceSSH,\n\t\tMethod: \"keyboard-interactive\",\n\t})); err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\n\tgotMsgExtInfo := false\n\tgotUserAuthInfoRequest := false\n\tfor {\n\t\tpacket, err := c.readPacket()\n\t\tif err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\n\t\t// like handleAuthResponse, but with less options.\n\t\tswitch packet[0] {\n\t\tcase msgUserAuthBanner:\n\t\t\tif err := handleBannerResponse(c, packet); err != nil {\n\t\t\t\treturn authFailure, nil, err\n\t\t\t}\n\t\t\tcontinue\n\t\tcase msgExtInfo:\n\t\t\t// Ignore post-authentication RFC 8308 extensions, once.\n\t\t\tif gotMsgExtInfo {\n\t\t\t\treturn authFailure, nil, unexpectedMessageError(msgUserAuthInfoRequest, packet[0])\n\t\t\t}\n\t\t\tgotMsgExtInfo = true\n\t\t\tcontinue\n\t\tcase msgUserAuthInfoRequest:\n\t\t\t// OK\n\t\tcase msgUserAuthFailure:\n\t\t\tvar msg userAuthFailureMsg\n\t\t\tif err := Unmarshal(packet, &msg); err != nil {\n\t\t\t\treturn authFailure, nil, err\n\t\t\t}\n\t\t\tif msg.PartialSuccess {\n\t\t\t\treturn authPartialSuccess, msg.Methods, nil\n\t\t\t}\n\t\t\tif !gotUserAuthInfoRequest {\n\t\t\t\treturn authFailure, msg.Methods, unexpectedMessageError(msgUserAuthInfoRequest, packet[0])\n\t\t\t}\n\t\t\treturn authFailure, msg.Methods, nil\n\t\tcase msgUserAuthSuccess:\n\t\t\treturn authSuccess, nil, nil\n\t\tdefault:\n\t\t\treturn authFailure, nil, unexpectedMessageError(msgUserAuthInfoRequest, packet[0])\n\t\t}\n\n\t\tvar msg userAuthInfoRequestMsg\n\t\tif err := Unmarshal(packet, &msg); err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\t\tgotUserAuthInfoRequest = true\n\n\t\t// Manually unpack the prompt/echo pairs.\n\t\trest := msg.Prompts\n\t\tvar prompts []string\n\t\tvar echos []bool\n\t\tfor i := 0; i < int(msg.NumPrompts); i++ {\n\t\t\tprompt, r, ok := parseString(rest)\n\t\t\tif !ok || len(r) == 0 {\n\t\t\t\treturn authFailure, nil, errors.New(\"ssh: prompt format error\")\n\t\t\t}\n\t\t\tprompts = append(prompts, string(prompt))\n\t\t\techos = append(echos, r[0] != 0)\n\t\t\trest = r[1:]\n\t\t}\n\n\t\tif len(rest) != 0 {\n\t\t\treturn authFailure, nil, errors.New(\"ssh: extra data following keyboard-interactive pairs\")\n\t\t}\n\n\t\tanswers, err := cb(msg.Name, msg.Instruction, prompts, echos)\n\t\tif err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\n\t\tif len(answers) != len(prompts) {\n\t\t\treturn authFailure, nil, fmt.Errorf(\"ssh: incorrect number of answers from keyboard-interactive callback %d (expected %d)\", len(answers), len(prompts))\n\t\t}\n\t\tresponseLength := 1 + 4\n\t\tfor _, a := range answers {\n\t\t\tresponseLength += stringLength(len(a))\n\t\t}\n\t\tserialized := make([]byte, responseLength)\n\t\tp := serialized\n\t\tp[0] = msgUserAuthInfoResponse\n\t\tp = p[1:]\n\t\tp = marshalUint32(p, uint32(len(answers)))\n\t\tfor _, a := range answers {\n\t\t\tp = marshalString(p, []byte(a))\n\t\t}\n\n\t\tif err := c.writePacket(serialized); err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\t}\n}\n\ntype retryableAuthMethod struct {\n\tauthMethod AuthMethod\n\tmaxTries int\n}\n\nfunc (r *retryableAuthMethod) auth(session []byte, user string, c packetConn, rand io.Reader, extensions map[string][]byte) (ok authResult, methods []string, err error) {\n\tfor i := 0; r.maxTries <= 0 || i < r.maxTries; i++ {\n\t\tok, methods, err = r.authMethod.auth(session, user, c, rand, extensions)\n\t\tif ok != authFailure || err != nil { // either success, partial success or error terminate\n\t\t\treturn ok, methods, err\n\t\t}\n\t}\n\treturn ok, methods, err\n}\n\nfunc (r *retryableAuthMethod) method() string {\n\treturn r.authMethod.method()\n}\n\n// RetryableAuthMethod is a decorator for other auth methods enabling them to\n// be retried up to maxTries before considering that AuthMethod itself failed.\n// If maxTries is <= 0, will retry indefinitely\n//\n// This is useful for interactive clients using challenge/response type\n// authentication (e.g. Keyboard-Interactive, Password, etc) where the user\n// could mistype their response resulting in the server issuing a\n// SSH_MSG_USERAUTH_FAILURE (rfc4252 #8 [password] and rfc4256 #3.4\n// [keyboard-interactive]); Without this decorator, the non-retryable\n// AuthMethod would be removed from future consideration, and never tried again\n// (and so the user would never be able to retry their entry).\nfunc RetryableAuthMethod(auth AuthMethod, maxTries int) AuthMethod {\n\treturn &retryableAuthMethod{authMethod: auth, maxTries: maxTries}\n}\n\n// GSSAPIWithMICAuthMethod is an AuthMethod with \"gssapi-with-mic\" authentication.\n// See RFC 4462 section 3\n// gssAPIClient is implementation of the GSSAPIClient interface, see the definition of the interface for details.\n// target is the server host you want to log in to.\nfunc GSSAPIWithMICAuthMethod(gssAPIClient GSSAPIClient, target string) AuthMethod {\n\tif gssAPIClient == nil {\n\t\tpanic(\"gss-api client must be not nil with enable gssapi-with-mic\")\n\t}\n\treturn &gssAPIWithMICCallback{gssAPIClient: gssAPIClient, target: target}\n}\n\ntype gssAPIWithMICCallback struct {\n\tgssAPIClient GSSAPIClient\n\ttarget string\n}\n\nfunc (g *gssAPIWithMICCallback) auth(session []byte, user string, c packetConn, rand io.Reader, _ map[string][]byte) (authResult, []string, error) {\n\tm := &userAuthRequestMsg{\n\t\tUser: user,\n\t\tService: serviceSSH,\n\t\tMethod: g.method(),\n\t}\n\t// The GSS-API authentication method is initiated when the client sends an SSH_MSG_USERAUTH_REQUEST.\n\t// See RFC 4462 section 3.2.\n\tm.Payload = appendU32(m.Payload, 1)\n\tm.Payload = appendString(m.Payload, string(krb5OID))\n\tif err := c.writePacket(Marshal(m)); err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\t// The server responds to the SSH_MSG_USERAUTH_REQUEST with either an\n\t// SSH_MSG_USERAUTH_FAILURE if none of the mechanisms are supported or\n\t// with an SSH_MSG_USERAUTH_GSSAPI_RESPONSE.\n\t// See RFC 4462 section 3.3.\n\t// OpenSSH supports Kerberos V5 mechanism only for GSS-API authentication,so I don't want to check\n\t// selected mech if it is valid.\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\tuserAuthGSSAPIResp := &userAuthGSSAPIResponse{}\n\tif err := Unmarshal(packet, userAuthGSSAPIResp); err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\t// Start the loop into the exchange token.\n\t// See RFC 4462 section 3.4.\n\tvar token []byte\n\tdefer g.gssAPIClient.DeleteSecContext()\n\tfor {\n\t\t// Initiates the establishment of a security context between the application and a remote peer.\n\t\tnextToken, needContinue, err := g.gssAPIClient.InitSecContext(\"host@\"+g.target, token, false)\n\t\tif err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\t\tif len(nextToken) > 0 {\n\t\t\tif err := c.writePacket(Marshal(&userAuthGSSAPIToken{\n\t\t\t\tToken: nextToken,\n\t\t\t})); err != nil {\n\t\t\t\treturn authFailure, nil, err\n\t\t\t}\n\t\t}\n\t\tif !needContinue {\n\t\t\tbreak\n\t\t}\n\t\tpacket, err = c.readPacket()\n\t\tif err != nil {\n\t\t\treturn authFailure, nil, err\n\t\t}\n\t\tswitch packet[0] {\n\t\tcase msgUserAuthFailure:\n\t\t\tvar msg userAuthFailureMsg\n\t\t\tif err := Unmarshal(packet, &msg); err != nil {\n\t\t\t\treturn authFailure, nil, err\n\t\t\t}\n\t\t\tif msg.PartialSuccess {\n\t\t\t\treturn authPartialSuccess, msg.Methods, nil\n\t\t\t}\n\t\t\treturn authFailure, msg.Methods, nil\n\t\tcase msgUserAuthGSSAPIError:\n\t\t\tuserAuthGSSAPIErrorResp := &userAuthGSSAPIError{}\n\t\t\tif err := Unmarshal(packet, userAuthGSSAPIErrorResp); err != nil {\n\t\t\t\treturn authFailure, nil, err\n\t\t\t}\n\t\t\treturn authFailure, nil, fmt.Errorf(\"GSS-API Error:\\n\"+\n\t\t\t\t\"Major Status: %d\\n\"+\n\t\t\t\t\"Minor Status: %d\\n\"+\n\t\t\t\t\"Error Message: %s\\n\", userAuthGSSAPIErrorResp.MajorStatus, userAuthGSSAPIErrorResp.MinorStatus,\n\t\t\t\tuserAuthGSSAPIErrorResp.Message)\n\t\tcase msgUserAuthGSSAPIToken:\n\t\t\tuserAuthGSSAPITokenReq := &userAuthGSSAPIToken{}\n\t\t\tif err := Unmarshal(packet, userAuthGSSAPITokenReq); err != nil {\n\t\t\t\treturn authFailure, nil, err\n\t\t\t}\n\t\t\ttoken = userAuthGSSAPITokenReq.Token\n\t\t}\n\t}\n\t// Binding Encryption Keys.\n\t// See RFC 4462 section 3.5.\n\tmicField := buildMIC(string(session), user, \"ssh-connection\", \"gssapi-with-mic\")\n\tmicToken, err := g.gssAPIClient.GetMIC(micField)\n\tif err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\tif err := c.writePacket(Marshal(&userAuthGSSAPIMIC{\n\t\tMIC: micToken,\n\t})); err != nil {\n\t\treturn authFailure, nil, err\n\t}\n\treturn handleAuthResponse(c)\n}\n\nfunc (g *gssAPIWithMICCallback) method() string {\n\treturn \"gssapi-with-mic\"\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/common.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"crypto\"\n\t\"crypto/fips140\"\n\t\"crypto/rand\"\n\t\"fmt\"\n\t\"io\"\n\t\"math\"\n\t\"slices\"\n\t\"sync\"\n\n\t_ \"crypto/sha1\"\n\t_ \"crypto/sha256\"\n\t_ \"crypto/sha512\"\n)\n\n// These are string constants in the SSH protocol.\nconst (\n\tcompressionNone = \"none\"\n\tserviceUserAuth = \"ssh-userauth\"\n\tserviceSSH = \"ssh-connection\"\n)\n\n// The ciphers currently or previously implemented by this library, to use in\n// [Config.Ciphers]. For a list, see the [Algorithms.Ciphers] returned by\n// [SupportedAlgorithms] or [InsecureAlgorithms].\nconst (\n\tCipherAES128GCM = \"aes128-gcm@openssh.com\"\n\tCipherAES256GCM = \"aes256-gcm@openssh.com\"\n\tCipherChaCha20Poly1305 = \"chacha20-poly1305@openssh.com\"\n\tCipherAES128CTR = \"aes128-ctr\"\n\tCipherAES192CTR = \"aes192-ctr\"\n\tCipherAES256CTR = \"aes256-ctr\"\n\tInsecureCipherAES128CBC = \"aes128-cbc\"\n\tInsecureCipherTripleDESCBC = \"3des-cbc\"\n\tInsecureCipherRC4 = \"arcfour\"\n\tInsecureCipherRC4128 = \"arcfour128\"\n\tInsecureCipherRC4256 = \"arcfour256\"\n)\n\n// The key exchanges currently or previously implemented by this library, to use\n// in [Config.KeyExchanges]. For a list, see the\n// [Algorithms.KeyExchanges] returned by [SupportedAlgorithms] or\n// [InsecureAlgorithms].\nconst (\n\tInsecureKeyExchangeDH1SHA1 = \"diffie-hellman-group1-sha1\"\n\tInsecureKeyExchangeDH14SHA1 = \"diffie-hellman-group14-sha1\"\n\tKeyExchangeDH14SHA256 = \"diffie-hellman-group14-sha256\"\n\tKeyExchangeDH16SHA512 = \"diffie-hellman-group16-sha512\"\n\tKeyExchangeECDHP256 = \"ecdh-sha2-nistp256\"\n\tKeyExchangeECDHP384 = \"ecdh-sha2-nistp384\"\n\tKeyExchangeECDHP521 = \"ecdh-sha2-nistp521\"\n\tKeyExchangeCurve25519 = \"curve25519-sha256\"\n\tInsecureKeyExchangeDHGEXSHA1 = \"diffie-hellman-group-exchange-sha1\"\n\tKeyExchangeDHGEXSHA256 = \"diffie-hellman-group-exchange-sha256\"\n\t// KeyExchangeMLKEM768X25519 is supported from Go 1.24.\n\tKeyExchangeMLKEM768X25519 = \"mlkem768x25519-sha256\"\n\n\t// An alias for KeyExchangeCurve25519SHA256. This kex ID will be added if\n\t// KeyExchangeCurve25519SHA256 is requested for backward compatibility with\n\t// OpenSSH versions up to 7.2.\n\tkeyExchangeCurve25519LibSSH = \"curve25519-sha256@libssh.org\"\n)\n\n// The message authentication code (MAC) currently or previously implemented by\n// this library, to use in [Config.MACs]. For a list, see the\n// [Algorithms.MACs] returned by [SupportedAlgorithms] or\n// [InsecureAlgorithms].\nconst (\n\tHMACSHA256ETM = \"hmac-sha2-256-etm@openssh.com\"\n\tHMACSHA512ETM = \"hmac-sha2-512-etm@openssh.com\"\n\tHMACSHA256 = \"hmac-sha2-256\"\n\tHMACSHA512 = \"hmac-sha2-512\"\n\tHMACSHA1 = \"hmac-sha1\"\n\tInsecureHMACSHA196 = \"hmac-sha1-96\"\n)\n\nvar (\n\t// supportedKexAlgos specifies key-exchange algorithms implemented by this\n\t// package in preference order, excluding those with security issues.\n\tsupportedKexAlgos = []string{\n\t\tKeyExchangeMLKEM768X25519,\n\t\tKeyExchangeCurve25519,\n\t\tKeyExchangeECDHP256,\n\t\tKeyExchangeECDHP384,\n\t\tKeyExchangeECDHP521,\n\t\tKeyExchangeDH14SHA256,\n\t\tKeyExchangeDH16SHA512,\n\t\tKeyExchangeDHGEXSHA256,\n\t}\n\t// defaultKexAlgos specifies the default preference for key-exchange\n\t// algorithms in preference order.\n\tdefaultKexAlgos = []string{\n\t\tKeyExchangeMLKEM768X25519,\n\t\tKeyExchangeCurve25519,\n\t\tKeyExchangeECDHP256,\n\t\tKeyExchangeECDHP384,\n\t\tKeyExchangeECDHP521,\n\t\tKeyExchangeDH14SHA256,\n\t\tInsecureKeyExchangeDH14SHA1,\n\t}\n\t// insecureKexAlgos specifies key-exchange algorithms implemented by this\n\t// package and which have security issues.\n\tinsecureKexAlgos = []string{\n\t\tInsecureKeyExchangeDH14SHA1,\n\t\tInsecureKeyExchangeDH1SHA1,\n\t\tInsecureKeyExchangeDHGEXSHA1,\n\t}\n\t// supportedCiphers specifies cipher algorithms implemented by this package\n\t// in preference order, excluding those with security issues.\n\tsupportedCiphers = []string{\n\t\tCipherAES128GCM,\n\t\tCipherAES256GCM,\n\t\tCipherChaCha20Poly1305,\n\t\tCipherAES128CTR,\n\t\tCipherAES192CTR,\n\t\tCipherAES256CTR,\n\t}\n\t// defaultCiphers specifies the default preference for ciphers algorithms\n\t// in preference order.\n\tdefaultCiphers = supportedCiphers\n\t// insecureCiphers specifies cipher algorithms implemented by this\n\t// package and which have security issues.\n\tinsecureCiphers = []string{\n\t\tInsecureCipherAES128CBC,\n\t\tInsecureCipherTripleDESCBC,\n\t\tInsecureCipherRC4256,\n\t\tInsecureCipherRC4128,\n\t\tInsecureCipherRC4,\n\t}\n\t// supportedMACs specifies MAC algorithms implemented by this package in\n\t// preference order, excluding those with security issues.\n\tsupportedMACs = []string{\n\t\tHMACSHA256ETM,\n\t\tHMACSHA512ETM,\n\t\tHMACSHA256,\n\t\tHMACSHA512,\n\t\tHMACSHA1,\n\t}\n\t// defaultMACs specifies the default preference for MAC algorithms in\n\t// preference order.\n\tdefaultMACs = []string{\n\t\tHMACSHA256ETM,\n\t\tHMACSHA512ETM,\n\t\tHMACSHA256,\n\t\tHMACSHA512,\n\t\tHMACSHA1,\n\t\tInsecureHMACSHA196,\n\t}\n\t// insecureMACs specifies MAC algorithms implemented by this\n\t// package and which have security issues.\n\tinsecureMACs = []string{\n\t\tInsecureHMACSHA196,\n\t}\n\t// supportedHostKeyAlgos specifies the supported host-key algorithms (i.e.\n\t// methods of authenticating servers) implemented by this package in\n\t// preference order, excluding those with security issues.\n\tsupportedHostKeyAlgos = []string{\n\t\tCertAlgoRSASHA256v01,\n\t\tCertAlgoRSASHA512v01,\n\t\tCertAlgoECDSA256v01,\n\t\tCertAlgoECDSA384v01,\n\t\tCertAlgoECDSA521v01,\n\t\tCertAlgoED25519v01,\n\t\tKeyAlgoRSASHA256,\n\t\tKeyAlgoRSASHA512,\n\t\tKeyAlgoECDSA256,\n\t\tKeyAlgoECDSA384,\n\t\tKeyAlgoECDSA521,\n\t\tKeyAlgoED25519,\n\t}\n\t// defaultHostKeyAlgos specifies the default preference for host-key\n\t// algorithms in preference order.\n\tdefaultHostKeyAlgos = []string{\n\t\tCertAlgoRSASHA256v01,\n\t\tCertAlgoRSASHA512v01,\n\t\tCertAlgoRSAv01,\n\t\tInsecureCertAlgoDSAv01,\n\t\tCertAlgoECDSA256v01,\n\t\tCertAlgoECDSA384v01,\n\t\tCertAlgoECDSA521v01,\n\t\tCertAlgoED25519v01,\n\t\tKeyAlgoECDSA256,\n\t\tKeyAlgoECDSA384,\n\t\tKeyAlgoECDSA521,\n\t\tKeyAlgoRSASHA256,\n\t\tKeyAlgoRSASHA512,\n\t\tKeyAlgoRSA,\n\t\tInsecureKeyAlgoDSA,\n\t\tKeyAlgoED25519,\n\t}\n\t// insecureHostKeyAlgos specifies host-key algorithms implemented by this\n\t// package and which have security issues.\n\tinsecureHostKeyAlgos = []string{\n\t\tKeyAlgoRSA,\n\t\tInsecureKeyAlgoDSA,\n\t\tCertAlgoRSAv01,\n\t\tInsecureCertAlgoDSAv01,\n\t}\n\t// supportedPubKeyAuthAlgos specifies the supported client public key\n\t// authentication algorithms. Note that this doesn't include certificate\n\t// types since those use the underlying algorithm. Order is irrelevant.\n\tsupportedPubKeyAuthAlgos = []string{\n\t\tKeyAlgoED25519,\n\t\tKeyAlgoSKED25519,\n\t\tKeyAlgoSKECDSA256,\n\t\tKeyAlgoECDSA256,\n\t\tKeyAlgoECDSA384,\n\t\tKeyAlgoECDSA521,\n\t\tKeyAlgoRSASHA256,\n\t\tKeyAlgoRSASHA512,\n\t}\n\n\t// defaultPubKeyAuthAlgos specifies the preferred client public key\n\t// authentication algorithms. This list is sent to the client if it supports\n\t// the server-sig-algs extension. Order is irrelevant.\n\tdefaultPubKeyAuthAlgos = []string{\n\t\tKeyAlgoED25519,\n\t\tKeyAlgoSKED25519,\n\t\tKeyAlgoSKECDSA256,\n\t\tKeyAlgoECDSA256,\n\t\tKeyAlgoECDSA384,\n\t\tKeyAlgoECDSA521,\n\t\tKeyAlgoRSASHA256,\n\t\tKeyAlgoRSASHA512,\n\t\tKeyAlgoRSA,\n\t\tInsecureKeyAlgoDSA,\n\t}\n\t// insecurePubKeyAuthAlgos specifies client public key authentication\n\t// algorithms implemented by this package and which have security issues.\n\tinsecurePubKeyAuthAlgos = []string{\n\t\tKeyAlgoRSA,\n\t\tInsecureKeyAlgoDSA,\n\t}\n)\n\n// NegotiatedAlgorithms defines algorithms negotiated between client and server.\ntype NegotiatedAlgorithms struct {\n\tKeyExchange string\n\tHostKey string\n\tRead DirectionAlgorithms\n\tWrite DirectionAlgorithms\n}\n\n// Algorithms defines a set of algorithms that can be configured in the client\n// or server config for negotiation during a handshake.\ntype Algorithms struct {\n\tKeyExchanges []string\n\tCiphers []string\n\tMACs []string\n\tHostKeys []string\n\tPublicKeyAuths []string\n}\n\nfunc init() {\n\tif fips140.Enabled() {\n\t\tdefaultHostKeyAlgos = slices.DeleteFunc(defaultHostKeyAlgos, func(algo string) bool {\n\t\t\t_, err := hashFunc(underlyingAlgo(algo))\n\t\t\treturn err != nil\n\t\t})\n\t\tdefaultPubKeyAuthAlgos = slices.DeleteFunc(defaultPubKeyAuthAlgos, func(algo string) bool {\n\t\t\t_, err := hashFunc(underlyingAlgo(algo))\n\t\t\treturn err != nil\n\t\t})\n\t}\n}\n\nfunc hashFunc(format string) (crypto.Hash, error) {\n\tswitch format {\n\tcase KeyAlgoRSASHA256, KeyAlgoECDSA256, KeyAlgoSKED25519, KeyAlgoSKECDSA256:\n\t\treturn crypto.SHA256, nil\n\tcase KeyAlgoECDSA384:\n\t\treturn crypto.SHA384, nil\n\tcase KeyAlgoRSASHA512, KeyAlgoECDSA521:\n\t\treturn crypto.SHA512, nil\n\tcase KeyAlgoED25519:\n\t\t// KeyAlgoED25519 doesn't pre-hash.\n\t\treturn 0, nil\n\tcase KeyAlgoRSA, InsecureKeyAlgoDSA:\n\t\tif fips140.Enabled() {\n\t\t\treturn 0, fmt.Errorf(\"ssh: hash algorithm for format %q not allowed in FIPS 140 mode\", format)\n\t\t}\n\t\treturn crypto.SHA1, nil\n\tdefault:\n\t\treturn 0, fmt.Errorf(\"ssh: hash algorithm for format %q not mapped\", format)\n\t}\n}\n\n// SupportedAlgorithms returns algorithms currently implemented by this package,\n// excluding those with security issues, which are returned by\n// InsecureAlgorithms. The algorithms listed here are in preference order.\nfunc SupportedAlgorithms() Algorithms {\n\treturn Algorithms{\n\t\tCiphers: slices.Clone(supportedCiphers),\n\t\tMACs: slices.Clone(supportedMACs),\n\t\tKeyExchanges: slices.Clone(supportedKexAlgos),\n\t\tHostKeys: slices.Clone(supportedHostKeyAlgos),\n\t\tPublicKeyAuths: slices.Clone(supportedPubKeyAuthAlgos),\n\t}\n}\n\n// InsecureAlgorithms returns algorithms currently implemented by this package\n// and which have security issues.\nfunc InsecureAlgorithms() Algorithms {\n\treturn Algorithms{\n\t\tKeyExchanges: slices.Clone(insecureKexAlgos),\n\t\tCiphers: slices.Clone(insecureCiphers),\n\t\tMACs: slices.Clone(insecureMACs),\n\t\tHostKeys: slices.Clone(insecureHostKeyAlgos),\n\t\tPublicKeyAuths: slices.Clone(insecurePubKeyAuthAlgos),\n\t}\n}\n\nvar supportedCompressions = []string{compressionNone}\n\n// algorithmsForKeyFormat returns the supported signature algorithms for a given\n// public key format (PublicKey.Type), in order of preference. See RFC 8332,\n// Section 2. See also the note in sendKexInit on backwards compatibility.\nfunc algorithmsForKeyFormat(keyFormat string) []string {\n\tswitch keyFormat {\n\tcase KeyAlgoRSA:\n\t\treturn []string{KeyAlgoRSASHA256, KeyAlgoRSASHA512, KeyAlgoRSA}\n\tcase CertAlgoRSAv01:\n\t\treturn []string{CertAlgoRSASHA256v01, CertAlgoRSASHA512v01, CertAlgoRSAv01}\n\tdefault:\n\t\treturn []string{keyFormat}\n\t}\n}\n\n// keyFormatForAlgorithm returns the key format corresponding to the given\n// signature algorithm. It returns an empty string if the signature algorithm is\n// invalid or unsupported.\nfunc keyFormatForAlgorithm(sigAlgo string) string {\n\tswitch sigAlgo {\n\tcase KeyAlgoRSA, KeyAlgoRSASHA256, KeyAlgoRSASHA512:\n\t\treturn KeyAlgoRSA\n\tcase CertAlgoRSAv01, CertAlgoRSASHA256v01, CertAlgoRSASHA512v01:\n\t\treturn CertAlgoRSAv01\n\tcase KeyAlgoED25519,\n\t\tKeyAlgoSKED25519,\n\t\tKeyAlgoSKECDSA256,\n\t\tKeyAlgoECDSA256,\n\t\tKeyAlgoECDSA384,\n\t\tKeyAlgoECDSA521,\n\t\tInsecureKeyAlgoDSA,\n\t\tInsecureCertAlgoDSAv01,\n\t\tCertAlgoECDSA256v01,\n\t\tCertAlgoECDSA384v01,\n\t\tCertAlgoECDSA521v01,\n\t\tCertAlgoSKECDSA256v01,\n\t\tCertAlgoED25519v01,\n\t\tCertAlgoSKED25519v01:\n\t\treturn sigAlgo\n\tdefault:\n\t\treturn \"\"\n\t}\n}\n\n// isRSA returns whether algo is a supported RSA algorithm, including certificate\n// algorithms.\nfunc isRSA(algo string) bool {\n\talgos := algorithmsForKeyFormat(KeyAlgoRSA)\n\treturn slices.Contains(algos, underlyingAlgo(algo))\n}\n\nfunc isRSACert(algo string) bool {\n\t_, ok := certKeyAlgoNames[algo]\n\tif !ok {\n\t\treturn false\n\t}\n\treturn isRSA(algo)\n}\n\n// unexpectedMessageError results when the SSH message that we received didn't\n// match what we wanted.\nfunc unexpectedMessageError(expected, got uint8) error {\n\treturn fmt.Errorf(\"ssh: unexpected message type %d (expected %d)\", got, expected)\n}\n\n// parseError results from a malformed SSH message.\nfunc parseError(tag uint8) error {\n\treturn fmt.Errorf(\"ssh: parse error in message type %d\", tag)\n}\n\nfunc findCommon(what string, client []string, server []string, isClient bool) (string, error) {\n\tfor _, c := range client {\n\t\tfor _, s := range server {\n\t\t\tif c == s {\n\t\t\t\treturn c, nil\n\t\t\t}\n\t\t}\n\t}\n\terr := &AlgorithmNegotiationError{\n\t\tWhat: what,\n\t}\n\tif isClient {\n\t\terr.SupportedAlgorithms = client\n\t\terr.RequestedAlgorithms = server\n\t} else {\n\t\terr.SupportedAlgorithms = server\n\t\terr.RequestedAlgorithms = client\n\t}\n\treturn \"\", err\n}\n\n// AlgorithmNegotiationError defines the error returned if the client and the\n// server cannot agree on an algorithm for key exchange, host key, cipher, MAC.\ntype AlgorithmNegotiationError struct {\n\tWhat string\n\t// RequestedAlgorithms lists the algorithms supported by the peer.\n\tRequestedAlgorithms []string\n\t// SupportedAlgorithms lists the algorithms supported on our side.\n\tSupportedAlgorithms []string\n}\n\nfunc (a *AlgorithmNegotiationError) Error() string {\n\treturn fmt.Sprintf(\"ssh: no common algorithm for %s; we offered: %v, peer offered: %v\",\n\t\ta.What, a.SupportedAlgorithms, a.RequestedAlgorithms)\n}\n\n// DirectionAlgorithms defines the algorithms negotiated in one direction\n// (either read or write).\ntype DirectionAlgorithms struct {\n\tCipher string\n\tMAC string\n\tcompression string\n}\n\n// rekeyBytes returns a rekeying intervals in bytes.\nfunc (a *DirectionAlgorithms) rekeyBytes() int64 {\n\t// According to RFC 4344 block ciphers should rekey after\n\t// 2^(BLOCKSIZE/4) blocks. For all AES flavors BLOCKSIZE is\n\t// 128.\n\tswitch a.Cipher {\n\tcase CipherAES128CTR, CipherAES192CTR, CipherAES256CTR, CipherAES128GCM, CipherAES256GCM, InsecureCipherAES128CBC:\n\t\treturn 16 * (1 << 32)\n\n\t}\n\n\t// For others, stick with RFC 4253 recommendation to rekey after 1 Gb of data.\n\treturn 1 << 30\n}\n\nvar aeadCiphers = map[string]bool{\n\tCipherAES128GCM: true,\n\tCipherAES256GCM: true,\n\tCipherChaCha20Poly1305: true,\n}\n\nfunc findAgreedAlgorithms(isClient bool, clientKexInit, serverKexInit *kexInitMsg) (algs *NegotiatedAlgorithms, err error) {\n\tresult := &NegotiatedAlgorithms{}\n\n\tresult.KeyExchange, err = findCommon(\"key exchange\", clientKexInit.KexAlgos, serverKexInit.KexAlgos, isClient)\n\tif err != nil {\n\t\treturn\n\t}\n\n\tresult.HostKey, err = findCommon(\"host key\", clientKexInit.ServerHostKeyAlgos, serverKexInit.ServerHostKeyAlgos, isClient)\n\tif err != nil {\n\t\treturn\n\t}\n\n\tstoc, ctos := &result.Write, &result.Read\n\tif isClient {\n\t\tctos, stoc = stoc, ctos\n\t}\n\n\tctos.Cipher, err = findCommon(\"client to server cipher\", clientKexInit.CiphersClientServer, serverKexInit.CiphersClientServer, isClient)\n\tif err != nil {\n\t\treturn\n\t}\n\n\tstoc.Cipher, err = findCommon(\"server to client cipher\", clientKexInit.CiphersServerClient, serverKexInit.CiphersServerClient, isClient)\n\tif err != nil {\n\t\treturn\n\t}\n\n\tif !aeadCiphers[ctos.Cipher] {\n\t\tctos.MAC, err = findCommon(\"client to server MAC\", clientKexInit.MACsClientServer, serverKexInit.MACsClientServer, isClient)\n\t\tif err != nil {\n\t\t\treturn\n\t\t}\n\t}\n\n\tif !aeadCiphers[stoc.Cipher] {\n\t\tstoc.MAC, err = findCommon(\"server to client MAC\", clientKexInit.MACsServerClient, serverKexInit.MACsServerClient, isClient)\n\t\tif err != nil {\n\t\t\treturn\n\t\t}\n\t}\n\n\tctos.compression, err = findCommon(\"client to server compression\", clientKexInit.CompressionClientServer, serverKexInit.CompressionClientServer, isClient)\n\tif err != nil {\n\t\treturn\n\t}\n\n\tstoc.compression, err = findCommon(\"server to client compression\", clientKexInit.CompressionServerClient, serverKexInit.CompressionServerClient, isClient)\n\tif err != nil {\n\t\treturn\n\t}\n\n\treturn result, nil\n}\n\n// If rekeythreshold is too small, we can't make any progress sending\n// stuff.\nconst minRekeyThreshold uint64 = 256\n\n// Config contains configuration data common to both ServerConfig and\n// ClientConfig.\ntype Config struct {\n\t// Rand provides the source of entropy for cryptographic\n\t// primitives. If Rand is nil, the cryptographic random reader\n\t// in package crypto/rand will be used.\n\tRand io.Reader\n\n\t// The maximum number of bytes sent or received after which a\n\t// new key is negotiated. It must be at least 256. If\n\t// unspecified, a size suitable for the chosen cipher is used.\n\tRekeyThreshold uint64\n\n\t// The allowed key exchanges algorithms. If unspecified then a default set\n\t// of algorithms is used. Unsupported values are silently ignored.\n\tKeyExchanges []string\n\n\t// The allowed cipher algorithms. If unspecified then a sensible default is\n\t// used. Unsupported values are silently ignored.\n\tCiphers []string\n\n\t// The allowed MAC algorithms. If unspecified then a sensible default is\n\t// used. Unsupported values are silently ignored.\n\tMACs []string\n}\n\n// SetDefaults sets sensible values for unset fields in config. This is\n// exported for testing: Configs passed to SSH functions are copied and have\n// default values set automatically.\nfunc (c *Config) SetDefaults() {\n\tif c.Rand == nil {\n\t\tc.Rand = rand.Reader\n\t}\n\tif c.Ciphers == nil {\n\t\tc.Ciphers = defaultCiphers\n\t}\n\tvar ciphers []string\n\tfor _, c := range c.Ciphers {\n\t\tif cipherModes[c] != nil {\n\t\t\t// Ignore the cipher if we have no cipherModes definition.\n\t\t\tciphers = append(ciphers, c)\n\t\t}\n\t}\n\tc.Ciphers = ciphers\n\n\tif c.KeyExchanges == nil {\n\t\tc.KeyExchanges = defaultKexAlgos\n\t}\n\tvar kexs []string\n\tfor _, k := range c.KeyExchanges {\n\t\tif kexAlgoMap[k] != nil {\n\t\t\t// Ignore the KEX if we have no kexAlgoMap definition.\n\t\t\tkexs = append(kexs, k)\n\t\t\tif k == KeyExchangeCurve25519 && !slices.Contains(c.KeyExchanges, keyExchangeCurve25519LibSSH) {\n\t\t\t\tkexs = append(kexs, keyExchangeCurve25519LibSSH)\n\t\t\t}\n\t\t}\n\t}\n\tc.KeyExchanges = kexs\n\n\tif c.MACs == nil {\n\t\tc.MACs = defaultMACs\n\t}\n\tvar macs []string\n\tfor _, m := range c.MACs {\n\t\tif macModes[m] != nil {\n\t\t\t// Ignore the MAC if we have no macModes definition.\n\t\t\tmacs = append(macs, m)\n\t\t}\n\t}\n\tc.MACs = macs\n\n\tif c.RekeyThreshold == 0 {\n\t\t// cipher specific default\n\t} else if c.RekeyThreshold < minRekeyThreshold {\n\t\tc.RekeyThreshold = minRekeyThreshold\n\t} else if c.RekeyThreshold >= math.MaxInt64 {\n\t\t// Avoid weirdness if somebody uses -1 as a threshold.\n\t\tc.RekeyThreshold = math.MaxInt64\n\t}\n}\n\n// buildDataSignedForAuth returns the data that is signed in order to prove\n// possession of a private key. See RFC 4252, section 7. algo is the advertised\n// algorithm, and may be a certificate type.\nfunc buildDataSignedForAuth(sessionID []byte, req userAuthRequestMsg, algo string, pubKey []byte) []byte {\n\tdata := struct {\n\t\tSession []byte\n\t\tType byte\n\t\tUser string\n\t\tService string\n\t\tMethod string\n\t\tSign bool\n\t\tAlgo string\n\t\tPubKey []byte\n\t}{\n\t\tsessionID,\n\t\tmsgUserAuthRequest,\n\t\treq.User,\n\t\treq.Service,\n\t\treq.Method,\n\t\ttrue,\n\t\talgo,\n\t\tpubKey,\n\t}\n\treturn Marshal(data)\n}\n\nfunc appendU16(buf []byte, n uint16) []byte {\n\treturn append(buf, byte(n>>8), byte(n))\n}\n\nfunc appendU32(buf []byte, n uint32) []byte {\n\treturn append(buf, byte(n>>24), byte(n>>16), byte(n>>8), byte(n))\n}\n\nfunc appendU64(buf []byte, n uint64) []byte {\n\treturn append(buf,\n\t\tbyte(n>>56), byte(n>>48), byte(n>>40), byte(n>>32),\n\t\tbyte(n>>24), byte(n>>16), byte(n>>8), byte(n))\n}\n\nfunc appendInt(buf []byte, n int) []byte {\n\treturn appendU32(buf, uint32(n))\n}\n\nfunc appendString(buf []byte, s string) []byte {\n\tbuf = appendU32(buf, uint32(len(s)))\n\tbuf = append(buf, s...)\n\treturn buf\n}\n\nfunc appendBool(buf []byte, b bool) []byte {\n\tif b {\n\t\treturn append(buf, 1)\n\t}\n\treturn append(buf, 0)\n}\n\n// newCond is a helper to hide the fact that there is no usable zero\n// value for sync.Cond.\nfunc newCond() *sync.Cond { return sync.NewCond(new(sync.Mutex)) }\n\n// window represents the buffer available to clients\n// wishing to write to a channel.\ntype window struct {\n\t*sync.Cond\n\twin uint32 // RFC 4254 5.2 says the window size can grow to 2^32-1\n\twriteWaiters int\n\tclosed bool\n}\n\n// add adds win to the amount of window available\n// for consumers.\nfunc (w *window) add(win uint32) bool {\n\t// a zero sized window adjust is a noop.\n\tif win == 0 {\n\t\treturn true\n\t}\n\tw.L.Lock()\n\tif w.win+win < win {\n\t\tw.L.Unlock()\n\t\treturn false\n\t}\n\tw.win += win\n\t// It is unusual that multiple goroutines would be attempting to reserve\n\t// window space, but not guaranteed. Use broadcast to notify all waiters\n\t// that additional window is available.\n\tw.Broadcast()\n\tw.L.Unlock()\n\treturn true\n}\n\n// close sets the window to closed, so all reservations fail\n// immediately.\nfunc (w *window) close() {\n\tw.L.Lock()\n\tw.closed = true\n\tw.Broadcast()\n\tw.L.Unlock()\n}\n\n// reserve reserves win from the available window capacity.\n// If no capacity remains, reserve will block. reserve may\n// return less than requested.\nfunc (w *window) reserve(win uint32) (uint32, error) {\n\tvar err error\n\tw.L.Lock()\n\tw.writeWaiters++\n\tw.Broadcast()\n\tfor w.win == 0 && !w.closed {\n\t\tw.Wait()\n\t}\n\tw.writeWaiters--\n\tif w.win < win {\n\t\twin = w.win\n\t}\n\tw.win -= win\n\tif w.closed {\n\t\terr = io.EOF\n\t}\n\tw.L.Unlock()\n\treturn win, err\n}\n\n// waitWriterBlocked waits until some goroutine is blocked for further\n// writes. It is used in tests only.\nfunc (w *window) waitWriterBlocked() {\n\tw.Cond.L.Lock()\n\tfor w.writeWaiters == 0 {\n\t\tw.Cond.Wait()\n\t}\n\tw.Cond.L.Unlock()\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/connection.go",
"content": "// Copyright 2013 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"fmt\"\n\t\"net\"\n)\n\n// OpenChannelError is returned if the other side rejects an\n// OpenChannel request.\ntype OpenChannelError struct {\n\tReason RejectionReason\n\tMessage string\n}\n\nfunc (e *OpenChannelError) Error() string {\n\treturn fmt.Sprintf(\"ssh: rejected: %s (%s)\", e.Reason, e.Message)\n}\n\n// ConnMetadata holds metadata for the connection.\ntype ConnMetadata interface {\n\t// User returns the user ID for this connection.\n\tUser() string\n\n\t// SessionID returns the session hash, also denoted by H.\n\tSessionID() []byte\n\n\t// ClientVersion returns the client's version string as hashed\n\t// into the session ID.\n\tClientVersion() []byte\n\n\t// ServerVersion returns the server's version string as hashed\n\t// into the session ID.\n\tServerVersion() []byte\n\n\t// RemoteAddr returns the remote address for this connection.\n\tRemoteAddr() net.Addr\n\n\t// LocalAddr returns the local address for this connection.\n\tLocalAddr() net.Addr\n}\n\n// Conn represents an SSH connection for both server and client roles.\n// Conn is the basis for implementing an application layer, such\n// as ClientConn, which implements the traditional shell access for\n// clients.\ntype Conn interface {\n\tConnMetadata\n\n\t// SendRequest sends a global request, and returns the\n\t// reply. If wantReply is true, it returns the response status\n\t// and payload. See also RFC 4254, section 4.\n\tSendRequest(name string, wantReply bool, payload []byte) (bool, []byte, error)\n\n\t// OpenChannel tries to open an channel. If the request is\n\t// rejected, it returns *OpenChannelError. On success it returns\n\t// the SSH Channel and a Go channel for incoming, out-of-band\n\t// requests. The Go channel must be serviced, or the\n\t// connection will hang.\n\tOpenChannel(name string, data []byte) (Channel, <-chan *Request, error)\n\n\t// Close closes the underlying network connection\n\tClose() error\n\n\t// Wait blocks until the connection has shut down, and returns the\n\t// error causing the shutdown.\n\tWait() error\n\n\t// TODO(hanwen): consider exposing:\n\t// RequestKeyChange\n\t// Disconnect\n}\n\n// AlgorithmsConnMetadata is a ConnMetadata that can return the algorithms\n// negotiated between client and server.\ntype AlgorithmsConnMetadata interface {\n\tConnMetadata\n\tAlgorithms() NegotiatedAlgorithms\n}\n\n// DiscardRequests consumes and rejects all requests from the\n// passed-in channel.\nfunc DiscardRequests(in <-chan *Request) {\n\tfor req := range in {\n\t\tif req.WantReply {\n\t\t\treq.Reply(false, nil)\n\t\t}\n\t}\n}\n\n// A connection represents an incoming connection.\ntype connection struct {\n\ttransport *handshakeTransport\n\tsshConn\n\n\t// The connection protocol.\n\t*mux\n}\n\nfunc (c *connection) Close() error {\n\treturn c.sshConn.conn.Close()\n}\n\n// sshConn provides net.Conn metadata, but disallows direct reads and\n// writes.\ntype sshConn struct {\n\tconn net.Conn\n\n\tuser string\n\tsessionID []byte\n\tclientVersion []byte\n\tserverVersion []byte\n\talgorithms NegotiatedAlgorithms\n}\n\nfunc dup(src []byte) []byte {\n\tdst := make([]byte, len(src))\n\tcopy(dst, src)\n\treturn dst\n}\n\nfunc (c *sshConn) User() string {\n\treturn c.user\n}\n\nfunc (c *sshConn) RemoteAddr() net.Addr {\n\treturn c.conn.RemoteAddr()\n}\n\nfunc (c *sshConn) Close() error {\n\treturn c.conn.Close()\n}\n\nfunc (c *sshConn) LocalAddr() net.Addr {\n\treturn c.conn.LocalAddr()\n}\n\nfunc (c *sshConn) SessionID() []byte {\n\treturn dup(c.sessionID)\n}\n\nfunc (c *sshConn) ClientVersion() []byte {\n\treturn dup(c.clientVersion)\n}\n\nfunc (c *sshConn) ServerVersion() []byte {\n\treturn dup(c.serverVersion)\n}\n\nfunc (c *sshConn) Algorithms() NegotiatedAlgorithms {\n\treturn c.algorithms\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/doc.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n/*\nPackage ssh implements an SSH client and server.\n\nSSH is a transport security protocol, an authentication protocol and a\nfamily of application protocols. The most typical application level\nprotocol is a remote shell and this is specifically implemented. However,\nthe multiplexed nature of SSH is exposed to users that wish to support\nothers.\n\nReferences:\n\n\t[PROTOCOL]: https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL?rev=HEAD\n\t[PROTOCOL.certkeys]: http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.certkeys?rev=HEAD\n\t[SSH-PARAMETERS]: http://www.iana.org/assignments/ssh-parameters/ssh-parameters.xml#ssh-parameters-1\n\t[SSH-CERTS]:\thttps://datatracker.ietf.org/doc/html/draft-miller-ssh-cert-01\n\t[FIPS 140-3 mode]: https://go.dev/doc/security/fips140\n\nThis package does not fall under the stability promise of the Go language itself,\nso its API may be changed when pressing needs arise.\n\n# FIPS 140-3 mode\n\nWhen the program is in [FIPS 140-3 mode], this package behaves as if only SP\n800-140C and SP 800-140D approved cipher suites, signature algorithms,\ncertificate public key types and sizes, and key exchange and derivation\nalgorithms were implemented. Others are silently ignored and not negotiated, or\nrejected. This set may depend on the algorithms supported by the FIPS 140-3 Go\nCryptographic Module selected with GOFIPS140, and may change across Go versions.\n*/\npackage ssh\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/handshake.go",
"content": "// Copyright 2013 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"net\"\n\t\"slices\"\n\t\"strings\"\n\t\"sync\"\n)\n\n// debugHandshake, if set, prints messages sent and received. Key\n// exchange messages are printed as if DH were used, so the debug\n// messages are wrong when using ECDH.\nconst debugHandshake = false\n\n// chanSize sets the amount of buffering SSH connections. This is\n// primarily for testing: setting chanSize=0 uncovers deadlocks more\n// quickly.\nconst chanSize = 16\n\n// maxPendingPackets sets the maximum number of packets to queue while waiting\n// for KEX to complete. This limits the total pending data to maxPendingPackets\n// * maxPacket bytes, which is ~16.8MB.\nconst maxPendingPackets = 64\n\n// keyingTransport is a packet based transport that supports key\n// changes. It need not be thread-safe. It should pass through\n// msgNewKeys in both directions.\ntype keyingTransport interface {\n\tpacketConn\n\n\t// prepareKeyChange sets up a key change. The key change for a\n\t// direction will be effected if a msgNewKeys message is sent\n\t// or received.\n\tprepareKeyChange(*NegotiatedAlgorithms, *kexResult) error\n\n\t// setStrictMode sets the strict KEX mode, notably triggering\n\t// sequence number resets on sending or receiving msgNewKeys.\n\t// If the sequence number is already > 1 when setStrictMode\n\t// is called, an error is returned.\n\tsetStrictMode() error\n\n\t// setInitialKEXDone indicates to the transport that the initial key exchange\n\t// was completed\n\tsetInitialKEXDone()\n}\n\n// handshakeTransport implements rekeying on top of a keyingTransport\n// and offers a thread-safe writePacket() interface.\ntype handshakeTransport struct {\n\tconn keyingTransport\n\tconfig *Config\n\n\tserverVersion []byte\n\tclientVersion []byte\n\n\t// hostKeys is non-empty if we are the server. In that case,\n\t// it contains all host keys that can be used to sign the\n\t// connection.\n\thostKeys []Signer\n\n\t// publicKeyAuthAlgorithms is non-empty if we are the server. In that case,\n\t// it contains the supported client public key authentication algorithms.\n\tpublicKeyAuthAlgorithms []string\n\n\t// hostKeyAlgorithms is non-empty if we are the client. In that case,\n\t// we accept these key types from the server as host key.\n\thostKeyAlgorithms []string\n\n\t// On read error, incoming is closed, and readError is set.\n\tincoming chan []byte\n\treadError error\n\n\tmu sync.Mutex\n\t// Condition for the above mutex. It is used to notify a completed key\n\t// exchange or a write failure. Writes can wait for this condition while a\n\t// key exchange is in progress.\n\twriteCond *sync.Cond\n\twriteError error\n\tsentInitPacket []byte\n\tsentInitMsg *kexInitMsg\n\t// Used to queue writes when a key exchange is in progress. The length is\n\t// limited by pendingPacketsSize. Once full, writes will block until the key\n\t// exchange is completed or an error occurs. If not empty, it is emptied\n\t// all at once when the key exchange is completed in kexLoop.\n\tpendingPackets [][]byte\n\twritePacketsLeft uint32\n\twriteBytesLeft int64\n\tuserAuthComplete bool // whether the user authentication phase is complete\n\n\t// If the read loop wants to schedule a kex, it pings this\n\t// channel, and the write loop will send out a kex\n\t// message.\n\trequestKex chan struct{}\n\n\t// If the other side requests or confirms a kex, its kexInit\n\t// packet is sent here for the write loop to find it.\n\tstartKex chan *pendingKex\n\tkexLoopDone chan struct{} // closed (with writeError non-nil) when kexLoop exits\n\n\t// data for host key checking\n\thostKeyCallback HostKeyCallback\n\tdialAddress string\n\tremoteAddr net.Addr\n\n\t// bannerCallback is non-empty if we are the client and it has been set in\n\t// ClientConfig. In that case it is called during the user authentication\n\t// dance to handle a custom server's message.\n\tbannerCallback BannerCallback\n\n\t// Algorithms agreed in the last key exchange.\n\talgorithms *NegotiatedAlgorithms\n\n\t// Counters exclusively owned by readLoop.\n\treadPacketsLeft uint32\n\treadBytesLeft int64\n\n\t// The session ID or nil if first kex did not complete yet.\n\tsessionID []byte\n\n\t// strictMode indicates if the other side of the handshake indicated\n\t// that we should be following the strict KEX protocol restrictions.\n\tstrictMode bool\n}\n\ntype pendingKex struct {\n\totherInit []byte\n\tdone chan error\n}\n\nfunc newHandshakeTransport(conn keyingTransport, config *Config, clientVersion, serverVersion []byte) *handshakeTransport {\n\tt := &handshakeTransport{\n\t\tconn: conn,\n\t\tserverVersion: serverVersion,\n\t\tclientVersion: clientVersion,\n\t\tincoming: make(chan []byte, chanSize),\n\t\trequestKex: make(chan struct{}, 1),\n\t\tstartKex: make(chan *pendingKex),\n\t\tkexLoopDone: make(chan struct{}),\n\n\t\tconfig: config,\n\t}\n\tt.writeCond = sync.NewCond(&t.mu)\n\tt.resetReadThresholds()\n\tt.resetWriteThresholds()\n\n\t// We always start with a mandatory key exchange.\n\tt.requestKex <- struct{}{}\n\treturn t\n}\n\nfunc newClientTransport(conn keyingTransport, clientVersion, serverVersion []byte, config *ClientConfig, dialAddr string, addr net.Addr) *handshakeTransport {\n\tt := newHandshakeTransport(conn, &config.Config, clientVersion, serverVersion)\n\tt.dialAddress = dialAddr\n\tt.remoteAddr = addr\n\tt.hostKeyCallback = config.HostKeyCallback\n\tt.bannerCallback = config.BannerCallback\n\tif config.HostKeyAlgorithms != nil {\n\t\tt.hostKeyAlgorithms = config.HostKeyAlgorithms\n\t} else {\n\t\tt.hostKeyAlgorithms = defaultHostKeyAlgos\n\t}\n\tgo t.readLoop()\n\tgo t.kexLoop()\n\treturn t\n}\n\nfunc newServerTransport(conn keyingTransport, clientVersion, serverVersion []byte, config *ServerConfig) *handshakeTransport {\n\tt := newHandshakeTransport(conn, &config.Config, clientVersion, serverVersion)\n\tt.hostKeys = config.hostKeys\n\tt.publicKeyAuthAlgorithms = config.PublicKeyAuthAlgorithms\n\tgo t.readLoop()\n\tgo t.kexLoop()\n\treturn t\n}\n\nfunc (t *handshakeTransport) getSessionID() []byte {\n\treturn t.sessionID\n}\n\nfunc (t *handshakeTransport) getAlgorithms() NegotiatedAlgorithms {\n\treturn *t.algorithms\n}\n\n// waitSession waits for the session to be established. This should be\n// the first thing to call after instantiating handshakeTransport.\nfunc (t *handshakeTransport) waitSession() error {\n\tp, err := t.readPacket()\n\tif err != nil {\n\t\treturn err\n\t}\n\tif p[0] != msgNewKeys {\n\t\treturn fmt.Errorf(\"ssh: first packet should be msgNewKeys\")\n\t}\n\n\treturn nil\n}\n\nfunc (t *handshakeTransport) id() string {\n\tif len(t.hostKeys) > 0 {\n\t\treturn \"server\"\n\t}\n\treturn \"client\"\n}\n\nfunc (t *handshakeTransport) printPacket(p []byte, write bool) {\n\taction := \"got\"\n\tif write {\n\t\taction = \"sent\"\n\t}\n\n\tif p[0] == msgChannelData || p[0] == msgChannelExtendedData {\n\t\tlog.Printf(\"%s %s data (packet %d bytes)\", t.id(), action, len(p))\n\t} else {\n\t\tmsg, err := decode(p)\n\t\tlog.Printf(\"%s %s %T %v (%v)\", t.id(), action, msg, msg, err)\n\t}\n}\n\nfunc (t *handshakeTransport) readPacket() ([]byte, error) {\n\tp, ok := <-t.incoming\n\tif !ok {\n\t\treturn nil, t.readError\n\t}\n\treturn p, nil\n}\n\nfunc (t *handshakeTransport) readLoop() {\n\tfirst := true\n\tfor {\n\t\tp, err := t.readOnePacket(first)\n\t\tfirst = false\n\t\tif err != nil {\n\t\t\tt.readError = err\n\t\t\tclose(t.incoming)\n\t\t\tbreak\n\t\t}\n\t\t// If this is the first kex, and strict KEX mode is enabled,\n\t\t// we don't ignore any messages, as they may be used to manipulate\n\t\t// the packet sequence numbers.\n\t\tif !(t.sessionID == nil && t.strictMode) && (p[0] == msgIgnore || p[0] == msgDebug) {\n\t\t\tcontinue\n\t\t}\n\t\tt.incoming <- p\n\t}\n\n\t// Stop writers too.\n\tt.recordWriteError(t.readError)\n\n\t// Unblock the writer should it wait for this.\n\tclose(t.startKex)\n\n\t// Don't close t.requestKex; it's also written to from writePacket.\n}\n\nfunc (t *handshakeTransport) pushPacket(p []byte) error {\n\tif debugHandshake {\n\t\tt.printPacket(p, true)\n\t}\n\treturn t.conn.writePacket(p)\n}\n\nfunc (t *handshakeTransport) getWriteError() error {\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\treturn t.writeError\n}\n\nfunc (t *handshakeTransport) recordWriteError(err error) {\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif t.writeError == nil && err != nil {\n\t\tt.writeError = err\n\t\tt.writeCond.Broadcast()\n\t}\n}\n\nfunc (t *handshakeTransport) requestKeyExchange() {\n\tselect {\n\tcase t.requestKex <- struct{}{}:\n\tdefault:\n\t\t// something already requested a kex, so do nothing.\n\t}\n}\n\nfunc (t *handshakeTransport) resetWriteThresholds() {\n\tt.writePacketsLeft = packetRekeyThreshold\n\tif t.config.RekeyThreshold > 0 {\n\t\tt.writeBytesLeft = int64(t.config.RekeyThreshold)\n\t} else if t.algorithms != nil {\n\t\tt.writeBytesLeft = t.algorithms.Write.rekeyBytes()\n\t} else {\n\t\tt.writeBytesLeft = 1 << 30\n\t}\n}\n\nfunc (t *handshakeTransport) kexLoop() {\n\nwrite:\n\tfor t.getWriteError() == nil {\n\t\tvar request *pendingKex\n\t\tvar sent bool\n\n\t\tfor request == nil || !sent {\n\t\t\tvar ok bool\n\t\t\tselect {\n\t\t\tcase request, ok = <-t.startKex:\n\t\t\t\tif !ok {\n\t\t\t\t\tbreak write\n\t\t\t\t}\n\t\t\tcase <-t.requestKex:\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\tif !sent {\n\t\t\t\tif err := t.sendKexInit(); err != nil {\n\t\t\t\t\tt.recordWriteError(err)\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tsent = true\n\t\t\t}\n\t\t}\n\n\t\tif err := t.getWriteError(); err != nil {\n\t\t\tif request != nil {\n\t\t\t\trequest.done <- err\n\t\t\t}\n\t\t\tbreak\n\t\t}\n\n\t\t// We're not servicing t.requestKex, but that is OK:\n\t\t// we never block on sending to t.requestKex.\n\n\t\t// We're not servicing t.startKex, but the remote end\n\t\t// has just sent us a kexInitMsg, so it can't send\n\t\t// another key change request, until we close the done\n\t\t// channel on the pendingKex request.\n\n\t\terr := t.enterKeyExchange(request.otherInit)\n\n\t\tt.mu.Lock()\n\t\tt.writeError = err\n\t\tt.sentInitPacket = nil\n\t\tt.sentInitMsg = nil\n\n\t\tt.resetWriteThresholds()\n\n\t\t// we have completed the key exchange. Since the\n\t\t// reader is still blocked, it is safe to clear out\n\t\t// the requestKex channel. This avoids the situation\n\t\t// where: 1) we consumed our own request for the\n\t\t// initial kex, and 2) the kex from the remote side\n\t\t// caused another send on the requestKex channel,\n\tclear:\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase <-t.requestKex:\n\t\t\t\t//\n\t\t\tdefault:\n\t\t\t\tbreak clear\n\t\t\t}\n\t\t}\n\n\t\trequest.done <- t.writeError\n\n\t\t// kex finished. Push packets that we received while\n\t\t// the kex was in progress. Don't look at t.startKex\n\t\t// and don't increment writtenSinceKex: if we trigger\n\t\t// another kex while we are still busy with the last\n\t\t// one, things will become very confusing.\n\t\tfor _, p := range t.pendingPackets {\n\t\t\tt.writeError = t.pushPacket(p)\n\t\t\tif t.writeError != nil {\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tt.pendingPackets = t.pendingPackets[:0]\n\t\t// Unblock writePacket if waiting for KEX.\n\t\tt.writeCond.Broadcast()\n\t\tt.mu.Unlock()\n\t}\n\n\t// Unblock reader.\n\tt.conn.Close()\n\n\t// drain startKex channel. We don't service t.requestKex\n\t// because nobody does blocking sends there.\n\tfor request := range t.startKex {\n\t\trequest.done <- t.getWriteError()\n\t}\n\n\t// Mark that the loop is done so that Close can return.\n\tclose(t.kexLoopDone)\n}\n\n// The protocol uses uint32 for packet counters, so we can't let them\n// reach 1<<32. We will actually read and write more packets than\n// this, though: the other side may send more packets, and after we\n// hit this limit on writing we will send a few more packets for the\n// key exchange itself.\nconst packetRekeyThreshold = (1 << 31)\n\nfunc (t *handshakeTransport) resetReadThresholds() {\n\tt.readPacketsLeft = packetRekeyThreshold\n\tif t.config.RekeyThreshold > 0 {\n\t\tt.readBytesLeft = int64(t.config.RekeyThreshold)\n\t} else if t.algorithms != nil {\n\t\tt.readBytesLeft = t.algorithms.Read.rekeyBytes()\n\t} else {\n\t\tt.readBytesLeft = 1 << 30\n\t}\n}\n\nfunc (t *handshakeTransport) readOnePacket(first bool) ([]byte, error) {\n\tp, err := t.conn.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif t.readPacketsLeft > 0 {\n\t\tt.readPacketsLeft--\n\t} else {\n\t\tt.requestKeyExchange()\n\t}\n\n\tif t.readBytesLeft > 0 {\n\t\tt.readBytesLeft -= int64(len(p))\n\t} else {\n\t\tt.requestKeyExchange()\n\t}\n\n\tif debugHandshake {\n\t\tt.printPacket(p, false)\n\t}\n\n\tif first && p[0] != msgKexInit {\n\t\treturn nil, fmt.Errorf(\"ssh: first packet should be msgKexInit\")\n\t}\n\n\tif p[0] != msgKexInit {\n\t\treturn p, nil\n\t}\n\n\tfirstKex := t.sessionID == nil\n\n\tkex := pendingKex{\n\t\tdone: make(chan error, 1),\n\t\totherInit: p,\n\t}\n\tt.startKex <- &kex\n\terr = <-kex.done\n\n\tif debugHandshake {\n\t\tlog.Printf(\"%s exited key exchange (first %v), err %v\", t.id(), firstKex, err)\n\t}\n\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tt.resetReadThresholds()\n\n\t// By default, a key exchange is hidden from higher layers by\n\t// translating it into msgIgnore.\n\tsuccessPacket := []byte{msgIgnore}\n\tif firstKex {\n\t\t// sendKexInit() for the first kex waits for\n\t\t// msgNewKeys so the authentication process is\n\t\t// guaranteed to happen over an encrypted transport.\n\t\tsuccessPacket = []byte{msgNewKeys}\n\t}\n\n\treturn successPacket, nil\n}\n\nconst (\n\tkexStrictClient = \"kex-strict-c-v00@openssh.com\"\n\tkexStrictServer = \"kex-strict-s-v00@openssh.com\"\n)\n\n// sendKexInit sends a key change message.\nfunc (t *handshakeTransport) sendKexInit() error {\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\tif t.sentInitMsg != nil {\n\t\t// kexInits may be sent either in response to the other side,\n\t\t// or because our side wants to initiate a key change, so we\n\t\t// may have already sent a kexInit. In that case, don't send a\n\t\t// second kexInit.\n\t\treturn nil\n\t}\n\n\tmsg := &kexInitMsg{\n\t\tCiphersClientServer: t.config.Ciphers,\n\t\tCiphersServerClient: t.config.Ciphers,\n\t\tMACsClientServer: t.config.MACs,\n\t\tMACsServerClient: t.config.MACs,\n\t\tCompressionClientServer: supportedCompressions,\n\t\tCompressionServerClient: supportedCompressions,\n\t}\n\tio.ReadFull(t.config.Rand, msg.Cookie[:])\n\n\t// We mutate the KexAlgos slice, in order to add the kex-strict extension algorithm,\n\t// and possibly to add the ext-info extension algorithm. Since the slice may be the\n\t// user owned KeyExchanges, we create our own slice in order to avoid using user\n\t// owned memory by mistake.\n\tmsg.KexAlgos = make([]string, 0, len(t.config.KeyExchanges)+2) // room for kex-strict and ext-info\n\tmsg.KexAlgos = append(msg.KexAlgos, t.config.KeyExchanges...)\n\n\tisServer := len(t.hostKeys) > 0\n\tif isServer {\n\t\tfor _, k := range t.hostKeys {\n\t\t\t// If k is a MultiAlgorithmSigner, we restrict the signature\n\t\t\t// algorithms. If k is a AlgorithmSigner, presume it supports all\n\t\t\t// signature algorithms associated with the key format. If k is not\n\t\t\t// an AlgorithmSigner, we can only assume it only supports the\n\t\t\t// algorithms that matches the key format. (This means that Sign\n\t\t\t// can't pick a different default).\n\t\t\tkeyFormat := k.PublicKey().Type()\n\n\t\t\tswitch s := k.(type) {\n\t\t\tcase MultiAlgorithmSigner:\n\t\t\t\tfor _, algo := range algorithmsForKeyFormat(keyFormat) {\n\t\t\t\t\tif slices.Contains(s.Algorithms(), underlyingAlgo(algo)) {\n\t\t\t\t\t\tmsg.ServerHostKeyAlgos = append(msg.ServerHostKeyAlgos, algo)\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\tcase AlgorithmSigner:\n\t\t\t\tmsg.ServerHostKeyAlgos = append(msg.ServerHostKeyAlgos, algorithmsForKeyFormat(keyFormat)...)\n\t\t\tdefault:\n\t\t\t\tmsg.ServerHostKeyAlgos = append(msg.ServerHostKeyAlgos, keyFormat)\n\t\t\t}\n\t\t}\n\n\t\tif t.sessionID == nil {\n\t\t\tmsg.KexAlgos = append(msg.KexAlgos, kexStrictServer)\n\t\t}\n\t} else {\n\t\tmsg.ServerHostKeyAlgos = t.hostKeyAlgorithms\n\n\t\t// As a client we opt in to receiving SSH_MSG_EXT_INFO so we know what\n\t\t// algorithms the server supports for public key authentication. See RFC\n\t\t// 8308, Section 2.1.\n\t\t//\n\t\t// We also send the strict KEX mode extension algorithm, in order to opt\n\t\t// into the strict KEX mode.\n\t\tif firstKeyExchange := t.sessionID == nil; firstKeyExchange {\n\t\t\tmsg.KexAlgos = append(msg.KexAlgos, \"ext-info-c\")\n\t\t\tmsg.KexAlgos = append(msg.KexAlgos, kexStrictClient)\n\t\t}\n\n\t}\n\n\tpacket := Marshal(msg)\n\n\t// writePacket destroys the contents, so save a copy.\n\tpacketCopy := make([]byte, len(packet))\n\tcopy(packetCopy, packet)\n\n\tif err := t.pushPacket(packetCopy); err != nil {\n\t\treturn err\n\t}\n\n\tt.sentInitMsg = msg\n\tt.sentInitPacket = packet\n\n\treturn nil\n}\n\nvar errSendBannerPhase = errors.New(\"ssh: SendAuthBanner outside of authentication phase\")\n\nfunc (t *handshakeTransport) writePacket(p []byte) error {\n\tt.mu.Lock()\n\tdefer t.mu.Unlock()\n\n\tswitch p[0] {\n\tcase msgKexInit:\n\t\treturn errors.New(\"ssh: only handshakeTransport can send kexInit\")\n\tcase msgNewKeys:\n\t\treturn errors.New(\"ssh: only handshakeTransport can send newKeys\")\n\tcase msgUserAuthBanner:\n\t\tif t.userAuthComplete {\n\t\t\treturn errSendBannerPhase\n\t\t}\n\tcase msgUserAuthSuccess:\n\t\tt.userAuthComplete = true\n\t}\n\n\tif t.writeError != nil {\n\t\treturn t.writeError\n\t}\n\n\tif t.sentInitMsg != nil {\n\t\tif len(t.pendingPackets) < maxPendingPackets {\n\t\t\t// Copy the packet so the writer can reuse the buffer.\n\t\t\tcp := make([]byte, len(p))\n\t\t\tcopy(cp, p)\n\t\t\tt.pendingPackets = append(t.pendingPackets, cp)\n\t\t\treturn nil\n\t\t}\n\t\tfor t.sentInitMsg != nil {\n\t\t\t// Block and wait for KEX to complete or an error.\n\t\t\tt.writeCond.Wait()\n\t\t\tif t.writeError != nil {\n\t\t\t\treturn t.writeError\n\t\t\t}\n\t\t}\n\t}\n\n\tif t.writeBytesLeft > 0 {\n\t\tt.writeBytesLeft -= int64(len(p))\n\t} else {\n\t\tt.requestKeyExchange()\n\t}\n\n\tif t.writePacketsLeft > 0 {\n\t\tt.writePacketsLeft--\n\t} else {\n\t\tt.requestKeyExchange()\n\t}\n\n\tif err := t.pushPacket(p); err != nil {\n\t\tt.writeError = err\n\t\tt.writeCond.Broadcast()\n\t}\n\n\treturn nil\n}\n\nfunc (t *handshakeTransport) Close() error {\n\t// Close the connection. This should cause the readLoop goroutine to wake up\n\t// and close t.startKex, which will shut down kexLoop if running.\n\terr := t.conn.Close()\n\n\t// Wait for the kexLoop goroutine to complete.\n\t// At that point we know that the readLoop goroutine is complete too,\n\t// because kexLoop itself waits for readLoop to close the startKex channel.\n\t<-t.kexLoopDone\n\n\treturn err\n}\n\nfunc (t *handshakeTransport) enterKeyExchange(otherInitPacket []byte) error {\n\tif debugHandshake {\n\t\tlog.Printf(\"%s entered key exchange\", t.id())\n\t}\n\n\totherInit := &kexInitMsg{}\n\tif err := Unmarshal(otherInitPacket, otherInit); err != nil {\n\t\treturn err\n\t}\n\n\tmagics := handshakeMagics{\n\t\tclientVersion: t.clientVersion,\n\t\tserverVersion: t.serverVersion,\n\t\tclientKexInit: otherInitPacket,\n\t\tserverKexInit: t.sentInitPacket,\n\t}\n\n\tclientInit := otherInit\n\tserverInit := t.sentInitMsg\n\tisClient := len(t.hostKeys) == 0\n\tif isClient {\n\t\tclientInit, serverInit = serverInit, clientInit\n\n\t\tmagics.clientKexInit = t.sentInitPacket\n\t\tmagics.serverKexInit = otherInitPacket\n\t}\n\n\tvar err error\n\tt.algorithms, err = findAgreedAlgorithms(isClient, clientInit, serverInit)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tif t.sessionID == nil && ((isClient && slices.Contains(serverInit.KexAlgos, kexStrictServer)) || (!isClient && slices.Contains(clientInit.KexAlgos, kexStrictClient))) {\n\t\tt.strictMode = true\n\t\tif err := t.conn.setStrictMode(); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\t// We don't send FirstKexFollows, but we handle receiving it.\n\t//\n\t// RFC 4253 section 7 defines the kex and the agreement method for\n\t// first_kex_packet_follows. It states that the guessed packet\n\t// should be ignored if the \"kex algorithm and/or the host\n\t// key algorithm is guessed wrong (server and client have\n\t// different preferred algorithm), or if any of the other\n\t// algorithms cannot be agreed upon\". The other algorithms have\n\t// already been checked above so the kex algorithm and host key\n\t// algorithm are checked here.\n\tif otherInit.FirstKexFollows && (clientInit.KexAlgos[0] != serverInit.KexAlgos[0] || clientInit.ServerHostKeyAlgos[0] != serverInit.ServerHostKeyAlgos[0]) {\n\t\t// other side sent a kex message for the wrong algorithm,\n\t\t// which we have to ignore.\n\t\tif _, err := t.conn.readPacket(); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\tkex, ok := kexAlgoMap[t.algorithms.KeyExchange]\n\tif !ok {\n\t\treturn fmt.Errorf(\"ssh: unexpected key exchange algorithm %v\", t.algorithms.KeyExchange)\n\t}\n\n\tvar result *kexResult\n\tif len(t.hostKeys) > 0 {\n\t\tresult, err = t.server(kex, &magics)\n\t} else {\n\t\tresult, err = t.client(kex, &magics)\n\t}\n\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tfirstKeyExchange := t.sessionID == nil\n\tif firstKeyExchange {\n\t\tt.sessionID = result.H\n\t}\n\tresult.SessionID = t.sessionID\n\n\tif err := t.conn.prepareKeyChange(t.algorithms, result); err != nil {\n\t\treturn err\n\t}\n\tif err = t.conn.writePacket([]byte{msgNewKeys}); err != nil {\n\t\treturn err\n\t}\n\n\t// On the server side, after the first SSH_MSG_NEWKEYS, send a SSH_MSG_EXT_INFO\n\t// message with the server-sig-algs extension if the client supports it. See\n\t// RFC 8308, Sections 2.4 and 3.1, and [PROTOCOL], Section 1.9.\n\tif !isClient && firstKeyExchange && slices.Contains(clientInit.KexAlgos, \"ext-info-c\") {\n\t\tsupportedPubKeyAuthAlgosList := strings.Join(t.publicKeyAuthAlgorithms, \",\")\n\t\textInfo := &extInfoMsg{\n\t\t\tNumExtensions: 2,\n\t\t\tPayload: make([]byte, 0, 4+15+4+len(supportedPubKeyAuthAlgosList)+4+16+4+1),\n\t\t}\n\t\textInfo.Payload = appendInt(extInfo.Payload, len(\"server-sig-algs\"))\n\t\textInfo.Payload = append(extInfo.Payload, \"server-sig-algs\"...)\n\t\textInfo.Payload = appendInt(extInfo.Payload, len(supportedPubKeyAuthAlgosList))\n\t\textInfo.Payload = append(extInfo.Payload, supportedPubKeyAuthAlgosList...)\n\t\textInfo.Payload = appendInt(extInfo.Payload, len(\"ping@openssh.com\"))\n\t\textInfo.Payload = append(extInfo.Payload, \"ping@openssh.com\"...)\n\t\textInfo.Payload = appendInt(extInfo.Payload, 1)\n\t\textInfo.Payload = append(extInfo.Payload, \"0\"...)\n\t\tif err := t.conn.writePacket(Marshal(extInfo)); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\n\tif packet, err := t.conn.readPacket(); err != nil {\n\t\treturn err\n\t} else if packet[0] != msgNewKeys {\n\t\treturn unexpectedMessageError(msgNewKeys, packet[0])\n\t}\n\n\tif firstKeyExchange {\n\t\t// Indicates to the transport that the first key exchange is completed\n\t\t// after receiving SSH_MSG_NEWKEYS.\n\t\tt.conn.setInitialKEXDone()\n\t}\n\n\treturn nil\n}\n\n// algorithmSignerWrapper is an AlgorithmSigner that only supports the default\n// key format algorithm.\n//\n// This is technically a violation of the AlgorithmSigner interface, but it\n// should be unreachable given where we use this. Anyway, at least it returns an\n// error instead of panicing or producing an incorrect signature.\ntype algorithmSignerWrapper struct {\n\tSigner\n}\n\nfunc (a algorithmSignerWrapper) SignWithAlgorithm(rand io.Reader, data []byte, algorithm string) (*Signature, error) {\n\tif algorithm != underlyingAlgo(a.PublicKey().Type()) {\n\t\treturn nil, errors.New(\"ssh: internal error: algorithmSignerWrapper invoked with non-default algorithm\")\n\t}\n\treturn a.Sign(rand, data)\n}\n\nfunc pickHostKey(hostKeys []Signer, algo string) AlgorithmSigner {\n\tfor _, k := range hostKeys {\n\t\tif s, ok := k.(MultiAlgorithmSigner); ok {\n\t\t\tif !slices.Contains(s.Algorithms(), underlyingAlgo(algo)) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t}\n\n\t\tif algo == k.PublicKey().Type() {\n\t\t\treturn algorithmSignerWrapper{k}\n\t\t}\n\n\t\tk, ok := k.(AlgorithmSigner)\n\t\tif !ok {\n\t\t\tcontinue\n\t\t}\n\t\tfor _, a := range algorithmsForKeyFormat(k.PublicKey().Type()) {\n\t\t\tif algo == a {\n\t\t\t\treturn k\n\t\t\t}\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc (t *handshakeTransport) server(kex kexAlgorithm, magics *handshakeMagics) (*kexResult, error) {\n\thostKey := pickHostKey(t.hostKeys, t.algorithms.HostKey)\n\tif hostKey == nil {\n\t\treturn nil, errors.New(\"ssh: internal error: negotiated unsupported signature type\")\n\t}\n\n\tr, err := kex.Server(t.conn, t.config.Rand, magics, hostKey, t.algorithms.HostKey)\n\treturn r, err\n}\n\nfunc (t *handshakeTransport) client(kex kexAlgorithm, magics *handshakeMagics) (*kexResult, error) {\n\tresult, err := kex.Client(t.conn, t.config.Rand, magics)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\thostKey, err := ParsePublicKey(result.HostKey)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tif err := verifyHostKeySignature(hostKey, t.algorithms.HostKey, result); err != nil {\n\t\treturn nil, err\n\t}\n\n\terr = t.hostKeyCallback(t.dialAddress, t.remoteAddr, hostKey)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn result, nil\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/internal/bcrypt_pbkdf/bcrypt_pbkdf.go",
"content": "// Copyright 2014 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package bcrypt_pbkdf implements bcrypt_pbkdf(3) from OpenBSD.\n//\n// See https://flak.tedunangst.com/post/bcrypt-pbkdf and\n// https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/lib/libutil/bcrypt_pbkdf.c.\npackage bcrypt_pbkdf\n\nimport (\n\t\"crypto/sha512\"\n\t\"errors\"\n\t\"golang.org/x/crypto/blowfish\"\n)\n\nconst blockSize = 32\n\n// Key derives a key from the password, salt and rounds count, returning a\n// []byte of length keyLen that can be used as cryptographic key.\nfunc Key(password, salt []byte, rounds, keyLen int) ([]byte, error) {\n\tif rounds < 1 {\n\t\treturn nil, errors.New(\"bcrypt_pbkdf: number of rounds is too small\")\n\t}\n\tif len(password) == 0 {\n\t\treturn nil, errors.New(\"bcrypt_pbkdf: empty password\")\n\t}\n\tif len(salt) == 0 || len(salt) > 1<<20 {\n\t\treturn nil, errors.New(\"bcrypt_pbkdf: bad salt length\")\n\t}\n\tif keyLen > 1024 {\n\t\treturn nil, errors.New(\"bcrypt_pbkdf: keyLen is too large\")\n\t}\n\n\tnumBlocks := (keyLen + blockSize - 1) / blockSize\n\tkey := make([]byte, numBlocks*blockSize)\n\n\th := sha512.New()\n\th.Write(password)\n\tshapass := h.Sum(nil)\n\n\tshasalt := make([]byte, 0, sha512.Size)\n\tcnt, tmp := make([]byte, 4), make([]byte, blockSize)\n\tfor block := 1; block <= numBlocks; block++ {\n\t\th.Reset()\n\t\th.Write(salt)\n\t\tcnt[0] = byte(block >> 24)\n\t\tcnt[1] = byte(block >> 16)\n\t\tcnt[2] = byte(block >> 8)\n\t\tcnt[3] = byte(block)\n\t\th.Write(cnt)\n\t\tbcryptHash(tmp, shapass, h.Sum(shasalt))\n\n\t\tout := make([]byte, blockSize)\n\t\tcopy(out, tmp)\n\t\tfor i := 2; i <= rounds; i++ {\n\t\t\th.Reset()\n\t\t\th.Write(tmp)\n\t\t\tbcryptHash(tmp, shapass, h.Sum(shasalt))\n\t\t\tfor j := 0; j < len(out); j++ {\n\t\t\t\tout[j] ^= tmp[j]\n\t\t\t}\n\t\t}\n\n\t\tfor i, v := range out {\n\t\t\tkey[i*numBlocks+(block-1)] = v\n\t\t}\n\t}\n\treturn key[:keyLen], nil\n}\n\nvar magic = []byte(\"OxychromaticBlowfishSwatDynamite\")\n\nfunc bcryptHash(out, shapass, shasalt []byte) {\n\tc, err := blowfish.NewSaltedCipher(shapass, shasalt)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tfor i := 0; i < 64; i++ {\n\t\tblowfish.ExpandKey(shasalt, c)\n\t\tblowfish.ExpandKey(shapass, c)\n\t}\n\tcopy(out, magic)\n\tfor i := 0; i < 32; i += 8 {\n\t\tfor j := 0; j < 64; j++ {\n\t\t\tc.Encrypt(out[i:i+8], out[i:i+8])\n\t\t}\n\t}\n\t// Swap bytes due to different endianness.\n\tfor i := 0; i < 32; i += 4 {\n\t\tout[i+3], out[i+2], out[i+1], out[i] = out[i], out[i+1], out[i+2], out[i+3]\n\t}\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/kex.go",
"content": "// Copyright 2013 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"crypto\"\n\t\"crypto/ecdsa\"\n\t\"crypto/elliptic\"\n\t\"crypto/fips140\"\n\t\"crypto/rand\"\n\t\"encoding/binary\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"math/big\"\n\t\"slices\"\n\n\t\"golang.org/x/crypto/curve25519\"\n)\n\nconst (\n\t// This is the group called diffie-hellman-group1-sha1 in RFC 4253 and\n\t// Oakley Group 2 in RFC 2409.\n\toakleyGroup2 = \"FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD129024E088A67CC74020BBEA63B139B22514A08798E3404DDEF9519B3CD3A431B302B0A6DF25F14374FE1356D6D51C245E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7EDEE386BFB5A899FA5AE9F24117C4B1FE649286651ECE65381FFFFFFFFFFFFFFFF\"\n\t// This is the group called diffie-hellman-group14-sha1 in RFC 4253 and\n\t// Oakley Group 14 in RFC 3526.\n\toakleyGroup14 = \"FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD129024E088A67CC74020BBEA63B139B22514A08798E3404DDEF9519B3CD3A431B302B0A6DF25F14374FE1356D6D51C245E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7EDEE386BFB5A899FA5AE9F24117C4B1FE649286651ECE45B3DC2007CB8A163BF0598DA48361C55D39A69163FA8FD24CF5F83655D23DCA3AD961C62F356208552BB9ED529077096966D670C354E4ABC9804F1746C08CA18217C32905E462E36CE3BE39E772C180E86039B2783A2EC07A28FB5C55DF06F4C52C9DE2BCBF6955817183995497CEA956AE515D2261898FA051015728E5A8AACAA68FFFFFFFFFFFFFFFF\"\n\t// This is the group called diffie-hellman-group15-sha512 in RFC 8268 and\n\t// Oakley Group 15 in RFC 3526.\n\toakleyGroup15 = \"FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD129024E088A67CC74020BBEA63B139B22514A08798E3404DDEF9519B3CD3A431B302B0A6DF25F14374FE1356D6D51C245E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7EDEE386BFB5A899FA5AE9F24117C4B1FE649286651ECE45B3DC2007CB8A163BF0598DA48361C55D39A69163FA8FD24CF5F83655D23DCA3AD961C62F356208552BB9ED529077096966D670C354E4ABC9804F1746C08CA18217C32905E462E36CE3BE39E772C180E86039B2783A2EC07A28FB5C55DF06F4C52C9DE2BCBF6955817183995497CEA956AE515D2261898FA051015728E5A8AAAC42DAD33170D04507A33A85521ABDF1CBA64ECFB850458DBEF0A8AEA71575D060C7DB3970F85A6E1E4C7ABF5AE8CDB0933D71E8C94E04A25619DCEE3D2261AD2EE6BF12FFA06D98A0864D87602733EC86A64521F2B18177B200CBBE117577A615D6C770988C0BAD946E208E24FA074E5AB3143DB5BFCE0FD108E4B82D120A93AD2CAFFFFFFFFFFFFFFFF\"\n\t// This is the group called diffie-hellman-group16-sha512 in RFC 8268 and\n\t// Oakley Group 16 in RFC 3526.\n\toakleyGroup16 = \"FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD129024E088A67CC74020BBEA63B139B22514A08798E3404DDEF9519B3CD3A431B302B0A6DF25F14374FE1356D6D51C245E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7EDEE386BFB5A899FA5AE9F24117C4B1FE649286651ECE45B3DC2007CB8A163BF0598DA48361C55D39A69163FA8FD24CF5F83655D23DCA3AD961C62F356208552BB9ED529077096966D670C354E4ABC9804F1746C08CA18217C32905E462E36CE3BE39E772C180E86039B2783A2EC07A28FB5C55DF06F4C52C9DE2BCBF6955817183995497CEA956AE515D2261898FA051015728E5A8AAAC42DAD33170D04507A33A85521ABDF1CBA64ECFB850458DBEF0A8AEA71575D060C7DB3970F85A6E1E4C7ABF5AE8CDB0933D71E8C94E04A25619DCEE3D2261AD2EE6BF12FFA06D98A0864D87602733EC86A64521F2B18177B200CBBE117577A615D6C770988C0BAD946E208E24FA074E5AB3143DB5BFCE0FD108E4B82D120A92108011A723C12A787E6D788719A10BDBA5B2699C327186AF4E23C1A946834B6150BDA2583E9CA2AD44CE8DBBBC2DB04DE8EF92E8EFC141FBECAA6287C59474E6BC05D99B2964FA090C3A2233BA186515BE7ED1F612970CEE2D7AFB81BDD762170481CD0069127D5B05AA993B4EA988D8FDDC186FFB7DC90A6C08F4DF435C934063199FFFFFFFFFFFFFFFF\"\n)\n\n// kexResult captures the outcome of a key exchange.\ntype kexResult struct {\n\t// Session hash. See also RFC 4253, section 8.\n\tH []byte\n\n\t// Shared secret. See also RFC 4253, section 8.\n\tK []byte\n\n\t// Host key as hashed into H.\n\tHostKey []byte\n\n\t// Signature of H.\n\tSignature []byte\n\n\t// A cryptographic hash function that matches the security\n\t// level of the key exchange algorithm. It is used for\n\t// calculating H, and for deriving keys from H and K.\n\tHash crypto.Hash\n\n\t// The session ID, which is the first H computed. This is used\n\t// to derive key material inside the transport.\n\tSessionID []byte\n}\n\n// handshakeMagics contains data that is always included in the\n// session hash.\ntype handshakeMagics struct {\n\tclientVersion, serverVersion []byte\n\tclientKexInit, serverKexInit []byte\n}\n\nfunc (m *handshakeMagics) write(w io.Writer) {\n\twriteString(w, m.clientVersion)\n\twriteString(w, m.serverVersion)\n\twriteString(w, m.clientKexInit)\n\twriteString(w, m.serverKexInit)\n}\n\n// kexAlgorithm abstracts different key exchange algorithms.\ntype kexAlgorithm interface {\n\t// Server runs server-side key agreement, signing the result\n\t// with a hostkey. algo is the negotiated algorithm, and may\n\t// be a certificate type.\n\tServer(p packetConn, rand io.Reader, magics *handshakeMagics, s AlgorithmSigner, algo string) (*kexResult, error)\n\n\t// Client runs the client-side key agreement. Caller is\n\t// responsible for verifying the host key signature.\n\tClient(p packetConn, rand io.Reader, magics *handshakeMagics) (*kexResult, error)\n}\n\n// dhGroup is a multiplicative group suitable for implementing Diffie-Hellman key agreement.\ntype dhGroup struct {\n\tg, p, pMinus1 *big.Int\n\thashFunc crypto.Hash\n}\n\nfunc (group *dhGroup) diffieHellman(theirPublic, myPrivate *big.Int) (*big.Int, error) {\n\tif theirPublic.Cmp(bigOne) <= 0 || theirPublic.Cmp(group.pMinus1) >= 0 {\n\t\treturn nil, errors.New(\"ssh: DH parameter out of bounds\")\n\t}\n\treturn new(big.Int).Exp(theirPublic, myPrivate, group.p), nil\n}\n\nfunc (group *dhGroup) Client(c packetConn, randSource io.Reader, magics *handshakeMagics) (*kexResult, error) {\n\tvar x *big.Int\n\tfor {\n\t\tvar err error\n\t\tif x, err = rand.Int(randSource, group.pMinus1); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tif x.Sign() > 0 {\n\t\t\tbreak\n\t\t}\n\t}\n\n\tX := new(big.Int).Exp(group.g, x, group.p)\n\tkexDHInit := kexDHInitMsg{\n\t\tX: X,\n\t}\n\tif err := c.writePacket(Marshal(&kexDHInit)); err != nil {\n\t\treturn nil, err\n\t}\n\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar kexDHReply kexDHReplyMsg\n\tif err = Unmarshal(packet, &kexDHReply); err != nil {\n\t\treturn nil, err\n\t}\n\n\tki, err := group.diffieHellman(kexDHReply.Y, x)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\th := group.hashFunc.New()\n\tmagics.write(h)\n\twriteString(h, kexDHReply.HostKey)\n\twriteInt(h, X)\n\twriteInt(h, kexDHReply.Y)\n\tK := make([]byte, intLength(ki))\n\tmarshalInt(K, ki)\n\th.Write(K)\n\n\treturn &kexResult{\n\t\tH: h.Sum(nil),\n\t\tK: K,\n\t\tHostKey: kexDHReply.HostKey,\n\t\tSignature: kexDHReply.Signature,\n\t\tHash: group.hashFunc,\n\t}, nil\n}\n\nfunc (group *dhGroup) Server(c packetConn, randSource io.Reader, magics *handshakeMagics, priv AlgorithmSigner, algo string) (result *kexResult, err error) {\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn\n\t}\n\tvar kexDHInit kexDHInitMsg\n\tif err = Unmarshal(packet, &kexDHInit); err != nil {\n\t\treturn\n\t}\n\n\tvar y *big.Int\n\tfor {\n\t\tif y, err = rand.Int(randSource, group.pMinus1); err != nil {\n\t\t\treturn\n\t\t}\n\t\tif y.Sign() > 0 {\n\t\t\tbreak\n\t\t}\n\t}\n\n\tY := new(big.Int).Exp(group.g, y, group.p)\n\tki, err := group.diffieHellman(kexDHInit.X, y)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\thostKeyBytes := priv.PublicKey().Marshal()\n\n\th := group.hashFunc.New()\n\tmagics.write(h)\n\twriteString(h, hostKeyBytes)\n\twriteInt(h, kexDHInit.X)\n\twriteInt(h, Y)\n\n\tK := make([]byte, intLength(ki))\n\tmarshalInt(K, ki)\n\th.Write(K)\n\n\tH := h.Sum(nil)\n\n\t// H is already a hash, but the hostkey signing will apply its\n\t// own key-specific hash algorithm.\n\tsig, err := signAndMarshal(priv, randSource, H, algo)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tkexDHReply := kexDHReplyMsg{\n\t\tHostKey: hostKeyBytes,\n\t\tY: Y,\n\t\tSignature: sig,\n\t}\n\tpacket = Marshal(&kexDHReply)\n\n\terr = c.writePacket(packet)\n\treturn &kexResult{\n\t\tH: H,\n\t\tK: K,\n\t\tHostKey: hostKeyBytes,\n\t\tSignature: sig,\n\t\tHash: group.hashFunc,\n\t}, err\n}\n\n// ecdh performs Elliptic Curve Diffie-Hellman key exchange as\n// described in RFC 5656, section 4.\ntype ecdh struct {\n\tcurve elliptic.Curve\n}\n\nfunc (kex *ecdh) Client(c packetConn, rand io.Reader, magics *handshakeMagics) (*kexResult, error) {\n\tephKey, err := ecdsa.GenerateKey(kex.curve, rand)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tkexInit := kexECDHInitMsg{\n\t\tClientPubKey: elliptic.Marshal(kex.curve, ephKey.PublicKey.X, ephKey.PublicKey.Y),\n\t}\n\n\tserialized := Marshal(&kexInit)\n\tif err := c.writePacket(serialized); err != nil {\n\t\treturn nil, err\n\t}\n\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar reply kexECDHReplyMsg\n\tif err = Unmarshal(packet, &reply); err != nil {\n\t\treturn nil, err\n\t}\n\n\tx, y, err := unmarshalECKey(kex.curve, reply.EphemeralPubKey)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// generate shared secret\n\tsecret, _ := kex.curve.ScalarMult(x, y, ephKey.D.Bytes())\n\n\th := ecHash(kex.curve).New()\n\tmagics.write(h)\n\twriteString(h, reply.HostKey)\n\twriteString(h, kexInit.ClientPubKey)\n\twriteString(h, reply.EphemeralPubKey)\n\tK := make([]byte, intLength(secret))\n\tmarshalInt(K, secret)\n\th.Write(K)\n\n\treturn &kexResult{\n\t\tH: h.Sum(nil),\n\t\tK: K,\n\t\tHostKey: reply.HostKey,\n\t\tSignature: reply.Signature,\n\t\tHash: ecHash(kex.curve),\n\t}, nil\n}\n\n// unmarshalECKey parses and checks an EC key.\nfunc unmarshalECKey(curve elliptic.Curve, pubkey []byte) (x, y *big.Int, err error) {\n\tx, y = elliptic.Unmarshal(curve, pubkey)\n\tif x == nil {\n\t\treturn nil, nil, errors.New(\"ssh: elliptic.Unmarshal failure\")\n\t}\n\tif !validateECPublicKey(curve, x, y) {\n\t\treturn nil, nil, errors.New(\"ssh: public key not on curve\")\n\t}\n\treturn x, y, nil\n}\n\n// validateECPublicKey checks that the point is a valid public key for\n// the given curve. See [SEC1], 3.2.2\nfunc validateECPublicKey(curve elliptic.Curve, x, y *big.Int) bool {\n\tif x.Sign() == 0 && y.Sign() == 0 {\n\t\treturn false\n\t}\n\n\tif x.Cmp(curve.Params().P) >= 0 {\n\t\treturn false\n\t}\n\n\tif y.Cmp(curve.Params().P) >= 0 {\n\t\treturn false\n\t}\n\n\tif !curve.IsOnCurve(x, y) {\n\t\treturn false\n\t}\n\n\t// We don't check if N * PubKey == 0, since\n\t//\n\t// - the NIST curves have cofactor = 1, so this is implicit.\n\t// (We don't foresee an implementation that supports non NIST\n\t// curves)\n\t//\n\t// - for ephemeral keys, we don't need to worry about small\n\t// subgroup attacks.\n\treturn true\n}\n\nfunc (kex *ecdh) Server(c packetConn, rand io.Reader, magics *handshakeMagics, priv AlgorithmSigner, algo string) (result *kexResult, err error) {\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar kexECDHInit kexECDHInitMsg\n\tif err = Unmarshal(packet, &kexECDHInit); err != nil {\n\t\treturn nil, err\n\t}\n\n\tclientX, clientY, err := unmarshalECKey(kex.curve, kexECDHInit.ClientPubKey)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// We could cache this key across multiple users/multiple\n\t// connection attempts, but the benefit is small. OpenSSH\n\t// generates a new key for each incoming connection.\n\tephKey, err := ecdsa.GenerateKey(kex.curve, rand)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\thostKeyBytes := priv.PublicKey().Marshal()\n\n\tserializedEphKey := elliptic.Marshal(kex.curve, ephKey.PublicKey.X, ephKey.PublicKey.Y)\n\n\t// generate shared secret\n\tsecret, _ := kex.curve.ScalarMult(clientX, clientY, ephKey.D.Bytes())\n\n\th := ecHash(kex.curve).New()\n\tmagics.write(h)\n\twriteString(h, hostKeyBytes)\n\twriteString(h, kexECDHInit.ClientPubKey)\n\twriteString(h, serializedEphKey)\n\n\tK := make([]byte, intLength(secret))\n\tmarshalInt(K, secret)\n\th.Write(K)\n\n\tH := h.Sum(nil)\n\n\t// H is already a hash, but the hostkey signing will apply its\n\t// own key-specific hash algorithm.\n\tsig, err := signAndMarshal(priv, rand, H, algo)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treply := kexECDHReplyMsg{\n\t\tEphemeralPubKey: serializedEphKey,\n\t\tHostKey: hostKeyBytes,\n\t\tSignature: sig,\n\t}\n\n\tserialized := Marshal(&reply)\n\tif err := c.writePacket(serialized); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn &kexResult{\n\t\tH: H,\n\t\tK: K,\n\t\tHostKey: reply.HostKey,\n\t\tSignature: sig,\n\t\tHash: ecHash(kex.curve),\n\t}, nil\n}\n\n// ecHash returns the hash to match the given elliptic curve, see RFC\n// 5656, section 6.2.1\nfunc ecHash(curve elliptic.Curve) crypto.Hash {\n\tbitSize := curve.Params().BitSize\n\tswitch {\n\tcase bitSize <= 256:\n\t\treturn crypto.SHA256\n\tcase bitSize <= 384:\n\t\treturn crypto.SHA384\n\t}\n\treturn crypto.SHA512\n}\n\n// kexAlgoMap defines the supported KEXs. KEXs not included are not supported\n// and will not be negotiated, even if explicitly configured. When FIPS mode is\n// enabled, only FIPS-approved algorithms are included.\nvar kexAlgoMap = map[string]kexAlgorithm{}\n\nfunc init() {\n\t// mlkem768x25519-sha256 we'll work with fips140=on but not fips140=only\n\t// until Go 1.26.\n\tkexAlgoMap[KeyExchangeMLKEM768X25519] = &mlkem768WithCurve25519sha256{}\n\tkexAlgoMap[KeyExchangeECDHP521] = &ecdh{elliptic.P521()}\n\tkexAlgoMap[KeyExchangeECDHP384] = &ecdh{elliptic.P384()}\n\tkexAlgoMap[KeyExchangeECDHP256] = &ecdh{elliptic.P256()}\n\n\tif fips140.Enabled() {\n\t\tdefaultKexAlgos = slices.DeleteFunc(defaultKexAlgos, func(algo string) bool {\n\t\t\t_, ok := kexAlgoMap[algo]\n\t\t\treturn !ok\n\t\t})\n\t\treturn\n\t}\n\n\tp, _ := new(big.Int).SetString(oakleyGroup2, 16)\n\tkexAlgoMap[InsecureKeyExchangeDH1SHA1] = &dhGroup{\n\t\tg: new(big.Int).SetInt64(2),\n\t\tp: p,\n\t\tpMinus1: new(big.Int).Sub(p, bigOne),\n\t\thashFunc: crypto.SHA1,\n\t}\n\n\tp, _ = new(big.Int).SetString(oakleyGroup14, 16)\n\tgroup14 := &dhGroup{\n\t\tg: new(big.Int).SetInt64(2),\n\t\tp: p,\n\t\tpMinus1: new(big.Int).Sub(p, bigOne),\n\t}\n\n\tkexAlgoMap[InsecureKeyExchangeDH14SHA1] = &dhGroup{\n\t\tg: group14.g, p: group14.p, pMinus1: group14.pMinus1,\n\t\thashFunc: crypto.SHA1,\n\t}\n\tkexAlgoMap[KeyExchangeDH14SHA256] = &dhGroup{\n\t\tg: group14.g, p: group14.p, pMinus1: group14.pMinus1,\n\t\thashFunc: crypto.SHA256,\n\t}\n\n\tp, _ = new(big.Int).SetString(oakleyGroup16, 16)\n\n\tkexAlgoMap[KeyExchangeDH16SHA512] = &dhGroup{\n\t\tg: new(big.Int).SetInt64(2),\n\t\tp: p,\n\t\tpMinus1: new(big.Int).Sub(p, bigOne),\n\t\thashFunc: crypto.SHA512,\n\t}\n\n\tkexAlgoMap[KeyExchangeCurve25519] = &curve25519sha256{}\n\tkexAlgoMap[keyExchangeCurve25519LibSSH] = &curve25519sha256{}\n\tkexAlgoMap[InsecureKeyExchangeDHGEXSHA1] = &dhGEXSHA{hashFunc: crypto.SHA1}\n\tkexAlgoMap[KeyExchangeDHGEXSHA256] = &dhGEXSHA{hashFunc: crypto.SHA256}\n}\n\n// curve25519sha256 implements the curve25519-sha256 (formerly known as\n// curve25519-sha256@libssh.org) key exchange method, as described in RFC 8731.\ntype curve25519sha256 struct{}\n\ntype curve25519KeyPair struct {\n\tpriv [32]byte\n\tpub [32]byte\n}\n\nfunc (kp *curve25519KeyPair) generate(rand io.Reader) error {\n\tif _, err := io.ReadFull(rand, kp.priv[:]); err != nil {\n\t\treturn err\n\t}\n\tp, err := curve25519.X25519(kp.priv[:], curve25519.Basepoint)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"curve25519: %w\", err)\n\t}\n\tif len(p) != 32 {\n\t\treturn fmt.Errorf(\"curve25519: internal error: X25519 returned %d bytes, expected 32\", len(p))\n\t}\n\tcopy(kp.pub[:], p)\n\treturn nil\n}\n\nfunc (kex *curve25519sha256) Client(c packetConn, rand io.Reader, magics *handshakeMagics) (*kexResult, error) {\n\tvar kp curve25519KeyPair\n\tif err := kp.generate(rand); err != nil {\n\t\treturn nil, err\n\t}\n\tif err := c.writePacket(Marshal(&kexECDHInitMsg{kp.pub[:]})); err != nil {\n\t\treturn nil, err\n\t}\n\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar reply kexECDHReplyMsg\n\tif err = Unmarshal(packet, &reply); err != nil {\n\t\treturn nil, err\n\t}\n\tif len(reply.EphemeralPubKey) != 32 {\n\t\treturn nil, errors.New(\"ssh: peer's curve25519 public value has wrong length\")\n\t}\n\n\tsecret, err := curve25519.X25519(kp.priv[:], reply.EphemeralPubKey)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"ssh: peer's curve25519 public value is not valid: %w\", err)\n\t}\n\n\th := crypto.SHA256.New()\n\tmagics.write(h)\n\twriteString(h, reply.HostKey)\n\twriteString(h, kp.pub[:])\n\twriteString(h, reply.EphemeralPubKey)\n\n\tki := new(big.Int).SetBytes(secret[:])\n\tK := make([]byte, intLength(ki))\n\tmarshalInt(K, ki)\n\th.Write(K)\n\n\treturn &kexResult{\n\t\tH: h.Sum(nil),\n\t\tK: K,\n\t\tHostKey: reply.HostKey,\n\t\tSignature: reply.Signature,\n\t\tHash: crypto.SHA256,\n\t}, nil\n}\n\nfunc (kex *curve25519sha256) Server(c packetConn, rand io.Reader, magics *handshakeMagics, priv AlgorithmSigner, algo string) (result *kexResult, err error) {\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn\n\t}\n\tvar kexInit kexECDHInitMsg\n\tif err = Unmarshal(packet, &kexInit); err != nil {\n\t\treturn\n\t}\n\n\tif len(kexInit.ClientPubKey) != 32 {\n\t\treturn nil, errors.New(\"ssh: peer's curve25519 public value has wrong length\")\n\t}\n\n\tvar kp curve25519KeyPair\n\tif err := kp.generate(rand); err != nil {\n\t\treturn nil, err\n\t}\n\n\tsecret, err := curve25519.X25519(kp.priv[:], kexInit.ClientPubKey)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"ssh: peer's curve25519 public value is not valid: %w\", err)\n\t}\n\n\thostKeyBytes := priv.PublicKey().Marshal()\n\n\th := crypto.SHA256.New()\n\tmagics.write(h)\n\twriteString(h, hostKeyBytes)\n\twriteString(h, kexInit.ClientPubKey)\n\twriteString(h, kp.pub[:])\n\n\tki := new(big.Int).SetBytes(secret[:])\n\tK := make([]byte, intLength(ki))\n\tmarshalInt(K, ki)\n\th.Write(K)\n\n\tH := h.Sum(nil)\n\n\tsig, err := signAndMarshal(priv, rand, H, algo)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treply := kexECDHReplyMsg{\n\t\tEphemeralPubKey: kp.pub[:],\n\t\tHostKey: hostKeyBytes,\n\t\tSignature: sig,\n\t}\n\tif err := c.writePacket(Marshal(&reply)); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &kexResult{\n\t\tH: H,\n\t\tK: K,\n\t\tHostKey: hostKeyBytes,\n\t\tSignature: sig,\n\t\tHash: crypto.SHA256,\n\t}, nil\n}\n\n// dhGEXSHA implements the diffie-hellman-group-exchange-sha1 and\n// diffie-hellman-group-exchange-sha256 key agreement protocols,\n// as described in RFC 4419\ntype dhGEXSHA struct {\n\thashFunc crypto.Hash\n}\n\nconst (\n\tdhGroupExchangeMinimumBits = 2048\n\tdhGroupExchangePreferredBits = 2048\n\tdhGroupExchangeMaximumBits = 8192\n)\n\nfunc (gex *dhGEXSHA) Client(c packetConn, randSource io.Reader, magics *handshakeMagics) (*kexResult, error) {\n\t// Send GexRequest\n\tkexDHGexRequest := kexDHGexRequestMsg{\n\t\tMinBits: dhGroupExchangeMinimumBits,\n\t\tPreferredBits: dhGroupExchangePreferredBits,\n\t\tMaxBits: dhGroupExchangeMaximumBits,\n\t}\n\tif err := c.writePacket(Marshal(&kexDHGexRequest)); err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Receive GexGroup\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar msg kexDHGexGroupMsg\n\tif err = Unmarshal(packet, &msg); err != nil {\n\t\treturn nil, err\n\t}\n\n\t// reject if p's bit length < dhGroupExchangeMinimumBits or > dhGroupExchangeMaximumBits\n\tif msg.P.BitLen() < dhGroupExchangeMinimumBits || msg.P.BitLen() > dhGroupExchangeMaximumBits {\n\t\treturn nil, fmt.Errorf(\"ssh: server-generated gex p is out of range (%d bits)\", msg.P.BitLen())\n\t}\n\n\t// Check if g is safe by verifying that 1 < g < p-1\n\tpMinusOne := new(big.Int).Sub(msg.P, bigOne)\n\tif msg.G.Cmp(bigOne) <= 0 || msg.G.Cmp(pMinusOne) >= 0 {\n\t\treturn nil, fmt.Errorf(\"ssh: server provided gex g is not safe\")\n\t}\n\n\t// Send GexInit\n\tpHalf := new(big.Int).Rsh(msg.P, 1)\n\tx, err := rand.Int(randSource, pHalf)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tX := new(big.Int).Exp(msg.G, x, msg.P)\n\tkexDHGexInit := kexDHGexInitMsg{\n\t\tX: X,\n\t}\n\tif err := c.writePacket(Marshal(&kexDHGexInit)); err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Receive GexReply\n\tpacket, err = c.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar kexDHGexReply kexDHGexReplyMsg\n\tif err = Unmarshal(packet, &kexDHGexReply); err != nil {\n\t\treturn nil, err\n\t}\n\n\tif kexDHGexReply.Y.Cmp(bigOne) <= 0 || kexDHGexReply.Y.Cmp(pMinusOne) >= 0 {\n\t\treturn nil, errors.New(\"ssh: DH parameter out of bounds\")\n\t}\n\tkInt := new(big.Int).Exp(kexDHGexReply.Y, x, msg.P)\n\n\t// Check if k is safe by verifying that k > 1 and k < p - 1\n\tif kInt.Cmp(bigOne) <= 0 || kInt.Cmp(pMinusOne) >= 0 {\n\t\treturn nil, fmt.Errorf(\"ssh: derived k is not safe\")\n\t}\n\n\th := gex.hashFunc.New()\n\tmagics.write(h)\n\twriteString(h, kexDHGexReply.HostKey)\n\tbinary.Write(h, binary.BigEndian, uint32(dhGroupExchangeMinimumBits))\n\tbinary.Write(h, binary.BigEndian, uint32(dhGroupExchangePreferredBits))\n\tbinary.Write(h, binary.BigEndian, uint32(dhGroupExchangeMaximumBits))\n\twriteInt(h, msg.P)\n\twriteInt(h, msg.G)\n\twriteInt(h, X)\n\twriteInt(h, kexDHGexReply.Y)\n\tK := make([]byte, intLength(kInt))\n\tmarshalInt(K, kInt)\n\th.Write(K)\n\n\treturn &kexResult{\n\t\tH: h.Sum(nil),\n\t\tK: K,\n\t\tHostKey: kexDHGexReply.HostKey,\n\t\tSignature: kexDHGexReply.Signature,\n\t\tHash: gex.hashFunc,\n\t}, nil\n}\n\n// Server half implementation of the Diffie Hellman Key Exchange with SHA1 and SHA256.\nfunc (gex *dhGEXSHA) Server(c packetConn, randSource io.Reader, magics *handshakeMagics, priv AlgorithmSigner, algo string) (result *kexResult, err error) {\n\t// Receive GexRequest\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn\n\t}\n\tvar kexDHGexRequest kexDHGexRequestMsg\n\tif err = Unmarshal(packet, &kexDHGexRequest); err != nil {\n\t\treturn\n\t}\n\t// We check that the request received is valid and that the MaxBits\n\t// requested are at least equal to our supported minimum. This is the same\n\t// check done in OpenSSH:\n\t// https://github.com/openssh/openssh-portable/blob/80a2f64b/kexgexs.c#L94\n\t//\n\t// Furthermore, we also check that the required MinBits are less than or\n\t// equal to 4096 because we can use up to Oakley Group 16.\n\tif kexDHGexRequest.MaxBits < kexDHGexRequest.MinBits || kexDHGexRequest.PreferredBits < kexDHGexRequest.MinBits ||\n\t\tkexDHGexRequest.MaxBits < kexDHGexRequest.PreferredBits || kexDHGexRequest.MaxBits < dhGroupExchangeMinimumBits ||\n\t\tkexDHGexRequest.MinBits > 4096 {\n\t\treturn nil, fmt.Errorf(\"ssh: DH GEX request out of range, min: %d, max: %d, preferred: %d\", kexDHGexRequest.MinBits,\n\t\t\tkexDHGexRequest.MaxBits, kexDHGexRequest.PreferredBits)\n\t}\n\n\tvar p *big.Int\n\t// We hardcode sending Oakley Group 14 (2048 bits), Oakley Group 15 (3072\n\t// bits) or Oakley Group 16 (4096 bits), based on the requested max size.\n\tif kexDHGexRequest.MaxBits < 3072 {\n\t\tp, _ = new(big.Int).SetString(oakleyGroup14, 16)\n\t} else if kexDHGexRequest.MaxBits < 4096 {\n\t\tp, _ = new(big.Int).SetString(oakleyGroup15, 16)\n\t} else {\n\t\tp, _ = new(big.Int).SetString(oakleyGroup16, 16)\n\t}\n\n\tg := big.NewInt(2)\n\tmsg := &kexDHGexGroupMsg{\n\t\tP: p,\n\t\tG: g,\n\t}\n\tif err := c.writePacket(Marshal(msg)); err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Receive GexInit\n\tpacket, err = c.readPacket()\n\tif err != nil {\n\t\treturn\n\t}\n\tvar kexDHGexInit kexDHGexInitMsg\n\tif err = Unmarshal(packet, &kexDHGexInit); err != nil {\n\t\treturn\n\t}\n\n\tpHalf := new(big.Int).Rsh(p, 1)\n\n\ty, err := rand.Int(randSource, pHalf)\n\tif err != nil {\n\t\treturn\n\t}\n\tY := new(big.Int).Exp(g, y, p)\n\n\tpMinusOne := new(big.Int).Sub(p, bigOne)\n\tif kexDHGexInit.X.Cmp(bigOne) <= 0 || kexDHGexInit.X.Cmp(pMinusOne) >= 0 {\n\t\treturn nil, errors.New(\"ssh: DH parameter out of bounds\")\n\t}\n\tkInt := new(big.Int).Exp(kexDHGexInit.X, y, p)\n\n\thostKeyBytes := priv.PublicKey().Marshal()\n\n\th := gex.hashFunc.New()\n\tmagics.write(h)\n\twriteString(h, hostKeyBytes)\n\tbinary.Write(h, binary.BigEndian, kexDHGexRequest.MinBits)\n\tbinary.Write(h, binary.BigEndian, kexDHGexRequest.PreferredBits)\n\tbinary.Write(h, binary.BigEndian, kexDHGexRequest.MaxBits)\n\twriteInt(h, p)\n\twriteInt(h, g)\n\twriteInt(h, kexDHGexInit.X)\n\twriteInt(h, Y)\n\n\tK := make([]byte, intLength(kInt))\n\tmarshalInt(K, kInt)\n\th.Write(K)\n\n\tH := h.Sum(nil)\n\n\t// H is already a hash, but the hostkey signing will apply its\n\t// own key-specific hash algorithm.\n\tsig, err := signAndMarshal(priv, randSource, H, algo)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tkexDHGexReply := kexDHGexReplyMsg{\n\t\tHostKey: hostKeyBytes,\n\t\tY: Y,\n\t\tSignature: sig,\n\t}\n\tpacket = Marshal(&kexDHGexReply)\n\n\terr = c.writePacket(packet)\n\n\treturn &kexResult{\n\t\tH: H,\n\t\tK: K,\n\t\tHostKey: hostKeyBytes,\n\t\tSignature: sig,\n\t\tHash: gex.hashFunc,\n\t}, err\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/keys.go",
"content": "// Copyright 2012 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"bytes\"\n\t\"crypto\"\n\t\"crypto/aes\"\n\t\"crypto/cipher\"\n\t\"crypto/dsa\"\n\t\"crypto/ecdsa\"\n\t\"crypto/ed25519\"\n\t\"crypto/elliptic\"\n\t\"crypto/md5\"\n\t\"crypto/rand\"\n\t\"crypto/rsa\"\n\t\"crypto/sha256\"\n\t\"crypto/x509\"\n\t\"encoding/asn1\"\n\t\"encoding/base64\"\n\t\"encoding/binary\"\n\t\"encoding/hex\"\n\t\"encoding/pem\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"math/big\"\n\t\"slices\"\n\t\"strings\"\n\n\t\"golang.org/x/crypto/ssh/internal/bcrypt_pbkdf\"\n)\n\n// Public key algorithms names. These values can appear in PublicKey.Type,\n// ClientConfig.HostKeyAlgorithms, Signature.Format, or as AlgorithmSigner\n// arguments.\nconst (\n\tKeyAlgoRSA = \"ssh-rsa\"\n\t// Deprecated: DSA is only supported at insecure key sizes, and was removed\n\t// from major implementations.\n\tKeyAlgoDSA = InsecureKeyAlgoDSA\n\t// Deprecated: DSA is only supported at insecure key sizes, and was removed\n\t// from major implementations.\n\tInsecureKeyAlgoDSA = \"ssh-dss\"\n\tKeyAlgoECDSA256 = \"ecdsa-sha2-nistp256\"\n\tKeyAlgoSKECDSA256 = \"sk-ecdsa-sha2-nistp256@openssh.com\"\n\tKeyAlgoECDSA384 = \"ecdsa-sha2-nistp384\"\n\tKeyAlgoECDSA521 = \"ecdsa-sha2-nistp521\"\n\tKeyAlgoED25519 = \"ssh-ed25519\"\n\tKeyAlgoSKED25519 = \"sk-ssh-ed25519@openssh.com\"\n\n\t// KeyAlgoRSASHA256 and KeyAlgoRSASHA512 are only public key algorithms, not\n\t// public key formats, so they can't appear as a PublicKey.Type. The\n\t// corresponding PublicKey.Type is KeyAlgoRSA. See RFC 8332, Section 2.\n\tKeyAlgoRSASHA256 = \"rsa-sha2-256\"\n\tKeyAlgoRSASHA512 = \"rsa-sha2-512\"\n)\n\nconst (\n\t// Deprecated: use KeyAlgoRSA.\n\tSigAlgoRSA = KeyAlgoRSA\n\t// Deprecated: use KeyAlgoRSASHA256.\n\tSigAlgoRSASHA2256 = KeyAlgoRSASHA256\n\t// Deprecated: use KeyAlgoRSASHA512.\n\tSigAlgoRSASHA2512 = KeyAlgoRSASHA512\n)\n\n// parsePubKey parses a public key of the given algorithm.\n// Use ParsePublicKey for keys with prepended algorithm.\nfunc parsePubKey(in []byte, algo string) (pubKey PublicKey, rest []byte, err error) {\n\tswitch algo {\n\tcase KeyAlgoRSA:\n\t\treturn parseRSA(in)\n\tcase InsecureKeyAlgoDSA:\n\t\treturn parseDSA(in)\n\tcase KeyAlgoECDSA256, KeyAlgoECDSA384, KeyAlgoECDSA521:\n\t\treturn parseECDSA(in)\n\tcase KeyAlgoSKECDSA256:\n\t\treturn parseSKECDSA(in)\n\tcase KeyAlgoED25519:\n\t\treturn parseED25519(in)\n\tcase KeyAlgoSKED25519:\n\t\treturn parseSKEd25519(in)\n\tcase CertAlgoRSAv01, InsecureCertAlgoDSAv01, CertAlgoECDSA256v01, CertAlgoECDSA384v01, CertAlgoECDSA521v01, CertAlgoSKECDSA256v01, CertAlgoED25519v01, CertAlgoSKED25519v01:\n\t\tcert, err := parseCert(in, certKeyAlgoNames[algo])\n\t\tif err != nil {\n\t\t\treturn nil, nil, err\n\t\t}\n\t\treturn cert, nil, nil\n\t}\n\tif keyFormat := keyFormatForAlgorithm(algo); keyFormat != \"\" {\n\t\treturn nil, nil, fmt.Errorf(\"ssh: signature algorithm %q isn't a key format; key is malformed and should be re-encoded with type %q\",\n\t\t\talgo, keyFormat)\n\t}\n\n\treturn nil, nil, fmt.Errorf(\"ssh: unknown key algorithm: %v\", algo)\n}\n\n// parseAuthorizedKey parses a public key in OpenSSH authorized_keys format\n// (see sshd(8) manual page) once the options and key type fields have been\n// removed.\nfunc parseAuthorizedKey(in []byte) (out PublicKey, comment string, err error) {\n\tin = bytes.TrimSpace(in)\n\n\ti := bytes.IndexAny(in, \" \\t\")\n\tif i == -1 {\n\t\ti = len(in)\n\t}\n\tbase64Key := in[:i]\n\n\tkey := make([]byte, base64.StdEncoding.DecodedLen(len(base64Key)))\n\tn, err := base64.StdEncoding.Decode(key, base64Key)\n\tif err != nil {\n\t\treturn nil, \"\", err\n\t}\n\tkey = key[:n]\n\tout, err = ParsePublicKey(key)\n\tif err != nil {\n\t\treturn nil, \"\", err\n\t}\n\tcomment = string(bytes.TrimSpace(in[i:]))\n\treturn out, comment, nil\n}\n\n// ParseKnownHosts parses an entry in the format of the known_hosts file.\n//\n// The known_hosts format is documented in the sshd(8) manual page. This\n// function will parse a single entry from in. On successful return, marker\n// will contain the optional marker value (i.e. \"cert-authority\" or \"revoked\")\n// or else be empty, hosts will contain the hosts that this entry matches,\n// pubKey will contain the public key and comment will contain any trailing\n// comment at the end of the line. See the sshd(8) manual page for the various\n// forms that a host string can take.\n//\n// The unparsed remainder of the input will be returned in rest. This function\n// can be called repeatedly to parse multiple entries.\n//\n// If no entries were found in the input then err will be io.EOF. Otherwise a\n// non-nil err value indicates a parse error.\nfunc ParseKnownHosts(in []byte) (marker string, hosts []string, pubKey PublicKey, comment string, rest []byte, err error) {\n\tfor len(in) > 0 {\n\t\tend := bytes.IndexByte(in, '\\n')\n\t\tif end != -1 {\n\t\t\trest = in[end+1:]\n\t\t\tin = in[:end]\n\t\t} else {\n\t\t\trest = nil\n\t\t}\n\n\t\tend = bytes.IndexByte(in, '\\r')\n\t\tif end != -1 {\n\t\t\tin = in[:end]\n\t\t}\n\n\t\tin = bytes.TrimSpace(in)\n\t\tif len(in) == 0 || in[0] == '#' {\n\t\t\tin = rest\n\t\t\tcontinue\n\t\t}\n\n\t\ti := bytes.IndexAny(in, \" \\t\")\n\t\tif i == -1 {\n\t\t\tin = rest\n\t\t\tcontinue\n\t\t}\n\n\t\t// Strip out the beginning of the known_host key.\n\t\t// This is either an optional marker or a (set of) hostname(s).\n\t\tkeyFields := bytes.Fields(in)\n\t\tif len(keyFields) < 3 || len(keyFields) > 5 {\n\t\t\treturn \"\", nil, nil, \"\", nil, errors.New(\"ssh: invalid entry in known_hosts data\")\n\t\t}\n\n\t\t// keyFields[0] is either \"@cert-authority\", \"@revoked\" or a comma separated\n\t\t// list of hosts\n\t\tmarker := \"\"\n\t\tif keyFields[0][0] == '@' {\n\t\t\tmarker = string(keyFields[0][1:])\n\t\t\tkeyFields = keyFields[1:]\n\t\t}\n\n\t\thosts := string(keyFields[0])\n\t\t// keyFields[1] contains the key type (e.g. “ssh-rsa”).\n\t\t// However, that information is duplicated inside the\n\t\t// base64-encoded key and so is ignored here.\n\n\t\tkey := bytes.Join(keyFields[2:], []byte(\" \"))\n\t\tif pubKey, comment, err = parseAuthorizedKey(key); err != nil {\n\t\t\treturn \"\", nil, nil, \"\", nil, err\n\t\t}\n\n\t\treturn marker, strings.Split(hosts, \",\"), pubKey, comment, rest, nil\n\t}\n\n\treturn \"\", nil, nil, \"\", nil, io.EOF\n}\n\n// ParseAuthorizedKey parses a public key from an authorized_keys file used in\n// OpenSSH according to the sshd(8) manual page. Invalid lines are ignored.\nfunc ParseAuthorizedKey(in []byte) (out PublicKey, comment string, options []string, rest []byte, err error) {\n\tvar lastErr error\n\tfor len(in) > 0 {\n\t\tend := bytes.IndexByte(in, '\\n')\n\t\tif end != -1 {\n\t\t\trest = in[end+1:]\n\t\t\tin = in[:end]\n\t\t} else {\n\t\t\trest = nil\n\t\t}\n\n\t\tend = bytes.IndexByte(in, '\\r')\n\t\tif end != -1 {\n\t\t\tin = in[:end]\n\t\t}\n\n\t\tin = bytes.TrimSpace(in)\n\t\tif len(in) == 0 || in[0] == '#' {\n\t\t\tin = rest\n\t\t\tcontinue\n\t\t}\n\n\t\ti := bytes.IndexAny(in, \" \\t\")\n\t\tif i == -1 {\n\t\t\tin = rest\n\t\t\tcontinue\n\t\t}\n\n\t\tif out, comment, err = parseAuthorizedKey(in[i:]); err == nil {\n\t\t\treturn out, comment, options, rest, nil\n\t\t} else {\n\t\t\tlastErr = err\n\t\t}\n\n\t\t// No key type recognised. Maybe there's an options field at\n\t\t// the beginning.\n\t\tvar b byte\n\t\tinQuote := false\n\t\tvar candidateOptions []string\n\t\toptionStart := 0\n\t\tfor i, b = range in {\n\t\t\tisEnd := !inQuote && (b == ' ' || b == '\\t')\n\t\t\tif (b == ',' && !inQuote) || isEnd {\n\t\t\t\tif i-optionStart > 0 {\n\t\t\t\t\tcandidateOptions = append(candidateOptions, string(in[optionStart:i]))\n\t\t\t\t}\n\t\t\t\toptionStart = i + 1\n\t\t\t}\n\t\t\tif isEnd {\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tif b == '\"' && (i == 0 || (i > 0 && in[i-1] != '\\\\')) {\n\t\t\t\tinQuote = !inQuote\n\t\t\t}\n\t\t}\n\t\tfor i < len(in) && (in[i] == ' ' || in[i] == '\\t') {\n\t\t\ti++\n\t\t}\n\t\tif i == len(in) {\n\t\t\t// Invalid line: unmatched quote\n\t\t\tin = rest\n\t\t\tcontinue\n\t\t}\n\n\t\tin = in[i:]\n\t\ti = bytes.IndexAny(in, \" \\t\")\n\t\tif i == -1 {\n\t\t\tin = rest\n\t\t\tcontinue\n\t\t}\n\n\t\tif out, comment, err = parseAuthorizedKey(in[i:]); err == nil {\n\t\t\toptions = candidateOptions\n\t\t\treturn out, comment, options, rest, nil\n\t\t} else {\n\t\t\tlastErr = err\n\t\t}\n\n\t\tin = rest\n\t\tcontinue\n\t}\n\n\tif lastErr != nil {\n\t\treturn nil, \"\", nil, nil, fmt.Errorf(\"ssh: no key found; last parsing error for ignored line: %w\", lastErr)\n\t}\n\n\treturn nil, \"\", nil, nil, errors.New(\"ssh: no key found\")\n}\n\n// ParsePublicKey parses an SSH public key or certificate formatted for use in\n// the SSH wire protocol according to RFC 4253, section 6.6.\nfunc ParsePublicKey(in []byte) (out PublicKey, err error) {\n\talgo, in, ok := parseString(in)\n\tif !ok {\n\t\treturn nil, errShortRead\n\t}\n\tvar rest []byte\n\tout, rest, err = parsePubKey(in, string(algo))\n\tif len(rest) > 0 {\n\t\treturn nil, errors.New(\"ssh: trailing junk in public key\")\n\t}\n\n\treturn out, err\n}\n\n// MarshalAuthorizedKey serializes key for inclusion in an OpenSSH\n// authorized_keys file. The return value ends with newline.\nfunc MarshalAuthorizedKey(key PublicKey) []byte {\n\tb := &bytes.Buffer{}\n\tb.WriteString(key.Type())\n\tb.WriteByte(' ')\n\te := base64.NewEncoder(base64.StdEncoding, b)\n\te.Write(key.Marshal())\n\te.Close()\n\tb.WriteByte('\\n')\n\treturn b.Bytes()\n}\n\n// MarshalPrivateKey returns a PEM block with the private key serialized in the\n// OpenSSH format.\nfunc MarshalPrivateKey(key crypto.PrivateKey, comment string) (*pem.Block, error) {\n\treturn marshalOpenSSHPrivateKey(key, comment, unencryptedOpenSSHMarshaler)\n}\n\n// MarshalPrivateKeyWithPassphrase returns a PEM block holding the encrypted\n// private key serialized in the OpenSSH format.\nfunc MarshalPrivateKeyWithPassphrase(key crypto.PrivateKey, comment string, passphrase []byte) (*pem.Block, error) {\n\treturn marshalOpenSSHPrivateKey(key, comment, passphraseProtectedOpenSSHMarshaler(passphrase))\n}\n\n// PublicKey represents a public key using an unspecified algorithm.\n//\n// Some PublicKeys provided by this package also implement CryptoPublicKey.\ntype PublicKey interface {\n\t// Type returns the key format name, e.g. \"ssh-rsa\".\n\tType() string\n\n\t// Marshal returns the serialized key data in SSH wire format, with the name\n\t// prefix. To unmarshal the returned data, use the ParsePublicKey function.\n\tMarshal() []byte\n\n\t// Verify that sig is a signature on the given data using this key. This\n\t// method will hash the data appropriately first. sig.Format is allowed to\n\t// be any signature algorithm compatible with the key type, the caller\n\t// should check if it has more stringent requirements.\n\tVerify(data []byte, sig *Signature) error\n}\n\n// CryptoPublicKey, if implemented by a PublicKey,\n// returns the underlying crypto.PublicKey form of the key.\ntype CryptoPublicKey interface {\n\tCryptoPublicKey() crypto.PublicKey\n}\n\n// A Signer can create signatures that verify against a public key.\n//\n// Some Signers provided by this package also implement MultiAlgorithmSigner.\ntype Signer interface {\n\t// PublicKey returns the associated PublicKey.\n\tPublicKey() PublicKey\n\n\t// Sign returns a signature for the given data. This method will hash the\n\t// data appropriately first. The signature algorithm is expected to match\n\t// the key format returned by the PublicKey.Type method (and not to be any\n\t// alternative algorithm supported by the key format).\n\tSign(rand io.Reader, data []byte) (*Signature, error)\n}\n\n// An AlgorithmSigner is a Signer that also supports specifying an algorithm to\n// use for signing.\n//\n// An AlgorithmSigner can't advertise the algorithms it supports, unless it also\n// implements MultiAlgorithmSigner, so it should be prepared to be invoked with\n// every algorithm supported by the public key format.\ntype AlgorithmSigner interface {\n\tSigner\n\n\t// SignWithAlgorithm is like Signer.Sign, but allows specifying a desired\n\t// signing algorithm. Callers may pass an empty string for the algorithm in\n\t// which case the AlgorithmSigner will use a default algorithm. This default\n\t// doesn't currently control any behavior in this package.\n\tSignWithAlgorithm(rand io.Reader, data []byte, algorithm string) (*Signature, error)\n}\n\n// MultiAlgorithmSigner is an AlgorithmSigner that also reports the algorithms\n// supported by that signer.\ntype MultiAlgorithmSigner interface {\n\tAlgorithmSigner\n\n\t// Algorithms returns the available algorithms in preference order. The list\n\t// must not be empty, and it must not include certificate types.\n\tAlgorithms() []string\n}\n\n// NewSignerWithAlgorithms returns a signer restricted to the specified\n// algorithms. The algorithms must be set in preference order. The list must not\n// be empty, and it must not include certificate types. An error is returned if\n// the specified algorithms are incompatible with the public key type.\nfunc NewSignerWithAlgorithms(signer AlgorithmSigner, algorithms []string) (MultiAlgorithmSigner, error) {\n\tif len(algorithms) == 0 {\n\t\treturn nil, errors.New(\"ssh: please specify at least one valid signing algorithm\")\n\t}\n\tvar signerAlgos []string\n\tsupportedAlgos := algorithmsForKeyFormat(underlyingAlgo(signer.PublicKey().Type()))\n\tif s, ok := signer.(*multiAlgorithmSigner); ok {\n\t\tsignerAlgos = s.Algorithms()\n\t} else {\n\t\tsignerAlgos = supportedAlgos\n\t}\n\n\tfor _, algo := range algorithms {\n\t\tif !slices.Contains(supportedAlgos, algo) {\n\t\t\treturn nil, fmt.Errorf(\"ssh: algorithm %q is not supported for key type %q\",\n\t\t\t\talgo, signer.PublicKey().Type())\n\t\t}\n\t\tif !slices.Contains(signerAlgos, algo) {\n\t\t\treturn nil, fmt.Errorf(\"ssh: algorithm %q is restricted for the provided signer\", algo)\n\t\t}\n\t}\n\treturn &multiAlgorithmSigner{\n\t\tAlgorithmSigner: signer,\n\t\tsupportedAlgorithms: algorithms,\n\t}, nil\n}\n\ntype multiAlgorithmSigner struct {\n\tAlgorithmSigner\n\tsupportedAlgorithms []string\n}\n\nfunc (s *multiAlgorithmSigner) Algorithms() []string {\n\treturn s.supportedAlgorithms\n}\n\nfunc (s *multiAlgorithmSigner) isAlgorithmSupported(algorithm string) bool {\n\tif algorithm == \"\" {\n\t\talgorithm = underlyingAlgo(s.PublicKey().Type())\n\t}\n\tfor _, algo := range s.supportedAlgorithms {\n\t\tif algorithm == algo {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nfunc (s *multiAlgorithmSigner) SignWithAlgorithm(rand io.Reader, data []byte, algorithm string) (*Signature, error) {\n\tif !s.isAlgorithmSupported(algorithm) {\n\t\treturn nil, fmt.Errorf(\"ssh: algorithm %q is not supported: %v\", algorithm, s.supportedAlgorithms)\n\t}\n\treturn s.AlgorithmSigner.SignWithAlgorithm(rand, data, algorithm)\n}\n\ntype rsaPublicKey rsa.PublicKey\n\nfunc (r *rsaPublicKey) Type() string {\n\treturn \"ssh-rsa\"\n}\n\n// parseRSA parses an RSA key according to RFC 4253, section 6.6.\nfunc parseRSA(in []byte) (out PublicKey, rest []byte, err error) {\n\tvar w struct {\n\t\tE *big.Int\n\t\tN *big.Int\n\t\tRest []byte `ssh:\"rest\"`\n\t}\n\tif err := Unmarshal(in, &w); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\tif w.E.BitLen() > 24 {\n\t\treturn nil, nil, errors.New(\"ssh: exponent too large\")\n\t}\n\te := w.E.Int64()\n\tif e < 3 || e&1 == 0 {\n\t\treturn nil, nil, errors.New(\"ssh: incorrect exponent\")\n\t}\n\n\tvar key rsa.PublicKey\n\tkey.E = int(e)\n\tkey.N = w.N\n\treturn (*rsaPublicKey)(&key), w.Rest, nil\n}\n\nfunc (r *rsaPublicKey) Marshal() []byte {\n\te := new(big.Int).SetInt64(int64(r.E))\n\t// RSA publickey struct layout should match the struct used by\n\t// parseRSACert in the x/crypto/ssh/agent package.\n\twirekey := struct {\n\t\tName string\n\t\tE *big.Int\n\t\tN *big.Int\n\t}{\n\t\tKeyAlgoRSA,\n\t\te,\n\t\tr.N,\n\t}\n\treturn Marshal(&wirekey)\n}\n\nfunc (r *rsaPublicKey) Verify(data []byte, sig *Signature) error {\n\tsupportedAlgos := algorithmsForKeyFormat(r.Type())\n\tif !slices.Contains(supportedAlgos, sig.Format) {\n\t\treturn fmt.Errorf(\"ssh: signature type %s for key type %s\", sig.Format, r.Type())\n\t}\n\thash, err := hashFunc(sig.Format)\n\tif err != nil {\n\t\treturn err\n\t}\n\th := hash.New()\n\th.Write(data)\n\tdigest := h.Sum(nil)\n\n\t// Signatures in PKCS1v15 must match the key's modulus in\n\t// length. However with SSH, some signers provide RSA\n\t// signatures which are missing the MSB 0's of the bignum\n\t// represented. With ssh-rsa signatures, this is encouraged by\n\t// the spec (even though e.g. OpenSSH will give the full\n\t// length unconditionally). With rsa-sha2-* signatures, the\n\t// verifier is allowed to support these, even though they are\n\t// out of spec. See RFC 4253 Section 6.6 for ssh-rsa and RFC\n\t// 8332 Section 3 for rsa-sha2-* details.\n\t//\n\t// In practice:\n\t// * OpenSSH always allows \"short\" signatures:\n\t// https://github.com/openssh/openssh-portable/blob/V_9_8_P1/ssh-rsa.c#L526\n\t// but always generates padded signatures:\n\t// https://github.com/openssh/openssh-portable/blob/V_9_8_P1/ssh-rsa.c#L439\n\t//\n\t// * PuTTY versions 0.81 and earlier will generate short\n\t// signatures for all RSA signature variants. Note that\n\t// PuTTY is embedded in other software, such as WinSCP and\n\t// FileZilla. At the time of writing, a patch has been\n\t// applied to PuTTY to generate padded signatures for\n\t// rsa-sha2-*, but not yet released:\n\t// https://git.tartarus.org/?p=simon/putty.git;a=commitdiff;h=a5bcf3d384e1bf15a51a6923c3724cbbee022d8e\n\t//\n\t// * SSH.NET versions 2024.0.0 and earlier will generate short\n\t// signatures for all RSA signature variants, fixed in 2024.1.0:\n\t// https://github.com/sshnet/SSH.NET/releases/tag/2024.1.0\n\t//\n\t// As a result, we pad these up to the key size by inserting\n\t// leading 0's.\n\t//\n\t// Note that support for short signatures with rsa-sha2-* may\n\t// be removed in the future due to such signatures not being\n\t// allowed by the spec.\n\tblob := sig.Blob\n\tkeySize := (*rsa.PublicKey)(r).Size()\n\tif len(blob) < keySize {\n\t\tpadded := make([]byte, keySize)\n\t\tcopy(padded[keySize-len(blob):], blob)\n\t\tblob = padded\n\t}\n\treturn rsa.VerifyPKCS1v15((*rsa.PublicKey)(r), hash, digest, blob)\n}\n\nfunc (r *rsaPublicKey) CryptoPublicKey() crypto.PublicKey {\n\treturn (*rsa.PublicKey)(r)\n}\n\ntype dsaPublicKey dsa.PublicKey\n\nfunc (k *dsaPublicKey) Type() string {\n\treturn \"ssh-dss\"\n}\n\nfunc checkDSAParams(param *dsa.Parameters) error {\n\t// SSH specifies FIPS 186-2, which only provided a single size\n\t// (1024 bits) DSA key. FIPS 186-3 allows for larger key\n\t// sizes, which would confuse SSH.\n\tif l := param.P.BitLen(); l != 1024 {\n\t\treturn fmt.Errorf(\"ssh: unsupported DSA key size %d\", l)\n\t}\n\n\treturn nil\n}\n\n// parseDSA parses an DSA key according to RFC 4253, section 6.6.\nfunc parseDSA(in []byte) (out PublicKey, rest []byte, err error) {\n\tvar w struct {\n\t\tP, Q, G, Y *big.Int\n\t\tRest []byte `ssh:\"rest\"`\n\t}\n\tif err := Unmarshal(in, &w); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\tparam := dsa.Parameters{\n\t\tP: w.P,\n\t\tQ: w.Q,\n\t\tG: w.G,\n\t}\n\tif err := checkDSAParams(¶m); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\tkey := &dsaPublicKey{\n\t\tParameters: param,\n\t\tY: w.Y,\n\t}\n\treturn key, w.Rest, nil\n}\n\nfunc (k *dsaPublicKey) Marshal() []byte {\n\t// DSA publickey struct layout should match the struct used by\n\t// parseDSACert in the x/crypto/ssh/agent package.\n\tw := struct {\n\t\tName string\n\t\tP, Q, G, Y *big.Int\n\t}{\n\t\tk.Type(),\n\t\tk.P,\n\t\tk.Q,\n\t\tk.G,\n\t\tk.Y,\n\t}\n\n\treturn Marshal(&w)\n}\n\nfunc (k *dsaPublicKey) Verify(data []byte, sig *Signature) error {\n\tif sig.Format != k.Type() {\n\t\treturn fmt.Errorf(\"ssh: signature type %s for key type %s\", sig.Format, k.Type())\n\t}\n\thash, err := hashFunc(sig.Format)\n\tif err != nil {\n\t\treturn err\n\t}\n\th := hash.New()\n\th.Write(data)\n\tdigest := h.Sum(nil)\n\n\t// Per RFC 4253, section 6.6,\n\t// The value for 'dss_signature_blob' is encoded as a string containing\n\t// r, followed by s (which are 160-bit integers, without lengths or\n\t// padding, unsigned, and in network byte order).\n\t// For DSS purposes, sig.Blob should be exactly 40 bytes in length.\n\tif len(sig.Blob) != 40 {\n\t\treturn errors.New(\"ssh: DSA signature parse error\")\n\t}\n\tr := new(big.Int).SetBytes(sig.Blob[:20])\n\ts := new(big.Int).SetBytes(sig.Blob[20:])\n\tif dsa.Verify((*dsa.PublicKey)(k), digest, r, s) {\n\t\treturn nil\n\t}\n\treturn errors.New(\"ssh: signature did not verify\")\n}\n\nfunc (k *dsaPublicKey) CryptoPublicKey() crypto.PublicKey {\n\treturn (*dsa.PublicKey)(k)\n}\n\ntype dsaPrivateKey struct {\n\t*dsa.PrivateKey\n}\n\nfunc (k *dsaPrivateKey) PublicKey() PublicKey {\n\treturn (*dsaPublicKey)(&k.PrivateKey.PublicKey)\n}\n\nfunc (k *dsaPrivateKey) Sign(rand io.Reader, data []byte) (*Signature, error) {\n\treturn k.SignWithAlgorithm(rand, data, k.PublicKey().Type())\n}\n\nfunc (k *dsaPrivateKey) Algorithms() []string {\n\treturn []string{k.PublicKey().Type()}\n}\n\nfunc (k *dsaPrivateKey) SignWithAlgorithm(rand io.Reader, data []byte, algorithm string) (*Signature, error) {\n\tif algorithm != \"\" && algorithm != k.PublicKey().Type() {\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported signature algorithm %s\", algorithm)\n\t}\n\n\thash, err := hashFunc(k.PublicKey().Type())\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\th := hash.New()\n\th.Write(data)\n\tdigest := h.Sum(nil)\n\tr, s, err := dsa.Sign(rand, k.PrivateKey, digest)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tsig := make([]byte, 40)\n\trb := r.Bytes()\n\tsb := s.Bytes()\n\n\tcopy(sig[20-len(rb):20], rb)\n\tcopy(sig[40-len(sb):], sb)\n\n\treturn &Signature{\n\t\tFormat: k.PublicKey().Type(),\n\t\tBlob: sig,\n\t}, nil\n}\n\ntype ecdsaPublicKey ecdsa.PublicKey\n\nfunc (k *ecdsaPublicKey) Type() string {\n\treturn \"ecdsa-sha2-\" + k.nistID()\n}\n\nfunc (k *ecdsaPublicKey) nistID() string {\n\tswitch k.Params().BitSize {\n\tcase 256:\n\t\treturn \"nistp256\"\n\tcase 384:\n\t\treturn \"nistp384\"\n\tcase 521:\n\t\treturn \"nistp521\"\n\t}\n\tpanic(\"ssh: unsupported ecdsa key size\")\n}\n\ntype ed25519PublicKey ed25519.PublicKey\n\nfunc (k ed25519PublicKey) Type() string {\n\treturn KeyAlgoED25519\n}\n\nfunc parseED25519(in []byte) (out PublicKey, rest []byte, err error) {\n\tvar w struct {\n\t\tKeyBytes []byte\n\t\tRest []byte `ssh:\"rest\"`\n\t}\n\n\tif err := Unmarshal(in, &w); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\tif l := len(w.KeyBytes); l != ed25519.PublicKeySize {\n\t\treturn nil, nil, fmt.Errorf(\"invalid size %d for Ed25519 public key\", l)\n\t}\n\n\treturn ed25519PublicKey(w.KeyBytes), w.Rest, nil\n}\n\nfunc (k ed25519PublicKey) Marshal() []byte {\n\tw := struct {\n\t\tName string\n\t\tKeyBytes []byte\n\t}{\n\t\tKeyAlgoED25519,\n\t\t[]byte(k),\n\t}\n\treturn Marshal(&w)\n}\n\nfunc (k ed25519PublicKey) Verify(b []byte, sig *Signature) error {\n\tif sig.Format != k.Type() {\n\t\treturn fmt.Errorf(\"ssh: signature type %s for key type %s\", sig.Format, k.Type())\n\t}\n\tif l := len(k); l != ed25519.PublicKeySize {\n\t\treturn fmt.Errorf(\"ssh: invalid size %d for Ed25519 public key\", l)\n\t}\n\n\tif ok := ed25519.Verify(ed25519.PublicKey(k), b, sig.Blob); !ok {\n\t\treturn errors.New(\"ssh: signature did not verify\")\n\t}\n\n\treturn nil\n}\n\nfunc (k ed25519PublicKey) CryptoPublicKey() crypto.PublicKey {\n\treturn ed25519.PublicKey(k)\n}\n\nfunc supportedEllipticCurve(curve elliptic.Curve) bool {\n\treturn curve == elliptic.P256() || curve == elliptic.P384() || curve == elliptic.P521()\n}\n\n// parseECDSA parses an ECDSA key according to RFC 5656, section 3.1.\nfunc parseECDSA(in []byte) (out PublicKey, rest []byte, err error) {\n\tvar w struct {\n\t\tCurve string\n\t\tKeyBytes []byte\n\t\tRest []byte `ssh:\"rest\"`\n\t}\n\n\tif err := Unmarshal(in, &w); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\tkey := new(ecdsa.PublicKey)\n\n\tswitch w.Curve {\n\tcase \"nistp256\":\n\t\tkey.Curve = elliptic.P256()\n\tcase \"nistp384\":\n\t\tkey.Curve = elliptic.P384()\n\tcase \"nistp521\":\n\t\tkey.Curve = elliptic.P521()\n\tdefault:\n\t\treturn nil, nil, errors.New(\"ssh: unsupported curve\")\n\t}\n\n\tkey.X, key.Y = elliptic.Unmarshal(key.Curve, w.KeyBytes)\n\tif key.X == nil || key.Y == nil {\n\t\treturn nil, nil, errors.New(\"ssh: invalid curve point\")\n\t}\n\treturn (*ecdsaPublicKey)(key), w.Rest, nil\n}\n\nfunc (k *ecdsaPublicKey) Marshal() []byte {\n\t// See RFC 5656, section 3.1.\n\tkeyBytes := elliptic.Marshal(k.Curve, k.X, k.Y)\n\t// ECDSA publickey struct layout should match the struct used by\n\t// parseECDSACert in the x/crypto/ssh/agent package.\n\tw := struct {\n\t\tName string\n\t\tID string\n\t\tKey []byte\n\t}{\n\t\tk.Type(),\n\t\tk.nistID(),\n\t\tkeyBytes,\n\t}\n\n\treturn Marshal(&w)\n}\n\nfunc (k *ecdsaPublicKey) Verify(data []byte, sig *Signature) error {\n\tif sig.Format != k.Type() {\n\t\treturn fmt.Errorf(\"ssh: signature type %s for key type %s\", sig.Format, k.Type())\n\t}\n\thash, err := hashFunc(sig.Format)\n\tif err != nil {\n\t\treturn err\n\t}\n\th := hash.New()\n\th.Write(data)\n\tdigest := h.Sum(nil)\n\n\t// Per RFC 5656, section 3.1.2,\n\t// The ecdsa_signature_blob value has the following specific encoding:\n\t// mpint r\n\t// mpint s\n\tvar ecSig struct {\n\t\tR *big.Int\n\t\tS *big.Int\n\t}\n\n\tif err := Unmarshal(sig.Blob, &ecSig); err != nil {\n\t\treturn err\n\t}\n\n\tif ecdsa.Verify((*ecdsa.PublicKey)(k), digest, ecSig.R, ecSig.S) {\n\t\treturn nil\n\t}\n\treturn errors.New(\"ssh: signature did not verify\")\n}\n\nfunc (k *ecdsaPublicKey) CryptoPublicKey() crypto.PublicKey {\n\treturn (*ecdsa.PublicKey)(k)\n}\n\n// skFields holds the additional fields present in U2F/FIDO2 signatures.\n// See openssh/PROTOCOL.u2f 'SSH U2F Signatures' for details.\ntype skFields struct {\n\t// Flags contains U2F/FIDO2 flags such as 'user present'\n\tFlags byte\n\t// Counter is a monotonic signature counter which can be\n\t// used to detect concurrent use of a private key, should\n\t// it be extracted from hardware.\n\tCounter uint32\n}\n\ntype skECDSAPublicKey struct {\n\t// application is a URL-like string, typically \"ssh:\" for SSH.\n\t// see openssh/PROTOCOL.u2f for details.\n\tapplication string\n\tecdsa.PublicKey\n}\n\nfunc (k *skECDSAPublicKey) Type() string {\n\treturn KeyAlgoSKECDSA256\n}\n\nfunc (k *skECDSAPublicKey) nistID() string {\n\treturn \"nistp256\"\n}\n\nfunc parseSKECDSA(in []byte) (out PublicKey, rest []byte, err error) {\n\tvar w struct {\n\t\tCurve string\n\t\tKeyBytes []byte\n\t\tApplication string\n\t\tRest []byte `ssh:\"rest\"`\n\t}\n\n\tif err := Unmarshal(in, &w); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\tkey := new(skECDSAPublicKey)\n\tkey.application = w.Application\n\n\tif w.Curve != \"nistp256\" {\n\t\treturn nil, nil, errors.New(\"ssh: unsupported curve\")\n\t}\n\tkey.Curve = elliptic.P256()\n\n\tkey.X, key.Y = elliptic.Unmarshal(key.Curve, w.KeyBytes)\n\tif key.X == nil || key.Y == nil {\n\t\treturn nil, nil, errors.New(\"ssh: invalid curve point\")\n\t}\n\n\treturn key, w.Rest, nil\n}\n\nfunc (k *skECDSAPublicKey) Marshal() []byte {\n\t// See RFC 5656, section 3.1.\n\tkeyBytes := elliptic.Marshal(k.Curve, k.X, k.Y)\n\tw := struct {\n\t\tName string\n\t\tID string\n\t\tKey []byte\n\t\tApplication string\n\t}{\n\t\tk.Type(),\n\t\tk.nistID(),\n\t\tkeyBytes,\n\t\tk.application,\n\t}\n\n\treturn Marshal(&w)\n}\n\nfunc (k *skECDSAPublicKey) Verify(data []byte, sig *Signature) error {\n\tif sig.Format != k.Type() {\n\t\treturn fmt.Errorf(\"ssh: signature type %s for key type %s\", sig.Format, k.Type())\n\t}\n\thash, err := hashFunc(sig.Format)\n\tif err != nil {\n\t\treturn err\n\t}\n\th := hash.New()\n\th.Write([]byte(k.application))\n\tappDigest := h.Sum(nil)\n\n\th.Reset()\n\th.Write(data)\n\tdataDigest := h.Sum(nil)\n\n\tvar ecSig struct {\n\t\tR *big.Int\n\t\tS *big.Int\n\t}\n\tif err := Unmarshal(sig.Blob, &ecSig); err != nil {\n\t\treturn err\n\t}\n\n\tvar skf skFields\n\tif err := Unmarshal(sig.Rest, &skf); err != nil {\n\t\treturn err\n\t}\n\n\tblob := struct {\n\t\tApplicationDigest []byte `ssh:\"rest\"`\n\t\tFlags byte\n\t\tCounter uint32\n\t\tMessageDigest []byte `ssh:\"rest\"`\n\t}{\n\t\tappDigest,\n\t\tskf.Flags,\n\t\tskf.Counter,\n\t\tdataDigest,\n\t}\n\n\toriginal := Marshal(blob)\n\n\th.Reset()\n\th.Write(original)\n\tdigest := h.Sum(nil)\n\n\tif ecdsa.Verify((*ecdsa.PublicKey)(&k.PublicKey), digest, ecSig.R, ecSig.S) {\n\t\treturn nil\n\t}\n\treturn errors.New(\"ssh: signature did not verify\")\n}\n\nfunc (k *skECDSAPublicKey) CryptoPublicKey() crypto.PublicKey {\n\treturn &k.PublicKey\n}\n\ntype skEd25519PublicKey struct {\n\t// application is a URL-like string, typically \"ssh:\" for SSH.\n\t// see openssh/PROTOCOL.u2f for details.\n\tapplication string\n\ted25519.PublicKey\n}\n\nfunc (k *skEd25519PublicKey) Type() string {\n\treturn KeyAlgoSKED25519\n}\n\nfunc parseSKEd25519(in []byte) (out PublicKey, rest []byte, err error) {\n\tvar w struct {\n\t\tKeyBytes []byte\n\t\tApplication string\n\t\tRest []byte `ssh:\"rest\"`\n\t}\n\n\tif err := Unmarshal(in, &w); err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\tif l := len(w.KeyBytes); l != ed25519.PublicKeySize {\n\t\treturn nil, nil, fmt.Errorf(\"invalid size %d for Ed25519 public key\", l)\n\t}\n\n\tkey := new(skEd25519PublicKey)\n\tkey.application = w.Application\n\tkey.PublicKey = ed25519.PublicKey(w.KeyBytes)\n\n\treturn key, w.Rest, nil\n}\n\nfunc (k *skEd25519PublicKey) Marshal() []byte {\n\tw := struct {\n\t\tName string\n\t\tKeyBytes []byte\n\t\tApplication string\n\t}{\n\t\tKeyAlgoSKED25519,\n\t\t[]byte(k.PublicKey),\n\t\tk.application,\n\t}\n\treturn Marshal(&w)\n}\n\nfunc (k *skEd25519PublicKey) Verify(data []byte, sig *Signature) error {\n\tif sig.Format != k.Type() {\n\t\treturn fmt.Errorf(\"ssh: signature type %s for key type %s\", sig.Format, k.Type())\n\t}\n\tif l := len(k.PublicKey); l != ed25519.PublicKeySize {\n\t\treturn fmt.Errorf(\"invalid size %d for Ed25519 public key\", l)\n\t}\n\n\thash, err := hashFunc(sig.Format)\n\tif err != nil {\n\t\treturn err\n\t}\n\th := hash.New()\n\th.Write([]byte(k.application))\n\tappDigest := h.Sum(nil)\n\n\th.Reset()\n\th.Write(data)\n\tdataDigest := h.Sum(nil)\n\n\tvar edSig struct {\n\t\tSignature []byte `ssh:\"rest\"`\n\t}\n\n\tif err := Unmarshal(sig.Blob, &edSig); err != nil {\n\t\treturn err\n\t}\n\n\tvar skf skFields\n\tif err := Unmarshal(sig.Rest, &skf); err != nil {\n\t\treturn err\n\t}\n\n\tblob := struct {\n\t\tApplicationDigest []byte `ssh:\"rest\"`\n\t\tFlags byte\n\t\tCounter uint32\n\t\tMessageDigest []byte `ssh:\"rest\"`\n\t}{\n\t\tappDigest,\n\t\tskf.Flags,\n\t\tskf.Counter,\n\t\tdataDigest,\n\t}\n\n\toriginal := Marshal(blob)\n\n\tif ok := ed25519.Verify(k.PublicKey, original, edSig.Signature); !ok {\n\t\treturn errors.New(\"ssh: signature did not verify\")\n\t}\n\n\treturn nil\n}\n\nfunc (k *skEd25519PublicKey) CryptoPublicKey() crypto.PublicKey {\n\treturn k.PublicKey\n}\n\n// NewSignerFromKey takes an *rsa.PrivateKey, *dsa.PrivateKey,\n// *ecdsa.PrivateKey or any other crypto.Signer and returns a\n// corresponding Signer instance. ECDSA keys must use P-256, P-384 or\n// P-521. DSA keys must use parameter size L1024N160.\nfunc NewSignerFromKey(key interface{}) (Signer, error) {\n\tswitch key := key.(type) {\n\tcase crypto.Signer:\n\t\treturn NewSignerFromSigner(key)\n\tcase *dsa.PrivateKey:\n\t\treturn newDSAPrivateKey(key)\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported key type %T\", key)\n\t}\n}\n\nfunc newDSAPrivateKey(key *dsa.PrivateKey) (Signer, error) {\n\tif err := checkDSAParams(&key.PublicKey.Parameters); err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn &dsaPrivateKey{key}, nil\n}\n\ntype wrappedSigner struct {\n\tsigner crypto.Signer\n\tpubKey PublicKey\n}\n\n// NewSignerFromSigner takes any crypto.Signer implementation and\n// returns a corresponding Signer interface. This can be used, for\n// example, with keys kept in hardware modules.\nfunc NewSignerFromSigner(signer crypto.Signer) (Signer, error) {\n\tpubKey, err := NewPublicKey(signer.Public())\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn &wrappedSigner{signer, pubKey}, nil\n}\n\nfunc (s *wrappedSigner) PublicKey() PublicKey {\n\treturn s.pubKey\n}\n\nfunc (s *wrappedSigner) Sign(rand io.Reader, data []byte) (*Signature, error) {\n\treturn s.SignWithAlgorithm(rand, data, s.pubKey.Type())\n}\n\nfunc (s *wrappedSigner) Algorithms() []string {\n\treturn algorithmsForKeyFormat(s.pubKey.Type())\n}\n\nfunc (s *wrappedSigner) SignWithAlgorithm(rand io.Reader, data []byte, algorithm string) (*Signature, error) {\n\tif algorithm == \"\" {\n\t\talgorithm = s.pubKey.Type()\n\t}\n\n\tif !slices.Contains(s.Algorithms(), algorithm) {\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported signature algorithm %q for key format %q\", algorithm, s.pubKey.Type())\n\t}\n\n\thashFunc, err := hashFunc(algorithm)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tvar digest []byte\n\tif hashFunc != 0 {\n\t\th := hashFunc.New()\n\t\th.Write(data)\n\t\tdigest = h.Sum(nil)\n\t} else {\n\t\tdigest = data\n\t}\n\n\tsignature, err := s.signer.Sign(rand, digest, hashFunc)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// crypto.Signer.Sign is expected to return an ASN.1-encoded signature\n\t// for ECDSA and DSA, but that's not the encoding expected by SSH, so\n\t// re-encode.\n\tswitch s.pubKey.(type) {\n\tcase *ecdsaPublicKey, *dsaPublicKey:\n\t\ttype asn1Signature struct {\n\t\t\tR, S *big.Int\n\t\t}\n\t\tasn1Sig := new(asn1Signature)\n\t\t_, err := asn1.Unmarshal(signature, asn1Sig)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tswitch s.pubKey.(type) {\n\t\tcase *ecdsaPublicKey:\n\t\t\tsignature = Marshal(asn1Sig)\n\n\t\tcase *dsaPublicKey:\n\t\t\tsignature = make([]byte, 40)\n\t\t\tr := asn1Sig.R.Bytes()\n\t\t\ts := asn1Sig.S.Bytes()\n\t\t\tcopy(signature[20-len(r):20], r)\n\t\t\tcopy(signature[40-len(s):40], s)\n\t\t}\n\t}\n\n\treturn &Signature{\n\t\tFormat: algorithm,\n\t\tBlob: signature,\n\t}, nil\n}\n\n// NewPublicKey takes an *rsa.PublicKey, *dsa.PublicKey, *ecdsa.PublicKey,\n// or ed25519.PublicKey returns a corresponding PublicKey instance.\n// ECDSA keys must use P-256, P-384 or P-521.\nfunc NewPublicKey(key interface{}) (PublicKey, error) {\n\tswitch key := key.(type) {\n\tcase *rsa.PublicKey:\n\t\treturn (*rsaPublicKey)(key), nil\n\tcase *ecdsa.PublicKey:\n\t\tif !supportedEllipticCurve(key.Curve) {\n\t\t\treturn nil, errors.New(\"ssh: only P-256, P-384 and P-521 EC keys are supported\")\n\t\t}\n\t\treturn (*ecdsaPublicKey)(key), nil\n\tcase *dsa.PublicKey:\n\t\treturn (*dsaPublicKey)(key), nil\n\tcase ed25519.PublicKey:\n\t\tif l := len(key); l != ed25519.PublicKeySize {\n\t\t\treturn nil, fmt.Errorf(\"ssh: invalid size %d for Ed25519 public key\", l)\n\t\t}\n\t\treturn ed25519PublicKey(key), nil\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported key type %T\", key)\n\t}\n}\n\n// ParsePrivateKey returns a Signer from a PEM encoded private key. It supports\n// the same keys as ParseRawPrivateKey. If the private key is encrypted, it\n// will return a PassphraseMissingError.\nfunc ParsePrivateKey(pemBytes []byte) (Signer, error) {\n\tkey, err := ParseRawPrivateKey(pemBytes)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn NewSignerFromKey(key)\n}\n\n// ParsePrivateKeyWithPassphrase returns a Signer from a PEM encoded private\n// key and passphrase. It supports the same keys as\n// ParseRawPrivateKeyWithPassphrase.\nfunc ParsePrivateKeyWithPassphrase(pemBytes, passphrase []byte) (Signer, error) {\n\tkey, err := ParseRawPrivateKeyWithPassphrase(pemBytes, passphrase)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn NewSignerFromKey(key)\n}\n\n// encryptedBlock tells whether a private key is\n// encrypted by examining its Proc-Type header\n// for a mention of ENCRYPTED\n// according to RFC 1421 Section 4.6.1.1.\nfunc encryptedBlock(block *pem.Block) bool {\n\treturn strings.Contains(block.Headers[\"Proc-Type\"], \"ENCRYPTED\")\n}\n\n// A PassphraseMissingError indicates that parsing this private key requires a\n// passphrase. Use ParsePrivateKeyWithPassphrase.\ntype PassphraseMissingError struct {\n\t// PublicKey will be set if the private key format includes an unencrypted\n\t// public key along with the encrypted private key.\n\tPublicKey PublicKey\n}\n\nfunc (*PassphraseMissingError) Error() string {\n\treturn \"ssh: this private key is passphrase protected\"\n}\n\n// ParseRawPrivateKey returns a private key from a PEM encoded private key. It supports\n// RSA, DSA, ECDSA, and Ed25519 private keys in PKCS#1, PKCS#8, OpenSSL, and OpenSSH\n// formats. If the private key is encrypted, it will return a PassphraseMissingError.\nfunc ParseRawPrivateKey(pemBytes []byte) (interface{}, error) {\n\tblock, _ := pem.Decode(pemBytes)\n\tif block == nil {\n\t\treturn nil, errors.New(\"ssh: no key found\")\n\t}\n\n\tif encryptedBlock(block) {\n\t\treturn nil, &PassphraseMissingError{}\n\t}\n\n\tswitch block.Type {\n\tcase \"RSA PRIVATE KEY\":\n\t\treturn x509.ParsePKCS1PrivateKey(block.Bytes)\n\t// RFC5208 - https://tools.ietf.org/html/rfc5208\n\tcase \"PRIVATE KEY\":\n\t\treturn x509.ParsePKCS8PrivateKey(block.Bytes)\n\tcase \"EC PRIVATE KEY\":\n\t\treturn x509.ParseECPrivateKey(block.Bytes)\n\tcase \"DSA PRIVATE KEY\":\n\t\treturn ParseDSAPrivateKey(block.Bytes)\n\tcase \"OPENSSH PRIVATE KEY\":\n\t\treturn parseOpenSSHPrivateKey(block.Bytes, unencryptedOpenSSHKey)\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported key type %q\", block.Type)\n\t}\n}\n\n// ParseRawPrivateKeyWithPassphrase returns a private key decrypted with\n// passphrase from a PEM encoded private key. If the passphrase is wrong, it\n// will return x509.IncorrectPasswordError.\nfunc ParseRawPrivateKeyWithPassphrase(pemBytes, passphrase []byte) (interface{}, error) {\n\tblock, _ := pem.Decode(pemBytes)\n\tif block == nil {\n\t\treturn nil, errors.New(\"ssh: no key found\")\n\t}\n\n\tif block.Type == \"OPENSSH PRIVATE KEY\" {\n\t\treturn parseOpenSSHPrivateKey(block.Bytes, passphraseProtectedOpenSSHKey(passphrase))\n\t}\n\n\tif !encryptedBlock(block) || !x509.IsEncryptedPEMBlock(block) {\n\t\treturn nil, errors.New(\"ssh: not an encrypted key\")\n\t}\n\n\tbuf, err := x509.DecryptPEMBlock(block, passphrase)\n\tif err != nil {\n\t\tif err == x509.IncorrectPasswordError {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn nil, fmt.Errorf(\"ssh: cannot decode encrypted private keys: %v\", err)\n\t}\n\n\tvar result interface{}\n\n\tswitch block.Type {\n\tcase \"RSA PRIVATE KEY\":\n\t\tresult, err = x509.ParsePKCS1PrivateKey(buf)\n\tcase \"EC PRIVATE KEY\":\n\t\tresult, err = x509.ParseECPrivateKey(buf)\n\tcase \"DSA PRIVATE KEY\":\n\t\tresult, err = ParseDSAPrivateKey(buf)\n\tdefault:\n\t\terr = fmt.Errorf(\"ssh: unsupported key type %q\", block.Type)\n\t}\n\t// Because of deficiencies in the format, DecryptPEMBlock does not always\n\t// detect an incorrect password. In these cases decrypted DER bytes is\n\t// random noise. If the parsing of the key returns an asn1.StructuralError\n\t// we return x509.IncorrectPasswordError.\n\tif _, ok := err.(asn1.StructuralError); ok {\n\t\treturn nil, x509.IncorrectPasswordError\n\t}\n\n\treturn result, err\n}\n\n// ParseDSAPrivateKey returns a DSA private key from its ASN.1 DER encoding, as\n// specified by the OpenSSL DSA man page.\nfunc ParseDSAPrivateKey(der []byte) (*dsa.PrivateKey, error) {\n\tvar k struct {\n\t\tVersion int\n\t\tP *big.Int\n\t\tQ *big.Int\n\t\tG *big.Int\n\t\tPub *big.Int\n\t\tPriv *big.Int\n\t}\n\trest, err := asn1.Unmarshal(der, &k)\n\tif err != nil {\n\t\treturn nil, errors.New(\"ssh: failed to parse DSA key: \" + err.Error())\n\t}\n\tif len(rest) > 0 {\n\t\treturn nil, errors.New(\"ssh: garbage after DSA key\")\n\t}\n\n\treturn &dsa.PrivateKey{\n\t\tPublicKey: dsa.PublicKey{\n\t\t\tParameters: dsa.Parameters{\n\t\t\t\tP: k.P,\n\t\t\t\tQ: k.Q,\n\t\t\t\tG: k.G,\n\t\t\t},\n\t\t\tY: k.Pub,\n\t\t},\n\t\tX: k.Priv,\n\t}, nil\n}\n\nfunc unencryptedOpenSSHKey(cipherName, kdfName, kdfOpts string, privKeyBlock []byte) ([]byte, error) {\n\tif kdfName != \"none\" || cipherName != \"none\" {\n\t\treturn nil, &PassphraseMissingError{}\n\t}\n\tif kdfOpts != \"\" {\n\t\treturn nil, errors.New(\"ssh: invalid openssh private key\")\n\t}\n\treturn privKeyBlock, nil\n}\n\nfunc passphraseProtectedOpenSSHKey(passphrase []byte) openSSHDecryptFunc {\n\treturn func(cipherName, kdfName, kdfOpts string, privKeyBlock []byte) ([]byte, error) {\n\t\tif kdfName == \"none\" || cipherName == \"none\" {\n\t\t\treturn nil, errors.New(\"ssh: key is not password protected\")\n\t\t}\n\t\tif kdfName != \"bcrypt\" {\n\t\t\treturn nil, fmt.Errorf(\"ssh: unknown KDF %q, only supports %q\", kdfName, \"bcrypt\")\n\t\t}\n\n\t\tvar opts struct {\n\t\t\tSalt string\n\t\t\tRounds uint32\n\t\t}\n\t\tif err := Unmarshal([]byte(kdfOpts), &opts); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tk, err := bcrypt_pbkdf.Key(passphrase, []byte(opts.Salt), int(opts.Rounds), 32+16)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tkey, iv := k[:32], k[32:]\n\n\t\tc, err := aes.NewCipher(key)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tswitch cipherName {\n\t\tcase \"aes256-ctr\":\n\t\t\tctr := cipher.NewCTR(c, iv)\n\t\t\tctr.XORKeyStream(privKeyBlock, privKeyBlock)\n\t\tcase \"aes256-cbc\":\n\t\t\tif len(privKeyBlock)%c.BlockSize() != 0 {\n\t\t\t\treturn nil, fmt.Errorf(\"ssh: invalid encrypted private key length, not a multiple of the block size\")\n\t\t\t}\n\t\t\tcbc := cipher.NewCBCDecrypter(c, iv)\n\t\t\tcbc.CryptBlocks(privKeyBlock, privKeyBlock)\n\t\tdefault:\n\t\t\treturn nil, fmt.Errorf(\"ssh: unknown cipher %q, only supports %q or %q\", cipherName, \"aes256-ctr\", \"aes256-cbc\")\n\t\t}\n\n\t\treturn privKeyBlock, nil\n\t}\n}\n\nfunc unencryptedOpenSSHMarshaler(privKeyBlock []byte) ([]byte, string, string, string, error) {\n\tkey := generateOpenSSHPadding(privKeyBlock, 8)\n\treturn key, \"none\", \"none\", \"\", nil\n}\n\nfunc passphraseProtectedOpenSSHMarshaler(passphrase []byte) openSSHEncryptFunc {\n\treturn func(privKeyBlock []byte) ([]byte, string, string, string, error) {\n\t\tsalt := make([]byte, 16)\n\t\tif _, err := rand.Read(salt); err != nil {\n\t\t\treturn nil, \"\", \"\", \"\", err\n\t\t}\n\n\t\topts := struct {\n\t\t\tSalt []byte\n\t\t\tRounds uint32\n\t\t}{salt, 16}\n\n\t\t// Derive key to encrypt the private key block.\n\t\tk, err := bcrypt_pbkdf.Key(passphrase, salt, int(opts.Rounds), 32+aes.BlockSize)\n\t\tif err != nil {\n\t\t\treturn nil, \"\", \"\", \"\", err\n\t\t}\n\n\t\t// Add padding matching the block size of AES.\n\t\tkeyBlock := generateOpenSSHPadding(privKeyBlock, aes.BlockSize)\n\n\t\t// Encrypt the private key using the derived secret.\n\n\t\tdst := make([]byte, len(keyBlock))\n\t\tkey, iv := k[:32], k[32:]\n\t\tblock, err := aes.NewCipher(key)\n\t\tif err != nil {\n\t\t\treturn nil, \"\", \"\", \"\", err\n\t\t}\n\n\t\tstream := cipher.NewCTR(block, iv)\n\t\tstream.XORKeyStream(dst, keyBlock)\n\n\t\treturn dst, \"aes256-ctr\", \"bcrypt\", string(Marshal(opts)), nil\n\t}\n}\n\nconst privateKeyAuthMagic = \"openssh-key-v1\\x00\"\n\ntype openSSHDecryptFunc func(CipherName, KdfName, KdfOpts string, PrivKeyBlock []byte) ([]byte, error)\ntype openSSHEncryptFunc func(PrivKeyBlock []byte) (ProtectedKeyBlock []byte, cipherName, kdfName, kdfOptions string, err error)\n\ntype openSSHEncryptedPrivateKey struct {\n\tCipherName string\n\tKdfName string\n\tKdfOpts string\n\tNumKeys uint32\n\tPubKey []byte\n\tPrivKeyBlock []byte\n\tRest []byte `ssh:\"rest\"`\n}\n\ntype openSSHPrivateKey struct {\n\tCheck1 uint32\n\tCheck2 uint32\n\tKeytype string\n\tRest []byte `ssh:\"rest\"`\n}\n\ntype openSSHRSAPrivateKey struct {\n\tN *big.Int\n\tE *big.Int\n\tD *big.Int\n\tIqmp *big.Int\n\tP *big.Int\n\tQ *big.Int\n\tComment string\n\tPad []byte `ssh:\"rest\"`\n}\n\ntype openSSHEd25519PrivateKey struct {\n\tPub []byte\n\tPriv []byte\n\tComment string\n\tPad []byte `ssh:\"rest\"`\n}\n\ntype openSSHECDSAPrivateKey struct {\n\tCurve string\n\tPub []byte\n\tD *big.Int\n\tComment string\n\tPad []byte `ssh:\"rest\"`\n}\n\n// parseOpenSSHPrivateKey parses an OpenSSH private key, using the decrypt\n// function to unwrap the encrypted portion. unencryptedOpenSSHKey can be used\n// as the decrypt function to parse an unencrypted private key. See\n// https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key.\nfunc parseOpenSSHPrivateKey(key []byte, decrypt openSSHDecryptFunc) (crypto.PrivateKey, error) {\n\tif len(key) < len(privateKeyAuthMagic) || string(key[:len(privateKeyAuthMagic)]) != privateKeyAuthMagic {\n\t\treturn nil, errors.New(\"ssh: invalid openssh private key format\")\n\t}\n\tremaining := key[len(privateKeyAuthMagic):]\n\n\tvar w openSSHEncryptedPrivateKey\n\tif err := Unmarshal(remaining, &w); err != nil {\n\t\treturn nil, err\n\t}\n\tif w.NumKeys != 1 {\n\t\t// We only support single key files, and so does OpenSSH.\n\t\t// https://github.com/openssh/openssh-portable/blob/4103a3ec7/sshkey.c#L4171\n\t\treturn nil, errors.New(\"ssh: multi-key files are not supported\")\n\t}\n\n\tprivKeyBlock, err := decrypt(w.CipherName, w.KdfName, w.KdfOpts, w.PrivKeyBlock)\n\tif err != nil {\n\t\tif err, ok := err.(*PassphraseMissingError); ok {\n\t\t\tpub, errPub := ParsePublicKey(w.PubKey)\n\t\t\tif errPub != nil {\n\t\t\t\treturn nil, fmt.Errorf(\"ssh: failed to parse embedded public key: %v\", errPub)\n\t\t\t}\n\t\t\terr.PublicKey = pub\n\t\t}\n\t\treturn nil, err\n\t}\n\n\tvar pk1 openSSHPrivateKey\n\tif err := Unmarshal(privKeyBlock, &pk1); err != nil || pk1.Check1 != pk1.Check2 {\n\t\tif w.CipherName != \"none\" {\n\t\t\treturn nil, x509.IncorrectPasswordError\n\t\t}\n\t\treturn nil, errors.New(\"ssh: malformed OpenSSH key\")\n\t}\n\n\tswitch pk1.Keytype {\n\tcase KeyAlgoRSA:\n\t\tvar key openSSHRSAPrivateKey\n\t\tif err := Unmarshal(pk1.Rest, &key); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tif err := checkOpenSSHKeyPadding(key.Pad); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tpk := &rsa.PrivateKey{\n\t\t\tPublicKey: rsa.PublicKey{\n\t\t\t\tN: key.N,\n\t\t\t\tE: int(key.E.Int64()),\n\t\t\t},\n\t\t\tD: key.D,\n\t\t\tPrimes: []*big.Int{key.P, key.Q},\n\t\t}\n\n\t\tif err := pk.Validate(); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tpk.Precompute()\n\n\t\treturn pk, nil\n\tcase KeyAlgoED25519:\n\t\tvar key openSSHEd25519PrivateKey\n\t\tif err := Unmarshal(pk1.Rest, &key); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tif len(key.Priv) != ed25519.PrivateKeySize {\n\t\t\treturn nil, errors.New(\"ssh: private key unexpected length\")\n\t\t}\n\n\t\tif err := checkOpenSSHKeyPadding(key.Pad); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tpk := ed25519.PrivateKey(make([]byte, ed25519.PrivateKeySize))\n\t\tcopy(pk, key.Priv)\n\t\treturn &pk, nil\n\tcase KeyAlgoECDSA256, KeyAlgoECDSA384, KeyAlgoECDSA521:\n\t\tvar key openSSHECDSAPrivateKey\n\t\tif err := Unmarshal(pk1.Rest, &key); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tif err := checkOpenSSHKeyPadding(key.Pad); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tvar curve elliptic.Curve\n\t\tswitch key.Curve {\n\t\tcase \"nistp256\":\n\t\t\tcurve = elliptic.P256()\n\t\tcase \"nistp384\":\n\t\t\tcurve = elliptic.P384()\n\t\tcase \"nistp521\":\n\t\t\tcurve = elliptic.P521()\n\t\tdefault:\n\t\t\treturn nil, errors.New(\"ssh: unhandled elliptic curve: \" + key.Curve)\n\t\t}\n\n\t\tX, Y := elliptic.Unmarshal(curve, key.Pub)\n\t\tif X == nil || Y == nil {\n\t\t\treturn nil, errors.New(\"ssh: failed to unmarshal public key\")\n\t\t}\n\n\t\tif key.D.Cmp(curve.Params().N) >= 0 {\n\t\t\treturn nil, errors.New(\"ssh: scalar is out of range\")\n\t\t}\n\n\t\tx, y := curve.ScalarBaseMult(key.D.Bytes())\n\t\tif x.Cmp(X) != 0 || y.Cmp(Y) != 0 {\n\t\t\treturn nil, errors.New(\"ssh: public key does not match private key\")\n\t\t}\n\n\t\treturn &ecdsa.PrivateKey{\n\t\t\tPublicKey: ecdsa.PublicKey{\n\t\t\t\tCurve: curve,\n\t\t\t\tX: X,\n\t\t\t\tY: Y,\n\t\t\t},\n\t\t\tD: key.D,\n\t\t}, nil\n\tdefault:\n\t\treturn nil, errors.New(\"ssh: unhandled key type\")\n\t}\n}\n\nfunc marshalOpenSSHPrivateKey(key crypto.PrivateKey, comment string, encrypt openSSHEncryptFunc) (*pem.Block, error) {\n\tvar w openSSHEncryptedPrivateKey\n\tvar pk1 openSSHPrivateKey\n\n\t// Random check bytes.\n\tvar check uint32\n\tif err := binary.Read(rand.Reader, binary.BigEndian, &check); err != nil {\n\t\treturn nil, err\n\t}\n\n\tpk1.Check1 = check\n\tpk1.Check2 = check\n\tw.NumKeys = 1\n\n\t// Use a []byte directly on ed25519 keys.\n\tif k, ok := key.(*ed25519.PrivateKey); ok {\n\t\tkey = *k\n\t}\n\n\tswitch k := key.(type) {\n\tcase *rsa.PrivateKey:\n\t\tE := new(big.Int).SetInt64(int64(k.PublicKey.E))\n\t\t// Marshal public key:\n\t\t// E and N are in reversed order in the public and private key.\n\t\tpubKey := struct {\n\t\t\tKeyType string\n\t\t\tE *big.Int\n\t\t\tN *big.Int\n\t\t}{\n\t\t\tKeyAlgoRSA,\n\t\t\tE, k.PublicKey.N,\n\t\t}\n\t\tw.PubKey = Marshal(pubKey)\n\n\t\t// Marshal private key.\n\t\tkey := openSSHRSAPrivateKey{\n\t\t\tN: k.PublicKey.N,\n\t\t\tE: E,\n\t\t\tD: k.D,\n\t\t\tIqmp: k.Precomputed.Qinv,\n\t\t\tP: k.Primes[0],\n\t\t\tQ: k.Primes[1],\n\t\t\tComment: comment,\n\t\t}\n\t\tpk1.Keytype = KeyAlgoRSA\n\t\tpk1.Rest = Marshal(key)\n\tcase ed25519.PrivateKey:\n\t\tpub := make([]byte, ed25519.PublicKeySize)\n\t\tpriv := make([]byte, ed25519.PrivateKeySize)\n\t\tcopy(pub, k[32:])\n\t\tcopy(priv, k)\n\n\t\t// Marshal public key.\n\t\tpubKey := struct {\n\t\t\tKeyType string\n\t\t\tPub []byte\n\t\t}{\n\t\t\tKeyAlgoED25519, pub,\n\t\t}\n\t\tw.PubKey = Marshal(pubKey)\n\n\t\t// Marshal private key.\n\t\tkey := openSSHEd25519PrivateKey{\n\t\t\tPub: pub,\n\t\t\tPriv: priv,\n\t\t\tComment: comment,\n\t\t}\n\t\tpk1.Keytype = KeyAlgoED25519\n\t\tpk1.Rest = Marshal(key)\n\tcase *ecdsa.PrivateKey:\n\t\tvar curve, keyType string\n\t\tswitch name := k.Curve.Params().Name; name {\n\t\tcase \"P-256\":\n\t\t\tcurve = \"nistp256\"\n\t\t\tkeyType = KeyAlgoECDSA256\n\t\tcase \"P-384\":\n\t\t\tcurve = \"nistp384\"\n\t\t\tkeyType = KeyAlgoECDSA384\n\t\tcase \"P-521\":\n\t\t\tcurve = \"nistp521\"\n\t\t\tkeyType = KeyAlgoECDSA521\n\t\tdefault:\n\t\t\treturn nil, errors.New(\"ssh: unhandled elliptic curve \" + name)\n\t\t}\n\n\t\tpub := elliptic.Marshal(k.Curve, k.PublicKey.X, k.PublicKey.Y)\n\n\t\t// Marshal public key.\n\t\tpubKey := struct {\n\t\t\tKeyType string\n\t\t\tCurve string\n\t\t\tPub []byte\n\t\t}{\n\t\t\tkeyType, curve, pub,\n\t\t}\n\t\tw.PubKey = Marshal(pubKey)\n\n\t\t// Marshal private key.\n\t\tkey := openSSHECDSAPrivateKey{\n\t\t\tCurve: curve,\n\t\t\tPub: pub,\n\t\t\tD: k.D,\n\t\t\tComment: comment,\n\t\t}\n\t\tpk1.Keytype = keyType\n\t\tpk1.Rest = Marshal(key)\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported key type %T\", k)\n\t}\n\n\tvar err error\n\t// Add padding and encrypt the key if necessary.\n\tw.PrivKeyBlock, w.CipherName, w.KdfName, w.KdfOpts, err = encrypt(Marshal(pk1))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tb := Marshal(w)\n\tblock := &pem.Block{\n\t\tType: \"OPENSSH PRIVATE KEY\",\n\t\tBytes: append([]byte(privateKeyAuthMagic), b...),\n\t}\n\treturn block, nil\n}\n\nfunc checkOpenSSHKeyPadding(pad []byte) error {\n\tfor i, b := range pad {\n\t\tif int(b) != i+1 {\n\t\t\treturn errors.New(\"ssh: padding not as expected\")\n\t\t}\n\t}\n\treturn nil\n}\n\nfunc generateOpenSSHPadding(block []byte, blockSize int) []byte {\n\tfor i, l := 0, len(block); (l+i)%blockSize != 0; i++ {\n\t\tblock = append(block, byte(i+1))\n\t}\n\treturn block\n}\n\n// FingerprintLegacyMD5 returns the user presentation of the key's\n// fingerprint as described by RFC 4716 section 4.\nfunc FingerprintLegacyMD5(pubKey PublicKey) string {\n\tmd5sum := md5.Sum(pubKey.Marshal())\n\thexarray := make([]string, len(md5sum))\n\tfor i, c := range md5sum {\n\t\thexarray[i] = hex.EncodeToString([]byte{c})\n\t}\n\treturn strings.Join(hexarray, \":\")\n}\n\n// FingerprintSHA256 returns the user presentation of the key's\n// fingerprint as unpadded base64 encoded sha256 hash.\n// This format was introduced from OpenSSH 6.8.\n// https://www.openssh.com/txt/release-6.8\n// https://tools.ietf.org/html/rfc4648#section-3.2 (unpadded base64 encoding)\nfunc FingerprintSHA256(pubKey PublicKey) string {\n\tsha256sum := sha256.Sum256(pubKey.Marshal())\n\thash := base64.RawStdEncoding.EncodeToString(sha256sum[:])\n\treturn \"SHA256:\" + hash\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/mac.go",
"content": "// Copyright 2012 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\n// Message authentication support\n\nimport (\n\t\"crypto/fips140\"\n\t\"crypto/hmac\"\n\t\"crypto/sha1\"\n\t\"crypto/sha256\"\n\t\"crypto/sha512\"\n\t\"hash\"\n\t\"slices\"\n)\n\ntype macMode struct {\n\tkeySize int\n\tetm bool\n\tnew func(key []byte) hash.Hash\n}\n\n// truncatingMAC wraps around a hash.Hash and truncates the output digest to\n// a given size.\ntype truncatingMAC struct {\n\tlength int\n\thmac hash.Hash\n}\n\nfunc (t truncatingMAC) Write(data []byte) (int, error) {\n\treturn t.hmac.Write(data)\n}\n\nfunc (t truncatingMAC) Sum(in []byte) []byte {\n\tout := t.hmac.Sum(in)\n\treturn out[:len(in)+t.length]\n}\n\nfunc (t truncatingMAC) Reset() {\n\tt.hmac.Reset()\n}\n\nfunc (t truncatingMAC) Size() int {\n\treturn t.length\n}\n\nfunc (t truncatingMAC) BlockSize() int { return t.hmac.BlockSize() }\n\n// macModes defines the supported MACs. MACs not included are not supported\n// and will not be negotiated, even if explicitly configured. When FIPS mode is\n// enabled, only FIPS-approved algorithms are included.\nvar macModes = map[string]*macMode{}\n\nfunc init() {\n\tmacModes[HMACSHA512ETM] = &macMode{64, true, func(key []byte) hash.Hash {\n\t\treturn hmac.New(sha512.New, key)\n\t}}\n\tmacModes[HMACSHA256ETM] = &macMode{32, true, func(key []byte) hash.Hash {\n\t\treturn hmac.New(sha256.New, key)\n\t}}\n\tmacModes[HMACSHA512] = &macMode{64, false, func(key []byte) hash.Hash {\n\t\treturn hmac.New(sha512.New, key)\n\t}}\n\tmacModes[HMACSHA256] = &macMode{32, false, func(key []byte) hash.Hash {\n\t\treturn hmac.New(sha256.New, key)\n\t}}\n\n\tif fips140.Enabled() {\n\t\tdefaultMACs = slices.DeleteFunc(defaultMACs, func(algo string) bool {\n\t\t\t_, ok := macModes[algo]\n\t\t\treturn !ok\n\t\t})\n\t\treturn\n\t}\n\n\tmacModes[HMACSHA1] = &macMode{20, false, func(key []byte) hash.Hash {\n\t\treturn hmac.New(sha1.New, key)\n\t}}\n\tmacModes[InsecureHMACSHA196] = &macMode{20, false, func(key []byte) hash.Hash {\n\t\treturn truncatingMAC{12, hmac.New(sha1.New, key)}\n\t}}\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/messages.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"bytes\"\n\t\"encoding/binary\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"math/big\"\n\t\"reflect\"\n\t\"strconv\"\n\t\"strings\"\n)\n\n// These are SSH message type numbers. They are scattered around several\n// documents but many were taken from [SSH-PARAMETERS].\nconst (\n\tmsgIgnore = 2\n\tmsgUnimplemented = 3\n\tmsgDebug = 4\n\tmsgNewKeys = 21\n)\n\n// SSH messages:\n//\n// These structures mirror the wire format of the corresponding SSH messages.\n// They are marshaled using reflection with the marshal and unmarshal functions\n// in this file. The only wrinkle is that a final member of type []byte with a\n// ssh tag of \"rest\" receives the remainder of a packet when unmarshaling.\n\n// See RFC 4253, section 11.1.\nconst msgDisconnect = 1\n\n// disconnectMsg is the message that signals a disconnect. It is also\n// the error type returned from mux.Wait()\ntype disconnectMsg struct {\n\tReason uint32 `sshtype:\"1\"`\n\tMessage string\n\tLanguage string\n}\n\nfunc (d *disconnectMsg) Error() string {\n\treturn fmt.Sprintf(\"ssh: disconnect, reason %d: %s\", d.Reason, d.Message)\n}\n\n// See RFC 4253, section 7.1.\nconst msgKexInit = 20\n\ntype kexInitMsg struct {\n\tCookie [16]byte `sshtype:\"20\"`\n\tKexAlgos []string\n\tServerHostKeyAlgos []string\n\tCiphersClientServer []string\n\tCiphersServerClient []string\n\tMACsClientServer []string\n\tMACsServerClient []string\n\tCompressionClientServer []string\n\tCompressionServerClient []string\n\tLanguagesClientServer []string\n\tLanguagesServerClient []string\n\tFirstKexFollows bool\n\tReserved uint32\n}\n\n// See RFC 4253, section 8.\n\n// Diffie-Hellman\nconst msgKexDHInit = 30\n\ntype kexDHInitMsg struct {\n\tX *big.Int `sshtype:\"30\"`\n}\n\nconst msgKexECDHInit = 30\n\ntype kexECDHInitMsg struct {\n\tClientPubKey []byte `sshtype:\"30\"`\n}\n\nconst msgKexECDHReply = 31\n\ntype kexECDHReplyMsg struct {\n\tHostKey []byte `sshtype:\"31\"`\n\tEphemeralPubKey []byte\n\tSignature []byte\n}\n\nconst msgKexDHReply = 31\n\ntype kexDHReplyMsg struct {\n\tHostKey []byte `sshtype:\"31\"`\n\tY *big.Int\n\tSignature []byte\n}\n\n// See RFC 4419, section 5.\nconst msgKexDHGexGroup = 31\n\ntype kexDHGexGroupMsg struct {\n\tP *big.Int `sshtype:\"31\"`\n\tG *big.Int\n}\n\nconst msgKexDHGexInit = 32\n\ntype kexDHGexInitMsg struct {\n\tX *big.Int `sshtype:\"32\"`\n}\n\nconst msgKexDHGexReply = 33\n\ntype kexDHGexReplyMsg struct {\n\tHostKey []byte `sshtype:\"33\"`\n\tY *big.Int\n\tSignature []byte\n}\n\nconst msgKexDHGexRequest = 34\n\ntype kexDHGexRequestMsg struct {\n\tMinBits uint32 `sshtype:\"34\"`\n\tPreferredBits uint32\n\tMaxBits uint32\n}\n\n// See RFC 4253, section 10.\nconst msgServiceRequest = 5\n\ntype serviceRequestMsg struct {\n\tService string `sshtype:\"5\"`\n}\n\n// See RFC 4253, section 10.\nconst msgServiceAccept = 6\n\ntype serviceAcceptMsg struct {\n\tService string `sshtype:\"6\"`\n}\n\n// See RFC 8308, section 2.3\nconst msgExtInfo = 7\n\ntype extInfoMsg struct {\n\tNumExtensions uint32 `sshtype:\"7\"`\n\tPayload []byte `ssh:\"rest\"`\n}\n\n// See RFC 4252, section 5.\nconst msgUserAuthRequest = 50\n\ntype userAuthRequestMsg struct {\n\tUser string `sshtype:\"50\"`\n\tService string\n\tMethod string\n\tPayload []byte `ssh:\"rest\"`\n}\n\n// Used for debug printouts of packets.\ntype userAuthSuccessMsg struct {\n}\n\n// See RFC 4252, section 5.1\nconst msgUserAuthFailure = 51\n\ntype userAuthFailureMsg struct {\n\tMethods []string `sshtype:\"51\"`\n\tPartialSuccess bool\n}\n\n// See RFC 4252, section 5.1\nconst msgUserAuthSuccess = 52\n\n// See RFC 4252, section 5.4\nconst msgUserAuthBanner = 53\n\ntype userAuthBannerMsg struct {\n\tMessage string `sshtype:\"53\"`\n\t// unused, but required to allow message parsing\n\tLanguage string\n}\n\n// See RFC 4256, section 3.2\nconst msgUserAuthInfoRequest = 60\nconst msgUserAuthInfoResponse = 61\n\ntype userAuthInfoRequestMsg struct {\n\tName string `sshtype:\"60\"`\n\tInstruction string\n\tLanguage string\n\tNumPrompts uint32\n\tPrompts []byte `ssh:\"rest\"`\n}\n\n// See RFC 4254, section 5.1.\nconst msgChannelOpen = 90\n\ntype channelOpenMsg struct {\n\tChanType string `sshtype:\"90\"`\n\tPeersID uint32\n\tPeersWindow uint32\n\tMaxPacketSize uint32\n\tTypeSpecificData []byte `ssh:\"rest\"`\n}\n\nconst msgChannelExtendedData = 95\nconst msgChannelData = 94\n\n// Used for debug print outs of packets.\ntype channelDataMsg struct {\n\tPeersID uint32 `sshtype:\"94\"`\n\tLength uint32\n\tRest []byte `ssh:\"rest\"`\n}\n\n// See RFC 4254, section 5.1.\nconst msgChannelOpenConfirm = 91\n\ntype channelOpenConfirmMsg struct {\n\tPeersID uint32 `sshtype:\"91\"`\n\tMyID uint32\n\tMyWindow uint32\n\tMaxPacketSize uint32\n\tTypeSpecificData []byte `ssh:\"rest\"`\n}\n\n// See RFC 4254, section 5.1.\nconst msgChannelOpenFailure = 92\n\ntype channelOpenFailureMsg struct {\n\tPeersID uint32 `sshtype:\"92\"`\n\tReason RejectionReason\n\tMessage string\n\tLanguage string\n}\n\nconst msgChannelRequest = 98\n\ntype channelRequestMsg struct {\n\tPeersID uint32 `sshtype:\"98\"`\n\tRequest string\n\tWantReply bool\n\tRequestSpecificData []byte `ssh:\"rest\"`\n}\n\n// See RFC 4254, section 5.4.\nconst msgChannelSuccess = 99\n\ntype channelRequestSuccessMsg struct {\n\tPeersID uint32 `sshtype:\"99\"`\n}\n\n// See RFC 4254, section 5.4.\nconst msgChannelFailure = 100\n\ntype channelRequestFailureMsg struct {\n\tPeersID uint32 `sshtype:\"100\"`\n}\n\n// See RFC 4254, section 5.3\nconst msgChannelClose = 97\n\ntype channelCloseMsg struct {\n\tPeersID uint32 `sshtype:\"97\"`\n}\n\n// See RFC 4254, section 5.3\nconst msgChannelEOF = 96\n\ntype channelEOFMsg struct {\n\tPeersID uint32 `sshtype:\"96\"`\n}\n\n// See RFC 4254, section 4\nconst msgGlobalRequest = 80\n\ntype globalRequestMsg struct {\n\tType string `sshtype:\"80\"`\n\tWantReply bool\n\tData []byte `ssh:\"rest\"`\n}\n\n// See RFC 4254, section 4\nconst msgRequestSuccess = 81\n\ntype globalRequestSuccessMsg struct {\n\tData []byte `ssh:\"rest\" sshtype:\"81\"`\n}\n\n// See RFC 4254, section 4\nconst msgRequestFailure = 82\n\ntype globalRequestFailureMsg struct {\n\tData []byte `ssh:\"rest\" sshtype:\"82\"`\n}\n\n// See RFC 4254, section 5.2\nconst msgChannelWindowAdjust = 93\n\ntype windowAdjustMsg struct {\n\tPeersID uint32 `sshtype:\"93\"`\n\tAdditionalBytes uint32\n}\n\n// See RFC 4252, section 7\nconst msgUserAuthPubKeyOk = 60\n\ntype userAuthPubKeyOkMsg struct {\n\tAlgo string `sshtype:\"60\"`\n\tPubKey []byte\n}\n\n// See RFC 4462, section 3\nconst msgUserAuthGSSAPIResponse = 60\n\ntype userAuthGSSAPIResponse struct {\n\tSupportMech []byte `sshtype:\"60\"`\n}\n\nconst msgUserAuthGSSAPIToken = 61\n\ntype userAuthGSSAPIToken struct {\n\tToken []byte `sshtype:\"61\"`\n}\n\nconst msgUserAuthGSSAPIMIC = 66\n\ntype userAuthGSSAPIMIC struct {\n\tMIC []byte `sshtype:\"66\"`\n}\n\n// See RFC 4462, section 3.9\nconst msgUserAuthGSSAPIErrTok = 64\n\ntype userAuthGSSAPIErrTok struct {\n\tErrorToken []byte `sshtype:\"64\"`\n}\n\n// See RFC 4462, section 3.8\nconst msgUserAuthGSSAPIError = 65\n\ntype userAuthGSSAPIError struct {\n\tMajorStatus uint32 `sshtype:\"65\"`\n\tMinorStatus uint32\n\tMessage string\n\tLanguageTag string\n}\n\n// Transport layer OpenSSH extension. See [PROTOCOL], section 1.9\nconst msgPing = 192\n\ntype pingMsg struct {\n\tData string `sshtype:\"192\"`\n}\n\n// Transport layer OpenSSH extension. See [PROTOCOL], section 1.9\nconst msgPong = 193\n\ntype pongMsg struct {\n\tData string `sshtype:\"193\"`\n}\n\n// typeTags returns the possible type bytes for the given reflect.Type, which\n// should be a struct. The possible values are separated by a '|' character.\nfunc typeTags(structType reflect.Type) (tags []byte) {\n\ttagStr := structType.Field(0).Tag.Get(\"sshtype\")\n\n\tfor _, tag := range strings.Split(tagStr, \"|\") {\n\t\ti, err := strconv.Atoi(tag)\n\t\tif err == nil {\n\t\t\ttags = append(tags, byte(i))\n\t\t}\n\t}\n\n\treturn tags\n}\n\nfunc fieldError(t reflect.Type, field int, problem string) error {\n\tif problem != \"\" {\n\t\tproblem = \": \" + problem\n\t}\n\treturn fmt.Errorf(\"ssh: unmarshal error for field %s of type %s%s\", t.Field(field).Name, t.Name(), problem)\n}\n\nvar errShortRead = errors.New(\"ssh: short read\")\n\n// Unmarshal parses data in SSH wire format into a structure. The out\n// argument should be a pointer to struct. If the first member of the\n// struct has the \"sshtype\" tag set to a '|'-separated set of numbers\n// in decimal, the packet must start with one of those numbers. In\n// case of error, Unmarshal returns a ParseError or\n// UnexpectedMessageError.\nfunc Unmarshal(data []byte, out interface{}) error {\n\tv := reflect.ValueOf(out).Elem()\n\tstructType := v.Type()\n\texpectedTypes := typeTags(structType)\n\n\tvar expectedType byte\n\tif len(expectedTypes) > 0 {\n\t\texpectedType = expectedTypes[0]\n\t}\n\n\tif len(data) == 0 {\n\t\treturn parseError(expectedType)\n\t}\n\n\tif len(expectedTypes) > 0 {\n\t\tgoodType := false\n\t\tfor _, e := range expectedTypes {\n\t\t\tif e > 0 && data[0] == e {\n\t\t\t\tgoodType = true\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t\tif !goodType {\n\t\t\treturn fmt.Errorf(\"ssh: unexpected message type %d (expected one of %v)\", data[0], expectedTypes)\n\t\t}\n\t\tdata = data[1:]\n\t}\n\n\tvar ok bool\n\tfor i := 0; i < v.NumField(); i++ {\n\t\tfield := v.Field(i)\n\t\tt := field.Type()\n\t\tswitch t.Kind() {\n\t\tcase reflect.Bool:\n\t\t\tif len(data) < 1 {\n\t\t\t\treturn errShortRead\n\t\t\t}\n\t\t\tfield.SetBool(data[0] != 0)\n\t\t\tdata = data[1:]\n\t\tcase reflect.Array:\n\t\t\tif t.Elem().Kind() != reflect.Uint8 {\n\t\t\t\treturn fieldError(structType, i, \"array of unsupported type\")\n\t\t\t}\n\t\t\tif len(data) < t.Len() {\n\t\t\t\treturn errShortRead\n\t\t\t}\n\t\t\tfor j, n := 0, t.Len(); j < n; j++ {\n\t\t\t\tfield.Index(j).Set(reflect.ValueOf(data[j]))\n\t\t\t}\n\t\t\tdata = data[t.Len():]\n\t\tcase reflect.Uint64:\n\t\t\tvar u64 uint64\n\t\t\tif u64, data, ok = parseUint64(data); !ok {\n\t\t\t\treturn errShortRead\n\t\t\t}\n\t\t\tfield.SetUint(u64)\n\t\tcase reflect.Uint32:\n\t\t\tvar u32 uint32\n\t\t\tif u32, data, ok = parseUint32(data); !ok {\n\t\t\t\treturn errShortRead\n\t\t\t}\n\t\t\tfield.SetUint(uint64(u32))\n\t\tcase reflect.Uint8:\n\t\t\tif len(data) < 1 {\n\t\t\t\treturn errShortRead\n\t\t\t}\n\t\t\tfield.SetUint(uint64(data[0]))\n\t\t\tdata = data[1:]\n\t\tcase reflect.String:\n\t\t\tvar s []byte\n\t\t\tif s, data, ok = parseString(data); !ok {\n\t\t\t\treturn fieldError(structType, i, \"\")\n\t\t\t}\n\t\t\tfield.SetString(string(s))\n\t\tcase reflect.Slice:\n\t\t\tswitch t.Elem().Kind() {\n\t\t\tcase reflect.Uint8:\n\t\t\t\tif structType.Field(i).Tag.Get(\"ssh\") == \"rest\" {\n\t\t\t\t\tfield.Set(reflect.ValueOf(data))\n\t\t\t\t\tdata = nil\n\t\t\t\t} else {\n\t\t\t\t\tvar s []byte\n\t\t\t\t\tif s, data, ok = parseString(data); !ok {\n\t\t\t\t\t\treturn errShortRead\n\t\t\t\t\t}\n\t\t\t\t\tfield.Set(reflect.ValueOf(s))\n\t\t\t\t}\n\t\t\tcase reflect.String:\n\t\t\t\tvar nl []string\n\t\t\t\tif nl, data, ok = parseNameList(data); !ok {\n\t\t\t\t\treturn errShortRead\n\t\t\t\t}\n\t\t\t\tfield.Set(reflect.ValueOf(nl))\n\t\t\tdefault:\n\t\t\t\treturn fieldError(structType, i, \"slice of unsupported type\")\n\t\t\t}\n\t\tcase reflect.Ptr:\n\t\t\tif t == bigIntType {\n\t\t\t\tvar n *big.Int\n\t\t\t\tif n, data, ok = parseInt(data); !ok {\n\t\t\t\t\treturn errShortRead\n\t\t\t\t}\n\t\t\t\tfield.Set(reflect.ValueOf(n))\n\t\t\t} else {\n\t\t\t\treturn fieldError(structType, i, \"pointer to unsupported type\")\n\t\t\t}\n\t\tdefault:\n\t\t\treturn fieldError(structType, i, fmt.Sprintf(\"unsupported type: %v\", t))\n\t\t}\n\t}\n\n\tif len(data) != 0 {\n\t\treturn parseError(expectedType)\n\t}\n\n\treturn nil\n}\n\n// Marshal serializes the message in msg to SSH wire format. The msg\n// argument should be a struct or pointer to struct. If the first\n// member has the \"sshtype\" tag set to a number in decimal, that\n// number is prepended to the result. If the last of member has the\n// \"ssh\" tag set to \"rest\", its contents are appended to the output.\nfunc Marshal(msg interface{}) []byte {\n\tout := make([]byte, 0, 64)\n\treturn marshalStruct(out, msg)\n}\n\nfunc marshalStruct(out []byte, msg interface{}) []byte {\n\tv := reflect.Indirect(reflect.ValueOf(msg))\n\tmsgTypes := typeTags(v.Type())\n\tif len(msgTypes) > 0 {\n\t\tout = append(out, msgTypes[0])\n\t}\n\n\tfor i, n := 0, v.NumField(); i < n; i++ {\n\t\tfield := v.Field(i)\n\t\tswitch t := field.Type(); t.Kind() {\n\t\tcase reflect.Bool:\n\t\t\tvar v uint8\n\t\t\tif field.Bool() {\n\t\t\t\tv = 1\n\t\t\t}\n\t\t\tout = append(out, v)\n\t\tcase reflect.Array:\n\t\t\tif t.Elem().Kind() != reflect.Uint8 {\n\t\t\t\tpanic(fmt.Sprintf(\"array of non-uint8 in field %d: %T\", i, field.Interface()))\n\t\t\t}\n\t\t\tfor j, l := 0, t.Len(); j < l; j++ {\n\t\t\t\tout = append(out, uint8(field.Index(j).Uint()))\n\t\t\t}\n\t\tcase reflect.Uint32:\n\t\t\tout = appendU32(out, uint32(field.Uint()))\n\t\tcase reflect.Uint64:\n\t\t\tout = appendU64(out, uint64(field.Uint()))\n\t\tcase reflect.Uint8:\n\t\t\tout = append(out, uint8(field.Uint()))\n\t\tcase reflect.String:\n\t\t\ts := field.String()\n\t\t\tout = appendInt(out, len(s))\n\t\t\tout = append(out, s...)\n\t\tcase reflect.Slice:\n\t\t\tswitch t.Elem().Kind() {\n\t\t\tcase reflect.Uint8:\n\t\t\t\tif v.Type().Field(i).Tag.Get(\"ssh\") != \"rest\" {\n\t\t\t\t\tout = appendInt(out, field.Len())\n\t\t\t\t}\n\t\t\t\tout = append(out, field.Bytes()...)\n\t\t\tcase reflect.String:\n\t\t\t\toffset := len(out)\n\t\t\t\tout = appendU32(out, 0)\n\t\t\t\tif n := field.Len(); n > 0 {\n\t\t\t\t\tfor j := 0; j < n; j++ {\n\t\t\t\t\t\tf := field.Index(j)\n\t\t\t\t\t\tif j != 0 {\n\t\t\t\t\t\t\tout = append(out, ',')\n\t\t\t\t\t\t}\n\t\t\t\t\t\tout = append(out, f.String()...)\n\t\t\t\t\t}\n\t\t\t\t\t// overwrite length value\n\t\t\t\t\tbinary.BigEndian.PutUint32(out[offset:], uint32(len(out)-offset-4))\n\t\t\t\t}\n\t\t\tdefault:\n\t\t\t\tpanic(fmt.Sprintf(\"slice of unknown type in field %d: %T\", i, field.Interface()))\n\t\t\t}\n\t\tcase reflect.Ptr:\n\t\t\tif t == bigIntType {\n\t\t\t\tvar n *big.Int\n\t\t\t\tnValue := reflect.ValueOf(&n)\n\t\t\t\tnValue.Elem().Set(field)\n\t\t\t\tneeded := intLength(n)\n\t\t\t\toldLength := len(out)\n\n\t\t\t\tif cap(out)-len(out) < needed {\n\t\t\t\t\tnewOut := make([]byte, len(out), 2*(len(out)+needed))\n\t\t\t\t\tcopy(newOut, out)\n\t\t\t\t\tout = newOut\n\t\t\t\t}\n\t\t\t\tout = out[:oldLength+needed]\n\t\t\t\tmarshalInt(out[oldLength:], n)\n\t\t\t} else {\n\t\t\t\tpanic(fmt.Sprintf(\"pointer to unknown type in field %d: %T\", i, field.Interface()))\n\t\t\t}\n\t\t}\n\t}\n\n\treturn out\n}\n\nvar bigOne = big.NewInt(1)\n\nfunc parseString(in []byte) (out, rest []byte, ok bool) {\n\tif len(in) < 4 {\n\t\treturn\n\t}\n\tlength := binary.BigEndian.Uint32(in)\n\tin = in[4:]\n\tif uint32(len(in)) < length {\n\t\treturn\n\t}\n\tout = in[:length]\n\trest = in[length:]\n\tok = true\n\treturn\n}\n\nvar (\n\tcomma = []byte{','}\n\temptyNameList = []string{}\n)\n\nfunc parseNameList(in []byte) (out []string, rest []byte, ok bool) {\n\tcontents, rest, ok := parseString(in)\n\tif !ok {\n\t\treturn\n\t}\n\tif len(contents) == 0 {\n\t\tout = emptyNameList\n\t\treturn\n\t}\n\tparts := bytes.Split(contents, comma)\n\tout = make([]string, len(parts))\n\tfor i, part := range parts {\n\t\tout[i] = string(part)\n\t}\n\treturn\n}\n\nfunc parseInt(in []byte) (out *big.Int, rest []byte, ok bool) {\n\tcontents, rest, ok := parseString(in)\n\tif !ok {\n\t\treturn\n\t}\n\tout = new(big.Int)\n\n\tif len(contents) > 0 && contents[0]&0x80 == 0x80 {\n\t\t// This is a negative number\n\t\tnotBytes := make([]byte, len(contents))\n\t\tfor i := range notBytes {\n\t\t\tnotBytes[i] = ^contents[i]\n\t\t}\n\t\tout.SetBytes(notBytes)\n\t\tout.Add(out, bigOne)\n\t\tout.Neg(out)\n\t} else {\n\t\t// Positive number\n\t\tout.SetBytes(contents)\n\t}\n\tok = true\n\treturn\n}\n\nfunc parseUint32(in []byte) (uint32, []byte, bool) {\n\tif len(in) < 4 {\n\t\treturn 0, nil, false\n\t}\n\treturn binary.BigEndian.Uint32(in), in[4:], true\n}\n\nfunc parseUint64(in []byte) (uint64, []byte, bool) {\n\tif len(in) < 8 {\n\t\treturn 0, nil, false\n\t}\n\treturn binary.BigEndian.Uint64(in), in[8:], true\n}\n\nfunc intLength(n *big.Int) int {\n\tlength := 4 /* length bytes */\n\tif n.Sign() < 0 {\n\t\tnMinus1 := new(big.Int).Neg(n)\n\t\tnMinus1.Sub(nMinus1, bigOne)\n\t\tbitLen := nMinus1.BitLen()\n\t\tif bitLen%8 == 0 {\n\t\t\t// The number will need 0xff padding\n\t\t\tlength++\n\t\t}\n\t\tlength += (bitLen + 7) / 8\n\t} else if n.Sign() == 0 {\n\t\t// A zero is the zero length string\n\t} else {\n\t\tbitLen := n.BitLen()\n\t\tif bitLen%8 == 0 {\n\t\t\t// The number will need 0x00 padding\n\t\t\tlength++\n\t\t}\n\t\tlength += (bitLen + 7) / 8\n\t}\n\n\treturn length\n}\n\nfunc marshalUint32(to []byte, n uint32) []byte {\n\tbinary.BigEndian.PutUint32(to, n)\n\treturn to[4:]\n}\n\nfunc marshalUint64(to []byte, n uint64) []byte {\n\tbinary.BigEndian.PutUint64(to, n)\n\treturn to[8:]\n}\n\nfunc marshalInt(to []byte, n *big.Int) []byte {\n\tlengthBytes := to\n\tto = to[4:]\n\tlength := 0\n\n\tif n.Sign() < 0 {\n\t\t// A negative number has to be converted to two's-complement\n\t\t// form. So we'll subtract 1 and invert. If the\n\t\t// most-significant-bit isn't set then we'll need to pad the\n\t\t// beginning with 0xff in order to keep the number negative.\n\t\tnMinus1 := new(big.Int).Neg(n)\n\t\tnMinus1.Sub(nMinus1, bigOne)\n\t\tbytes := nMinus1.Bytes()\n\t\tfor i := range bytes {\n\t\t\tbytes[i] ^= 0xff\n\t\t}\n\t\tif len(bytes) == 0 || bytes[0]&0x80 == 0 {\n\t\t\tto[0] = 0xff\n\t\t\tto = to[1:]\n\t\t\tlength++\n\t\t}\n\t\tnBytes := copy(to, bytes)\n\t\tto = to[nBytes:]\n\t\tlength += nBytes\n\t} else if n.Sign() == 0 {\n\t\t// A zero is the zero length string\n\t} else {\n\t\tbytes := n.Bytes()\n\t\tif len(bytes) > 0 && bytes[0]&0x80 != 0 {\n\t\t\t// We'll have to pad this with a 0x00 in order to\n\t\t\t// stop it looking like a negative number.\n\t\t\tto[0] = 0\n\t\t\tto = to[1:]\n\t\t\tlength++\n\t\t}\n\t\tnBytes := copy(to, bytes)\n\t\tto = to[nBytes:]\n\t\tlength += nBytes\n\t}\n\n\tlengthBytes[0] = byte(length >> 24)\n\tlengthBytes[1] = byte(length >> 16)\n\tlengthBytes[2] = byte(length >> 8)\n\tlengthBytes[3] = byte(length)\n\treturn to\n}\n\nfunc writeInt(w io.Writer, n *big.Int) {\n\tlength := intLength(n)\n\tbuf := make([]byte, length)\n\tmarshalInt(buf, n)\n\tw.Write(buf)\n}\n\nfunc writeString(w io.Writer, s []byte) {\n\tvar lengthBytes [4]byte\n\tlengthBytes[0] = byte(len(s) >> 24)\n\tlengthBytes[1] = byte(len(s) >> 16)\n\tlengthBytes[2] = byte(len(s) >> 8)\n\tlengthBytes[3] = byte(len(s))\n\tw.Write(lengthBytes[:])\n\tw.Write(s)\n}\n\nfunc stringLength(n int) int {\n\treturn 4 + n\n}\n\nfunc marshalString(to []byte, s []byte) []byte {\n\tto[0] = byte(len(s) >> 24)\n\tto[1] = byte(len(s) >> 16)\n\tto[2] = byte(len(s) >> 8)\n\tto[3] = byte(len(s))\n\tto = to[4:]\n\tcopy(to, s)\n\treturn to[len(s):]\n}\n\nvar bigIntType = reflect.TypeFor[*big.Int]()\n\n// Decode a packet into its corresponding message.\nfunc decode(packet []byte) (interface{}, error) {\n\tvar msg interface{}\n\tswitch packet[0] {\n\tcase msgDisconnect:\n\t\tmsg = new(disconnectMsg)\n\tcase msgServiceRequest:\n\t\tmsg = new(serviceRequestMsg)\n\tcase msgServiceAccept:\n\t\tmsg = new(serviceAcceptMsg)\n\tcase msgExtInfo:\n\t\tmsg = new(extInfoMsg)\n\tcase msgKexInit:\n\t\tmsg = new(kexInitMsg)\n\tcase msgKexDHInit:\n\t\tmsg = new(kexDHInitMsg)\n\tcase msgKexDHReply:\n\t\tmsg = new(kexDHReplyMsg)\n\tcase msgUserAuthRequest:\n\t\tmsg = new(userAuthRequestMsg)\n\tcase msgUserAuthSuccess:\n\t\treturn new(userAuthSuccessMsg), nil\n\tcase msgUserAuthFailure:\n\t\tmsg = new(userAuthFailureMsg)\n\tcase msgUserAuthBanner:\n\t\tmsg = new(userAuthBannerMsg)\n\tcase msgUserAuthPubKeyOk:\n\t\tmsg = new(userAuthPubKeyOkMsg)\n\tcase msgGlobalRequest:\n\t\tmsg = new(globalRequestMsg)\n\tcase msgRequestSuccess:\n\t\tmsg = new(globalRequestSuccessMsg)\n\tcase msgRequestFailure:\n\t\tmsg = new(globalRequestFailureMsg)\n\tcase msgChannelOpen:\n\t\tmsg = new(channelOpenMsg)\n\tcase msgChannelData:\n\t\tmsg = new(channelDataMsg)\n\tcase msgChannelOpenConfirm:\n\t\tmsg = new(channelOpenConfirmMsg)\n\tcase msgChannelOpenFailure:\n\t\tmsg = new(channelOpenFailureMsg)\n\tcase msgChannelWindowAdjust:\n\t\tmsg = new(windowAdjustMsg)\n\tcase msgChannelEOF:\n\t\tmsg = new(channelEOFMsg)\n\tcase msgChannelClose:\n\t\tmsg = new(channelCloseMsg)\n\tcase msgChannelRequest:\n\t\tmsg = new(channelRequestMsg)\n\tcase msgChannelSuccess:\n\t\tmsg = new(channelRequestSuccessMsg)\n\tcase msgChannelFailure:\n\t\tmsg = new(channelRequestFailureMsg)\n\tcase msgUserAuthGSSAPIToken:\n\t\tmsg = new(userAuthGSSAPIToken)\n\tcase msgUserAuthGSSAPIMIC:\n\t\tmsg = new(userAuthGSSAPIMIC)\n\tcase msgUserAuthGSSAPIErrTok:\n\t\tmsg = new(userAuthGSSAPIErrTok)\n\tcase msgUserAuthGSSAPIError:\n\t\tmsg = new(userAuthGSSAPIError)\n\tdefault:\n\t\treturn nil, unexpectedMessageError(0, packet[0])\n\t}\n\tif err := Unmarshal(packet, msg); err != nil {\n\t\treturn nil, err\n\t}\n\treturn msg, nil\n}\n\nvar packetTypeNames = map[byte]string{\n\tmsgDisconnect: \"disconnectMsg\",\n\tmsgServiceRequest: \"serviceRequestMsg\",\n\tmsgServiceAccept: \"serviceAcceptMsg\",\n\tmsgExtInfo: \"extInfoMsg\",\n\tmsgKexInit: \"kexInitMsg\",\n\tmsgKexDHInit: \"kexDHInitMsg\",\n\tmsgKexDHReply: \"kexDHReplyMsg\",\n\tmsgUserAuthRequest: \"userAuthRequestMsg\",\n\tmsgUserAuthSuccess: \"userAuthSuccessMsg\",\n\tmsgUserAuthFailure: \"userAuthFailureMsg\",\n\tmsgUserAuthPubKeyOk: \"userAuthPubKeyOkMsg\",\n\tmsgGlobalRequest: \"globalRequestMsg\",\n\tmsgRequestSuccess: \"globalRequestSuccessMsg\",\n\tmsgRequestFailure: \"globalRequestFailureMsg\",\n\tmsgChannelOpen: \"channelOpenMsg\",\n\tmsgChannelData: \"channelDataMsg\",\n\tmsgChannelOpenConfirm: \"channelOpenConfirmMsg\",\n\tmsgChannelOpenFailure: \"channelOpenFailureMsg\",\n\tmsgChannelWindowAdjust: \"windowAdjustMsg\",\n\tmsgChannelEOF: \"channelEOFMsg\",\n\tmsgChannelClose: \"channelCloseMsg\",\n\tmsgChannelRequest: \"channelRequestMsg\",\n\tmsgChannelSuccess: \"channelRequestSuccessMsg\",\n\tmsgChannelFailure: \"channelRequestFailureMsg\",\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/mlkem.go",
"content": "// Copyright 2024 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"crypto\"\n\t\"crypto/mlkem\"\n\t\"crypto/sha256\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\n\t\"golang.org/x/crypto/curve25519\"\n)\n\n// mlkem768WithCurve25519sha256 implements the hybrid ML-KEM768 with\n// curve25519-sha256 key exchange method, as described by\n// draft-kampanakis-curdle-ssh-pq-ke-05 section 2.3.3.\ntype mlkem768WithCurve25519sha256 struct{}\n\nfunc (kex *mlkem768WithCurve25519sha256) Client(c packetConn, rand io.Reader, magics *handshakeMagics) (*kexResult, error) {\n\tvar c25519kp curve25519KeyPair\n\tif err := c25519kp.generate(rand); err != nil {\n\t\treturn nil, err\n\t}\n\n\tseed := make([]byte, mlkem.SeedSize)\n\tif _, err := io.ReadFull(rand, seed); err != nil {\n\t\treturn nil, err\n\t}\n\n\tmlkemDk, err := mlkem.NewDecapsulationKey768(seed)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\thybridKey := append(mlkemDk.EncapsulationKey().Bytes(), c25519kp.pub[:]...)\n\tif err := c.writePacket(Marshal(&kexECDHInitMsg{hybridKey})); err != nil {\n\t\treturn nil, err\n\t}\n\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar reply kexECDHReplyMsg\n\tif err = Unmarshal(packet, &reply); err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(reply.EphemeralPubKey) != mlkem.CiphertextSize768+32 {\n\t\treturn nil, errors.New(\"ssh: peer's mlkem768x25519 public value has wrong length\")\n\t}\n\n\t// Perform KEM decapsulate operation to obtain shared key from ML-KEM.\n\tmlkem768Secret, err := mlkemDk.Decapsulate(reply.EphemeralPubKey[:mlkem.CiphertextSize768])\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\t// Complete Curve25519 ECDH to obtain its shared key.\n\tc25519Secret, err := curve25519.X25519(c25519kp.priv[:], reply.EphemeralPubKey[mlkem.CiphertextSize768:])\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"ssh: peer's mlkem768x25519 public value is not valid: %w\", err)\n\t}\n\t// Compute actual shared key.\n\th := sha256.New()\n\th.Write(mlkem768Secret)\n\th.Write(c25519Secret)\n\tsecret := h.Sum(nil)\n\n\th.Reset()\n\tmagics.write(h)\n\twriteString(h, reply.HostKey)\n\twriteString(h, hybridKey)\n\twriteString(h, reply.EphemeralPubKey)\n\n\tK := make([]byte, stringLength(len(secret)))\n\tmarshalString(K, secret)\n\th.Write(K)\n\n\treturn &kexResult{\n\t\tH: h.Sum(nil),\n\t\tK: K,\n\t\tHostKey: reply.HostKey,\n\t\tSignature: reply.Signature,\n\t\tHash: crypto.SHA256,\n\t}, nil\n}\n\nfunc (kex *mlkem768WithCurve25519sha256) Server(c packetConn, rand io.Reader, magics *handshakeMagics, priv AlgorithmSigner, algo string) (*kexResult, error) {\n\tpacket, err := c.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar kexInit kexECDHInitMsg\n\tif err = Unmarshal(packet, &kexInit); err != nil {\n\t\treturn nil, err\n\t}\n\n\tif len(kexInit.ClientPubKey) != mlkem.EncapsulationKeySize768+32 {\n\t\treturn nil, errors.New(\"ssh: peer's ML-KEM768/curve25519 public value has wrong length\")\n\t}\n\n\tencapsulationKey, err := mlkem.NewEncapsulationKey768(kexInit.ClientPubKey[:mlkem.EncapsulationKeySize768])\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"ssh: peer's ML-KEM768 encapsulation key is not valid: %w\", err)\n\t}\n\t// Perform KEM encapsulate operation to obtain ciphertext and shared key.\n\tmlkem768Secret, mlkem768Ciphertext := encapsulationKey.Encapsulate()\n\n\t// Perform server side of Curve25519 ECDH to obtain server public value and\n\t// shared key.\n\tvar c25519kp curve25519KeyPair\n\tif err := c25519kp.generate(rand); err != nil {\n\t\treturn nil, err\n\t}\n\tc25519Secret, err := curve25519.X25519(c25519kp.priv[:], kexInit.ClientPubKey[mlkem.EncapsulationKeySize768:])\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"ssh: peer's ML-KEM768/curve25519 public value is not valid: %w\", err)\n\t}\n\thybridKey := append(mlkem768Ciphertext, c25519kp.pub[:]...)\n\n\t// Compute actual shared key.\n\th := sha256.New()\n\th.Write(mlkem768Secret)\n\th.Write(c25519Secret)\n\tsecret := h.Sum(nil)\n\n\thostKeyBytes := priv.PublicKey().Marshal()\n\n\th.Reset()\n\tmagics.write(h)\n\twriteString(h, hostKeyBytes)\n\twriteString(h, kexInit.ClientPubKey)\n\twriteString(h, hybridKey)\n\n\tK := make([]byte, stringLength(len(secret)))\n\tmarshalString(K, secret)\n\th.Write(K)\n\n\tH := h.Sum(nil)\n\n\tsig, err := signAndMarshal(priv, rand, H, algo)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treply := kexECDHReplyMsg{\n\t\tEphemeralPubKey: hybridKey,\n\t\tHostKey: hostKeyBytes,\n\t\tSignature: sig,\n\t}\n\tif err := c.writePacket(Marshal(&reply)); err != nil {\n\t\treturn nil, err\n\t}\n\treturn &kexResult{\n\t\tH: H,\n\t\tK: K,\n\t\tHostKey: hostKeyBytes,\n\t\tSignature: sig,\n\t\tHash: crypto.SHA256,\n\t}, nil\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/mux.go",
"content": "// Copyright 2013 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"encoding/binary\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n\t\"sync\"\n\t\"sync/atomic\"\n)\n\n// debugMux, if set, causes messages in the connection protocol to be\n// logged.\nconst debugMux = false\n\n// chanList is a thread safe channel list.\ntype chanList struct {\n\t// protects concurrent access to chans\n\tsync.Mutex\n\n\t// chans are indexed by the local id of the channel, which the\n\t// other side should send in the PeersId field.\n\tchans []*channel\n\n\t// This is a debugging aid: it offsets all IDs by this\n\t// amount. This helps distinguish otherwise identical\n\t// server/client muxes\n\toffset uint32\n}\n\n// Assigns a channel ID to the given channel.\nfunc (c *chanList) add(ch *channel) uint32 {\n\tc.Lock()\n\tdefer c.Unlock()\n\tfor i := range c.chans {\n\t\tif c.chans[i] == nil {\n\t\t\tc.chans[i] = ch\n\t\t\treturn uint32(i) + c.offset\n\t\t}\n\t}\n\tc.chans = append(c.chans, ch)\n\treturn uint32(len(c.chans)-1) + c.offset\n}\n\n// getChan returns the channel for the given ID.\nfunc (c *chanList) getChan(id uint32) *channel {\n\tid -= c.offset\n\n\tc.Lock()\n\tdefer c.Unlock()\n\tif id < uint32(len(c.chans)) {\n\t\treturn c.chans[id]\n\t}\n\treturn nil\n}\n\nfunc (c *chanList) remove(id uint32) {\n\tid -= c.offset\n\tc.Lock()\n\tif id < uint32(len(c.chans)) {\n\t\tc.chans[id] = nil\n\t}\n\tc.Unlock()\n}\n\n// dropAll forgets all channels it knows, returning them in a slice.\nfunc (c *chanList) dropAll() []*channel {\n\tc.Lock()\n\tdefer c.Unlock()\n\tvar r []*channel\n\n\tfor _, ch := range c.chans {\n\t\tif ch == nil {\n\t\t\tcontinue\n\t\t}\n\t\tr = append(r, ch)\n\t}\n\tc.chans = nil\n\treturn r\n}\n\n// mux represents the state for the SSH connection protocol, which\n// multiplexes many channels onto a single packet transport.\ntype mux struct {\n\tconn packetConn\n\tchanList chanList\n\n\tincomingChannels chan NewChannel\n\n\tglobalSentMu sync.Mutex\n\tglobalResponses chan interface{}\n\tincomingRequests chan *Request\n\n\terrCond *sync.Cond\n\terr error\n}\n\n// When debugging, each new chanList instantiation has a different\n// offset.\nvar globalOff uint32\n\nfunc (m *mux) Wait() error {\n\tm.errCond.L.Lock()\n\tdefer m.errCond.L.Unlock()\n\tfor m.err == nil {\n\t\tm.errCond.Wait()\n\t}\n\treturn m.err\n}\n\n// newMux returns a mux that runs over the given connection.\nfunc newMux(p packetConn) *mux {\n\tm := &mux{\n\t\tconn: p,\n\t\tincomingChannels: make(chan NewChannel, chanSize),\n\t\tglobalResponses: make(chan interface{}, 1),\n\t\tincomingRequests: make(chan *Request, chanSize),\n\t\terrCond: newCond(),\n\t}\n\tif debugMux {\n\t\tm.chanList.offset = atomic.AddUint32(&globalOff, 1)\n\t}\n\n\tgo m.loop()\n\treturn m\n}\n\nfunc (m *mux) sendMessage(msg interface{}) error {\n\tp := Marshal(msg)\n\tif debugMux {\n\t\tlog.Printf(\"send global(%d): %#v\", m.chanList.offset, msg)\n\t}\n\treturn m.conn.writePacket(p)\n}\n\nfunc (m *mux) SendRequest(name string, wantReply bool, payload []byte) (bool, []byte, error) {\n\tif wantReply {\n\t\tm.globalSentMu.Lock()\n\t\tdefer m.globalSentMu.Unlock()\n\t}\n\n\tif err := m.sendMessage(globalRequestMsg{\n\t\tType: name,\n\t\tWantReply: wantReply,\n\t\tData: payload,\n\t}); err != nil {\n\t\treturn false, nil, err\n\t}\n\n\tif !wantReply {\n\t\treturn false, nil, nil\n\t}\n\n\tmsg, ok := <-m.globalResponses\n\tif !ok {\n\t\treturn false, nil, io.EOF\n\t}\n\tswitch msg := msg.(type) {\n\tcase *globalRequestFailureMsg:\n\t\treturn false, msg.Data, nil\n\tcase *globalRequestSuccessMsg:\n\t\treturn true, msg.Data, nil\n\tdefault:\n\t\treturn false, nil, fmt.Errorf(\"ssh: unexpected response to request: %#v\", msg)\n\t}\n}\n\n// ackRequest must be called after processing a global request that\n// has WantReply set.\nfunc (m *mux) ackRequest(ok bool, data []byte) error {\n\tif ok {\n\t\treturn m.sendMessage(globalRequestSuccessMsg{Data: data})\n\t}\n\treturn m.sendMessage(globalRequestFailureMsg{Data: data})\n}\n\nfunc (m *mux) Close() error {\n\treturn m.conn.Close()\n}\n\n// loop runs the connection machine. It will process packets until an\n// error is encountered. To synchronize on loop exit, use mux.Wait.\nfunc (m *mux) loop() {\n\tvar err error\n\tfor err == nil {\n\t\terr = m.onePacket()\n\t}\n\n\tfor _, ch := range m.chanList.dropAll() {\n\t\tch.close()\n\t}\n\n\tclose(m.incomingChannels)\n\tclose(m.incomingRequests)\n\tclose(m.globalResponses)\n\n\tm.conn.Close()\n\n\tm.errCond.L.Lock()\n\tm.err = err\n\tm.errCond.Broadcast()\n\tm.errCond.L.Unlock()\n\n\tif debugMux {\n\t\tlog.Println(\"loop exit\", err)\n\t}\n}\n\n// onePacket reads and processes one packet.\nfunc (m *mux) onePacket() error {\n\tpacket, err := m.conn.readPacket()\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tif debugMux {\n\t\tif packet[0] == msgChannelData || packet[0] == msgChannelExtendedData {\n\t\t\tlog.Printf(\"decoding(%d): data packet - %d bytes\", m.chanList.offset, len(packet))\n\t\t} else {\n\t\t\tp, _ := decode(packet)\n\t\t\tlog.Printf(\"decoding(%d): %d %#v - %d bytes\", m.chanList.offset, packet[0], p, len(packet))\n\t\t}\n\t}\n\n\tswitch packet[0] {\n\tcase msgChannelOpen:\n\t\treturn m.handleChannelOpen(packet)\n\tcase msgGlobalRequest, msgRequestSuccess, msgRequestFailure:\n\t\treturn m.handleGlobalPacket(packet)\n\tcase msgPing:\n\t\tvar msg pingMsg\n\t\tif err := Unmarshal(packet, &msg); err != nil {\n\t\t\treturn fmt.Errorf(\"failed to unmarshal ping@openssh.com message: %w\", err)\n\t\t}\n\t\treturn m.sendMessage(pongMsg(msg))\n\t}\n\n\t// assume a channel packet.\n\tif len(packet) < 5 {\n\t\treturn parseError(packet[0])\n\t}\n\tid := binary.BigEndian.Uint32(packet[1:])\n\tch := m.chanList.getChan(id)\n\tif ch == nil {\n\t\treturn m.handleUnknownChannelPacket(id, packet)\n\t}\n\n\treturn ch.handlePacket(packet)\n}\n\nfunc (m *mux) handleGlobalPacket(packet []byte) error {\n\tmsg, err := decode(packet)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tswitch msg := msg.(type) {\n\tcase *globalRequestMsg:\n\t\tm.incomingRequests <- &Request{\n\t\t\tType: msg.Type,\n\t\t\tWantReply: msg.WantReply,\n\t\t\tPayload: msg.Data,\n\t\t\tmux: m,\n\t\t}\n\tcase *globalRequestSuccessMsg, *globalRequestFailureMsg:\n\t\tm.globalResponses <- msg\n\tdefault:\n\t\tpanic(fmt.Sprintf(\"not a global message %#v\", msg))\n\t}\n\n\treturn nil\n}\n\n// handleChannelOpen schedules a channel to be Accept()ed.\nfunc (m *mux) handleChannelOpen(packet []byte) error {\n\tvar msg channelOpenMsg\n\tif err := Unmarshal(packet, &msg); err != nil {\n\t\treturn err\n\t}\n\n\tif msg.MaxPacketSize < minPacketLength || msg.MaxPacketSize > 1<<31 {\n\t\tfailMsg := channelOpenFailureMsg{\n\t\t\tPeersID: msg.PeersID,\n\t\t\tReason: ConnectionFailed,\n\t\t\tMessage: \"invalid request\",\n\t\t\tLanguage: \"en_US.UTF-8\",\n\t\t}\n\t\treturn m.sendMessage(failMsg)\n\t}\n\n\tc := m.newChannel(msg.ChanType, channelInbound, msg.TypeSpecificData)\n\tc.remoteId = msg.PeersID\n\tc.maxRemotePayload = msg.MaxPacketSize\n\tc.remoteWin.add(msg.PeersWindow)\n\tm.incomingChannels <- c\n\treturn nil\n}\n\nfunc (m *mux) OpenChannel(chanType string, extra []byte) (Channel, <-chan *Request, error) {\n\tch, err := m.openChannel(chanType, extra)\n\tif err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\treturn ch, ch.incomingRequests, nil\n}\n\nfunc (m *mux) openChannel(chanType string, extra []byte) (*channel, error) {\n\tch := m.newChannel(chanType, channelOutbound, extra)\n\n\tch.maxIncomingPayload = channelMaxPacket\n\n\topen := channelOpenMsg{\n\t\tChanType: chanType,\n\t\tPeersWindow: ch.myWindow,\n\t\tMaxPacketSize: ch.maxIncomingPayload,\n\t\tTypeSpecificData: extra,\n\t\tPeersID: ch.localId,\n\t}\n\tif err := m.sendMessage(open); err != nil {\n\t\treturn nil, err\n\t}\n\n\tswitch msg := (<-ch.msg).(type) {\n\tcase *channelOpenConfirmMsg:\n\t\treturn ch, nil\n\tcase *channelOpenFailureMsg:\n\t\treturn nil, &OpenChannelError{msg.Reason, msg.Message}\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"ssh: unexpected packet in response to channel open: %T\", msg)\n\t}\n}\n\nfunc (m *mux) handleUnknownChannelPacket(id uint32, packet []byte) error {\n\tmsg, err := decode(packet)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tswitch msg := msg.(type) {\n\t// RFC 4254 section 5.4 says unrecognized channel requests should\n\t// receive a failure response.\n\tcase *channelRequestMsg:\n\t\tif msg.WantReply {\n\t\t\treturn m.sendMessage(channelRequestFailureMsg{\n\t\t\t\tPeersID: msg.PeersID,\n\t\t\t})\n\t\t}\n\t\treturn nil\n\tdefault:\n\t\treturn fmt.Errorf(\"ssh: invalid channel %d\", id)\n\t}\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/server.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net\"\n\t\"slices\"\n\t\"strings\"\n)\n\n// The Permissions type holds fine-grained permissions that are\n// specific to a user or a specific authentication method for a user.\n// The Permissions value for a successful authentication attempt is\n// available in ServerConn, so it can be used to pass information from\n// the user-authentication phase to the application layer.\ntype Permissions struct {\n\t// CriticalOptions indicate restrictions to the default\n\t// permissions, and are typically used in conjunction with\n\t// user certificates. The standard for SSH certificates\n\t// defines \"force-command\" (only allow the given command to\n\t// execute) and \"source-address\" (only allow connections from\n\t// the given address). The SSH package currently only enforces\n\t// the \"source-address\" critical option. It is up to server\n\t// implementations to enforce other critical options, such as\n\t// \"force-command\", by checking them after the SSH handshake\n\t// is successful. In general, SSH servers should reject\n\t// connections that specify critical options that are unknown\n\t// or not supported.\n\tCriticalOptions map[string]string\n\n\t// Extensions are extra functionality that the server may\n\t// offer on authenticated connections. Lack of support for an\n\t// extension does not preclude authenticating a user. Common\n\t// extensions are \"permit-agent-forwarding\",\n\t// \"permit-X11-forwarding\". The Go SSH library currently does\n\t// not act on any extension, and it is up to server\n\t// implementations to honor them. Extensions can be used to\n\t// pass data from the authentication callbacks to the server\n\t// application layer.\n\tExtensions map[string]string\n\n\t// ExtraData allows to store user defined data.\n\tExtraData map[any]any\n}\n\ntype GSSAPIWithMICConfig struct {\n\t// AllowLogin, must be set, is called when gssapi-with-mic\n\t// authentication is selected (RFC 4462 section 3). The srcName is from the\n\t// results of the GSS-API authentication. The format is username@DOMAIN.\n\t// GSSAPI just guarantees to the server who the user is, but not if they can log in, and with what permissions.\n\t// This callback is called after the user identity is established with GSSAPI to decide if the user can login with\n\t// which permissions. If the user is allowed to login, it should return a nil error.\n\tAllowLogin func(conn ConnMetadata, srcName string) (*Permissions, error)\n\n\t// Server must be set. It's the implementation\n\t// of the GSSAPIServer interface. See GSSAPIServer interface for details.\n\tServer GSSAPIServer\n}\n\n// SendAuthBanner implements [ServerPreAuthConn].\nfunc (s *connection) SendAuthBanner(msg string) error {\n\treturn s.transport.writePacket(Marshal(&userAuthBannerMsg{\n\t\tMessage: msg,\n\t}))\n}\n\nfunc (*connection) unexportedMethodForFutureProofing() {}\n\n// ServerPreAuthConn is the interface available on an incoming server\n// connection before authentication has completed.\ntype ServerPreAuthConn interface {\n\tunexportedMethodForFutureProofing() // permits growing ServerPreAuthConn safely later, ala testing.TB\n\n\tConnMetadata\n\n\t// SendAuthBanner sends a banner message to the client.\n\t// It returns an error once the authentication phase has ended.\n\tSendAuthBanner(string) error\n}\n\n// ServerConfig holds server specific configuration data.\ntype ServerConfig struct {\n\t// Config contains configuration shared between client and server.\n\tConfig\n\n\t// PublicKeyAuthAlgorithms specifies the supported client public key\n\t// authentication algorithms. Note that this should not include certificate\n\t// types since those use the underlying algorithm. This list is sent to the\n\t// client if it supports the server-sig-algs extension. Order is irrelevant.\n\t// If unspecified then a default set of algorithms is used.\n\tPublicKeyAuthAlgorithms []string\n\n\thostKeys []Signer\n\n\t// NoClientAuth is true if clients are allowed to connect without\n\t// authenticating.\n\t// To determine NoClientAuth at runtime, set NoClientAuth to true\n\t// and the optional NoClientAuthCallback to a non-nil value.\n\tNoClientAuth bool\n\n\t// NoClientAuthCallback, if non-nil, is called when a user\n\t// attempts to authenticate with auth method \"none\".\n\t// NoClientAuth must also be set to true for this be used, or\n\t// this func is unused.\n\tNoClientAuthCallback func(ConnMetadata) (*Permissions, error)\n\n\t// MaxAuthTries specifies the maximum number of authentication attempts\n\t// permitted per connection. If set to a negative number, the number of\n\t// attempts are unlimited. If set to zero, the number of attempts are limited\n\t// to 6.\n\tMaxAuthTries int\n\n\t// PasswordCallback, if non-nil, is called when a user\n\t// attempts to authenticate using a password.\n\tPasswordCallback func(conn ConnMetadata, password []byte) (*Permissions, error)\n\n\t// PublicKeyCallback, if non-nil, is called when a client\n\t// offers a public key for authentication. It must return a nil error\n\t// if the given public key can be used to authenticate the\n\t// given user. For example, see CertChecker.Authenticate. A\n\t// call to this function does not guarantee that the key\n\t// offered is in fact used to authenticate. To record any data\n\t// depending on the public key, store it inside a\n\t// Permissions.Extensions entry.\n\tPublicKeyCallback func(conn ConnMetadata, key PublicKey) (*Permissions, error)\n\n\t// VerifiedPublicKeyCallback, if non-nil, is called after a client\n\t// successfully confirms having control over a key that was previously\n\t// approved by PublicKeyCallback. The permissions object passed to the\n\t// callback is the one returned by PublicKeyCallback for the given public\n\t// key and its ownership is transferred to the callback. The returned\n\t// Permissions object can be the same object, optionally modified, or a\n\t// completely new object. If VerifiedPublicKeyCallback is non-nil,\n\t// PublicKeyCallback is not allowed to return a PartialSuccessError, which\n\t// can instead be returned by VerifiedPublicKeyCallback.\n\t//\n\t// VerifiedPublicKeyCallback does not affect which authentication methods\n\t// are included in the list of methods that can be attempted by the client.\n\tVerifiedPublicKeyCallback func(conn ConnMetadata, key PublicKey, permissions *Permissions,\n\t\tsignatureAlgorithm string) (*Permissions, error)\n\n\t// KeyboardInteractiveCallback, if non-nil, is called when\n\t// keyboard-interactive authentication is selected (RFC\n\t// 4256). The client object's Challenge function should be\n\t// used to query the user. The callback may offer multiple\n\t// Challenge rounds. To avoid information leaks, the client\n\t// should be presented a challenge even if the user is\n\t// unknown.\n\tKeyboardInteractiveCallback func(conn ConnMetadata, client KeyboardInteractiveChallenge) (*Permissions, error)\n\n\t// AuthLogCallback, if non-nil, is called to log all authentication\n\t// attempts.\n\tAuthLogCallback func(conn ConnMetadata, method string, err error)\n\n\t// PreAuthConnCallback, if non-nil, is called upon receiving a new connection\n\t// before any authentication has started. The provided ServerPreAuthConn\n\t// can be used at any time before authentication is complete, including\n\t// after this callback has returned.\n\tPreAuthConnCallback func(ServerPreAuthConn)\n\n\t// ServerVersion is the version identification string to announce in\n\t// the public handshake.\n\t// If empty, a reasonable default is used.\n\t// Note that RFC 4253 section 4.2 requires that this string start with\n\t// \"SSH-2.0-\".\n\tServerVersion string\n\n\t// BannerCallback, if present, is called and the return string is sent to\n\t// the client after key exchange completed but before authentication.\n\tBannerCallback func(conn ConnMetadata) string\n\n\t// GSSAPIWithMICConfig includes gssapi server and callback, which if both non-nil, is used\n\t// when gssapi-with-mic authentication is selected (RFC 4462 section 3).\n\tGSSAPIWithMICConfig *GSSAPIWithMICConfig\n}\n\n// AddHostKey adds a private key as a host key. If an existing host\n// key exists with the same public key format, it is replaced. Each server\n// config must have at least one host key.\nfunc (s *ServerConfig) AddHostKey(key Signer) {\n\tfor i, k := range s.hostKeys {\n\t\tif k.PublicKey().Type() == key.PublicKey().Type() {\n\t\t\ts.hostKeys[i] = key\n\t\t\treturn\n\t\t}\n\t}\n\n\ts.hostKeys = append(s.hostKeys, key)\n}\n\n// cachedPubKey contains the results of querying whether a public key is\n// acceptable for a user. This is a FIFO cache.\ntype cachedPubKey struct {\n\tuser string\n\tpubKeyData []byte\n\tresult error\n\tperms *Permissions\n}\n\n// maxCachedPubKeys is the number of cache entries we store.\n//\n// Due to consistent misuse of the PublicKeyCallback API, we have reduced this\n// to 1, such that the only key in the cache is the most recently seen one. This\n// forces the behavior that the last call to PublicKeyCallback will always be\n// with the key that is used for authentication.\nconst maxCachedPubKeys = 1\n\n// pubKeyCache caches tests for public keys. Since SSH clients\n// will query whether a public key is acceptable before attempting to\n// authenticate with it, we end up with duplicate queries for public\n// key validity. The cache only applies to a single ServerConn.\ntype pubKeyCache struct {\n\tkeys []cachedPubKey\n}\n\n// get returns the result for a given user/algo/key tuple.\nfunc (c *pubKeyCache) get(user string, pubKeyData []byte) (cachedPubKey, bool) {\n\tfor _, k := range c.keys {\n\t\tif k.user == user && bytes.Equal(k.pubKeyData, pubKeyData) {\n\t\t\treturn k, true\n\t\t}\n\t}\n\treturn cachedPubKey{}, false\n}\n\n// add adds the given tuple to the cache.\nfunc (c *pubKeyCache) add(candidate cachedPubKey) {\n\tif len(c.keys) >= maxCachedPubKeys {\n\t\tc.keys = c.keys[1:]\n\t}\n\tc.keys = append(c.keys, candidate)\n}\n\n// ServerConn is an authenticated SSH connection, as seen from the\n// server\ntype ServerConn struct {\n\tConn\n\n\t// If the succeeding authentication callback returned a\n\t// non-nil Permissions pointer, it is stored here.\n\tPermissions *Permissions\n}\n\n// NewServerConn starts a new SSH server with c as the underlying\n// transport. It starts with a handshake and, if the handshake is\n// unsuccessful, it closes the connection and returns an error. The\n// Request and NewChannel channels must be serviced, or the connection\n// will hang.\n//\n// The returned error may be of type *ServerAuthError for\n// authentication errors.\nfunc NewServerConn(c net.Conn, config *ServerConfig) (*ServerConn, <-chan NewChannel, <-chan *Request, error) {\n\tfullConf := *config\n\tfullConf.SetDefaults()\n\tif fullConf.MaxAuthTries == 0 {\n\t\tfullConf.MaxAuthTries = 6\n\t}\n\tif len(fullConf.PublicKeyAuthAlgorithms) == 0 {\n\t\tfullConf.PublicKeyAuthAlgorithms = defaultPubKeyAuthAlgos\n\t} else {\n\t\tfor _, algo := range fullConf.PublicKeyAuthAlgorithms {\n\t\t\tif !slices.Contains(SupportedAlgorithms().PublicKeyAuths, algo) && !slices.Contains(InsecureAlgorithms().PublicKeyAuths, algo) {\n\t\t\t\tc.Close()\n\t\t\t\treturn nil, nil, nil, fmt.Errorf(\"ssh: unsupported public key authentication algorithm %s\", algo)\n\t\t\t}\n\t\t}\n\t}\n\n\ts := &connection{\n\t\tsshConn: sshConn{conn: c},\n\t}\n\tperms, err := s.serverHandshake(&fullConf)\n\tif err != nil {\n\t\tc.Close()\n\t\treturn nil, nil, nil, err\n\t}\n\treturn &ServerConn{s, perms}, s.mux.incomingChannels, s.mux.incomingRequests, nil\n}\n\n// signAndMarshal signs the data with the appropriate algorithm,\n// and serializes the result in SSH wire format. algo is the negotiate\n// algorithm and may be a certificate type.\nfunc signAndMarshal(k AlgorithmSigner, rand io.Reader, data []byte, algo string) ([]byte, error) {\n\tsig, err := k.SignWithAlgorithm(rand, data, underlyingAlgo(algo))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn Marshal(sig), nil\n}\n\n// handshake performs key exchange and user authentication.\nfunc (s *connection) serverHandshake(config *ServerConfig) (*Permissions, error) {\n\tif len(config.hostKeys) == 0 {\n\t\treturn nil, errors.New(\"ssh: server has no host keys\")\n\t}\n\n\tif !config.NoClientAuth && config.PasswordCallback == nil && config.PublicKeyCallback == nil &&\n\t\tconfig.KeyboardInteractiveCallback == nil && (config.GSSAPIWithMICConfig == nil ||\n\t\tconfig.GSSAPIWithMICConfig.AllowLogin == nil || config.GSSAPIWithMICConfig.Server == nil) {\n\t\treturn nil, errors.New(\"ssh: no authentication methods configured but NoClientAuth is also false\")\n\t}\n\n\tif config.ServerVersion != \"\" {\n\t\ts.serverVersion = []byte(config.ServerVersion)\n\t} else {\n\t\ts.serverVersion = []byte(packageVersion)\n\t}\n\tvar err error\n\ts.clientVersion, err = exchangeVersions(s.sshConn.conn, s.serverVersion)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\ttr := newTransport(s.sshConn.conn, config.Rand, false /* not client */)\n\ts.transport = newServerTransport(tr, s.clientVersion, s.serverVersion, config)\n\n\tif err := s.transport.waitSession(); err != nil {\n\t\treturn nil, err\n\t}\n\n\t// We just did the key change, so the session ID is established.\n\ts.sessionID = s.transport.getSessionID()\n\ts.algorithms = s.transport.getAlgorithms()\n\n\tvar packet []byte\n\tif packet, err = s.transport.readPacket(); err != nil {\n\t\treturn nil, err\n\t}\n\n\tvar serviceRequest serviceRequestMsg\n\tif err = Unmarshal(packet, &serviceRequest); err != nil {\n\t\treturn nil, err\n\t}\n\tif serviceRequest.Service != serviceUserAuth {\n\t\treturn nil, errors.New(\"ssh: requested service '\" + serviceRequest.Service + \"' before authenticating\")\n\t}\n\tserviceAccept := serviceAcceptMsg{\n\t\tService: serviceUserAuth,\n\t}\n\tif err := s.transport.writePacket(Marshal(&serviceAccept)); err != nil {\n\t\treturn nil, err\n\t}\n\n\tperms, err := s.serverAuthenticate(config)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\ts.mux = newMux(s.transport)\n\treturn perms, err\n}\n\nfunc checkSourceAddress(addr net.Addr, sourceAddrs string) error {\n\tif addr == nil {\n\t\treturn errors.New(\"ssh: no address known for client, but source-address match required\")\n\t}\n\n\ttcpAddr, ok := addr.(*net.TCPAddr)\n\tif !ok {\n\t\treturn fmt.Errorf(\"ssh: remote address %v is not an TCP address when checking source-address match\", addr)\n\t}\n\n\tfor _, sourceAddr := range strings.Split(sourceAddrs, \",\") {\n\t\tif allowedIP := net.ParseIP(sourceAddr); allowedIP != nil {\n\t\t\tif allowedIP.Equal(tcpAddr.IP) {\n\t\t\t\treturn nil\n\t\t\t}\n\t\t} else {\n\t\t\t_, ipNet, err := net.ParseCIDR(sourceAddr)\n\t\t\tif err != nil {\n\t\t\t\treturn fmt.Errorf(\"ssh: error parsing source-address restriction %q: %v\", sourceAddr, err)\n\t\t\t}\n\n\t\t\tif ipNet.Contains(tcpAddr.IP) {\n\t\t\t\treturn nil\n\t\t\t}\n\t\t}\n\t}\n\n\treturn fmt.Errorf(\"ssh: remote address %v is not allowed because of source-address restriction\", addr)\n}\n\nfunc gssExchangeToken(gssapiConfig *GSSAPIWithMICConfig, token []byte, s *connection,\n\tsessionID []byte, userAuthReq userAuthRequestMsg) (authErr error, perms *Permissions, err error) {\n\tgssAPIServer := gssapiConfig.Server\n\tdefer gssAPIServer.DeleteSecContext()\n\tvar srcName string\n\tfor {\n\t\tvar (\n\t\t\toutToken []byte\n\t\t\tneedContinue bool\n\t\t)\n\t\toutToken, srcName, needContinue, err = gssAPIServer.AcceptSecContext(token)\n\t\tif err != nil {\n\t\t\treturn err, nil, nil\n\t\t}\n\t\tif len(outToken) != 0 {\n\t\t\tif err := s.transport.writePacket(Marshal(&userAuthGSSAPIToken{\n\t\t\t\tToken: outToken,\n\t\t\t})); err != nil {\n\t\t\t\treturn nil, nil, err\n\t\t\t}\n\t\t}\n\t\tif !needContinue {\n\t\t\tbreak\n\t\t}\n\t\tpacket, err := s.transport.readPacket()\n\t\tif err != nil {\n\t\t\treturn nil, nil, err\n\t\t}\n\t\tuserAuthGSSAPITokenReq := &userAuthGSSAPIToken{}\n\t\tif err := Unmarshal(packet, userAuthGSSAPITokenReq); err != nil {\n\t\t\treturn nil, nil, err\n\t\t}\n\t\ttoken = userAuthGSSAPITokenReq.Token\n\t}\n\tpacket, err := s.transport.readPacket()\n\tif err != nil {\n\t\treturn nil, nil, err\n\t}\n\tuserAuthGSSAPIMICReq := &userAuthGSSAPIMIC{}\n\tif err := Unmarshal(packet, userAuthGSSAPIMICReq); err != nil {\n\t\treturn nil, nil, err\n\t}\n\tmic := buildMIC(string(sessionID), userAuthReq.User, userAuthReq.Service, userAuthReq.Method)\n\tif err := gssAPIServer.VerifyMIC(mic, userAuthGSSAPIMICReq.MIC); err != nil {\n\t\treturn err, nil, nil\n\t}\n\tperms, authErr = gssapiConfig.AllowLogin(s, srcName)\n\treturn authErr, perms, nil\n}\n\n// isAlgoCompatible checks if the signature format is compatible with the\n// selected algorithm taking into account edge cases that occur with old\n// clients.\nfunc isAlgoCompatible(algo, sigFormat string) bool {\n\t// Compatibility for old clients.\n\t//\n\t// For certificate authentication with OpenSSH 7.2-7.7 signature format can\n\t// be rsa-sha2-256 or rsa-sha2-512 for the algorithm\n\t// ssh-rsa-cert-v01@openssh.com.\n\t//\n\t// With gpg-agent < 2.2.6 the algorithm can be rsa-sha2-256 or rsa-sha2-512\n\t// for signature format ssh-rsa.\n\tif isRSA(algo) && isRSA(sigFormat) {\n\t\treturn true\n\t}\n\t// Standard case: the underlying algorithm must match the signature format.\n\treturn underlyingAlgo(algo) == sigFormat\n}\n\n// ServerAuthError represents server authentication errors and is\n// sometimes returned by NewServerConn. It appends any authentication\n// errors that may occur, and is returned if all of the authentication\n// methods provided by the user failed to authenticate.\ntype ServerAuthError struct {\n\t// Errors contains authentication errors returned by the authentication\n\t// callback methods. The first entry is typically ErrNoAuth.\n\tErrors []error\n}\n\nfunc (l ServerAuthError) Error() string {\n\tvar errs []string\n\tfor _, err := range l.Errors {\n\t\terrs = append(errs, err.Error())\n\t}\n\treturn \"[\" + strings.Join(errs, \", \") + \"]\"\n}\n\n// ServerAuthCallbacks defines server-side authentication callbacks.\ntype ServerAuthCallbacks struct {\n\t// PasswordCallback behaves like [ServerConfig.PasswordCallback].\n\tPasswordCallback func(conn ConnMetadata, password []byte) (*Permissions, error)\n\n\t// PublicKeyCallback behaves like [ServerConfig.PublicKeyCallback].\n\tPublicKeyCallback func(conn ConnMetadata, key PublicKey) (*Permissions, error)\n\n\t// KeyboardInteractiveCallback behaves like [ServerConfig.KeyboardInteractiveCallback].\n\tKeyboardInteractiveCallback func(conn ConnMetadata, client KeyboardInteractiveChallenge) (*Permissions, error)\n\n\t// GSSAPIWithMICConfig behaves like [ServerConfig.GSSAPIWithMICConfig].\n\tGSSAPIWithMICConfig *GSSAPIWithMICConfig\n}\n\n// PartialSuccessError can be returned by any of the [ServerConfig]\n// authentication callbacks to indicate to the client that authentication has\n// partially succeeded, but further steps are required.\ntype PartialSuccessError struct {\n\t// Next defines the authentication callbacks to apply to further steps. The\n\t// available methods communicated to the client are based on the non-nil\n\t// ServerAuthCallbacks fields.\n\tNext ServerAuthCallbacks\n}\n\nfunc (p *PartialSuccessError) Error() string {\n\treturn \"ssh: authenticated with partial success\"\n}\n\n// ErrNoAuth is the error value returned if no\n// authentication method has been passed yet. This happens as a normal\n// part of the authentication loop, since the client first tries\n// 'none' authentication to discover available methods.\n// It is returned in ServerAuthError.Errors from NewServerConn.\nvar ErrNoAuth = errors.New(\"ssh: no auth passed yet\")\n\n// BannerError is an error that can be returned by authentication handlers in\n// ServerConfig to send a banner message to the client.\ntype BannerError struct {\n\tErr error\n\tMessage string\n}\n\nfunc (b *BannerError) Unwrap() error {\n\treturn b.Err\n}\n\nfunc (b *BannerError) Error() string {\n\tif b.Err == nil {\n\t\treturn b.Message\n\t}\n\treturn b.Err.Error()\n}\n\nfunc (s *connection) serverAuthenticate(config *ServerConfig) (*Permissions, error) {\n\tif config.PreAuthConnCallback != nil {\n\t\tconfig.PreAuthConnCallback(s)\n\t}\n\n\tsessionID := s.transport.getSessionID()\n\tvar cache pubKeyCache\n\tvar perms *Permissions\n\n\tauthFailures := 0\n\tnoneAuthCount := 0\n\tvar authErrs []error\n\tvar calledBannerCallback bool\n\tpartialSuccessReturned := false\n\t// Set the initial authentication callbacks from the config. They can be\n\t// changed if a PartialSuccessError is returned.\n\tauthConfig := ServerAuthCallbacks{\n\t\tPasswordCallback: config.PasswordCallback,\n\t\tPublicKeyCallback: config.PublicKeyCallback,\n\t\tKeyboardInteractiveCallback: config.KeyboardInteractiveCallback,\n\t\tGSSAPIWithMICConfig: config.GSSAPIWithMICConfig,\n\t}\n\nuserAuthLoop:\n\tfor {\n\t\tif authFailures >= config.MaxAuthTries && config.MaxAuthTries > 0 {\n\t\t\tdiscMsg := &disconnectMsg{\n\t\t\t\tReason: 2,\n\t\t\t\tMessage: \"too many authentication failures\",\n\t\t\t}\n\n\t\t\tif err := s.transport.writePacket(Marshal(discMsg)); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tauthErrs = append(authErrs, discMsg)\n\t\t\treturn nil, &ServerAuthError{Errors: authErrs}\n\t\t}\n\n\t\tvar userAuthReq userAuthRequestMsg\n\t\tif packet, err := s.transport.readPacket(); err != nil {\n\t\t\tif err == io.EOF {\n\t\t\t\treturn nil, &ServerAuthError{Errors: authErrs}\n\t\t\t}\n\t\t\treturn nil, err\n\t\t} else if err = Unmarshal(packet, &userAuthReq); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\tif userAuthReq.Service != serviceSSH {\n\t\t\treturn nil, errors.New(\"ssh: client attempted to negotiate for unknown service: \" + userAuthReq.Service)\n\t\t}\n\n\t\tif s.user != userAuthReq.User && partialSuccessReturned {\n\t\t\treturn nil, fmt.Errorf(\"ssh: client changed the user after a partial success authentication, previous user %q, current user %q\",\n\t\t\t\ts.user, userAuthReq.User)\n\t\t}\n\n\t\ts.user = userAuthReq.User\n\n\t\tif !calledBannerCallback && config.BannerCallback != nil {\n\t\t\tcalledBannerCallback = true\n\t\t\tif msg := config.BannerCallback(s); msg != \"\" {\n\t\t\t\tif err := s.SendAuthBanner(msg); err != nil {\n\t\t\t\t\treturn nil, err\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tperms = nil\n\t\tauthErr := ErrNoAuth\n\n\t\tswitch userAuthReq.Method {\n\t\tcase \"none\":\n\t\t\tnoneAuthCount++\n\t\t\t// We don't allow none authentication after a partial success\n\t\t\t// response.\n\t\t\tif config.NoClientAuth && !partialSuccessReturned {\n\t\t\t\tif config.NoClientAuthCallback != nil {\n\t\t\t\t\tperms, authErr = config.NoClientAuthCallback(s)\n\t\t\t\t} else {\n\t\t\t\t\tauthErr = nil\n\t\t\t\t}\n\t\t\t}\n\t\tcase \"password\":\n\t\t\tif authConfig.PasswordCallback == nil {\n\t\t\t\tauthErr = errors.New(\"ssh: password auth not configured\")\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tpayload := userAuthReq.Payload\n\t\t\tif len(payload) < 1 || payload[0] != 0 {\n\t\t\t\treturn nil, parseError(msgUserAuthRequest)\n\t\t\t}\n\t\t\tpayload = payload[1:]\n\t\t\tpassword, payload, ok := parseString(payload)\n\t\t\tif !ok || len(payload) > 0 {\n\t\t\t\treturn nil, parseError(msgUserAuthRequest)\n\t\t\t}\n\n\t\t\tperms, authErr = authConfig.PasswordCallback(s, password)\n\t\tcase \"keyboard-interactive\":\n\t\t\tif authConfig.KeyboardInteractiveCallback == nil {\n\t\t\t\tauthErr = errors.New(\"ssh: keyboard-interactive auth not configured\")\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\tprompter := &sshClientKeyboardInteractive{s}\n\t\t\tperms, authErr = authConfig.KeyboardInteractiveCallback(s, prompter.Challenge)\n\t\tcase \"publickey\":\n\t\t\tif authConfig.PublicKeyCallback == nil {\n\t\t\t\tauthErr = errors.New(\"ssh: publickey auth not configured\")\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tpayload := userAuthReq.Payload\n\t\t\tif len(payload) < 1 {\n\t\t\t\treturn nil, parseError(msgUserAuthRequest)\n\t\t\t}\n\t\t\tisQuery := payload[0] == 0\n\t\t\tpayload = payload[1:]\n\t\t\talgoBytes, payload, ok := parseString(payload)\n\t\t\tif !ok {\n\t\t\t\treturn nil, parseError(msgUserAuthRequest)\n\t\t\t}\n\t\t\talgo := string(algoBytes)\n\t\t\tif !slices.Contains(config.PublicKeyAuthAlgorithms, underlyingAlgo(algo)) {\n\t\t\t\tauthErr = fmt.Errorf(\"ssh: algorithm %q not accepted\", algo)\n\t\t\t\tbreak\n\t\t\t}\n\n\t\t\tpubKeyData, payload, ok := parseString(payload)\n\t\t\tif !ok {\n\t\t\t\treturn nil, parseError(msgUserAuthRequest)\n\t\t\t}\n\n\t\t\tpubKey, err := ParsePublicKey(pubKeyData)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\n\t\t\tcandidate, ok := cache.get(s.user, pubKeyData)\n\t\t\tif !ok {\n\t\t\t\tcandidate.user = s.user\n\t\t\t\tcandidate.pubKeyData = pubKeyData\n\t\t\t\tcandidate.perms, candidate.result = authConfig.PublicKeyCallback(s, pubKey)\n\t\t\t\t_, isPartialSuccessError := candidate.result.(*PartialSuccessError)\n\t\t\t\tif isPartialSuccessError && config.VerifiedPublicKeyCallback != nil {\n\t\t\t\t\treturn nil, errors.New(\"ssh: invalid library usage: PublicKeyCallback must not return partial success when VerifiedPublicKeyCallback is defined\")\n\t\t\t\t}\n\n\t\t\t\tif (candidate.result == nil || isPartialSuccessError) &&\n\t\t\t\t\tcandidate.perms != nil &&\n\t\t\t\t\tcandidate.perms.CriticalOptions != nil &&\n\t\t\t\t\tcandidate.perms.CriticalOptions[sourceAddressCriticalOption] != \"\" {\n\t\t\t\t\tif err := checkSourceAddress(\n\t\t\t\t\t\ts.RemoteAddr(),\n\t\t\t\t\t\tcandidate.perms.CriticalOptions[sourceAddressCriticalOption]); err != nil {\n\t\t\t\t\t\tcandidate.result = err\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tcache.add(candidate)\n\t\t\t}\n\n\t\t\tif isQuery {\n\t\t\t\t// The client can query if the given public key\n\t\t\t\t// would be okay.\n\n\t\t\t\tif len(payload) > 0 {\n\t\t\t\t\treturn nil, parseError(msgUserAuthRequest)\n\t\t\t\t}\n\t\t\t\t_, isPartialSuccessError := candidate.result.(*PartialSuccessError)\n\t\t\t\tif candidate.result == nil || isPartialSuccessError {\n\t\t\t\t\tokMsg := userAuthPubKeyOkMsg{\n\t\t\t\t\t\tAlgo: algo,\n\t\t\t\t\t\tPubKey: pubKeyData,\n\t\t\t\t\t}\n\t\t\t\t\tif err = s.transport.writePacket(Marshal(&okMsg)); err != nil {\n\t\t\t\t\t\treturn nil, err\n\t\t\t\t\t}\n\t\t\t\t\tcontinue userAuthLoop\n\t\t\t\t}\n\t\t\t\tauthErr = candidate.result\n\t\t\t} else {\n\t\t\t\tsig, payload, ok := parseSignature(payload)\n\t\t\t\tif !ok || len(payload) > 0 {\n\t\t\t\t\treturn nil, parseError(msgUserAuthRequest)\n\t\t\t\t}\n\t\t\t\t// Ensure the declared public key algo is compatible with the\n\t\t\t\t// decoded one. This check will ensure we don't accept e.g.\n\t\t\t\t// ssh-rsa-cert-v01@openssh.com algorithm with ssh-rsa public\n\t\t\t\t// key type. The algorithm and public key type must be\n\t\t\t\t// consistent: both must be certificate algorithms, or neither.\n\t\t\t\tif !slices.Contains(algorithmsForKeyFormat(pubKey.Type()), algo) {\n\t\t\t\t\tauthErr = fmt.Errorf(\"ssh: public key type %q not compatible with selected algorithm %q\",\n\t\t\t\t\t\tpubKey.Type(), algo)\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\t// Ensure the public key algo and signature algo\n\t\t\t\t// are supported. Compare the private key\n\t\t\t\t// algorithm name that corresponds to algo with\n\t\t\t\t// sig.Format. This is usually the same, but\n\t\t\t\t// for certs, the names differ.\n\t\t\t\tif !slices.Contains(config.PublicKeyAuthAlgorithms, sig.Format) {\n\t\t\t\t\tauthErr = fmt.Errorf(\"ssh: algorithm %q not accepted\", sig.Format)\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t\tif !isAlgoCompatible(algo, sig.Format) {\n\t\t\t\t\tauthErr = fmt.Errorf(\"ssh: signature %q not compatible with selected algorithm %q\", sig.Format, algo)\n\t\t\t\t\tbreak\n\t\t\t\t}\n\n\t\t\t\tsignedData := buildDataSignedForAuth(sessionID, userAuthReq, algo, pubKeyData)\n\n\t\t\t\tif err := pubKey.Verify(signedData, sig); err != nil {\n\t\t\t\t\treturn nil, err\n\t\t\t\t}\n\n\t\t\t\tauthErr = candidate.result\n\t\t\t\tperms = candidate.perms\n\t\t\t\tif authErr == nil && config.VerifiedPublicKeyCallback != nil {\n\t\t\t\t\t// Only call VerifiedPublicKeyCallback after the key has been accepted\n\t\t\t\t\t// and successfully verified. If authErr is non-nil, the key is not\n\t\t\t\t\t// considered verified and the callback must not run.\n\t\t\t\t\tperms, authErr = config.VerifiedPublicKeyCallback(s, pubKey, perms, algo)\n\t\t\t\t}\n\t\t\t}\n\t\tcase \"gssapi-with-mic\":\n\t\t\tif authConfig.GSSAPIWithMICConfig == nil {\n\t\t\t\tauthErr = errors.New(\"ssh: gssapi-with-mic auth not configured\")\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tgssapiConfig := authConfig.GSSAPIWithMICConfig\n\t\t\tuserAuthRequestGSSAPI, err := parseGSSAPIPayload(userAuthReq.Payload)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, parseError(msgUserAuthRequest)\n\t\t\t}\n\t\t\t// OpenSSH supports Kerberos V5 mechanism only for GSS-API authentication.\n\t\t\tif userAuthRequestGSSAPI.N == 0 {\n\t\t\t\tauthErr = fmt.Errorf(\"ssh: Mechanism negotiation is not supported\")\n\t\t\t\tbreak\n\t\t\t}\n\t\t\tvar i uint32\n\t\t\tpresent := false\n\t\t\tfor i = 0; i < userAuthRequestGSSAPI.N; i++ {\n\t\t\t\tif userAuthRequestGSSAPI.OIDS[i].Equal(krb5Mesh) {\n\t\t\t\t\tpresent = true\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t\tif !present {\n\t\t\t\tauthErr = fmt.Errorf(\"ssh: GSSAPI authentication must use the Kerberos V5 mechanism\")\n\t\t\t\tbreak\n\t\t\t}\n\t\t\t// Initial server response, see RFC 4462 section 3.3.\n\t\t\tif err := s.transport.writePacket(Marshal(&userAuthGSSAPIResponse{\n\t\t\t\tSupportMech: krb5OID,\n\t\t\t})); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\t// Exchange token, see RFC 4462 section 3.4.\n\t\t\tpacket, err := s.transport.readPacket()\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tuserAuthGSSAPITokenReq := &userAuthGSSAPIToken{}\n\t\t\tif err := Unmarshal(packet, userAuthGSSAPITokenReq); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\tauthErr, perms, err = gssExchangeToken(gssapiConfig, userAuthGSSAPITokenReq.Token, s, sessionID,\n\t\t\t\tuserAuthReq)\n\t\t\tif err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\tdefault:\n\t\t\tauthErr = fmt.Errorf(\"ssh: unknown method %q\", userAuthReq.Method)\n\t\t}\n\n\t\tauthErrs = append(authErrs, authErr)\n\n\t\tif config.AuthLogCallback != nil {\n\t\t\tconfig.AuthLogCallback(s, userAuthReq.Method, authErr)\n\t\t}\n\n\t\tvar bannerErr *BannerError\n\t\tif errors.As(authErr, &bannerErr) {\n\t\t\tif bannerErr.Message != \"\" {\n\t\t\t\tif err := s.SendAuthBanner(bannerErr.Message); err != nil {\n\t\t\t\t\treturn nil, err\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif authErr == nil {\n\t\t\tbreak userAuthLoop\n\t\t}\n\n\t\tvar failureMsg userAuthFailureMsg\n\n\t\tif partialSuccess, ok := authErr.(*PartialSuccessError); ok {\n\t\t\t// After a partial success error we don't allow changing the user\n\t\t\t// name and execute the NoClientAuthCallback.\n\t\t\tpartialSuccessReturned = true\n\n\t\t\t// In case a partial success is returned, the server may send\n\t\t\t// a new set of authentication methods.\n\t\t\tauthConfig = partialSuccess.Next\n\n\t\t\t// Reset pubkey cache, as the new PublicKeyCallback might\n\t\t\t// accept a different set of public keys.\n\t\t\tcache = pubKeyCache{}\n\n\t\t\t// Send back a partial success message to the user.\n\t\t\tfailureMsg.PartialSuccess = true\n\t\t} else {\n\t\t\t// Allow initial attempt of 'none' without penalty.\n\t\t\tif authFailures > 0 || userAuthReq.Method != \"none\" || noneAuthCount != 1 {\n\t\t\t\tauthFailures++\n\t\t\t}\n\t\t\tif config.MaxAuthTries > 0 && authFailures >= config.MaxAuthTries {\n\t\t\t\t// If we have hit the max attempts, don't bother sending the\n\t\t\t\t// final SSH_MSG_USERAUTH_FAILURE message, since there are\n\t\t\t\t// no more authentication methods which can be attempted,\n\t\t\t\t// and this message may cause the client to re-attempt\n\t\t\t\t// authentication while we send the disconnect message.\n\t\t\t\t// Continue, and trigger the disconnect at the start of\n\t\t\t\t// the loop.\n\t\t\t\t//\n\t\t\t\t// The SSH specification is somewhat confusing about this,\n\t\t\t\t// RFC 4252 Section 5.1 requires each authentication failure\n\t\t\t\t// be responded to with a respective SSH_MSG_USERAUTH_FAILURE\n\t\t\t\t// message, but Section 4 says the server should disconnect\n\t\t\t\t// after some number of attempts, but it isn't explicit which\n\t\t\t\t// message should take precedence (i.e. should there be a failure\n\t\t\t\t// message than a disconnect message, or if we are going to\n\t\t\t\t// disconnect, should we only send that message.)\n\t\t\t\t//\n\t\t\t\t// Either way, OpenSSH disconnects immediately after the last\n\t\t\t\t// failed authentication attempt, and given they are typically\n\t\t\t\t// considered the golden implementation it seems reasonable\n\t\t\t\t// to match that behavior.\n\t\t\t\tcontinue\n\t\t\t}\n\t\t}\n\n\t\tif authConfig.PasswordCallback != nil {\n\t\t\tfailureMsg.Methods = append(failureMsg.Methods, \"password\")\n\t\t}\n\t\tif authConfig.PublicKeyCallback != nil {\n\t\t\tfailureMsg.Methods = append(failureMsg.Methods, \"publickey\")\n\t\t}\n\t\tif authConfig.KeyboardInteractiveCallback != nil {\n\t\t\tfailureMsg.Methods = append(failureMsg.Methods, \"keyboard-interactive\")\n\t\t}\n\t\tif authConfig.GSSAPIWithMICConfig != nil && authConfig.GSSAPIWithMICConfig.Server != nil &&\n\t\t\tauthConfig.GSSAPIWithMICConfig.AllowLogin != nil {\n\t\t\tfailureMsg.Methods = append(failureMsg.Methods, \"gssapi-with-mic\")\n\t\t}\n\n\t\tif len(failureMsg.Methods) == 0 {\n\t\t\treturn nil, errors.New(\"ssh: no authentication methods available\")\n\t\t}\n\n\t\tif err := s.transport.writePacket(Marshal(&failureMsg)); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\n\tif err := s.transport.writePacket([]byte{msgUserAuthSuccess}); err != nil {\n\t\treturn nil, err\n\t}\n\treturn perms, nil\n}\n\n// sshClientKeyboardInteractive implements a ClientKeyboardInteractive by\n// asking the client on the other side of a ServerConn.\ntype sshClientKeyboardInteractive struct {\n\t*connection\n}\n\nfunc (c *sshClientKeyboardInteractive) Challenge(name, instruction string, questions []string, echos []bool) (answers []string, err error) {\n\tif len(questions) != len(echos) {\n\t\treturn nil, errors.New(\"ssh: echos and questions must have equal length\")\n\t}\n\n\tvar prompts []byte\n\tfor i := range questions {\n\t\tprompts = appendString(prompts, questions[i])\n\t\tprompts = appendBool(prompts, echos[i])\n\t}\n\n\tif err := c.transport.writePacket(Marshal(&userAuthInfoRequestMsg{\n\t\tName: name,\n\t\tInstruction: instruction,\n\t\tNumPrompts: uint32(len(questions)),\n\t\tPrompts: prompts,\n\t})); err != nil {\n\t\treturn nil, err\n\t}\n\n\tpacket, err := c.transport.readPacket()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif packet[0] != msgUserAuthInfoResponse {\n\t\treturn nil, unexpectedMessageError(msgUserAuthInfoResponse, packet[0])\n\t}\n\tpacket = packet[1:]\n\n\tn, packet, ok := parseUint32(packet)\n\tif !ok || int(n) != len(questions) {\n\t\treturn nil, parseError(msgUserAuthInfoResponse)\n\t}\n\n\tfor i := uint32(0); i < n; i++ {\n\t\tans, rest, ok := parseString(packet)\n\t\tif !ok {\n\t\t\treturn nil, parseError(msgUserAuthInfoResponse)\n\t\t}\n\n\t\tanswers = append(answers, string(ans))\n\t\tpacket = rest\n\t}\n\tif len(packet) != 0 {\n\t\treturn nil, errors.New(\"ssh: junk at end of message\")\n\t}\n\n\treturn answers, nil\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/session.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\n// Session implements an interactive session described in\n// \"RFC 4254, section 6\".\n\nimport (\n\t\"bytes\"\n\t\"encoding/binary\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"sync\"\n)\n\ntype Signal string\n\n// POSIX signals as listed in RFC 4254 Section 6.10.\nconst (\n\tSIGABRT Signal = \"ABRT\"\n\tSIGALRM Signal = \"ALRM\"\n\tSIGFPE Signal = \"FPE\"\n\tSIGHUP Signal = \"HUP\"\n\tSIGILL Signal = \"ILL\"\n\tSIGINT Signal = \"INT\"\n\tSIGKILL Signal = \"KILL\"\n\tSIGPIPE Signal = \"PIPE\"\n\tSIGQUIT Signal = \"QUIT\"\n\tSIGSEGV Signal = \"SEGV\"\n\tSIGTERM Signal = \"TERM\"\n\tSIGUSR1 Signal = \"USR1\"\n\tSIGUSR2 Signal = \"USR2\"\n)\n\nvar signals = map[Signal]int{\n\tSIGABRT: 6,\n\tSIGALRM: 14,\n\tSIGFPE: 8,\n\tSIGHUP: 1,\n\tSIGILL: 4,\n\tSIGINT: 2,\n\tSIGKILL: 9,\n\tSIGPIPE: 13,\n\tSIGQUIT: 3,\n\tSIGSEGV: 11,\n\tSIGTERM: 15,\n}\n\ntype TerminalModes map[uint8]uint32\n\n// POSIX terminal mode flags as listed in RFC 4254 Section 8.\nconst (\n\ttty_OP_END = 0\n\tVINTR = 1\n\tVQUIT = 2\n\tVERASE = 3\n\tVKILL = 4\n\tVEOF = 5\n\tVEOL = 6\n\tVEOL2 = 7\n\tVSTART = 8\n\tVSTOP = 9\n\tVSUSP = 10\n\tVDSUSP = 11\n\tVREPRINT = 12\n\tVWERASE = 13\n\tVLNEXT = 14\n\tVFLUSH = 15\n\tVSWTCH = 16\n\tVSTATUS = 17\n\tVDISCARD = 18\n\tIGNPAR = 30\n\tPARMRK = 31\n\tINPCK = 32\n\tISTRIP = 33\n\tINLCR = 34\n\tIGNCR = 35\n\tICRNL = 36\n\tIUCLC = 37\n\tIXON = 38\n\tIXANY = 39\n\tIXOFF = 40\n\tIMAXBEL = 41\n\tIUTF8 = 42 // RFC 8160\n\tISIG = 50\n\tICANON = 51\n\tXCASE = 52\n\tECHO = 53\n\tECHOE = 54\n\tECHOK = 55\n\tECHONL = 56\n\tNOFLSH = 57\n\tTOSTOP = 58\n\tIEXTEN = 59\n\tECHOCTL = 60\n\tECHOKE = 61\n\tPENDIN = 62\n\tOPOST = 70\n\tOLCUC = 71\n\tONLCR = 72\n\tOCRNL = 73\n\tONOCR = 74\n\tONLRET = 75\n\tCS7 = 90\n\tCS8 = 91\n\tPARENB = 92\n\tPARODD = 93\n\tTTY_OP_ISPEED = 128\n\tTTY_OP_OSPEED = 129\n)\n\n// A Session represents a connection to a remote command or shell.\ntype Session struct {\n\t// Stdin specifies the remote process's standard input.\n\t// If Stdin is nil, the remote process reads from an empty\n\t// bytes.Buffer.\n\tStdin io.Reader\n\n\t// Stdout and Stderr specify the remote process's standard\n\t// output and error.\n\t//\n\t// If either is nil, Run connects the corresponding file\n\t// descriptor to an instance of io.Discard. There is a\n\t// fixed amount of buffering that is shared for the two streams.\n\t// If either blocks it may eventually cause the remote\n\t// command to block.\n\tStdout io.Writer\n\tStderr io.Writer\n\n\tch Channel // the channel backing this session\n\tstarted bool // true once Start, Run or Shell is invoked.\n\tcopyFuncs []func() error\n\terrors chan error // one send per copyFunc\n\n\t// true if pipe method is active\n\tstdinpipe, stdoutpipe, stderrpipe bool\n\n\t// stdinPipeWriter is non-nil if StdinPipe has not been called\n\t// and Stdin was specified by the user; it is the write end of\n\t// a pipe connecting Session.Stdin to the stdin channel.\n\tstdinPipeWriter io.WriteCloser\n\n\texitStatus chan error\n}\n\n// SendRequest sends an out-of-band channel request on the SSH channel\n// underlying the session.\nfunc (s *Session) SendRequest(name string, wantReply bool, payload []byte) (bool, error) {\n\treturn s.ch.SendRequest(name, wantReply, payload)\n}\n\nfunc (s *Session) Close() error {\n\treturn s.ch.Close()\n}\n\n// RFC 4254 Section 6.4.\ntype setenvRequest struct {\n\tName string\n\tValue string\n}\n\n// Setenv sets an environment variable that will be applied to any\n// command executed by Shell or Run.\nfunc (s *Session) Setenv(name, value string) error {\n\tmsg := setenvRequest{\n\t\tName: name,\n\t\tValue: value,\n\t}\n\tok, err := s.ch.SendRequest(\"env\", true, Marshal(&msg))\n\tif err == nil && !ok {\n\t\terr = errors.New(\"ssh: setenv failed\")\n\t}\n\treturn err\n}\n\n// RFC 4254 Section 6.2.\ntype ptyRequestMsg struct {\n\tTerm string\n\tColumns uint32\n\tRows uint32\n\tWidth uint32\n\tHeight uint32\n\tModelist string\n}\n\n// RequestPty requests the association of a pty with the session on the remote host.\nfunc (s *Session) RequestPty(term string, h, w int, termmodes TerminalModes) error {\n\tvar tm []byte\n\tfor k, v := range termmodes {\n\t\tkv := struct {\n\t\t\tKey byte\n\t\t\tVal uint32\n\t\t}{k, v}\n\n\t\ttm = append(tm, Marshal(&kv)...)\n\t}\n\ttm = append(tm, tty_OP_END)\n\treq := ptyRequestMsg{\n\t\tTerm: term,\n\t\tColumns: uint32(w),\n\t\tRows: uint32(h),\n\t\tWidth: uint32(w * 8),\n\t\tHeight: uint32(h * 8),\n\t\tModelist: string(tm),\n\t}\n\tok, err := s.ch.SendRequest(\"pty-req\", true, Marshal(&req))\n\tif err == nil && !ok {\n\t\terr = errors.New(\"ssh: pty-req failed\")\n\t}\n\treturn err\n}\n\n// RFC 4254 Section 6.5.\ntype subsystemRequestMsg struct {\n\tSubsystem string\n}\n\n// RequestSubsystem requests the association of a subsystem with the session on the remote host.\n// A subsystem is a predefined command that runs in the background when the ssh session is initiated\nfunc (s *Session) RequestSubsystem(subsystem string) error {\n\tmsg := subsystemRequestMsg{\n\t\tSubsystem: subsystem,\n\t}\n\tok, err := s.ch.SendRequest(\"subsystem\", true, Marshal(&msg))\n\tif err == nil && !ok {\n\t\terr = errors.New(\"ssh: subsystem request failed\")\n\t}\n\treturn err\n}\n\n// RFC 4254 Section 6.7.\ntype ptyWindowChangeMsg struct {\n\tColumns uint32\n\tRows uint32\n\tWidth uint32\n\tHeight uint32\n}\n\n// WindowChange informs the remote host about a terminal window dimension change to h rows and w columns.\nfunc (s *Session) WindowChange(h, w int) error {\n\treq := ptyWindowChangeMsg{\n\t\tColumns: uint32(w),\n\t\tRows: uint32(h),\n\t\tWidth: uint32(w * 8),\n\t\tHeight: uint32(h * 8),\n\t}\n\t_, err := s.ch.SendRequest(\"window-change\", false, Marshal(&req))\n\treturn err\n}\n\n// RFC 4254 Section 6.9.\ntype signalMsg struct {\n\tSignal string\n}\n\n// Signal sends the given signal to the remote process.\n// sig is one of the SIG* constants.\nfunc (s *Session) Signal(sig Signal) error {\n\tmsg := signalMsg{\n\t\tSignal: string(sig),\n\t}\n\n\t_, err := s.ch.SendRequest(\"signal\", false, Marshal(&msg))\n\treturn err\n}\n\n// RFC 4254 Section 6.5.\ntype execMsg struct {\n\tCommand string\n}\n\n// Start runs cmd on the remote host. Typically, the remote\n// server passes cmd to the shell for interpretation.\n// A Session only accepts one call to Run, Start or Shell.\nfunc (s *Session) Start(cmd string) error {\n\tif s.started {\n\t\treturn errors.New(\"ssh: session already started\")\n\t}\n\treq := execMsg{\n\t\tCommand: cmd,\n\t}\n\n\tok, err := s.ch.SendRequest(\"exec\", true, Marshal(&req))\n\tif err == nil && !ok {\n\t\terr = fmt.Errorf(\"ssh: command %v failed\", cmd)\n\t}\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn s.start()\n}\n\n// Run runs cmd on the remote host. Typically, the remote\n// server passes cmd to the shell for interpretation.\n// A Session only accepts one call to Run, Start, Shell, Output,\n// or CombinedOutput.\n//\n// The returned error is nil if the command runs, has no problems\n// copying stdin, stdout, and stderr, and exits with a zero exit\n// status.\n//\n// If the remote server does not send an exit status, an error of type\n// *ExitMissingError is returned. If the command completes\n// unsuccessfully or is interrupted by a signal, the error is of type\n// *ExitError. Other error types may be returned for I/O problems.\nfunc (s *Session) Run(cmd string) error {\n\terr := s.Start(cmd)\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn s.Wait()\n}\n\n// Output runs cmd on the remote host and returns its standard output.\nfunc (s *Session) Output(cmd string) ([]byte, error) {\n\tif s.Stdout != nil {\n\t\treturn nil, errors.New(\"ssh: Stdout already set\")\n\t}\n\tvar b bytes.Buffer\n\ts.Stdout = &b\n\terr := s.Run(cmd)\n\treturn b.Bytes(), err\n}\n\ntype singleWriter struct {\n\tb bytes.Buffer\n\tmu sync.Mutex\n}\n\nfunc (w *singleWriter) Write(p []byte) (int, error) {\n\tw.mu.Lock()\n\tdefer w.mu.Unlock()\n\treturn w.b.Write(p)\n}\n\n// CombinedOutput runs cmd on the remote host and returns its combined\n// standard output and standard error.\nfunc (s *Session) CombinedOutput(cmd string) ([]byte, error) {\n\tif s.Stdout != nil {\n\t\treturn nil, errors.New(\"ssh: Stdout already set\")\n\t}\n\tif s.Stderr != nil {\n\t\treturn nil, errors.New(\"ssh: Stderr already set\")\n\t}\n\tvar b singleWriter\n\ts.Stdout = &b\n\ts.Stderr = &b\n\terr := s.Run(cmd)\n\treturn b.b.Bytes(), err\n}\n\n// Shell starts a login shell on the remote host. A Session only\n// accepts one call to Run, Start, Shell, Output, or CombinedOutput.\nfunc (s *Session) Shell() error {\n\tif s.started {\n\t\treturn errors.New(\"ssh: session already started\")\n\t}\n\n\tok, err := s.ch.SendRequest(\"shell\", true, nil)\n\tif err == nil && !ok {\n\t\treturn errors.New(\"ssh: could not start shell\")\n\t}\n\tif err != nil {\n\t\treturn err\n\t}\n\treturn s.start()\n}\n\nfunc (s *Session) start() error {\n\ts.started = true\n\n\ttype F func(*Session)\n\tfor _, setupFd := range []F{(*Session).stdin, (*Session).stdout, (*Session).stderr} {\n\t\tsetupFd(s)\n\t}\n\n\ts.errors = make(chan error, len(s.copyFuncs))\n\tfor _, fn := range s.copyFuncs {\n\t\tgo func(fn func() error) {\n\t\t\ts.errors <- fn()\n\t\t}(fn)\n\t}\n\treturn nil\n}\n\n// Wait waits for the remote command to exit.\n//\n// The returned error is nil if the command runs, has no problems\n// copying stdin, stdout, and stderr, and exits with a zero exit\n// status.\n//\n// If the remote server does not send an exit status, an error of type\n// *ExitMissingError is returned. If the command completes\n// unsuccessfully or is interrupted by a signal, the error is of type\n// *ExitError. Other error types may be returned for I/O problems.\nfunc (s *Session) Wait() error {\n\tif !s.started {\n\t\treturn errors.New(\"ssh: session not started\")\n\t}\n\twaitErr := <-s.exitStatus\n\n\tif s.stdinPipeWriter != nil {\n\t\ts.stdinPipeWriter.Close()\n\t}\n\tvar copyError error\n\tfor range s.copyFuncs {\n\t\tif err := <-s.errors; err != nil && copyError == nil {\n\t\t\tcopyError = err\n\t\t}\n\t}\n\tif waitErr != nil {\n\t\treturn waitErr\n\t}\n\treturn copyError\n}\n\nfunc (s *Session) wait(reqs <-chan *Request) error {\n\twm := Waitmsg{status: -1}\n\t// Wait for msg channel to be closed before returning.\n\tfor msg := range reqs {\n\t\tswitch msg.Type {\n\t\tcase \"exit-status\":\n\t\t\twm.status = int(binary.BigEndian.Uint32(msg.Payload))\n\t\tcase \"exit-signal\":\n\t\t\tvar sigval struct {\n\t\t\t\tSignal string\n\t\t\t\tCoreDumped bool\n\t\t\t\tError string\n\t\t\t\tLang string\n\t\t\t}\n\t\t\tif err := Unmarshal(msg.Payload, &sigval); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\n\t\t\t// Must sanitize strings?\n\t\t\twm.signal = sigval.Signal\n\t\t\twm.msg = sigval.Error\n\t\t\twm.lang = sigval.Lang\n\t\tdefault:\n\t\t\t// This handles keepalives and matches\n\t\t\t// OpenSSH's behaviour.\n\t\t\tif msg.WantReply {\n\t\t\t\tmsg.Reply(false, nil)\n\t\t\t}\n\t\t}\n\t}\n\tif wm.status == 0 {\n\t\treturn nil\n\t}\n\tif wm.status == -1 {\n\t\t// exit-status was never sent from server\n\t\tif wm.signal == \"\" {\n\t\t\t// signal was not sent either. RFC 4254\n\t\t\t// section 6.10 recommends against this\n\t\t\t// behavior, but it is allowed, so we let\n\t\t\t// clients handle it.\n\t\t\treturn &ExitMissingError{}\n\t\t}\n\t\twm.status = 128\n\t\tif _, ok := signals[Signal(wm.signal)]; ok {\n\t\t\twm.status += signals[Signal(wm.signal)]\n\t\t}\n\t}\n\n\treturn &ExitError{wm}\n}\n\n// ExitMissingError is returned if a session is torn down cleanly, but\n// the server sends no confirmation of the exit status.\ntype ExitMissingError struct{}\n\nfunc (e *ExitMissingError) Error() string {\n\treturn \"wait: remote command exited without exit status or exit signal\"\n}\n\nfunc (s *Session) stdin() {\n\tif s.stdinpipe {\n\t\treturn\n\t}\n\tvar stdin io.Reader\n\tif s.Stdin == nil {\n\t\tstdin = new(bytes.Buffer)\n\t} else {\n\t\tr, w := io.Pipe()\n\t\tgo func() {\n\t\t\t_, err := io.Copy(w, s.Stdin)\n\t\t\tw.CloseWithError(err)\n\t\t}()\n\t\tstdin, s.stdinPipeWriter = r, w\n\t}\n\ts.copyFuncs = append(s.copyFuncs, func() error {\n\t\t_, err := io.Copy(s.ch, stdin)\n\t\tif err1 := s.ch.CloseWrite(); err == nil && err1 != io.EOF {\n\t\t\terr = err1\n\t\t}\n\t\treturn err\n\t})\n}\n\nfunc (s *Session) stdout() {\n\tif s.stdoutpipe {\n\t\treturn\n\t}\n\tif s.Stdout == nil {\n\t\ts.Stdout = io.Discard\n\t}\n\ts.copyFuncs = append(s.copyFuncs, func() error {\n\t\t_, err := io.Copy(s.Stdout, s.ch)\n\t\treturn err\n\t})\n}\n\nfunc (s *Session) stderr() {\n\tif s.stderrpipe {\n\t\treturn\n\t}\n\tif s.Stderr == nil {\n\t\ts.Stderr = io.Discard\n\t}\n\ts.copyFuncs = append(s.copyFuncs, func() error {\n\t\t_, err := io.Copy(s.Stderr, s.ch.Stderr())\n\t\treturn err\n\t})\n}\n\n// sessionStdin reroutes Close to CloseWrite.\ntype sessionStdin struct {\n\tio.Writer\n\tch Channel\n}\n\nfunc (s *sessionStdin) Close() error {\n\treturn s.ch.CloseWrite()\n}\n\n// StdinPipe returns a pipe that will be connected to the\n// remote command's standard input when the command starts.\nfunc (s *Session) StdinPipe() (io.WriteCloser, error) {\n\tif s.Stdin != nil {\n\t\treturn nil, errors.New(\"ssh: Stdin already set\")\n\t}\n\tif s.started {\n\t\treturn nil, errors.New(\"ssh: StdinPipe after process started\")\n\t}\n\ts.stdinpipe = true\n\treturn &sessionStdin{s.ch, s.ch}, nil\n}\n\n// StdoutPipe returns a pipe that will be connected to the\n// remote command's standard output when the command starts.\n// There is a fixed amount of buffering that is shared between\n// stdout and stderr streams. If the StdoutPipe reader is\n// not serviced fast enough it may eventually cause the\n// remote command to block.\nfunc (s *Session) StdoutPipe() (io.Reader, error) {\n\tif s.Stdout != nil {\n\t\treturn nil, errors.New(\"ssh: Stdout already set\")\n\t}\n\tif s.started {\n\t\treturn nil, errors.New(\"ssh: StdoutPipe after process started\")\n\t}\n\ts.stdoutpipe = true\n\treturn s.ch, nil\n}\n\n// StderrPipe returns a pipe that will be connected to the\n// remote command's standard error when the command starts.\n// There is a fixed amount of buffering that is shared between\n// stdout and stderr streams. If the StderrPipe reader is\n// not serviced fast enough it may eventually cause the\n// remote command to block.\nfunc (s *Session) StderrPipe() (io.Reader, error) {\n\tif s.Stderr != nil {\n\t\treturn nil, errors.New(\"ssh: Stderr already set\")\n\t}\n\tif s.started {\n\t\treturn nil, errors.New(\"ssh: StderrPipe after process started\")\n\t}\n\ts.stderrpipe = true\n\treturn s.ch.Stderr(), nil\n}\n\n// newSession returns a new interactive session on the remote host.\nfunc newSession(ch Channel, reqs <-chan *Request) (*Session, error) {\n\ts := &Session{\n\t\tch: ch,\n\t}\n\ts.exitStatus = make(chan error, 1)\n\tgo func() {\n\t\ts.exitStatus <- s.wait(reqs)\n\t}()\n\n\treturn s, nil\n}\n\n// An ExitError reports unsuccessful completion of a remote command.\ntype ExitError struct {\n\tWaitmsg\n}\n\nfunc (e *ExitError) Error() string {\n\treturn e.Waitmsg.String()\n}\n\n// Waitmsg stores the information about an exited remote command\n// as reported by Wait.\ntype Waitmsg struct {\n\tstatus int\n\tsignal string\n\tmsg string\n\tlang string\n}\n\n// ExitStatus returns the exit status of the remote command.\nfunc (w Waitmsg) ExitStatus() int {\n\treturn w.status\n}\n\n// Signal returns the exit signal of the remote command if\n// it was terminated violently.\nfunc (w Waitmsg) Signal() string {\n\treturn w.signal\n}\n\n// Msg returns the exit message given by the remote command\nfunc (w Waitmsg) Msg() string {\n\treturn w.msg\n}\n\n// Lang returns the language tag. See RFC 3066\nfunc (w Waitmsg) Lang() string {\n\treturn w.lang\n}\n\nfunc (w Waitmsg) String() string {\n\tstr := fmt.Sprintf(\"Process exited with status %v\", w.status)\n\tif w.signal != \"\" {\n\t\tstr += fmt.Sprintf(\" from signal %v\", w.signal)\n\t}\n\tif w.msg != \"\" {\n\t\tstr += fmt.Sprintf(\". Reason was: %v\", w.msg)\n\t}\n\treturn str\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/ssh_gss.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"encoding/asn1\"\n\t\"errors\"\n)\n\nvar krb5OID []byte\n\nfunc init() {\n\tkrb5OID, _ = asn1.Marshal(krb5Mesh)\n}\n\n// GSSAPIClient provides the API to plug-in GSSAPI authentication for client logins.\ntype GSSAPIClient interface {\n\t// InitSecContext initiates the establishment of a security context for GSS-API between the\n\t// ssh client and ssh server. Initially the token parameter should be specified as nil.\n\t// The routine may return a outputToken which should be transferred to\n\t// the ssh server, where the ssh server will present it to\n\t// AcceptSecContext. If no token need be sent, InitSecContext will indicate this by setting\n\t// needContinue to false. To complete the context\n\t// establishment, one or more reply tokens may be required from the ssh\n\t// server;if so, InitSecContext will return a needContinue which is true.\n\t// In this case, InitSecContext should be called again when the\n\t// reply token is received from the ssh server, passing the reply\n\t// token to InitSecContext via the token parameters.\n\t// See RFC 2743 section 2.2.1 and RFC 4462 section 3.4.\n\tInitSecContext(target string, token []byte, isGSSDelegCreds bool) (outputToken []byte, needContinue bool, err error)\n\t// GetMIC generates a cryptographic MIC for the SSH2 message, and places\n\t// the MIC in a token for transfer to the ssh server.\n\t// The contents of the MIC field are obtained by calling GSS_GetMIC()\n\t// over the following, using the GSS-API context that was just\n\t// established:\n\t// string session identifier\n\t// byte SSH_MSG_USERAUTH_REQUEST\n\t// string user name\n\t// string service\n\t// string \"gssapi-with-mic\"\n\t// See RFC 2743 section 2.3.1 and RFC 4462 3.5.\n\tGetMIC(micFiled []byte) ([]byte, error)\n\t// Whenever possible, it should be possible for\n\t// DeleteSecContext() calls to be successfully processed even\n\t// if other calls cannot succeed, thereby enabling context-related\n\t// resources to be released.\n\t// In addition to deleting established security contexts,\n\t// gss_delete_sec_context must also be able to delete \"half-built\"\n\t// security contexts resulting from an incomplete sequence of\n\t// InitSecContext()/AcceptSecContext() calls.\n\t// See RFC 2743 section 2.2.3.\n\tDeleteSecContext() error\n}\n\n// GSSAPIServer provides the API to plug in GSSAPI authentication for server logins.\ntype GSSAPIServer interface {\n\t// AcceptSecContext allows a remotely initiated security context between the application\n\t// and a remote peer to be established by the ssh client. The routine may return a\n\t// outputToken which should be transferred to the ssh client,\n\t// where the ssh client will present it to InitSecContext.\n\t// If no token need be sent, AcceptSecContext will indicate this\n\t// by setting the needContinue to false. To\n\t// complete the context establishment, one or more reply tokens may be\n\t// required from the ssh client. if so, AcceptSecContext\n\t// will return a needContinue which is true, in which case it\n\t// should be called again when the reply token is received from the ssh\n\t// client, passing the token to AcceptSecContext via the\n\t// token parameters.\n\t// The srcName return value is the authenticated username.\n\t// See RFC 2743 section 2.2.2 and RFC 4462 section 3.4.\n\tAcceptSecContext(token []byte) (outputToken []byte, srcName string, needContinue bool, err error)\n\t// VerifyMIC verifies that a cryptographic MIC, contained in the token parameter,\n\t// fits the supplied message is received from the ssh client.\n\t// See RFC 2743 section 2.3.2.\n\tVerifyMIC(micField []byte, micToken []byte) error\n\t// Whenever possible, it should be possible for\n\t// DeleteSecContext() calls to be successfully processed even\n\t// if other calls cannot succeed, thereby enabling context-related\n\t// resources to be released.\n\t// In addition to deleting established security contexts,\n\t// gss_delete_sec_context must also be able to delete \"half-built\"\n\t// security contexts resulting from an incomplete sequence of\n\t// InitSecContext()/AcceptSecContext() calls.\n\t// See RFC 2743 section 2.2.3.\n\tDeleteSecContext() error\n}\n\nvar (\n\t// OpenSSH supports Kerberos V5 mechanism only for GSS-API authentication,\n\t// so we also support the krb5 mechanism only.\n\t// See RFC 1964 section 1.\n\tkrb5Mesh = asn1.ObjectIdentifier{1, 2, 840, 113554, 1, 2, 2}\n)\n\n// The GSS-API authentication method is initiated when the client sends an SSH_MSG_USERAUTH_REQUEST\n// See RFC 4462 section 3.2.\ntype userAuthRequestGSSAPI struct {\n\tN uint32\n\tOIDS []asn1.ObjectIdentifier\n}\n\nfunc parseGSSAPIPayload(payload []byte) (*userAuthRequestGSSAPI, error) {\n\tn, rest, ok := parseUint32(payload)\n\tif !ok {\n\t\treturn nil, errors.New(\"parse uint32 failed\")\n\t}\n\t// Each ASN.1 encoded OID must have a minimum\n\t// of 2 bytes; 64 maximum mechanisms is an\n\t// arbitrary, but reasonable ceiling.\n\tconst maxMechs = 64\n\tif n > maxMechs || int(n)*2 > len(rest) {\n\t\treturn nil, errors.New(\"invalid mechanism count\")\n\t}\n\ts := &userAuthRequestGSSAPI{\n\t\tN: n,\n\t\tOIDS: make([]asn1.ObjectIdentifier, n),\n\t}\n\tfor i := 0; i < int(n); i++ {\n\t\tvar (\n\t\t\tdesiredMech []byte\n\t\t\terr error\n\t\t)\n\t\tdesiredMech, rest, ok = parseString(rest)\n\t\tif !ok {\n\t\t\treturn nil, errors.New(\"parse string failed\")\n\t\t}\n\t\tif rest, err = asn1.Unmarshal(desiredMech, &s.OIDS[i]); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t}\n\treturn s, nil\n}\n\n// See RFC 4462 section 3.6.\nfunc buildMIC(sessionID string, username string, service string, authMethod string) []byte {\n\tout := make([]byte, 0, 0)\n\tout = appendString(out, sessionID)\n\tout = append(out, msgUserAuthRequest)\n\tout = appendString(out, username)\n\tout = appendString(out, service)\n\tout = appendString(out, authMethod)\n\treturn out\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/streamlocal.go",
"content": "package ssh\n\nimport (\n\t\"errors\"\n\t\"io\"\n\t\"net\"\n)\n\n// streamLocalChannelOpenDirectMsg is a struct used for SSH_MSG_CHANNEL_OPEN message\n// with \"direct-streamlocal@openssh.com\" string.\n//\n// See openssh-portable/PROTOCOL, section 2.4. connection: Unix domain socket forwarding\n// https://github.com/openssh/openssh-portable/blob/master/PROTOCOL#L235\ntype streamLocalChannelOpenDirectMsg struct {\n\tsocketPath string\n\treserved0 string\n\treserved1 uint32\n}\n\n// forwardedStreamLocalPayload is a struct used for SSH_MSG_CHANNEL_OPEN message\n// with \"forwarded-streamlocal@openssh.com\" string.\ntype forwardedStreamLocalPayload struct {\n\tSocketPath string\n\tReserved0 string\n}\n\n// streamLocalChannelForwardMsg is a struct used for SSH2_MSG_GLOBAL_REQUEST message\n// with \"streamlocal-forward@openssh.com\"/\"cancel-streamlocal-forward@openssh.com\" string.\ntype streamLocalChannelForwardMsg struct {\n\tsocketPath string\n}\n\n// ListenUnix is similar to ListenTCP but uses a Unix domain socket.\nfunc (c *Client) ListenUnix(socketPath string) (net.Listener, error) {\n\tc.handleForwardsOnce.Do(c.handleForwards)\n\tm := streamLocalChannelForwardMsg{\n\t\tsocketPath,\n\t}\n\t// send message\n\tok, _, err := c.SendRequest(\"streamlocal-forward@openssh.com\", true, Marshal(&m))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif !ok {\n\t\treturn nil, errors.New(\"ssh: streamlocal-forward@openssh.com request denied by peer\")\n\t}\n\tch := c.forwards.add(\"unix\", socketPath)\n\n\treturn &unixListener{socketPath, c, ch}, nil\n}\n\nfunc (c *Client) dialStreamLocal(socketPath string) (Channel, error) {\n\tmsg := streamLocalChannelOpenDirectMsg{\n\t\tsocketPath: socketPath,\n\t}\n\tch, in, err := c.OpenChannel(\"direct-streamlocal@openssh.com\", Marshal(&msg))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tgo DiscardRequests(in)\n\treturn ch, err\n}\n\ntype unixListener struct {\n\tsocketPath string\n\n\tconn *Client\n\tin <-chan forward\n}\n\n// Accept waits for and returns the next connection to the listener.\nfunc (l *unixListener) Accept() (net.Conn, error) {\n\ts, ok := <-l.in\n\tif !ok {\n\t\treturn nil, io.EOF\n\t}\n\tch, incoming, err := s.newCh.Accept()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tgo DiscardRequests(incoming)\n\n\treturn &chanConn{\n\t\tChannel: ch,\n\t\tladdr: &net.UnixAddr{\n\t\t\tName: l.socketPath,\n\t\t\tNet: \"unix\",\n\t\t},\n\t\traddr: &net.UnixAddr{\n\t\t\tName: \"@\",\n\t\t\tNet: \"unix\",\n\t\t},\n\t}, nil\n}\n\n// Close closes the listener.\nfunc (l *unixListener) Close() error {\n\t// this also closes the listener.\n\tl.conn.forwards.remove(\"unix\", l.socketPath)\n\tm := streamLocalChannelForwardMsg{\n\t\tl.socketPath,\n\t}\n\tok, _, err := l.conn.SendRequest(\"cancel-streamlocal-forward@openssh.com\", true, Marshal(&m))\n\tif err == nil && !ok {\n\t\terr = errors.New(\"ssh: cancel-streamlocal-forward@openssh.com failed\")\n\t}\n\treturn err\n}\n\n// Addr returns the listener's network address.\nfunc (l *unixListener) Addr() net.Addr {\n\treturn &net.UnixAddr{\n\t\tName: l.socketPath,\n\t\tNet: \"unix\",\n\t}\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/tcpip.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"math/rand\"\n\t\"net\"\n\t\"net/netip\"\n\t\"strconv\"\n\t\"strings\"\n\t\"sync\"\n\t\"time\"\n)\n\n// Listen requests the remote peer open a listening socket on\n// addr. Incoming connections will be available by calling Accept on\n// the returned net.Listener. The listener must be serviced, or the\n// SSH connection may hang.\n// N must be \"tcp\", \"tcp4\", \"tcp6\", or \"unix\".\n//\n// If the address is a hostname, it is sent to the remote peer as-is, without\n// being resolved locally, and the Listener Addr method will return a zero IP.\nfunc (c *Client) Listen(n, addr string) (net.Listener, error) {\n\tswitch n {\n\tcase \"tcp\", \"tcp4\", \"tcp6\":\n\t\thost, portStr, err := net.SplitHostPort(addr)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tport, err := strconv.ParseInt(portStr, 10, 32)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn c.listenTCPInternal(host, int(port))\n\tcase \"unix\":\n\t\treturn c.ListenUnix(addr)\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported protocol: %s\", n)\n\t}\n}\n\n// Automatic port allocation is broken with OpenSSH before 6.0. See\n// also https://bugzilla.mindrot.org/show_bug.cgi?id=2017. In\n// particular, OpenSSH 5.9 sends a channelOpenMsg with port number 0,\n// rather than the actual port number. This means you can never open\n// two different listeners with auto allocated ports. We work around\n// this by trying explicit ports until we succeed.\n\nconst openSSHPrefix = \"OpenSSH_\"\n\nvar portRandomizer = rand.New(rand.NewSource(time.Now().UnixNano()))\n\n// isBrokenOpenSSHVersion returns true if the given version string\n// specifies a version of OpenSSH that is known to have a bug in port\n// forwarding.\nfunc isBrokenOpenSSHVersion(versionStr string) bool {\n\ti := strings.Index(versionStr, openSSHPrefix)\n\tif i < 0 {\n\t\treturn false\n\t}\n\ti += len(openSSHPrefix)\n\tj := i\n\tfor ; j < len(versionStr); j++ {\n\t\tif versionStr[j] < '0' || versionStr[j] > '9' {\n\t\t\tbreak\n\t\t}\n\t}\n\tversion, _ := strconv.Atoi(versionStr[i:j])\n\treturn version < 6\n}\n\n// autoPortListenWorkaround simulates automatic port allocation by\n// trying random ports repeatedly.\nfunc (c *Client) autoPortListenWorkaround(laddr *net.TCPAddr) (net.Listener, error) {\n\tvar sshListener net.Listener\n\tvar err error\n\tconst tries = 10\n\tfor i := 0; i < tries; i++ {\n\t\taddr := *laddr\n\t\taddr.Port = 1024 + portRandomizer.Intn(60000)\n\t\tsshListener, err = c.ListenTCP(&addr)\n\t\tif err == nil {\n\t\t\tladdr.Port = addr.Port\n\t\t\treturn sshListener, err\n\t\t}\n\t}\n\treturn nil, fmt.Errorf(\"ssh: listen on random port failed after %d tries: %v\", tries, err)\n}\n\n// RFC 4254 7.1\ntype channelForwardMsg struct {\n\taddr string\n\trport uint32\n}\n\n// handleForwards starts goroutines handling forwarded connections.\n// It's called on first use by (*Client).ListenTCP to not launch\n// goroutines until needed.\nfunc (c *Client) handleForwards() {\n\tgo c.forwards.handleChannels(c.HandleChannelOpen(\"forwarded-tcpip\"))\n\tgo c.forwards.handleChannels(c.HandleChannelOpen(\"forwarded-streamlocal@openssh.com\"))\n}\n\n// ListenTCP requests the remote peer open a listening socket\n// on laddr. Incoming connections will be available by calling\n// Accept on the returned net.Listener.\n//\n// ListenTCP accepts an IP address, to provide a hostname use [Client.Listen]\n// with \"tcp\", \"tcp4\", or \"tcp6\" network instead.\nfunc (c *Client) ListenTCP(laddr *net.TCPAddr) (net.Listener, error) {\n\tc.handleForwardsOnce.Do(c.handleForwards)\n\tif laddr.Port == 0 && isBrokenOpenSSHVersion(string(c.ServerVersion())) {\n\t\treturn c.autoPortListenWorkaround(laddr)\n\t}\n\n\treturn c.listenTCPInternal(laddr.IP.String(), laddr.Port)\n}\n\nfunc (c *Client) listenTCPInternal(host string, port int) (net.Listener, error) {\n\tc.handleForwardsOnce.Do(c.handleForwards)\n\n\tm := channelForwardMsg{\n\t\thost,\n\t\tuint32(port),\n\t}\n\t// send message\n\tok, resp, err := c.SendRequest(\"tcpip-forward\", true, Marshal(&m))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif !ok {\n\t\treturn nil, errors.New(\"ssh: tcpip-forward request denied by peer\")\n\t}\n\n\t// If the original port was 0, then the remote side will\n\t// supply a real port number in the response.\n\tif port == 0 {\n\t\tvar p struct {\n\t\t\tPort uint32\n\t\t}\n\t\tif err := Unmarshal(resp, &p); err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tport = int(p.Port)\n\t}\n\t// Construct a local address placeholder for the remote listener. If the\n\t// original host is an IP address, preserve it so that Listener.Addr()\n\t// reports the same IP. If the host is a hostname or cannot be parsed as an\n\t// IP, fall back to IPv4zero. The port field is always set, even if the\n\t// original port was 0, because in that case the remote server will assign\n\t// one, allowing callers to determine which port was selected.\n\tip := net.IPv4zero\n\tif parsed, err := netip.ParseAddr(host); err == nil {\n\t\tip = net.IP(parsed.AsSlice())\n\t}\n\tladdr := &net.TCPAddr{\n\t\tIP: ip,\n\t\tPort: port,\n\t}\n\taddr := net.JoinHostPort(host, strconv.FormatInt(int64(port), 10))\n\tch := c.forwards.add(\"tcp\", addr)\n\n\treturn &tcpListener{laddr, addr, c, ch}, nil\n}\n\n// forwardList stores a mapping between remote\n// forward requests and the tcpListeners.\ntype forwardList struct {\n\tsync.Mutex\n\tentries []forwardEntry\n}\n\n// forwardEntry represents an established mapping of a laddr on a\n// remote ssh server to a channel connected to a tcpListener.\ntype forwardEntry struct {\n\taddr string // host:port or socket path\n\tnetwork string // tcp or unix\n\tc chan forward\n}\n\n// forward represents an incoming forwarded tcpip connection. The\n// arguments to add/remove/lookup should be address as specified in\n// the original forward-request.\ntype forward struct {\n\tnewCh NewChannel // the ssh client channel underlying this forward\n\traddr net.Addr // the raddr of the incoming connection\n}\n\nfunc (l *forwardList) add(n, addr string) chan forward {\n\tl.Lock()\n\tdefer l.Unlock()\n\tf := forwardEntry{\n\t\taddr: addr,\n\t\tnetwork: n,\n\t\tc: make(chan forward, 1),\n\t}\n\tl.entries = append(l.entries, f)\n\treturn f.c\n}\n\n// See RFC 4254, section 7.2\ntype forwardedTCPPayload struct {\n\tAddr string\n\tPort uint32\n\tOriginAddr string\n\tOriginPort uint32\n}\n\n// parseTCPAddr parses the originating address from the remote into a *net.TCPAddr.\nfunc parseTCPAddr(addr string, port uint32) (*net.TCPAddr, error) {\n\tif port == 0 || port > 65535 {\n\t\treturn nil, fmt.Errorf(\"ssh: port number out of range: %d\", port)\n\t}\n\tip, err := netip.ParseAddr(addr)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"ssh: cannot parse IP address %q\", addr)\n\t}\n\treturn &net.TCPAddr{IP: net.IP(ip.AsSlice()), Port: int(port)}, nil\n}\n\nfunc (l *forwardList) handleChannels(in <-chan NewChannel) {\n\tfor ch := range in {\n\t\tvar (\n\t\t\taddr string\n\t\t\tnetwork string\n\t\t\traddr net.Addr\n\t\t\terr error\n\t\t)\n\t\tswitch channelType := ch.ChannelType(); channelType {\n\t\tcase \"forwarded-tcpip\":\n\t\t\tvar payload forwardedTCPPayload\n\t\t\tif err = Unmarshal(ch.ExtraData(), &payload); err != nil {\n\t\t\t\tch.Reject(ConnectionFailed, \"could not parse forwarded-tcpip payload: \"+err.Error())\n\t\t\t\tcontinue\n\t\t\t}\n\n\t\t\t// RFC 4254 section 7.2 specifies that incoming addresses should\n\t\t\t// list the address that was connected, in string format. It is the\n\t\t\t// same address used in the tcpip-forward request. The originator\n\t\t\t// address is an IP address instead.\n\t\t\taddr = net.JoinHostPort(payload.Addr, strconv.FormatUint(uint64(payload.Port), 10))\n\n\t\t\traddr, err = parseTCPAddr(payload.OriginAddr, payload.OriginPort)\n\t\t\tif err != nil {\n\t\t\t\tch.Reject(ConnectionFailed, err.Error())\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tnetwork = \"tcp\"\n\t\tcase \"forwarded-streamlocal@openssh.com\":\n\t\t\tvar payload forwardedStreamLocalPayload\n\t\t\tif err = Unmarshal(ch.ExtraData(), &payload); err != nil {\n\t\t\t\tch.Reject(ConnectionFailed, \"could not parse forwarded-streamlocal@openssh.com payload: \"+err.Error())\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\taddr = payload.SocketPath\n\t\t\traddr = &net.UnixAddr{\n\t\t\t\tName: \"@\",\n\t\t\t\tNet: \"unix\",\n\t\t\t}\n\t\t\tnetwork = \"unix\"\n\t\tdefault:\n\t\t\tpanic(fmt.Errorf(\"ssh: unknown channel type %s\", channelType))\n\t\t}\n\t\tif ok := l.forward(network, addr, raddr, ch); !ok {\n\t\t\t// Section 7.2, implementations MUST reject spurious incoming\n\t\t\t// connections.\n\t\t\tch.Reject(Prohibited, \"no forward for address\")\n\t\t\tcontinue\n\t\t}\n\n\t}\n}\n\n// remove removes the forward entry, and the channel feeding its\n// listener.\nfunc (l *forwardList) remove(n, addr string) {\n\tl.Lock()\n\tdefer l.Unlock()\n\tfor i, f := range l.entries {\n\t\tif n == f.network && addr == f.addr {\n\t\t\tl.entries = append(l.entries[:i], l.entries[i+1:]...)\n\t\t\tclose(f.c)\n\t\t\treturn\n\t\t}\n\t}\n}\n\n// closeAll closes and clears all forwards.\nfunc (l *forwardList) closeAll() {\n\tl.Lock()\n\tdefer l.Unlock()\n\tfor _, f := range l.entries {\n\t\tclose(f.c)\n\t}\n\tl.entries = nil\n}\n\nfunc (l *forwardList) forward(n, addr string, raddr net.Addr, ch NewChannel) bool {\n\tl.Lock()\n\tdefer l.Unlock()\n\tfor _, f := range l.entries {\n\t\tif n == f.network && addr == f.addr {\n\t\t\tf.c <- forward{newCh: ch, raddr: raddr}\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\ntype tcpListener struct {\n\tladdr *net.TCPAddr\n\taddr string\n\n\tconn *Client\n\tin <-chan forward\n}\n\n// Accept waits for and returns the next connection to the listener.\nfunc (l *tcpListener) Accept() (net.Conn, error) {\n\ts, ok := <-l.in\n\tif !ok {\n\t\treturn nil, io.EOF\n\t}\n\tch, incoming, err := s.newCh.Accept()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tgo DiscardRequests(incoming)\n\n\treturn &chanConn{\n\t\tChannel: ch,\n\t\tladdr: l.laddr,\n\t\traddr: s.raddr,\n\t}, nil\n}\n\n// Close closes the listener.\nfunc (l *tcpListener) Close() error {\n\thost, port, err := net.SplitHostPort(l.addr)\n\tif err != nil {\n\t\treturn err\n\t}\n\trport, err := strconv.ParseUint(port, 10, 32)\n\tif err != nil {\n\t\treturn err\n\t}\n\tm := channelForwardMsg{\n\t\thost,\n\t\tuint32(rport),\n\t}\n\n\t// this also closes the listener.\n\tl.conn.forwards.remove(\"tcp\", l.addr)\n\tok, _, err := l.conn.SendRequest(\"cancel-tcpip-forward\", true, Marshal(&m))\n\tif err == nil && !ok {\n\t\terr = errors.New(\"ssh: cancel-tcpip-forward failed\")\n\t}\n\treturn err\n}\n\n// Addr returns the listener's network address.\nfunc (l *tcpListener) Addr() net.Addr {\n\treturn l.laddr\n}\n\n// DialContext initiates a connection to the addr from the remote host.\n//\n// The provided Context must be non-nil. If the context expires before the\n// connection is complete, an error is returned. Once successfully connected,\n// any expiration of the context will not affect the connection.\n//\n// See func Dial for additional information.\nfunc (c *Client) DialContext(ctx context.Context, n, addr string) (net.Conn, error) {\n\tif err := ctx.Err(); err != nil {\n\t\treturn nil, err\n\t}\n\ttype connErr struct {\n\t\tconn net.Conn\n\t\terr error\n\t}\n\tch := make(chan connErr)\n\tgo func() {\n\t\tconn, err := c.Dial(n, addr)\n\t\tselect {\n\t\tcase ch <- connErr{conn, err}:\n\t\tcase <-ctx.Done():\n\t\t\tif conn != nil {\n\t\t\t\tconn.Close()\n\t\t\t}\n\t\t}\n\t}()\n\tselect {\n\tcase res := <-ch:\n\t\treturn res.conn, res.err\n\tcase <-ctx.Done():\n\t\treturn nil, ctx.Err()\n\t}\n}\n\n// Dial initiates a connection to the addr from the remote host.\n// The resulting connection has a zero LocalAddr() and RemoteAddr().\nfunc (c *Client) Dial(n, addr string) (net.Conn, error) {\n\tvar ch Channel\n\tswitch n {\n\tcase \"tcp\", \"tcp4\", \"tcp6\":\n\t\t// Parse the address into host and numeric port.\n\t\thost, portString, err := net.SplitHostPort(addr)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tport, err := strconv.ParseUint(portString, 10, 16)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tch, err = c.dial(net.IPv4zero.String(), 0, host, int(port))\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\t// Use a zero address for local and remote address.\n\t\tzeroAddr := &net.TCPAddr{\n\t\t\tIP: net.IPv4zero,\n\t\t\tPort: 0,\n\t\t}\n\t\treturn &chanConn{\n\t\t\tChannel: ch,\n\t\t\tladdr: zeroAddr,\n\t\t\traddr: zeroAddr,\n\t\t}, nil\n\tcase \"unix\":\n\t\tvar err error\n\t\tch, err = c.dialStreamLocal(addr)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn &chanConn{\n\t\t\tChannel: ch,\n\t\t\tladdr: &net.UnixAddr{\n\t\t\t\tName: \"@\",\n\t\t\t\tNet: \"unix\",\n\t\t\t},\n\t\t\traddr: &net.UnixAddr{\n\t\t\t\tName: addr,\n\t\t\t\tNet: \"unix\",\n\t\t\t},\n\t\t}, nil\n\tdefault:\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported protocol: %s\", n)\n\t}\n}\n\n// DialTCP connects to the remote address raddr on the network net,\n// which must be \"tcp\", \"tcp4\", or \"tcp6\". If laddr is not nil, it is used\n// as the local address for the connection.\nfunc (c *Client) DialTCP(n string, laddr, raddr *net.TCPAddr) (net.Conn, error) {\n\tif laddr == nil {\n\t\tladdr = &net.TCPAddr{\n\t\t\tIP: net.IPv4zero,\n\t\t\tPort: 0,\n\t\t}\n\t}\n\tch, err := c.dial(laddr.IP.String(), laddr.Port, raddr.IP.String(), raddr.Port)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn &chanConn{\n\t\tChannel: ch,\n\t\tladdr: laddr,\n\t\traddr: raddr,\n\t}, nil\n}\n\n// RFC 4254 7.2\ntype channelOpenDirectMsg struct {\n\traddr string\n\trport uint32\n\tladdr string\n\tlport uint32\n}\n\nfunc (c *Client) dial(laddr string, lport int, raddr string, rport int) (Channel, error) {\n\tmsg := channelOpenDirectMsg{\n\t\traddr: raddr,\n\t\trport: uint32(rport),\n\t\tladdr: laddr,\n\t\tlport: uint32(lport),\n\t}\n\tch, in, err := c.OpenChannel(\"direct-tcpip\", Marshal(&msg))\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tgo DiscardRequests(in)\n\treturn ch, nil\n}\n\ntype tcpChan struct {\n\tChannel // the backing channel\n}\n\n// chanConn fulfills the net.Conn interface without\n// the tcpChan having to hold laddr or raddr directly.\ntype chanConn struct {\n\tChannel\n\tladdr, raddr net.Addr\n}\n\n// LocalAddr returns the local network address.\nfunc (t *chanConn) LocalAddr() net.Addr {\n\treturn t.laddr\n}\n\n// RemoteAddr returns the remote network address.\nfunc (t *chanConn) RemoteAddr() net.Addr {\n\treturn t.raddr\n}\n\n// SetDeadline sets the read and write deadlines associated\n// with the connection.\nfunc (t *chanConn) SetDeadline(deadline time.Time) error {\n\tif err := t.SetReadDeadline(deadline); err != nil {\n\t\treturn err\n\t}\n\treturn t.SetWriteDeadline(deadline)\n}\n\n// SetReadDeadline sets the read deadline.\n// A zero value for t means Read will not time out.\n// After the deadline, the error from Read will implement net.Error\n// with Timeout() == true.\nfunc (t *chanConn) SetReadDeadline(deadline time.Time) error {\n\t// for compatibility with previous version,\n\t// the error message contains \"tcpChan\"\n\treturn errors.New(\"ssh: tcpChan: deadline not supported\")\n}\n\n// SetWriteDeadline exists to satisfy the net.Conn interface\n// but is not implemented by this type. It always returns an error.\nfunc (t *chanConn) SetWriteDeadline(deadline time.Time) error {\n\treturn errors.New(\"ssh: tcpChan: deadline not supported\")\n}\n"
},
{
"path": "tests/vendor/golang.org/x/crypto/ssh/transport.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage ssh\n\nimport (\n\t\"bufio\"\n\t\"bytes\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"log\"\n)\n\n// debugTransport if set, will print packet types as they go over the\n// wire. No message decoding is done, to minimize the impact on timing.\nconst debugTransport = false\n\n// packetConn represents a transport that implements packet based\n// operations.\ntype packetConn interface {\n\t// Encrypt and send a packet of data to the remote peer.\n\twritePacket(packet []byte) error\n\n\t// Read a packet from the connection. The read is blocking,\n\t// i.e. if error is nil, then the returned byte slice is\n\t// always non-empty.\n\treadPacket() ([]byte, error)\n\n\t// Close closes the write-side of the connection.\n\tClose() error\n}\n\n// transport is the keyingTransport that implements the SSH packet\n// protocol.\ntype transport struct {\n\treader connectionState\n\twriter connectionState\n\n\tbufReader *bufio.Reader\n\tbufWriter *bufio.Writer\n\trand io.Reader\n\tisClient bool\n\tio.Closer\n\n\tstrictMode bool\n\tinitialKEXDone bool\n}\n\n// packetCipher represents a combination of SSH encryption/MAC\n// protocol. A single instance should be used for one direction only.\ntype packetCipher interface {\n\t// writeCipherPacket encrypts the packet and writes it to w. The\n\t// contents of the packet are generally scrambled.\n\twriteCipherPacket(seqnum uint32, w io.Writer, rand io.Reader, packet []byte) error\n\n\t// readCipherPacket reads and decrypts a packet of data. The\n\t// returned packet may be overwritten by future calls of\n\t// readPacket.\n\treadCipherPacket(seqnum uint32, r io.Reader) ([]byte, error)\n}\n\n// connectionState represents one side (read or write) of the\n// connection. This is necessary because each direction has its own\n// keys, and can even have its own algorithms\ntype connectionState struct {\n\tpacketCipher\n\tseqNum uint32\n\tdir direction\n\tpendingKeyChange chan packetCipher\n}\n\nfunc (t *transport) setStrictMode() error {\n\tif t.reader.seqNum != 1 {\n\t\treturn errors.New(\"ssh: sequence number != 1 when strict KEX mode requested\")\n\t}\n\tt.strictMode = true\n\treturn nil\n}\n\nfunc (t *transport) setInitialKEXDone() {\n\tt.initialKEXDone = true\n}\n\n// prepareKeyChange sets up key material for a keychange. The key changes in\n// both directions are triggered by reading and writing a msgNewKey packet\n// respectively.\nfunc (t *transport) prepareKeyChange(algs *NegotiatedAlgorithms, kexResult *kexResult) error {\n\tciph, err := newPacketCipher(t.reader.dir, algs.Read, kexResult)\n\tif err != nil {\n\t\treturn err\n\t}\n\tt.reader.pendingKeyChange <- ciph\n\n\tciph, err = newPacketCipher(t.writer.dir, algs.Write, kexResult)\n\tif err != nil {\n\t\treturn err\n\t}\n\tt.writer.pendingKeyChange <- ciph\n\n\treturn nil\n}\n\nfunc (t *transport) printPacket(p []byte, write bool) {\n\tif len(p) == 0 {\n\t\treturn\n\t}\n\twho := \"server\"\n\tif t.isClient {\n\t\twho = \"client\"\n\t}\n\twhat := \"read\"\n\tif write {\n\t\twhat = \"write\"\n\t}\n\n\tlog.Println(what, who, p[0])\n}\n\n// Read and decrypt next packet.\nfunc (t *transport) readPacket() (p []byte, err error) {\n\tfor {\n\t\tp, err = t.reader.readPacket(t.bufReader, t.strictMode)\n\t\tif err != nil {\n\t\t\tbreak\n\t\t}\n\t\t// in strict mode we pass through DEBUG and IGNORE packets only during the initial KEX\n\t\tif len(p) == 0 || (t.strictMode && !t.initialKEXDone) || (p[0] != msgIgnore && p[0] != msgDebug) {\n\t\t\tbreak\n\t\t}\n\t}\n\tif debugTransport {\n\t\tt.printPacket(p, false)\n\t}\n\n\treturn p, err\n}\n\nfunc (s *connectionState) readPacket(r *bufio.Reader, strictMode bool) ([]byte, error) {\n\tpacket, err := s.packetCipher.readCipherPacket(s.seqNum, r)\n\ts.seqNum++\n\tif err == nil && len(packet) == 0 {\n\t\terr = errors.New(\"ssh: zero length packet\")\n\t}\n\n\tif len(packet) > 0 {\n\t\tswitch packet[0] {\n\t\tcase msgNewKeys:\n\t\t\tselect {\n\t\t\tcase cipher := <-s.pendingKeyChange:\n\t\t\t\ts.packetCipher = cipher\n\t\t\t\tif strictMode {\n\t\t\t\t\ts.seqNum = 0\n\t\t\t\t}\n\t\t\tdefault:\n\t\t\t\treturn nil, errors.New(\"ssh: got bogus newkeys message\")\n\t\t\t}\n\n\t\tcase msgDisconnect:\n\t\t\t// Transform a disconnect message into an\n\t\t\t// error. Since this is lowest level at which\n\t\t\t// we interpret message types, doing it here\n\t\t\t// ensures that we don't have to handle it\n\t\t\t// elsewhere.\n\t\t\tvar msg disconnectMsg\n\t\t\tif err := Unmarshal(packet, &msg); err != nil {\n\t\t\t\treturn nil, err\n\t\t\t}\n\t\t\treturn nil, &msg\n\t\t}\n\t}\n\n\t// The packet may point to an internal buffer, so copy the\n\t// packet out here.\n\tfresh := make([]byte, len(packet))\n\tcopy(fresh, packet)\n\n\treturn fresh, err\n}\n\nfunc (t *transport) writePacket(packet []byte) error {\n\tif debugTransport {\n\t\tt.printPacket(packet, true)\n\t}\n\treturn t.writer.writePacket(t.bufWriter, t.rand, packet, t.strictMode)\n}\n\nfunc (s *connectionState) writePacket(w *bufio.Writer, rand io.Reader, packet []byte, strictMode bool) error {\n\tchangeKeys := len(packet) > 0 && packet[0] == msgNewKeys\n\n\terr := s.packetCipher.writeCipherPacket(s.seqNum, w, rand, packet)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif err = w.Flush(); err != nil {\n\t\treturn err\n\t}\n\ts.seqNum++\n\tif changeKeys {\n\t\tselect {\n\t\tcase cipher := <-s.pendingKeyChange:\n\t\t\ts.packetCipher = cipher\n\t\t\tif strictMode {\n\t\t\t\ts.seqNum = 0\n\t\t\t}\n\t\tdefault:\n\t\t\tpanic(\"ssh: no key material for msgNewKeys\")\n\t\t}\n\t}\n\treturn err\n}\n\nfunc newTransport(rwc io.ReadWriteCloser, rand io.Reader, isClient bool) *transport {\n\tt := &transport{\n\t\tbufReader: bufio.NewReader(rwc),\n\t\tbufWriter: bufio.NewWriter(rwc),\n\t\trand: rand,\n\t\treader: connectionState{\n\t\t\tpacketCipher: &streamPacketCipher{cipher: noneCipher{}},\n\t\t\tpendingKeyChange: make(chan packetCipher, 1),\n\t\t},\n\t\twriter: connectionState{\n\t\t\tpacketCipher: &streamPacketCipher{cipher: noneCipher{}},\n\t\t\tpendingKeyChange: make(chan packetCipher, 1),\n\t\t},\n\t\tCloser: rwc,\n\t}\n\tt.isClient = isClient\n\n\tif isClient {\n\t\tt.reader.dir = serverKeys\n\t\tt.writer.dir = clientKeys\n\t} else {\n\t\tt.reader.dir = clientKeys\n\t\tt.writer.dir = serverKeys\n\t}\n\n\treturn t\n}\n\ntype direction struct {\n\tivTag []byte\n\tkeyTag []byte\n\tmacKeyTag []byte\n}\n\nvar (\n\tserverKeys = direction{[]byte{'B'}, []byte{'D'}, []byte{'F'}}\n\tclientKeys = direction{[]byte{'A'}, []byte{'C'}, []byte{'E'}}\n)\n\n// setupKeys sets the cipher and MAC keys from kex.K, kex.H and sessionId, as\n// described in RFC 4253, section 6.4. direction should either be serverKeys\n// (to setup server->client keys) or clientKeys (for client->server keys).\nfunc newPacketCipher(d direction, algs DirectionAlgorithms, kex *kexResult) (packetCipher, error) {\n\tcipherMode := cipherModes[algs.Cipher]\n\tif cipherMode == nil {\n\t\treturn nil, fmt.Errorf(\"ssh: unsupported cipher %v\", algs.Cipher)\n\t}\n\n\tiv := make([]byte, cipherMode.ivSize)\n\tkey := make([]byte, cipherMode.keySize)\n\n\tgenerateKeyMaterial(iv, d.ivTag, kex)\n\tgenerateKeyMaterial(key, d.keyTag, kex)\n\n\tvar macKey []byte\n\tif !aeadCiphers[algs.Cipher] {\n\t\tmacMode := macModes[algs.MAC]\n\t\tmacKey = make([]byte, macMode.keySize)\n\t\tgenerateKeyMaterial(macKey, d.macKeyTag, kex)\n\t}\n\n\treturn cipherModes[algs.Cipher].create(key, iv, macKey, algs)\n}\n\n// generateKeyMaterial fills out with key material generated from tag, K, H\n// and sessionId, as specified in RFC 4253, section 7.2.\nfunc generateKeyMaterial(out, tag []byte, r *kexResult) {\n\tvar digestsSoFar []byte\n\n\th := r.Hash.New()\n\tfor len(out) > 0 {\n\t\th.Reset()\n\t\th.Write(r.K)\n\t\th.Write(r.H)\n\n\t\tif len(digestsSoFar) == 0 {\n\t\t\th.Write(tag)\n\t\t\th.Write(r.SessionID)\n\t\t} else {\n\t\t\th.Write(digestsSoFar)\n\t\t}\n\n\t\tdigest := h.Sum(nil)\n\t\tn := copy(out, digest)\n\t\tout = out[n:]\n\t\tif len(out) > 0 {\n\t\t\tdigestsSoFar = append(digestsSoFar, digest...)\n\t\t}\n\t}\n}\n\nconst packageVersion = \"SSH-2.0-Go\"\n\n// Sends and receives a version line. The versionLine string should\n// be US ASCII, start with \"SSH-2.0-\", and should not include a\n// newline. exchangeVersions returns the other side's version line.\nfunc exchangeVersions(rw io.ReadWriter, versionLine []byte) (them []byte, err error) {\n\t// Contrary to the RFC, we do not ignore lines that don't\n\t// start with \"SSH-2.0-\" to make the library usable with\n\t// nonconforming servers.\n\tfor _, c := range versionLine {\n\t\t// The spec disallows non US-ASCII chars, and\n\t\t// specifically forbids null chars.\n\t\tif c < 32 {\n\t\t\treturn nil, errors.New(\"ssh: junk character in version line\")\n\t\t}\n\t}\n\tif _, err = rw.Write(append(versionLine, '\\r', '\\n')); err != nil {\n\t\treturn\n\t}\n\n\tthem, err = readVersion(rw)\n\treturn them, err\n}\n\n// maxVersionStringBytes is the maximum number of bytes that we'll\n// accept as a version string. RFC 4253 section 4.2 limits this at 255\n// chars\nconst maxVersionStringBytes = 255\n\n// Read version string as specified by RFC 4253, section 4.2.\nfunc readVersion(r io.Reader) ([]byte, error) {\n\tversionString := make([]byte, 0, 64)\n\tvar ok bool\n\tvar buf [1]byte\n\n\tfor length := 0; length < maxVersionStringBytes; length++ {\n\t\t_, err := io.ReadFull(r, buf[:])\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\t// The RFC says that the version should be terminated with \\r\\n\n\t\t// but several SSH servers actually only send a \\n.\n\t\tif buf[0] == '\\n' {\n\t\t\tif !bytes.HasPrefix(versionString, []byte(\"SSH-\")) {\n\t\t\t\t// RFC 4253 says we need to ignore all version string lines\n\t\t\t\t// except the one containing the SSH version (provided that\n\t\t\t\t// all the lines do not exceed 255 bytes in total).\n\t\t\t\tversionString = versionString[:0]\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tok = true\n\t\t\tbreak\n\t\t}\n\n\t\t// non ASCII chars are disallowed, but we are lenient,\n\t\t// since Go doesn't use null-terminated strings.\n\n\t\t// The RFC allows a comment after a space, however,\n\t\t// all of it (version and comments) goes into the\n\t\t// session hash.\n\t\tversionString = append(versionString, buf[0])\n\t}\n\n\tif !ok {\n\t\treturn nil, errors.New(\"ssh: overflow reading version string\")\n\t}\n\n\t// There might be a '\\r' on the end which we should remove.\n\tif len(versionString) > 0 && versionString[len(versionString)-1] == '\\r' {\n\t\tversionString = versionString[:len(versionString)-1]\n\t}\n\treturn versionString, nil\n}\n"
},
{
"path": "tests/vendor/golang.org/x/mod/LICENSE",
"content": "Copyright 2009 The Go Authors.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n * Redistributions of source code must retain the above copyright\nnotice, this list of conditions and the following disclaimer.\n * Redistributions in binary form must reproduce the above\ncopyright notice, this list of conditions and the following disclaimer\nin the documentation and/or other materials provided with the\ndistribution.\n * Neither the name of Google LLC nor the names of its\ncontributors may be used to endorse or promote products derived from\nthis software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\nLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\nDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\nTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
},
{
"path": "tests/vendor/golang.org/x/mod/PATENTS",
"content": "Additional IP Rights Grant (Patents)\n\n\"This implementation\" means the copyrightable works distributed by\nGoogle as part of the Go project.\n\nGoogle hereby grants to You a perpetual, worldwide, non-exclusive,\nno-charge, royalty-free, irrevocable (except as stated in this section)\npatent license to make, have made, use, offer to sell, sell, import,\ntransfer and otherwise run, modify and propagate the contents of this\nimplementation of Go, where such license applies only to those patent\nclaims, both currently owned or controlled by Google and acquired in\nthe future, licensable by Google that are necessarily infringed by this\nimplementation of Go. This grant does not include claims that would be\ninfringed only as a consequence of further modification of this\nimplementation. If you or your agent or exclusive licensee institute or\norder or agree to the institution of patent litigation against any\nentity (including a cross-claim or counterclaim in a lawsuit) alleging\nthat this implementation of Go or any code incorporated within this\nimplementation of Go constitutes direct or contributory patent\ninfringement, or inducement of patent infringement, then any patent\nrights granted to you under this License for this implementation of Go\nshall terminate as of the date such litigation is filed.\n"
},
{
"path": "tests/vendor/golang.org/x/mod/semver/semver.go",
"content": "// Copyright 2018 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package semver implements comparison of semantic version strings.\n// In this package, semantic version strings must begin with a leading \"v\",\n// as in \"v1.0.0\".\n//\n// The general form of a semantic version string accepted by this package is\n//\n//\tvMAJOR[.MINOR[.PATCH[-PRERELEASE][+BUILD]]]\n//\n// where square brackets indicate optional parts of the syntax;\n// MAJOR, MINOR, and PATCH are decimal integers without extra leading zeros;\n// PRERELEASE and BUILD are each a series of non-empty dot-separated identifiers\n// using only alphanumeric characters and hyphens; and\n// all-numeric PRERELEASE identifiers must not have leading zeros.\n//\n// This package follows Semantic Versioning 2.0.0 (see semver.org)\n// with two exceptions. First, it requires the \"v\" prefix. Second, it recognizes\n// vMAJOR and vMAJOR.MINOR (with no prerelease or build suffixes)\n// as shorthands for vMAJOR.0.0 and vMAJOR.MINOR.0.\npackage semver\n\nimport (\n\t\"slices\"\n\t\"strings\"\n)\n\n// parsed returns the parsed form of a semantic version string.\ntype parsed struct {\n\tmajor string\n\tminor string\n\tpatch string\n\tshort string\n\tprerelease string\n\tbuild string\n}\n\n// IsValid reports whether v is a valid semantic version string.\nfunc IsValid(v string) bool {\n\t_, ok := parse(v)\n\treturn ok\n}\n\n// Canonical returns the canonical formatting of the semantic version v.\n// It fills in any missing .MINOR or .PATCH and discards build metadata.\n// Two semantic versions compare equal only if their canonical formatting\n// is an identical string.\n// The canonical invalid semantic version is the empty string.\nfunc Canonical(v string) string {\n\tp, ok := parse(v)\n\tif !ok {\n\t\treturn \"\"\n\t}\n\tif p.build != \"\" {\n\t\treturn v[:len(v)-len(p.build)]\n\t}\n\tif p.short != \"\" {\n\t\treturn v + p.short\n\t}\n\treturn v\n}\n\n// Major returns the major version prefix of the semantic version v.\n// For example, Major(\"v2.1.0\") == \"v2\".\n// If v is an invalid semantic version string, Major returns the empty string.\nfunc Major(v string) string {\n\tpv, ok := parse(v)\n\tif !ok {\n\t\treturn \"\"\n\t}\n\treturn v[:1+len(pv.major)]\n}\n\n// MajorMinor returns the major.minor version prefix of the semantic version v.\n// For example, MajorMinor(\"v2.1.0\") == \"v2.1\".\n// If v is an invalid semantic version string, MajorMinor returns the empty string.\nfunc MajorMinor(v string) string {\n\tpv, ok := parse(v)\n\tif !ok {\n\t\treturn \"\"\n\t}\n\ti := 1 + len(pv.major)\n\tif j := i + 1 + len(pv.minor); j <= len(v) && v[i] == '.' && v[i+1:j] == pv.minor {\n\t\treturn v[:j]\n\t}\n\treturn v[:i] + \".\" + pv.minor\n}\n\n// Prerelease returns the prerelease suffix of the semantic version v.\n// For example, Prerelease(\"v2.1.0-pre+meta\") == \"-pre\".\n// If v is an invalid semantic version string, Prerelease returns the empty string.\nfunc Prerelease(v string) string {\n\tpv, ok := parse(v)\n\tif !ok {\n\t\treturn \"\"\n\t}\n\treturn pv.prerelease\n}\n\n// Build returns the build suffix of the semantic version v.\n// For example, Build(\"v2.1.0+meta\") == \"+meta\".\n// If v is an invalid semantic version string, Build returns the empty string.\nfunc Build(v string) string {\n\tpv, ok := parse(v)\n\tif !ok {\n\t\treturn \"\"\n\t}\n\treturn pv.build\n}\n\n// Compare returns an integer comparing two versions according to\n// semantic version precedence.\n// The result will be 0 if v == w, -1 if v < w, or +1 if v > w.\n//\n// An invalid semantic version string is considered less than a valid one.\n// All invalid semantic version strings compare equal to each other.\nfunc Compare(v, w string) int {\n\tpv, ok1 := parse(v)\n\tpw, ok2 := parse(w)\n\tif !ok1 && !ok2 {\n\t\treturn 0\n\t}\n\tif !ok1 {\n\t\treturn -1\n\t}\n\tif !ok2 {\n\t\treturn +1\n\t}\n\tif c := compareInt(pv.major, pw.major); c != 0 {\n\t\treturn c\n\t}\n\tif c := compareInt(pv.minor, pw.minor); c != 0 {\n\t\treturn c\n\t}\n\tif c := compareInt(pv.patch, pw.patch); c != 0 {\n\t\treturn c\n\t}\n\treturn comparePrerelease(pv.prerelease, pw.prerelease)\n}\n\n// Max canonicalizes its arguments and then returns the version string\n// that compares greater.\n//\n// Deprecated: use [Compare] instead. In most cases, returning a canonicalized\n// version is not expected or desired.\nfunc Max(v, w string) string {\n\tv = Canonical(v)\n\tw = Canonical(w)\n\tif Compare(v, w) > 0 {\n\t\treturn v\n\t}\n\treturn w\n}\n\n// ByVersion implements [sort.Interface] for sorting semantic version strings.\ntype ByVersion []string\n\nfunc (vs ByVersion) Len() int { return len(vs) }\nfunc (vs ByVersion) Swap(i, j int) { vs[i], vs[j] = vs[j], vs[i] }\nfunc (vs ByVersion) Less(i, j int) bool { return compareVersion(vs[i], vs[j]) < 0 }\n\n// Sort sorts a list of semantic version strings using [Compare] and falls back\n// to use [strings.Compare] if both versions are considered equal.\nfunc Sort(list []string) {\n\tslices.SortFunc(list, compareVersion)\n}\n\nfunc compareVersion(a, b string) int {\n\tcmp := Compare(a, b)\n\tif cmp != 0 {\n\t\treturn cmp\n\t}\n\treturn strings.Compare(a, b)\n}\n\nfunc parse(v string) (p parsed, ok bool) {\n\tif v == \"\" || v[0] != 'v' {\n\t\treturn\n\t}\n\tp.major, v, ok = parseInt(v[1:])\n\tif !ok {\n\t\treturn\n\t}\n\tif v == \"\" {\n\t\tp.minor = \"0\"\n\t\tp.patch = \"0\"\n\t\tp.short = \".0.0\"\n\t\treturn\n\t}\n\tif v[0] != '.' {\n\t\tok = false\n\t\treturn\n\t}\n\tp.minor, v, ok = parseInt(v[1:])\n\tif !ok {\n\t\treturn\n\t}\n\tif v == \"\" {\n\t\tp.patch = \"0\"\n\t\tp.short = \".0\"\n\t\treturn\n\t}\n\tif v[0] != '.' {\n\t\tok = false\n\t\treturn\n\t}\n\tp.patch, v, ok = parseInt(v[1:])\n\tif !ok {\n\t\treturn\n\t}\n\tif len(v) > 0 && v[0] == '-' {\n\t\tp.prerelease, v, ok = parsePrerelease(v)\n\t\tif !ok {\n\t\t\treturn\n\t\t}\n\t}\n\tif len(v) > 0 && v[0] == '+' {\n\t\tp.build, v, ok = parseBuild(v)\n\t\tif !ok {\n\t\t\treturn\n\t\t}\n\t}\n\tif v != \"\" {\n\t\tok = false\n\t\treturn\n\t}\n\tok = true\n\treturn\n}\n\nfunc parseInt(v string) (t, rest string, ok bool) {\n\tif v == \"\" {\n\t\treturn\n\t}\n\tif v[0] < '0' || '9' < v[0] {\n\t\treturn\n\t}\n\ti := 1\n\tfor i < len(v) && '0' <= v[i] && v[i] <= '9' {\n\t\ti++\n\t}\n\tif v[0] == '0' && i != 1 {\n\t\treturn\n\t}\n\treturn v[:i], v[i:], true\n}\n\nfunc parsePrerelease(v string) (t, rest string, ok bool) {\n\t// \"A pre-release version MAY be denoted by appending a hyphen and\n\t// a series of dot separated identifiers immediately following the patch version.\n\t// Identifiers MUST comprise only ASCII alphanumerics and hyphen [0-9A-Za-z-].\n\t// Identifiers MUST NOT be empty. Numeric identifiers MUST NOT include leading zeroes.\"\n\tif v == \"\" || v[0] != '-' {\n\t\treturn\n\t}\n\ti := 1\n\tstart := 1\n\tfor i < len(v) && v[i] != '+' {\n\t\tif !isIdentChar(v[i]) && v[i] != '.' {\n\t\t\treturn\n\t\t}\n\t\tif v[i] == '.' {\n\t\t\tif start == i || isBadNum(v[start:i]) {\n\t\t\t\treturn\n\t\t\t}\n\t\t\tstart = i + 1\n\t\t}\n\t\ti++\n\t}\n\tif start == i || isBadNum(v[start:i]) {\n\t\treturn\n\t}\n\treturn v[:i], v[i:], true\n}\n\nfunc parseBuild(v string) (t, rest string, ok bool) {\n\tif v == \"\" || v[0] != '+' {\n\t\treturn\n\t}\n\ti := 1\n\tstart := 1\n\tfor i < len(v) {\n\t\tif !isIdentChar(v[i]) && v[i] != '.' {\n\t\t\treturn\n\t\t}\n\t\tif v[i] == '.' {\n\t\t\tif start == i {\n\t\t\t\treturn\n\t\t\t}\n\t\t\tstart = i + 1\n\t\t}\n\t\ti++\n\t}\n\tif start == i {\n\t\treturn\n\t}\n\treturn v[:i], v[i:], true\n}\n\nfunc isIdentChar(c byte) bool {\n\treturn 'A' <= c && c <= 'Z' || 'a' <= c && c <= 'z' || '0' <= c && c <= '9' || c == '-'\n}\n\nfunc isBadNum(v string) bool {\n\ti := 0\n\tfor i < len(v) && '0' <= v[i] && v[i] <= '9' {\n\t\ti++\n\t}\n\treturn i == len(v) && i > 1 && v[0] == '0'\n}\n\nfunc isNum(v string) bool {\n\ti := 0\n\tfor i < len(v) && '0' <= v[i] && v[i] <= '9' {\n\t\ti++\n\t}\n\treturn i == len(v)\n}\n\nfunc compareInt(x, y string) int {\n\tif x == y {\n\t\treturn 0\n\t}\n\tif len(x) < len(y) {\n\t\treturn -1\n\t}\n\tif len(x) > len(y) {\n\t\treturn +1\n\t}\n\tif x < y {\n\t\treturn -1\n\t} else {\n\t\treturn +1\n\t}\n}\n\nfunc comparePrerelease(x, y string) int {\n\t// \"When major, minor, and patch are equal, a pre-release version has\n\t// lower precedence than a normal version.\n\t// Example: 1.0.0-alpha < 1.0.0.\n\t// Precedence for two pre-release versions with the same major, minor,\n\t// and patch version MUST be determined by comparing each dot separated\n\t// identifier from left to right until a difference is found as follows:\n\t// identifiers consisting of only digits are compared numerically and\n\t// identifiers with letters or hyphens are compared lexically in ASCII\n\t// sort order. Numeric identifiers always have lower precedence than\n\t// non-numeric identifiers. A larger set of pre-release fields has a\n\t// higher precedence than a smaller set, if all of the preceding\n\t// identifiers are equal.\n\t// Example: 1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta <\n\t// 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0.\"\n\tif x == y {\n\t\treturn 0\n\t}\n\tif x == \"\" {\n\t\treturn +1\n\t}\n\tif y == \"\" {\n\t\treturn -1\n\t}\n\tfor x != \"\" && y != \"\" {\n\t\tx = x[1:] // skip - or .\n\t\ty = y[1:] // skip - or .\n\t\tvar dx, dy string\n\t\tdx, x = nextIdent(x)\n\t\tdy, y = nextIdent(y)\n\t\tif dx != dy {\n\t\t\tix := isNum(dx)\n\t\t\tiy := isNum(dy)\n\t\t\tif ix != iy {\n\t\t\t\tif ix {\n\t\t\t\t\treturn -1\n\t\t\t\t} else {\n\t\t\t\t\treturn +1\n\t\t\t\t}\n\t\t\t}\n\t\t\tif ix {\n\t\t\t\tif len(dx) < len(dy) {\n\t\t\t\t\treturn -1\n\t\t\t\t}\n\t\t\t\tif len(dx) > len(dy) {\n\t\t\t\t\treturn +1\n\t\t\t\t}\n\t\t\t}\n\t\t\tif dx < dy {\n\t\t\t\treturn -1\n\t\t\t} else {\n\t\t\t\treturn +1\n\t\t\t}\n\t\t}\n\t}\n\tif x == \"\" {\n\t\treturn -1\n\t} else {\n\t\treturn +1\n\t}\n}\n\nfunc nextIdent(x string) (dx, rest string) {\n\ti := 0\n\tfor i < len(x) && x[i] != '.' {\n\t\ti++\n\t}\n\treturn x[:i], x[i:]\n}\n"
},
{
"path": "tests/vendor/golang.org/x/net/LICENSE",
"content": "Copyright 2009 The Go Authors.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n * Redistributions of source code must retain the above copyright\nnotice, this list of conditions and the following disclaimer.\n * Redistributions in binary form must reproduce the above\ncopyright notice, this list of conditions and the following disclaimer\nin the documentation and/or other materials provided with the\ndistribution.\n * Neither the name of Google LLC nor the names of its\ncontributors may be used to endorse or promote products derived from\nthis software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\nLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\nDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\nTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n"
},
{
"path": "tests/vendor/golang.org/x/net/PATENTS",
"content": "Additional IP Rights Grant (Patents)\n\n\"This implementation\" means the copyrightable works distributed by\nGoogle as part of the Go project.\n\nGoogle hereby grants to You a perpetual, worldwide, non-exclusive,\nno-charge, royalty-free, irrevocable (except as stated in this section)\npatent license to make, have made, use, offer to sell, sell, import,\ntransfer and otherwise run, modify and propagate the contents of this\nimplementation of Go, where such license applies only to those patent\nclaims, both currently owned or controlled by Google and acquired in\nthe future, licensable by Google that are necessarily infringed by this\nimplementation of Go. This grant does not include claims that would be\ninfringed only as a consequence of further modification of this\nimplementation. If you or your agent or exclusive licensee institute or\norder or agree to the institution of patent litigation against any\nentity (including a cross-claim or counterclaim in a lawsuit) alleging\nthat this implementation of Go or any code incorporated within this\nimplementation of Go constitutes direct or contributory patent\ninfringement, or inducement of patent infringement, then any patent\nrights granted to you under this License for this implementation of Go\nshall terminate as of the date such litigation is filed.\n"
},
{
"path": "tests/vendor/golang.org/x/net/html/atom/atom.go",
"content": "// Copyright 2012 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package atom provides integer codes (also known as atoms) for a fixed set of\n// frequently occurring HTML strings: tag names and attribute keys such as \"p\"\n// and \"id\".\n//\n// Sharing an atom's name between all elements with the same tag can result in\n// fewer string allocations when tokenizing and parsing HTML. Integer\n// comparisons are also generally faster than string comparisons.\n//\n// The value of an atom's particular code is not guaranteed to stay the same\n// between versions of this package. Neither is any ordering guaranteed:\n// whether atom.H1 < atom.H2 may also change. The codes are not guaranteed to\n// be dense. The only guarantees are that e.g. looking up \"div\" will yield\n// atom.Div, calling atom.Div.String will return \"div\", and atom.Div != 0.\npackage atom // import \"golang.org/x/net/html/atom\"\n\n// Atom is an integer code for a string. The zero value maps to \"\".\ntype Atom uint32\n\n// String returns the atom's name.\nfunc (a Atom) String() string {\n\tstart := uint32(a >> 8)\n\tn := uint32(a & 0xff)\n\tif start+n > uint32(len(atomText)) {\n\t\treturn \"\"\n\t}\n\treturn atomText[start : start+n]\n}\n\nfunc (a Atom) string() string {\n\treturn atomText[a>>8 : a>>8+a&0xff]\n}\n\n// fnv computes the FNV hash with an arbitrary starting value h.\nfunc fnv(h uint32, s []byte) uint32 {\n\tfor i := range s {\n\t\th ^= uint32(s[i])\n\t\th *= 16777619\n\t}\n\treturn h\n}\n\nfunc match(s string, t []byte) bool {\n\tfor i, c := range t {\n\t\tif s[i] != c {\n\t\t\treturn false\n\t\t}\n\t}\n\treturn true\n}\n\n// Lookup returns the atom whose name is s. It returns zero if there is no\n// such atom. The lookup is case sensitive.\nfunc Lookup(s []byte) Atom {\n\tif len(s) == 0 || len(s) > maxAtomLen {\n\t\treturn 0\n\t}\n\th := fnv(hash0, s)\n\tif a := table[h&uint32(len(table)-1)]; int(a&0xff) == len(s) && match(a.string(), s) {\n\t\treturn a\n\t}\n\tif a := table[(h>>16)&uint32(len(table)-1)]; int(a&0xff) == len(s) && match(a.string(), s) {\n\t\treturn a\n\t}\n\treturn 0\n}\n\n// String returns a string whose contents are equal to s. In that sense, it is\n// equivalent to string(s) but may be more efficient.\nfunc String(s []byte) string {\n\tif a := Lookup(s); a != 0 {\n\t\treturn a.String()\n\t}\n\treturn string(s)\n}\n"
},
{
"path": "tests/vendor/golang.org/x/net/html/atom/table.go",
"content": "// Code generated by go generate gen.go; DO NOT EDIT.\n\n//go:generate go run gen.go\n\npackage atom\n\nconst (\n\tA Atom = 0x1\n\tAbbr Atom = 0x4\n\tAccept Atom = 0x1a06\n\tAcceptCharset Atom = 0x1a0e\n\tAccesskey Atom = 0x2c09\n\tAcronym Atom = 0xaa07\n\tAction Atom = 0x26506\n\tAddress Atom = 0x6f107\n\tAlign Atom = 0xb105\n\tAllowfullscreen Atom = 0x3280f\n\tAllowpaymentrequest Atom = 0xc113\n\tAllowusermedia Atom = 0xdd0e\n\tAlt Atom = 0xf303\n\tAnnotation Atom = 0x1c90a\n\tAnnotationXml Atom = 0x1c90e\n\tApplet Atom = 0x30806\n\tArea Atom = 0x35004\n\tArticle Atom = 0x3f607\n\tAs Atom = 0x3c02\n\tAside Atom = 0x10705\n\tAsync Atom = 0xff05\n\tAudio Atom = 0x11505\n\tAutocomplete Atom = 0x26b0c\n\tAutofocus Atom = 0x12109\n\tAutoplay Atom = 0x13c08\n\tB Atom = 0x101\n\tBase Atom = 0x3b04\n\tBasefont Atom = 0x3b08\n\tBdi Atom = 0xba03\n\tBdo Atom = 0x14b03\n\tBgsound Atom = 0x15e07\n\tBig Atom = 0x17003\n\tBlink Atom = 0x17305\n\tBlockquote Atom = 0x1870a\n\tBody Atom = 0x2804\n\tBr Atom = 0x202\n\tButton Atom = 0x19106\n\tCanvas Atom = 0x10306\n\tCaption Atom = 0x22407\n\tCenter Atom = 0x21306\n\tChallenge Atom = 0x28e09\n\tCharset Atom = 0x2107\n\tChecked Atom = 0x5b507\n\tCite Atom = 0x19c04\n\tClass Atom = 0x55805\n\tCode Atom = 0x5ee04\n\tCol Atom = 0x1ab03\n\tColgroup Atom = 0x1ab08\n\tColor Atom = 0x1bf05\n\tCols Atom = 0x1c404\n\tColspan Atom = 0x1c407\n\tCommand Atom = 0x1d707\n\tContent Atom = 0x57b07\n\tContenteditable Atom = 0x57b0f\n\tContextmenu Atom = 0x37a0b\n\tControls Atom = 0x1de08\n\tCoords Atom = 0x1f006\n\tCrossorigin Atom = 0x1fa0b\n\tData Atom = 0x49904\n\tDatalist Atom = 0x49908\n\tDatetime Atom = 0x2ab08\n\tDd Atom = 0x2bf02\n\tDefault Atom = 0x10a07\n\tDefer Atom = 0x5f005\n\tDel Atom = 0x44c03\n\tDesc Atom = 0x55504\n\tDetails Atom = 0x7207\n\tDfn Atom = 0x8703\n\tDialog Atom = 0xbb06\n\tDir Atom = 0x9303\n\tDirname Atom = 0x9307\n\tDisabled Atom = 0x16408\n\tDiv Atom = 0x16b03\n\tDl Atom = 0x5d602\n\tDownload Atom = 0x45d08\n\tDraggable Atom = 0x17a09\n\tDropzone Atom = 0x3ff08\n\tDt Atom = 0x64002\n\tEm Atom = 0x6e02\n\tEmbed Atom = 0x6e05\n\tEnctype Atom = 0x28007\n\tFace Atom = 0x21104\n\tFieldset Atom = 0x21908\n\tFigcaption Atom = 0x2210a\n\tFigure Atom = 0x23b06\n\tFont Atom = 0x3f04\n\tFooter Atom = 0xf606\n\tFor Atom = 0x24703\n\tForeignObject Atom = 0x2470d\n\tForeignobject Atom = 0x2540d\n\tForm Atom = 0x26104\n\tFormaction Atom = 0x2610a\n\tFormenctype Atom = 0x27c0b\n\tFormmethod Atom = 0x2970a\n\tFormnovalidate Atom = 0x2a10e\n\tFormtarget Atom = 0x2b30a\n\tFrame Atom = 0x8b05\n\tFrameset Atom = 0x8b08\n\tH1 Atom = 0x15c02\n\tH2 Atom = 0x56102\n\tH3 Atom = 0x2cd02\n\tH4 Atom = 0x2fc02\n\tH5 Atom = 0x33f02\n\tH6 Atom = 0x34902\n\tHead Atom = 0x32004\n\tHeader Atom = 0x32006\n\tHeaders Atom = 0x32007\n\tHeight Atom = 0x5206\n\tHgroup Atom = 0x64206\n\tHidden Atom = 0x2bd06\n\tHigh Atom = 0x2ca04\n\tHr Atom = 0x15702\n\tHref Atom = 0x2cf04\n\tHreflang Atom = 0x2cf08\n\tHtml Atom = 0x5604\n\tHttpEquiv Atom = 0x2d70a\n\tI Atom = 0x601\n\tIcon Atom = 0x57a04\n\tId Atom = 0x10902\n\tIframe Atom = 0x2eb06\n\tImage Atom = 0x2f105\n\tImg Atom = 0x2f603\n\tInput Atom = 0x44505\n\tInputmode Atom = 0x44509\n\tIns Atom = 0x20303\n\tIntegrity Atom = 0x23209\n\tIs Atom = 0x16502\n\tIsindex Atom = 0x2fe07\n\tIsmap Atom = 0x30505\n\tItemid Atom = 0x38506\n\tItemprop Atom = 0x19d08\n\tItemref Atom = 0x3c707\n\tItemscope Atom = 0x66f09\n\tItemtype Atom = 0x30e08\n\tKbd Atom = 0xb903\n\tKeygen Atom = 0x3206\n\tKeytype Atom = 0xd607\n\tKind Atom = 0x17704\n\tLabel Atom = 0x5905\n\tLang Atom = 0x2d304\n\tLegend Atom = 0x18106\n\tLi Atom = 0xb202\n\tLink Atom = 0x17404\n\tList Atom = 0x49d04\n\tListing Atom = 0x49d07\n\tLoop Atom = 0x5d04\n\tLow Atom = 0xc303\n\tMain Atom = 0x1004\n\tMalignmark Atom = 0xb00a\n\tManifest Atom = 0x6d508\n\tMap Atom = 0x30703\n\tMark Atom = 0xb604\n\tMarquee Atom = 0x31607\n\tMath Atom = 0x31d04\n\tMax Atom = 0x33703\n\tMaxlength Atom = 0x33709\n\tMedia Atom = 0xe605\n\tMediagroup Atom = 0xe60a\n\tMenu Atom = 0x38104\n\tMenuitem Atom = 0x38108\n\tMeta Atom = 0x4ac04\n\tMeter Atom = 0x9805\n\tMethod Atom = 0x29b06\n\tMglyph Atom = 0x2f706\n\tMi Atom = 0x34102\n\tMin Atom = 0x34103\n\tMinlength Atom = 0x34109\n\tMn Atom = 0x2a402\n\tMo Atom = 0xa402\n\tMs Atom = 0x67202\n\tMtext Atom = 0x34b05\n\tMultiple Atom = 0x35908\n\tMuted Atom = 0x36105\n\tName Atom = 0x9604\n\tNav Atom = 0x1303\n\tNobr Atom = 0x3704\n\tNoembed Atom = 0x6c07\n\tNoframes Atom = 0x8908\n\tNomodule Atom = 0xa208\n\tNonce Atom = 0x1a605\n\tNoscript Atom = 0x2c208\n\tNovalidate Atom = 0x2a50a\n\tObject Atom = 0x25b06\n\tOl Atom = 0x13702\n\tOnabort Atom = 0x19507\n\tOnafterprint Atom = 0x2290c\n\tOnautocomplete Atom = 0x2690e\n\tOnautocompleteerror Atom = 0x26913\n\tOnauxclick Atom = 0x6140a\n\tOnbeforeprint Atom = 0x69c0d\n\tOnbeforeunload Atom = 0x6e50e\n\tOnblur Atom = 0x1ea06\n\tOncancel Atom = 0x11908\n\tOncanplay Atom = 0x14d09\n\tOncanplaythrough Atom = 0x14d10\n\tOnchange Atom = 0x41508\n\tOnclick Atom = 0x2e407\n\tOnclose Atom = 0x36607\n\tOncontextmenu Atom = 0x3780d\n\tOncopy Atom = 0x38b06\n\tOncuechange Atom = 0x3910b\n\tOncut Atom = 0x39c05\n\tOndblclick Atom = 0x3a10a\n\tOndrag Atom = 0x3ab06\n\tOndragend Atom = 0x3ab09\n\tOndragenter Atom = 0x3b40b\n\tOndragexit Atom = 0x3bf0a\n\tOndragleave Atom = 0x3d90b\n\tOndragover Atom = 0x3e40a\n\tOndragstart Atom = 0x3ee0b\n\tOndrop Atom = 0x3fd06\n\tOndurationchange Atom = 0x40d10\n\tOnemptied Atom = 0x40409\n\tOnended Atom = 0x41d07\n\tOnerror Atom = 0x42407\n\tOnfocus Atom = 0x42b07\n\tOnhashchange Atom = 0x4370c\n\tOninput Atom = 0x44307\n\tOninvalid Atom = 0x44f09\n\tOnkeydown Atom = 0x45809\n\tOnkeypress Atom = 0x4650a\n\tOnkeyup Atom = 0x47407\n\tOnlanguagechange Atom = 0x48110\n\tOnload Atom = 0x49106\n\tOnloadeddata Atom = 0x4910c\n\tOnloadedmetadata Atom = 0x4a410\n\tOnloadend Atom = 0x4ba09\n\tOnloadstart Atom = 0x4c30b\n\tOnmessage Atom = 0x4ce09\n\tOnmessageerror Atom = 0x4ce0e\n\tOnmousedown Atom = 0x4dc0b\n\tOnmouseenter Atom = 0x4e70c\n\tOnmouseleave Atom = 0x4f30c\n\tOnmousemove Atom = 0x4ff0b\n\tOnmouseout Atom = 0x50a0a\n\tOnmouseover Atom = 0x5170b\n\tOnmouseup Atom = 0x52209\n\tOnmousewheel Atom = 0x5300c\n\tOnoffline Atom = 0x53c09\n\tOnonline Atom = 0x54508\n\tOnpagehide Atom = 0x54d0a\n\tOnpageshow Atom = 0x5630a\n\tOnpaste Atom = 0x56f07\n\tOnpause Atom = 0x58a07\n\tOnplay Atom = 0x59406\n\tOnplaying Atom = 0x59409\n\tOnpopstate Atom = 0x59d0a\n\tOnprogress Atom = 0x5a70a\n\tOnratechange Atom = 0x5bc0c\n\tOnrejectionhandled Atom = 0x5c812\n\tOnreset Atom = 0x5da07\n\tOnresize Atom = 0x5e108\n\tOnscroll Atom = 0x5f508\n\tOnsecuritypolicyviolation Atom = 0x5fd19\n\tOnseeked Atom = 0x61e08\n\tOnseeking Atom = 0x62609\n\tOnselect Atom = 0x62f08\n\tOnshow Atom = 0x63906\n\tOnsort Atom = 0x64d06\n\tOnstalled Atom = 0x65709\n\tOnstorage Atom = 0x66009\n\tOnsubmit Atom = 0x66908\n\tOnsuspend Atom = 0x67909\n\tOntimeupdate Atom = 0x400c\n\tOntoggle Atom = 0x68208\n\tOnunhandledrejection Atom = 0x68a14\n\tOnunload Atom = 0x6a908\n\tOnvolumechange Atom = 0x6b10e\n\tOnwaiting Atom = 0x6bf09\n\tOnwheel Atom = 0x6c807\n\tOpen Atom = 0x1a304\n\tOptgroup Atom = 0x5f08\n\tOptimum Atom = 0x6cf07\n\tOption Atom = 0x6e106\n\tOutput Atom = 0x51106\n\tP Atom = 0xc01\n\tParam Atom = 0xc05\n\tPattern Atom = 0x6607\n\tPicture Atom = 0x7b07\n\tPing Atom = 0xef04\n\tPlaceholder Atom = 0x1310b\n\tPlaintext Atom = 0x1b209\n\tPlaysinline Atom = 0x1400b\n\tPoster Atom = 0x64706\n\tPre Atom = 0x46a03\n\tPreload Atom = 0x47a07\n\tProgress Atom = 0x5a908\n\tPrompt Atom = 0x52a06\n\tPublic Atom = 0x57606\n\tQ Atom = 0xcf01\n\tRadiogroup Atom = 0x30a\n\tRb Atom = 0x3a02\n\tReadonly Atom = 0x35108\n\tReferrerpolicy Atom = 0x3cb0e\n\tRel Atom = 0x47b03\n\tRequired Atom = 0x23f08\n\tReversed Atom = 0x8008\n\tRows Atom = 0x9c04\n\tRowspan Atom = 0x9c07\n\tRp Atom = 0x22f02\n\tRt Atom = 0x19a02\n\tRtc Atom = 0x19a03\n\tRuby Atom = 0xfb04\n\tS Atom = 0x2501\n\tSamp Atom = 0x7804\n\tSandbox Atom = 0x12907\n\tScope Atom = 0x67305\n\tScoped Atom = 0x67306\n\tScript Atom = 0x2c406\n\tSeamless Atom = 0x36b08\n\tSearch Atom = 0x55c06\n\tSection Atom = 0x1e507\n\tSelect Atom = 0x63106\n\tSelected Atom = 0x63108\n\tShape Atom = 0x1f505\n\tSize Atom = 0x5e504\n\tSizes Atom = 0x5e505\n\tSlot Atom = 0x20504\n\tSmall Atom = 0x32605\n\tSortable Atom = 0x64f08\n\tSorted Atom = 0x37206\n\tSource Atom = 0x43106\n\tSpacer Atom = 0x46e06\n\tSpan Atom = 0x9f04\n\tSpellcheck Atom = 0x5b00a\n\tSrc Atom = 0x5e903\n\tSrcdoc Atom = 0x5e906\n\tSrclang Atom = 0x6f707\n\tSrcset Atom = 0x6fe06\n\tStart Atom = 0x3f405\n\tStep Atom = 0x57304\n\tStrike Atom = 0xd206\n\tStrong Atom = 0x6db06\n\tStyle Atom = 0x70405\n\tSub Atom = 0x66b03\n\tSummary Atom = 0x70907\n\tSup Atom = 0x71003\n\tSvg Atom = 0x71303\n\tSystem Atom = 0x71606\n\tTabindex Atom = 0x4b208\n\tTable Atom = 0x58505\n\tTarget Atom = 0x2b706\n\tTbody Atom = 0x2705\n\tTd Atom = 0x9202\n\tTemplate Atom = 0x71908\n\tTextarea Atom = 0x34c08\n\tTfoot Atom = 0xf505\n\tTh Atom = 0x15602\n\tThead Atom = 0x31f05\n\tTime Atom = 0x4204\n\tTitle Atom = 0x11005\n\tTr Atom = 0xcc02\n\tTrack Atom = 0x1ba05\n\tTranslate Atom = 0x20809\n\tTt Atom = 0x6802\n\tType Atom = 0xd904\n\tTypemustmatch Atom = 0x2830d\n\tU Atom = 0xb01\n\tUl Atom = 0xa702\n\tUpdateviacache Atom = 0x460e\n\tUsemap Atom = 0x58e06\n\tValue Atom = 0x1505\n\tVar Atom = 0x16d03\n\tVideo Atom = 0x2e005\n\tWbr Atom = 0x56c03\n\tWidth Atom = 0x63e05\n\tWorkertype Atom = 0x7210a\n\tWrap Atom = 0x72b04\n\tXmp Atom = 0x12f03\n)\n\nconst hash0 = 0x84f70e16\n\nconst maxAtomLen = 25\n\nvar table = [1 << 9]Atom{\n\t0x1: 0x3ff08, // dropzone\n\t0x2: 0x3b08, // basefont\n\t0x3: 0x23209, // integrity\n\t0x4: 0x43106, // source\n\t0x5: 0x2c09, // accesskey\n\t0x6: 0x1a06, // accept\n\t0x7: 0x6c807, // onwheel\n\t0xb: 0x47407, // onkeyup\n\t0xc: 0x32007, // headers\n\t0xd: 0x67306, // scoped\n\t0xe: 0x67909, // onsuspend\n\t0xf: 0x8908, // noframes\n\t0x10: 0x1fa0b, // crossorigin\n\t0x11: 0x2e407, // onclick\n\t0x12: 0x3f405, // start\n\t0x13: 0x37a0b, // contextmenu\n\t0x14: 0x5e903, // src\n\t0x15: 0x1c404, // cols\n\t0x16: 0xbb06, // dialog\n\t0x17: 0x47a07, // preload\n\t0x18: 0x3c707, // itemref\n\t0x1b: 0x2f105, // image\n\t0x1d: 0x4ba09, // onloadend\n\t0x1e: 0x45d08, // download\n\t0x1f: 0x46a03, // pre\n\t0x23: 0x2970a, // formmethod\n\t0x24: 0x71303, // svg\n\t0x25: 0xcf01, // q\n\t0x26: 0x64002, // dt\n\t0x27: 0x1de08, // controls\n\t0x2a: 0x2804, // body\n\t0x2b: 0xd206, // strike\n\t0x2c: 0x3910b, // oncuechange\n\t0x2d: 0x4c30b, // onloadstart\n\t0x2e: 0x2fe07, // isindex\n\t0x2f: 0xb202, // li\n\t0x30: 0x1400b, // playsinline\n\t0x31: 0x34102, // mi\n\t0x32: 0x30806, // applet\n\t0x33: 0x4ce09, // onmessage\n\t0x35: 0x13702, // ol\n\t0x36: 0x1a304, // open\n\t0x39: 0x14d09, // oncanplay\n\t0x3a: 0x6bf09, // onwaiting\n\t0x3b: 0x11908, // oncancel\n\t0x3c: 0x6a908, // onunload\n\t0x3e: 0x53c09, // onoffline\n\t0x3f: 0x1a0e, // accept-charset\n\t0x40: 0x32004, // head\n\t0x42: 0x3ab09, // ondragend\n\t0x43: 0x1310b, // placeholder\n\t0x44: 0x2b30a, // formtarget\n\t0x45: 0x2540d, // foreignobject\n\t0x47: 0x400c, // ontimeupdate\n\t0x48: 0xdd0e, // allowusermedia\n\t0x4a: 0x69c0d, // onbeforeprint\n\t0x4b: 0x5604, // html\n\t0x4c: 0x9f04, // span\n\t0x4d: 0x64206, // hgroup\n\t0x4e: 0x16408, // disabled\n\t0x4f: 0x4204, // time\n\t0x51: 0x42b07, // onfocus\n\t0x53: 0xb00a, // malignmark\n\t0x55: 0x4650a, // onkeypress\n\t0x56: 0x55805, // class\n\t0x57: 0x1ab08, // colgroup\n\t0x58: 0x33709, // maxlength\n\t0x59: 0x5a908, // progress\n\t0x5b: 0x70405, // style\n\t0x5c: 0x2a10e, // formnovalidate\n\t0x5e: 0x38b06, // oncopy\n\t0x60: 0x26104, // form\n\t0x61: 0xf606, // footer\n\t0x64: 0x30a, // radiogroup\n\t0x66: 0xfb04, // ruby\n\t0x67: 0x4ff0b, // onmousemove\n\t0x68: 0x19d08, // itemprop\n\t0x69: 0x2d70a, // http-equiv\n\t0x6a: 0x15602, // th\n\t0x6c: 0x6e02, // em\n\t0x6d: 0x38108, // menuitem\n\t0x6e: 0x63106, // select\n\t0x6f: 0x48110, // onlanguagechange\n\t0x70: 0x31f05, // thead\n\t0x71: 0x15c02, // h1\n\t0x72: 0x5e906, // srcdoc\n\t0x75: 0x9604, // name\n\t0x76: 0x19106, // button\n\t0x77: 0x55504, // desc\n\t0x78: 0x17704, // kind\n\t0x79: 0x1bf05, // color\n\t0x7c: 0x58e06, // usemap\n\t0x7d: 0x30e08, // itemtype\n\t0x7f: 0x6d508, // manifest\n\t0x81: 0x5300c, // onmousewheel\n\t0x82: 0x4dc0b, // onmousedown\n\t0x84: 0xc05, // param\n\t0x85: 0x2e005, // video\n\t0x86: 0x4910c, // onloadeddata\n\t0x87: 0x6f107, // address\n\t0x8c: 0xef04, // ping\n\t0x8d: 0x24703, // for\n\t0x8f: 0x62f08, // onselect\n\t0x90: 0x30703, // map\n\t0x92: 0xc01, // p\n\t0x93: 0x8008, // reversed\n\t0x94: 0x54d0a, // onpagehide\n\t0x95: 0x3206, // keygen\n\t0x96: 0x34109, // minlength\n\t0x97: 0x3e40a, // ondragover\n\t0x98: 0x42407, // onerror\n\t0x9a: 0x2107, // charset\n\t0x9b: 0x29b06, // method\n\t0x9c: 0x101, // b\n\t0x9d: 0x68208, // ontoggle\n\t0x9e: 0x2bd06, // hidden\n\t0xa0: 0x3f607, // article\n\t0xa2: 0x63906, // onshow\n\t0xa3: 0x64d06, // onsort\n\t0xa5: 0x57b0f, // contenteditable\n\t0xa6: 0x66908, // onsubmit\n\t0xa8: 0x44f09, // oninvalid\n\t0xaa: 0x202, // br\n\t0xab: 0x10902, // id\n\t0xac: 0x5d04, // loop\n\t0xad: 0x5630a, // onpageshow\n\t0xb0: 0x2cf04, // href\n\t0xb2: 0x2210a, // figcaption\n\t0xb3: 0x2690e, // onautocomplete\n\t0xb4: 0x49106, // onload\n\t0xb6: 0x9c04, // rows\n\t0xb7: 0x1a605, // nonce\n\t0xb8: 0x68a14, // onunhandledrejection\n\t0xbb: 0x21306, // center\n\t0xbc: 0x59406, // onplay\n\t0xbd: 0x33f02, // h5\n\t0xbe: 0x49d07, // listing\n\t0xbf: 0x57606, // public\n\t0xc2: 0x23b06, // figure\n\t0xc3: 0x57a04, // icon\n\t0xc4: 0x1ab03, // col\n\t0xc5: 0x47b03, // rel\n\t0xc6: 0xe605, // media\n\t0xc7: 0x12109, // autofocus\n\t0xc8: 0x19a02, // rt\n\t0xca: 0x2d304, // lang\n\t0xcc: 0x49908, // datalist\n\t0xce: 0x2eb06, // iframe\n\t0xcf: 0x36105, // muted\n\t0xd0: 0x6140a, // onauxclick\n\t0xd2: 0x3c02, // as\n\t0xd6: 0x3fd06, // ondrop\n\t0xd7: 0x1c90a, // annotation\n\t0xd8: 0x21908, // fieldset\n\t0xdb: 0x2cf08, // hreflang\n\t0xdc: 0x4e70c, // onmouseenter\n\t0xdd: 0x2a402, // mn\n\t0xde: 0xe60a, // mediagroup\n\t0xdf: 0x9805, // meter\n\t0xe0: 0x56c03, // wbr\n\t0xe2: 0x63e05, // width\n\t0xe3: 0x2290c, // onafterprint\n\t0xe4: 0x30505, // ismap\n\t0xe5: 0x1505, // value\n\t0xe7: 0x1303, // nav\n\t0xe8: 0x54508, // ononline\n\t0xe9: 0xb604, // mark\n\t0xea: 0xc303, // low\n\t0xeb: 0x3ee0b, // ondragstart\n\t0xef: 0x12f03, // xmp\n\t0xf0: 0x22407, // caption\n\t0xf1: 0xd904, // type\n\t0xf2: 0x70907, // summary\n\t0xf3: 0x6802, // tt\n\t0xf4: 0x20809, // translate\n\t0xf5: 0x1870a, // blockquote\n\t0xf8: 0x15702, // hr\n\t0xfa: 0x2705, // tbody\n\t0xfc: 0x7b07, // picture\n\t0xfd: 0x5206, // height\n\t0xfe: 0x19c04, // cite\n\t0xff: 0x2501, // s\n\t0x101: 0xff05, // async\n\t0x102: 0x56f07, // onpaste\n\t0x103: 0x19507, // onabort\n\t0x104: 0x2b706, // target\n\t0x105: 0x14b03, // bdo\n\t0x106: 0x1f006, // coords\n\t0x107: 0x5e108, // onresize\n\t0x108: 0x71908, // template\n\t0x10a: 0x3a02, // rb\n\t0x10b: 0x2a50a, // novalidate\n\t0x10c: 0x460e, // updateviacache\n\t0x10d: 0x71003, // sup\n\t0x10e: 0x6c07, // noembed\n\t0x10f: 0x16b03, // div\n\t0x110: 0x6f707, // srclang\n\t0x111: 0x17a09, // draggable\n\t0x112: 0x67305, // scope\n\t0x113: 0x5905, // label\n\t0x114: 0x22f02, // rp\n\t0x115: 0x23f08, // required\n\t0x116: 0x3780d, // oncontextmenu\n\t0x117: 0x5e504, // size\n\t0x118: 0x5b00a, // spellcheck\n\t0x119: 0x3f04, // font\n\t0x11a: 0x9c07, // rowspan\n\t0x11b: 0x10a07, // default\n\t0x11d: 0x44307, // oninput\n\t0x11e: 0x38506, // itemid\n\t0x11f: 0x5ee04, // code\n\t0x120: 0xaa07, // acronym\n\t0x121: 0x3b04, // base\n\t0x125: 0x2470d, // foreignObject\n\t0x126: 0x2ca04, // high\n\t0x127: 0x3cb0e, // referrerpolicy\n\t0x128: 0x33703, // max\n\t0x129: 0x59d0a, // onpopstate\n\t0x12a: 0x2fc02, // h4\n\t0x12b: 0x4ac04, // meta\n\t0x12c: 0x17305, // blink\n\t0x12e: 0x5f508, // onscroll\n\t0x12f: 0x59409, // onplaying\n\t0x130: 0xc113, // allowpaymentrequest\n\t0x131: 0x19a03, // rtc\n\t0x132: 0x72b04, // wrap\n\t0x134: 0x8b08, // frameset\n\t0x135: 0x32605, // small\n\t0x137: 0x32006, // header\n\t0x138: 0x40409, // onemptied\n\t0x139: 0x34902, // h6\n\t0x13a: 0x35908, // multiple\n\t0x13c: 0x52a06, // prompt\n\t0x13f: 0x28e09, // challenge\n\t0x141: 0x4370c, // onhashchange\n\t0x142: 0x57b07, // content\n\t0x143: 0x1c90e, // annotation-xml\n\t0x144: 0x36607, // onclose\n\t0x145: 0x14d10, // oncanplaythrough\n\t0x148: 0x5170b, // onmouseover\n\t0x149: 0x64f08, // sortable\n\t0x14a: 0xa402, // mo\n\t0x14b: 0x2cd02, // h3\n\t0x14c: 0x2c406, // script\n\t0x14d: 0x41d07, // onended\n\t0x14f: 0x64706, // poster\n\t0x150: 0x7210a, // workertype\n\t0x153: 0x1f505, // shape\n\t0x154: 0x4, // abbr\n\t0x155: 0x1, // a\n\t0x156: 0x2bf02, // dd\n\t0x157: 0x71606, // system\n\t0x158: 0x4ce0e, // onmessageerror\n\t0x159: 0x36b08, // seamless\n\t0x15a: 0x2610a, // formaction\n\t0x15b: 0x6e106, // option\n\t0x15c: 0x31d04, // math\n\t0x15d: 0x62609, // onseeking\n\t0x15e: 0x39c05, // oncut\n\t0x15f: 0x44c03, // del\n\t0x160: 0x11005, // title\n\t0x161: 0x11505, // audio\n\t0x162: 0x63108, // selected\n\t0x165: 0x3b40b, // ondragenter\n\t0x166: 0x46e06, // spacer\n\t0x167: 0x4a410, // onloadedmetadata\n\t0x168: 0x44505, // input\n\t0x16a: 0x58505, // table\n\t0x16b: 0x41508, // onchange\n\t0x16e: 0x5f005, // defer\n\t0x171: 0x50a0a, // onmouseout\n\t0x172: 0x20504, // slot\n\t0x175: 0x3704, // nobr\n\t0x177: 0x1d707, // command\n\t0x17a: 0x7207, // details\n\t0x17b: 0x38104, // menu\n\t0x17c: 0xb903, // kbd\n\t0x17d: 0x57304, // step\n\t0x17e: 0x20303, // ins\n\t0x17f: 0x13c08, // autoplay\n\t0x182: 0x34103, // min\n\t0x183: 0x17404, // link\n\t0x185: 0x40d10, // ondurationchange\n\t0x186: 0x9202, // td\n\t0x187: 0x8b05, // frame\n\t0x18a: 0x2ab08, // datetime\n\t0x18b: 0x44509, // inputmode\n\t0x18c: 0x35108, // readonly\n\t0x18d: 0x21104, // face\n\t0x18f: 0x5e505, // sizes\n\t0x191: 0x4b208, // tabindex\n\t0x192: 0x6db06, // strong\n\t0x193: 0xba03, // bdi\n\t0x194: 0x6fe06, // srcset\n\t0x196: 0x67202, // ms\n\t0x197: 0x5b507, // checked\n\t0x198: 0xb105, // align\n\t0x199: 0x1e507, // section\n\t0x19b: 0x6e05, // embed\n\t0x19d: 0x15e07, // bgsound\n\t0x1a2: 0x49d04, // list\n\t0x1a3: 0x61e08, // onseeked\n\t0x1a4: 0x66009, // onstorage\n\t0x1a5: 0x2f603, // img\n\t0x1a6: 0xf505, // tfoot\n\t0x1a9: 0x26913, // onautocompleteerror\n\t0x1aa: 0x5fd19, // onsecuritypolicyviolation\n\t0x1ad: 0x9303, // dir\n\t0x1ae: 0x9307, // dirname\n\t0x1b0: 0x5a70a, // onprogress\n\t0x1b2: 0x65709, // onstalled\n\t0x1b5: 0x66f09, // itemscope\n\t0x1b6: 0x49904, // data\n\t0x1b7: 0x3d90b, // ondragleave\n\t0x1b8: 0x56102, // h2\n\t0x1b9: 0x2f706, // mglyph\n\t0x1ba: 0x16502, // is\n\t0x1bb: 0x6e50e, // onbeforeunload\n\t0x1bc: 0x2830d, // typemustmatch\n\t0x1bd: 0x3ab06, // ondrag\n\t0x1be: 0x5da07, // onreset\n\t0x1c0: 0x51106, // output\n\t0x1c1: 0x12907, // sandbox\n\t0x1c2: 0x1b209, // plaintext\n\t0x1c4: 0x34c08, // textarea\n\t0x1c7: 0xd607, // keytype\n\t0x1c8: 0x34b05, // mtext\n\t0x1c9: 0x6b10e, // onvolumechange\n\t0x1ca: 0x1ea06, // onblur\n\t0x1cb: 0x58a07, // onpause\n\t0x1cd: 0x5bc0c, // onratechange\n\t0x1ce: 0x10705, // aside\n\t0x1cf: 0x6cf07, // optimum\n\t0x1d1: 0x45809, // onkeydown\n\t0x1d2: 0x1c407, // colspan\n\t0x1d3: 0x1004, // main\n\t0x1d4: 0x66b03, // sub\n\t0x1d5: 0x25b06, // object\n\t0x1d6: 0x55c06, // search\n\t0x1d7: 0x37206, // sorted\n\t0x1d8: 0x17003, // big\n\t0x1d9: 0xb01, // u\n\t0x1db: 0x26b0c, // autocomplete\n\t0x1dc: 0xcc02, // tr\n\t0x1dd: 0xf303, // alt\n\t0x1df: 0x7804, // samp\n\t0x1e0: 0x5c812, // onrejectionhandled\n\t0x1e1: 0x4f30c, // onmouseleave\n\t0x1e2: 0x28007, // enctype\n\t0x1e3: 0xa208, // nomodule\n\t0x1e5: 0x3280f, // allowfullscreen\n\t0x1e6: 0x5f08, // optgroup\n\t0x1e8: 0x27c0b, // formenctype\n\t0x1e9: 0x18106, // legend\n\t0x1ea: 0x10306, // canvas\n\t0x1eb: 0x6607, // pattern\n\t0x1ec: 0x2c208, // noscript\n\t0x1ed: 0x601, // i\n\t0x1ee: 0x5d602, // dl\n\t0x1ef: 0xa702, // ul\n\t0x1f2: 0x52209, // onmouseup\n\t0x1f4: 0x1ba05, // track\n\t0x1f7: 0x3a10a, // ondblclick\n\t0x1f8: 0x3bf0a, // ondragexit\n\t0x1fa: 0x8703, // dfn\n\t0x1fc: 0x26506, // action\n\t0x1fd: 0x35004, // area\n\t0x1fe: 0x31607, // marquee\n\t0x1ff: 0x16d03, // var\n}\n\nconst atomText = \"abbradiogrouparamainavalueaccept-charsetbodyaccesskeygenobrb\" +\n\t\"asefontimeupdateviacacheightmlabelooptgroupatternoembedetail\" +\n\t\"sampictureversedfnoframesetdirnameterowspanomoduleacronymali\" +\n\t\"gnmarkbdialogallowpaymentrequestrikeytypeallowusermediagroup\" +\n\t\"ingaltfooterubyasyncanvasidefaultitleaudioncancelautofocusan\" +\n\t\"dboxmplaceholderautoplaysinlinebdoncanplaythrough1bgsoundisa\" +\n\t\"bledivarbigblinkindraggablegendblockquotebuttonabortcitempro\" +\n\t\"penoncecolgrouplaintextrackcolorcolspannotation-xmlcommandco\" +\n\t\"ntrolsectionblurcoordshapecrossoriginslotranslatefacenterfie\" +\n\t\"ldsetfigcaptionafterprintegrityfigurequiredforeignObjectfore\" +\n\t\"ignobjectformactionautocompleteerrorformenctypemustmatchalle\" +\n\t\"ngeformmethodformnovalidatetimeformtargethiddenoscripthigh3h\" +\n\t\"reflanghttp-equivideonclickiframeimageimglyph4isindexismappl\" +\n\t\"etitemtypemarqueematheadersmallowfullscreenmaxlength5minleng\" +\n\t\"th6mtextareadonlymultiplemutedoncloseamlessortedoncontextmen\" +\n\t\"uitemidoncopyoncuechangeoncutondblclickondragendondragentero\" +\n\t\"ndragexitemreferrerpolicyondragleaveondragoverondragstarticl\" +\n\t\"eondropzonemptiedondurationchangeonendedonerroronfocusourceo\" +\n\t\"nhashchangeoninputmodeloninvalidonkeydownloadonkeypresspacer\" +\n\t\"onkeyupreloadonlanguagechangeonloadeddatalistingonloadedmeta\" +\n\t\"databindexonloadendonloadstartonmessageerroronmousedownonmou\" +\n\t\"seenteronmouseleaveonmousemoveonmouseoutputonmouseoveronmous\" +\n\t\"eupromptonmousewheelonofflineononlineonpagehidesclassearch2o\" +\n\t\"npageshowbronpastepublicontenteditableonpausemaponplayingonp\" +\n\t\"opstateonprogresspellcheckedonratechangeonrejectionhandledon\" +\n\t\"resetonresizesrcdocodeferonscrollonsecuritypolicyviolationau\" +\n\t\"xclickonseekedonseekingonselectedonshowidthgrouposteronsorta\" +\n\t\"bleonstalledonstorageonsubmitemscopedonsuspendontoggleonunha\" +\n\t\"ndledrejectionbeforeprintonunloadonvolumechangeonwaitingonwh\" +\n\t\"eeloptimumanifestrongoptionbeforeunloaddressrclangsrcsetstyl\" +\n\t\"esummarysupsvgsystemplateworkertypewrap\"\n"
},
{
"path": "tests/vendor/golang.org/x/net/html/charset/charset.go",
"content": "// Copyright 2013 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n// Package charset provides common text encodings for HTML documents.\n//\n// The mapping from encoding labels to encodings is defined at\n// https://encoding.spec.whatwg.org/.\npackage charset // import \"golang.org/x/net/html/charset\"\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"io\"\n\t\"mime\"\n\t\"strings\"\n\t\"unicode/utf8\"\n\n\t\"golang.org/x/net/html\"\n\t\"golang.org/x/text/encoding\"\n\t\"golang.org/x/text/encoding/charmap\"\n\t\"golang.org/x/text/encoding/htmlindex\"\n\t\"golang.org/x/text/transform\"\n)\n\n// Lookup returns the encoding with the specified label, and its canonical\n// name. It returns nil and the empty string if label is not one of the\n// standard encodings for HTML. Matching is case-insensitive and ignores\n// leading and trailing whitespace. Encoders will use HTML escape sequences for\n// runes that are not supported by the character set.\nfunc Lookup(label string) (e encoding.Encoding, name string) {\n\te, err := htmlindex.Get(label)\n\tif err != nil {\n\t\treturn nil, \"\"\n\t}\n\tname, _ = htmlindex.Name(e)\n\treturn &htmlEncoding{e}, name\n}\n\ntype htmlEncoding struct{ encoding.Encoding }\n\nfunc (h *htmlEncoding) NewEncoder() *encoding.Encoder {\n\t// HTML requires a non-terminating legacy encoder. We use HTML escapes to\n\t// substitute unsupported code points.\n\treturn encoding.HTMLEscapeUnsupported(h.Encoding.NewEncoder())\n}\n\n// DetermineEncoding determines the encoding of an HTML document by examining\n// up to the first 1024 bytes of content and the declared Content-Type.\n//\n// See http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#determining-the-character-encoding\nfunc DetermineEncoding(content []byte, contentType string) (e encoding.Encoding, name string, certain bool) {\n\tif len(content) > 1024 {\n\t\tcontent = content[:1024]\n\t}\n\n\tfor _, b := range boms {\n\t\tif bytes.HasPrefix(content, b.bom) {\n\t\t\te, name = Lookup(b.enc)\n\t\t\treturn e, name, true\n\t\t}\n\t}\n\n\tif _, params, err := mime.ParseMediaType(contentType); err == nil {\n\t\tif cs, ok := params[\"charset\"]; ok {\n\t\t\tif e, name = Lookup(cs); e != nil {\n\t\t\t\treturn e, name, true\n\t\t\t}\n\t\t}\n\t}\n\n\tif len(content) > 0 {\n\t\te, name = prescan(content)\n\t\tif e != nil {\n\t\t\treturn e, name, false\n\t\t}\n\t}\n\n\t// Try to detect UTF-8.\n\t// First eliminate any partial rune at the end.\n\tfor i := len(content) - 1; i >= 0 && i > len(content)-4; i-- {\n\t\tb := content[i]\n\t\tif b < 0x80 {\n\t\t\tbreak\n\t\t}\n\t\tif utf8.RuneStart(b) {\n\t\t\tcontent = content[:i]\n\t\t\tbreak\n\t\t}\n\t}\n\thasHighBit := false\n\tfor _, c := range content {\n\t\tif c >= 0x80 {\n\t\t\thasHighBit = true\n\t\t\tbreak\n\t\t}\n\t}\n\tif hasHighBit && utf8.Valid(content) {\n\t\treturn encoding.Nop, \"utf-8\", false\n\t}\n\n\t// TODO: change default depending on user's locale?\n\treturn charmap.Windows1252, \"windows-1252\", false\n}\n\n// NewReader returns an io.Reader that converts the content of r to UTF-8.\n// It calls DetermineEncoding to find out what r's encoding is.\nfunc NewReader(r io.Reader, contentType string) (io.Reader, error) {\n\tpreview := make([]byte, 1024)\n\tn, err := io.ReadFull(r, preview)\n\tswitch {\n\tcase err == io.ErrUnexpectedEOF:\n\t\tpreview = preview[:n]\n\t\tr = bytes.NewReader(preview)\n\tcase err != nil:\n\t\treturn nil, err\n\tdefault:\n\t\tr = io.MultiReader(bytes.NewReader(preview), r)\n\t}\n\n\tif e, _, _ := DetermineEncoding(preview, contentType); e != encoding.Nop {\n\t\tr = transform.NewReader(r, e.NewDecoder())\n\t}\n\treturn r, nil\n}\n\n// NewReaderLabel returns a reader that converts from the specified charset to\n// UTF-8. It uses Lookup to find the encoding that corresponds to label, and\n// returns an error if Lookup returns nil. It is suitable for use as\n// encoding/xml.Decoder's CharsetReader function.\nfunc NewReaderLabel(label string, input io.Reader) (io.Reader, error) {\n\te, _ := Lookup(label)\n\tif e == nil {\n\t\treturn nil, fmt.Errorf(\"unsupported charset: %q\", label)\n\t}\n\treturn transform.NewReader(input, e.NewDecoder()), nil\n}\n\nfunc prescan(content []byte) (e encoding.Encoding, name string) {\n\tz := html.NewTokenizer(bytes.NewReader(content))\n\tfor {\n\t\tswitch z.Next() {\n\t\tcase html.ErrorToken:\n\t\t\treturn nil, \"\"\n\n\t\tcase html.StartTagToken, html.SelfClosingTagToken:\n\t\t\ttagName, hasAttr := z.TagName()\n\t\t\tif !bytes.Equal(tagName, []byte(\"meta\")) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tattrList := make(map[string]bool)\n\t\t\tgotPragma := false\n\n\t\t\tconst (\n\t\t\t\tdontKnow = iota\n\t\t\t\tdoNeedPragma\n\t\t\t\tdoNotNeedPragma\n\t\t\t)\n\t\t\tneedPragma := dontKnow\n\n\t\t\tname = \"\"\n\t\t\te = nil\n\t\t\tfor hasAttr {\n\t\t\t\tvar key, val []byte\n\t\t\t\tkey, val, hasAttr = z.TagAttr()\n\t\t\t\tks := string(key)\n\t\t\t\tif attrList[ks] {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tattrList[ks] = true\n\t\t\t\tfor i, c := range val {\n\t\t\t\t\tif 'A' <= c && c <= 'Z' {\n\t\t\t\t\t\tval[i] = c + 0x20\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\tswitch ks {\n\t\t\t\tcase \"http-equiv\":\n\t\t\t\t\tif bytes.Equal(val, []byte(\"content-type\")) {\n\t\t\t\t\t\tgotPragma = true\n\t\t\t\t\t}\n\n\t\t\t\tcase \"content\":\n\t\t\t\t\tif e == nil {\n\t\t\t\t\t\tname = fromMetaElement(string(val))\n\t\t\t\t\t\tif name != \"\" {\n\t\t\t\t\t\t\te, name = Lookup(name)\n\t\t\t\t\t\t\tif e != nil {\n\t\t\t\t\t\t\t\tneedPragma = doNeedPragma\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\tcase \"charset\":\n\t\t\t\t\te, name = Lookup(string(val))\n\t\t\t\t\tneedPragma = doNotNeedPragma\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif needPragma == dontKnow || needPragma == doNeedPragma && !gotPragma {\n\t\t\t\tcontinue\n\t\t\t}\n\n\t\t\tif strings.HasPrefix(name, \"utf-16\") {\n\t\t\t\tname = \"utf-8\"\n\t\t\t\te = encoding.Nop\n\t\t\t}\n\n\t\t\tif e != nil {\n\t\t\t\treturn e, name\n\t\t\t}\n\t\t}\n\t}\n}\n\nfunc fromMetaElement(s string) string {\n\tfor s != \"\" {\n\t\tcsLoc := strings.Index(s, \"charset\")\n\t\tif csLoc == -1 {\n\t\t\treturn \"\"\n\t\t}\n\t\ts = s[csLoc+len(\"charset\"):]\n\t\ts = strings.TrimLeft(s, \" \\t\\n\\f\\r\")\n\t\tif !strings.HasPrefix(s, \"=\") {\n\t\t\tcontinue\n\t\t}\n\t\ts = s[1:]\n\t\ts = strings.TrimLeft(s, \" \\t\\n\\f\\r\")\n\t\tif s == \"\" {\n\t\t\treturn \"\"\n\t\t}\n\t\tif q := s[0]; q == '\"' || q == '\\'' {\n\t\t\ts = s[1:]\n\t\t\tcloseQuote := strings.IndexRune(s, rune(q))\n\t\t\tif closeQuote == -1 {\n\t\t\t\treturn \"\"\n\t\t\t}\n\t\t\treturn s[:closeQuote]\n\t\t}\n\n\t\tend := strings.IndexAny(s, \"; \\t\\n\\f\\r\")\n\t\tif end == -1 {\n\t\t\tend = len(s)\n\t\t}\n\t\treturn s[:end]\n\t}\n\treturn \"\"\n}\n\nvar boms = []struct {\n\tbom []byte\n\tenc string\n}{\n\t{[]byte{0xfe, 0xff}, \"utf-16be\"},\n\t{[]byte{0xff, 0xfe}, \"utf-16le\"},\n\t{[]byte{0xef, 0xbb, 0xbf}, \"utf-8\"},\n}\n"
},
{
"path": "tests/vendor/golang.org/x/net/html/const.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage html\n\n// Section 12.2.4.2 of the HTML5 specification says \"The following elements\n// have varying levels of special parsing rules\".\n// https://html.spec.whatwg.org/multipage/syntax.html#the-stack-of-open-elements\nvar isSpecialElementMap = map[string]bool{\n\t\"address\": true,\n\t\"applet\": true,\n\t\"area\": true,\n\t\"article\": true,\n\t\"aside\": true,\n\t\"base\": true,\n\t\"basefont\": true,\n\t\"bgsound\": true,\n\t\"blockquote\": true,\n\t\"body\": true,\n\t\"br\": true,\n\t\"button\": true,\n\t\"caption\": true,\n\t\"center\": true,\n\t\"col\": true,\n\t\"colgroup\": true,\n\t\"dd\": true,\n\t\"details\": true,\n\t\"dir\": true,\n\t\"div\": true,\n\t\"dl\": true,\n\t\"dt\": true,\n\t\"embed\": true,\n\t\"fieldset\": true,\n\t\"figcaption\": true,\n\t\"figure\": true,\n\t\"footer\": true,\n\t\"form\": true,\n\t\"frame\": true,\n\t\"frameset\": true,\n\t\"h1\": true,\n\t\"h2\": true,\n\t\"h3\": true,\n\t\"h4\": true,\n\t\"h5\": true,\n\t\"h6\": true,\n\t\"head\": true,\n\t\"header\": true,\n\t\"hgroup\": true,\n\t\"hr\": true,\n\t\"html\": true,\n\t\"iframe\": true,\n\t\"img\": true,\n\t\"input\": true,\n\t\"keygen\": true, // \"keygen\" has been removed from the spec, but are kept here for backwards compatibility.\n\t\"li\": true,\n\t\"link\": true,\n\t\"listing\": true,\n\t\"main\": true,\n\t\"marquee\": true,\n\t\"menu\": true,\n\t\"meta\": true,\n\t\"nav\": true,\n\t\"noembed\": true,\n\t\"noframes\": true,\n\t\"noscript\": true,\n\t\"object\": true,\n\t\"ol\": true,\n\t\"p\": true,\n\t\"param\": true,\n\t\"plaintext\": true,\n\t\"pre\": true,\n\t\"script\": true,\n\t\"section\": true,\n\t\"select\": true,\n\t\"source\": true,\n\t\"style\": true,\n\t\"summary\": true,\n\t\"table\": true,\n\t\"tbody\": true,\n\t\"td\": true,\n\t\"template\": true,\n\t\"textarea\": true,\n\t\"tfoot\": true,\n\t\"th\": true,\n\t\"thead\": true,\n\t\"title\": true,\n\t\"tr\": true,\n\t\"track\": true,\n\t\"ul\": true,\n\t\"wbr\": true,\n\t\"xmp\": true,\n}\n\nfunc isSpecialElement(element *Node) bool {\n\tswitch element.Namespace {\n\tcase \"\", \"html\":\n\t\treturn isSpecialElementMap[element.Data]\n\tcase \"math\":\n\t\tswitch element.Data {\n\t\tcase \"mi\", \"mo\", \"mn\", \"ms\", \"mtext\", \"annotation-xml\":\n\t\t\treturn true\n\t\t}\n\tcase \"svg\":\n\t\tswitch element.Data {\n\t\tcase \"foreignObject\", \"desc\", \"title\":\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n"
},
{
"path": "tests/vendor/golang.org/x/net/html/doc.go",
"content": "// Copyright 2010 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\n/*\nPackage html implements an HTML5-compliant tokenizer and parser.\n\nTokenization is done by creating a Tokenizer for an io.Reader r. It is the\ncaller's responsibility to ensure that r provides UTF-8 encoded HTML.\n\n\tz := html.NewTokenizer(r)\n\nGiven a Tokenizer z, the HTML is tokenized by repeatedly calling z.Next(),\nwhich parses the next token and returns its type, or an error:\n\n\tfor {\n\t\ttt := z.Next()\n\t\tif tt == html.ErrorToken {\n\t\t\t// ...\n\t\t\treturn ...\n\t\t}\n\t\t// Process the current token.\n\t}\n\nThere are two APIs for retrieving the current token. The high-level API is to\ncall Token; the low-level API is to call Text or TagName / TagAttr. Both APIs\nallow optionally calling Raw after Next but before Token, Text, TagName, or\nTagAttr. In EBNF notation, the valid call sequence per token is:\n\n\tNext {Raw} [ Token | Text | TagName {TagAttr} ]\n\nToken returns an independent data structure that completely describes a token.\nEntities (such as \"<\") are unescaped, tag names and attribute keys are\nlower-cased, and attributes are collected into a []Attribute. For example:\n\n\tfor {\n\t\tif z.Next() == html.ErrorToken {\n\t\t\t// Returning io.EOF indicates success.\n\t\t\treturn z.Err()\n\t\t}\n\t\temitToken(z.Token())\n\t}\n\nThe low-level API performs fewer allocations and copies, but the contents of\nthe []byte values returned by Text, TagName and TagAttr may change on the next\ncall to Next. For example, to extract an HTML page's anchor text:\n\n\tdepth := 0\n\tfor {\n\t\ttt := z.Next()\n\t\tswitch tt {\n\t\tcase html.ErrorToken:\n\t\t\treturn z.Err()\n\t\tcase html.TextToken:\n\t\t\tif depth > 0 {\n\t\t\t\t// emitBytes should copy the []byte it receives,\n\t\t\t\t// if it doesn't process it immediately.\n\t\t\t\temitBytes(z.Text())\n\t\t\t}\n\t\tcase html.StartTagToken, html.EndTagToken:\n\t\t\ttn, _ := z.TagName()\n\t\t\tif len(tn) == 1 && tn[0] == 'a' {\n\t\t\t\tif tt == html.StartTagToken {\n\t\t\t\t\tdepth++\n\t\t\t\t} else {\n\t\t\t\t\tdepth--\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\nParsing is done by calling Parse with an io.Reader, which returns the root of\nthe parse tree (the document element) as a *Node. It is the caller's\nresponsibility to ensure that the Reader provides UTF-8 encoded HTML. For\nexample, to process each anchor node in depth-first order:\n\n\tdoc, err := html.Parse(r)\n\tif err != nil {\n\t\t// ...\n\t}\n\tfor n := range doc.Descendants() {\n\t\tif n.Type == html.ElementNode && n.Data == \"a\" {\n\t\t\t// Do something with n...\n\t\t}\n\t}\n\nThe relevant specifications include:\nhttps://html.spec.whatwg.org/multipage/syntax.html and\nhttps://html.spec.whatwg.org/multipage/syntax.html#tokenization\n\n# Security Considerations\n\nCare should be taken when parsing and interpreting HTML, whether full documents\nor fragments, within the framework of the HTML specification, especially with\nregard to untrusted inputs.\n\nThis package provides both a tokenizer and a parser, which implement the\ntokenization, and tokenization and tree construction stages of the WHATWG HTML\nparsing specification respectively. While the tokenizer parses and normalizes\nindividual HTML tokens, only the parser constructs the DOM tree from the\ntokenized HTML, as described in the tree construction stage of the\nspecification, dynamically modifying or extending the document's DOM tree.\n\nIf your use case requires semantically well-formed HTML documents, as defined by\nthe WHATWG specification, the parser should be used rather than the tokenizer.\n\nIn security contexts, if trust decisions are being made using the tokenized or\nparsed content, the input must be re-serialized (for instance by using Render or\nToken.String) in order for those trust decisions to hold, as the process of\ntokenization or parsing may alter the content.\n*/\npackage html // import \"golang.org/x/net/html\"\n\n// The tokenization algorithm implemented by this package is not a line-by-line\n// transliteration of the relatively verbose state-machine in the WHATWG\n// specification. A more direct approach is used instead, where the program\n// counter implies the state, such as whether it is tokenizing a tag or a text\n// node. Specification compliance is verified by checking expected and actual\n// outputs over a test suite rather than aiming for algorithmic fidelity.\n\n// TODO(nigeltao): Does a DOM API belong in this package or a separate one?\n// TODO(nigeltao): How does parsing interact with a JavaScript engine?\n"
},
{
"path": "tests/vendor/golang.org/x/net/html/doctype.go",
"content": "// Copyright 2011 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage html\n\nimport (\n\t\"strings\"\n)\n\n// parseDoctype parses the data from a DoctypeToken into a name,\n// public identifier, and system identifier. It returns a Node whose Type\n// is DoctypeNode, whose Data is the name, and which has attributes\n// named \"system\" and \"public\" for the two identifiers if they were present.\n// quirks is whether the document should be parsed in \"quirks mode\".\nfunc parseDoctype(s string) (n *Node, quirks bool) {\n\tn = &Node{Type: DoctypeNode}\n\n\t// Find the name.\n\tspace := strings.IndexAny(s, whitespace)\n\tif space == -1 {\n\t\tspace = len(s)\n\t}\n\tn.Data = s[:space]\n\t// The comparison to \"html\" is case-sensitive.\n\tif n.Data != \"html\" {\n\t\tquirks = true\n\t}\n\tn.Data = strings.ToLower(n.Data)\n\ts = strings.TrimLeft(s[space:], whitespace)\n\n\tif len(s) < 6 {\n\t\t// It can't start with \"PUBLIC\" or \"SYSTEM\".\n\t\t// Ignore the rest of the string.\n\t\treturn n, quirks || s != \"\"\n\t}\n\n\tkey := strings.ToLower(s[:6])\n\ts = s[6:]\n\tfor key == \"public\" || key == \"system\" {\n\t\ts = strings.TrimLeft(s, whitespace)\n\t\tif s == \"\" {\n\t\t\tbreak\n\t\t}\n\t\tquote := s[0]\n\t\tif quote != '\"' && quote != '\\'' {\n\t\t\tbreak\n\t\t}\n\t\ts = s[1:]\n\t\tq := strings.IndexRune(s, rune(quote))\n\t\tvar id string\n\t\tif q == -1 {\n\t\t\tid = s\n\t\t\ts = \"\"\n\t\t} else {\n\t\t\tid = s[:q]\n\t\t\ts = s[q+1:]\n\t\t}\n\t\tn.Attr = append(n.Attr, Attribute{Key: key, Val: id})\n\t\tif key == \"public\" {\n\t\t\tkey = \"system\"\n\t\t} else {\n\t\t\tkey = \"\"\n\t\t}\n\t}\n\n\tif key != \"\" || s != \"\" {\n\t\tquirks = true\n\t} else if len(n.Attr) > 0 {\n\t\tif n.Attr[0].Key == \"public\" {\n\t\t\tpublic := strings.ToLower(n.Attr[0].Val)\n\t\t\tswitch public {\n\t\t\tcase \"-//w3o//dtd w3 html strict 3.0//en//\", \"-/w3d/dtd html 4.0 transitional/en\", \"html\":\n\t\t\t\tquirks = true\n\t\t\tdefault:\n\t\t\t\tfor _, q := range quirkyIDs {\n\t\t\t\t\tif strings.HasPrefix(public, q) {\n\t\t\t\t\t\tquirks = true\n\t\t\t\t\t\tbreak\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\t// The following two public IDs only cause quirks mode if there is no system ID.\n\t\t\tif len(n.Attr) == 1 && (strings.HasPrefix(public, \"-//w3c//dtd html 4.01 frameset//\") ||\n\t\t\t\tstrings.HasPrefix(public, \"-//w3c//dtd html 4.01 transitional//\")) {\n\t\t\t\tquirks = true\n\t\t\t}\n\t\t}\n\t\tif lastAttr := n.Attr[len(n.Attr)-1]; lastAttr.Key == \"system\" &&\n\t\t\tstrings.EqualFold(lastAttr.Val, \"http://www.ibm.com/data/dtd/v11/ibmxhtml1-transitional.dtd\") {\n\t\t\tquirks = true\n\t\t}\n\t}\n\n\treturn n, quirks\n}\n\n// quirkyIDs is a list of public doctype identifiers that cause a document\n// to be interpreted in quirks mode. The identifiers should be in lower case.\nvar quirkyIDs = []string{\n\t\"+//silmaril//dtd html pro v0r11 19970101//\",\n\t\"-//advasoft ltd//dtd html 3.0 aswedit + extensions//\",\n\t\"-//as//dtd html 3.0 aswedit + extensions//\",\n\t\"-//ietf//dtd html 2.0 level 1//\",\n\t\"-//ietf//dtd html 2.0 level 2//\",\n\t\"-//ietf//dtd html 2.0 strict level 1//\",\n\t\"-//ietf//dtd html 2.0 strict level 2//\",\n\t\"-//ietf//dtd html 2.0 strict//\",\n\t\"-//ietf//dtd html 2.0//\",\n\t\"-//ietf//dtd html 2.1e//\",\n\t\"-//ietf//dtd html 3.0//\",\n\t\"-//ietf//dtd html 3.2 final//\",\n\t\"-//ietf//dtd html 3.2//\",\n\t\"-//ietf//dtd html 3//\",\n\t\"-//ietf//dtd html level 0//\",\n\t\"-//ietf//dtd html level 1//\",\n\t\"-//ietf//dtd html level 2//\",\n\t\"-//ietf//dtd html level 3//\",\n\t\"-//ietf//dtd html strict level 0//\",\n\t\"-//ietf//dtd html strict level 1//\",\n\t\"-//ietf//dtd html strict level 2//\",\n\t\"-//ietf//dtd html strict level 3//\",\n\t\"-//ietf//dtd html strict//\",\n\t\"-//ietf//dtd html//\",\n\t\"-//metrius//dtd metrius presentational//\",\n\t\"-//microsoft//dtd internet explorer 2.0 html strict//\",\n\t\"-//microsoft//dtd internet explorer 2.0 html//\",\n\t\"-//microsoft//dtd internet explorer 2.0 tables//\",\n\t\"-//microsoft//dtd internet explorer 3.0 html strict//\",\n\t\"-//microsoft//dtd internet explorer 3.0 html//\",\n\t\"-//microsoft//dtd internet explorer 3.0 tables//\",\n\t\"-//netscape comm. corp.//dtd html//\",\n\t\"-//netscape comm. corp.//dtd strict html//\",\n\t\"-//o'reilly and associates//dtd html 2.0//\",\n\t\"-//o'reilly and associates//dtd html extended 1.0//\",\n\t\"-//o'reilly and associates//dtd html extended relaxed 1.0//\",\n\t\"-//softquad software//dtd hotmetal pro 6.0::19990601::extensions to html 4.0//\",\n\t\"-//softquad//dtd hotmetal pro 4.0::19971010::extensions to html 4.0//\",\n\t\"-//spyglass//dtd html 2.0 extended//\",\n\t\"-//sq//dtd html 2.0 hotmetal + extensions//\",\n\t\"-//sun microsystems corp.//dtd hotjava html//\",\n\t\"-//sun microsystems corp.//dtd hotjava strict html//\",\n\t\"-//w3c//dtd html 3 1995-03-24//\",\n\t\"-//w3c//dtd html 3.2 draft//\",\n\t\"-//w3c//dtd html 3.2 final//\",\n\t\"-//w3c//dtd html 3.2//\",\n\t\"-//w3c//dtd html 3.2s draft//\",\n\t\"-//w3c//dtd html 4.0 frameset//\",\n\t\"-//w3c//dtd html 4.0 transitional//\",\n\t\"-//w3c//dtd html experimental 19960712//\",\n\t\"-//w3c//dtd html experimental 970421//\",\n\t\"-//w3c//dtd w3 html//\",\n\t\"-//w3o//dtd w3 html 3.0//\",\n\t\"-//webtechs//dtd mozilla html 2.0//\",\n\t\"-//webtechs//dtd mozilla html//\",\n}\n"
},
{
"path": "tests/vendor/golang.org/x/net/html/entity.go",
"content": "// Copyright 2010 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage html\n\n// All entities that do not end with ';' are 6 or fewer bytes long.\nconst longestEntityWithoutSemicolon = 6\n\n// entity is a map from HTML entity names to their values. The semicolon matters:\n// https://html.spec.whatwg.org/multipage/syntax.html#named-character-references\n// lists both \"amp\" and \"amp;\" as two separate entries.\n//\n// Note that the HTML5 list is larger than the HTML4 list at\n// http://www.w3.org/TR/html4/sgml/entities.html\nvar entity = map[string]rune{\n\t\"AElig;\": '\\U000000C6',\n\t\"AMP;\": '\\U00000026',\n\t\"Aacute;\": '\\U000000C1',\n\t\"Abreve;\": '\\U00000102',\n\t\"Acirc;\": '\\U000000C2',\n\t\"Acy;\": '\\U00000410',\n\t\"Afr;\": '\\U0001D504',\n\t\"Agrave;\": '\\U000000C0',\n\t\"Alpha;\": '\\U00000391',\n\t\"Amacr;\": '\\U00000100',\n\t\"And;\": '\\U00002A53',\n\t\"Aogon;\": '\\U00000104',\n\t\"Aopf;\": '\\U0001D538',\n\t\"ApplyFunction;\": '\\U00002061',\n\t\"Aring;\": '\\U000000C5',\n\t\"Ascr;\": '\\U0001D49C',\n\t\"Assign;\": '\\U00002254',\n\t\"Atilde;\": '\\U000000C3',\n\t\"Auml;\": '\\U000000C4',\n\t\"Backslash;\": '\\U00002216',\n\t\"Barv;\": '\\U00002AE7',\n\t\"Barwed;\": '\\U00002306',\n\t\"Bcy;\": '\\U00000411',\n\t\"Because;\": '\\U00002235',\n\t\"Bernoullis;\": '\\U0000212C',\n\t\"Beta;\": '\\U00000392',\n\t\"Bfr;\": '\\U0001D505',\n\t\"Bopf;\": '\\U0001D539',\n\t\"Breve;\": '\\U000002D8',\n\t\"Bscr;\": '\\U0000212C',\n\t\"Bumpeq;\": '\\U0000224E',\n\t\"CHcy;\": '\\U00000427',\n\t\"COPY;\": '\\U000000A9',\n\t\"Cacute;\": '\\U00000106',\n\t\"Cap;\": '\\U000022D2',\n\t\"CapitalDifferentialD;\": '\\U00002145',\n\t\"Cayleys;\": '\\U0000212D',\n\t\"Ccaron;\": '\\U0000010C',\n\t\"Ccedil;\": '\\U000000C7',\n\t\"Ccirc;\": '\\U00000108',\n\t\"Cconint;\": '\\U00002230',\n\t\"Cdot;\": '\\U0000010A',\n\t\"Cedilla;\": '\\U000000B8',\n\t\"CenterDot;\": '\\U000000B7',\n\t\"Cfr;\": '\\U0000212D',\n\t\"Chi;\": '\\U000003A7',\n\t\"CircleDot;\": '\\U00002299',\n\t\"CircleMinus;\": '\\U00002296',\n\t\"CirclePlus;\": '\\U00002295',\n\t\"CircleTimes;\": '\\U00002297',\n\t\"ClockwiseContourIntegral;\": '\\U00002232',\n\t\"CloseCurlyDoubleQuote;\": '\\U0000201D',\n\t\"CloseCurlyQuote;\": '\\U00002019',\n\t\"Colon;\": '\\U00002237',\n\t\"Colone;\": '\\U00002A74',\n\t\"Congruent;\": '\\U00002261',\n\t\"Conint;\": '\\U0000222F',\n\t\"ContourIntegral;\": '\\U0000222E',\n\t\"Copf;\": '\\U00002102',\n\t\"Coproduct;\": '\\U00002210',\n\t\"CounterClockwiseContourIntegral;\": '\\U00002233',\n\t\"Cross;\": '\\U00002A2F',\n\t\"Cscr;\": '\\U0001D49E',\n\t\"Cup;\": '\\U000022D3',\n\t\"CupCap;\": '\\U0000224D',\n\t\"DD;\": '\\U00002145',\n\t\"DDotrahd;\": '\\U00002911',\n\t\"DJcy;\": '\\U00000402',\n\t\"DScy;\": '\\U00000405',\n\t\"DZcy;\": '\\U0000040F',\n\t\"Dagger;\": '\\U00002021',\n\t\"Darr;\": '\\U000021A1',\n\t\"Dashv;\": '\\U00002AE4',\n\t\"Dcaron;\": '\\U0000010E',\n\t\"Dcy;\": '\\U00000414',\n\t\"Del;\": '\\U00002207',\n\t\"Delta;\": '\\U00000394',\n\t\"Dfr;\": '\\U0001D507',\n\t\"DiacriticalAcute;\": '\\U000000B4',\n\t\"DiacriticalDot;\": '\\U000002D9',\n\t\"DiacriticalDoubleAcute;\": '\\U000002DD',\n\t\"DiacriticalGrave;\": '\\U00000060',\n\t\"DiacriticalTilde;\": '\\U000002DC',\n\t\"Diamond;\": '\\U000022C4',\n\t\"DifferentialD;\": '\\U00002146',\n\t\"Dopf;\": '\\U0001D53B',\n\t\"Dot;\": '\\U000000A8',\n\t\"DotDot;\": '\\U000020DC',\n\t\"DotEqual;\": '\\U00002250',\n\t\"DoubleContourIntegral;\": '\\U0000222F',\n\t\"DoubleDot;\": '\\U000000A8',\n\t\"DoubleDownArrow;\": '\\U000021D3',\n\t\"DoubleLeftArrow;\": '\\U000021D0',\n\t\"DoubleLeftRightArrow;\": '\\U000021D4',\n\t\"DoubleLeftTee;\": '\\U00002AE4',\n\t\"DoubleLongLeftArrow;\": '\\U000027F8',\n\t\"DoubleLongLeftRightArrow;\": '\\U000027FA',\n\t\"DoubleLongRightArrow;\": '\\U000027F9',\n\t\"DoubleRightArrow;\": '\\U000021D2',\n\t\"DoubleRightTee;\": '\\U000022A8',\n\t\"DoubleUpArrow;\": '\\U000021D1',\n\t\"DoubleUpDownArrow;\": '\\U000021D5',\n\t\"DoubleVerticalBar;\": '\\U00002225',\n\t\"DownArrow;\": '\\U00002193',\n\t\"DownArrowBar;\": '\\U00002913',\n\t\"DownArrowUpArrow;\": '\\U000021F5',\n\t\"DownBreve;\": '\\U00000311',\n\t\"DownLeftRightVector;\": '\\U00002950',\n\t\"DownLeftTeeVector;\": '\\U0000295E',\n\t\"DownLeftVector;\": '\\U000021BD',\n\t\"DownLeftVectorBar;\": '\\U00002956',\n\t\"DownRightTeeVector;\": '\\U0000295F',\n\t\"DownRightVector;\": '\\U000021C1',\n\t\"DownRightVectorBar;\": '\\U00002957',\n\t\"DownTee;\": '\\U000022A4',\n\t\"DownTeeArrow;\": '\\U000021A7',\n\t\"Downarrow;\": '\\U000021D3',\n\t\"Dscr;\": '\\U0001D49F',\n\t\"Dstrok;\": '\\U00000110',\n\t\"ENG;\": '\\U0000014A',\n\t\"ETH;\": '\\U000000D0',\n\t\"Eacute;\": '\\U000000C9',\n\t\"Ecaron;\": '\\U0000011A',\n\t\"Ecirc;\": '\\U000000CA',\n\t\"Ecy;\": '\\U0000042D',\n\t\"Edot;\": '\\U00000116',\n\t\"Efr;\": '\\U0001D508',\n\t\"Egrave;\": '\\U000000C8',\n\t\"Element;\": '\\U00002208',\n\t\"Emacr;\": '\\U00000112',\n\t\"EmptySmallSquare;\": '\\U000025FB',\n\t\"EmptyVerySmallSquare;\": '\\U000025AB',\n\t\"Eogon;\": '\\U00000118',\n\t\"Eopf;\": '\\U0001D53C',\n\t\"Epsilon;\": '\\U00000395',\n\t\"Equal;\": '\\U00002A75',\n\t\"EqualTilde;\": '\\U00002242',\n\t\"Equilibrium;\": '\\U000021CC',\n\t\"Escr;\": '\\U00002130',\n\t\"Esim;\": '\\U00002A73',\n\t\"Eta;\": '\\U00000397',\n\t\"Euml;\": '\\U000000CB',\n\t\"Exists;\": '\\U00002203',\n\t\"ExponentialE;\": '\\U00002147',\n\t\"Fcy;\": '\\U00000424',\n\t\"Ffr;\": '\\U0001D509',\n\t\"FilledSmallSquare;\": '\\U000025FC',\n\t\"FilledVerySmallSquare;\": '\\U000025AA',\n\t\"Fopf;\": '\\U0001D53D',\n\t\"ForAll;\": '\\U00002200',\n\t\"Fouriertrf;\": '\\U00002131',\n\t\"Fscr;\": '\\U00002131',\n\t\"GJcy;\": '\\U00000403',\n\t\"GT;\": '\\U0000003E',\n\t\"Gamma;\": '\\U00000393',\n\t\"Gammad;\": '\\U000003DC',\n\t\"Gbreve;\": '\\U0000011E',\n\t\"Gcedil;\": '\\U00000122',\n\t\"Gcirc;\": '\\U0000011C',\n\t\"Gcy;\": '\\U00000413',\n\t\"Gdot;\": '\\U00000120',\n\t\"Gfr;\": '\\U0001D50A',\n\t\"Gg;\": '\\U000022D9',\n\t\"Gopf;\": '\\U0001D53E',\n\t\"GreaterEqual;\": '\\U00002265',\n\t\"GreaterEqualLess;\": '\\U000022DB',\n\t\"GreaterFullEqual;\": '\\U00002267',\n\t\"GreaterGreater;\": '\\U00002AA2',\n\t\"GreaterLess;\": '\\U00002277',\n\t\"GreaterSlantEqual;\": '\\U00002A7E',\n\t\"GreaterTilde;\": '\\U00002273',\n\t\"Gscr;\": '\\U0001D4A2',\n\t\"Gt;\": '\\U0000226B',\n\t\"HARDcy;\": '\\U0000042A',\n\t\"Hacek;\": '\\U000002C7',\n\t\"Hat;\": '\\U0000005E',\n\t\"Hcirc;\": '\\U00000124',\n\t\"Hfr;\": '\\U0000210C',\n\t\"HilbertSpace;\": '\\U0000210B',\n\t\"Hopf;\": '\\U0000210D',\n\t\"HorizontalLine;\": '\\U00002500',\n\t\"Hscr;\": '\\U0000210B',\n\t\"Hstrok;\": '\\U00000126',\n\t\"HumpDownHump;\": '\\U0000224E',\n\t\"HumpEqual;\": '\\U0000224F',\n\t\"IEcy;\": '\\U00000415',\n\t\"IJlig;\": '\\U00000132',\n\t\"IOcy;\": '\\U00000401',\n\t\"Iacute;\": '\\U000000CD',\n\t\"Icirc;\": '\\U000000CE',\n\t\"Icy;\": '\\U00000418',\n\t\"Idot;\": '\\U00000130',\n\t\"Ifr;\": '\\U00002111',\n\t\"Igrave;\": '\\U000000CC',\n\t\"Im;\": '\\U00002111',\n\t\"Imacr;\": '\\U0000012A',\n\t\"ImaginaryI;\": '\\U00002148',\n\t\"Implies;\": '\\U000021D2',\n\t\"Int;\": '\\U0000222C',\n\t\"Integral;\": '\\U0000222B',\n\t\"Intersection;\": '\\U000022C2',\n\t\"InvisibleComma;\": '\\U00002063',\n\t\"InvisibleTimes;\": '\\U00002062',\n\t\"Iogon;\": '\\U0000012E',\n\t\"Iopf;\": '\\U0001D540',\n\t\"Iota;\": '\\U00000399',\n\t\"Iscr;\": '\\U00002110',\n\t\"Itilde;\": '\\U00000128',\n\t\"Iukcy;\": '\\U00000406',\n\t\"Iuml;\": '\\U000000CF',\n\t\"Jcirc;\": '\\U00000134',\n\t\"Jcy;\": '\\U00000419',\n\t\"Jfr;\": '\\U0001D50D',\n\t\"Jopf;\": '\\U0001D541',\n\t\"Jscr;\": '\\U0001D4A5',\n\t\"Jsercy;\": '\\U00000408',\n\t\"Jukcy;\": '\\U00000404',\n\t\"KHcy;\": '\\U00000425',\n\t\"KJcy;\": '\\U0000040C',\n\t\"Kappa;\": '\\U0000039A',\n\t\"Kcedil;\": '\\U00000136',\n\t\"Kcy;\": '\\U0000041A',\n\t\"Kfr;\": '\\U0001D50E',\n\t\"Kopf;\": '\\U0001D542',\n\t\"Kscr;\": '\\U0001D4A6',\n\t\"LJcy;\": '\\U00000409',\n\t\"LT;\": '\\U0000003C',\n\t\"Lacute;\": '\\U00000139',\n\t\"Lambda;\": '\\U0000039B',\n\t\"Lang;\": '\\U000027EA',\n\t\"Laplacetrf;\": '\\U00002112',\n\t\"Larr;\": '\\U0000219E',\n\t\"Lcaron;\": '\\U0000013D',\n\t\"Lcedil;\": '\\U0000013B',\n\t\"Lcy;\": '\\U0000041B',\n\t\"LeftAngleBracket;\": '\\U000027E8',\n\t\"LeftArrow;\": '\\U00002190',\n\t\"LeftArrowBar;\": '\\U000021E4',\n\t\"LeftArrowRightArrow;\": '\\U000021C6',\n\t\"LeftCeiling;\": '\\U00002308',\n\t\"LeftDoubleBracket;\": '\\U000027E6',\n\t\"LeftDownTeeVector;\": '\\U00002961',\n\t\"LeftDownVector;\": '\\U000021C3',\n\t\"LeftDownVectorBar;\": '\\U00002959',\n\t\"LeftFloor;\": '\\U0000230A',\n\t\"LeftRightArrow;\": '\\U00002194',\n\t\"LeftRightVector;\": '\\U0000294E',\n\t\"LeftTee;\": '\\U000022A3',\n\t\"LeftTeeArrow;\": '\\U000021A4',\n\t\"LeftTeeVector;\": '\\U0000295A',\n\t\"LeftTriangle;\": '\\U000022B2',\n\t\"LeftTriangleBar;\": '\\U000029CF',\n\t\"LeftTriangleEqual;\": '\\U000022B4',\n\t\"LeftUpDownVector;\": '\\U00002951',\n\t\"LeftUpTeeVector;\": '\\U00002960',\n\t\"LeftUpVector;\": '\\U000021BF',\n\t\"LeftUpVectorBar;\": '\\U00002958',\n\t\"LeftVector;\": '\\U000021BC',\n\t\"LeftVectorBar;\": '\\U00002952',\n\t\"Leftarrow;\": '\\U000021D0',\n\t\"Leftrightarrow;\": '\\U000021D4',\n\t\"LessEqualGreater;\": '\\U000022DA',\n\t\"LessFullEqual;\": '\\U00002266',\n\t\"LessGreater;\": '\\U00002276',\n\t\"LessLess;\": '\\U00002AA1',\n\t\"LessSlantEqual;\": '\\U00002A7D',\n\t\"LessTilde;\": '\\U00002272',\n\t\"Lfr;\": '\\U0001D50F',\n\t\"Ll;\": '\\U000022D8',\n\t\"Lleftarrow;\": '\\U000021DA',\n\t\"Lmidot;\": '\\U0000013F',\n\t\"LongLeftArrow;\": '\\U000027F5',\n\t\"LongLeftRightArrow;\": '\\U000027F7',\n\t\"LongRightArrow;\": '\\U000027F6',\n\t\"Longleftarrow;\": '\\U000027F8',\n\t\"Longleftrightarrow;\": '\\U000027FA',\n\t\"Longrightarrow;\": '\\U000027F9',\n\t\"Lopf;\": '\\U0001D543',\n\t\"LowerLeftArrow;\": '\\U00002199',\n\t\"LowerRightArrow;\": '\\U00002198',\n\t\"Lscr;\": '\\U00002112',\n\t\"Lsh;\": '\\U000021B0',\n\t\"Lstrok;\": '\\U00000141',\n\t\"Lt;\": '\\U0000226A',\n\t\"Map;\": '\\U00002905',\n\t\"Mcy;\": '\\U0000041C',\n\t\"MediumSpace;\": '\\U0000205F',\n\t\"Mellintrf;\": '\\U00002133',\n\t\"Mfr;\": '\\U0001D510',\n\t\"MinusPlus;\": '\\U00002213',\n\t\"Mopf;\": '\\U0001D544',\n\t\"Mscr;\": '\\U00002133',\n\t\"Mu;\": '\\U0000039C',\n\t\"NJcy;\": '\\U0000040A',\n\t\"Nacute;\": '\\U00000143',\n\t\"Ncaron;\": '\\U00000147',\n\t\"Ncedil;\": '\\U00000145',\n\t\"Ncy;\": '\\U0000041D',\n\t\"NegativeMediumSpace;\": '\\U0000200B',\n\t\"NegativeThickSpace;\": '\\U0000200B',\n\t\"NegativeThinSpace;\": '\\U0000200B',\n\t\"NegativeVeryThinSpace;\": '\\U0000200B',\n\t\"NestedGreaterGreater;\": '\\U0000226B',\n\t\"NestedLessLess;\": '\\U0000226A',\n\t\"NewLine;\": '\\U0000000A',\n\t\"Nfr;\": '\\U0001D511',\n\t\"NoBreak;\": '\\U00002060',\n\t\"NonBreakingSpace;\": '\\U000000A0',\n\t\"Nopf;\": '\\U00002115',\n\t\"Not;\": '\\U00002AEC',\n\t\"NotCongruent;\": '\\U00002262',\n\t\"NotCupCap;\": '\\U0000226D',\n\t\"NotDoubleVerticalBar;\": '\\U00002226',\n\t\"NotElement;\": '\\U00002209',\n\t\"NotEqual;\": '\\U00002260',\n\t\"NotExists;\": '\\U00002204',\n\t\"NotGreater;\": '\\U0000226F',\n\t\"NotGreaterEqual;\": '\\U00002271',\n\t\"NotGreaterLess;\": '\\U00002279',\n\t\"NotGreaterTilde;\": '\\U00002275',\n\t\"NotLeftTriangle;\": '\\U000022EA',\n\t\"NotLeftTriangleEqual;\": '\\U000022EC',\n\t\"NotLess;\": '\\U0000226E',\n\t\"NotLessEqual;\": '\\U00002270',\n\t\"NotLessGreater;\": '\\U00002278',\n\t\"NotLessTilde;\": '\\U00002274',\n\t\"NotPrecedes;\": '\\U00002280',\n\t\"NotPrecedesSlantEqual;\": '\\U000022E0',\n\t\"NotReverseElement;\": '\\U0000220C',\n\t\"NotRightTriangle;\": '\\U000022EB',\n\t\"NotRightTriangleEqual;\": '\\U000022ED',\n\t\"NotSquareSubsetEqual;\": '\\U000022E2',\n\t\"NotSquareSupersetEqual;\": '\\U000022E3',\n\t\"NotSubsetEqual;\": '\\U00002288',\n\t\"NotSucceeds;\": '\\U00002281',\n\t\"NotSucceedsSlantEqual;\": '\\U000022E1',\n\t\"NotSupersetEqual;\": '\\U00002289',\n\t\"NotTilde;\": '\\U00002241',\n\t\"NotTildeEqual;\": '\\U00002244',\n\t\"NotTildeFullEqual;\": '\\U00002247',\n\t\"NotTildeTilde;\": '\\U00002249',\n\t\"NotVerticalBar;\": '\\U00002224',\n\t\"Nscr;\": '\\U0001D4A9',\n\t\"Ntilde;\": '\\U000000D1',\n\t\"Nu;\": '\\U0000039D',\n\t\"OElig;\": '\\U00000152',\n\t\"Oacute;\": '\\U000000D3',\n\t\"Ocirc;\": '\\U000000D4',\n\t\"Ocy;\": '\\U0000041E',\n\t\"Odblac;\": '\\U00000150',\n\t\"Ofr;\": '\\U0001D512',\n\t\"Ograve;\": '\\U000000D2',\n\t\"Omacr;\": '\\U0000014C',\n\t\"Omega;\": '\\U000003A9',\n\t\"Omicron;\": '\\U0000039F',\n\t\"Oopf;\": '\\U0001D546',\n\t\"OpenCurlyDoubleQuote;\": '\\U0000201C',\n\t\"OpenCurlyQuote;\": '\\U00002018',\n\t\"Or;\": '\\U00002A54',\n\t\"Oscr;\": '\\U0001D4AA',\n\t\"Oslash;\": '\\U000000D8',\n\t\"Otilde;\": '\\U000000D5',\n\t\"Otimes;\": '\\U00002A37',\n\t\"Ouml;\": '\\U000000D6',\n\t\"OverBar;\": '\\U0000203E',\n\t\"OverBrace;\": '\\U000023DE',\n\t\"OverBracket;\": '\\U000023B4',\n\t\"OverParenthesis;\": '\\U000023DC',\n\t\"PartialD;\": '\\U00002202',\n\t\"Pcy;\": '\\U0000041F',\n\t\"Pfr;\": '\\U0001D513',\n\t\"Phi;\": '\\U000003A6',\n\t\"Pi;\": '\\U000003A0',\n\t\"PlusMinus;\": '\\U000000B1',\n\t\"Poincareplane;\": '\\U0000210C',\n\t\"Popf;\": '\\U00002119',\n\t\"Pr;\": '\\U00002ABB',\n\t\"Precedes;\": '\\U0000227A',\n\t\"PrecedesEqual;\": '\\U00002AAF',\n\t\"PrecedesSlantEqual;\": '\\U0000227C',\n\t\"PrecedesTilde;\": '\\U0000227E',\n\t\"Prime;\": '\\U00002033',\n\t\"Product;\": '\\U0000220F',\n\t\"Proportion;\": '\\U00002237',\n\t\"Proportional;\": '\\U0000221D',\n\t\"Pscr;\": '\\U0001D4AB',\n\t\"Psi;\": '\\U000003A8',\n\t\"QUOT;\": '\\U00000022',\n\t\"Qfr;\": '\\U0001D514',\n\t\"Qopf;\": '\\U0000211A',\n\t\"Qscr;\": '\\U0001D4AC',\n\t\"RBarr;\": '\\U00002910',\n\t\"REG;\": '\\U000000AE',\n\t\"Racute;\": '\\U00000154',\n\t\"Rang;\": '\\U000027EB',\n\t\"Rarr;\": '\\U000021A0',\n\t\"Rarrtl;\": '\\U00002916',\n\t\"Rcaron;\": '\\U00000158',\n\t\"Rcedil;\": '\\U00000156',\n\t\"Rcy;\": '\\U00000420',\n\t\"Re;\": '\\U0000211C',\n\t\"ReverseElement;\": '\\U0000220B',\n\t\"ReverseEquilibrium;\": '\\U000021CB',\n\t\"ReverseUpEquilibrium;\": '\\U0000296F',\n\t\"Rfr;\": '\\U0000211C',\n\t\"Rho;\": '\\U000003A1',\n\t\"RightAngleBracket;\": '\\U000027E9',\n\t\"RightArrow;\": '\\U00002192',\n\t\"RightArrowBar;\": '\\U000021E5',\n\t\"RightArrowLeftArrow;\": '\\U000021C4',\n\t\"RightCeiling;\": '\\U00002309',\n\t\"RightDoubleBracket;\": '\\U000027E7',\n\t\"RightDownTeeVector;\": '\\U0000295D',\n\t\"RightDownVector;\": '\\U000021C2',\n\t\"RightDownVectorBar;\": '\\U00002955',\n\t\"RightFloor;\": '\\U0000230B',\n\t\"RightTee;\": '\\U000022A2',\n\t\"RightTeeArrow;\": '\\U000021A6',\n\t\"RightTeeVector;\": '\\U0000295B',\n\t\"RightTriangle;\": '\\U000022B3',\n\t\"RightTriangleBar;\": '\\U000029D0',\n\t\"RightTriangleEqual;\": '\\U000022B5',\n\t\"RightUpDownVector;\": '\\U0000294F',\n\t\"RightUpTeeVector;\": '\\U0000295C',\n\t\"RightUpVector;\": '\\U000021BE',\n\t\"RightUpVectorBar;\": '\\U00002954',\n\t\"RightVector;\": '\\U000021C0',\n\t\"RightVectorBar;\": '\\U00002953',\n\t\"Rightarrow;\": '\\U000021D2',\n\t\"Ropf;\": '\\U0000211D',\n\t\"RoundImplies;\": '\\U00002970',\n\t\"Rrightarrow;\": '\\U000021DB',\n\t\"Rscr;\": '\\U0000211B',\n\t\"Rsh;\": '\\U000021B1',\n\t\"RuleDelayed;\": '\\U000029F4',\n\t\"SHCHcy;\": '\\U00000429',\n\t\"SHcy;\": '\\U00000428',\n\t\"SOFTcy;\": '\\U0000042C',\n\t\"Sacute;\": '\\U0000015A',\n\t\"Sc;\": '\\U00002ABC',\n\t\"Scaron;\": '\\U00000160',\n\t\"Scedil;\": '\\U0000015E',\n\t\"Scirc;\": '\\U0000015C',\n\t\"Scy;\": '\\U00000421',\n\t\"Sfr;\": '\\U0001D516',\n\t\"ShortDownArrow;\": '\\U00002193',\n\t\"ShortLeftArrow;\": '\\U00002190',\n\t\"ShortRightArrow;\": '\\U00002192',\n\t\"ShortUpArrow;\": '\\U00002191',\n\t\"Sigma;\": '\\U000003A3',\n\t\"SmallCircle;\": '\\U00002218',\n\t\"Sopf;\": '\\U0001D54A',\n\t\"Sqrt;\": '\\U0000221A',\n\t\"Square;\": '\\U000025A1',\n\t\"SquareIntersection;\": '\\U00002293',\n\t\"SquareSubset;\": '\\U0000228F',\n\t\"SquareSubsetEqual;\": '\\U00002291',\n\t\"SquareSuperset;\": '\\U00002290',\n\t\"SquareSupersetEqual;\": '\\U00002292',\n\t\"SquareUnion;\": '\\U00002294',\n\t\"Sscr;\": '\\U0001D4AE',\n\t\"Star;\": '\\U000022C6',\n\t\"Sub;\": '\\U000022D0',\n\t\"Subset;\": '\\U000022D0',\n\t\"SubsetEqual;\": '\\U00002286',\n\t\"Succeeds;\": '\\U0000227B',\n\t\"SucceedsEqual;\": '\\U00002AB0',\n\t\"SucceedsSlantEqual;\": '\\U0000227D',\n\t\"SucceedsTilde;\": '\\U0000227F',\n\t\"SuchThat;\": '\\U0000220B',\n\t\"Sum;\": '\\U00002211',\n\t\"Sup;\": '\\U000022D1',\n\t\"Superset;\": '\\U00002283',\n\t\"SupersetEqual;\": '\\U00002287',\n\t\"Supset;\": '\\U000022D1',\n\t\"THORN;\": '\\U000000DE',\n\t\"TRADE;\": '\\U00002122',\n\t\"TSHcy;\": '\\U0000040B',\n\t\"TScy;\": '\\U00000426',\n\t\"Tab;\": '\\U00000009',\n\t\"Tau;\": '\\U000003A4',\n\t\"Tcaron;\": '\\U00000164',\n\t\"Tcedil;\": '\\U00000162',\n\t\"Tcy;\": '\\U00000422',\n\t\"Tfr;\": '\\U0001D517',\n\t\"Therefore;\": '\\U00002234',\n\t\"Theta;\": '\\U00000398',\n\t\"ThinSpace;\": '\\U00002009',\n\t\"Tilde;\": '\\U0000223C',\n\t\"TildeEqual;\": '\\U00002243',\n\t\"TildeFullEqual;\": '\\U00002245',\n\t\"TildeTilde;\": '\\U00002248',\n\t\"Topf;\": '\\U0001D54B',\n\t\"TripleDot;\": '\\U000020DB',\n\t\"Tscr;\": '\\U0001D4AF',\n\t\"Tstrok;\": '\\U00000166',\n\t\"Uacute;\": '\\U000000DA',\n\t\"Uarr;\": '\\U0000219F',\n\t\"Uarrocir;\": '\\U00002949',\n\t\"Ubrcy;\": '\\U0000040E',\n\t\"Ubreve;\": '\\U0000016C',\n\t\"Ucirc;\": '\\U000000DB',\n\t\"Ucy;\": '\\U00000423',\n\t\"Udblac;\": '\\U00000170',\n\t\"Ufr;\": '\\U0001D518',\n\t\"Ugrave;\": '\\U000000D9',\n\t\"Umacr;\": '\\U0000016A',\n\t\"UnderBar;\": '\\U0000005F',\n\t\"UnderBrace;\": '\\U000023DF',\n\t\"UnderBracket;\": '\\U000023B5',\n\t\"UnderParenthesis;\": '\\U000023DD',\n\t\"Union;\": '\\U000022C3',\n\t\"UnionPlus;\": '\\U0000228E',\n\t\"Uogon;\": '\\U00000172',\n\t\"Uopf;\": '\\U0001D54C',\n\t\"UpArrow;\": '\\U00002191',\n\t\"UpArrowBar;\": '\\U00002912',\n\t\"UpArrowDownArrow;\": '\\U000021C5',\n\t\"UpDownArrow;\": '\\U00002195',\n\t\"UpEquilibrium;\": '\\U0000296E',\n\t\"UpTee;\": '\\U000022A5',\n\t\"UpTeeArrow;\": '\\U000021A5',\n\t\"Uparrow;\": '\\U000021D1',\n\t\"Updownarrow;\": '\\U000021D5',\n\t\"UpperLeftArrow;\": '\\U00002196',\n\t\"UpperRightArrow;\": '\\U00002197',\n\t\"Upsi;\": '\\U000003D2',\n\t\"Upsilon;\": '\\U000003A5',\n\t\"Uring;\": '\\U0000016E',\n\t\"Uscr;\": '\\U0001D4B0',\n\t\"Utilde;\": '\\U00000168',\n\t\"Uuml;\": '\\U000000DC',\n\t\"VDash;\": '\\U000022AB',\n\t\"Vbar;\": '\\U00002AEB',\n\t\"Vcy;\": '\\U00000412',\n\t\"Vdash;\": '\\U000022A9',\n\t\"Vdashl;\": '\\U00002AE6',\n\t\"Vee;\": '\\U000022C1',\n\t\"Verbar;\": '\\U00002016',\n\t\"Vert;\": '\\U00002016',\n\t\"VerticalBar;\": '\\U00002223',\n\t\"VerticalLine;\": '\\U0000007C',\n\t\"VerticalSeparator;\": '\\U00002758',\n\t\"VerticalTilde;\": '\\U00002240',\n\t\"VeryThinSpace;\": '\\U0000200A',\n\t\"Vfr;\": '\\U0001D519',\n\t\"Vopf;\": '\\U0001D54D',\n\t\"Vscr;\": '\\U0001D4B1',\n\t\"Vvdash;\": '\\U000022AA',\n\t\"Wcirc;\": '\\U00000174',\n\t\"Wedge;\": '\\U000022C0',\n\t\"Wfr;\": '\\U0001D51A',\n\t\"Wopf;\": '\\U0001D54E',\n\t\"Wscr;\": '\\U0001D4B2',\n\t\"Xfr;\": '\\U0001D51B',\n\t\"Xi;\": '\\U0000039E',\n\t\"Xopf;\": '\\U0001D54F',\n\t\"Xscr;\": '\\U0001D4B3',\n\t\"YAcy;\": '\\U0000042F',\n\t\"YIcy;\": '\\U00000407',\n\t\"YUcy;\": '\\U0000042E',\n\t\"Yacute;\": '\\U000000DD',\n\t\"Ycirc;\": '\\U00000176',\n\t\"Ycy;\": '\\U0000042B',\n\t\"Yfr;\": '\\U0001D51C',\n\t\"Yopf;\": '\\U0001D550',\n\t\"Yscr;\": '\\U0001D4B4',\n\t\"Yuml;\": '\\U00000178',\n\t\"ZHcy;\": '\\U00000416',\n\t\"Zacute;\": '\\U00000179',\n\t\"Zcaron;\": '\\U0000017D',\n\t\"Zcy;\": '\\U00000417',\n\t\"Zdot;\": '\\U0000017B',\n\t\"ZeroWidthSpace;\": '\\U0000200B',\n\t\"Zeta;\": '\\U00000396',\n\t\"Zfr;\": '\\U00002128',\n\t\"Zopf;\": '\\U00002124',\n\t\"Zscr;\": '\\U0001D4B5',\n\t\"aacute;\": '\\U000000E1',\n\t\"abreve;\": '\\U00000103',\n\t\"ac;\": '\\U0000223E',\n\t\"acd;\": '\\U0000223F',\n\t\"acirc;\": '\\U000000E2',\n\t\"acute;\": '\\U000000B4',\n\t\"acy;\": '\\U00000430',\n\t\"aelig;\": '\\U000000E6',\n\t\"af;\": '\\U00002061',\n\t\"afr;\": '\\U0001D51E',\n\t\"agrave;\": '\\U000000E0',\n\t\"alefsym;\": '\\U00002135',\n\t\"aleph;\": '\\U00002135',\n\t\"alpha;\": '\\U000003B1',\n\t\"amacr;\": '\\U00000101',\n\t\"amalg;\": '\\U00002A3F',\n\t\"amp;\": '\\U00000026',\n\t\"and;\": '\\U00002227',\n\t\"andand;\": '\\U00002A55',\n\t\"andd;\": '\\U00002A5C',\n\t\"andslope;\": '\\U00002A58',\n\t\"andv;\": '\\U00002A5A',\n\t\"ang;\": '\\U00002220',\n\t\"ange;\": '\\U000029A4',\n\t\"angle;\": '\\U00002220',\n\t\"angmsd;\": '\\U00002221',\n\t\"angmsdaa;\": '\\U000029A8',\n\t\"angmsdab;\": '\\U000029A9',\n\t\"angmsdac;\": '\\U000029AA',\n\t\"angmsdad;\": '\\U000029AB',\n\t\"angmsdae;\": '\\U000029AC',\n\t\"angmsdaf;\": '\\U000029AD',\n\t\"angmsdag;\": '\\U000029AE',\n\t\"angmsdah;\": '\\U000029AF',\n\t\"angrt;\": '\\U0000221F',\n\t\"angrtvb;\": '\\U000022BE',\n\t\"angrtvbd;\": '\\U0000299D',\n\t\"angsph;\": '\\U00002222',\n\t\"angst;\": '\\U000000C5',\n\t\"angzarr;\": '\\U0000237C',\n\t\"aogon;\": '\\U00000105',\n\t\"aopf;\": '\\U0001D552',\n\t\"ap;\": '\\U00002248',\n\t\"apE;\": '\\U00002A70',\n\t\"apacir;\": '\\U00002A6F',\n\t\"ape;\": '\\U0000224A',\n\t\"apid;\": '\\U0000224B',\n\t\"apos;\": '\\U00000027',\n\t\"approx;\": '\\U00002248',\n\t\"approxeq;\": '\\U0000224A',\n\t\"aring;\": '\\U000000E5',\n\t\"ascr;\": '\\U0001D4B6',\n\t\"ast;\": '\\U0000002A',\n\t\"asymp;\": '\\U00002248',\n\t\"asympeq;\": '\\U0000224D',\n\t\"atilde;\": '\\U000000E3',\n\t\"auml;\": '\\U000000E4',\n\t\"awconint;\": '\\U00002233',\n\t\"awint;\": '\\U00002A11',\n\t\"bNot;\": '\\U00002AED',\n\t\"backcong;\": '\\U0000224C',\n\t\"backepsilon;\": '\\U000003F6',\n\t\"backprime;\": '\\U00002035',\n\t\"backsim;\": '\\U0000223D',\n\t\"backsimeq;\": '\\U000022CD',\n\t\"barvee;\": '\\U000022BD',\n\t\"barwed;\": '\\U00002305',\n\t\"barwedge;\": '\\U00002305',\n\t\"bbrk;\": '\\U000023B5',\n\t\"bbrktbrk;\": '\\U000023B6',\n\t\"bcong;\": '\\U0000224C',\n\t\"bcy;\": '\\U00000431',\n\t\"bdquo;\": '\\U0000201E',\n\t\"becaus;\": '\\U00002235',\n\t\"because;\": '\\U00002235',\n\t\"bemptyv;\": '\\U000029B0',\n\t\"bepsi;\": '\\U000003F6',\n\t\"bernou;\": '\\U0000212C',\n\t\"beta;\": '\\U000003B2',\n\t\"beth;\": '\\U00002136',\n\t\"between;\": '\\U0000226C',\n\t\"bfr;\": '\\U0001D51F',\n\t\"bigcap;\": '\\U000022C2',\n\t\"bigcirc;\": '\\U000025EF',\n\t\"bigcup;\": '\\U000022C3',\n\t\"bigodot;\": '\\U00002A00',\n\t\"bigoplus;\": '\\U00002A01',\n\t\"bigotimes;\": '\\U00002A02',\n\t\"bigsqcup;\": '\\U00002A06',\n\t\"bigstar;\": '\\U00002605',\n\t\"bigtriangledown;\": '\\U000025BD',\n\t\"bigtriangleup;\": '\\U000025B3',\n\t\"biguplus;\": '\\U00002A04',\n\t\"bigvee;\": '\\U000022C1',\n\t\"bigwedge;\": '\\U000022C0',\n\t\"bkarow;\": '\\U0000290D',\n\t\"blacklozenge;\": '\\U000029EB',\n\t\"blacksquare;\": '\\U000025AA',\n\t\"blacktriangle;\": '\\U000025B4',\n\t\"blacktriangledown;\": '\\U000025BE',\n\t\"blacktriangleleft;\": '\\U000025C2',\n\t\"blacktriangleright;\": '\\U000025B8',\n\t\"blank;\": '\\U00002423',\n\t\"blk12;\": '\\U00002592',\n\t\"blk14;\": '\\U00002591',\n\t\"blk34;\": '\\U00002593',\n\t\"block;\": '\\U00002588',\n\t\"bnot;\": '\\U00002310',\n\t\"bopf;\": '\\U0001D553',\n\t\"bot;\": '\\U000022A5',\n\t\"bottom;\": '\\U000022A5',\n\t\"bowtie;\": '\\U000022C8',\n\t\"boxDL;\": '\\U00002557',\n\t\"boxDR;\": '\\U00002554',\n\t\"boxDl;\": '\\U00002556',\n\t\"boxDr;\": '\\U00002553',\n\t\"boxH;\": '\\U00002550',\n\t\"boxHD;\": '\\U00002566',\n\t\"boxHU;\": '\\U00002569',\n\t\"boxHd;\": '\\U00002564',\n\t\"boxHu;\": '\\U00002567',\n\t\"boxUL;\": '\\U0000255D',\n\t\"boxUR;\": '\\U0000255A',\n\t\"boxUl;\": '\\U0000255C',\n\t\"boxUr;\": '\\U00002559',\n\t\"boxV;\": '\\U00002551',\n\t\"boxVH;\": '\\U0000256C',\n\t\"boxVL;\": '\\U00002563',\n\t\"boxVR;\": '\\U00002560',\n\t\"boxVh;\": '\\U0000256B',\n\t\"boxVl;\": '\\U00002562',\n\t\"boxVr;\": '\\U0000255F',\n\t\"boxbox;\": '\\U000029C9',\n\t\"boxdL;\": '\\U00002555',\n\t\"boxdR;\": '\\U00002552',\n\t\"boxdl;\": '\\U00002510',\n\t\"boxdr;\": '\\U0000250C',\n\t\"boxh;\": '\\U00002500',\n\t\"boxhD;\": '\\U00002565',\n\t\"boxhU;\": '\\U00002568',\n\t\"boxhd;\": '\\U0000252C',\n\t\"boxhu;\": '\\U00002534',\n\t\"boxminus;\": '\\U0000229F',\n\t\"boxplus;\": '\\U0000229E',\n\t\"boxtimes;\": '\\U000022A0',\n\t\"boxuL;\": '\\U0000255B',\n\t\"boxuR;\": '\\U00002558',\n\t\"boxul;\": '\\U00002518',\n\t\"boxur;\": '\\U00002514',\n\t\"boxv;\": '\\U00002502',\n\t\"boxvH;\": '\\U0000256A',\n\t\"boxvL;\": '\\U00002561',\n\t\"boxvR;\": '\\U0000255E',\n\t\"boxvh;\": '\\U0000253C',\n\t\"boxvl;\": '\\U00002524',\n\t\"boxvr;\": '\\U0000251C',\n\t\"bprime;\": '\\U00002035',\n\t\"breve;\": '\\U000002D8',\n\t\"brvbar;\": '\\U000000A6',\n\t\"bscr;\": '\\U0001D4B7',\n\t\"bsemi;\": '\\U0000204F',\n\t\"bsim;\": '\\U0000223D',\n\t\"bsime;\": '\\U000022CD',\n\t\"bsol;\": '\\U0000005C',\n\t\"bsolb;\": '\\U000029C5',\n\t\"bsolhsub;\": '\\U000027C8',\n\t\"bull;\": '\\U00002022',\n\t\"bullet;\": '\\U00002022',\n\t\"bump;\": '\\U0000224E',\n\t\"bumpE;\": '\\U00002AAE',\n\t\"bumpe;\": '\\U0000224F',\n\t\"bumpeq;\": '\\U0000224F',\n\t\"cacute;\": '\\U00000107',\n\t\"cap;\": '\\U00002229',\n\t\"capand;\": '\\U00002A44',\n\t\"capbrcup;\": '\\U00002A49',\n\t\"capcap;\": '\\U00002A4B',\n\t\"capcup;\": '\\U00002A47',\n\t\"capdot;\": '\\U00002A40',\n\t\"caret;\": '\\U00002041',\n\t\"caron;\": '\\U000002C7',\n\t\"ccaps;\": '\\U00002A4D',\n\t\"ccaron;\": '\\U0000010D',\n\t\"ccedil;\": '\\U000000E7',\n\t\"ccirc;\": '\\U00000109',\n\t\"ccups;\": '\\U00002A4C',\n\t\"ccupssm;\": '\\U00002A50',\n\t\"cdot;\": '\\U0000010B',\n\t\"cedil;\": '\\U000000B8',\n\t\"cemptyv;\": '\\U000029B2',\n\t\"cent;\": '\\U000000A2',\n\t\"centerdot;\": '\\U000000B7',\n\t\"cfr;\": '\\U0001D520',\n\t\"chcy;\": '\\U00000447',\n\t\"check;\": '\\U00002713',\n\t\"checkmark;\": '\\U00002713',\n\t\"chi;\": '\\U000003C7',\n\t\"cir;\": '\\U000025CB',\n\t\"cirE;\": '\\U000029C3',\n\t\"circ;\": '\\U000002C6',\n\t\"circeq;\": '\\U00002257',\n\t\"circlearrowleft;\": '\\U000021BA',\n\t\"circlearrowright;\": '\\U000021BB',\n\t\"circledR;\": '\\U000000AE',\n\t\"circledS;\": '\\U000024C8',\n\t\"circledast;\": '\\U0000229B',\n\t\"circledcirc;\": '\\U0000229A',\n\t\"circleddash;\": '\\U0000229D',\n\t\"cire;\": '\\U00002257',\n\t\"cirfnint;\": '\\U00002A10',\n\t\"cirmid;\": '\\U00002AEF',\n\t\"cirscir;\": '\\U000029C2',\n\t\"clubs;\": '\\U00002663',\n\t\"clubsuit;\": '\\U00002663',\n\t\"colon;\": '\\U0000003A',\n\t\"colone;\": '\\U00002254',\n\t\"coloneq;\": '\\U00002254',\n\t\"comma;\": '\\U0000002C',\n\t\"commat;\": '\\U00000040',\n\t\"comp;\": '\\U00002201',\n\t\"compfn;\": '\\U00002218',\n\t\"complement;\": '\\U00002201',\n\t\"complexes;\": '\\U00002102',\n\t\"cong;\": '\\U00002245',\n\t\"congdot;\": '\\U00002A6D',\n\t\"conint;\": '\\U0000222E',\n\t\"copf;\": '\\U0001D554',\n\t\"coprod;\": '\\U00002210',\n\t\"copy;\": '\\U000000A9',\n\t\"copysr;\": '\\U00002117',\n\t\"crarr;\": '\\U000021B5',\n\t\"cross;\": '\\U00002717',\n\t\"cscr;\": '\\U0001D4B8',\n\t\"csub;\": '\\U00002ACF',\n\t\"csube;\": '\\U00002AD1',\n\t\"csup;\": '\\U00002AD0',\n\t\"csupe;\": '\\U00002AD2',\n\t\"ctdot;\": '\\U000022EF',\n\t\"cudarrl;\": '\\U00002938',\n\t\"cudarrr;\": '\\U00002935',\n\t\"cuepr;\": '\\U000022DE',\n\t\"cuesc;\": '\\U000022DF',\n\t\"cularr;\": '\\U000021B6',\n\t\"cularrp;\": '\\U0000293D',\n\t\"cup;\": '\\U0000222A',\n\t\"cupbrcap;\": '\\U00002A48',\n\t\"cupcap;\": '\\U00002A46',\n\t\"cupcup;\": '\\U00002A4A',\n\t\"cupdot;\": '\\U0000228D',\n\t\"cupor;\": '\\U00002A45',\n\t\"curarr;\": '\\U000021B7',\n\t\"curarrm;\": '\\U0000293C',\n\t\"curlyeqprec;\": '\\U000022DE',\n\t\"curlyeqsucc;\": '\\U000022DF',\n\t\"curlyvee;\": '\\U000022CE',\n\t\"curlywedge;\": '\\U000022CF',\n\t\"curren;\": '\\U000000A4',\n\t\"curvearrowleft;\": '\\U000021B6',\n\t\"curvearrowright;\": '\\U000021B7',\n\t\"cuvee;\": '\\U000022CE',\n\t\"cuwed;\": '\\U000022CF',\n\t\"cwconint;\": '\\U00002232',\n\t\"cwint;\": '\\U00002231',\n\t\"cylcty;\": '\\U0000232D',\n\t\"dArr;\": '\\U000021D3',\n\t\"dHar;\": '\\U00002965',\n\t\"dagger;\": '\\U00002020',\n\t\"daleth;\": '\\U00002138',\n\t\"darr;\": '\\U00002193',\n\t\"dash;\": '\\U00002010',\n\t\"dashv;\": '\\U000022A3',\n\t\"dbkarow;\": '\\U0000290F',\n\t\"dblac;\": '\\U000002DD',\n\t\"dcaron;\": '\\U0000010F',\n\t\"dcy;\": '\\U00000434',\n\t\"dd;\": '\\U00002146',\n\t\"ddagger;\": '\\U00002021',\n\t\"ddarr;\": '\\U000021CA',\n\t\"ddotseq;\": '\\U00002A77',\n\t\"deg;\": '\\U000000B0',\n\t\"delta;\": '\\U000003B4',\n\t\"demptyv;\": '\\U000029B1',\n\t\"dfisht;\": '\\U0000297F',\n\t\"dfr;\": '\\U0001D521',\n\t\"dharl;\": '\\U000021C3',\n\t\"dharr;\": '\\U000021C2',\n\t\"diam;\": '\\U000022C4',\n\t\"diamond;\": '\\U000022C4',\n\t\"diamondsuit;\": '\\U00002666',\n\t\"diams;\": '\\U00002666',\n\t\"die;\": '\\U000000A8',\n\t\"digamma;\": '\\U000003DD',\n\t\"disin;\": '\\U000022F2',\n\t\"div;\": '\\U000000F7',\n\t\"divide;\": '\\U000000F7',\n\t\"divideontimes;\": '\\U000022C7',\n\t\"divonx;\": '\\U000022C7',\n\t\"djcy;\": '\\U00000452',\n\t\"dlcorn;\": '\\U0000231E',\n\t\"dlcrop;\": '\\U0000230D',\n\t\"dollar;\": '\\U00000024',\n\t\"dopf;\": '\\U0001D555',\n\t\"dot;\": '\\U000002D9',\n\t\"doteq;\": '\\U00002250',\n\t\"doteqdot;\": '\\U00002251',\n\t\"dotminus;\": '\\U00002238',\n\t\"dotplus;\": '\\U00002214',\n\t\"dotsquare;\": '\\U000022A1',\n\t\"doublebarwedge;\": '\\U00002306',\n\t\"downarrow;\": '\\U00002193',\n\t\"downdownarrows;\": '\\U000021CA',\n\t\"downharpoonleft;\": '\\U000021C3',\n\t\"downharpoonright;\": '\\U000021C2',\n\t\"drbkarow;\": '\\U00002910',\n\t\"drcorn;\": '\\U0000231F',\n\t\"drcrop;\": '\\U0000230C',\n\t\"dscr;\": '\\U0001D4B9',\n\t\"dscy;\": '\\U00000455',\n\t\"dsol;\": '\\U000029F6',\n\t\"dstrok;\": '\\U00000111',\n\t\"dtdot;\": '\\U000022F1',\n\t\"dtri;\": '\\U000025BF',\n\t\"dtrif;\": '\\U000025BE',\n\t\"duarr;\": '\\U000021F5',\n\t\"duhar;\": '\\U0000296F',\n\t\"dwangle;\": '\\U000029A6',\n\t\"dzcy;\": '\\U0000045F',\n\t\"dzigrarr;\": '\\U000027FF',\n\t\"eDDot;\": '\\U00002A77',\n\t\"eDot;\": '\\U00002251',\n\t\"eacute;\": '\\U000000E9',\n\t\"easter;\": '\\U00002A6E',\n\t\"ecaron;\": '\\U0000011B',\n\t\"ecir;\": '\\U00002256',\n\t\"ecirc;\": '\\U000000EA',\n\t\"ecolon;\": '\\U00002255',\n\t\"ecy;\": '\\U0000044D',\n\t\"edot;\": '\\U00000117',\n\t\"ee;\": '\\U00002147',\n\t\"efDot;\": '\\U00002252',\n\t\"efr;\": '\\U0001D522',\n\t\"eg;\": '\\U00002A9A',\n\t\"egrave;\": '\\U000000E8',\n\t\"egs;\": '\\U00002A96',\n\t\"egsdot;\": '\\U00002A98',\n\t\"el;\": '\\U00002A99',\n\t\"elinters;\": '\\U000023E7',\n\t\"ell;\": '\\U00002113',\n\t\"els;\": '\\U00002A95',\n\t\"elsdot;\": '\\U00002A97',\n\t\"emacr;\": '\\U00000113',\n\t\"empty;\": '\\U00002205',\n\t\"emptyset;\": '\\U00002205',\n\t\"emptyv;\": '\\U00002205',\n\t\"emsp;\": '\\U00002003',\n\t\"emsp13;\": '\\U00002004',\n\t\"emsp14;\": '\\U00002005',\n\t\"eng;\": '\\U0000014B',\n\t\"ensp;\": '\\U00002002',\n\t\"eogon;\": '\\U00000119',\n\t\"eopf;\": '\\U0001D556',\n\t\"epar;\": '\\U000022D5',\n\t\"eparsl;\": '\\U000029E3',\n\t\"eplus;\": '\\U00002A71',\n\t\"epsi;\": '\\U000003B5',\n\t\"epsilon;\": '\\U000003B5',\n\t\"epsiv;\": '\\U000003F5',\n\t\"eqcirc;\": '\\U00002256',\n\t\"eqcolon;\": '\\U00002255',\n\t\"eqsim;\": '\\U00002242',\n\t\"eqslantgtr;\": '\\U00002A96',\n\t\"eqslantless;\": '\\U00002A95',\n\t\"equals;\": '\\U0000003D',\n\t\"equest;\": '\\U0000225F',\n\t\"equiv;\": '\\U00002261',\n\t\"equivDD;\": '\\U00002A78',\n\t\"eqvparsl;\": '\\U000029E5',\n\t\"erDot;\": '\\U00002253',\n\t\"erarr;\": '\\U00002971',\n\t\"escr;\": '\\U0000212F',\n\t\"esdot;\": '\\U00002250',\n\t\"esim;\": '\\U00002242',\n\t\"eta;\": '\\U000003B7',\n\t\"eth;\": '\\U000000F0',\n\t\"euml;\": '\\U000000EB',\n\t\"euro;\": '\\U000020AC',\n\t\"excl;\": '\\U00000021',\n\t\"exist;\": '\\U00002203',\n\t\"expectation;\": '\\U00002130',\n\t\"exponentiale;\": '\\U00002147',\n\t\"fallingdotseq;\": '\\U00002252',\n\t\"fcy;\": '\\U00000444',\n\t\"female;\": '\\U00002640',\n\t\"ffilig;\": '\\U0000FB03',\n\t\"fflig;\": '\\U0000FB00',\n\t\"ffllig;\": '\\U0000FB04',\n\t\"ffr;\": '\\U0001D523',\n\t\"filig;\": '\\U0000FB01',\n\t\"flat;\": '\\U0000266D',\n\t\"fllig;\": '\\U0000FB02',\n\t\"fltns;\": '\\U000025B1',\n\t\"fnof;\": '\\U00000192',\n\t\"fopf;\": '\\U0001D557',\n\t\"forall;\": '\\U00002200',\n\t\"fork;\": '\\U000022D4',\n\t\"forkv;\": '\\U00002AD9',\n\t\"fpartint;\": '\\U00002A0D',\n\t\"frac12;\": '\\U000000BD',\n\t\"frac13;\": '\\U00002153',\n\t\"frac14;\": '\\U000000BC',\n\t\"frac15;\": '\\U00002155',\n\t\"frac16;\": '\\U00002159',\n\t\"frac18;\": '\\U0000215B',\n\t\"frac23;\": '\\U00002154',\n\t\"frac25;\": '\\U00002156',\n\t\"frac34;\": '\\U000000BE',\n\t\"frac35;\": '\\U00002157',\n\t\"frac38;\": '\\U0000215C',\n\t\"frac45;\": '\\U00002158',\n\t\"frac56;\": '\\U0000215A',\n\t\"frac58;\": '\\U0000215D',\n\t\"frac78;\": '\\U0000215E',\n\t\"frasl;\": '\\U00002044',\n\t\"frown;\": '\\U00002322',\n\t\"fscr;\": '\\U0001D4BB',\n\t\"gE;\": '\\U00002267',\n\t\"gEl;\": '\\U00002A8C',\n\t\"gacute;\": '\\U000001F5',\n\t\"gamma;\": '\\U000003B3',\n\t\"gammad;\": '\\U000003DD',\n\t\"gap;\": '\\U00002A86',\n\t\"gbreve;\": '\\U0000011F',\n\t\"gcirc;\": '\\U0000011D',\n\t\"gcy;\": '\\U00000433',\n\t\"gdot;\": '\\U00000121',\n\t\"ge;\": '\\U00002265',\n\t\"gel;\": '\\U000022DB',\n\t\"geq;\": '\\U00002265',\n\t\"geqq;\": '\\U00002267',\n\t\"geqslant;\": '\\U00002A7E',\n\t\"ges;\": '\\U00002A7E',\n\t\"gescc;\": '\\U00002AA9',\n\t\"gesdot;\": '\\U00002A80',\n\t\"gesdoto;\": '\\U00002A82',\n\t\"gesdotol;\": '\\U00002A84',\n\t\"gesles;\": '\\U00002A94',\n\t\"gfr;\": '\\U0001D524',\n\t\"gg;\": '\\U0000226B',\n\t\"ggg;\": '\\U000022D9',\n\t\"gimel;\": '\\U00002137',\n\t\"gjcy;\": '\\U00000453',\n\t\"gl;\": '\\U00002277',\n\t\"glE;\": '\\U00002A92',\n\t\"gla;\": '\\U00002AA5',\n\t\"glj;\": '\\U00002AA4',\n\t\"gnE;\": '\\U00002269',\n\t\"gnap;\": '\\U00002A8A',\n\t\"gnapprox;\": '\\U00002A8A',\n\t\"gne;\": '\\U00002A88',\n\t\"gneq;\": '\\U00002A88',\n\t\"gneqq;\": '\\U00002269',\n\t\"gnsim;\": '\\U000022E7',\n\t\"gopf;\": '\\U0001D558',\n\t\"grave;\": '\\U00000060',\n\t\"gscr;\": '\\U0000210A',\n\t\"gsim;\": '\\U00002273',\n\t\"gsime;\": '\\U00002A8E',\n\t\"gsiml;\": '\\U00002A90',\n\t\"gt;\": '\\U0000003E',\n\t\"gtcc;\": '\\U00002AA7',\n\t\"gtcir;\": '\\U00002A7A',\n\t\"gtdot;\": '\\U000022D7',\n\t\"gtlPar;\": '\\U00002995',\n\t\"gtquest;\": '\\U00002A7C',\n\t\"gtrapprox;\": '\\U00002A86',\n\t\"gtrarr;\": '\\U00002978',\n\t\"gtrdot;\": '\\U000022D7',\n\t\"gtreqless;\": '\\U000022DB',\n\t\"gtreqqless;\": '\\U00002A8C',\n\t\"gtrless;\": '\\U00002277',\n\t\"gtrsim;\": '\\U00002273',\n\t\"hArr;\": '\\U000021D4',\n\t\"hairsp;\": '\\U0000200A',\n\t\"half;\": '\\U000000BD',\n\t\"hamilt;\": '\\U0000210B',\n\t\"hardcy;\": '\\U0000044A',\n\t\"harr;\": '\\U00002194',\n\t\"harrcir;\": '\\U00002948',\n\t\"harrw;\": '\\U000021AD',\n\t\"hbar;\": '\\U0000210F',\n\t\"hcirc;\": '\\U00000125',\n\t\"hearts;\": '\\U00002665',\n\t\"heartsuit;\": '\\U00002665',\n\t\"hellip;\": '\\U00002026',\n\t\"hercon;\": '\\U000022B9',\n\t\"hfr;\": '\\U0001D525',\n\t\"hksearow;\": '\\U00002925',\n\t\"hkswarow;\": '\\U00002926',\n\t\"hoarr;\": '\\U000021FF',\n\t\"homtht;\": '\\U0000223B',\n\t\"hookleftarrow;\": '\\U000021A9',\n\t\"hookrightarrow;\": '\\U000021AA',\n\t\"hopf;\": '\\U0001D559',\n\t\"horbar;\": '\\U00002015',\n\t\"hscr;\": '\\U0001D4BD',\n\t\"hslash;\": '\\U0000210F',\n\t\"hstrok;\": '\\U00000127',\n\t\"hybull;\": '\\U00002043',\n\t\"hyphen;\": '\\U00002010',\n\t\"iacute;\": '\\U000000ED',\n\t\"ic;\": '\\U00002063',\n\t\"icirc;\": '\\U000000EE',\n\t\"icy;\": '\\U00000438',\n\t\"iecy;\": '\\U00000435',\n\t\"iexcl;\": '\\U000000A1',\n\t\"iff;\": '\\U000021D4',\n\t\"ifr;\": '\\U0001D526',\n\t\"igrave;\": '\\U000000EC',\n\t\"ii;\": '\\U00002148',\n\t\"iiiint;\": '\\U00002A0C',\n\t\"iiint;\": '\\U0000222D',\n\t\"iinfin;\": '\\U000029DC',\n\t\"iiota;\": '\\U00002129',\n\t\"ijlig;\": '\\U00000133',\n\t\"imacr;\": '\\U0000012B',\n\t\"image;\": '\\U00002111',\n\t\"imagline;\": '\\U00002110',\n\t\"imagpart;\": '\\U00002111',\n\t\"imath;\": '\\U00000131',\n\t\"imof;\": '\\U000022B7',\n\t\"imped;\": '\\U000001B5',\n\t\"in;\": '\\U00002208',\n\t\"incare;\": '\\U00002105',\n\t\"infin;\": '\\U0000221E',\n\t\"infintie;\": '\\U000029DD',\n\t\"inodot;\": '\\U00000131',\n\t\"int;\": '\\U0000222B',\n\t\"intcal;\": '\\U000022BA',\n\t\"integers;\": '\\U00002124',\n\t\"intercal;\": '\\U000022BA',\n\t\"intlarhk;\": '\\U00002A17',\n\t\"intprod;\": '\\U00002A3C',\n\t\"iocy;\": '\\U00000451',\n\t\"iogon;\": '\\U0000012F',\n\t\"iopf;\": '\\U0001D55A',\n\t\"iota;\": '\\U000003B9',\n\t\"iprod;\": '\\U00002A3C',\n\t\"iquest;\": '\\U000000BF',\n\t\"iscr;\": '\\U0001D4BE',\n\t\"isin;\": '\\U00002208',\n\t\"isinE;\": '\\U000022F9',\n\t\"isindot;\": '\\U000022F5',\n\t\"isins;\": '\\U000022F4',\n\t\"isinsv;\": '\\U000022F3',\n\t\"isinv;\": '\\U00002208',\n\t\"it;\": '\\U00002062',\n\t\"itilde;\": '\\U00000129',\n\t\"iukcy;\": '\\U00000456',\n\t\"iuml;\": '\\U000000EF',\n\t\"jcirc;\": '\\U00000135',\n\t\"jcy;\": '\\U00000439',\n\t\"jfr;\": '\\U0001D527',\n\t\"jmath;\": '\\U00000237',\n\t\"jopf;\": '\\U0001D55B',\n\t\"jscr;\": '\\U0001D4BF',\n\t\"jsercy;\": '\\U00000458',\n\t\"jukcy;\": '\\U00000454',\n\t\"kappa;\": '\\U000003BA',\n\t\"kappav;\": '\\U000003F0',\n\t\"kcedil;\": '\\U00000137',\n\t\"kcy;\": '\\U0000043A',\n\t\"kfr;\": '\\U0001D528',\n\t\"kgreen;\": '\\U00000138',\n\t\"khcy;\": '\\U00000445',\n\t\"kjcy;\": '\\U0000045C',\n\t\"kopf;\": '\\U0001D55C',\n\t\"kscr;\": '\\U0001D4C0',\n\t\"lAarr;\": '\\U000021DA',\n\t\"lArr;\": '\\U000021D0',\n\t\"lAtail;\": '\\U0000291B',\n\t\"lBarr;\": '\\U0000290E',\n\t\"lE;\": '\\U00002266',\n\t\"lEg;\": '\\U00002A8B',\n\t\"lHar;\": '\\U00002962',\n\t\"lacute;\": '\\U0000013A',\n\t\"laemptyv;\": '\\U000029B4',\n\t\"lagran;\": '\\U00002112',\n\t\"lambda;\": '\\U000003BB',\n\t\"lang;\": '\\U000027E8',\n\t\"langd;\": '\\U00002991',\n\t\"langle;\": '\\U000027E8',\n\t\"lap;\": '\\U00002A85',\n\t\"laquo;\": '\\U000000AB',\n\t\"larr;\": '\\U00002190',\n\t\"larrb;\": '\\U000021E4',\n\t\"larrbfs;\": '\\U0000291F',\n\t\"larrfs;\": '\\U0000291D',\n\t\"larrhk;\": '\\U000021A9',\n\t\"larrlp;\": '\\U000021AB',\n\t\"larrpl;\": '\\U00002939',\n\t\"larrsim;\": '\\U00002973',\n\t\"larrtl;\": '\\U000021A2',\n\t\"lat;\": '\\U00002AAB',\n\t\"latail;\": '\\U00002919',\n\t\"late;\": '\\U00002AAD',\n\t\"lbarr;\": '\\U0000290C',\n\t\"lbbrk;\": '\\U00002772',\n\t\"lbrace;\": '\\U0000007B',\n\t\"lbrack;\": '\\U0000005B',\n\t\"lbrke;\": '\\U0000298B',\n\t\"lbrksld;\": '\\U0000298F',\n\t\"lbrkslu;\": '\\U0000298D',\n\t\"lcaron;\": '\\U0000013E',\n\t\"lcedil;\": '\\U0000013C',\n\t\"lceil;\": '\\U00002308',\n\t\"lcub;\": '\\U0000007B',\n\t\"lcy;\": '\\U0000043B',\n\t\"ldca;\": '\\U00002936',\n\t\"ldquo;\": '\\U0000201C',\n\t\"ldquor;\": '\\U0000201E',\n\t\"ldrdhar;\": '\\U00002967',\n\t\"ldrushar;\": '\\U0000294B',\n\t\"ldsh;\": '\\U000021B2',\n\t\"le;\": '\\U00002264',\n\t\"leftarrow;\": '\\U00002190',\n\t\"leftarrowtail;\": '\\U000021A2',\n\t\"leftharpoondown;\": '\\U000021BD',\n\t\"leftharpoonup;\": '\\U000021BC',\n\t\"leftleftarrows;\": '\\U000021C7',\n\t\"leftrightarrow;\": '\\U00002194',\n\t\"leftrightarrows;\": '\\U000021C6',\n\t\"leftrightharpoons;\": '\\U000021CB',\n\t\"leftrightsquigarrow;\": '\\U000021AD',\n\t\"leftthreetimes;\": '\\U000022CB',\n\t\"leg;\": '\\U000022DA',\n\t\"leq;\": '\\U00002264',\n\t\"leqq;\": '\\U00002266',\n\t\"leqslant;\": '\\U00002A7D',\n\t\"les;\": '\\U00002A7D',\n\t\"lescc;\": '\\U00002AA8',\n\t\"lesdot;\": '\\U00002A7F',\n\t\"lesdoto;\": '\\U00002A81',\n\t\"lesdotor;\": '\\U00002A83',\n\t\"lesges;\": '\\U00002A93',\n\t\"lessapprox;\": '\\U00002A85',\n\t\"lessdot;\": '\\U000022D6',\n\t\"lesseqgtr;\": '\\U000022DA',\n\t\"lesseqqgtr;\": '\\U00002A8B',\n\t\"lessgtr;\": '\\U00002276',\n\t\"lesssim;\": '\\U00002272',\n\t\"lfisht;\": '\\U0000297C',\n\t\"lfloor;\": '\\U0000230A',\n\t\"lfr;\": '\\U0001D529',\n\t\"lg;\": '\\U00002276',\n\t\"lgE;\": '\\U00002A91',\n\t\"lhard;\": '\\U000021BD',\n\t\"lharu;\": '\\U000021BC',\n\t\"lharul;\": '\\U0000296A',\n\t\"lhblk;\": '\\U00002584',\n\t\"ljcy;\": '\\U00000459',\n\t\"ll;\": '\\U0000226A',\n\t\"llarr;\": '\\U000021C7',\n\t\"llcorner;\": '\\U0000231E',\n\t\"llhard;\": '\\U0000296B',\n\t\"lltri;\": '\\U000025FA',\n\t\"lmidot;\": '\\U00000140',\n\t\"lmoust;\": '\\U000023B0',\n\t\"lmoustache;\": '\\U000023B0',\n\t\"lnE;\": '\\U00002268',\n\t\"lnap;\": '\\U00002A89',\n\t\"lnapprox;\": '\\U00002A89',\n\t\"lne;\": '\\U00002A87',\n\t\"lneq;\": '\\U00002A87',\n\t\"lneqq;\": '\\U00002268',\n\t\"lnsim;\": '\\U000022E6',\n\t\"loang;\": '\\U000027EC',\n\t\"loarr;\": '\\U000021FD',\n\t\"lobrk;\": '\\U000027E6',\n\t\"longleftarrow;\": '\\U000027F5',\n\t\"longleftrightarrow;\": '\\U000027F7',\n\t\"longmapsto;\": '\\U000027FC',\n\t\"longrightarrow;\": '\\U000027F6',\n\t\"looparrowleft;\": '\\U000021AB',\n\t\"looparrowright;\": '\\U000021AC',\n\t\"lopar;\": '\\U00002985',\n\t\"lopf;\": '\\U0001D55D',\n\t\"loplus;\": '\\U00002A2D',\n\t\"lotimes;\": '\\U00002A34',\n\t\"lowast;\": '\\U00002217',\n\t\"lowbar;\": '\\U0000005F',\n\t\"loz;\": '\\U000025CA',\n\t\"lozenge;\": '\\U000025CA',\n\t\"lozf;\": '\\U000029EB',\n\t\"lpar;\": '\\U00000028',\n\t\"lparlt;\": '\\U00002993',\n\t\"lrarr;\": '\\U000021C6',\n\t\"lrcorner;\": '\\U0000231F',\n\t\"lrhar;\": '\\U000021CB',\n\t\"lrhard;\": '\\U0000296D',\n\t\"lrm;\": '\\U0000200E',\n\t\"lrtri;\": '\\U000022BF',\n\t\"lsaquo;\": '\\U00002039',\n\t\"lscr;\": '\\U0001D4C1',\n\t\"lsh;\": '\\U000021B0',\n\t\"lsim;\": '\\U00002272',\n\t\"lsime;\": '\\U00002A8D',\n\t\"lsimg;\": '\\U00002A8F',\n\t\"lsqb;\": '\\U0000005B',\n\t\"lsquo;\": '\\U00002018',\n\t\"lsquor;\": '\\U0000201A',\n\t\"lstrok;\": '\\U00000142',\n\t\"lt;\": '\\U0000003C',\n\t\"ltcc;\": '\\U00002AA6',\n\t\"ltcir;\": '\\U00002A79',\n\t\"ltdot;\": '\\U000022D6',\n\t\"lthree;\": '\\U000022CB',\n\t\"ltimes;\": '\\U000022C9',\n\t\"ltlarr;\": '\\U00002976',\n\t\"ltquest;\": '\\U00002A7B',\n\t\"ltrPar;\": '\\U00002996',\n\t\"ltri;\": '\\U000025C3',\n\t\"ltrie;\": '\\U000022B4',\n\t\"ltrif;\": '\\U000025C2',\n\t\"lurdshar;\": '\\U0000294A',\n\t\"luruhar;\": '\\U00002966',\n\t\"mDDot;\": '\\U0000223A',\n\t\"macr;\": '\\U000000AF',\n\t\"male;\": '\\U00002642',\n\t\"malt;\": '\\U00002720',\n\t\"maltese;\": '\\U00002720',\n\t\"map;\": '\\U000021A6',\n\t\"mapsto;\": '\\U000021A6',\n\t\"mapstodown;\": '\\U000021A7',\n\t\"mapstoleft;\": '\\U000021A4',\n\t\"mapstoup;\": '\\U000021A5',\n\t\"marker;\": '\\U000025AE',\n\t\"mcomma;\": '\\U00002A29',\n\t\"mcy;\": '\\U0000043C',\n\t\"mdash;\": '\\U00002014',\n\t\"measuredangle;\": '\\U00002221',\n\t\"mfr;\": '\\U0001D52A',\n\t\"mho;\": '\\U00002127',\n\t\"micro;\": '\\U000000B5',\n\t\"mid;\": '\\U00002223',\n\t\"midast;\": '\\U0000002A',\n\t\"midcir;\": '\\U00002AF0',\n\t\"middot;\": '\\U000000B7',\n\t\"minus;\": '\\U00002212',\n\t\"minusb;\": '\\U0000229F',\n\t\"minusd;\": '\\U00002238',\n\t\"minusdu;\": '\\U00002A2A',\n\t\"mlcp;\": '\\U00002ADB',\n\t\"mldr;\": '\\U00002026',\n\t\"mnplus;\": '\\U00002213',\n\t\"models;\": '\\U000022A7',\n\t\"mopf;\": '\\U0001D55E',\n\t\"mp;\": '\\U00002213',\n\t\"mscr;\": '\\U0001D4C2',\n\t\"mstpos;\": '\\U0000223E',\n\t\"mu;\": '\\U000003BC',\n\t\"multimap;\": '\\U000022B8',\n\t\"mumap;\": '\\U000022B8',\n\t\"nLeftarrow;\": '\\U000021CD',\n\t\"nLeftrightarrow;\": '\\U000021CE',\n\t\"nRightarrow;\": '\\U000021CF',\n\t\"nVDash;\": '\\U000022AF',\n\t\"nVdash;\": '\\U000022AE',\n\t\"nabla;\": '\\U00002207',\n\t\"nacute;\": '\\U00000144',\n\t\"nap;\": '\\U00002249',\n\t\"napos;\": '\\U00000149',\n\t\"napprox;\": '\\U00002249',\n\t\"natur;\": '\\U0000266E',\n\t\"natural;\": '\\U0000266E',\n\t\"naturals;\": '\\U00002115',\n\t\"nbsp;\": '\\U000000A0',\n\t\"ncap;\": '\\U00002A43',\n\t\"ncaron;\": '\\U00000148',\n\t\"ncedil;\": '\\U00000146',\n\t\"ncong;\": '\\U00002247',\n\t\"ncup;\": '\\U00002A42',\n\t\"ncy;\": '\\U0000043D',\n\t\"ndash;\": '\\U00002013',\n\t\"ne;\": '\\U00002260',\n\t\"neArr;\": '\\U000021D7',\n\t\"nearhk;\": '\\U00002924',\n\t\"nearr;\": '\\U00002197',\n\t\"nearrow;\": '\\U00002197',\n\t\"nequiv;\": '\\U00002262',\n\t\"nesear;\": '\\U00002928',\n\t\"nexist;\": '\\U00002204',\n\t\"nexists;\": '\\U00002204',\n\t\"nfr;\": '\\U0001D52B',\n\t\"nge;\": '\\U00002271',\n\t\"ngeq;\": '\\U00002271',\n\t\"ngsim;\": '\\U00002275',\n\t\"ngt;\": '\\U0000226F',\n\t\"ngtr;\": '\\U0000226F',\n\t\"nhArr;\": '\\U000021CE',\n\t\"nharr;\": '\\U000021AE',\n\t\"nhpar;\": '\\U00002AF2',\n\t\"ni;\": '\\U0000220B',\n\t\"nis;\": '\\U000022FC',\n\t\"nisd;\": '\\U000022FA',\n\t\"niv;\": '\\U0000220B',\n\t\"njcy;\": '\\U0000045A',\n\t\"nlArr;\": '\\U000021CD',\n\t\"nlarr;\": '\\U0000219A',\n\t\"nldr;\": '\\U00002025',\n\t\"nle;\": '\\U00002270',\n\t\"nleftarrow;\": '\\U0000219A',\n\t\"nleftrightarrow;\": '\\U000021AE',\n\t\"nleq;\": '\\U00002270',\n\t\"nless;\": '\\U0000226E',\n\t\"nlsim;\": '\\U00002274',\n\t\"nlt;\": '\\U0000226E',\n\t\"nltri;\": '\\U000022EA',\n\t\"nltrie;\": '\\U000022EC',\n\t\"nmid;\": '\\U00002224',\n\t\"nopf;\": '\\U0001D55F',\n\t\"not;\": '\\U000000AC',\n\t\"notin;\": '\\U00002209',\n\t\"notinva;\": '\\U00002209',\n\t\"notinvb;\": '\\U000022F7',\n\t\"notinvc;\": '\\U000022F6',\n\t\"notni;\": '\\U0000220C',\n\t\"notniva;\": '\\U0000220C',\n\t\"notnivb;\": '\\U000022FE',\n\t\"notnivc;\": '\\U000022FD',\n\t\"npar;\": '\\U00002226',\n\t\"nparallel;\": '\\U00002226',\n\t\"npolint;\": '\\U00002A14',\n\t\"npr;\": '\\U00002280',\n\t\"nprcue;\": '\\U000022E0',\n\t\"nprec;\": '\\U00002280',\n\t\"nrArr;\": '\\U000021CF',\n\t\"nrarr;\": '\\U0000219B',\n\t\"nrightarrow;\": '\\U0000219B',\n\t\"nrtri;\": '\\U000022EB',\n\t\"nrtrie;\": '\\U000022ED',\n\t\"nsc;\": '\\U00002281',\n\t\"nsccue;\": '\\U000022E1',\n\t\"nscr;\": '\\U0001D4C3',\n\t\"nshortmid;\": '\\U00002224',\n\t\"nshortparallel;\": '\\U00002226',\n\t\"nsim;\": '\\U00002241',\n\t\"nsime;\": '\\U00002244',\n\t\"nsimeq;\": '\\U00002244',\n\t\"nsmid;\": '\\U00002224',\n\t\"nspar;\": '\\U00002226',\n\t\"nsqsube;\": '\\U000022E2',\n\t\"nsqsupe;\": '\\U000022E3',\n\t\"nsub;\": '\\U00002284',\n\t\"nsube;\": '\\U00002288',\n\t\"nsubseteq;\": '\\U00002288',\n\t\"nsucc;\": '\\U00002281',\n\t\"nsup;\": '\\U00002285',\n\t\"nsupe;\": '\\U00002289',\n\t\"nsupseteq;\": '\\U00002289',\n\t\"ntgl;\": '\\U00002279',\n\t\"ntilde;\": '\\U000000F1',\n\t\"ntlg;\": '\\U00002278',\n\t\"ntriangleleft;\": '\\U000022EA',\n\t\"ntrianglelefteq;\": '\\U000022EC',\n\t\"ntriangleright;\": '\\U000022EB',\n\t\"ntrianglerighteq;\": '\\U000022ED',\n\t\"nu;\": '\\U000003BD',\n\t\"num;\": '\\U00000023',\n\t\"numero;\": '\\U00002116',\n\t\"numsp;\": '\\U00002007',\n\t\"nvDash;\": '\\U000022AD',\n\t\"nvHarr;\": '\\U00002904',\n\t\"nvdash;\": '\\U000022AC',\n\t\"nvinfin;\": '\\U000029DE',\n\t\"nvlArr;\": '\\U00002902',\n\t\"nvrArr;\": '\\U00002903',\n\t\"nwArr;\": '\\U000021D6',\n\t\"nwarhk;\": '\\U00002923',\n\t\"nwarr;\": '\\U00002196',\n\t\"nwarrow;\": '\\U00002196',\n\t\"nwnear;\": '\\U00002927',\n\t\"oS;\": '\\U000024C8',\n\t\"oacute;\": '\\U000000F3',\n\t\"oast;\": '\\U0000229B',\n\t\"ocir;\": '\\U0000229A',\n\t\"ocirc;\": '\\U000000F4',\n\t\"ocy;\": '\\U0000043E',\n\t\"odash;\": '\\U0000229D',\n\t\"odblac;\": '\\U00000151',\n\t\"odiv;\": '\\U00002A38',\n\t\"odot;\": '\\U00002299',\n\t\"odsold;\": '\\U000029BC',\n\t\"oelig;\": '\\U00000153',\n\t\"ofcir;\": '\\U000029BF',\n\t\"ofr;\": '\\U0001D52C',\n\t\"ogon;\": '\\U000002DB',\n\t\"ograve;\": '\\U000000F2',\n\t\"ogt;\": '\\U000029C1',\n\t\"ohbar;\": '\\U000029B5',\n\t\"ohm;\": '\\U000003A9',\n\t\"oint;\": '\\U0000222E',\n\t\"olarr;\": '\\U000021BA',\n\t\"olcir;\": '\\U000029BE',\n\t\"olcross;\": '\\U000029BB',\n\t\"oline;\": '\\U0000203E',\n\t\"olt;\": '\\U000029C0',\n\t\"omacr;\": '\\U0000014D',\n\t\"omega;\": '\\U000003C9',\n\t\"omicron;\": '\\U000003BF',\n\t\"omid;\": '\\U000029B6',\n\t\"ominus;\": '\\U00002296',\n\t\"oopf;\": '\\U0001D560',\n\t\"opar;\": '\\U000029B7',\n\t\"operp;\": '\\U000029B9',\n\t\"oplus;\": '\\U00002295',\n\t\"or;\": '\\U00002228',\n\t\"orarr;\": '\\U000021BB',\n\t\"ord;\": '\\U00002A5D',\n\t\"order;\": '\\U00002134',\n\t\"orderof;\": '\\U00002134',\n\t\"ordf;\": '\\U000000AA',\n\t\"ordm;\": '\\U000000BA',\n\t\"origof;\": '\\U000022B6',\n\t\"oror;\": '\\U00002A56',\n\t\"orslope;\": '\\U00002A57',\n\t\"orv;\": '\\U00002A5B',\n\t\"oscr;\": '\\U00002134',\n\t\"oslash;\": '\\U000000F8',\n\t\"osol;\": '\\U00002298',\n\t\"otilde;\": '\\U000000F5',\n\t\"otimes;\": '\\U00002297',\n\t\"otimesas;\": '\\U00002A36',\n\t\"ouml;\": '\\U000000F6',\n\t\"ovbar;\": '\\U0000233D',\n\t\"par;\": '\\U00002225',\n\t\"para;\": '\\U000000B6',\n\t\"parallel;\": '\\U00002225',\n\t\"parsim;\": '\\U00002AF3',\n\t\"parsl;\": '\\U00002AFD',\n\t\"part;\": '\\U00002202',\n\t\"pcy;\": '\\U0000043F',\n\t\"percnt;\": '\\U00000025',\n\t\"period;\": '\\U0000002E',\n\t\"permil;\": '\\U00002030',\n\t\"perp;\": '\\U000022A5',\n\t\"pertenk;\": '\\U00002031',\n\t\"pfr;\": '\\U0001D52D',\n\t\"phi;\": '\\U000003C6',\n\t\"phiv;\": '\\U000003D5',\n\t\"phmmat;\": '\\U00002133',\n\t\"phone;\": '\\U0000260E',\n\t\"pi;\": '\\U000003C0',\n\t\"pitchfork;\": '\\U000022D4',\n\t\"piv;\": '\\U000003D6',\n\t\"planck;\": '\\U0000210F',\n\t\"planckh;\": '\\U0000210E',\n\t\"plankv;\": '\\U0000210F',\n\t\"plus;\": '\\U0000002B',\n\t\"plusacir;\": '\\U00002A23',\n\t\"plusb;\": '\\U0000229E',\n\t\"pluscir;\": '\\U00002A22',\n\t\"plusdo;\": '\\U00002214',\n\t\"plusdu;\": '\\U00002A25',\n\t\"pluse;\": '\\U00002A72',\n\t\"plusmn;\": '\\U000000B1',\n\t\"plussim;\": '\\U00002A26',\n\t\"plustwo;\": '\\U00002A27',\n\t\"pm;\": '\\U000000B1',\n\t\"pointint;\": '\\U00002A15',\n\t\"popf;\": '\\U0001D561',\n\t\"pound;\": '\\U000000A3',\n\t\"pr;\": '\\U0000227A',\n\t\"prE;\": '\\U00002AB3',\n\t\"prap;\": '\\U00002AB7',\n\t\"prcue;\": '\\U0000227C',\n\t\"pre;\": '\\U00002AAF',\n\t\"prec;\": '\\U0000227A',\n\t\"precapprox;\": '\\U00002AB7',\n\t\"preccurlyeq;\": '\\U0000227C',\n\t\"preceq;\": '\\U00002AAF',\n\t\"precnapprox;\": '\\U00002AB9',\n\t\"precneqq;\": '\\U00002AB5',\n\t\"precnsim;\": '\\U000022E8',\n\t\"precsim;\": '\\U0000227E',\n\t\"prime;\": '\\U00002032',\n\t\"primes;\": '\\U00002119',\n\t\"prnE;\": '\\U00002AB5',\n\t\"prnap;\": '\\U00002AB9',\n\t\"prnsim;\": '\\U000022E8',\n\t\"prod;\": '\\U0000220F',\n\t\"profalar;\": '\\U0000232E',\n\t\"profline;\": '\\U00002312',\n\t\"profsurf;\": '\\U00002313',\n\t\"prop;\": '\\U0000221D',\n\t\"propto;\": '\\U0000221D',\n\t\"prsim;\": '\\U0000227E',\n\t\"prurel;\": '\\U000022B0',\n\t\"pscr;\": '\\U0001D4C5',\n\t\"psi;\": '\\U000003C8',\n\t\"puncsp;\": '\\U00002008',\n\t\"qfr;\": '\\U0001D52E',\n\t\"qint;\": '\\U00002A0C',\n\t\"qopf;\": '\\U0001D562',\n\t\"qprime;\": '\\U00002057',\n\t\"qscr;\": '\\U0001D4C6',\n\t\"quaternions;\": '\\U0000210D',\n\t\"quatint;\": '\\U00002A16',\n\t\"quest;\": '\\U0000003F',\n\t\"questeq;\": '\\U0000225F',\n\t\"quot;\": '\\U00000022',\n\t\"rAarr;\": '\\U000021DB',\n\t\"rArr;\": '\\U000021D2',\n\t\"rAtail;\": '\\U0000291C',\n\t\"rBarr;\": '\\U0000290F',\n\t\"rHar;\": '\\U00002964',\n\t\"racute;\": '\\U00000155',\n\t\"radic;\": '\\U0000221A',\n\t\"raemptyv;\": '\\U000029B3',\n\t\"rang;\": '\\U000027E9',\n\t\"rangd;\": '\\U00002992',\n\t\"range;\": '\\U000029A5',\n\t\"rangle;\": '\\U000027E9',\n\t\"raquo;\": '\\U000000BB',\n\t\"rarr;\": '\\U00002192',\n\t\"rarrap;\": '\\U00002975',\n\t\"rarrb;\": '\\U000021E5',\n\t\"rarrbfs;\": '\\U00002920',\n\t\"rarrc;\": '\\U00002933',\n\t\"rarrfs;\": '\\U0000291E',\n\t\"rarrhk;\": '\\U000021AA',\n\t\"rarrlp;\": '\\U000021AC',\n\t\"rarrpl;\": '\\U00002945',\n\t\"rarrsim;\": '\\U00002974',\n\t\"rarrtl;\": '\\U000021A3',\n\t\"rarrw;\": '\\U0000219D',\n\t\"ratail;\": '\\U0000291A',\n\t\"ratio;\": '\\U00002236',\n\t\"rationals;\": '\\U0000211A',\n\t\"rbarr;\": '\\U0000290D',\n\t\"rbbrk;\": '\\U00002773',\n\t\"rbrace;\": '\\U0000007D',\n\t\"rbrack;\": '\\U0000005D',\n\t\"rbrke;\": '\\U0000298C',\n\t\"rbrksld;\": '\\U0000298E',\n\t\"rbrkslu;\": '\\U00002990',\n\t\"rcaron;\": '\\U00000159',\n\t\"rcedil;\": '\\U00000157',\n\t\"rceil;\": '\\U00002309',\n\t\"rcub;\": '\\U0000007D',\n\t\"rcy;\": '\\U00000440',\n\t\"rdca;\": '\\U00002937',\n\t\"rdldhar;\": '\\U00002969',\n\t\"rdquo;\": '\\U0000201D',\n\t\"rdquor;\": '\\U0000201D',\n\t\"rdsh;\": '\\U000021B3',\n\t\"real;\": '\\U0000211C',\n\t\"realine;\": '\\U0000211B',\n\t\"realpart;\": '\\U0000211C',\n\t\"reals;\": '\\U0000211D',\n\t\"rect;\": '\\U000025AD',\n\t\"reg;\": '\\U000000AE',\n\t\"rfisht;\": '\\U0000297D',\n\t\"rfloor;\": '\\U0000230B',\n\t\"rfr;\": '\\U0001D52F',\n\t\"rhard;\": '\\U000021C1',\n\t\"rharu;\": '\\U000021C0',\n\t\"rharul;\": '\\U0000296C',\n\t\"rho;\": '\\U000003C1',\n\t\"rhov;\": '\\U000003F1',\n\t\"rightarrow;\": '\\U00002192',\n\t\"rightarrowtail;\": '\\U000021A3',\n\t\"rightharpoondown;\": '\\U000021C1',\n\t\"rightharpoonup;\": '\\U000021C0',\n\t\"rightleftarrows;\": '\\U000021C4',\n\t\"rightleftharpoons;\": '\\U000021CC',\n\t\"rightrightarrows;\": '\\U000021C9',\n\t\"rightsquigarrow;\": '\\U0000219D',\n\t\"rightthreetimes;\": '\\U000022CC',\n\t\"ring;\": '\\U000002DA',\n\t\"risingdotseq;\": '\\U00002253',\n\t\"rlarr;\": '\\U000021C4',\n\t\"rlhar;\": '\\U000021CC',\n\t\"rlm;\": '\\U0000200F',\n\t\"rmoust;\": '\\U000023B1',\n\t\"rmoustache;\": '\\U000023B1',\n\t\"rnmid;\": '\\U00002AEE',\n\t\"roang;\": '\\U000027ED',\n\t\"roarr;\": '\\U000021FE',\n\t\"robrk;\": '\\U000027E7',\n\t\"ropar;\": '\\U00002986',\n\t\"ropf;\": '\\U0001D563',\n\t\"roplus;\": '\\U00002A2E',\n\t\"rotimes;\": '\\U00002A35',\n\t\"rpar;\": '\\U00000029',\n\t\"rpargt;\": '\\U00002994',\n\t\"rppolint;\": '\\U00002A12',\n\t\"rrarr;\": '\\U000021C9',\n\t\"rsaquo;\": '\\U0000203A',\n\t\"rscr;\": '\\U0001D4C7',\n\t\"rsh;\": '\\U000021B1',\n\t\"rsqb;\": '\\U0000005D',\n\t\"rsquo;\": '\\U00002019',\n\t\"rsquor;\": '\\U00002019',\n\t\"rthree;\": '\\U000022CC',\n\t\"rtimes;\": '\\U000022CA',\n\t\"rtri;\": '\\U000025B9',\n\t\"rtrie;\": '\\U000022B5',\n\t\"rtrif;\": '\\U000025B8',\n\t\"rtriltri;\": '\\U000029CE',\n\t\"ruluhar;\": '\\U00002968',\n\t\"rx;\": '\\U0000211E',\n\t\"sacute;\": '\\U0000015B',\n\t\"sbquo;\": '\\U0000201A',\n\t\"sc;\": '\\U0000227B',\n\t\"scE;\": '\\U00002AB4',\n\t\"scap;\": '\\U00002AB8',\n\t\"scaron;\": '\\U00000161',\n\t\"sccue;\": '\\U0000227D',\n\t\"sce;\": '\\U00002AB0',\n\t\"scedil;\": '\\U0000015F',\n\t\"scirc;\": '\\U0000015D',\n\t\"scnE;\": '\\U00002AB6',\n\t\"scnap;\": '\\U00002ABA',\n\t\"scnsim;\": '\\U000022E9',\n\t\"scpolint;\": '\\U00002A13',\n\t\"scsim;\": '\\U0000227F',\n\t\"scy;\": '\\U00000441',\n\t\"sdot;\": '\\U000022C5',\n\t\"sdotb;\": '\\U000022A1',\n\t\"sdote;\": '\\U00002A66',\n\t\"seArr;\": '\\U000021D8',\n\t\"searhk;\": '\\U00002925',\n\t\"searr;\": '\\U00002198',\n\t\"searrow;\": '\\U00002198',\n\t\"sect;\": '\\U000000A7',\n\t\"semi;\": '\\U0000003B',\n\t\"seswar;\": '\\U00002929',\n\t\"setminus;\": '\\U00002216',\n\t\"setmn;\": '\\U00002216',\n\t\"sext;\": '\\U00002736',\n\t\"sfr;\": '\\U0001D530',\n\t\"sfrown;\": '\\U00002322',\n\t\"sharp;\": '\\U0000266F',\n\t\"shchcy;\": '\\U00000449',\n\t\"shcy;\": '\\U00000448',\n\t\"shortmid;\": '\\U00002223',\n\t\"shortparallel;\": '\\U00002225',\n\t\"shy;\": '\\U000000AD',\n\t\"sigma;\": '\\U000003C3',\n\t\"sigmaf;\": '\\U000003C2',\n\t\"sigmav;\": '\\U000003C2',\n\t\"sim;\": '\\U0000223C',\n\t\"simdot;\": '\\U00002A6A',\n\t\"sime;\": '\\U00002243',\n\t\"simeq;\": '\\U00002243',\n\t\"simg;\": '\\U00002A9E',\n\t\"simgE;\": '\\U00002AA0',\n\t\"siml;\": '\\U00002A9D',\n\t\"simlE;\": '\\U00002A9F',\n\t\"simne;\": '\\U00002246',\n\t\"simplus;\": '\\U00002A24',\n\t\"simrarr;\": '\\U00002972',\n\t\"slarr;\": '\\U00002190',\n\t\"smallsetminus;\": '\\U00002216',\n\t\"smashp;\": '\\U00002A33',\n\t\"smeparsl;\": '\\U000029E4',\n\t\"smid;\": '\\U00002223',\n\t\"smile;\": '\\U00002323',\n\t\"smt;\": '\\U00002AAA',\n\t\"smte;\": '\\U00002AAC',\n\t\"softcy;\": '\\U0000044C',\n\t\"sol;\": '\\U0000002F',\n\t\"solb;\": '\\U000029C4',\n\t\"solbar;\": '\\U0000233F',\n\t\"sopf;\": '\\U0001D564',\n\t\"spades;\": '\\U00002660',\n\t\"spadesuit;\": '\\U00002660',\n\t\"spar;\": '\\U00002225',\n\t\"sqcap;\": '\\U00002293',\n\t\"sqcup;\": '\\U00002294',\n\t\"sqsub;\": '\\U0000228F',\n\t\"sqsube;\": '\\U00002291',\n\t\"sqsubset;\": '\\U0000228F',\n\t\"sqsubseteq;\": '\\U00002291',\n\t\"sqsup;\": '\\U00002290',\n\t\"sqsupe;\": '\\U00002292',\n\t\"sqsupset;\": '\\U00002290',\n\t\"sqsupseteq;\": '\\U00002292',\n\t\"squ;\": '\\U000025A1',\n\t\"square;\": '\\U000025A1',\n\t\"squarf;\": '\\U000025AA',\n\t\"squf;\": '\\U000025AA',\n\t\"srarr;\": '\\U00002192',\n\t\"sscr;\": '\\U0001D4C8',\n\t\"ssetmn;\": '\\U00002216',\n\t\"ssmile;\": '\\U00002323',\n\t\"sstarf;\": '\\U000022C6',\n\t\"star;\": '\\U00002606',\n\t\"starf;\": '\\U00002605',\n\t\"straightepsilon;\": '\\U000003F5',\n\t\"straightphi;\": '\\U000003D5',\n\t\"strns;\": '\\U000000AF',\n\t\"sub;\": '\\U00002282',\n\t\"subE;\": '\\U00002AC5',\n\t\"subdot;\": '\\U00002ABD',\n\t\"sube;\": '\\U00002286',\n\t\"subedot;\": '\\U00002AC3',\n\t\"submult;\": '\\U00002AC1',\n\t\"subnE;\": '\\U00002ACB',\n\t\"subne;\": '\\U0000228A',\n\t\"subplus;\": '\\U00002ABF',\n\t\"subrarr;\": '\\U00002979',\n\t\"subset;\": '\\U00002282',\n\t\"subseteq;\": '\\U00002286',\n\t\"subseteqq;\": '\\U00002AC5',\n\t\"subsetneq;\": '\\U0000228A',\n\t\"subsetneqq;\": '\\U00002ACB',\n\t\"subsim;\": '\\U00002AC7',\n\t\"subsub;\": '\\U00002AD5',\n\t\"subsup;\": '\\U00002AD3',\n\t\"succ;\": '\\U0000227B',\n\t\"succapprox;\": '\\U00002AB8',\n\t\"succcurlyeq;\": '\\U0000227D',\n\t\"succeq;\": '\\U00002AB0',\n\t\"succnapprox;\": '\\U00002ABA',\n\t\"succneqq;\": '\\U00002AB6',\n\t\"succnsim;\": '\\U000022E9',\n\t\"succsim;\": '\\U0000227F',\n\t\"sum;\": '\\U00002211',\n\t\"sung;\": '\\U0000266A',\n\t\"sup;\": '\\U00002283',\n\t\"sup1;\": '\\U000000B9',\n\t\"sup2;\": '\\U000000B2',\n\t\"sup3;\": '\\U000000B3',\n\t\"supE;\": '\\U00002AC6',\n\t\"supdot;\": '\\U00002ABE',\n\t\"supdsub;\": '\\U00002AD8',\n\t\"supe;\": '\\U00002287',\n\t\"supedot;\": '\\U00002AC4',\n\t\"suphsol;\": '\\U000027C9',\n\t\"suphsub;\": '\\U00002AD7',\n\t\"suplarr;\": '\\U0000297B',\n\t\"supmult;\": '\\U00002AC2',\n\t\"supnE;\": '\\U00002ACC',\n\t\"supne;\": '\\U0000228B',\n\t\"supplus;\": '\\U00002AC0',\n\t\"supset;\": '\\U00002283',\n\t\"supseteq;\": '\\U00002287',\n\t\"supseteqq;\": '\\U00002AC6',\n\t\"supsetneq;\": '\\U0000228B',\n\t\"supsetneqq;\": '\\U00002ACC',\n\t\"supsim;\": '\\U00002AC8',\n\t\"supsub;\": '\\U00002AD4',\n\t\"supsup;\": '\\U00002AD6',\n\t\"swArr;\": '\\U000021D9',\n\t\"swarhk;\": '\\U00002926',\n\t\"swarr;\": '\\U00002199',\n\t\"swarrow;\": '\\U00002199',\n\t\"swnwar;\": '\\U0000292A',\n\t\"szlig;\": '\\U000000DF',\n\t\"target;\": '\\U00002316',\n\t\"tau;\": '\\U000003C4',\n\t\"tbrk;\": '\\U000023B4',\n\t\"tcaron;\": '\\U00000165',\n\t\"tcedil;\": '\\U00000163',\n\t\"tcy;\": '\\U00000442',\n\t\"tdot;\": '\\U000020DB',\n\t\"telrec;\": '\\U00002315',\n\t\"tfr;\": '\\U0001D531',\n\t\"there4;\": '\\U00002234',\n\t\"therefore;\": '\\U00002234',\n\t\"theta;\": '\\U000003B8',\n\t\"thetasym;\": '\\U000003D1',\n\t\"thetav;\": '\\U000003D1',\n\t\"thickapprox;\": '\\U00002248',\n\t\"thicksim;\": '\\U0000223C',\n\t\"thinsp;\": '\\U00002009',\n\t\"thkap;\": '\\U00002248',\n\t\"thksim;\": '\\U0000223C',\n\t\"thorn;\": '\\U000000FE',\n\t\"tilde;\": '\\U000002DC',\n\t\"times;\": '\\U000000D7',\n\t\"timesb;\": '\\U000022A0',\n\t\"timesbar;\": '\\U00002A31',\n\t\"timesd;\": '\\U00002A30',\n\t\"tint;\": '\\U0000222D',\n\t\"toea;\": '\\U00002928',\n\t\"top;\": '\\U000022A4',\n\t\"topbot;\": '\\U00002336',\n\t\"topcir;\": '\\U00002AF1',\n\t\"topf;\": '\\U0001D565',\n\t\"topfork;\": '\\U00002ADA',\n\t\"tosa;\": '\\U00002929',\n\t\"tprime;\": '\\U00002034',\n\t\"trade;\": '\\U00002122',\n\t\"triangle;\": '\\U000025B5',\n\t\"triangledown;\": '\\U000025BF',\n\t\"triangleleft;\": '\\U000025C3',\n\t\"trianglelefteq;\": '\\U000022B4',\n\t\"triangleq;\": '\\U0000225C',\n\t\"triangleright;\": '\\U000025B9',\n\t\"trianglerighteq;\": '\\U000022B5',\n\t\"tridot;\": '\\U000025EC',\n\t\"trie;\": '\\U0000225C',\n\t\"triminus;\": '\\U00002A3A',\n\t\"triplus;\": '\\U00002A39',\n\t\"trisb;\": '\\U000029CD',\n\t\"tritime;\": '\\U00002A3B',\n\t\"trpezium;\": '\\U000023E2',\n\t\"tscr;\": '\\U0001D4C9',\n\t\"tscy;\": '\\U00000446',\n\t\"tshcy;\": '\\U0000045B',\n\t\"tstrok;\": '\\U00000167',\n\t\"twixt;\": '\\U0000226C',\n\t\"twoheadleftarrow;\": '\\U0000219E',\n\t\"twoheadrightarrow;\": '\\U000021A0',\n\t\"uArr;\": '\\U000021D1',\n\t\"uHar;\": '\\U00002963',\n\t\"uacute;\": '\\U000000FA',\n\t\"uarr;\": '\\U00002191',\n\t\"ubrcy;\": '\\U0000045E',\n\t\"ubreve;\": '\\U0000016D',\n\t\"ucirc;\": '\\U000000FB',\n\t\"ucy;\": '\\U00000443',\n\t\"udarr;\": '\\U000021C5',\n\t\"udblac;\": '\\U00000171',\n\t\"udhar;\": '\\U0000296E',\n\t\"ufisht;\": '\\U0000297E',\n\t\"ufr;\": '\\U0001D532',\n\t\"ugrave;\": '\\U000000F9',\n\t\"uharl;\": '\\U000021BF',\n\t\"uharr;\": '\\U000021BE',\n\t\"uhblk;\": '\\U00002580',\n\t\"ulcorn;\": '\\U0000231C',\n\t\"ulcorner;\": '\\U0000231C',\n\t\"ulcrop;\": '\\U0000230F',\n\t\"ultri;\": '\\U000025F8',\n\t\"umacr;\": '\\U0000016B',\n\t\"uml;\": '\\U000000A8',\n\t\"uogon;\": '\\U00000173',\n\t\"uopf;\": '\\U0001D566',\n\t\"uparrow;\": '\\U00002191',\n\t\"updownarrow;\": '\\U00002195',\n\t\"upharpoonleft;\": '\\U000021BF',\n\t\"upharpoonright;\": '\\U000021BE',\n\t\"uplus;\": '\\U0000228E',\n\t\"upsi;\": '\\U000003C5',\n\t\"upsih;\": '\\U000003D2',\n\t\"upsilon;\": '\\U000003C5',\n\t\"upuparrows;\": '\\U000021C8',\n\t\"urcorn;\": '\\U0000231D',\n\t\"urcorner;\": '\\U0000231D',\n\t\"urcrop;\": '\\U0000230E',\n\t\"uring;\": '\\U0000016F',\n\t\"urtri;\": '\\U000025F9',\n\t\"uscr;\": '\\U0001D4CA',\n\t\"utdot;\": '\\U000022F0',\n\t\"utilde;\": '\\U00000169',\n\t\"utri;\": '\\U000025B5',\n\t\"utrif;\": '\\U000025B4',\n\t\"uuarr;\": '\\U000021C8',\n\t\"uuml;\": '\\U000000FC',\n\t\"uwangle;\": '\\U000029A7',\n\t\"vArr;\": '\\U000021D5',\n\t\"vBar;\": '\\U00002AE8',\n\t\"vBarv;\": '\\U00002AE9',\n\t\"vDash;\": '\\U000022A8',\n\t\"vangrt;\": '\\U0000299C',\n\t\"varepsilon;\": '\\U000003F5',\n\t\"varkappa;\": '\\U000003F0',\n\t\"varnothing;\": '\\U00002205',\n\t\"varphi;\": '\\U000003D5',\n\t\"varpi;\": '\\U000003D6',\n\t\"varpropto;\": '\\U0000221D',\n\t\"varr;\": '\\U00002195',\n\t\"varrho;\": '\\U000003F1',\n\t\"varsigma;\": '\\U000003C2',\n\t\"vartheta;\": '\\U000003D1',\n\t\"vartriangleleft;\": '\\U000022B2',\n\t\"vartriangleright;\": '\\U000022B3',\n\t\"vcy;\": '\\U00000432',\n\t\"vdash;\": '\\U000022A2',\n\t\"vee;\": '\\U00002228',\n\t\"veebar;\": '\\U000022BB',\n\t\"veeeq;\": '\\U0000225A',\n\t\"vellip;\": '\\U000022EE',\n\t\"verbar;\": '\\U0000007C',\n\t\"vert;\": '\\U0000007C',\n\t\"vfr;\": '\\U0001D533',\n\t\"vltri;\": '\\U000022B2',\n\t\"vopf;\": '\\U0001D567',\n\t\"vprop;\": '\\U0000221D',\n\t\"vrtri;\": '\\U000022B3',\n\t\"vscr;\": '\\U0001D4CB',\n\t\"vzigzag;\": '\\U0000299A',\n\t\"wcirc;\": '\\U00000175',\n\t\"wedbar;\": '\\U00002A5F',\n\t\"wedge;\": '\\U00002227',\n\t\"wedgeq;\": '\\U00002259',\n\t\"weierp;\": '\\U00002118',\n\t\"wfr;\": '\\U0001D534',\n\t\"wopf;\": '\\U0001D568',\n\t\"wp;\": '\\U00002118',\n\t\"wr;\": '\\U00002240',\n\t\"wreath;\": '\\U00002240',\n\t\"wscr;\": '\\U0001D4CC',\n\t\"xcap;\": '\\U000022C2',\n\t\"xcirc;\": '\\U000025EF',\n\t\"xcup;\": '\\U000022C3',\n\t\"xdtri;\": '\\U000025BD',\n\t\"xfr;\": '\\U0001D535',\n\t\"xhArr;\": '\\U000027FA',\n\t\"xharr;\": '\\U000027F7',\n\t\"xi;\": '\\U000003BE',\n\t\"xlArr;\": '\\U000027F8',\n\t\"xlarr;\": '\\U000027F5',\n\t\"xmap;\": '\\U000027FC',\n\t\"xnis;\": '\\U000022FB',\n\t\"xodot;\": '\\U00002A00',\n\t\"xopf;\": '\\U0001D569',\n\t\"xoplus;\": '\\U00002A01',\n\t\"xotime;\": '\\U00002A02',\n\t\"xrArr;\": '\\U000027F9',\n\t\"xrarr;\": '\\U000027F6',\n\t\"xscr;\": '\\U0001D4CD',\n\t\"xsqcup;\": '\\U00002A06',\n\t\"xuplus;\": '\\U00002A04',\n\t\"xutri;\": '\\U000025B3',\n\t\"xvee;\": '\\U000022C1',\n\t\"xwedge;\": '\\U000022C0',\n\t\"yacute;\": '\\U000000FD',\n\t\"yacy;\": '\\U0000044F',\n\t\"ycirc;\": '\\U00000177',\n\t\"ycy;\": '\\U0000044B',\n\t\"yen;\": '\\U000000A5',\n\t\"yfr;\": '\\U0001D536',\n\t\"yicy;\": '\\U00000457',\n\t\"yopf;\": '\\U0001D56A',\n\t\"yscr;\": '\\U0001D4CE',\n\t\"yucy;\": '\\U0000044E',\n\t\"yuml;\": '\\U000000FF',\n\t\"zacute;\": '\\U0000017A',\n\t\"zcaron;\": '\\U0000017E',\n\t\"zcy;\": '\\U00000437',\n\t\"zdot;\": '\\U0000017C',\n\t\"zeetrf;\": '\\U00002128',\n\t\"zeta;\": '\\U000003B6',\n\t\"zfr;\": '\\U0001D537',\n\t\"zhcy;\": '\\U00000436',\n\t\"zigrarr;\": '\\U000021DD',\n\t\"zopf;\": '\\U0001D56B',\n\t\"zscr;\": '\\U0001D4CF',\n\t\"zwj;\": '\\U0000200D',\n\t\"zwnj;\": '\\U0000200C',\n\t\"AElig\": '\\U000000C6',\n\t\"AMP\": '\\U00000026',\n\t\"Aacute\": '\\U000000C1',\n\t\"Acirc\": '\\U000000C2',\n\t\"Agrave\": '\\U000000C0',\n\t\"Aring\": '\\U000000C5',\n\t\"Atilde\": '\\U000000C3',\n\t\"Auml\": '\\U000000C4',\n\t\"COPY\": '\\U000000A9',\n\t\"Ccedil\": '\\U000000C7',\n\t\"ETH\": '\\U000000D0',\n\t\"Eacute\": '\\U000000C9',\n\t\"Ecirc\": '\\U000000CA',\n\t\"Egrave\": '\\U000000C8',\n\t\"Euml\": '\\U000000CB',\n\t\"GT\": '\\U0000003E',\n\t\"Iacute\": '\\U000000CD',\n\t\"Icirc\": '\\U000000CE',\n\t\"Igrave\": '\\U000000CC',\n\t\"Iuml\": '\\U000000CF',\n\t\"LT\": '\\U0000003C',\n\t\"Ntilde\": '\\U000000D1',\n\t\"Oacute\": '\\U000000D3',\n\t\"Ocirc\": '\\U000000D4',\n\t\"Ograve\": '\\U000000D2',\n\t\"Oslash\": '\\U000000D8',\n\t\"Otilde\": '\\U000000D5',\n\t\"Ouml\": '\\U000000D6',\n\t\"QUOT\": '\\U00000022',\n\t\"REG\": '\\U000000AE',\n\t\"THORN\": '\\U000000DE',\n\t\"Uacute\": '\\U000000DA',\n\t\"Ucirc\": '\\U000000DB',\n\t\"Ugrave\": '\\U000000D9',\n\t\"Uuml\": '\\U000000DC',\n\t\"Yacute\": '\\U000000DD',\n\t\"aacute\": '\\U000000E1',\n\t\"acirc\": '\\U000000E2',\n\t\"acute\": '\\U000000B4',\n\t\"aelig\": '\\U000000E6',\n\t\"agrave\": '\\U000000E0',\n\t\"amp\": '\\U00000026',\n\t\"aring\": '\\U000000E5',\n\t\"atilde\": '\\U000000E3',\n\t\"auml\": '\\U000000E4',\n\t\"brvbar\": '\\U000000A6',\n\t\"ccedil\": '\\U000000E7',\n\t\"cedil\": '\\U000000B8',\n\t\"cent\": '\\U000000A2',\n\t\"copy\": '\\U000000A9',\n\t\"curren\": '\\U000000A4',\n\t\"deg\": '\\U000000B0',\n\t\"divide\": '\\U000000F7',\n\t\"eacute\": '\\U000000E9',\n\t\"ecirc\": '\\U000000EA',\n\t\"egrave\": '\\U000000E8',\n\t\"eth\": '\\U000000F0',\n\t\"euml\": '\\U000000EB',\n\t\"frac12\": '\\U000000BD',\n\t\"frac14\": '\\U000000BC',\n\t\"frac34\": '\\U000000BE',\n\t\"gt\": '\\U0000003E',\n\t\"iacute\": '\\U000000ED',\n\t\"icirc\": '\\U000000EE',\n\t\"iexcl\": '\\U000000A1',\n\t\"igrave\": '\\U000000EC',\n\t\"iquest\": '\\U000000BF',\n\t\"iuml\": '\\U000000EF',\n\t\"laquo\": '\\U000000AB',\n\t\"lt\": '\\U0000003C',\n\t\"macr\": '\\U000000AF',\n\t\"micro\": '\\U000000B5',\n\t\"middot\": '\\U000000B7',\n\t\"nbsp\": '\\U000000A0',\n\t\"not\": '\\U000000AC',\n\t\"ntilde\": '\\U000000F1',\n\t\"oacute\": '\\U000000F3',\n\t\"ocirc\": '\\U000000F4',\n\t\"ograve\": '\\U000000F2',\n\t\"ordf\": '\\U000000AA',\n\t\"ordm\": '\\U000000BA',\n\t\"oslash\": '\\U000000F8',\n\t\"otilde\": '\\U000000F5',\n\t\"ouml\": '\\U000000F6',\n\t\"para\": '\\U000000B6',\n\t\"plusmn\": '\\U000000B1',\n\t\"pound\": '\\U000000A3',\n\t\"quot\": '\\U00000022',\n\t\"raquo\": '\\U000000BB',\n\t\"reg\": '\\U000000AE',\n\t\"sect\": '\\U000000A7',\n\t\"shy\": '\\U000000AD',\n\t\"sup1\": '\\U000000B9',\n\t\"sup2\": '\\U000000B2',\n\t\"sup3\": '\\U000000B3',\n\t\"szlig\": '\\U000000DF',\n\t\"thorn\": '\\U000000FE',\n\t\"times\": '\\U000000D7',\n\t\"uacute\": '\\U000000FA',\n\t\"ucirc\": '\\U000000FB',\n\t\"ugrave\": '\\U000000F9',\n\t\"uml\": '\\U000000A8',\n\t\"uuml\": '\\U000000FC',\n\t\"yacute\": '\\U000000FD',\n\t\"yen\": '\\U000000A5',\n\t\"yuml\": '\\U000000FF',\n}\n\n// HTML entities that are two unicode codepoints.\nvar entity2 = map[string][2]rune{\n\t// TODO(nigeltao): Handle replacements that are wider than their names.\n\t// \"nLt;\": {'\\u226A', '\\u20D2'},\n\t// \"nGt;\": {'\\u226B', '\\u20D2'},\n\t\"NotEqualTilde;\": {'\\u2242', '\\u0338'},\n\t\"NotGreaterFullEqual;\": {'\\u2267', '\\u0338'},\n\t\"NotGreaterGreater;\": {'\\u226B', '\\u0338'},\n\t\"NotGreaterSlantEqual;\": {'\\u2A7E', '\\u0338'},\n\t\"NotHumpDownHump;\": {'\\u224E', '\\u0338'},\n\t\"NotHumpEqual;\": {'\\u224F', '\\u0338'},\n\t\"NotLeftTriangleBar;\": {'\\u29CF', '\\u0338'},\n\t\"NotLessLess;\": {'\\u226A', '\\u0338'},\n\t\"NotLessSlantEqual;\": {'\\u2A7D', '\\u0338'},\n\t\"NotNestedGreaterGreater;\": {'\\u2AA2', '\\u0338'},\n\t\"NotNestedLessLess;\": {'\\u2AA1', '\\u0338'},\n\t\"NotPrecedesEqual;\": {'\\u2AAF', '\\u0338'},\n\t\"NotRightTriangleBar;\": {'\\u29D0', '\\u0338'},\n\t\"NotSquareSubset;\": {'\\u228F', '\\u0338'},\n\t\"NotSquareSuperset;\": {'\\u2290', '\\u0338'},\n\t\"NotSubset;\": {'\\u2282', '\\u20D2'},\n\t\"NotSucceedsEqual;\": {'\\u2AB0', '\\u0338'},\n\t\"NotSucceedsTilde;\": {'\\u227F', '\\u0338'},\n\t\"NotSuperset;\": {'\\u2283', '\\u20D2'},\n\t\"ThickSpace;\": {'\\u205F', '\\u200A'},\n\t\"acE;\": {'\\u223E', '\\u0333'},\n\t\"bne;\": {'\\u003D', '\\u20E5'},\n\t\"bnequiv;\": {'\\u2261', '\\u20E5'},\n\t\"caps;\": {'\\u2229', '\\uFE00'},\n\t\"cups;\": {'\\u222A', '\\uFE00'},\n\t\"fjlig;\": {'\\u0066', '\\u006A'},\n\t\"gesl;\": {'\\u22DB', '\\uFE00'},\n\t\"gvertneqq;\": {'\\u2269', '\\uFE00'},\n\t\"gvnE;\": {'\\u2269', '\\uFE00'},\n\t\"lates;\": {'\\u2AAD', '\\uFE00'},\n\t\"lesg;\": {'\\u22DA', '\\uFE00'},\n\t\"lvertneqq;\": {'\\u2268', '\\uFE00'},\n\t\"lvnE;\": {'\\u2268', '\\uFE00'},\n\t\"nGg;\": {'\\u22D9', '\\u0338'},\n\t\"nGtv;\": {'\\u226B', '\\u0338'},\n\t\"nLl;\": {'\\u22D8', '\\u0338'},\n\t\"nLtv;\": {'\\u226A', '\\u0338'},\n\t\"nang;\": {'\\u2220', '\\u20D2'},\n\t\"napE;\": {'\\u2A70', '\\u0338'},\n\t\"napid;\": {'\\u224B', '\\u0338'},\n\t\"nbump;\": {'\\u224E', '\\u0338'},\n\t\"nbumpe;\": {'\\u224F', '\\u0338'},\n\t\"ncongdot;\": {'\\u2A6D', '\\u0338'},\n\t\"nedot;\": {'\\u2250', '\\u0338'},\n\t\"nesim;\": {'\\u2242', '\\u0338'},\n\t\"ngE;\": {'\\u2267', '\\u0338'},\n\t\"ngeqq;\": {'\\u2267', '\\u0338'},\n\t\"ngeqslant;\": {'\\u2A7E', '\\u0338'},\n\t\"nges;\": {'\\u2A7E', '\\u0338'},\n\t\"nlE;\": {'\\u2266', '\\u0338'},\n\t\"nleqq;\": {'\\u2266', '\\u0338'},\n\t\"nleqslant;\": {'\\u2A7D', '\\u0338'},\n\t\"nles;\": {'\\u2A7D', '\\u0338'},\n\t\"notinE;\": {'\\u22F9', '\\u0338'},\n\t\"notindot;\": {'\\u22F5', '\\u0338'},\n\t\"nparsl;\": {'\\u2AFD', '\\u20E5'},\n\t\"npart;\": {'\\u2202', '\\u0338'},\n\t\"npre;\": {'\\u2AAF', '\\u0338'},\n\t\"npreceq;\": {'\\u2AAF', '\\u0338'},\n\t\"nrarrc;\": {'\\u2933', '\\u0338'},\n\t\"nrarrw;\": {'\\u219D', '\\u0338'},\n\t\"nsce;\": {'\\u2AB0', '\\u0338'},\n\t\"nsubE;\": {'\\u2AC5', '\\u0338'},\n\t\"nsubset;\": {'\\u2282', '\\u20D2'},\n\t\"nsubseteqq;\": {'\\u2AC5', '\\u0338'},\n\t\"nsucceq;\": {'\\u2AB0', '\\u0338'},\n\t\"nsupE;\": {'\\u2AC6', '\\u0338'},\n\t\"nsupset;\": {'\\u2283', '\\u20D2'},\n\t\"nsupseteqq;\": {'\\u2AC6', '\\u0338'},\n\t\"nvap;\": {'\\u224D', '\\u20D2'},\n\t\"nvge;\": {'\\u2265', '\\u20D2'},\n\t\"nvgt;\": {'\\u003E', '\\u20D2'},\n\t\"nvle;\": {'\\u2264', '\\u20D2'},\n\t\"nvlt;\": {'\\u003C', '\\u20D2'},\n\t\"nvltrie;\": {'\\u22B4', '\\u20D2'},\n\t\"nvrtrie;\": {'\\u22B5', '\\u20D2'},\n\t\"nvsim;\": {'\\u223C', '\\u20D2'},\n\t\"race;\": {'\\u223D', '\\u0331'},\n\t\"smtes;\": {'\\u2AAC', '\\uFE00'},\n\t\"sqcaps;\": {'\\u2293', '\\uFE00'},\n\t\"sqcups;\": {'\\u2294', '\\uFE00'},\n\t\"varsubsetneq;\": {'\\u228A', '\\uFE00'},\n\t\"varsubsetneqq;\": {'\\u2ACB', '\\uFE00'},\n\t\"varsupsetneq;\": {'\\u228B', '\\uFE00'},\n\t\"varsupsetneqq;\": {'\\u2ACC', '\\uFE00'},\n\t\"vnsub;\": {'\\u2282', '\\u20D2'},\n\t\"vnsup;\": {'\\u2283', '\\u20D2'},\n\t\"vsubnE;\": {'\\u2ACB', '\\uFE00'},\n\t\"vsubne;\": {'\\u228A', '\\uFE00'},\n\t\"vsupnE;\": {'\\u2ACC', '\\uFE00'},\n\t\"vsupne;\": {'\\u228B', '\\uFE00'},\n}\n"
},
{
"path": "tests/vendor/golang.org/x/net/html/escape.go",
"content": "// Copyright 2010 The Go Authors. All rights reserved.\n// Use of this source code is governed by a BSD-style\n// license that can be found in the LICENSE file.\n\npackage html\n\nimport (\n\t\"bytes\"\n\t\"strings\"\n\t\"unicode/utf8\"\n)\n\n// These replacements permit compatibility with old numeric entities that\n// assumed Windows-1252 encoding.\n// https://html.spec.whatwg.org/multipage/syntax.html#consume-a-character-reference\nvar replacementTable = [...]rune{\n\t'\\u20AC', // First entry is what 0x80 should be replaced with.\n\t'\\u0081',\n\t'\\u201A',\n\t'\\u0192',\n\t'\\u201E',\n\t'\\u2026',\n\t'\\u2020',\n\t'\\u2021',\n\t'\\u02C6',\n\t'\\u2030',\n\t'\\u0160',\n\t'\\u2039',\n\t'\\u0152',\n\t'\\u008D',\n\t'\\u017D',\n\t'\\u008F',\n\t'\\u0090',\n\t'\\u2018',\n\t'\\u2019',\n\t'\\u201C',\n\t'\\u201D',\n\t'\\u2022',\n\t'\\u2013',\n\t'\\u2014',\n\t'\\u02DC',\n\t'\\u2122',\n\t'\\u0161',\n\t'\\u203A',\n\t'\\u0153',\n\t'\\u009D',\n\t'\\u017E',\n\t'\\u0178', // Last entry is 0x9F.\n\t// 0x00->'\\uFFFD' is handled programmatically.\n\t// 0x0D->'\\u000D' is a no-op.\n}\n\n// unescapeEntity reads an entity like \"<\" from b[src:] and writes the\n// corresponding \"<\" to b[dst:], returning the incremented dst and src cursors.\n// Precondition: b[src] == '&' && dst <= src.\n// attribute should be true if parsing an attribute value.\nfunc unescapeEntity(b []byte, dst, src int, attribute bool) (dst1, src1 int) {\n\t// https://html.spec.whatwg.org/multipage/syntax.html#consume-a-character-reference\n\n\t// i starts at 1 because we already know that s[0] == '&'.\n\ti, s := 1, b[src:]\n\n\tif len(s) <= 1 {\n\t\tb[dst] = b[src]\n\t\treturn dst + 1, src + 1\n\t}\n\n\tif s[i] == '#' {\n\t\tif len(s) <= 3 { // We need to have at least \"&#.\".\n\t\t\tb[dst] = b[src]\n\t\t\treturn dst + 1, src + 1\n\t\t}\n\t\ti++\n\t\tc := s[i]\n\t\thex := false\n\t\tif c == 'x' || c == 'X' {\n\t\t\thex = true\n\t\t\ti++\n\t\t}\n\n\t\tx := '\\x00'\n\t\tfor i < len(s) {\n\t\t\tc = s[i]\n\t\t\ti++\n\t\t\tif hex {\n\t\t\t\tif '0' <= c && c <= '9' {\n\t\t\t\t\tx = 16*x + rune(c) - '0'\n\t\t\t\t\tcontinue\n\t\t\t\t} else if 'a' <= c && c <= 'f' {\n\t\t\t\t\tx = 16*x + rune(c) - 'a' + 10\n\t\t\t\t\tcontinue\n\t\t\t\t} else if 'A' <= c && c <= 'F' {\n\t\t\t\t\tx = 16*x + rune(c) - 'A' + 10\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t} else if '0' <= c && c <= '9' {\n\t\t\t\tx = 10*x + rune(c) - '0'\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif c != ';' {\n\t\t\t\ti--\n\t\t\t}\n\t\t\tbreak\n\t\t}\n\n\t\tif i <= 3 { // No characters matched.\n\t\t\tb[dst] = b[src]\n\t\t\treturn dst + 1, src + 1\n\t\t}\n\n\t\tif 0x80 <= x && x <= 0x9F {\n\t\t\t// Replace characters from Windows-1252 with UTF-8 equivalents.\n\t\t\tx = replacementTable[x-0x80]\n\t\t} else if x == 0 || (0xD800 <= x && x <= 0xDFFF) || x > 0x10FFFF {\n\t\t\t// Replace invalid characters with the replacement character.\n\t\t\tx = '\\uFFFD'\n\t\t}\n\n\t\treturn dst + utf8.EncodeRune(b[dst:], x), src + i\n\t}\n\n\t// Consume the maximum number of characters possible, with the\n\t// consumed characters matching one of the named references.\n\n\tfor i < len(s) {\n\t\tc := s[i]\n\t\ti++\n\t\t// Lower-cased characters are more common in entities, so we check for them first.\n\t\tif 'a' <= c && c <= 'z' || 'A' <= c && c <= 'Z' || '0' <= c && c <= '9' {\n\t\t\tcontinue\n\t\t}\n\t\tif c != ';' {\n\t\t\ti--\n\t\t}\n\t\tbreak\n\t}\n\n\tentityName := string(s[1:i])\n\tif entityName == \"\" {\n\t\t// No-op.\n\t} else if attribute && entityName[len(entityName)-1] != ';' && len(s) > i && s[i] == '=' {\n\t\t// No-op.\n\t} else if x := entity[entityName]; x != 0 {\n\t\treturn dst + utf8.EncodeRune(b[dst:], x), src + i\n\t} else if x := entity2[entityName]; x[0] != 0 {\n\t\tdst1 := dst + utf8.EncodeRune(b[dst:], x[0])\n\t\treturn dst1 + utf8.EncodeRune(b[dst1:], x[1]), src + i\n\t} else if !attribute {\n\t\tmaxLen := len(entityName) - 1\n\t\tif maxLen > longestEntityWithoutSemicolon {\n\t\t\tmaxLen = longestEntityWithoutSemicolon\n\t\t}\n\t\tfor j := maxLen; j > 1; j-- {\n\t\t\tif x := entity[entityName[:j]]; x != 0 {\n\t\t\t\treturn dst + utf8.EncodeRune(b[dst:], x), src + j + 1\n\t\t\t}\n\t\t}\n\t}\n\n\tdst1, src1 = dst+i, src+i\n\tcopy(b[dst:dst1], b[src:src1])\n\treturn dst1, src1\n}\n\n// unescape unescapes b's entities in-place, so that \"a<b\" becomes \"a' byte that, per above, we'd like to avoid escaping unless we have to.\n//\n// Studying the summary table (and T actions in its '>' column) closely, we\n// only need to escape in states 43, 44, 49, 51 and 52. State 43 is at the\n// start of the comment data. State 52 is after a '!'. The other three states\n// are after a '-'.\n//\n// Our algorithm is thus to escape every '&' and to escape '>' if and only if:\n// - The '>' is after a '!' or '-' (in the unescaped data) or\n// - The '>' is at the start of the comment data (after the opening \"\"); err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\tcase DoctypeNode:\n\t\tif _, err := w.WriteString(\"')\n\tcase RawNode:\n\t\t_, err := w.WriteString(n.Data)\n\t\treturn err\n\tdefault:\n\t\treturn errors.New(\"html: unknown node type\")\n\t}\n\n\t// Render the opening tag.\n\tif err := w.WriteByte('<'); err != nil {\n\t\treturn err\n\t}\n\tif _, err := w.WriteString(n.Data); err != nil {\n\t\treturn err\n\t}\n\tfor _, a := range n.Attr {\n\t\tif err := w.WriteByte(' '); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif a.Namespace != \"\" {\n\t\t\tif _, err := w.WriteString(a.Namespace); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tif err := w.WriteByte(':'); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t\tif _, err := w.WriteString(a.Key); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif _, err := w.WriteString(`=\"`); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif err := escape(w, a.Val); err != nil {\n\t\t\treturn err\n\t\t}\n\t\tif err := w.WriteByte('\"'); err != nil {\n\t\t\treturn err\n\t\t}\n\t}\n\tif voidElements[n.Data] {\n\t\tif n.FirstChild != nil {\n\t\t\treturn fmt.Errorf(\"html: void element <%s> has child nodes\", n.Data)\n\t\t}\n\t\t_, err := w.WriteString(\"/>\")\n\t\treturn err\n\t}\n\tif err := w.WriteByte('>'); err != nil {\n\t\treturn err\n\t}\n\n\t// Add initial newline where there is danger of a newline being ignored.\n\tif c := n.FirstChild; c != nil && c.Type == TextNode && strings.HasPrefix(c.Data, \"\\n\") {\n\t\tswitch n.Data {\n\t\tcase \"pre\", \"listing\", \"textarea\":\n\t\t\tif err := w.WriteByte('\\n'); err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t}\n\t}\n\n\t// Render any child nodes\n\tif childTextNodesAreLiteral(n) {\n\t\tfor c := n.FirstChild; c != nil; c = c.NextSibling {\n\t\t\tif c.Type == TextNode {\n\t\t\t\tif _, err := w.WriteString(c.Data); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tif err := render1(w, c); err != nil {\n\t\t\t\t\treturn err\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif n.Data == \"plaintext\" {\n\t\t\t// Don't render anything else.
![](\"https://www.testmu.ai/blue-logo.png\"){kind=logo}
\n \n