Introduce Registry Core REST API v3 (#4085)

* Introduce Registry Core REST API v3

* Fix data migration/upgrade tests

* Temporarily disable data migration integration tests

* Run v2 regression tests against v3 server (using legacy v2 API)

* Addressed comments from @andreaTP - thanks!

* Expand default value for CORS_ALLOWED_ORIGINS a bit

Author: EricWittmann

.github/workflows/dispatch-openapi.yaml

@@ -134,7 +134,7 @@ jobs:
         if: failure()
         uses: actions/upload-artifact@v1.0.0
         with:
-          name: tests-logs
+          name: tests-logs-h2
           path: artifacts
 
   integration-tests-postgresql:
@@ -179,7 +179,7 @@ jobs:
         if: failure()
         uses: actions/upload-artifact@v1.0.0
         with:
-          name: tests-logs
+          name: tests-logs-postgresql
           path: artifacts
 
 
@@ -225,7 +225,7 @@ jobs:
         if: failure()
         uses: actions/upload-artifact@v1.0.0
         with:
-          name: tests-logs
+          name: tests-logs-kafkasql
           path: artifacts
 
   integration-tests-ui:
@@ -246,7 +246,7 @@ jobs:
       - name: Run UI tests
         run: |
           echo "Starting Registry App (In Memory)"
-          docker run -it -p 8080:8080 -d --env CORS_ALLOWED_ORIGINS=* ttl.sh/${{ github.sha }}/apicurio/apicurio-registry:1d
+          docker run -it -p 8080:8080 -d ttl.sh/${{ github.sha }}/apicurio/apicurio-registry:1d
           echo "Starting Registry UI"
           docker run -it -p 8888:8080 -d ttl.sh/${{ github.sha }}/apicurio/apicurio-registry-ui:1d
 
@@ -256,7 +256,7 @@ jobs:
 
           echo "App System Info:"
           echo "--"
-          curl -s http://localhost:8080/apis/registry/v2/system/info
+          curl -s http://localhost:8080/apis/registry/v3/system/info
           echo "--"
           echo ""
           echo "UI Config Info:"
@@ -293,5 +293,43 @@ jobs:
         if: failure()
         uses: actions/upload-artifact@v3
         with:
-          name: tests-logs
+          name: tests-logs-ui
+          path: artifacts
+
+  integration-tests-legacy-v2:
+    name: Integration Tests Legacy V2
+    runs-on: ubuntu-20.04
+    needs: prepare-integration-tests
+    steps:
+      - name: Checkout Registry 2.5
+        uses: actions/checkout@v4
+        with:
+          ref: '2.5.x'
+          path: registry-v2
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Run Legacy Integration Tests (Core API v2)
+        run: |
+          echo "Starting Registry App (In Memory)"
+          docker run -it -p 8181:8080 -d ttl.sh/${{ github.sha }}/apicurio/apicurio-registry:1d
+          cd registry-v2
+          ./mvnw -T 1.5C -Pintegration-tests clean install -DskipTests=true -Dmaven.javadoc.skip=true
+          cd integration-tests
+          ../mvnw -T 1.5C verify -Pregression -Dmaven.javadoc.skip=true -Dquarkus.http.test-host=localhost -Dquarkus.http.test-port=8181
+
+      - name: Collect logs
+        if: failure()
+        run: ./.github/scripts/collect_logs.sh
+
+      - name: Upload tests logs artifacts
+        if: failure()
+        uses: actions/upload-artifact@v1.0.0
+        with:
+          name: tests-logs-legacy-v2
           path: artifacts

.github/workflows/integration-tests.yaml

@@ -76,7 +76,7 @@ jobs:
           DOCS_VERSION=$(echo "${{ github.event.inputs.release-version}}" | awk -F '.' '{print $1"."$2".x"}')
           
           sed -i  "s/version\:\s.*/version: \'${DOCS_VERSION}\'/g" docs/antora.yml
-          sed -i  "5s/\"version\"\:\s\".*\"/\"version\": \"${DOCS_VERSION}\"/g" app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json
+          sed -i  "5s/\"version\"\:\s\".*\"/\"version\": \"${DOCS_VERSION}\"/g" app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json
 
           # take only the major, minor and patch
           PYTHON_SDK_VERSION=$(echo "${{ github.event.inputs.release-version}}" | awk -F '.' '{print $1"."$2"."$3}')
@@ -178,7 +178,7 @@ jobs:
           DOCS_VERSION=$(echo "${{ github.event.inputs.snapshot-version}}" | awk -F '.' '{print $1"."$2".x"}')
           
           sed -i  "s/version\:\s.*/version: \'${DOCS_VERSION}\'/g" docs/antora.yml
-          sed -i  "5s/\"version\"\:\s\".*\"/\"version\": \"${DOCS_VERSION}\"/g" app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json
+          sed -i  "5s/\"version\"\:\s\".*\"/\"version\": \"${DOCS_VERSION}\"/g" app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json
 
           # take only the major, minor and patch
           PYTHON_SDK_VERSION=$(echo "${{ github.event.inputs.snapshot-version}}" | awk -F '.' '{print $1"."$2"."$3}')

.github/workflows/release.yaml

@@ -40,22 +40,15 @@ jobs:
       - name: Copy openapi.json
         run: |
           cd registry
-          cp ./common/src/main/resources/META-INF/openapi.json ./app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json
-
-      - name: Make copy with Auth info
-        run: |
-          cd registry/utils/tools
-          mvn clean package
-          mvn exec:java -Dexec.mainClass="io.apicurio.registry.utils.tools.AddOpenApiAuth" -Dexec.args="../../app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json ../../app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi-auth.json"
-          mvn exec:java -Dexec.mainClass="io.apicurio.registry.utils.tools.TransformOpenApiForClientGen" -Dexec.args="../../app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json ../../app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi-gen.json"
+          cp ./common/src/main/resources/META-INF/openapi.json ./app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json
+          cp ./common/src/main/resources/META-INF/openapi-v2.json ./app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json
 
       - name: Commit Release Version Change
         run: |
           cd registry
+          git add ./app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json
           git add ./app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json
-          git add ./app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi-auth.json
-          git add ./app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi-gen.json
-          git commit -m "Automatically updated the core v2 API OpenAPI definition."
+          git commit -m "Automatically updated the core API OpenAPI definition."
           git push
 
   validate:

.github/workflows/update-openapi.yaml

@@ -25,7 +25,7 @@ jobs:
       - name: Validate OpenAPI schema with Spectral and RHOAS Guidelines (Common)
         run: npx rhoasapi lint common/src/main/resources/META-INF/openapi.json
       - name: Validate OpenAPI schema with Spectral and RHOAS Guidelines (Final)
-        run: npx rhoasapi lint app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json
+        run: npx rhoasapi lint app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json
       - name: Cleanup
         run: |
           rm .spectral.yaml

.github/workflows/validate-openapi.yaml

@@ -356,7 +356,7 @@ jobs:
           base: main
           filters: |
             openapi:
-              - 'app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json'
+              - 'app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json'
 
       - name: Repository Dispatch
         if: steps.changes.outputs.openapi == 'true'
@@ -365,7 +365,7 @@ jobs:
           token: ${{ secrets.ACCESS_TOKEN }}
           repository: Apicurio/apicurio-registry-client-sdk-${{ matrix.language }}
           event-type: on-oas-updated
-          client-payload: '{"openapi_file_path": "app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v2/openapi.json"}'
+          client-payload: '{"openapi_file_path": "app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json"}'
 
   # Trigger a deployment workflow in the apicurio-operate-first repository, which will
   # deploy the `latest-snapshot` version of registry into the 3scale OpenShift cluster

.github/workflows/verify.yaml

@@ -21,7 +21,7 @@
 import io.apicurio.registry.ccompat.rest.error.ConflictException;
 import io.apicurio.registry.ccompat.rest.error.UnprocessableEntityException;
 import io.apicurio.registry.content.ContentHandle;
-import io.apicurio.registry.rest.v2.beans.ArtifactReference;
+import io.apicurio.registry.rest.v3.beans.ArtifactReference;
 import io.apicurio.registry.rules.RuleApplicationType;
 import io.apicurio.registry.rules.RuleViolationException;
 import io.apicurio.registry.rules.RulesService;

app/src/main/java/io/apicurio/registry/ccompat/rest/v7/impl/AbstractResource.java

@@ -21,7 +21,7 @@
 import lombok.ToString;
 
 /**
- * NOTE: Follow the naming conventions from {@link io.apicurio.registry.rest.v2.beans.Limits}
+ * NOTE: Follow the naming conventions from {@link io.apicurio.registry.rest.v3.beans.Limits}
  *
  * @author Fabian Martinez
  */

app/src/main/java/io/apicurio/registry/limits/RegistryLimitsConfiguration.java

@@ -18,7 +18,7 @@
 
 import io.apicurio.registry.ccompat.rest.error.*;
 import io.apicurio.registry.ccompat.rest.error.ConflictException;
-import io.apicurio.registry.rest.v2.beans.Error;
+import io.apicurio.registry.rest.v3.beans.Error;
 import io.apicurio.registry.rules.RuleViolationException;
 import io.apicurio.registry.services.http.ErrorHttpResponse;
 import io.apicurio.registry.services.http.RegistryExceptionMapperService;

app/src/main/java/io/apicurio/registry/rest/RegistryExceptionMapper.java

@@ -893,7 +893,8 @@ private ArtifactMetaData createArtifactWithRefs(String groupId, String xRegistry
             //Try to resolve the new artifact references and the nested ones (if any)
             final Map<String, ContentHandle> resolvedReferences = storage.resolveReferences(referencesAsDtos);
 
-            rulesService.applyRules(defaultGroupIdToNull(groupId), artifactId, artifactType, content, RuleApplicationType.CREATE, references, resolvedReferences);
+            rulesService.applyRules(defaultGroupIdToNull(groupId), artifactId, artifactType, content, 
+                    RuleApplicationType.CREATE, toV3Refs(references), resolvedReferences);
 
             final String finalArtifactId = artifactId;
             EditableArtifactMetaDataDto metaData = getEditableMetaData(artifactName, artifactDescription);
@@ -991,7 +992,8 @@ private VersionMetaData createArtifactVersionWithRefs(String groupId, String art
         final Map<String, ContentHandle> resolvedReferences = storage.resolveReferences(referencesAsDtos);
 
         String artifactType = lookupArtifactType(groupId, artifactId);
-        rulesService.applyRules(defaultGroupIdToNull(groupId), artifactId, artifactType, content, RuleApplicationType.UPDATE, references, resolvedReferences);
+        rulesService.applyRules(defaultGroupIdToNull(groupId), artifactId, artifactType, content, 
+                RuleApplicationType.UPDATE, toV3Refs(references), resolvedReferences);
         EditableArtifactMetaDataDto metaData = getEditableMetaData(artifactName, artifactDescription);
         ArtifactMetaDataDto amd = storage.updateArtifactWithMetadata(defaultGroupIdToNull(groupId), artifactId, xRegistryVersion, artifactType, content, metaData, referencesAsDtos);
         return V2ApiUtil.dtoToVersionMetaData(defaultGroupIdToNull(groupId), artifactId, artifactType, amd);
@@ -1099,7 +1101,8 @@ private ArtifactMetaData updateArtifactInternal(String groupId, String artifactI
 
         final Map<String, ContentHandle> resolvedReferences = storage.resolveReferences(referencesAsDtos);
 
-        rulesService.applyRules(defaultGroupIdToNull(groupId), artifactId, artifactType, content, RuleApplicationType.UPDATE, references, resolvedReferences);
+        rulesService.applyRules(defaultGroupIdToNull(groupId), artifactId, artifactType, content,
+                RuleApplicationType.UPDATE, toV3Refs(references), resolvedReferences);
         EditableArtifactMetaDataDto metaData = getEditableMetaData(name, description);
         ArtifactMetaDataDto dto = storage.updateArtifactWithMetadata(defaultGroupIdToNull(groupId), artifactId, version, artifactType, content, metaData, referencesAsDtos);
         return V2ApiUtil.dtoToMetaData(defaultGroupIdToNull(groupId), artifactId, artifactType, dto);
@@ -1125,4 +1128,17 @@ private List<ArtifactReferenceDto> toReferenceDtos(List<ArtifactReference> refer
                 .collect(Collectors.toList());
     }
 
+    private static List<io.apicurio.registry.rest.v3.beans.ArtifactReference> toV3Refs(List<ArtifactReference> references) {
+        return references.stream().map(ref -> toV3Ref(ref)).collect(Collectors.toList());
+    }
+
+    private static io.apicurio.registry.rest.v3.beans.ArtifactReference toV3Ref(ArtifactReference reference) {
+        return io.apicurio.registry.rest.v3.beans.ArtifactReference.builder()
+                .artifactId(reference.getArtifactId())
+                .groupId(reference.getGroupId())
+                .version(reference.getVersion())
+                .name(reference.getName())
+                .build();
+    }
+
 }