Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integration tests for delete #192

Merged
merged 1 commit into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package com.homihq.db2rest.rest.delete;


import com.homihq.db2rest.rest.delete.dto.DeleteResponse;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;


Expand All @@ -14,10 +16,12 @@ public class DeleteController {
private final DeleteService deleteService;

@DeleteMapping("/{tableName}")
public void delete(@PathVariable String tableName,
@RequestHeader(name = "Content-Profile") String schemaName,
@RequestParam(name = "filter", required = false, defaultValue = "") String filter) {
public ResponseEntity<DeleteResponse> delete(@PathVariable String tableName,
@RequestHeader(name = "Content-Profile") String schemaName,
@RequestParam(name = "filter", required = false, defaultValue = "") String filter) {

deleteService.delete(schemaName, tableName, filter);
int rows = deleteService.delete(schemaName, tableName, filter);
log.debug("Number of rows deleted - {}", rows);
return ResponseEntity.ok(DeleteResponse.builder().rows(rows).build());
}
}
31 changes: 17 additions & 14 deletions src/main/java/com/homihq/db2rest/rest/delete/DeleteService.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.homihq.db2rest.config.Db2RestConfigProperties;
import com.homihq.db2rest.exception.DeleteOpNotAllowedException;
import com.homihq.db2rest.exception.GenericDataAccessException;
import com.homihq.db2rest.exception.InvalidTableException;
import com.homihq.db2rest.mybatis.MyBatisTable;
import com.homihq.db2rest.rsql.operators.SimpleRSQLOperators;
Expand All @@ -17,13 +18,13 @@
import org.mybatis.dynamic.sql.delete.DeleteModel;
import org.mybatis.dynamic.sql.delete.render.DeleteStatementProvider;
import org.mybatis.dynamic.sql.render.RenderingStrategies;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import schemacrawler.schema.Table;

import java.util.Map;

import static org.mybatis.dynamic.sql.delete.DeleteDSL.deleteFrom;

@Service
Expand All @@ -33,27 +34,27 @@ public class DeleteService {

private final Db2RestConfigProperties db2RestConfigProperties;

private final NamedParameterJdbcTemplate namedParameterJdbcTemplate;

private final SchemaManager schemaManager;

@Transactional
public void delete(String schemaName, String tableName, String filter) {
public int delete(String schemaName, String tableName, String filter) {

if(StringUtils.isBlank(filter) && db2RestConfigProperties.isAllowSafeDelete()) {
if (StringUtils.isBlank(filter) && db2RestConfigProperties.isAllowSafeDelete()) {
throw new DeleteOpNotAllowedException(true);
}
else{
} else {

db2RestConfigProperties.verifySchema(schemaName);

Table t = schemaManager.getTable(schemaName, tableName)
.orElseThrow(() -> new InvalidTableException(tableName));

MyBatisTable table = new MyBatisTable(schemaName, tableName, t);
var table = new MyBatisTable(schemaName, tableName, t);

DeleteDSL<DeleteModel> deleteDSL = deleteFrom(table);

if(StringUtils.isNotBlank(filter)) {
if (StringUtils.isNotBlank(filter)) {

Node rootNode = new RSQLParser(SimpleRSQLOperators.customOperators()).parse(filter);

Expand All @@ -66,13 +67,15 @@ public void delete(String schemaName, String tableName, String filter) {
DeleteStatementProvider deleteStatement = deleteDSL.build()
.render(RenderingStrategies.SPRING_NAMED_PARAMETER);

String sql = deleteStatement.getDeleteStatement();
Map<String,Object> bindValues = deleteStatement.getParameters();


log.info("SQL - {}", sql);
log.info("Bind variables - {}", bindValues);
log.info("SQL - {}", deleteStatement.getDeleteStatement());
log.info("Bind variables - {}", deleteStatement.getParameters());

try {
return namedParameterJdbcTemplate.update(deleteStatement.getDeleteStatement(),
deleteStatement.getParameters());
} catch (DataAccessException e) {
throw new GenericDataAccessException(e.getMostSpecificCause().getMessage());
}

}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package com.homihq.db2rest.rest.delete.dto;

import lombok.Builder;

@Builder
public record DeleteResponse(int rows) {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
package com.homihq.db2rest.rest;

import com.homihq.db2rest.MySQLBaseIntegrationTest;
import org.hamcrest.Matchers;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import static org.hamcrest.Matchers.containsString;
import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.delete;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

class MySQLDeleteControllerTest extends MySQLBaseIntegrationTest {

@Test
@DisplayName("Delete a Director")
void delete_single_record() throws Exception {
mockMvc.perform(delete("/director")
.param("filter", "first_name==\"Alex\"")
.header("Content-Profile", "sakila")
.accept(APPLICATION_JSON))
.andExpect(status().isOk())
.andExpect(jsonPath("$.rows", Matchers.equalTo(1)))
.andDo(print())
.andDo(document("mysql-delete-a-director"));
}

@Test
@DisplayName("Delete all records while allowSafeDelete=true")
void delete_all_records_with_allow_safe_delete_true() throws Exception {
mockMvc.perform(delete("/director")
.header("Content-Profile", "sakila")
.accept(APPLICATION_JSON))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.detail",
containsString("Invalid delete operation , safe set to true")))
.andDo(print())
.andDo(document("mysql-delete-a-director"));
}

@Disabled
@Test
@DisplayName("Delete all records while allowSafeDelete=false")
void delete_all_records_with_allow_safe_delete_false() throws Exception {

}

@Test
@DisplayName("Column Does Not Exist")
void column_does_not_exist() throws Exception {
mockMvc.perform(delete("/director")
.param("filter", "_name==\"Alex\"")
.header("Content-Profile", "sakila")
.accept(APPLICATION_JSON))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.detail",
containsString("Unknown column '_name' in 'where clause'")))
.andDo(print())
.andDo(document("mysql-delete-a-director"));
}

@Test
@DisplayName("Foreign Key Constraint Violation")
void foreign_key_constraint_violation() throws Exception {
mockMvc.perform(delete("/language")
.param("filter", "name==\"ENGLISH\"")
.header("Content-Profile", "sakila")
.accept(APPLICATION_JSON))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.detail",
containsString("Cannot delete or update a parent row: a foreign key constraint fails")))
.andDo(print())
.andDo(document("mysql-delete-a-director"));
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
package com.homihq.db2rest.rest;

import com.homihq.db2rest.PostgreSQLBaseIntegrationTest;
import org.hamcrest.Matchers;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.http.MediaType;
Expand Down
4 changes: 4 additions & 0 deletions src/test/resources/application-it.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
db2rest:
schemas:
- sakila
- public
23 changes: 23 additions & 0 deletions src/test/resources/mysql/mysql-sakila-data.sql
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,29 @@ Values
('4','JENNIFER','DAVIS','2006-02-15 04:34:33.000');


-- director

Insert into director
(director_id,first_name,last_name,last_update)
Values
('1','Michael','Tam','2006-02-15 04:34:33.000');

Insert into director
(director_id,first_name,last_name,last_update)
Values
('2','Paul','Anderson','2006-02-15 04:34:33.000');

Insert into director
(director_id,first_name,last_name,last_update)
Values
('3','Alex','Chase','2006-02-15 04:34:33.000');

Insert into director
(director_id,first_name,last_name,last_update)
Values
('4','Karol','Davis','2006-02-15 04:34:33.000');


-- category

Insert into category
Expand Down
24 changes: 24 additions & 0 deletions src/test/resources/pg/postgres-sakila-data.sql
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,30 @@ Insert into actor
Values
('4','JENNIFER','DAVIS','2006-02-15 04:34:33.000');


-- director

Insert into director
(director_id,first_name,last_name,last_update)
Values
('1','Michael','Tam','2006-02-15 04:34:33.000');

Insert into director
(director_id,first_name,last_name,last_update)
Values
('2','Paul','Anderson','2006-02-15 04:34:33.000');

Insert into director
(director_id,first_name,last_name,last_update)
Values
('3','Alex','Chase','2006-02-15 04:34:33.000');

Insert into director
(director_id,first_name,last_name,last_update)
Values
('4','Karol','Davis','2006-02-15 04:34:33.000');


-- category

Insert into category
Expand Down
Loading