accept upstream changes and simplyfying apply-test-ids.yml

Author: AnirudhJindal

.github/workflows/apply-test-ids.yml

@@ -1,4 +1,4 @@
-name: apply-test-ids
+name: Test IDs
 
 on:
   pull_request_target:
@@ -8,145 +8,63 @@ on:
 
 permissions:
   contents: write
-  pull-requests: write
 
 jobs:
-  apply:
+  generate:
     runs-on: ubuntu-latest
 
     steps:
-      # 1. Detect what changed in this PR
-      - name: Check changed paths
+      - name: Detect changed files
         uses: dorny/paths-filter@v3
-        id: filter
+        id: changes
         with:
           filters: |
             tests:
               - 'tests/**/*.json'
-            scripts:
-              - 'scripts/**'
-              - 'package.json'
-              - 'package-lock.json'
+            other:
+              - '!tests/**/*.json'
 
-      # 2. Fail if both tests AND scripts changed together
       - name: Block mixed changes
-        if: steps.filter.outputs.tests == 'true' && steps.filter.outputs.scripts == 'true'
+        if: steps.changes.outputs.tests == 'true' && steps.changes.outputs.other == 'true'
         run: |
-          echo "This PR changes both test files and scripts at the same time."
-          echo "Please split them into separate PRs."
+          echo "Tests and other files were changed together."
+          echo "Please submit test JSON changes separately."
           exit 1
 
-      # 3. Checkout repo
-      - name: Checkout
-        if: steps.filter.outputs.tests == 'true'
+      - name: Checkout PR branch
+        if: steps.changes.outputs.tests == 'true'
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
-          fetch-depth: 0
 
-      # 4. Setup Node.js
       - name: Setup Node.js
-        if: steps.filter.outputs.tests == 'true'
+        if: steps.changes.outputs.tests == 'true'
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
-      # 5. Install dependencies
       - name: Install dependencies
-        if: steps.filter.outputs.tests == 'true'
+        if: steps.changes.outputs.tests == 'true'
         run: npm ci
 
-      # 6. Fetch list of files changed in this PR
-      - name: Get changed test files
-        if: steps.filter.outputs.tests == 'true'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Generate test IDs
+        if: steps.changes.outputs.tests == 'true'
         run: |
-          curl -s \
-            -H "Authorization: Bearer $GITHUB_TOKEN" \
-            "${{ github.event.pull_request.url }}/files?per_page=100" \
-            | jq -r ".[].filename" \
-            > changed-files.txt
-
-          grep -E "^tests/(draft[^/]+)/.*\.json$" changed-files.txt \
-            | sed -E "s|^tests/([^/]+)/.*|\1|" \
-            | sort -u \
-            > affected-drafts.txt
-
-      # 7. Run add-test-ids.js for each changed file
-      - name: Apply missing test IDs
-        if: steps.filter.outputs.tests == 'true'
-        env:
-          CI: "false"
+          node scripts/generate-ids-for.js draft2020-12
+          node scripts/generate-ids-for.js draft2019-09
+          node scripts/generate-ids-for.js draft7
+          node scripts/generate-ids-for.js draft6
+          node scripts/generate-ids-for.js draft4
+          node scripts/generate-ids-for.js v1
+
+      - name: Commit and push
+        if: steps.changes.outputs.tests == 'true'
         run: |
-          if [ ! -s affected-drafts.txt ]; then
-            echo "No test JSON files changed - nothing to do."
-            exit 0
-          fi
-
-          while IFS= read -r draft; do
-            echo "Processing dialect: $draft"
-            grep -E "^tests/${draft}/.*\.json$" changed-files.txt | while IFS= read -r file; do
-              if [ -f "$file" ]; then
-                echo "  -> $file"
-                node scripts/add-test-ids.js "$draft" "$file"
-              fi
-            done
-          done < affected-drafts.txt
-
-      # 8. Commit and push back to the PR branch
-      - name: Commit and push changes
-        if: steps.filter.outputs.tests == 'true'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          git config user.name  "test-id-bot"
+          git config user.name "test-id-bot"
           git config user.email "test-id-bot@users.noreply.github.com"
 
