Merge pull request #2183 from newrelic/alec/validate-ds-ids

Properly validate data source id references on quickstarts
newrelic · Jan 4, 2024 · b04b665 · b04b665
2 parents 77fb064 + 15650e6
commit b04b665
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 3 deletions.
diff --git a/.github/workflows/pr-merged.yml b/.github/workflows/pr-merged.yml
@@ -87,6 +87,7 @@ jobs:
                     'Validation / Image count and extension compliance',
                     'Validation / Ensure icons exist',
                     'Validation / Install plan ids exist',
+                    'Validation / Validate data source ids',
                     'Validation / Install plan schema compliance',
                     'Validation / Data source schema compliance',
                     'Validation / Quickstart id are unique',

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -79,6 +79,7 @@ jobs:
                     'Validation / Image count and extension compliance',
                     'Validation / Ensure icons exist',
                     'Validation / Install plan ids exist',
+                    'Validation / Validate data source ids',
                     'Validation / Install plan schema compliance',
                     'Validation / Data source schema compliance',
                     'Validation / Quickstart id are unique',

diff --git a/.github/workflows/validate_packs.yml b/.github/workflows/validate_packs.yml
@@ -204,6 +204,48 @@ jobs:
           statusContext: "Validation / Install plan ids exist"
           state: ${{ job.status }}
 
+  validate-data-source-ids:
+    name: Validate data source ids
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: dawidd6/action-download-artifact@v2
+        with:
+          workflow: validation_gate.yml
+          run_id: ${{ github.event.workflow_run.id }}
+
+      - name: Get PR number
+        id: get_pr_number
+        run: |
+          export PR_NUMBER=$(cat artifact/pr_number.txt)
+          echo "pr-number=$PR_NUMBER" >> $GITHUB_ENV
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: "refs/pull/${{ env.pr-number }}/merge"
+
+      - name: Setup workspace
+        uses: './.github/actions/bootstrap'
+
+      - name: Validate new files
+        id: validation
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ env.pr-number }}
+          NR_API_URL: ${{ secrets.NR_API_URL }}
+          NR_API_TOKEN: ${{ secrets.NR_API_TOKEN }}
+        run: |
+          URL="https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/$PR_NUMBER/files"
+          cd utils && yarn validate-quickstart-data-sources "$URL"
+
+      - name: Add commit status
+        if: always()
+        uses: './.github/actions/add-commit-status'
+        with:
+          statusContext: "Validation / Data source ids exist"
+          state: ${{ job.status }}
+
   ensure-quickstart-dashboard-names-are-unique:
     name: Ensure quickstart dashboard names are unique
     runs-on: ubuntu-latest

diff --git a/utils/validate-quickstart-data-sources.ts b/utils/validate-quickstart-data-sources.ts
@@ -56,16 +56,16 @@ export const validateDataSourceIds = async (
 
   if (quickstartsWithInvalidDataSources.length > 0) {
     console.error(
-      `ERROR: Found install plans with no corresponding data source id.\n`
+      `ERROR: Found quickstarts with no corresponding data source id.\n`
     );
-    console.error(`An install plan id must match an existing data source id.`);
+    console.error(`An data source id must match an existing data source id.`);
     quickstartsWithInvalidDataSources.forEach((m) =>
       console.error(
         `- ${m.invalidDataSourceIds.join(', ')} in ${m.quickstart.configPath}`
       )
     );
     console.error(
-      `\nPlease change to an existing install plan id or remove the ids.`
+      `\nPlease change to an existing data source id or remove the ids.`
     );
 
     if (require.main === module) {