Debezium SQL Server Connector native support #1193

apache · Jun 1, 2020 · 07c0dbb · 07c0dbb
1 parent 0e717c2
commit 07c0dbb
Show file tree

Hide file tree

Showing 29 changed files with 612 additions and 225 deletions.
diff --git a/docs/modules/ROOT/pages/extensions/debezium-sqlserver.adoc b/docs/modules/ROOT/pages/extensions/debezium-sqlserver.adoc
@@ -5,7 +5,7 @@
 = Debezium SQL Server Connector
 
 [.badges]
-[.badge-key]##Since Camel Quarkus##[.badge-version]##1.0.0-M6## [.badge-key]##JVM##[.badge-supported]##supported## [.badge-key]##Native##[.badge-unsupported]##unsupported##
+[.badge-key]##Since Camel Quarkus##[.badge-version]##1.0.0-M6## [.badge-key]##JVM##[.badge-supported]##supported## [.badge-key]##Native##[.badge-supported]##supported##
 
 Capture changes from an SQL Server database.
 
@@ -26,3 +26,32 @@ Please refer to the above link for usage and configuration details.
 ----
 
 Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
+
+== Usage
+
+=== Encryption
+
+SQL server may require encryption. In that case `quarkus.ssl.native=false` parameter has to be added during execution.
+See https://quarkus.io/guides/native-and-ssl for more details.
+
+=== Integration testing
+We can not start SQL container for legal reasons.
+
+To execute integration tests you are required to accept an EULA for SQL container image. Please add file named
+`container-license-acceptance.txt` with content `mcr.microsoft.com/mssql/server:2017-CU12` into the test resource
+folder (`integration-tests/debezium/src/test/resources`).
+
+For more details see https://www.testcontainers.org/modules/databases/mssqlserver/
+
+
+== Camel Quarkus limitations
+
+While you can use any of the available Kafka offset stores in JVM mode, only the following offset stores are supported
+in native mode:
+
+* `org.apache.kafka.connect.storage.FileOffsetBackingStore`
+* `org.apache.kafka.connect.storage.MemoryOffsetBackingStore`
+
+Please file an https://github.com/apache/camel-quarkus/issues/new[issue] if you are missing some specific offset store
+in native mode.
+
diff --git a/docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc b/docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc
@@ -126,7 +126,7 @@ Number of Camel components: 148 in 113 JAR artifacts (0 deprecated)
 
 | xref:extensions/debezium-postgres.adoc[Debezium PostgresSQL Connector] | camel-quarkus-debezium-postgres | Native + Stable | 1.0.0-M6 | Capture changes from a PostgresSQL database.
 
-| xref:extensions/debezium-sqlserver.adoc[Debezium SQL Server Connector] | camel-quarkus-debezium-sqlserver | JVM + Preview | 1.0.0-M6 | Capture changes from an SQL Server database.
+| xref:extensions/debezium-sqlserver.adoc[Debezium SQL Server Connector] | camel-quarkus-debezium-sqlserver | Native + Stable | 1.0.0-M8 | Capture changes from an SQL Server database.
 
 | xref:extensions/direct.adoc[Direct] | camel-quarkus-direct | Native + Stable | 0.2.0 | Call another endpoint from the same Camel Context synchronously.
 

diff --git a/extensions-jvm/debezium-sqlserver/integration-test/pom.xml b/extensions-jvm/debezium-sqlserver/integration-test/pom.xml
diff --git a/...a/org/apache/camel/quarkus/component/debezium/sqlserver/it/DebeziumSqlserverResource.java b/...a/org/apache/camel/quarkus/component/debezium/sqlserver/it/DebeziumSqlserverResource.java
diff --git a/extensions-jvm/pom.xml b/extensions-jvm/pom.xml
@@ -48,7 +48,6 @@
         <module>cassandraql</module>
         <module>couchbase</module>
         <module>debezium-mongodb</module>
-        <module>debezium-sqlserver</module>
         <module>google-bigquery</module>
         <module>google-pubsub</module>
         <module>groovy</module>

