db: update queries single param shortcut (#818)

Author: MykolaGolubyev

webtau-db/src/main/java/org/testingisdocumenting/webtau/db/Database.java

@@ -18,6 +18,7 @@
 
 import org.testingisdocumenting.webtau.data.table.TableData;
 import org.testingisdocumenting.webtau.reporter.StepReportOptions;
+import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
 import org.testingisdocumenting.webtau.reporter.WebTauStep;
 
 import java.util.Collections;
@@ -67,22 +68,45 @@ public <E> E querySingleValue(String query, Map<String, Object> params) {
     }
 
     public void update(String query) {
-        WebTauStep step = createStep(null,
-                tokenizedMessage(action("running DB update"), stringValue(query), ON, id(dataSource.getLabel())),
-                (rows) -> tokenizedMessage(action("ran DB update"), stringValue(query), ON, id(dataSource.getLabel()),
-                        action("affected"), numberValue(rows), classifier("rows")),
-                () -> QueryRunnerUtils.runUpdate(dataSource.getDataSource(), query));
+        update(query, Collections.emptyMap());
+    }
 
-        step.execute(StepReportOptions.REPORT_ALL);
+    public <E> void update(String query, E singleParam) {
+        update(query, DbNamedParamsQuery.singleNoNameParam(singleParam));
     }
 
     public void update(String query, Map<String, Object> params) {
+        DbNamedParamsQuery namedParamsQuery = new DbNamedParamsQuery(query, params);
+
         WebTauStep step = createStep(null,
-                tokenizedMessage(action("running DB update"), stringValue(query), ON, id(dataSource.getLabel()), WITH, stringValue(params)),
-                (rows) -> tokenizedMessage(action("ran DB update"), stringValue(query), ON, id(dataSource.getLabel()),
-                        action("affected"), numberValue(rows), classifier("rows")),
-                () -> QueryRunnerUtils.runUpdate(dataSource.getDataSource(), query, params));
+                updateMessage("running DB update", query, namedParamsQuery.effectiveParams(), null),
+                (rows) -> updateMessage("ran DB update", query, Collections.emptyMap(), (Integer) rows),
+                () -> QueryRunnerUtils.runUpdate(dataSource.getDataSource(), query, namedParamsQuery));
 
         step.execute(StepReportOptions.REPORT_ALL);
     }
+
+    private TokenizedMessage updateMessage(String actionLabel,
+                                           String query,
+                                           Map<String, Object> params,
+                                           Integer numberOfRows) {
+        return appendParamsAndAffectedIfRequired(
+                tokenizedMessage(action(actionLabel), stringValue(query), ON, id(dataSource.getLabel())),
+                params,
+                numberOfRows);
+    }
+
+    private TokenizedMessage appendParamsAndAffectedIfRequired(TokenizedMessage message,
+                                                               Map<String, Object> params,
+                                                               Integer numberOfRows) {
+        if (!params.isEmpty()) {
+            message.add(WITH, stringValue(params));
+        }
+
+        if (numberOfRows != null) {
+            message.add(action("affected"), numberValue(numberOfRows), classifier("rows"));
+        }
+
+        return message;
+    }
 }

webtau-db/src/main/java/org/testingisdocumenting/webtau/db/DatabaseFacade.java

@@ -75,6 +75,10 @@ public void update(String query, Map<String, Object> params) {
         from(getPrimaryDataSource()).update(query, params);
     }
 
+    public <E> void update(String query, E singleParam) {
+        from(getPrimaryDataSource()).update(query, singleParam);
+    }
+
     private static LabeledDataSource getPrimaryDataSource() {
         return new LabeledDataSource(DbDataSourceProviders.provideByName("primary"), "primary-db");
     }

webtau-db/src/main/java/org/testingisdocumenting/webtau/db/QueryRunnerUtils.java

@@ -46,13 +46,17 @@ static int runUpdate(DataSource dataSource, String query) {
     }
 
     static int runUpdate(DataSource dataSource, String query, Map<String, Object> params) {
+        DbNamedParamsQuery namedParamsQuery = new DbNamedParamsQuery(query, params);
+        return runUpdate(dataSource, query, namedParamsQuery);
+    }
+
+    static int runUpdate(DataSource dataSource, String query, DbNamedParamsQuery namedParamsQuery) {
         QueryRunner run = new QueryRunner(dataSource);
 
         try {
-            if (params.isEmpty()) {
+            if (namedParamsQuery.isEmpty()) {
                 return run.update(query);
             } else {
-                DbNamedParamsQuery namedParamsQuery = new DbNamedParamsQuery(query, params);
                 return run.update(namedParamsQuery.getQuestionMarksQuery(), namedParamsQuery.getQuestionMarksValues());
             }
         } catch (SQLException e) {

webtau-db/src/test/groovy/org/testingisdocumenting/webtau/db/DatabaseFacadeTest.groovy

@@ -262,6 +262,14 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
         db.table("PRICES").query().numberOfRows().should == 0
     }
 
+    @Test
+    void "delete with single param shortcut"() {
+        setupPrices()
+
+        db.update("delete from PRICES where price > :price", 950)
+        db.table("PRICES").query().numberOfRows().should == 0
+    }
+
     @Test
     void "should run updates with params"() {
         def PRICES = setupPrices()

webtau-db/src/test/groovy/org/testingisdocumenting/webtau/db/DatabaseStepReporterTest.groovy

@@ -65,7 +65,7 @@ class DatabaseStepReporterTest extends DatabaseBaseTest implements StepReporter
     }
 
     @Test
-    void "query result comparison step should not capture params when no params ara passed"() {
+    void "query result comparison step should not capture params when no params are passed"() {
         setupPrices()
 
         def price = db.query("select price from PRICES where id='id1'")
@@ -75,8 +75,31 @@ class DatabaseStepReporterTest extends DatabaseBaseTest implements StepReporter
         fullMessage.should contain("select price from PRICES where id='id1' equals 1000")
     }
 
+    @Test
+    void "update step should capture query and params in case of maps param"() {
+        setupPrices()
+
+        db.update("delete from PRICES where price>:price1 or price>:price2", [price1: 1000, price2: 2000])
+
+        def fullMessage = stepMessages.join('\n')
+        fullMessage.should contain(
+                "running DB update delete from PRICES where price>:price1 or price>:price2 on primary-db with {price1=1000, price2=2000}")
+    }
+
+    @Test
+    void "update step should capture query and params in case of single param"() {
+        setupPrices()
+
+        db.update("delete from PRICES where price>:price", 950)
+
+        def fullMessage = stepMessages.join('\n')
+        fullMessage.should contain(
+                "running DB update delete from PRICES where price>:price on primary-db with {price=950}")
+    }
+
     @Override
     void onStepStart(WebTauStep step) {
+        stepMessages << step.inProgressMessage.toString()
     }
 
     @Override

webtau-docs/znai/database/data-setup.md

@@ -65,6 +65,14 @@ Note: code above assumes `WebTauCore.*` static import or `WebTauGroovyDsl.*` sta
     commentsType: "inline"
 }
 
+:include-groovy: org/testingisdocumenting/webtau/db/DatabaseFacadeTest.groovy {
+    entry: "delete with single param shortcut",
+    title: "delete data with single param shortcut",
+    bodyOnly: true,
+    includeRegexp: "delete",
+    commentsType: "inline"
+}
+
 # Updating Tables
 
 :include-table: doc-artifacts/db-before-update.json { title: "PRICES" }