Replace default CI test products with Core and Telegraf (#6812)

* feat(ci): add per-product codeblock testing with default group

- Add support for all products: core, enterprise, v2, v1, telegraf,
  cloud, cloud-dedicated, cloud-serverless, clustered, explorer
- Define default test group (core + telegraf) when no product specified
- Exclude cloud products from automatic CI (manual dispatch only)
- Add placeholder scripts for products without pytest services
- Normalize product name handling (core, influxdb3_core, influxdb3-core)
- Log informative messages when excluded products' content changes

* chore(ci): make codeblock tests manual-only and informational

- Remove pull_request trigger, keep only workflow_dispatch
- Change all exit codes to 0 so workflow never blocks PRs
- Use warnings instead of errors for failed tests
- Simplify job from detect-changes to parse-inputs

* feat(ci): make codeblock tests informational on PRs, manual-only execution

- PRs now trigger detection-only mode that suggests which products to test
- Actual test execution only runs via manual workflow_dispatch
- Add detect-test-products.js script using existing content-utils library
- Properly resolve shared content to affected product pages
- Non-blocking: PRs won't fail due to codeblock test issues

* Update .github/workflows/test.yml

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix(ci): add guard for empty products array after parsing

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix(ci): remove redundant output before exit 1

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
claude/add-codeblock-ci-tests-jRvG9
Copilot 2026-02-11 17:04:47 -06:00 committed by GitHub
parent ae646cbcfa
commit 83db31cd07
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 421 additions and 41 deletions

View File

@ -1,6 +1,8 @@
name: Test Code Blocks
on:
# Pull requests: detection only (informational, non-blocking)
# Detects changed content and suggests which products to test
pull_request:
paths:
- 'content/**/*.md'
@ -8,20 +10,41 @@ on:
- 'Dockerfile.pytest'
- 'compose.yaml'
types: [opened, synchronize, reopened]
# Manual dispatch: actually runs tests
workflow_dispatch:
inputs:
test_suite:
description: 'Test suite to run (all, cloud, v2, telegraf, or specific products)'
products:
description: 'Products to test (comma-separated: core,enterprise,telegraf,v1,v2,cloud,cloud-dedicated,cloud-serverless,clustered,explorer)'
required: false
default: 'all'
default: ''
use_default_group:
description: 'Use default group (core + telegraf) if no products specified'
type: boolean
required: false
default: true
# Product to test script mapping
# Products with Docker Compose pytest services:
# - core (influxdb3_core) → influxdb3-core-pytest
# - telegraf → telegraf-pytest
# - v2 → v2-pytest
# - cloud → cloud-pytest
# - cloud-dedicated → cloud-dedicated-pytest
# - cloud-serverless → cloud-serverless-pytest
# - clustered → clustered-pytest
# Products without pytest services (content paths only):
# - enterprise → content/influxdb3/enterprise
# - v1 → content/influxdb/v1
# - explorer → content/influxdb3/explorer
jobs:
detect-changes:
name: Detect test requirements
name: Detect changed content
runs-on: ubuntu-latest
outputs:
should-run: ${{ steps.check.outputs.should-run }}
has-changes: ${{ steps.check.outputs.has-changes }}
test-products: ${{ steps.check.outputs.test-products }}
suggested-products: ${{ steps.check.outputs.suggested-products }}
steps:
- name: Checkout repository
@ -29,13 +52,93 @@ jobs:
with:
fetch-depth: 0
- name: Check if tests should run
- name: Setup Node.js
if: github.event_name == 'pull_request'
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Analyze changes and determine products
id: check
run: |
# For workflow_dispatch, always run tests
# Default product group: core + telegraf
DEFAULT_PRODUCTS=("influxdb3_core" "telegraf")
# For workflow_dispatch, use specified products or default
if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
echo "should-run=true" >> $GITHUB_OUTPUT
echo "test-products=[\"cloud\", \"v2\", \"telegraf\"]" >> $GITHUB_OUTPUT
echo "has-changes=true" >> $GITHUB_OUTPUT
INPUT_PRODUCTS="${{ github.event.inputs.products }}"
USE_DEFAULT="${{ github.event.inputs.use_default_group }}"
if [[ -n "$INPUT_PRODUCTS" ]]; then
# Parse comma-separated products and normalize names
PRODUCTS=()
IFS=',' read -ra PRODUCT_LIST <<< "$INPUT_PRODUCTS"
for product in "${PRODUCT_LIST[@]}"; do
# Trim whitespace and normalize product names
product=$(echo "$product" | xargs)
case "$product" in
core|influxdb3_core|influxdb3-core)
PRODUCTS+=("influxdb3_core")
;;
enterprise|influxdb3_enterprise|influxdb3-enterprise)
PRODUCTS+=("influxdb3_enterprise")
;;
telegraf)
PRODUCTS+=("telegraf")
;;
v2|influxdb_v2)
PRODUCTS+=("v2")
;;
v1|influxdb_v1)
PRODUCTS+=("v1")
;;
cloud|influxdb_cloud)
PRODUCTS+=("cloud")
;;
cloud-dedicated|cloud_dedicated)
PRODUCTS+=("cloud-dedicated")
;;
cloud-serverless|cloud_serverless)
PRODUCTS+=("cloud-serverless")
;;
clustered)
PRODUCTS+=("clustered")
;;
explorer|influxdb3_explorer)
PRODUCTS+=("explorer")
;;
*)
echo "⚠️ Unknown product: $product (skipping)"
;;
esac
done
# Guard: if all products were invalid/unknown, handle gracefully
if [[ ${#PRODUCTS[@]} -eq 0 ]]; then
if [[ "$USE_DEFAULT" == "true" ]]; then
echo "⚠️ All specified products were invalid. Falling back to default group."
PRODUCTS=("${DEFAULT_PRODUCTS[@]}")
else
echo "❌ All specified products were invalid and default group is disabled"
exit 1
fi
fi
elif [[ "$USE_DEFAULT" == "true" ]]; then
PRODUCTS=("${DEFAULT_PRODUCTS[@]}")
echo "📦 Using default product group: ${PRODUCTS[*]}"
else
echo "❌ No products specified and default group disabled"
echo "has-changes=false" >> $GITHUB_OUTPUT
exit 0
fi
# Convert to JSON array
PRODUCTS_JSON=$(printf '%s\n' "${PRODUCTS[@]}" | jq -R . | jq -s -c .)
echo "test-products=$PRODUCTS_JSON" >> $GITHUB_OUTPUT
echo "suggested-products=$PRODUCTS_JSON" >> $GITHUB_OUTPUT
echo "✅ Will run tests for: ${PRODUCTS[*]}"
exit 0
fi
@ -43,43 +146,90 @@ jobs:
CHANGED_FILES=$(git diff --name-only ${{ github.event.pull_request.base.sha }}...${{ github.sha }} | grep '^content/.*\.md$' || true)
if [[ -z "$CHANGED_FILES" ]]; then
echo "should-run=false" >> $GITHUB_OUTPUT
echo "📝 No content changes detected - skipping code block tests"
echo "has-changes=false" >> $GITHUB_OUTPUT
echo "📝 No content changes detected"
exit 0
fi
echo "should-run=true" >> $GITHUB_OUTPUT
echo "has-changes=true" >> $GITHUB_OUTPUT
echo "📝 Changed content files:"
echo "$CHANGED_FILES"
# Determine which product tests to run based on changed files
PRODUCTS=()
# Use Node.js script to detect products (handles shared content resolution)
# The script expands shared content changes to find all affected product pages
RESULT=$(echo "$CHANGED_FILES" | node scripts/ci/detect-test-products.js)
if echo "$CHANGED_FILES" | grep -q '^content/influxdb/cloud/'; then
PRODUCTS+=("cloud")
PRODUCTS_JSON=$(echo "$RESULT" | jq -c '.products')
FILES_JSON=$(echo "$RESULT" | jq -c '.files')
# Check if we got any products
PRODUCT_COUNT=$(echo "$PRODUCTS_JSON" | jq 'length')
if [[ "$PRODUCT_COUNT" -eq 0 ]]; then
echo "📦 No specific products detected - using default group"
PRODUCTS_JSON=$(printf '%s\n' "${DEFAULT_PRODUCTS[@]}" | jq -R . | jq -s -c .)
fi
if echo "$CHANGED_FILES" | grep -q '^content/influxdb/v2/'; then
PRODUCTS+=("v2")
fi
if echo "$CHANGED_FILES" | grep -q '^content/telegraf/'; then
PRODUCTS+=("telegraf")
fi
# If no specific products matched or shared content changed, run all
if [[ ${#PRODUCTS[@]} -eq 0 ]] || echo "$CHANGED_FILES" | grep -q '^content/shared/'; then
PRODUCTS=("cloud" "v2" "telegraf")
fi
# Convert to JSON array
PRODUCTS_JSON=$(printf '%s\n' "${PRODUCTS[@]}" | jq -R . | jq -s -c .)
echo "test-products=$PRODUCTS_JSON" >> $GITHUB_OUTPUT
echo "suggested-products=$PRODUCTS_JSON" >> $GITHUB_OUTPUT
echo "affected-files=$FILES_JSON" >> $GITHUB_OUTPUT
echo "✅ Will run tests for: ${PRODUCTS[*]}"
echo "📋 Suggested products for testing: $(echo "$PRODUCTS_JSON" | jq -r 'join(", ")')"
# Informational job for PRs - suggests tests but doesn't run them
suggest-tests:
name: Suggest code block tests
needs: detect-changes
if: github.event_name == 'pull_request' && needs.detect-changes.outputs.has-changes == 'true'
runs-on: ubuntu-latest
steps:
- name: Generate test suggestions
run: |
PRODUCTS='${{ needs.detect-changes.outputs.suggested-products }}'
cat >> $GITHUB_STEP_SUMMARY << 'EOF'
## 📋 Code Block Test Suggestions
Based on the changed content in this PR, the following products should be tested:
EOF
# Parse JSON array and list products
echo "$PRODUCTS" | jq -r '.[]' | while read -r product; do
echo "- \`$product\`" >> $GITHUB_STEP_SUMMARY
done
cat >> $GITHUB_STEP_SUMMARY << 'EOF'
### How to run tests
**Option 1: Manual workflow dispatch**
1. Go to [Actions → Test Code Blocks](../actions/workflows/test.yml)
2. Click "Run workflow"
3. Enter products (comma-separated) or use the default group
**Option 2: Run locally**
```bash
# Run default group (core + telegraf)
yarn test:codeblocks:default
# Run specific product
yarn test:codeblocks:influxdb3_core
yarn test:codeblocks:telegraf
yarn test:codeblocks:v2
```
> **Note:** Automatic test execution on PRs is currently disabled.
> Tests can be run manually using the options above.
EOF
echo "::notice::Code block tests suggested for: $(echo "$PRODUCTS" | jq -r 'join(", ")')"
# Actual test execution - only runs on manual dispatch
test-codeblocks:
name: Test ${{ matrix.product }} code blocks
needs: detect-changes
if: needs.detect-changes.outputs.should-run == 'true'
if: github.event_name == 'workflow_dispatch' && needs.detect-changes.outputs.has-changes == 'true'
runs-on: ubuntu-latest
timeout-minutes: 30
@ -112,10 +262,51 @@ jobs:
run: |
# Create mock .env.test files for CI
# In production, these would be configured with actual credentials
# InfluxDB 3 products
mkdir -p content/influxdb3/core
mkdir -p content/influxdb3/enterprise
mkdir -p content/influxdb3/cloud-dedicated
mkdir -p content/influxdb3/cloud-serverless
mkdir -p content/influxdb3/clustered
# InfluxDB v1/v2 products
mkdir -p content/influxdb/cloud
mkdir -p content/influxdb/v2
mkdir -p content/influxdb/v1
# Telegraf
mkdir -p content/telegraf/v1
# InfluxDB 3 Core
cat > content/influxdb3/core/.env.test << 'EOF'
# Mock credentials for CI testing
INFLUX_HOST=http://localhost:8282
INFLUX_TOKEN=mock_token_for_ci
INFLUX_DATABASE=test_db
EOF
# InfluxDB 3 Enterprise
cat > content/influxdb3/enterprise/.env.test << 'EOF'
# Mock credentials for CI testing
INFLUX_HOST=http://localhost:8181
INFLUX_TOKEN=mock_token_for_ci
INFLUX_DATABASE=test_db
EOF
# InfluxDB 3 Cloud products
for product in cloud-dedicated cloud-serverless clustered; do
cat > content/influxdb3/$product/.env.test << 'EOF'
# Mock credentials for CI testing
INFLUX_HOST=https://cluster.influxdata.com
INFLUX_TOKEN=mock_token_for_ci
INFLUX_DATABASE=test_db
ACCOUNT_ID=mock_account
CLUSTER_ID=mock_cluster
EOF
done
# InfluxDB Cloud (v2)
cat > content/influxdb/cloud/.env.test << 'EOF'
# Mock credentials for CI testing
INFLUX_HOST=https://cloud2.influxdata.com
@ -124,6 +315,7 @@ jobs:
INFLUX_BUCKET=mock_bucket
EOF
# InfluxDB v2
cat > content/influxdb/v2/.env.test << 'EOF'
# Mock credentials for CI testing
INFLUX_HOST=http://localhost:8086
@ -132,6 +324,15 @@ jobs:
INFLUX_BUCKET=mock_bucket
EOF
# InfluxDB v1
cat > content/influxdb/v1/.env.test << 'EOF'
# Mock credentials for CI testing
INFLUX_HOST=http://localhost:8086
INFLUX_USERNAME=mock_user
INFLUX_PASSWORD=mock_password
EOF
# Telegraf
cat > content/telegraf/v1/.env.test << 'EOF'
# Mock credentials for CI testing
INFLUX_HOST=https://cloud2.influxdata.com
@ -146,8 +347,58 @@ jobs:
run: |
echo "Running tests for ${{ matrix.product }}..."
# Run the specific product test suite
yarn test:codeblocks:${{ matrix.product }} || EXIT_CODE=$?
# Map product names to yarn test commands
# Some products don't have pytest services yet - skip them gracefully
case "${{ matrix.product }}" in
influxdb3_core)
TEST_CMD="yarn test:codeblocks:influxdb3_core"
;;
influxdb3_enterprise)
echo "⚠️ InfluxDB 3 Enterprise tests not yet configured - skipping"
echo "test-status=skipped" >> $GITHUB_OUTPUT
echo "exit-code=0" >> $GITHUB_OUTPUT
exit 0
;;
telegraf)
TEST_CMD="yarn test:codeblocks:telegraf"
;;
v2)
TEST_CMD="yarn test:codeblocks:v2"
;;
v1)
echo "⚠️ InfluxDB v1 tests not yet configured - skipping"
echo "test-status=skipped" >> $GITHUB_OUTPUT
echo "exit-code=0" >> $GITHUB_OUTPUT
exit 0
;;
cloud)
TEST_CMD="yarn test:codeblocks:cloud"
;;
cloud-dedicated)
TEST_CMD="yarn test:codeblocks:cloud-dedicated"
;;
cloud-serverless)
TEST_CMD="yarn test:codeblocks:cloud-serverless"
;;
clustered)
TEST_CMD="yarn test:codeblocks:clustered"
;;
explorer)
echo "⚠️ InfluxDB 3 Explorer tests not yet configured - skipping"
echo "test-status=skipped" >> $GITHUB_OUTPUT
echo "exit-code=0" >> $GITHUB_OUTPUT
exit 0
;;
*)
echo "❌ Unknown product: ${{ matrix.product }}"
echo "test-status=failed" >> $GITHUB_OUTPUT
echo "exit-code=1" >> $GITHUB_OUTPUT
exit 1
;;
esac
# Run the test command
$TEST_CMD || EXIT_CODE=$?
# Capture exit code for reporting
if [[ -n "$EXIT_CODE" ]]; then
@ -161,16 +412,29 @@ jobs:
- name: Generate test summary
if: always()
run: |
cat >> $GITHUB_STEP_SUMMARY << 'EOF'
STATUS="${{ steps.test.outputs.test-status }}"
case "$STATUS" in
passed)
STATUS_ICON="✅ Passed"
;;
skipped)
STATUS_ICON="⏭️ Skipped"
;;
*)
STATUS_ICON="❌ Failed"
;;
esac
cat >> $GITHUB_STEP_SUMMARY << EOF
## Code Block Test Results - ${{ matrix.product }}
**Status:** ${{ steps.test.outputs.test-status == 'passed' && '✅ Passed' || '❌ Failed' }}
**Status:** $STATUS_ICON
**Product:** ${{ matrix.product }}
**Exit Code:** ${{ steps.test.outputs.exit-code }}
EOF
if [[ "${{ steps.test.outputs.test-status }}" == "failed" ]]; then
if [[ "$STATUS" == "failed" ]]; then
cat >> $GITHUB_STEP_SUMMARY << 'EOF'
⚠️ **Note:** Code block tests require valid credentials configured in `.env.test` files.
In CI, mock credentials are used which may cause some tests to fail.
@ -178,7 +442,12 @@ jobs:
To test locally with real credentials:
1. Create `.env.test` files in product directories
2. Run `yarn test:codeblocks:${{ matrix.product }}`
2. Run `yarn test:codeblocks:<product>`
EOF
elif [[ "$STATUS" == "skipped" ]]; then
cat >> $GITHUB_STEP_SUMMARY << 'EOF'
**Note:** This product does not have a pytest service configured yet.
To add testing support, create a Docker Compose service in `compose.yaml`.
EOF
fi
@ -199,10 +468,15 @@ jobs:
echo "::error::Code block tests failed for ${{ matrix.product }}"
exit 1
- name: Report skipped tests
if: steps.test.outputs.test-status == 'skipped'
run: |
echo "::notice::Tests skipped for ${{ matrix.product }} - pytest service not configured"
test-summary:
name: Code Block Test Summary
needs: [detect-changes, test-codeblocks]
if: always() && needs.detect-changes.outputs.should-run == 'true'
if: always() && github.event_name == 'workflow_dispatch' && needs.detect-changes.outputs.has-changes == 'true'
runs-on: ubuntu-latest
steps:

