chore: SQL data source handling

- Auto resolve data source from Citrus bean registry - Allow to set data source by its name in the bean registry
citrusframework · Nov 11, 2024 · 23a6398 · 23a6398
1 parent 6080a5f
commit 23a6398
Show file tree

Hide file tree

Showing 11 changed files with 68 additions and 29 deletions.
diff --git a/...s-sql/src/main/java/org/citrusframework/actions/AbstractDatabaseConnectingTestAction.java b/...s-sql/src/main/java/org/citrusframework/actions/AbstractDatabaseConnectingTestAction.java
@@ -28,9 +28,12 @@
 import org.citrusframework.common.Described;
 import org.citrusframework.common.Named;
 import org.citrusframework.context.TestContext;
+import org.citrusframework.spi.ReferenceResolver;
+import org.citrusframework.spi.ReferenceResolverAware;
 import org.citrusframework.spi.Resource;
 import org.citrusframework.spi.Resources;
 import org.citrusframework.util.SqlUtils;
+import org.citrusframework.util.StringUtils;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.jdbc.core.support.JdbcDaoSupport;
 import org.springframework.transaction.PlatformTransactionManager;
@@ -210,16 +213,21 @@ public AbstractDatabaseConnectingTestAction setActor(TestActor actor) {
     /**
      * Action builder.
      */
-    public static abstract class Builder<T extends AbstractDatabaseConnectingTestAction, S extends Builder<T, S>> extends AbstractTestActionBuilder<T, S> {
+    public static abstract class Builder<T extends AbstractDatabaseConnectingTestAction, S extends Builder<T, S>> extends AbstractTestActionBuilder<T, S> implements ReferenceResolverAware {
 
         protected JdbcTemplate jdbcTemplate;
         protected DataSource dataSource;
+
+        protected String dataSourceName;
+
         protected String sqlResourcePath;
         protected final List<String> statements = new ArrayList<>();
         protected PlatformTransactionManager transactionManager;
         protected String transactionTimeout = String.valueOf(TransactionDefinition.TIMEOUT_DEFAULT);
         protected String transactionIsolationLevel = "ISOLATION_DEFAULT";
 
+        private ReferenceResolver referenceResolver;
+
         /**
          * Sets the Spring JDBC template to use.
          * @param jdbcTemplate
@@ -280,6 +288,16 @@ public S dataSource(DataSource dataSource) {
             return self;
         }
 
+        /**
+         * Sets the name of the SQL data source.
+         * @param dataSourceName
+         * @return
+         */
+        public S dataSource(String dataSourceName) {
+            this.dataSourceName = dataSourceName;
+            return self;
+        }
+
         /**
          * List of statements to execute. Declared inline in the test case.
          * @param statements
@@ -316,5 +334,30 @@ public S sqlResource(String filePath) {
             this.sqlResourcePath = filePath;
             return self;
         }
+
+        @Override
+        public final T build() {
+            if (jdbcTemplate == null && dataSource == null && referenceResolver != null) {
+                if (StringUtils.hasText(dataSourceName)) {
+                    dataSource = referenceResolver.resolve(dataSourceName, DataSource.class);
+                } else if (referenceResolver.isResolvable(DataSource.class)) {
+                    dataSource = referenceResolver.resolve(DataSource.class);
+                }
+            }
+
+            return doBuild();
+        }
+
+        protected abstract T doBuild();
+
+        public S withReferenceResolver(ReferenceResolver referenceResolver) {
+            this.referenceResolver = referenceResolver;
+            return self;
+        }
+
+        @Override
+        public void setReferenceResolver(ReferenceResolver referenceResolver) {
+            this.referenceResolver = referenceResolver;
+        }
     }
 }
diff --git a/connectors/citrus-sql/src/main/java/org/citrusframework/actions/ExecutePLSQLAction.java b/connectors/citrus-sql/src/main/java/org/citrusframework/actions/ExecutePLSQLAction.java
@@ -226,7 +226,7 @@ public Builder ignoreErrors(boolean ignoreErrors) {
         }
 
         @Override
-        public ExecutePLSQLAction build() {
+        public ExecutePLSQLAction doBuild() {
             return new ExecutePLSQLAction(this);
         }
     }

diff --git a/connectors/citrus-sql/src/main/java/org/citrusframework/actions/ExecuteSQLAction.java b/connectors/citrus-sql/src/main/java/org/citrusframework/actions/ExecuteSQLAction.java
@@ -16,13 +16,13 @@
 
 package org.citrusframework.actions;
 
+import java.util.List;
+import javax.sql.DataSource;
+
 import org.citrusframework.context.TestContext;
 import org.citrusframework.exceptions.CitrusRuntimeException;
 import org.springframework.transaction.support.TransactionTemplate;
 
-import javax.sql.DataSource;
-import java.util.List;
-
 /**
  * Test action execute SQL statements. Use this action when executing
  * database altering statements like UPDATE, INSERT, ALTER, DELETE. Statements are either
@@ -149,7 +149,7 @@ public Builder ignoreErrors(boolean ignoreErrors) {
         }
 
         @Override
-        public ExecuteSQLAction build() {
+        public ExecuteSQLAction doBuild() {
             return new ExecuteSQLAction(this);
         }
     }

diff --git a/connectors/citrus-sql/src/main/java/org/citrusframework/actions/ExecuteSQLQueryAction.java b/connectors/citrus-sql/src/main/java/org/citrusframework/actions/ExecuteSQLQueryAction.java
@@ -536,7 +536,7 @@ public Builder validator(SqlResultSetScriptValidator validator) {
         }
 
         @Override
-        public ExecuteSQLQueryAction build() {
+        public ExecuteSQLQueryAction doBuild() {
             return new ExecuteSQLQueryAction(this);
         }
     }

diff --git a/connectors/citrus-sql/src/main/java/org/citrusframework/sql/xml/Plsql.java b/connectors/citrus-sql/src/main/java/org/citrusframework/sql/xml/Plsql.java
@@ -16,16 +16,15 @@
 
 package org.citrusframework.sql.xml;
 
-import javax.sql.DataSource;
+import java.util.ArrayList;
+import java.util.List;
+
 import jakarta.xml.bind.annotation.XmlAccessType;
 import jakarta.xml.bind.annotation.XmlAccessorType;
 import jakarta.xml.bind.annotation.XmlAttribute;
 import jakarta.xml.bind.annotation.XmlElement;
 import jakarta.xml.bind.annotation.XmlRootElement;
 import jakarta.xml.bind.annotation.XmlType;
-import java.util.ArrayList;
-import java.util.List;
-
 import org.citrusframework.TestActionBuilder;
 import org.citrusframework.actions.ExecutePLSQLAction;
 import org.citrusframework.spi.ReferenceResolver;
@@ -37,7 +36,6 @@ public class Plsql implements TestActionBuilder<ExecutePLSQLAction>, ReferenceRe
 
     private final ExecutePLSQLAction.Builder builder = new ExecutePLSQLAction.Builder();
 
-    private String dataSource;
     private String transactionManager;
 
     private ReferenceResolver referenceResolver;
@@ -50,7 +48,7 @@ public Plsql setDescription(String value) {
 
     @XmlAttribute(name = "datasource", required = true)
     public Plsql setDataSource(String dataSource) {
-        this.dataSource = dataSource;
+        builder.dataSource(dataSource);
         builder.name(String.format("plsql:%s", dataSource));
         return this;
     }
@@ -96,7 +94,7 @@ public Plsql setIgnoreErrors(boolean value) {
     @Override
     public ExecutePLSQLAction build() {
         if (referenceResolver != null) {
-            builder.dataSource(referenceResolver.resolve(dataSource, DataSource.class));
+            builder.withReferenceResolver(referenceResolver);
 
             if (transactionManager != null) {
                 builder.transactionManager(referenceResolver.resolve(transactionManager, PlatformTransactionManager.class));

diff --git a/connectors/citrus-sql/src/main/java/org/citrusframework/sql/xml/Sql.java b/connectors/citrus-sql/src/main/java/org/citrusframework/sql/xml/Sql.java
@@ -20,7 +20,6 @@
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
-import javax.sql.DataSource;
 
 import jakarta.xml.bind.annotation.XmlAccessType;
 import jakarta.xml.bind.annotation.XmlAccessorType;
@@ -43,7 +42,6 @@ public class Sql implements TestActionBuilder<AbstractDatabaseConnectingTestActi
 
     private AbstractDatabaseConnectingTestAction.Builder<?, ?> builder = new ExecuteSQLAction.Builder();
 
-    private String dataSource;
     private String transactionManager;
 
     private ReferenceResolver referenceResolver;
@@ -60,9 +58,9 @@ public Sql setDescription(String value) {
         return this;
     }
 
-    @XmlAttribute(name = "datasource", required = true)
+    @XmlAttribute(name = "datasource")
     public Sql setDataSource(String dataSource) {
-        this.dataSource = dataSource;
+        builder.dataSource(dataSource);
         builder.name(String.format("sql:%s", dataSource));
         return this;
     }
@@ -120,7 +118,7 @@ public List<Extract> getExtracts() {
     @Override
     public AbstractDatabaseConnectingTestAction build() {
         if (referenceResolver != null) {
-            builder.dataSource(referenceResolver.resolve(dataSource, DataSource.class));
+            builder.withReferenceResolver(referenceResolver);
 
             if (transactionManager != null) {
                 builder.transactionManager(referenceResolver.resolve(transactionManager, PlatformTransactionManager.class));

diff --git a/connectors/citrus-sql/src/main/java/org/citrusframework/sql/yaml/Plsql.java b/connectors/citrus-sql/src/main/java/org/citrusframework/sql/yaml/Plsql.java
@@ -17,7 +17,6 @@
 package org.citrusframework.sql.yaml;
 
 import java.util.List;
-import javax.sql.DataSource;
 
 import org.citrusframework.TestActionBuilder;
 import org.citrusframework.actions.ExecutePLSQLAction;
@@ -29,7 +28,6 @@ public class Plsql implements TestActionBuilder<ExecutePLSQLAction>, ReferenceRe
 
     private final ExecutePLSQLAction.Builder builder = new ExecutePLSQLAction.Builder();
 
-    private String dataSource;
     private String transactionManager;
 
     private ReferenceResolver referenceResolver;
@@ -39,7 +37,7 @@ public void setDescription(String value) {
     }
 
     public void setDataSource(String dataSource) {
-        this.dataSource = dataSource;
+        builder.dataSource(dataSource);
         builder.name(String.format("plsql:%s", dataSource));
     }
 
@@ -80,7 +78,7 @@ public void setIgnoreErrors(boolean value) {
     @Override
     public ExecutePLSQLAction build() {
         if (referenceResolver != null) {
-            builder.dataSource(referenceResolver.resolve(dataSource, DataSource.class));
+            builder.withReferenceResolver(referenceResolver);
 
             if (transactionManager != null) {
                 builder.transactionManager(referenceResolver.resolve(transactionManager, PlatformTransactionManager.class));

diff --git a/connectors/citrus-sql/src/main/java/org/citrusframework/sql/yaml/Sql.java b/connectors/citrus-sql/src/main/java/org/citrusframework/sql/yaml/Sql.java
@@ -20,7 +20,6 @@
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
-import javax.sql.DataSource;
 
 import org.citrusframework.TestActionBuilder;
 import org.citrusframework.actions.AbstractDatabaseConnectingTestAction;
@@ -35,7 +34,6 @@ public class Sql implements TestActionBuilder<AbstractDatabaseConnectingTestActi
 
     private AbstractDatabaseConnectingTestAction.Builder<?, ?> builder = new ExecuteSQLAction.Builder();
 
-    private String dataSource;
     private String transactionManager;
 
     private ReferenceResolver referenceResolver;
@@ -49,7 +47,7 @@ public void setDescription(String value) {
     }
 
     public void setDataSource(String dataSource) {
-        this.dataSource = dataSource;
+        builder.dataSource(dataSource);
         builder.name(String.format("sql:%s", dataSource));
     }
 
@@ -110,7 +108,7 @@ public void setExtract(List<Extract> extract) {
     @Override
     public AbstractDatabaseConnectingTestAction build() {
         if (referenceResolver != null) {
-            builder.dataSource(referenceResolver.resolve(dataSource, DataSource.class));
+            builder.withReferenceResolver(referenceResolver);
 
             if (transactionManager != null) {
                 builder.transactionManager(referenceResolver.resolve(transactionManager, PlatformTransactionManager.class));

diff --git a/...iners/src/main/java/org/citrusframework/testcontainers/postgresql/PostgreSQLSettings.java b/...iners/src/main/java/org/citrusframework/testcontainers/postgresql/PostgreSQLSettings.java
@@ -144,15 +144,19 @@ public static void exposeConnectionSettings(PostgreSQLContainer<?> container, St
             context.setVariable(getEnvVarName(containerType, "CONTAINER_ID"), dockerContainerId);
             context.setVariable(getEnvVarName(containerType, "CONTAINER_NAME"), dockerContainerName);
 
+            context.setVariable(getEnvVarName(containerType, "SERVICE_PORT"), container.getMappedPort(PostgreSQLContainer.POSTGRESQL_PORT));
+            context.setVariable(getEnvVarName(containerType, "PORT"), container.getMappedPort(PostgreSQLContainer.POSTGRESQL_PORT));
             context.setVariable(getEnvVarName(containerType, "LOCAL_URL"), container.getJdbcUrl());
             context.setVariable(getEnvVarName(containerType, "SERVICE_LOCAL_URL"), container.getJdbcUrl());
 
             if (!KubernetesSupport.isConnected(context) || !TestContainersSettings.isKubedockEnabled()) {
                 context.setVariable(getEnvVarName(containerType, "SERVICE_NAME"), serviceName);
                 context.setVariable(getEnvVarName(containerType, "SERVICE_URL"), container.getJdbcUrl());
+                context.setVariable(getEnvVarName(containerType, "URL"), container.getJdbcUrl());
             } else {
                 context.setVariable(getEnvVarName(containerType, "SERVICE_NAME"), serviceName);
                 context.setVariable(getEnvVarName(containerType, "SERVICE_URL"), container.getJdbcUrl().replace("localhost", serviceName));
+                context.setVariable(getEnvVarName(containerType, "URL"), container.getJdbcUrl().replace("localhost", serviceName));
             }
 
             context.setVariable(getEnvVarName(containerType, "DRIVER"), container.getDriverClassName());

diff --git a/...main/resources/org/citrusframework/schema/xml/testcase/citrus-testcase-4.4.0-SNAPSHOT.xsd b/...main/resources/org/citrusframework/schema/xml/testcase/citrus-testcase-4.4.0-SNAPSHOT.xsd
@@ -810,7 +810,7 @@
         </xs:complexType>
       </xs:element>
     </xs:sequence>
-    <xs:attribute name="datasource" type="xs:string" use="required"/>
+    <xs:attribute name="datasource" type="xs:string"/>
     <xs:attribute name="ignore-errors" type="xs:boolean"/>
   </xs:complexType>
 

diff --git a/...citrus-xml/src/main/resources/org/citrusframework/schema/xml/testcase/citrus-testcase.xsd b/...citrus-xml/src/main/resources/org/citrusframework/schema/xml/testcase/citrus-testcase.xsd
@@ -810,7 +810,7 @@
         </xs:complexType>
       </xs:element>
     </xs:sequence>
-    <xs:attribute name="datasource" type="xs:string" use="required"/>
+    <xs:attribute name="datasource" type="xs:string"/>
     <xs:attribute name="ignore-errors" type="xs:boolean"/>
   </xs:complexType>