diff --git a/...jvm/debezium-sqlserver/deployment/pom.xml → ...ons/debezium-sqlserver/deployment/pom.xml b/...jvm/debezium-sqlserver/deployment/pom.xml → ...ons/debezium-sqlserver/deployment/pom.xml
@@ -17,7 +17,9 @@
     limitations under the License.
 
 -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>org.apache.camel.quarkus</groupId>
@@ -46,6 +48,10 @@
             <groupId>org.apache.camel.quarkus</groupId>
             <artifactId>camel-quarkus-core-deployment</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.apache.camel.quarkus</groupId>
+            <artifactId>camel-quarkus-debezium-sqlserver</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.apache.camel.quarkus</groupId>
             <artifactId>camel-quarkus-support-debezium-deployment</artifactId>
@@ -54,10 +60,6 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-jdbc-mssql-deployment</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.apache.camel.quarkus</groupId>
-            <artifactId>camel-quarkus-debezium-sqlserver</artifactId>
-        </dependency>
     </dependencies>
 
     <build>

diff --git a/...eployment/DebeziumSqlserverProcessor.java → ...eployment/DebeziumSqlserverProcessor.java b/...eployment/DebeziumSqlserverProcessor.java → ...eployment/DebeziumSqlserverProcessor.java
@@ -16,16 +16,13 @@
  */
 package org.apache.camel.quarkus.component.debezium.sqlserver.deployment;
 
+import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
-import io.quarkus.deployment.annotations.ExecutionTime;
-import io.quarkus.deployment.annotations.Record;
 import io.quarkus.deployment.builditem.FeatureBuildItem;