View File

@ -84,14 +84,19 @@
"lint": "LEFTHOOK_EXCLUDE=test lefthook run pre-commit && lefthook run pre-push",
"pre-commit": "lefthook run pre-commit",
"test": "echo \"Run 'yarn test:e2e', 'yarn test:links', 'yarn test:codeblocks:all' or a specific test command. e2e and links test commands can take a glob of file paths to test. Some commands run automatically during the git pre-commit and pre-push hooks.\" && exit 0",
"test:codeblocks": "echo \"Run a specific codeblocks test command\" && exit 0",
"test:codeblocks": "echo \"Run a specific codeblocks test command (e.g., yarn test:codeblocks:influxdb3_core)\" && exit 0",
"test:codeblocks:all": "docker compose --profile test up",
"test:codeblocks:default": "echo 'Running default test group (core + telegraf)...' && yarn test:codeblocks:influxdb3_core && yarn test:codeblocks:telegraf",
"test:codeblocks:parallel": "docker compose run --rm cloud-pytest & docker compose run --rm v2-pytest & docker compose run --rm telegraf-pytest & wait",
"test:codeblocks:influxdb3_core": "docker compose run --rm --name influxdb3-core-pytest influxdb3-core-pytest",
"test:codeblocks:influxdb3_enterprise": "echo '⚠️ InfluxDB 3 Enterprise pytest service not yet configured. Add influxdb3-enterprise-pytest to compose.yaml.' && exit 0",
"test:codeblocks:cloud": "docker compose run --rm --name cloud-pytest cloud-pytest",
"test:codeblocks:cloud-dedicated": "./test/scripts/monitor-tests.sh start cloud-dedicated-pytest && docker compose run --name cloud-dedicated-pytest cloud-dedicated-pytest",
"test:codeblocks:cloud-serverless": "docker compose run --rm --name cloud-serverless-pytest cloud-serverless-pytest",
"test:codeblocks:clustered": "./test/scripts/monitor-tests.sh start clustered-pytest && docker compose run --name clustered-pytest clustered-pytest",
"test:codeblocks:explorer": "echo '⚠️ InfluxDB 3 Explorer pytest service not yet configured. Add explorer-pytest to compose.yaml.' && exit 0",
"test:codeblocks:telegraf": "docker compose run --rm --name telegraf-pytest telegraf-pytest",
"test:codeblocks:v1": "echo '⚠️ InfluxDB v1 pytest service not yet configured. Add v1-pytest to compose.yaml.' && exit 0",
"test:codeblocks:v2": "docker compose run --rm --name v2-pytest v2-pytest",
"test:codeblocks:stop-monitors": "./test/scripts/monitor-tests.sh stop cloud-dedicated-pytest && ./test/scripts/monitor-tests.sh stop clustered-pytest",
"test:codeblocks:python": "echo 'Testing Python code blocks...' && docker compose run --rm cloud-pytest bash -c './test/scripts/test-by-language.sh python content/influxdb/cloud/**/*.md'",

