1
0

test deep patch into properties and fix typing while patching array properties (#99)

Co-authored-by: Michael Hoennig <michael@hoennig.de>
Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/99
Reviewed-by: Marc Sandlus <marc.sandlus@hostsharing.net>
This commit is contained in:
Michael Hoennig
2024-09-11 18:16:50 +02:00
parent 13f258fb90
commit b1ab1afbb6
6 changed files with 534 additions and 13 deletions

View File

@@ -1,20 +1,26 @@
package net.hostsharing.hsadminng.hs.hosting.asset;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import lombok.SneakyThrows;
import net.hostsharing.hsadminng.config.JsonObjectMapperConfiguration;
import net.hostsharing.hsadminng.context.Context;
import net.hostsharing.hsadminng.hs.booking.item.HsBookingItemRealRepository;
import net.hostsharing.hsadminng.mapper.Array;
import net.hostsharing.hsadminng.mapper.Mapper;
import net.hostsharing.hsadminng.persistence.EntityManagerWrapper;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Import;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
@@ -24,8 +30,11 @@ import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import jakarta.persistence.EntityManager;
import jakarta.persistence.EntityManagerFactory;
import jakarta.persistence.SynchronizationType;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import static java.util.Map.entry;
import static net.hostsharing.hsadminng.hs.booking.item.TestHsBookingItem.CLOUD_SERVER_BOOKING_ITEM_REAL_ENTITY;
@@ -36,12 +45,14 @@ import static net.hostsharing.hsadminng.hs.office.contact.HsOfficeContactRealTes
import static net.hostsharing.hsadminng.rbac.test.JsonMatcher.lenientlyEquals;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@WebMvcTest(HsHostingAssetController.class)
@Import(Mapper.class)
@Import({Mapper.class, JsonObjectMapperConfiguration.class})
@RunWith(SpringRunner.class)
public class HsHostingAssetControllerRestTest {
@@ -54,8 +65,8 @@ public class HsHostingAssetControllerRestTest {
@Autowired
Mapper mapper;
@Mock
private EntityManager em;
@MockBean
private EntityManagerWrapper em;
@MockBean
EntityManagerFactory emf;
@@ -70,6 +81,15 @@ public class HsHostingAssetControllerRestTest {
@MockBean
private HsHostingAssetRbacRepository rbacAssetRepo;
@TestConfiguration
public static class TestConfig {
@Bean
public EntityManager entityManager() {
return mock(EntityManager.class);
}
}
enum ListTestCases {
CLOUD_SERVER(
List.of(
@@ -584,4 +604,129 @@ public class HsHostingAssetControllerRestTest {
assertThat(resultBody.get(n).path("config")).isEqualTo(testCase.expectedConfig(n));
}
}
@Test
void shouldPatchAsset() throws Exception {
// given
final var givenDomainSetup = HsHostingAssetRealEntity.builder()
.type(HsHostingAssetType.DOMAIN_SETUP)
.identifier("example.org")
.caption("some fake Domain-Setup")
.build();
final var givenUnixUser = HsHostingAssetRealEntity.builder()
.type(HsHostingAssetType.UNIX_USER)
.parentAsset(MANAGED_WEBSPACE_HOSTING_ASSET_REAL_TEST_ENTITY)
.identifier("xyz00-office")
.caption("some fake Unix-User")
.config(Map.ofEntries(
entry("password", "$6$salt$hashed-salted-password"),
entry("totpKey", "0x0123456789abcdef"),
entry("shell", "/bin/bash"),
entry("SSD-soft-quota", 128),
entry("SSD-hard-quota", 256),
entry("HDD-soft-quota", 256),
entry("HDD-hard-quota", 512)))
.build();
final var givenDomainHttpSetupUuid = UUID.randomUUID();
final var givenDomainHttpSetupHostingAsset = HsHostingAssetRbacEntity.builder()
.type(HsHostingAssetType.DOMAIN_HTTP_SETUP)
.identifier("example.org|HTTP")
.caption("some fake Domain-HTTP-Setup")
.parentAsset(givenDomainSetup)
.assignedToAsset(givenUnixUser)
.config(new HashMap<>(Map.ofEntries(
entry("htdocsfallback", false),
entry("indexes", false),
entry("cgi", false),
entry("passenger", false),
entry("passenger-errorpage", true),
entry("fastcgi", false),
entry("autoconfig", false),
entry("greylisting", false),
entry("includes", false),
entry("letsencrypt", false),
entry("multiviews", false),
entry("fcgi-php-bin", "/usr/lib/cgi-bin/php-orig"),
entry("passenger-nodejs", "/usr/bin/node-js7"),
entry("passenger-python", "/usr/bin/python6"),
entry("passenger-ruby", "/usr/bin/ruby5"),
entry("subdomains", Array.of("www", "test1", "test2"))
)))
.build();
when(rbacAssetRepo.findByUuid(givenDomainHttpSetupUuid)).thenReturn(Optional.of(givenDomainHttpSetupHostingAsset));
when(em.contains(givenDomainHttpSetupHostingAsset)).thenReturn(true);
doNothing().when(em).flush();
// when
final var result = mockMvc.perform(MockMvcRequestBuilders
.patch("/api/hs/hosting/assets/" + givenDomainHttpSetupUuid)
.header("current-user", "superuser-alex@hostsharing.net")
.contentType(MediaType.APPLICATION_JSON)
.content("""
{
"type": "DOMAIN_HTTP_SETUP",
"identifier": "updated example.org|HTTP",
"caption": "some updated fake Domain-HTTP-Setup",
"alarmContact": null,
"config": {
"autoconfig": true,
"multiviews": true,
"passenger": false,
"fcgi-php-bin": null,
"passenger-nodejs": "/usr/bin/node-js8",
"subdomains": ["www","test"]
}
}
""")
.accept(MediaType.APPLICATION_JSON))
// then
.andExpect(status().is2xxSuccessful())
.andExpect(jsonPath("$", lenientlyEquals("""
{
"type": "DOMAIN_HTTP_SETUP",
"identifier": "example.org|HTTP",
"caption": "some updated fake Domain-HTTP-Setup",
"alarmContact": null
}
""")))
.andReturn();
// and the config properties do match not just leniently but even strictly
final var actualConfig = formatJsonNode(result.getResponse().getContentAsString());
final var expectedConfig = formatJsonNode("""
{
"config": {
"autoconfig" : true,
"cgi" : false,
"fastcgi" : false,
// "fcgi-php-bin" : "/usr/lib/cgi-bin/php", TODO.spec: do we want defaults to work like initializers?
"greylisting" : false,
"htdocsfallback" : false,
"includes" : false,
"indexes" : false,
"letsencrypt" : false,
"multiviews" : true,
"passenger" : false,
"passenger-errorpage" : true,
"passenger-nodejs" : "/usr/bin/node-js8",
"passenger-python" : "/usr/bin/python6",
"passenger-ruby" : "/usr/bin/ruby5",
"subdomains" : [ "www", "test" ]
}
}
""");
assertThat(actualConfig).isEqualTo(expectedConfig);
}
private static final ObjectMapper SORTED_MAPPER = new ObjectMapper();
static {
SORTED_MAPPER.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true);
}
private static String formatJsonNode(final String json) throws JsonProcessingException {
final var node = SORTED_MAPPER.readTree(json.replaceAll("//.*", "")).path("config");
final var obj = SORTED_MAPPER.treeToValue(node, Object.class);
return SORTED_MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(obj);
}
}

View File

@@ -0,0 +1,61 @@
package net.hostsharing.hsadminng.persistence;
import net.hostsharing.hsadminng.mapper.Array;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import jakarta.persistence.EntityManager;
import java.lang.reflect.Method;
import java.util.Arrays;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
class EntityManagerWrapperUnitTest {
private EntityManagerWrapper wrapper;
private EntityManager delegateMock;
@BeforeEach
public void setUp() {
delegateMock = mock(EntityManager.class);
wrapper = new EntityManagerWrapper(delegateMock);
}
@Test
public void testAllMethodsAreForwarded() throws Exception {
final var methods = EntityManager.class.getMethods();
for (Method method : methods) {
// given prepared dummy arguments (if any)
final var args = Arrays.stream(method.getParameterTypes())
.map(this::getDefaultValue)
.toArray();
// when
method.invoke(wrapper, args);
// then verify that the same method was called on the mock delegate
Mockito.verify(delegateMock, times(1)).getClass()
.getMethod(method.getName(), method.getParameterTypes())
.invoke(delegateMock, args);
}
}
private Object getDefaultValue(Class<?> type) {
if (type == boolean.class) return false;
if (type == byte.class) return (byte) 0;
if (type == short.class) return (short) 0;
if (type == int.class) return 0;
if (type == long.class) return 0L;
if (type == float.class) return 0.0f;
if (type == double.class) return 0.0;
if (type == char.class) return '\0';
if (type == String.class) return "dummy";
if (type == String[].class) return Array.of("dummy");
if (type == Class.class) return String.class;
if (type == Class[].class) return Array.of(String.class);
return mock(type);
}
}