mirror of
https://github.com/ansible/awx.git
synced 2026-01-08 14:32:07 -03:30
335a4bbbc6
* AAP-45927 Add drf-spectacular - Remove drf-yasg - Add drf-spectacular * move SPECTACULAR_SETTINGS from development_defaults.py to defaults.py * move SPECTACULAR_SETTINGS from development_defaults.py to defaults.py * Fix swagger tests: enable schema endpoints in all modes Schema endpoints were restricted to development mode, causing test_swagger_generation.py to fail. Made schema URLs available in all modes and fixed deprecated Django warning filters in pytest.ini. * remove swagger from Makefile * remove swagger from Makefile * change docker-compose-build-swagger to docker-compose-build-schema * remove MODE * remove unused import * Update genschema to use drf-spectacular with awx-link dependency - Add awx-link as dependency for genschema targets to ensure package metadata exists - Remove --validate --fail-on-warn flags (schema needs improvements first) - Add genschema-yaml target for YAML output - Add schema.yaml to .gitignore * Fix detect-schema-change to not fail on schema differences Add '-' prefix to diff command so Make ignores its exit status. diff returns exit code 1 when files differ, which is expected behavior for schema change detection, not an error. * Truncate schema diff summary to stay under GitHub's 1MB limit Limit schema diff output in job summary to first 1000 lines to avoid exceeding GitHub's 1MB step summary size limit. Add message indicating when diff is truncated and direct users to job logs or artifacts for full output. * readd MODE * add drf-spectacular to requirements.in and the requirements.txt generated from the script * Add drf-spectacular BSD license file Required for test_python_licenses test to pass now that drf-spectacular is in requirements.txt. * add licenses * Add comprehensive unit tests for CustomAutoSchema Adds 15 unit tests for awx/api/schema.py to improve SonarCloud test coverage. Tests cover all code paths in CustomAutoSchema including: - get_tags() method with various scenarios (swagger_topic, serializer Meta.model, view.model, exception handling, fallbacks, warnings) - is_deprecated() method with different view configurations - Edge cases and priority ordering All tests passing. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * remove unused imports --------- Co-authored-by: Claude <noreply@anthropic.com>
73 lines
2.6 KiB
YAML
73 lines
2.6 KiB
YAML
---
|
|
name: API Schema Change Detection
|
|
env:
|
|
LC_ALL: "C.UTF-8" # prevent ERROR: Ansible could not initialize the preferred locale: unsupported locale setting
|
|
CI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
DEV_DOCKER_OWNER: ${{ github.repository_owner }}
|
|
COMPOSE_TAG: ${{ github.base_ref || 'devel' }}
|
|
UPSTREAM_REPOSITORY_ID: 91594105
|
|
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- devel
|
|
- release_**
|
|
- feature_**
|
|
- stable-**
|
|
|
|
jobs:
|
|
api-schema-detection:
|
|
name: Detect API Schema Changes
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
permissions:
|
|
packages: write
|
|
contents: read
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
show-progress: false
|
|
fetch-depth: 0
|
|
|
|
- name: Build awx_devel image for schema check
|
|
uses: ./.github/actions/awx_devel_image
|
|
with:
|
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
|
private-github-key: ${{ secrets.PRIVATE_GITHUB_KEY }}
|
|
|
|
- name: Detect API schema changes
|
|
id: schema-check
|
|
continue-on-error: true
|
|
run: |
|
|
AWX_DOCKER_ARGS='-e GITHUB_ACTIONS' \
|
|
AWX_DOCKER_CMD='make detect-schema-change SCHEMA_DIFF_BASE_BRANCH=${{ github.event.pull_request.base.ref }}' \
|
|
make docker-runner 2>&1 | tee schema-diff.txt
|
|
exit ${PIPESTATUS[0]}
|
|
|
|
- name: Add schema diff to job summary
|
|
if: always()
|
|
# show text and if for some reason, it can't be generated, state that it can't be.
|
|
run: |
|
|
echo "## API Schema Change Detection Results" >> $GITHUB_STEP_SUMMARY
|
|
echo "" >> $GITHUB_STEP_SUMMARY
|
|
if [ -f schema-diff.txt ]; then
|
|
if grep -q "^+" schema-diff.txt || grep -q "^-" schema-diff.txt; then
|
|
echo "### Schema changes detected" >> $GITHUB_STEP_SUMMARY
|
|
echo "" >> $GITHUB_STEP_SUMMARY
|
|
# Truncate to first 1000 lines to stay under GitHub's 1MB summary limit
|
|
TOTAL_LINES=$(wc -l < schema-diff.txt)
|
|
if [ $TOTAL_LINES -gt 1000 ]; then
|
|
echo "_Showing first 1000 of ${TOTAL_LINES} lines. See job logs or download artifact for full diff._" >> $GITHUB_STEP_SUMMARY
|
|
echo "" >> $GITHUB_STEP_SUMMARY
|
|
fi
|
|
echo '```diff' >> $GITHUB_STEP_SUMMARY
|
|
head -n 1000 schema-diff.txt >> $GITHUB_STEP_SUMMARY
|
|
echo '```' >> $GITHUB_STEP_SUMMARY
|
|
else
|
|
echo "### No schema changes detected" >> $GITHUB_STEP_SUMMARY
|
|
fi
|
|
else
|
|
echo "### Unable to generate schema diff" >> $GITHUB_STEP_SUMMARY
|
|
fi
|