|
| 1 | +name: Enforce Groovy Migration |
| 2 | +on: |
| 3 | + pull_request: |
| 4 | + types: [opened, edited, ready_for_review, labeled, unlabeled, synchronize] |
| 5 | + branches: |
| 6 | + - master |
| 7 | + |
| 8 | +concurrency: |
| 9 | + group: ${{ github.workflow }}-${{ github.ref }} |
| 10 | + cancel-in-progress: true |
| 11 | + |
| 12 | +jobs: |
| 13 | + enforce_groovy_migration: |
| 14 | + name: Enforce Groovy migration |
| 15 | + permissions: |
| 16 | + issues: write # Required to create a comment on the pull request |
| 17 | + pull-requests: write # Required to create a comment on the pull request |
| 18 | + contents: read # Required to read migrated modules file |
| 19 | + runs-on: ubuntu-latest |
| 20 | + steps: |
| 21 | + - name: Check for Groovy regressions |
| 22 | + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # 8.0.0 |
| 23 | + with: |
| 24 | + github-token: ${{ secrets.GITHUB_TOKEN }} |
| 25 | + script: | |
| 26 | + // Skip draft pull requests |
| 27 | + if (context.payload.pull_request.draft) { |
| 28 | + return |
| 29 | + } |
| 30 | +
|
| 31 | + // Check for override label — skip all checks if label present |
| 32 | + const labels = context.payload.pull_request.labels.map(l => l.name) |
| 33 | + if (labels.includes('tag: override-groovy-enforcement')) { |
| 34 | + console.log('tag: override-groovy-enforcement label detected — skipping all checks.') |
| 35 | + return |
| 36 | + } |
| 37 | +
|
| 38 | + // Read migrated modules list from master |
| 39 | + const migratedMods = await github.rest.repos.getContent({ |
| 40 | + owner: context.repo.owner, |
| 41 | + repo: context.repo.repo, |
| 42 | + path: '.github/g2j-migrated-modules.txt', |
| 43 | + ref: 'master' |
| 44 | + }) |
| 45 | + const migratedPrefixes = Buffer.from(migratedMods.data.content, 'base64') |
| 46 | + .toString() |
| 47 | + .split('\n') |
| 48 | + .map(l => l.trim()) |
| 49 | + .filter(l => l && !l.startsWith('#')) |
| 50 | +
|
| 51 | + // Get all files changed in this PR |
| 52 | + const allFiles = await github.paginate(github.rest.pulls.listFiles, { |
| 53 | + owner: context.repo.owner, |
| 54 | + repo: context.repo.repo, |
| 55 | + pull_number: context.payload.pull_request.number |
| 56 | + }) |
| 57 | +
|
| 58 | + // Filter these changed files to newly added Groovy files in any test source set |
| 59 | + const addedGroovy = allFiles.filter(f => |
| 60 | + f.status === 'added' && |
| 61 | + /\/src\/[^/]*[tT]est[^/]*\/groovy\/.*\.groovy$/.test(f.filename) |
| 62 | + ) |
| 63 | +
|
| 64 | + // Extract module prefix from file path (everything before /src/(test|testFixtures)/groovy/) |
| 65 | + const moduleOf = path => { |
| 66 | + const m = path.match(/^(.*?)\/src\/(test|testFixtures)\/groovy\//) |
| 67 | + return m ? m[1] : null |
| 68 | + } |
| 69 | +
|
| 70 | + // Classify each added Groovy file |
| 71 | + const regressions = [] |
| 72 | + const warnings = [] |
| 73 | + for (const file of addedGroovy) { |
| 74 | + const path = file.filename |
| 75 | + const mod = moduleOf(path) |
| 76 | + if (migratedPrefixes.some(prefix => path.startsWith(prefix + '/'))) { |
| 77 | + regressions.push({ path, mod }) |
| 78 | + } else if ( |
| 79 | + path.startsWith('dd-java-agent/instrumentation/') || |
| 80 | + path.startsWith('dd-smoke-tests/') |
| 81 | + ) { |
| 82 | + // ignore Groovy file additions to instrumentations and smoke-tests for now |
| 83 | + } else { |
| 84 | + warnings.push({ path, mod }) |
| 85 | + } |
| 86 | + } |
| 87 | +
|
| 88 | + // Fetch existing comments once |
| 89 | + const comments = await github.rest.issues.listComments({ |
| 90 | + issue_number: context.payload.pull_request.number, |
| 91 | + owner: context.repo.owner, |
| 92 | + repo: context.repo.repo |
| 93 | + }) |
| 94 | +
|
| 95 | + const regressionMarker = '<!-- dd-trace-java-groovy-regression -->' |
| 96 | + const warningMarker = '<!-- dd-trace-java-groovy-warning -->' |
| 97 | + const existingRegressionComment = comments.data.find(c => c.body.includes(regressionMarker)) |
| 98 | + const existingWarningComment = comments.data.find(c => c.body.includes(warningMarker)) |
| 99 | +
|
| 100 | + // Handle regression comment |
| 101 | + if (regressions.length > 0) { |
| 102 | + const fileList = regressions |
| 103 | + .map(({ path, mod }) => `- \`${path}\` (module: \`${mod}\`)`) |
| 104 | + .join('\n') |
| 105 | + const body = `**❌ Groovy Test Regression Detected**\n\n` + |
| 106 | + `The following files add Groovy tests to modules that have been fully migrated to Java / JUnit 5:\n\n` + |
| 107 | + `${fileList}\n\n` + |
| 108 | + `These modules no longer accept Groovy test files. Please rewrite the test in Java / JUnit 5 instead.\n\n` + |
| 109 | + regressionMarker |
| 110 | + if (existingRegressionComment) { |
| 111 | + await github.rest.issues.updateComment({ |
| 112 | + comment_id: existingRegressionComment.id, |
| 113 | + owner: context.repo.owner, |
| 114 | + repo: context.repo.repo, |
| 115 | + body |
| 116 | + }) |
| 117 | + } else { |
| 118 | + await github.rest.issues.createComment({ |
| 119 | + issue_number: context.payload.pull_request.number, |
| 120 | + owner: context.repo.owner, |
| 121 | + repo: context.repo.repo, |
| 122 | + body |
| 123 | + }) |
| 124 | + } |
| 125 | + } else if (existingRegressionComment) { |
| 126 | + await github.rest.issues.deleteComment({ |
| 127 | + comment_id: existingRegressionComment.id, |
| 128 | + owner: context.repo.owner, |
| 129 | + repo: context.repo.repo |
| 130 | + }) |
| 131 | + } |
| 132 | +
|
| 133 | + // Handle warning comment |
| 134 | + if (warnings.length > 0) { |
| 135 | + const fileList = warnings |
| 136 | + .map(({ path, mod }) => `- \`${path}\` (module: \`${mod}\`)`) |
| 137 | + .join('\n') |
| 138 | + const body = `**⚠️ New Groovy Test Files Added**\n\n` + |
| 139 | + `The following files add Groovy tests to modules that are candidates for migration to Java / JUnit 5:\n\n` + |
| 140 | + `${fileList}\n\n` + |
| 141 | + `Consider writing these tests in Java / JUnit 5 instead to help with the ongoing migration effort.\n\n` + |
| 142 | + warningMarker |
| 143 | + if (existingWarningComment) { |
| 144 | + await github.rest.issues.updateComment({ |
| 145 | + comment_id: existingWarningComment.id, |
| 146 | + owner: context.repo.owner, |
| 147 | + repo: context.repo.repo, |
| 148 | + body |
| 149 | + }) |
| 150 | + } else { |
| 151 | + await github.rest.issues.createComment({ |
| 152 | + issue_number: context.payload.pull_request.number, |
| 153 | + owner: context.repo.owner, |
| 154 | + repo: context.repo.repo, |
| 155 | + body |
| 156 | + }) |
| 157 | + } |
| 158 | + } else if (existingWarningComment) { |
| 159 | + await github.rest.issues.deleteComment({ |
| 160 | + comment_id: existingWarningComment.id, |
| 161 | + owner: context.repo.owner, |
| 162 | + repo: context.repo.repo |
| 163 | + }) |
| 164 | + } |
| 165 | +
|
| 166 | + // Fail the check if there are regressions |
| 167 | + if (regressions.length > 0) { |
| 168 | + core.setFailed(`${regressions.length} Groovy regression(s) detected in migrated module(s). See PR comment for details. To skip this check entirely, add the 'tag: override-groovy-enforcement' label.`) |
| 169 | + } |
0 commit comments