-          git add "tests/**/*.json"
-
-          if git diff --cached --quiet; then
-            echo "No test ID changes needed - nothing to commit."
-            echo "CHANGES_MADE=false" >> $GITHUB_ENV
-          else
-            SUMMARY=""
-            TOTAL=0
-            while IFS= read -r file; do
-              COUNT=$(git diff --cached -- "$file" | grep "^+" | grep '"id":' | wc -l | tr -d " ")
-              if [ "$COUNT" -gt 0 ]; then
-                SUMMARY="${SUMMARY}\n- \`${file}\` - **${COUNT}** ID(s) added"
-                TOTAL=$((TOTAL + COUNT))
-              fi
-            done < <(git diff --cached --name-only)
-
-            printf "%b" "$SUMMARY" > /tmp/summary.txt
-            echo "TOTAL_IDS=${TOTAL}" >> $GITHUB_ENV
-
-            git commit -m "chore: auto-add missing test IDs"
-
-            COMMIT_SHA=$(git rev-parse HEAD)
-            echo "COMMIT_SHA=${COMMIT_SHA}" >> $GITHUB_ENV
-
-            git push \
-              https://x-access-token:${GITHUB_TOKEN}@github.com/${{ github.event.pull_request.head.repo.full_name }}.git \
-              HEAD:refs/heads/${{ github.event.pull_request.head.ref }}
-
-            echo "CHANGES_MADE=true" >> $GITHUB_ENV
-          fi
-
-      # 9. Post a summary comment on the PR
-      - name: Post PR comment
-        if: env.CHANGES_MADE == 'true'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          SUMMARY=$(cat /tmp/summary.txt)
-          COMMIT_URL="https://github.com/${{ github.event.pull_request.head.repo.full_name }}/commit/${COMMIT_SHA}"
+          git add $(find tests -name "*.json" ! -type l)
 
-          BODY="### test-id-bot added ${TOTAL_IDS} missing test ID(s)\n\n${SUMMARY}\n\nView the full diff of added IDs: ${COMMIT_URL}\n\n> IDs are deterministic hashes based on the schema, test data, and expected result."
+          git diff --cached --quiet || git commit -m "chore: auto-add missing test IDs"
 
-          curl -s -X POST \
-            -H "Authorization: Bearer $GITHUB_TOKEN" \
-            -H "Content-Type: application/json" \
-            "${{ github.event.pull_request.comments_url }}" \
-            --data "$(jq -n --arg body "$(printf '%b' "$BODY")" '{body: $body}')"
+          git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.event.pull_request.head.repo.full_name }}.git HEAD:refs/heads/${{ github.event.pull_request.head.ref }}

.github/workflows/generate-test-ids.yml

@@ -0,0 +1,52 @@
+name: Test IDs
+
+on: [pull_request]
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }} # Check out the PR branch, not the merge commit
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: latest
+
+      - name: Install dependencies
+        run: npm ci
+
+      # - name: Generate test IDs for v1
+      #   run: node scripts/generate-ids-for.js v1
+      #
+      # - name: Generate test IDs for draft2020-12
+      #   run: node scripts/generate-ids-for.js draft2020-12
+      #
+      # - name: Generate test IDs for draft2019-09
+      #   run: node scripts/generate-ids-for.js draft2019-09
+      #
+      # - name: Generate test IDs for draft7
+      #   run: node scripts/generate-ids-for.js draft7
+      #
+      # - name: Generate test IDs for draft6
+      #   run: node scripts/generate-ids-for.js draft6
+      #
+      # - name: Generate test IDs for draft4
+      #   run: node scripts/generate-ids-for.js draft4
+
+      - name: Commit and push changes
+        run: |
+          git config user.name "test-id-action"
+          git config user.email "test-id-action@users.noreply.github.com"
+          git add "tests/**/*.json"
+          git commit -m "Update test IDs based on the schema, test data, and expected result." || echo "No changes to commit"
+          git push origin ${{ github.event.pull_request.head.ref }}

README.md