-import io.quarkus.deployment.pkg.steps.NativeBuild;
-import org.apache.camel.quarkus.core.JvmOnlyRecorder;
-import org.jboss.logging.Logger;
+import io.quarkus.deployment.builditem.IndexDependencyBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
 
 class DebeziumSqlserverProcessor {
-    private static final Logger LOG = Logger.getLogger(DebeziumSqlserverProcessor.class);
 
     private static final String FEATURE = "camel-debezium-sqlserver";
 
@@ -34,14 +31,15 @@ FeatureBuildItem feature() {
         return new FeatureBuildItem(FEATURE);
     }
 
-    /**
-     * Remove this once this extension starts supporting the native mode.
-     */
-    @BuildStep(onlyIf = NativeBuild.class)
-    @Record(value = ExecutionTime.RUNTIME_INIT)
-    void warnJvmInNative(JvmOnlyRecorder recorder) {
-        JvmOnlyRecorder.warnJvmInNative(LOG, FEATURE); // warn at build time
-        recorder.warnJvmInNative(FEATURE); // warn at runtime
+    @BuildStep
+    ReflectiveClassBuildItem reflectiveClasses() {
+        return new ReflectiveClassBuildItem(false, false,
+                new String[] { "io.debezium.connector.sqlserver.SqlServerConnector",
+                        "io.debezium.connector.sqlserver.SqlServerConnectorTask" });
     }
 
+    @BuildStep
+    void addDependencies(BuildProducer<IndexDependencyBuildItem> indexDependency) {
+        indexDependency.produce(new IndexDependencyBuildItem("io.debezium", "debezium-connector-sqlserver"));
+    }
 }
diff --git a/extensions-jvm/debezium-sqlserver/pom.xml → extensions/debezium-sqlserver/pom.xml b/extensions-jvm/debezium-sqlserver/pom.xml → extensions/debezium-sqlserver/pom.xml
@@ -17,13 +17,15 @@
     limitations under the License.
 
 -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>org.apache.camel.quarkus</groupId>
-        <artifactId>camel-quarkus-build-parent-it</artifactId>
+        <artifactId>camel-quarkus-build-parent</artifactId>
         <version>1.1.0-SNAPSHOT</version>
-        <relativePath>../../poms/build-parent-it/pom.xml</relativePath>
+        <relativePath>../../poms/build-parent/pom.xml</relativePath>
     </parent>
 
     <artifactId>camel-quarkus-debezium-sqlserver-parent</artifactId>
@@ -33,6 +35,5 @@
     <modules>
         <module>deployment</module>
         <module>runtime</module>
-        <module>integration-test</module>
     </modules>
 </project>
diff --git a/...ns-jvm/debezium-sqlserver/runtime/pom.xml → ...nsions/debezium-sqlserver/runtime/pom.xml b/...ns-jvm/debezium-sqlserver/runtime/pom.xml → ...nsions/debezium-sqlserver/runtime/pom.xml
@@ -17,7 +17,9 @@
     limitations under the License.
 
 -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>org.apache.camel.quarkus</groupId>
@@ -28,6 +30,7 @@
 
     <artifactId>camel-quarkus-debezium-sqlserver</artifactId>
     <name>Camel Quarkus :: Debezium SQL Server Connector :: Runtime</name>
+    <description>Capture changes from an SQL Server database.</description>
 
     <properties>
         <firstVersion>1.0.0-M6</firstVersion>
@@ -50,6 +53,16 @@
             <groupId>org.apache.camel.quarkus</groupId>
             <artifactId>camel-quarkus-core</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.apache.camel</groupId>
+            <artifactId>camel-debezium-sqlserver</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.apache.maven</groupId>
+                    <artifactId>maven-artifact</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
         <dependency>
             <groupId>org.apache.camel.quarkus</groupId>
             <artifactId>camel-quarkus-support-debezium</artifactId>
@@ -58,10 +71,6 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-jdbc-mssql</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.apache.camel</groupId>
-            <artifactId>camel-debezium-sqlserver</artifactId>
-        </dependency>
     </dependencies>
 
     <build>

diff --git a/extensions/debezium-sqlserver/runtime/src/main/doc/limitations.adoc b/extensions/debezium-sqlserver/runtime/src/main/doc/limitations.adoc
@@ -0,0 +1,8 @@
+While you can use any of the available Kafka offset stores in JVM mode, only the following offset stores are supported
+in native mode:
+
+* `org.apache.kafka.connect.storage.FileOffsetBackingStore`
+* `org.apache.kafka.connect.storage.MemoryOffsetBackingStore`
+
+Please file an https://github.com/apache/camel-quarkus/issues/new[issue] if you are missing some specific offset store
+in native mode.
diff --git a/extensions/debezium-sqlserver/runtime/src/main/doc/usage.adoc b/extensions/debezium-sqlserver/runtime/src/main/doc/usage.adoc
@@ -0,0 +1,13 @@
+=== Encryption
+
+SQL server may require encryption. In that case `quarkus.ssl.native=false` parameter has to be added during execution.
+See https://quarkus.io/guides/native-and-ssl for more details.
+
+=== Integration testing
+We can not start SQL container for legal reasons.
+
+To execute integration tests you are required to accept an EULA for SQL container image. Please add file named
+`container-license-acceptance.txt` with content `mcr.microsoft.com/mssql/server:2017-CU12` into the test resource
+folder (`integration-tests/debezium/src/test/resources`).
+
+For more details see https://www.testcontainers.org/modules/databases/mssqlserver/
diff --git a/...resources/META-INF/quarkus-extension.yaml → ...resources/META-INF/quarkus-extension.yaml b/...resources/META-INF/quarkus-extension.yaml → ...resources/META-INF/quarkus-extension.yaml
@@ -24,8 +24,6 @@
 name: "Camel Debezium SQL Server Connector"
 description: "Capture changes from an SQL Server database"
 metadata:
-  unlisted: true
   guide: "https://camel.apache.org/camel-quarkus/latest/extensions/debezium-sqlserver.html"
   categories:
   - "integration"
-  status: "preview"
diff --git a/extensions/pom.xml b/extensions/pom.xml
@@ -71,6 +71,7 @@
         <module>dataformat</module>
         <module>debezium-mysql</module>
         <module>debezium-postgres</module>
+        <module>debezium-sqlserver</module>
         <module>direct</module>
         <module>dozer</module>
         <module>elasticsearch-rest</module>

diff --git a/integration-tests/debezium/.gitignore b/integration-tests/debezium/.gitignore
@@ -1 +1,2 @@
-libs/mysql-connector-java-*.jar
+libs/mysql-connector-java-*.jar
+src/test/resources/*-license-*