Merge pull request #60 from aquality-automation/feature/dao-unit-tests

Feature/unit tests for dao

Author: VladislavKostyukevich

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.3.9 (Unreleased)
+
+Features:
+  - Added unit tests for checking DAO's -> [View Issue](https://github.com/aquality-automation/aquality-tracking/issues/80)
+
 ## 0.3.8 (2020-03-11)
 
 Features:

src/main/java/main/model/db/dao/DAO.java

@@ -78,6 +78,7 @@ public List<T> getAll() throws AqualityException {
      */
     public List<T> searchAll(T entity) throws AqualityException {
         List<Pair<String, String>> parameters = entity.getSearchParameters();
+        checkSelectProcedure();
         return dtoMapper.mapObjects(CallStoredProcedure(select, parameters).toString());
     }
 
@@ -95,6 +96,7 @@ public T getEntityById(Integer id) throws AqualityException {
         }
 
         List<Pair<String, String>> parameters = entity.getIdSearchParameters(id);
+        checkSelectProcedure();
         List<T> all = dtoMapper.mapObjects(CallStoredProcedure(select, parameters).toString());
 
         return getSingleResult(all, id);
@@ -107,6 +109,7 @@ public T getEntityById(Integer id) throws AqualityException {
      */
     public T getEntityById(T entity) throws AqualityException {
         List<Pair<String, String>> parameters = entity.getIdAndProjectIdSearchParameters();
+        checkSelectProcedure();
         List<T> all = dtoMapper.mapObjects(CallStoredProcedure(select, parameters).toString());
 
         return getSingleResult(all, entity.getIdOrOverrideId());
@@ -129,6 +132,7 @@ public T update(T entity) throws AqualityException {
         }
 
         List<Pair<String, String>> parameters = entity.getParameters();
+        checkInsertProcedure();
         List<T> results = dtoMapper.mapObjects(CallStoredProcedure(insert, parameters).toString());
         if (!results.isEmpty()) {
             return results.get(0);
@@ -144,7 +148,7 @@ public T update(T entity) throws AqualityException {
      */
     public boolean delete(T entity) throws AqualityException {
         List<Pair<String, String>> parameters = entity.getDataBaseIDParameters();
-
+        checkRemoveProcedure();
         CallStoredProcedure(remove, parameters);
         return true;
     }
@@ -164,6 +168,7 @@ public T create(T entity) throws AqualityException {
 
         if(id == null){
             List<Pair<String, String>> parameters = entity.getParameters();
+            checkInsertProcedure();
             List<T> results = dtoMapper.mapObjects(CallStoredProcedure(insert, parameters).toString());
             if(!results.isEmpty()){
                 return results.get(0);
@@ -330,4 +335,22 @@ private boolean areParametersEmpty(List<Pair<String, String>> parameters) {
 
         return true;
     }
+
+    protected void checkSelectProcedure() throws AqualityException {
+        checkProcedure(select, "SELECT");
+    }
+
+    protected void checkInsertProcedure() throws AqualityException {
+        checkProcedure(insert, "INSERT");
+    }
+
+    protected void checkRemoveProcedure() throws AqualityException {
+        checkProcedure(remove, "REMOVE");
+    }
+
+    private void checkProcedure(String sql, String sqlName) throws AqualityException {
+        if(sql == null){
+            throw new AqualityException(String.format("SQL procedure '%s' is not define for DAO '%s'", sqlName, getClass()));
+        }
+    }
 }

src/main/java/main/model/db/dao/audit/AuditorsDao.java

@@ -19,6 +19,7 @@ public AuditorsDao() {
     @Override
     public List<AuditorDto> searchAll(AuditorDto entity) throws AqualityException {
         List<Pair<String, String>> parameters = entity.getSearchParameters();
+        checkSelectProcedure();
         List<AuditorDto> auditors = dtoMapper.mapObjects(CallStoredProcedure(select, parameters).toString());
         auditors.forEach(UserDto::toPublic);
         return auditors;

src/main/java/main/model/db/dao/project/APITokenDao.java

@@ -24,7 +24,7 @@ public APITokenDto create(APITokenDto entity) throws AqualityException {
         String token = generateToken();
         entity.setApi_token(DigestUtils.md5Hex(token + "advbc1671-nlksdui-ff"));
         List<Pair<String, String>> parameters = entity.getParameters();
-
+        checkInsertProcedure();
         CallStoredProcedure(insert, parameters);
         entity.setApi_token(token);
         return entity;

src/main/java/main/model/db/dao/project/Step2TestDao.java

@@ -24,6 +24,7 @@ public Step2TestDao() {
      */
     public Step2TestDto create(Step2TestDto entity) throws AqualityException {
         List<ConnectionUrlParser.Pair<String, String>> parameters = entity.getParameters();
+        checkInsertProcedure();
         CallStoredProcedure(insert, parameters);
         return entity;
     }
@@ -35,6 +36,7 @@ public Step2TestDto create(Step2TestDto entity) throws AqualityException {
      */
     public List<StepDto> getTestSteps(Step2TestDto entity) throws AqualityException {
         List<ConnectionUrlParser.Pair<String, String>> parameters = entity.getSearchParameters();
+        checkSelectProcedure();
         List<StepDto> results = new DtoMapper<>(StepDto.class).mapObjects(CallStoredProcedure(select, parameters).toString());
         return results;
     }

src/main/java/main/model/db/dao/project/StepResultDao.java

@@ -8,6 +8,5 @@ public StepResultDao() {
         super(StepResultDto.class);
         select = "{call SELECT_STEP_RESULT(?,?,?)}";
         insert = "{call INSERT_STEP_RESULT(?,?,?,?,?,?,?,?,?,?,?,?)}";
-        remove = "{call REMOVE_STEP_RESULT(?)}";
     }
 }

src/test/java/tests/workers/dao/IDaoTest.java

@@ -0,0 +1,12 @@
+package tests.workers.dao;
+
+import main.exceptions.AqualityException;
+
+public interface IDaoTest {
+
+    void searchAllTest() throws AqualityException;
+
+    void insertTest() throws AqualityException;
+
+    void removeTest() throws AqualityException;
+}

src/test/java/tests/workers/audits/AuditAttachmentsDaoTest.java renamed to src/test/java/tests/workers/dao/audits/AuditAttachmentsDaoTest.java

@@ -1,4 +1,4 @@
-package tests.workers.audits;
+package tests.workers.dao.audits;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.mysql.cj.core.conf.url.ConnectionUrlParser.Pair;
@@ -9,21 +9,22 @@
 import org.json.JSONException;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
+import tests.workers.dao.IDaoTest;
 
 import java.util.ArrayList;
 import java.util.List;
 
 import static org.testng.Assert.assertEquals;
 import static utils.Validations.assertSQLToParams;
 
-public class AuditAttachmentsDaoTest extends AuditAttachmentsDao {
+public class AuditAttachmentsDaoTest extends AuditAttachmentsDao implements IDaoTest {
 
     private String currentSql;
     private List<Pair<String, String>> currentParameters;
     private List<AuditAttachmentDto> resultList;
 
     @BeforeMethod
-    public void cleanUpResults(){
+    public void cleanUpResults() {
         resultList = new ArrayList<>();
     }
 
@@ -50,7 +51,7 @@ public void removeTest() throws AqualityException {
     }
 
     @Override
-    protected JSONArray CallStoredProcedure(String sql, List<Pair<String, String>> parameters){
+    protected JSONArray CallStoredProcedure(String sql, List<Pair<String, String>> parameters) {
         currentSql = sql;
         currentParameters = parameters;
         try {

src/test/java/tests/workers/audits/AuditCommentsDaoTest.java renamed to src/test/java/tests/workers/dao/audits/AuditCommentsDaoTest.java

@@ -1,4 +1,4 @@
-package tests.workers.audits;
+package tests.workers.dao.audits;
 
 import com.mysql.cj.core.conf.url.ConnectionUrlParser.Pair;
 import main.exceptions.AqualityException;
@@ -8,6 +8,7 @@
 import org.json.JSONException;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
+import tests.workers.dao.IDaoTest;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -16,14 +17,14 @@
 import static utils.FileUtils.getResourceFileAsString;
 import static utils.Validations.assertSQLToParams;
 
-public class AuditCommentsDaoTest extends AuditCommentsDao {
+public class AuditCommentsDaoTest extends AuditCommentsDao implements IDaoTest {
 
     private String currentSql;
     private List<Pair<String, String>> currentParameters;
     private List<AuditCommentDto> resultList;
 
     @BeforeMethod
-    public void cleanUpResults(){
+    public void cleanUpResults() {
         resultList = new ArrayList<>();
     }
 
@@ -41,14 +42,18 @@ public void insertTest() throws AqualityException {
         assertSQLToParams(currentSql, currentParameters);
     }
 
+    @Test(expectedExceptions = AqualityException.class, expectedExceptionsMessageRegExp = "SQL procedure 'REMOVE' is not define for DAO.+AuditCommentsDao.+")
+    public void removeTest() throws AqualityException {
+        delete(new AuditCommentDto());
+    }
 
     @Override
-    protected JSONArray CallStoredProcedure(String sql, List<Pair<String, String>> parameters){
+    protected JSONArray CallStoredProcedure(String sql, List<Pair<String, String>> parameters) {
         currentSql = sql;
         currentParameters = parameters;
         try {
             return new JSONArray(getResourceFileAsString("entities/auditComments.json"));
-        } catch ( JSONException e) {
+        } catch (JSONException e) {
             e.printStackTrace();
         }
         return new JSONArray();

src/test/java/tests/workers/audits/AuditDaoTest.java renamed to src/test/java/tests/workers/dao/audits/AuditDaoTest.java

@@ -1,4 +1,4 @@
-package tests.workers.audits;
+package tests.workers.dao.audits;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.mysql.cj.core.conf.url.ConnectionUrlParser.Pair;
@@ -9,21 +9,22 @@
 import org.json.JSONException;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
+import tests.workers.dao.IDaoTest;
 
 import java.util.ArrayList;
 import java.util.List;
 
 import static org.testng.Assert.assertEquals;
 import static utils.Validations.assertSQLToParams;
 
-public class AuditDaoTest extends AuditDao {
+public class AuditDaoTest extends AuditDao implements IDaoTest {
 
     private String currentSql;
     private List<Pair<String, String>> currentParameters;
     private List<AuditDto> resultList;
 
     @BeforeMethod
-    public void cleanUpResults(){
+    public void cleanUpResults() {
         resultList = new ArrayList<>();
     }
 
@@ -50,7 +51,7 @@ public void removeTest() throws AqualityException {
     }
 
     @Override
-    protected JSONArray CallStoredProcedure(String sql, List<Pair<String, String>> parameters){
+    protected JSONArray CallStoredProcedure(String sql, List<Pair<String, String>> parameters) {
         currentSql = sql;
         currentParameters = parameters;
         try {