@@ -8,6 +8,7 @@
 [![Build Status](https://github.com/json-schema-org/JSON-Schema-Test-Suite/workflows/Test%20Suite%20Sanity%20Checking/badge.svg)](https://github.com/json-schema-org/JSON-Schema-Test-Suite/actions?query=workflow%3A%22Test+Suite+Sanity+Checking%22)
 
 This repository contains a set of JSON objects that implementers of JSON Schema validation libraries can use to test their validators.
+The test suite repository exists to verify specified behavior defined by the JSON Schema specification and should not be confused with a style guide. It is not intended to demonstrate how schemas ought to be written. Tests may appear unusual or unintuitive, but they exist solely to exercise behavior prescribed by the specification.
 
 It is meant to be language agnostic and should require only a JSON parser.
 The conversion of the JSON objects into tests within a specific language and test framework of choice is left to be done by the validator implementer.
@@ -79,15 +80,13 @@ Here is a single *test case*, containing one or more tests:
 
 ### Subdirectories Within Each Version directory
 
-There is currently only one additional subdirectory that may exist within each specification version test directory.
+A specification version test directory may contain one or more subdirectories.
 
-This is:
+These are:
 
-1. `optional/`: Contains tests that are considered optional.
+1. `optional/`: Contains tests that are considered optional. Note that this subdirectory currently conflates many reasons why a test may be optional -- it may be because tests within a particular file are indeed not required by the specification but still potentially useful to an implementer, or it may be because tests within it only apply to programming languages with particular functionality (in which case they are not truly optional in such a language). In the future this directory structure will be made richer to reflect these differences more clearly.
 
-Note, the `optional/` subdirectory today conflates many reasons why a test may be optional -- it may be because tests within a particular file are indeed not required by the specification but still potentially useful to an implementer, or it may be because tests within it only apply to programming languages with particular functionality (in
-which case they are not truly optional in such a language).
-In the future this directory structure will be made richer to reflect these differences more clearly.
+2. `proposals/`: Contains a subfolder for each active proposal to the specification. If the proposal is a keyword (generally the case), then the subfolder will bear the name of that keyword. Inside the proposal subfolder is a series of test files that would contain amendments to the required test suite should the proposal be incorporated into the specification. These test should be considered volitile while the proposal is in development, however implementations claiming to support the proposal are expected to pass its tests.
 
 ## Using the Suite to Test a Validator Implementation
 
@@ -215,6 +214,7 @@ This suite is being used by:
 
 * [jinx](https://github.com/juxt/jinx)
 * [json-schema](https://github.com/tatut/json-schema)
+* [M3](https://github.com/JulesGosnell/m3) (all drafts, pure Clojure — also usable from Java, Kotlin, Scala, and JavaScript)
 
 ### Coffeescript
 
@@ -262,6 +262,7 @@ This suite is being used by:
 * [Snow](https://github.com/ssilverman/snowy-json)
 * [jsonschemafriend](https://github.com/jimblackler/jsonschemafriend)
 * [OpenAPI JSON Schema Generator](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator)
+* [M3](https://github.com/JulesGosnell/m3) (all drafts, pure Clojure — also usable from Kotlin, Scala, and JavaScript)
 
 ### JavaScript
 
@@ -280,10 +281,17 @@ This suite is being used by:
 * [jsen](https://github.com/bugventure/jsen)
 * [ajv](https://github.com/epoberezkin/ajv)
 * [djv](https://github.com/korzio/djv)
+* [M3](https://github.com/JulesGosnell/m3) (all drafts, pure Clojure — also usable from Java, Kotlin, and Scala)
 
 ### Kotlin
 
 * [json-schema-validation-comparison](https://www.creekservice.org/json-schema-validation-comparison/functional) (Comparison site for JVM-based validator implementations)
+* [kotlinx-schema](https://github.com/Kotlin/kotlinx-schema)
+* [M3](https://github.com/JulesGosnell/m3) (all drafts, pure Clojure — also usable from Java, Scala, and JavaScript)
+
+### Lua
+
+* [lua-schema](https://framagit.org/fperrad/lua-schema)
 
 ### Node.js
 
@@ -334,13 +342,17 @@ Node-specific support is maintained in a [separate repository](https://github.co
 ### Scala
 
 * [json-schema-validation-comparison](https://www.creekservice.org/json-schema-validation-comparison/functional) (Comparison site for JVM-based validator implementations)
-* [typed-json](https://github.com/frawa/typed-json)
+* [M3](https://github.com/JulesGosnell/m3) (all drafts, pure Clojure — also usable from Java, Kotlin, and JavaScript)
 
 ### Swift
 
 * [JSONSchema](https://github.com/kylef/JSONSchema.swift)
 * [swift-json-schema](https://github.com/ajevans99/swift-json-schema)
 
+### Unison
+
+* [typed-json](https://share.unison-lang.org/@frawa/typed-json)
+
 If you use it as well, please fork and send a pull request adding yourself to
 the list :).