db: rollback createQuery -> query (#817)

Author: MykolaGolubyev

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

@@ -38,15 +38,15 @@ public DatabaseTable table(String name) {
         return new DatabaseTable(dataSource, name);
     }
 
-    public DbQuery createQuery(String query) {
+    public DbQuery query(String query) {
         return QueryRunnerUtils.createQuery(dataSource, query);
     }
 
-    public DbQuery createQuery(String query, Map<String, Object> params) {
+    public DbQuery query(String query, Map<String, Object> params) {
         return QueryRunnerUtils.createQuery(dataSource, query, params);
     }
 
-    public <E> DbQuery createQuery(String query, E singleParam) {
+    public <E> DbQuery query(String query, E singleParam) {
         return QueryRunnerUtils.createQuery(dataSource, query, DbNamedParamsQuery.singleNoNameParam(singleParam));
     }
 
@@ -55,15 +55,15 @@ public TableData queryTableData(String query) {
     }
 
     public TableData queryTableData(String query, Map<String, Object> params) {
-        return createQuery(query, params).queryTableData();
+        return query(query, params).tableData();
     }
 
     public <E> E querySingleValue(String query) {
         return querySingleValue(query, Collections.emptyMap());
     }
 
     public <E> E querySingleValue(String query, Map<String, Object> params) {
-        return createQuery(query, params).querySingleValue();
+        return query(query, params).singleValue();
     }
 
     public void update(String query) {

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

@@ -37,7 +37,7 @@ public void compareEqualOnly(CompareToComparator comparator, ActualPath actualPa
 
     private Object extractActual(Object expected, Object actual) {
         if (actual instanceof DatabaseTable) {
-            return ((DatabaseTable) actual).createQuery().queryTableDataNoStep();
+            return ((DatabaseTable) actual).query().queryTableDataNoStep();
         }
 
         DbQuery actualResult = (DbQuery) actual;

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

@@ -19,7 +19,6 @@
 import org.testingisdocumenting.webtau.data.table.TableData;
 
 import javax.sql.DataSource;
-import java.util.Collections;
 import java.util.Map;
 
 public class DatabaseFacade {
@@ -40,16 +39,16 @@ public DatabaseTable table(String tableName) {
         return from(getPrimaryDataSource()).table(tableName);
     }
 
-    public DbQuery createQuery(String query) {
-        return from(getPrimaryDataSource()).createQuery(query);
+    public DbQuery query(String query) {
+        return from(getPrimaryDataSource()).query(query);
     }
 
-    public DbQuery createQuery(String query, Map<String, Object> params) {
-        return from(getPrimaryDataSource()).createQuery(query, params);
+    public DbQuery query(String query, Map<String, Object> params) {
+        return from(getPrimaryDataSource()).query(query, params);
     }
 
-    public <E> DbQuery createQuery(String query, E singleParam) {
-        return from(getPrimaryDataSource()).createQuery(query, singleParam);
+    public <E> DbQuery query(String query, E singleParam) {
+        return from(getPrimaryDataSource()).query(query, singleParam);
     }
 
     public TableData queryTableData(String query) {

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

@@ -55,15 +55,11 @@ INTO, createMessageId()),
                 () -> insertRowStep(row));
     }
 
-    public TableData query() {
-        return createQuery().queryTableData();
-    }
-
-    public DbQuery createCountQuery() {
+    public DbQuery queryCount() {
         return QueryRunnerUtils.createQuery(dataSource, SqlQueriesGenerator.count(name));
     }
 
-    public DbQuery createQuery() {
+    public DbQuery query() {
         return QueryRunnerUtils.createQuery(dataSource, SqlQueriesGenerator.fullTable(name));
     }
 

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

@@ -57,15 +57,15 @@ public class DbQuery implements ActualValueExpectations, ActualPathAware {
         this.params = params;
     }
 
-    public int queryNumberOfRows() {
-        return queryTableDataNoStep().numberOfRows();
+    public int numberOfRows() {
+        return tableData().numberOfRows();
     }
 
-    public TableData queryTableData() {
+    public TableData tableData() {
         return fetchValueAsStep(this::queryTableDataNoStep);
     }
 
-    public <E> E querySingleValue() {
+    public <E> E singleValue() {
         return fetchValueAsStep(this::querySingleValueNoStep);
     }
 

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

@@ -35,12 +35,12 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
                    "id1" | "nice set"    | 1000
                    "id2" | "another set" | 2000 }
 
-        PRICES.createQuery().should == ["ID" | "DESCRIPTION" | "PRICE"] {
+        PRICES.query().should == ["ID" | "DESCRIPTION" | "PRICE"] {
                                        ___________________________________
                                        "id1" | "nice set"    | 1000
                                        "id2" | "another set" | 2000 }
 
-        db.createQuery("select * from PRICES where id='id2'").should ==
+        db.query("select * from PRICES where id='id2'").should ==
                 ["ID" | "DESCRIPTION" | "PRICE"] {
                 __________________________________
                 "id2" | "another set" | 2000 }
@@ -82,7 +82,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
                    cell.guid | "nice set"    |                 true |                "card" | cell.above + 10 // cell.above refers values above and can be modified with simple math operations
                    cell.guid | "another set" | permute(true, false) | permute("rts", "fps") | cell.above + 20 } // permute generates additional rows generating new rows with all the permutations
 
-        doc.capture('db-setup-permute-table', PRICES.query())
+        doc.capture('db-setup-permute-table', PRICES.query().tableData())
         PRICES.query().numberOfRows().should == 6
     }
 
@@ -93,7 +93,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
         def PRICES = db.table("PRICES")
         PRICES << data.csv.table('prices-db.csv')
 
-        doc.capture('db-setup-csv-table', PRICES.query())
+        doc.capture('db-setup-csv-table', PRICES.query().tableData())
         PRICES.should == [ "*ID" | "DESCRIPTION"  | "AVAILABLE" | "TYPE" | "PRICE"] {
                           __________________________________________________________
                            "id1" | "description1" |        true | "card" | 200
@@ -118,7 +118,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
         setupPrices()
 
         // query without where clause start
-        def prices = db.createQuery("select * from PRICES")
+        def prices = db.query("select * from PRICES")
         prices.should == ["ID" | "DESCRIPTION" | "PRICE"] {
                          ___________________________________
                          "id1" | "nice set"    | 1000
@@ -130,7 +130,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
     void "query table with select statement and param"() {
         setupPrices()
         // query with where clause start
-        def prices = db.createQuery("select * from PRICES where id=:id", [id: "id1"])
+        def prices = db.query("select * from PRICES where id=:id", [id: "id1"])
         prices.should == ["ID" | "DESCRIPTION" | "PRICE"] {
                          ___________________________________
                          "id1" | "nice set"    | 1000     }
@@ -141,7 +141,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
     void "create query is lazy"() {
         setupPrices()
         // query with where clause start
-        def prices = db.createQuery("select * from PRICES")
+        def prices = db.query("select * from PRICES")
 
         prices.shouldNot == []
         db.update("delete from PRICES")
@@ -154,7 +154,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
         setupPrices()
         // query with where clause start
         def PRICES = db.table("PRICES")
-        def numberOfItems = PRICES.createCountQuery()
+        def numberOfItems = PRICES.queryCount()
 
         numberOfItems.shouldNot == 0
         db.update("delete from PRICES")
@@ -166,7 +166,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
     void "query table to match one row and assert against map"() {
         setupPrices()
         // query with where clause start
-        def prices = db.createQuery("select * from PRICES where id=:id", [id: "id1"])
+        def prices = db.query("select * from PRICES where id=:id", [id: "id1"])
         prices.should == [ID: "id1", "DESCRIPTION": "nice set", PRICE: 1000]
         // query with where clause end
     }
@@ -175,15 +175,15 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
     void "query table to match one row using single param shortcut and assert against map"() {
         setupPrices()
         // query with where clause start
-        def prices = db.createQuery("select * from PRICES where id=:id or external_id=:id", "id1")
+        def prices = db.query("select * from PRICES where id=:id or external_id=:id", "id1")
         prices.should == [ID: "id1", "DESCRIPTION": "nice set", PRICE: 1000]
         // query with where clause end
     }
 
     @Test
     void "query table to match multiple row and assert against map"() {
         setupPrices()
-        def prices = db.createQuery("select * from PRICES")
+        def prices = db.query("select * from PRICES")
 
         code {
             prices.should == [ID: "id1", "DESCRIPTION": "nice set", PRICE: 1000]
@@ -194,7 +194,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
     void "query table with select statement and array param"() {
         setupPrices()
         // query with where clause start
-        def prices = db.createQuery("select * from PRICES where id in (:ids)", [ids: ["id1", "id2"]])
+        def prices = db.query("select * from PRICES where id in (:ids)", [ids: ["id1", "id2"]])
         prices.should == ["ID" | "DESCRIPTION" | "PRICE"] {
                          ___________________________________
                          "id1" | "nice set"    | 1000
@@ -213,7 +213,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
         }
 
         // query with where clause start
-        def count = db.createQuery("select count(*) from PRICES")
+        def count = db.query("select count(*) from PRICES")
         count.should == 2
 
         // event happen somewhere to increase the number of rows...
@@ -227,7 +227,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
     void "should query single value"() {
         setupPrices()
 
-        def price = db.createQuery("select price from PRICES where id='id1'")
+        def price = db.query("select price from PRICES where id='id1'")
         price.should == 1000
         price.shouldNot == 2000
     }
@@ -237,7 +237,7 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
         setupPrices()
 
         // query single value params start
-        def price = db.createQuery("select price from PRICES where id=:id", [id: 'id1'])
+        def price = db.query("select price from PRICES where id=:id", [id: 'id1'])
         price.should == 1000
         price.shouldNot == 2000
         // query single value params end
@@ -247,8 +247,8 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
     void "value returned from query is a special wrapper value"() {
         setupPrices()
         // single value access start
-        def price = db.createQuery("select price from PRICES where id=:id", [id: 'id1'])
-        if (price.querySingleValue() > 100) {
+        def price = db.query("select price from PRICES where id=:id", [id: 'id1'])
+        if (price.singleValue() > 100) {
             println("do something")
         }
         // single value access end
@@ -265,10 +265,10 @@ class DatabaseFacadeTest extends DatabaseBaseTest {
     @Test
     void "should run updates with params"() {
         def PRICES = setupPrices()
-        doc.capture('db-before-update', PRICES.query())
+        doc.capture('db-before-update', PRICES.query().tableData())
 
         db.update("update PRICES set price=:price where id=:id", [id: 'id2', price: 4000])
-        doc.capture('db-after-update', PRICES.query())
+        doc.capture('db-after-update', PRICES.query().tableData())
 
         PRICES.should == ["ID" | "DESCRIPTION" | "PRICE"] {
                          ___________________________________

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

@@ -44,7 +44,7 @@ class DatabaseStepReporterTest extends DatabaseBaseTest implements StepReporter
     void "query result comparison step should capture query and params"() {
         setupPrices()
 
-        def price = db.createQuery("select price from PRICES where id=:id", [id: 'id1'])
+        def price = db.query("select price from PRICES where id=:id", [id: 'id1'])
         price.should == 1000
         price.shouldNot == 2000
 
@@ -57,7 +57,7 @@ class DatabaseStepReporterTest extends DatabaseBaseTest implements StepReporter
     void "query result comparison step should capture query and params in case of single param"() {
         setupPrices()
 
-        def price = db.createQuery("select price from PRICES where id=:id", 'id1')
+        def price = db.query("select price from PRICES where id=:id", 'id1')
         price.should == 1000
 
         def fullMessage = stepMessages.join('\n')
@@ -68,7 +68,7 @@ class DatabaseStepReporterTest extends DatabaseBaseTest implements StepReporter
     void "query result comparison step should not capture params when no params ara passed"() {
         setupPrices()
 
-        def price = db.createQuery("select price from PRICES where id='id1'")
+        def price = db.query("select price from PRICES where id='id1'")
         price.should == 1000
 
         def fullMessage = stepMessages.join('\n')

webtau-db/src/test/groovy/org/testingisdocumenting/webtau/db/cfg/ConfigBasedDbProviderTest.groovy

@@ -31,6 +31,6 @@ class ConfigBasedDbProviderTest {
     void "should use data source provider for primary database"() {
         DbConfig.setDbPrimaryUrl("jdbc:h2:mem:dbconfig;DB_CLOSE_DELAY=-1")
         DbConfig.setDbPrimaryUserName("sa")
-        db.createQuery("select 1")
+        db.query("select 1")
     }
 }

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

@@ -55,7 +55,7 @@ If your query uses a single unique placeholder name, you can pass a regular valu
 
 # Lazy Declaration
 
-`createQuery` doesn't query database at the call time. It defines a query to be used later.
+`query` doesn't query database at the call time. It defines a query to be used later.
 
 :include-groovy: org/testingisdocumenting/webtau/db/DatabaseFacadeTest.groovy {
     entry: "create query is lazy",
@@ -102,7 +102,7 @@ Use `waitTo` on query result to continuously query database until condition is m
 
 # Query Result Value
 
-Value returned from `createQuery` methods is an instance of `DbQuery` type.
+Value returned from `query` methods is an instance of `DbQuery` type.
 No actual query is performed when `DbQuery` instance is created. It holds information about what query is, and what its parameters
 and only performs query when validation is triggered.
 

webtau-groovy/src/main/groovy/org/testingisdocumenting/webtau/cli/repl/ReplResultRenderer.groovy

@@ -55,7 +55,7 @@ class ReplResultRenderer {
     }
 
     private static void renderDbQueryResult(DbQuery queryResult) {
-        out(ReplTableRenderer.render(queryResult.tableData))
+        out(ReplTableRenderer.render(queryResult.tableData()))
     }
 
     private static void renderPageElementAndHighlight(PageElement pageElement) {