View File

@ -0,0 +1,101 @@
#!/usr/bin/env node
/**
* Detect which products need testing based on changed content files.
*
* Usage:
* echo "content/influxdb3/core/page.md" | node scripts/ci/detect-test-products.js
* node scripts/ci/detect-test-products.js < changed-files.txt
*
* Output (JSON):
* {"products":["influxdb3_core","telegraf"],"files":["content/influxdb3/core/page.md",...]}
*
* This script:
* 1. Reads changed file paths from stdin (one per line)
* 2. Expands shared content changes to find all affected product pages
* 3. Extracts unique products from the affected file paths
* 4. Outputs JSON with products array and expanded files array
*/
import { expandSharedContentChanges } from '../lib/content-utils.js';
// Product path mappings
const PRODUCT_PATTERNS = [
{ pattern: /^content\/influxdb3\/core\//, product: 'influxdb3_core' },
{ pattern: /^content\/influxdb3\/enterprise\//, product: 'influxdb3_enterprise' },
{ pattern: /^content\/influxdb3\/cloud-dedicated\//, product: 'cloud-dedicated' },
{ pattern: /^content\/influxdb3\/cloud-serverless\//, product: 'cloud-serverless' },
{ pattern: /^content\/influxdb3\/clustered\//, product: 'clustered' },
{ pattern: /^content\/influxdb3\/explorer\//, product: 'explorer' },
{ pattern: /^content\/influxdb\/cloud\//, product: 'cloud' },
{ pattern: /^content\/influxdb\/v2\//, product: 'v2' },
{ pattern: /^content\/influxdb\/v1\//, product: 'v1' },
{ pattern: /^content\/telegraf\//, product: 'telegraf' },
];
/**
* Extract product identifier from a content file path
* @param {string} filePath - Content file path
* @returns {string|null} Product identifier or null
*/
function getProductFromPath(filePath) {
for (const { pattern, product } of PRODUCT_PATTERNS) {
if (pattern.test(filePath)) {
return product;
}
}
return null;
}
/**
* Main function
*/
async function main() {
// Read changed files from stdin
const input = await new Promise((resolve) => {
let data = '';
process.stdin.setEncoding('utf8');
process.stdin.on('data', (chunk) => (data += chunk));
process.stdin.on('end', () => resolve(data));
// Handle case where stdin is empty/closed immediately
if (process.stdin.isTTY) {
resolve('');
}
});
const changedFiles = input
.trim()
.split('\n')
.filter((f) => f && f.endsWith('.md'));
if (changedFiles.length === 0) {
console.log(JSON.stringify({ products: [], files: [] }));
process.exit(0);
}
// Expand shared content changes to find all affected pages
const verbose = process.env.VERBOSE === 'true';
const expandedFiles = expandSharedContentChanges(changedFiles, { verbose });
// Extract unique products from expanded file list
const products = new Set();
for (const file of expandedFiles) {
const product = getProductFromPath(file);
if (product) {
products.add(product);
}
}
// Output JSON result
const result = {
products: Array.from(products).sort(),
files: expandedFiles.sort(),
};
console.log(JSON.stringify(result));
}
main().catch((err) => {
console.error('Error:', err.message);
process.exit(1);
});