From fe2d38e7a13c36dd20875c6a45528dfafaf0795e Mon Sep 17 00:00:00 2001
From: Jonah Graham <jonah@kichwacoders.com>
Date: Wed, 16 Aug 2023 15:22:28 -0400
Subject: [PATCH 1/3] Add API Baseline checking to the build

---
 BUILDING.md                                   |  4 ++
 Jenkinsfile                                   |  1 +
 pom.xml                                       | 37 +++++++++++++++++++
 releng/scripts/check_bundle_versions.sh       |  1 +
 .../scripts/check_bundle_versions_report.sh   | 17 +++++++++
 5 files changed, 60 insertions(+)

diff --git a/BUILDING.md b/BUILDING.md
index f897c3886d6..339bffc54c8 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -57,6 +57,10 @@ replace. To do that run with the `baseline-compare-and-replace` profile.
 
 Requires verify phase of maven to run, i.e. will not run with `mvn package` even if profile is specified.
 
+#### api-baseline-check
+
+`api-baseline-check` checks the API of CDT matches the [API policy](https://github.com/eclipse-cdt/cdt/blob/main/POLICY.md#api)
+
 #### production
 
 Runs the production steps of the build. This profile can only be run on the CDT CI machines
diff --git a/Jenkinsfile b/Jenkinsfile
index e56194241fd..346a2f829a3 100644
--- a/Jenkinsfile
+++ b/Jenkinsfile
@@ -42,6 +42,7 @@ pipeline {
                       -Dmaven.test.failure.ignore=true \
                       -DexcludedGroups=flakyTest,slowTest \
                       -P baseline-compare-and-replace \
+                      -P api-baseline-check \
                       -Ddsf.gdb.tests.timeout.multiplier=50 \
                       -Dindexer.timeout=300 \
                       -P production \
diff --git a/pom.xml b/pom.xml
index eec8476f338..b77cdc7d6d0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -45,6 +45,8 @@
 		<!-- Some old tests, like CDescriptorOldTests, fail due to reflection access. Therefore we add-opens to make that pass -->
 		<base.test.vmargs>-Xms256m -Xmx512m -ea --add-opens=java.xml/com.sun.org.apache.xerces.internal.dom=ALL-UNNAMED</base.test.vmargs>
 		<comparator.repo>https://download.eclipse.org/tools/cdt/releases/11.2/cdt-11.2.0/</comparator.repo>
+		<api-baseline.repo>https://download.eclipse.org/tools/cdt/releases/latest/</api-baseline.repo>
+		<api-baseline.repo.simrel>https://download.eclipse.org/releases/latest/</api-baseline.repo.simrel>
 		<!-- these parameters are to control baseline replace and compare. On a local build you want
 		     to avoid baseline replace and compare, especially if you have different versions of Java than
 			 the baseline was built with. This is the default.
@@ -549,6 +551,41 @@
 				<replace-version-with-baselines.replace>all</replace-version-with-baselines.replace>
 			</properties>
 		</profile>
+		<profile>
+			<id>api-baseline-check</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.eclipse.tycho</groupId>
+						<artifactId>tycho-apitools-plugin</artifactId>
+						<version>${tycho-version}</version>
+						<configuration>
+							<skipIfReplaced>false</skipIfReplaced>
+							<baselines>
+								<repository>
+									<url>${api-baseline.repo}</url>
+									<url>${api-baseline.repo.simrel}</url>
+								</repository>
+							</baselines>
+						</configuration>
+						<executions>
+							<execution>
+								<id>generate</id>
+								<goals>
+									<goal>generate</goal>
+								</goals>
+							</execution>
+							<execution>
+								<id>verify</id>
+								<goals>
+									<goal>verify</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
 		<profile>
 			<id>production</id>
 			<build>
diff --git a/releng/scripts/check_bundle_versions.sh b/releng/scripts/check_bundle_versions.sh
index 783efe9b257..95ad3f613ad 100755
--- a/releng/scripts/check_bundle_versions.sh
+++ b/releng/scripts/check_bundle_versions.sh
@@ -29,6 +29,7 @@ ${MVN:-mvn} \
         -DskipDoc=true \
         -DskipTests=true \
         -P baseline-compare-and-replace \
+        -P api-baseline-check \
          2>&1 | tee ${logfile}
 
 if [ $? -eq 0 ]; then
diff --git a/releng/scripts/check_bundle_versions_report.sh b/releng/scripts/check_bundle_versions_report.sh
index 6bbdcdc3daa..ae8beadd9c6 100755
--- a/releng/scripts/check_bundle_versions_report.sh
+++ b/releng/scripts/check_bundle_versions_report.sh
@@ -23,6 +23,7 @@ fi
 logfile=baseline-compare-and-replace.log
 bundles_only_qualifier_changed=$(grep "Only qualifier changed" ${logfile} | sed -e 's/^.*Only qualifier changed for .//' -e 's@/.*@@' | sort)
 if [ -n "$bundles_only_qualifier_changed" ]; then
+    echo
     echo "The following bundles are missing a service segment version bump:"
     for bundle in $bundles_only_qualifier_changed; do
         echo "  - $bundle"
@@ -35,6 +36,7 @@ fi
 
 bundles_same_version_different_content=$(grep "baseline and build artifacts have same version but different contents" ${logfile} | sed -e 's/^.* on project //' -e 's@: baseline.*@@' | sort)
 if [ -n "$bundles_same_version_different_content" ]; then
+    echo
     echo "The following bundles have same version as baseline, but different contents:"
     for bundle in $bundles_same_version_different_content; do
         echo "  - $bundle"
@@ -49,6 +51,21 @@ if [ -n "$bundles_same_version_different_content" ]; then
     echo
 fi
 
+api_errors=$(grep "API ERROR" ${logfile} | grep -v "0 API ERRORS" || true)
+if [ -n "$api_errors" ]; then
+    echo
+    echo "API Errors were detected when running the build:"
+    grep "API ERROR" ${logfile} | grep -v "0 API ERRORS" || true
+    major_version=$(grep "The major version should be incremented" ${logfile})
+    if [ -n "$major_version" ]; then
+        echo "WARNING: some of the API errors report as 'major version should be incremented'. Incrementing the"
+        echo "major version is only allowed on major new versions of CDT. This error indicates that API has been"
+        echo "broken in some incompatible way. An project committer can help explain what to do if the (lengthy)"
+        echo "documentation below needs interpreting for this use case.".
+    fi
+    echo "See https://github.com/eclipse-cdt/cdt/blob/main/POLICY.md#api for details"
+fi
+
 success=$(grep "SUCCESS - Maven check all versions have been bumped appropriately appears to have completed successfully" ${logfile})
 if [ -n "$success" ]; then
     echo "Maven check all versions have been bumped appropriately appears to have completed successfully"

From 6d4e8ededc0454700546a0e4a80ce724a02dbbf0 Mon Sep 17 00:00:00 2001
From: Jonah Graham <jonah@kichwacoders.com>
Date: Wed, 16 Aug 2023 15:55:12 -0400
Subject: [PATCH 2/3] Stop checking baseline-compare-and-replace in build and
 test workflow

This is checked in the code cleanliness workflow and by failing the
main build here causes the tests not to run and the tests are more
important. Similar to the new api-baseline-check that doesn't
run in the main workflow
---
 .github/workflows/build-test.yml | 1 -
 1 file changed, 1 deletion(-)

diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
index 778ec34e18b..7aea1a371c6 100644
--- a/.github/workflows/build-test.yml
+++ b/.github/workflows/build-test.yml
@@ -46,7 +46,6 @@ jobs:
           clean verify -B -V \
           -Dmaven.test.failure.ignore=true \
           -DexcludedGroups=flakyTest,slowTest \
-          -P baseline-compare-and-replace \
           -P build-standalone-debugger-rcp \
           -Ddsf.gdb.tests.timeout.multiplier=50 \
           -Ddsf-gdb.skip.tests=$(test ${{ steps.filter.outputs.dsf }} == 'false' && echo 'true' || echo 'false') \

From 75521e0e9fb73975a24bbe98581dc6a8f56dee05 Mon Sep 17 00:00:00 2001
From: Jonah Graham <jonah@kichwacoders.com>
Date: Wed, 16 Aug 2023 16:06:18 -0400
Subject: [PATCH 3/3] Fix the check bundle versions check

---
 releng/scripts/check_bundle_versions.sh | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/releng/scripts/check_bundle_versions.sh b/releng/scripts/check_bundle_versions.sh
index 95ad3f613ad..23867346b91 100755
--- a/releng/scripts/check_bundle_versions.sh
+++ b/releng/scripts/check_bundle_versions.sh
@@ -24,15 +24,15 @@ fi
 logfile=baseline-compare-and-replace.log
 echo "Running 'mvn verify -P baseline-compare-and-replace' to make sure all versions"
 echo "have been appropriately incremented."
-${MVN:-mvn} \
+
+
+if ${MVN:-mvn} \
         clean verify -B -V --fail-at-end \
         -DskipDoc=true \
         -DskipTests=true \
         -P baseline-compare-and-replace \
         -P api-baseline-check \
-         2>&1 | tee ${logfile}
-
-if [ $? -eq 0 ]; then
+         2>&1 | tee ${logfile}; then
     echo "SUCCESS - Maven check all versions have been bumped appropriately appears to have completed successfully"
     echo "SUCCESS - Maven check all versions have been bumped appropriately appears to have completed successfully" >> ${logfile}
 else