/** * Copyright © 2016-2026 The Thingsboard Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.thingsboard.server.controller; import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.databind.JsonNode; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.ListeningExecutorService; import io.jsonwebtoken.Claims; import io.jsonwebtoken.Jws; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.RandomStringUtils; import org.awaitility.Awaitility; import org.hamcrest.Matcher; import org.hibernate.exception.ConstraintViolationException; import org.junit.After; import org.junit.Assert; import org.junit.Before; import org.junit.Rule; import org.junit.rules.TestRule; import org.junit.rules.TestWatcher; import org.junit.runner.Description; import org.mockito.Mockito; import org.mockito.invocation.InvocationOnMock; import org.mockito.stubbing.Answer; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.cache.Cache; import org.springframework.cache.CacheManager; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpMethod; import org.springframework.http.MediaType; import org.springframework.http.converter.HttpMessageConverter; import org.springframework.http.converter.StringHttpMessageConverter; import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.mock.http.MockHttpInputMessage; import org.springframework.mock.http.MockHttpOutputMessage; import org.springframework.mock.web.MockMultipartFile; import org.springframework.mock.web.MockPart; import org.springframework.test.context.bean.override.mockito.MockitoBean; import org.springframework.test.context.bean.override.mockito.MockitoSpyBean; import org.springframework.test.util.ReflectionTestUtils; import org.springframework.test.web.servlet.MockMvc; import org.springframework.test.web.servlet.MvcResult; import org.springframework.test.web.servlet.ResultActions; import org.springframework.test.web.servlet.ResultMatcher; import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder; import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; import org.springframework.test.web.servlet.result.MockMvcResultHandlers; import org.springframework.util.LinkedMultiValueMap; import org.springframework.util.MultiValueMap; import org.springframework.web.context.WebApplicationContext; import org.thingsboard.common.util.JacksonUtil; import org.thingsboard.rule.engine.api.MailService; import org.thingsboard.server.actors.DefaultTbActorSystem; import org.thingsboard.server.actors.TbActorId; import org.thingsboard.server.actors.TbActorMailbox; import org.thingsboard.server.actors.TbCalculatedFieldEntityActorId; import org.thingsboard.server.actors.TbEntityActorId; import org.thingsboard.server.actors.calculatedField.CalculatedFieldEntityActor; import org.thingsboard.server.actors.calculatedField.CalculatedFieldEntityMessageProcessor; import org.thingsboard.server.actors.device.DeviceActor; import org.thingsboard.server.actors.device.DeviceActorMessageProcessor; import org.thingsboard.server.actors.device.SessionInfo; import org.thingsboard.server.actors.device.ToDeviceRpcRequestMetadata; import org.thingsboard.server.actors.service.DefaultActorService; import org.thingsboard.server.common.data.AttributeScope; import org.thingsboard.server.common.data.Customer; import org.thingsboard.server.common.data.DataConstants; import org.thingsboard.server.common.data.Device; import org.thingsboard.server.common.data.DeviceProfile; import org.thingsboard.server.common.data.DeviceProfileType; import org.thingsboard.server.common.data.DeviceTransportType; import org.thingsboard.server.common.data.EntityType; import org.thingsboard.server.common.data.EventInfo; import org.thingsboard.server.common.data.SaveDeviceWithCredentialsRequest; import org.thingsboard.server.common.data.StringUtils; import org.thingsboard.server.common.data.TbResourceInfo; import org.thingsboard.server.common.data.Tenant; import org.thingsboard.server.common.data.TenantProfile; import org.thingsboard.server.common.data.User; import org.thingsboard.server.common.data.asset.AssetProfile; import org.thingsboard.server.common.data.cf.AlarmRuleDefinition; import org.thingsboard.server.common.data.cf.CalculatedField; import org.thingsboard.server.common.data.cf.CalculatedFieldInfo; import org.thingsboard.server.common.data.cf.CalculatedFieldType; import org.thingsboard.server.common.data.device.data.DefaultDeviceConfiguration; import org.thingsboard.server.common.data.device.data.DefaultDeviceTransportConfiguration; import org.thingsboard.server.common.data.device.data.DeviceData; import org.thingsboard.server.common.data.device.profile.DefaultDeviceProfileConfiguration; import org.thingsboard.server.common.data.device.profile.DefaultDeviceProfileTransportConfiguration; import org.thingsboard.server.common.data.device.profile.DeviceProfileData; import org.thingsboard.server.common.data.device.profile.DeviceProfileTransportConfiguration; import org.thingsboard.server.common.data.device.profile.MqttDeviceProfileTransportConfiguration; import org.thingsboard.server.common.data.device.profile.MqttTopics; import org.thingsboard.server.common.data.device.profile.ProtoTransportPayloadConfiguration; import org.thingsboard.server.common.data.device.profile.TransportPayloadTypeConfiguration; import org.thingsboard.server.common.data.edge.Edge; import org.thingsboard.server.common.data.event.EventType; import org.thingsboard.server.common.data.exception.ThingsboardException; import org.thingsboard.server.common.data.id.CalculatedFieldId; import org.thingsboard.server.common.data.id.CustomerId; import org.thingsboard.server.common.data.id.DeviceId; import org.thingsboard.server.common.data.id.EntityId; import org.thingsboard.server.common.data.id.HasId; import org.thingsboard.server.common.data.id.JobId; import org.thingsboard.server.common.data.id.TenantId; import org.thingsboard.server.common.data.id.TenantProfileId; import org.thingsboard.server.common.data.id.UUIDBased; import org.thingsboard.server.common.data.id.UserId; import org.thingsboard.server.common.data.job.Job; import org.thingsboard.server.common.data.job.JobType; import org.thingsboard.server.common.data.kv.KvEntry; import org.thingsboard.server.common.data.kv.TsKvEntry; import org.thingsboard.server.common.data.notification.Notification; import org.thingsboard.server.common.data.notification.NotificationDeliveryMethod; import org.thingsboard.server.common.data.notification.NotificationType; import org.thingsboard.server.common.data.notification.targets.NotificationTarget; import org.thingsboard.server.common.data.notification.targets.platform.PlatformUsersNotificationTargetConfig; import org.thingsboard.server.common.data.notification.targets.platform.UserListFilter; import org.thingsboard.server.common.data.notification.targets.platform.UsersFilter; import org.thingsboard.server.common.data.notification.template.DeliveryMethodNotificationTemplate; import org.thingsboard.server.common.data.notification.template.EmailDeliveryMethodNotificationTemplate; import org.thingsboard.server.common.data.notification.template.HasSubject; import org.thingsboard.server.common.data.notification.template.MobileAppDeliveryMethodNotificationTemplate; import org.thingsboard.server.common.data.notification.template.NotificationTemplate; import org.thingsboard.server.common.data.notification.template.NotificationTemplateConfig; import org.thingsboard.server.common.data.notification.template.SmsDeliveryMethodNotificationTemplate; import org.thingsboard.server.common.data.notification.template.WebDeliveryMethodNotificationTemplate; import org.thingsboard.server.common.data.oauth2.MapperType; import org.thingsboard.server.common.data.oauth2.OAuth2Client; import org.thingsboard.server.common.data.oauth2.OAuth2CustomMapperConfig; import org.thingsboard.server.common.data.oauth2.OAuth2MapperConfig; import org.thingsboard.server.common.data.oauth2.PlatformType; import org.thingsboard.server.common.data.page.PageData; import org.thingsboard.server.common.data.page.PageLink; import org.thingsboard.server.common.data.page.SortOrder; import org.thingsboard.server.common.data.page.TimePageLink; import org.thingsboard.server.common.data.relation.EntityRelation; import org.thingsboard.server.common.data.security.Authority; import org.thingsboard.server.common.data.security.DeviceCredentials; import org.thingsboard.server.common.data.security.DeviceCredentialsType; import org.thingsboard.server.common.data.security.model.JwtPair; import org.thingsboard.server.common.data.tenant.profile.DefaultTenantProfileConfiguration; import org.thingsboard.server.common.data.tenant.profile.TenantProfileData; import org.thingsboard.server.common.msg.session.FeatureType; import org.thingsboard.server.config.ThingsboardSecurityConfiguration; import org.thingsboard.server.dao.Dao; import org.thingsboard.server.dao.DaoUtil; import org.thingsboard.server.dao.attributes.AttributesService; import org.thingsboard.server.dao.device.ClaimDevicesService; import org.thingsboard.server.dao.tenant.TenantProfileService; import org.thingsboard.server.dao.timeseries.TimeseriesService; import org.thingsboard.server.queue.memory.InMemoryStorage; import org.thingsboard.server.service.cf.CfRocksDb; import org.thingsboard.server.service.cf.ctx.state.CalculatedFieldState; import org.thingsboard.server.service.cf.ctx.state.geofencing.GeofencingCalculatedFieldState; import org.thingsboard.server.service.entitiy.tenant.profile.TbTenantProfileService; import org.thingsboard.server.service.security.auth.jwt.RefreshTokenRequest; import org.thingsboard.server.service.security.auth.rest.LoginRequest; import org.thingsboard.server.service.security.model.token.JwtTokenFactory; import org.thingsboard.server.service.system.SystemPatchApplier; import java.io.IOException; import java.nio.charset.StandardCharsets; import java.sql.SQLException; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.Comparator; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.UUID; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.TimeUnit; import java.util.function.Consumer; import java.util.stream.Collectors; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyLong; import static org.mockito.ArgumentMatchers.anyString; import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.asyncDispatch; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.request; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; import static org.springframework.test.web.servlet.setup.MockMvcBuilders.webAppContextSetup; import static org.thingsboard.server.common.data.CacheConstants.CLAIM_DEVICES_CACHE; import static org.thingsboard.server.config.ThingsboardSecurityConfiguration.API_KEY_HEADER_PREFIX; import static org.thingsboard.server.config.ThingsboardSecurityConfiguration.BEARER_HEADER_PREFIX; @Slf4j public abstract class AbstractWebTest extends AbstractInMemoryStorageTest { public static final int TIMEOUT = 30; protected static final String TEST_TENANT_NAME = "TEST TENANT"; protected static final String TEST_DIFFERENT_TENANT_NAME = "TEST DIFFERENT TENANT"; protected static final String SYS_ADMIN_EMAIL = "sysadmin@thingsboard.org"; protected static final String SYS_ADMIN_PASSWORD = "sysadmin"; protected static final String TENANT_ADMIN_EMAIL = "testtenant@thingsboard.org"; protected static final String TENANT_ADMIN_PASSWORD = "tenant"; protected static final String DIFFERENT_TENANT_ADMIN_EMAIL = "testdifftenant@thingsboard.org"; protected static final String DIFFERENT_TENANT_ADMIN_PASSWORD = "difftenant"; protected static final String CUSTOMER_USER_EMAIL = "testcustomer@thingsboard.org"; protected static final String SECOND_CUSTOMER_USER_EMAIL = "testsecondcustomer@thingsboard.org"; private static final String CUSTOMER_USER_PASSWORD = "customer"; protected static final String DIFFERENT_CUSTOMER_USER_EMAIL = "testdifferentcustomer@thingsboard.org"; protected static final String DIFFERENT_TENANT_CUSTOMER_USER_EMAIL = "testdifferenttenantcustomer@thingsboard.org"; private static final String DIFFERENT_CUSTOMER_USER_PASSWORD = "diffcustomer"; /** * See {@link org.springframework.test.web.servlet.DefaultMvcResult#getAsyncResult(long)} * and {@link org.springframework.mock.web.MockAsyncContext#getTimeout()} */ private static final long DEFAULT_TIMEOUT = -1L; private static final int CLEANUP_TENANT_RETRIES_COUNT = 3; protected MediaType contentType = MediaType.APPLICATION_JSON; protected MockMvc mockMvc; protected String currentActivateToken; protected String currentResetPasswordToken; protected String token; protected String refreshToken; protected String mobileToken; protected String username; protected String apiKey; protected TenantId tenantId; protected TenantProfileId tenantProfileId; protected UserId tenantAdminUserId; protected User tenantAdminUser; protected CustomerId tenantAdminCustomerId; protected CustomerId customerId; protected TenantId differentTenantId; protected CustomerId differentCustomerId; protected CustomerId differentTenantCustomerId; protected UserId customerUserId; protected UserId secondCustomerUserId; protected UserId differentCustomerUserId; protected UserId differentTenantCustomerUserId; protected UserId currentUserId; @SuppressWarnings("rawtypes") private HttpMessageConverter mappingJackson2HttpMessageConverter; @SuppressWarnings("rawtypes") private HttpMessageConverter stringHttpMessageConverter; @Autowired private WebApplicationContext webApplicationContext; @Autowired private TenantProfileService tenantProfileService; @Autowired private TbTenantProfileService tbTenantProfileService; @Autowired protected TimeseriesService tsService; @Autowired protected AttributesService attributesService; @Autowired protected DefaultActorService actorService; @Autowired protected ClaimDevicesService claimDevicesService; @Autowired private JwtTokenFactory jwtTokenFactory; @Autowired protected InMemoryStorage storage; @Autowired protected JdbcTemplate jdbcTemplate; @MockitoSpyBean protected MailService mailService; @MockitoBean protected CfRocksDb cfRocksDb; @MockitoBean protected SystemPatchApplier systemPatchApplier; @Rule public TestRule watcher = new TestWatcher() { protected void starting(Description description) { log.info("Starting test: {}", description.getMethodName()); } protected void finished(Description description) { log.info("Finished test: {}", description.getMethodName()); } }; @Autowired void setConverters(HttpMessageConverter[] converters) { this.mappingJackson2HttpMessageConverter = Arrays.stream(converters) .filter(hmc -> hmc instanceof MappingJackson2HttpMessageConverter) .findAny() .get(); this.stringHttpMessageConverter = Arrays.stream(converters) .filter(hmc -> hmc instanceof StringHttpMessageConverter) .findAny() .get(); Assert.assertNotNull("the JSON message converter must not be null", this.mappingJackson2HttpMessageConverter); } @Before public void setupWebTest() throws Exception { log.debug("Executing web test setup"); setupMailServiceMock(); if (this.mockMvc == null) { this.mockMvc = webAppContextSetup(webApplicationContext) .apply(springSecurity()) // conditional printing of non 2xx responses .alwaysDo(result -> { if (result.getResponse().getStatus() >= 400) { MockMvcResultHandlers.log().handle(result); } }) .build(); } loginSysAdmin(); Tenant tenant = new Tenant(); tenant.setTitle(TEST_TENANT_NAME); Tenant savedTenant = saveTenant(tenant); Assert.assertNotNull(savedTenant); tenantId = savedTenant.getId(); tenantProfileId = savedTenant.getTenantProfileId(); tenantAdminUser = new User(); tenantAdminUser.setAuthority(Authority.TENANT_ADMIN); tenantAdminUser.setTenantId(tenantId); tenantAdminUser.setEmail(TENANT_ADMIN_EMAIL); tenantAdminUser = createUserAndLogin(tenantAdminUser, TENANT_ADMIN_PASSWORD); tenantAdminUserId = tenantAdminUser.getId(); tenantAdminCustomerId = tenantAdminUser.getCustomerId(); Customer customer = new Customer(); customer.setTitle("Customer"); customer.setTenantId(tenantId); Customer savedCustomer = doPost("/api/customer", customer, Customer.class); customerId = savedCustomer.getId(); User customerUser = new User(); customerUser.setAuthority(Authority.CUSTOMER_USER); customerUser.setTenantId(tenantId); customerUser.setCustomerId(savedCustomer.getId()); customerUser.setEmail(CUSTOMER_USER_EMAIL); customerUser = createUserAndActivate(customerUser, CUSTOMER_USER_PASSWORD); customerUserId = customerUser.getId(); User secondCustomerUser = new User(); secondCustomerUser.setAuthority(Authority.CUSTOMER_USER); secondCustomerUser.setTenantId(tenantId); secondCustomerUser.setCustomerId(customerId); secondCustomerUser.setEmail(SECOND_CUSTOMER_USER_EMAIL); secondCustomerUser = createUserAndActivate(secondCustomerUser, CUSTOMER_USER_PASSWORD); secondCustomerUserId = secondCustomerUser.getId(); resetTokens(); log.debug("Executed web test setup"); } private void setupMailServiceMock() throws ThingsboardException { Mockito.doNothing().when(mailService).sendAccountActivatedEmail(anyString(), anyString()); Mockito.doAnswer(new Answer() { public Void answer(InvocationOnMock invocation) { Object[] args = invocation.getArguments(); String activationLink = (String) args[0]; currentActivateToken = activationLink.split("=")[1]; return null; } }).when(mailService).sendActivationEmail(anyString(), anyLong(), anyString()); Mockito.doAnswer(new Answer() { public Void answer(InvocationOnMock invocation) { Object[] args = invocation.getArguments(); String passwordResetLink = (String) args[0]; currentResetPasswordToken = passwordResetLink.split("=")[1]; return null; } }).when(mailService).sendResetPasswordEmailAsync(anyString(), anyLong(), anyString()); } @After public void teardownWebTest() throws Exception { log.debug("Executing web test teardown"); // Drain any pending housekeeper work left by the test body (e.g., bulk tenant deletes) // before proceeding with teardown deletions, to avoid 90s per-tenant wait timing out. awaitHousekeeperDrained(); loginSysAdmin(); deleteTenant(tenantId); deleteDifferentTenant(); verifyNoTenantsLeft(); tenantProfileService.deleteTenantProfiles(TenantId.SYS_TENANT_ID); jdbcTemplate.execute("TRUNCATE TABLE notification"); jdbcTemplate.execute("TRUNCATE TABLE audit_log"); log.debug("Executed web test teardown"); } private void verifyNoTenantsLeft() throws Exception { List loadedTenants = getAllTenants(); if (!loadedTenants.isEmpty()) { loadedTenants.forEach(tenant -> deleteTenant(tenant.getId())); loadedTenants = getAllTenants(); } assertThat(loadedTenants).as("All tenants expected to be deleted, but some tenants left in the database").isEmpty(); } protected void deleteTenant(TenantId tenantId) { try { doDelete("/api/tenant/" + tenantId.getId()).andExpect(status().isOk()); } catch (Exception e) { throw new RuntimeException(e); } Awaitility.await("all tasks processed").atMost(90, TimeUnit.SECONDS).during(300, TimeUnit.MILLISECONDS) .until(() -> storage.getLag("tb_housekeeper") == 0); } protected void awaitHousekeeperDrained() { Awaitility.await("housekeeper drained").atMost(5, TimeUnit.MINUTES).during(300, TimeUnit.MILLISECONDS) .until(() -> storage.getLag("tb_housekeeper") == 0); } private List getAllTenants() throws Exception { List loadedTenants = new ArrayList<>(); PageLink pageLink = new PageLink(10); PageData pageData; do { pageData = doGetTypedWithPageLink("/api/tenants?", new TypeReference>() { }, pageLink); loadedTenants.addAll(pageData.getData()); if (pageData.hasNext()) { pageLink = pageLink.nextPageLink(); } } while (pageData.hasNext()); return loadedTenants; } protected void loginSysAdmin() throws Exception { login(SYS_ADMIN_EMAIL, SYS_ADMIN_PASSWORD); } protected void loginTenantAdmin() throws Exception { login(TENANT_ADMIN_EMAIL, TENANT_ADMIN_PASSWORD); } protected void loginCustomerUser() throws Exception { login(CUSTOMER_USER_EMAIL, CUSTOMER_USER_PASSWORD); } protected void loginSecondCustomerUser() throws Exception { login(SECOND_CUSTOMER_USER_EMAIL, CUSTOMER_USER_PASSWORD); } protected void loginUser(String userName, String password) throws Exception { login(userName, password); } protected Tenant savedDifferentTenant; protected User savedDifferentTenantUser; private Customer savedDifferentCustomer; private Customer savedDifferentTenantCustomer; protected User differentCustomerUser; protected User differentTenantCustomerUser; protected void loginDifferentTenant() throws Exception { if (savedDifferentTenant != null) { login(DIFFERENT_TENANT_ADMIN_EMAIL, DIFFERENT_TENANT_ADMIN_PASSWORD); } else { createDifferentTenant(); } } protected void createDifferentTenant() throws Exception { loginSysAdmin(); Tenant tenant = new Tenant(); tenant.setTitle(TEST_DIFFERENT_TENANT_NAME); savedDifferentTenant = saveTenant(tenant); differentTenantId = savedDifferentTenant.getId(); Assert.assertNotNull(savedDifferentTenant); User differentTenantAdmin = new User(); differentTenantAdmin.setAuthority(Authority.TENANT_ADMIN); differentTenantAdmin.setTenantId(savedDifferentTenant.getId()); differentTenantAdmin.setEmail(DIFFERENT_TENANT_ADMIN_EMAIL); savedDifferentTenantUser = createUserAndLogin(differentTenantAdmin, DIFFERENT_TENANT_ADMIN_PASSWORD); } protected Tenant saveTenant(Tenant tenant) throws Exception { return doPost("/api/tenant", tenant, Tenant.class); } protected void loginDifferentCustomer() throws Exception { if (savedDifferentCustomer != null) { login(savedDifferentCustomer.getEmail(), CUSTOMER_USER_PASSWORD); } else { createDifferentCustomer(); loginTenantAdmin(); differentCustomerUser = new User(); differentCustomerUser.setAuthority(Authority.CUSTOMER_USER); differentCustomerUser.setTenantId(tenantId); differentCustomerUser.setCustomerId(savedDifferentCustomer.getId()); differentCustomerUser.setEmail(DIFFERENT_CUSTOMER_USER_EMAIL); differentCustomerUser = createUserAndLogin(differentCustomerUser, DIFFERENT_CUSTOMER_USER_PASSWORD); differentCustomerUserId = differentCustomerUser.getId(); } } protected void loginDifferentTenantCustomer() throws Exception { if (savedDifferentTenantCustomer != null) { login(savedDifferentTenantCustomer.getEmail(), CUSTOMER_USER_PASSWORD); } else { createDifferentTenantCustomer(); loginDifferentTenant(); differentTenantCustomerUser = new User(); differentTenantCustomerUser.setAuthority(Authority.CUSTOMER_USER); differentTenantCustomerUser.setTenantId(savedDifferentTenantCustomer.getTenantId()); differentTenantCustomerUser.setCustomerId(savedDifferentTenantCustomer.getId()); differentTenantCustomerUser.setEmail(DIFFERENT_TENANT_CUSTOMER_USER_EMAIL); differentTenantCustomerUser = createUserAndLogin(differentTenantCustomerUser, DIFFERENT_CUSTOMER_USER_PASSWORD); differentTenantCustomerUserId = differentTenantCustomerUser.getId(); } } protected void createDifferentCustomer() throws Exception { loginTenantAdmin(); Customer customer = new Customer(); customer.setTitle("Different customer"); savedDifferentCustomer = doPost("/api/customer", customer, Customer.class); Assert.assertNotNull(savedDifferentCustomer); differentCustomerId = savedDifferentCustomer.getId(); resetTokens(); } protected void createDifferentTenantCustomer() throws Exception { loginDifferentTenant(); Customer customer = new Customer(); customer.setTitle("Different tenant customer"); savedDifferentTenantCustomer = doPost("/api/customer", customer, Customer.class); Assert.assertNotNull(savedDifferentTenantCustomer); differentTenantCustomerId = savedDifferentTenantCustomer.getId(); resetTokens(); } protected void deleteDifferentTenant() throws Exception { if (savedDifferentTenant != null) { loginSysAdmin(); deleteTenant(savedDifferentTenant.getId()); savedDifferentTenant = null; } } protected User createUserAndLogin(User user, String password) throws Exception { User savedUser = doPost("/api/user", user, User.class); resetTokens(); JsonNode activateRequest = getActivateRequest(password); JsonNode tokenInfo = readResponse(doPost("/api/noauth/activate", activateRequest).andExpect(status().isOk()), JsonNode.class); validateAndSetJwtToken(tokenInfo, user.getEmail()); return savedUser; } protected User createUserAndActivate(User user, String password) throws Exception { User savedUser = doPost("/api/user", user, User.class); JsonNode activateRequest = getActivateRequest(password); doPost("/api/noauth/activate", activateRequest).andExpect(status().isOk()); return savedUser; } protected User createUser(User user, String password) throws Exception { User savedUser = doPost("/api/user", user, User.class); JsonNode activateRequest = getActivateRequest(password); ResultActions resultActions = doPost("/api/noauth/activate", activateRequest); resultActions.andExpect(status().isOk()); return doGet("/api/user/" + savedUser.getId(), User.class); } private JsonNode getActivateRequest(String password) throws Exception { doGet("/api/noauth/activate?activateToken={activateToken}", this.currentActivateToken) .andExpect(status().isSeeOther()) .andExpect(header().string(HttpHeaders.LOCATION, "/login/createPassword?activateToken=" + this.currentActivateToken)); return JacksonUtil.newObjectNode() .put("activateToken", this.currentActivateToken) .put("password", password); } protected void login(String username, String password) throws Exception { resetTokens(); JsonNode tokenInfo = readResponse(doPost("/api/auth/login", new LoginRequest(username, password)).andExpect(status().isOk()), JsonNode.class); validateAndSetJwtToken(tokenInfo, username); } protected void refreshToken() throws Exception { this.token = null; JsonNode tokenInfo = readResponse(doPost("/api/auth/token", new RefreshTokenRequest(this.refreshToken)).andExpect(status().isOk()), JsonNode.class); validateAndSetJwtToken(tokenInfo, this.username); } protected void validateAndSetJwtToken(JsonNode tokenInfo, String username) { Assert.assertNotNull(tokenInfo); Assert.assertTrue(tokenInfo.has("token")); Assert.assertTrue(tokenInfo.has("refreshToken")); validateAndSetJwtToken(JacksonUtil.treeToValue(tokenInfo, JwtPair.class), username); } protected void validateAndSetJwtToken(JwtPair jwtPair, String username) { Assert.assertNotNull(jwtPair); String token = jwtPair.getToken(); String refreshToken = jwtPair.getRefreshToken(); validateJwtToken(token, username); validateJwtToken(refreshToken, username); this.token = token; this.refreshToken = refreshToken; this.username = username; } protected void validateJwtToken(String token, String username) { Jws jwsClaims = jwtTokenFactory.parseTokenClaims(token); Claims claims = jwsClaims.getPayload(); String subject = claims.getSubject(); Assert.assertEquals(username, subject); String userId = claims.get("userId", String.class); this.currentUserId = UserId.fromString(userId); } protected void resetTokens() throws Exception { this.token = null; this.refreshToken = null; this.username = null; } protected void logout() throws Exception { doPost("/api/auth/logout").andExpect(status().isOk()); } protected void setJwtToken(MockHttpServletRequestBuilder request) { if (this.token != null) { request.header(ThingsboardSecurityConfiguration.AUTHORIZATION_HEADER, BEARER_HEADER_PREFIX + this.token); } if (this.mobileToken != null) { request.header(UserController.MOBILE_TOKEN_HEADER, this.mobileToken); } } protected void resetApiKey() { this.apiKey = null; } protected void setApiKey(String apiKey) { this.apiKey = apiKey; } protected void setApiKey(MockHttpServletRequestBuilder request) { if (this.apiKey != null) { request.header(ThingsboardSecurityConfiguration.AUTHORIZATION_HEADER, API_KEY_HEADER_PREFIX + this.apiKey); } } protected DeviceProfile createDeviceProfile(String name) { return createDeviceProfile(name, null); } protected DeviceProfile createDeviceProfile(String name, DeviceProfileTransportConfiguration deviceProfileTransportConfiguration) { DeviceProfile deviceProfile = new DeviceProfile(); deviceProfile.setName(name); deviceProfile.setType(DeviceProfileType.DEFAULT); deviceProfile.setDescription(name + " Test"); DeviceProfileData deviceProfileData = new DeviceProfileData(); DefaultDeviceProfileConfiguration configuration = new DefaultDeviceProfileConfiguration(); deviceProfileData.setConfiguration(configuration); if (deviceProfileTransportConfiguration != null) { deviceProfile.setTransportType(deviceProfileTransportConfiguration.getType()); deviceProfileData.setTransportConfiguration(deviceProfileTransportConfiguration); } else { deviceProfile.setTransportType(DeviceTransportType.DEFAULT); deviceProfileData.setTransportConfiguration(new DefaultDeviceProfileTransportConfiguration()); } deviceProfile.setProfileData(deviceProfileData); deviceProfile.setDefault(false); deviceProfile.setDefaultRuleChainId(null); return deviceProfile; } protected AssetProfile createAssetProfile(String name) { AssetProfile assetProfile = new AssetProfile(); assetProfile.setName(name); assetProfile.setDescription(name + " Test"); assetProfile.setDefault(false); assetProfile.setDefaultRuleChainId(null); return assetProfile; } protected Device createDevice(String name) throws Exception { return createDevice(name, "default", null, null); } protected Device createDevice(String name, String accessToken) throws Exception { return createDevice(name, "default", null, accessToken); } protected Device createDevice(String name, String type, String label, String accessToken) throws Exception { Device device = new Device(); device.setName(name); device.setType(type); device.setLabel(label); DeviceData deviceData = new DeviceData(); deviceData.setTransportConfiguration(new DefaultDeviceTransportConfiguration()); deviceData.setConfiguration(new DefaultDeviceConfiguration()); device.setDeviceData(deviceData); if (accessToken != null) { return doPost("/api/device?accessToken=" + accessToken, device, Device.class); } else { return doPost("/api/device", device, Device.class); } } protected Device assignDeviceToCustomer(DeviceId deviceId, CustomerId customerId) { String deviceIdStr = String.valueOf(deviceId.getId()); return doPost("/api/customer/" + customerId.getId() + "/device/" + deviceIdStr, Device.class); } protected MqttDeviceProfileTransportConfiguration createMqttDeviceProfileTransportConfiguration(TransportPayloadTypeConfiguration transportPayloadTypeConfiguration, boolean sendAckOnValidationException) { MqttDeviceProfileTransportConfiguration mqttDeviceProfileTransportConfiguration = new MqttDeviceProfileTransportConfiguration(); mqttDeviceProfileTransportConfiguration.setDeviceTelemetryTopic(MqttTopics.DEVICE_TELEMETRY_TOPIC); mqttDeviceProfileTransportConfiguration.setDeviceAttributesTopic(MqttTopics.DEVICE_ATTRIBUTES_TOPIC); mqttDeviceProfileTransportConfiguration.setDeviceAttributesSubscribeTopic(MqttTopics.DEVICE_ATTRIBUTES_TOPIC); mqttDeviceProfileTransportConfiguration.setSendAckOnValidationException(sendAckOnValidationException); mqttDeviceProfileTransportConfiguration.setTransportPayloadTypeConfiguration(transportPayloadTypeConfiguration); return mqttDeviceProfileTransportConfiguration; } protected MqttDeviceProfileTransportConfiguration createMqttDeviceProfileTransportConfiguration(TransportPayloadTypeConfiguration transportPayloadTypeConfiguration, boolean sendAckOnValidationException, String telemetryTopic, String attributesPublishTopic, String attributesSubscribeTopic) { MqttDeviceProfileTransportConfiguration mqttDeviceProfileTransportConfiguration = new MqttDeviceProfileTransportConfiguration(); mqttDeviceProfileTransportConfiguration.setDeviceTelemetryTopic(telemetryTopic); mqttDeviceProfileTransportConfiguration.setDeviceAttributesTopic(attributesPublishTopic); mqttDeviceProfileTransportConfiguration.setDeviceAttributesSubscribeTopic(attributesSubscribeTopic); mqttDeviceProfileTransportConfiguration.setSendAckOnValidationException(sendAckOnValidationException); mqttDeviceProfileTransportConfiguration.setTransportPayloadTypeConfiguration(transportPayloadTypeConfiguration); return mqttDeviceProfileTransportConfiguration; } protected ProtoTransportPayloadConfiguration createProtoTransportPayloadConfiguration(String attributesProtoSchema, String telemetryProtoSchema, String rpcRequestProtoSchema, String rpcResponseProtoSchema) { ProtoTransportPayloadConfiguration protoTransportPayloadConfiguration = new ProtoTransportPayloadConfiguration(); protoTransportPayloadConfiguration.setDeviceAttributesProtoSchema(attributesProtoSchema); protoTransportPayloadConfiguration.setDeviceTelemetryProtoSchema(telemetryProtoSchema); protoTransportPayloadConfiguration.setDeviceRpcRequestProtoSchema(rpcRequestProtoSchema); protoTransportPayloadConfiguration.setDeviceRpcResponseProtoSchema(rpcResponseProtoSchema); return protoTransportPayloadConfiguration; } protected Device createDevice(String deviceName, String type, String accessToken) throws Exception { Device device = new Device(); device.setName(deviceName); device.setType(type); DeviceCredentials credentials = new DeviceCredentials(); credentials.setCredentialsType(DeviceCredentialsType.ACCESS_TOKEN); credentials.setCredentialsId(accessToken); SaveDeviceWithCredentialsRequest request = new SaveDeviceWithCredentialsRequest(device, credentials); return doPost("/api/device-with-credentials", request, Device.class); } protected ResultActions doGetAsync(String urlTemplate, MultiValueMap params) throws Exception { MockHttpServletRequestBuilder getRequest = get(urlTemplate).params(params); setJwtToken(getRequest); return mockMvc.perform(asyncDispatch(mockMvc.perform(getRequest).andExpect(request().asyncStarted()).andReturn())); } protected ResultActions doGet(String urlTemplate, Object... urlVariables) throws Exception { MockHttpServletRequestBuilder getRequest = get(urlTemplate, urlVariables); setJwtToken(getRequest); return mockMvc.perform(getRequest); } protected ResultActions doGet(String urlTemplate, HttpHeaders httpHeaders, Object... urlVariables) throws Exception { MockHttpServletRequestBuilder getRequest = get(urlTemplate, urlVariables); getRequest.headers(httpHeaders); setJwtToken(getRequest); return mockMvc.perform(getRequest); } protected ResultActions doGetWithApiKey(String urlTemplate, Object... urlVariables) throws Exception { MockHttpServletRequestBuilder getRequest = get(urlTemplate, urlVariables); setApiKey(getRequest); return mockMvc.perform(getRequest); } protected T doGet(String urlTemplate, Class responseClass, Object... urlVariables) throws Exception { return readResponse(doGet(urlTemplate, urlVariables).andExpect(status().isOk()), responseClass); } protected T doGet(String urlTemplate, Class responseClass, ResultMatcher resultMatcher, Object... urlVariables) throws Exception { return readResponse(doGet(urlTemplate, urlVariables).andExpect(resultMatcher), responseClass); } protected T doGetAsync(String urlTemplate, Class responseClass, Object... urlVariables) throws Exception { return readResponse(doGetAsync(urlTemplate, urlVariables).andExpect(status().isOk()), responseClass); } protected T doGetAsyncTyped(String urlTemplate, TypeReference responseType, Object... urlVariables) throws Exception { return readResponse(doGetAsync(urlTemplate, urlVariables).andExpect(status().isOk()), responseType); } protected ResultActions doGetAsync(String urlTemplate, Object... urlVariables) throws Exception { MockHttpServletRequestBuilder getRequest; getRequest = get(urlTemplate, urlVariables); setJwtToken(getRequest); return mockMvc.perform(asyncDispatch(mockMvc.perform(getRequest).andExpect(request().asyncStarted()).andReturn())); } protected T doGetWithApiKey(String urlTemplate, Class responseClass, Object... urlVariables) throws Exception { return readResponse(doGetWithApiKey(urlTemplate, urlVariables).andExpect(status().isOk()), responseClass); } protected T doGetTyped(String urlTemplate, TypeReference responseType, Object... urlVariables) throws Exception { return readResponse(doGet(urlTemplate, urlVariables).andExpect(status().isOk()), responseType); } protected T doGetTypedWithPageLink(String urlTemplate, TypeReference responseType, PageLink pageLink, Object... urlVariables) throws Exception { List pageLinkVariables = new ArrayList<>(); urlTemplate += "pageSize={pageSize}&page={page}"; pageLinkVariables.add(pageLink.getPageSize()); pageLinkVariables.add(pageLink.getPage()); if (StringUtils.isNotEmpty(pageLink.getTextSearch())) { urlTemplate += "&textSearch={textSearch}"; pageLinkVariables.add(pageLink.getTextSearch()); } if (pageLink.getSortOrder() != null) { urlTemplate += "&sortProperty={sortProperty}&sortOrder={sortOrder}"; pageLinkVariables.add(pageLink.getSortOrder().getProperty()); pageLinkVariables.add(pageLink.getSortOrder().getDirection().name()); } Object[] vars = new Object[urlVariables.length + pageLinkVariables.size()]; System.arraycopy(urlVariables, 0, vars, 0, urlVariables.length); System.arraycopy(pageLinkVariables.toArray(), 0, vars, urlVariables.length, pageLinkVariables.size()); return readResponse(doGet(urlTemplate, vars).andExpect(status().isOk()), responseType); } protected T doGetTypedWithTimePageLink(String urlTemplate, TypeReference responseType, TimePageLink pageLink, Object... urlVariables) throws Exception { List pageLinkVariables = new ArrayList<>(); urlTemplate += "pageSize={pageSize}&page={page}"; pageLinkVariables.add(pageLink.getPageSize()); pageLinkVariables.add(pageLink.getPage()); if (pageLink.getStartTime() != null) { urlTemplate += "&startTime={startTime}"; pageLinkVariables.add(pageLink.getStartTime()); } if (pageLink.getEndTime() != null) { urlTemplate += "&endTime={endTime}"; pageLinkVariables.add(pageLink.getEndTime()); } if (StringUtils.isNotEmpty(pageLink.getTextSearch())) { urlTemplate += "&textSearch={textSearch}"; pageLinkVariables.add(pageLink.getTextSearch()); } if (pageLink.getSortOrder() != null) { urlTemplate += "&sortProperty={sortProperty}&sortOrder={sortOrder}"; pageLinkVariables.add(pageLink.getSortOrder().getProperty()); pageLinkVariables.add(pageLink.getSortOrder().getDirection().name()); } Object[] vars = new Object[urlVariables.length + pageLinkVariables.size()]; System.arraycopy(urlVariables, 0, vars, 0, urlVariables.length); System.arraycopy(pageLinkVariables.toArray(), 0, vars, urlVariables.length, pageLinkVariables.size()); return readResponse(doGet(urlTemplate, vars).andExpect(status().isOk()), responseType); } protected T doPost(String urlTemplate, Class responseClass, String... params) { try { return readResponse(doPost(urlTemplate, params).andExpect(status().isOk()), responseClass); } catch (Exception e) { throw new RuntimeException(e); } } protected T doPost(String urlTemplate, T content, Class responseClass, ResultMatcher resultMatcher, String... params) throws Exception { return readResponse(doPost(urlTemplate, content, params).andExpect(resultMatcher), responseClass); } protected R doPost(String urlTemplate, T content, Class responseClass, String... params) { try { return readResponse(doPost(urlTemplate, content, params).andExpect(status().isOk()), responseClass); } catch (Exception e) { throw new RuntimeException(e); } } protected R doPostWithApiKey(String urlTemplate, T content, Class responseClass, String... params) { try { return readResponse(doPostWithApiKey(urlTemplate, content, params).andExpect(status().isOk()), responseClass); } catch (Exception e) { throw new RuntimeException(e); } } protected R doPostWithResponse(String urlTemplate, T content, Class responseClass, String... params) throws Exception { return readResponse(doPost(urlTemplate, content, params).andExpect(status().isOk()), responseClass); } protected R doPostWithTypedResponse(String urlTemplate, T content, TypeReference responseType, String... params) throws Exception { return readResponse(doPost(urlTemplate, content, params).andExpect(status().isOk()), responseType); } protected R doPostWithTypedResponse(String urlTemplate, T content, TypeReference responseType, ResultMatcher resultMatcher, String... params) throws Exception { return readResponse(doPost(urlTemplate, content, params).andExpect(resultMatcher), responseType); } protected R doPostAsyncWithTypedResponse(String urlTemplate, T content, TypeReference responseType, ResultMatcher resultMatcher, String... params) throws Exception { return readResponse(doPostAsync(urlTemplate, content, DEFAULT_TIMEOUT, params).andExpect(resultMatcher), responseType); } protected R doPostAsync(String urlTemplate, T content, Class responseClass, ResultMatcher resultMatcher, String... params) throws Exception { return readResponse(doPostAsync(urlTemplate, content, DEFAULT_TIMEOUT, params).andExpect(resultMatcher), responseClass); } protected T doPostAsync(String urlTemplate, T content, Class responseClass, ResultMatcher resultMatcher, Long timeout, String... params) throws Exception { return readResponse(doPostAsync(urlTemplate, content, timeout, params).andExpect(resultMatcher), responseClass); } protected T doPostClaimAsync(String urlTemplate, Object content, Class responseClass, ResultMatcher resultMatcher, String... params) throws Exception { return readResponse(doPostAsync(urlTemplate, content, DEFAULT_TIMEOUT, params).andExpect(resultMatcher), responseClass); } protected T doPut(String urlTemplate, Object content, Class responseClass, String... params) { try { return readResponse(doPut(urlTemplate, content, params).andExpect(status().isOk()), responseClass); } catch (Exception e) { throw new RuntimeException(e); } } protected ResultActions doPut(String urlTemplate, T content, String... params) throws Exception { MockHttpServletRequestBuilder postRequest = put(urlTemplate, params); setJwtToken(postRequest); String json = json(content); postRequest.contentType(contentType).content(json); return mockMvc.perform(postRequest); } protected T doDelete(String urlTemplate, Class responseClass, String... params) throws Exception { return readResponse(doDelete(urlTemplate, params).andExpect(status().isOk()), responseClass); } protected T doDeleteAsync(String urlTemplate, Class responseClass, String... params) throws Exception { return readResponse(doDeleteAsync(urlTemplate, DEFAULT_TIMEOUT, params).andExpect(status().isOk()), responseClass); } protected ResultActions doPost(String urlTemplate, String... params) throws Exception { MockHttpServletRequestBuilder postRequest = post(urlTemplate); setJwtToken(postRequest); populateParams(postRequest, params); return mockMvc.perform(postRequest); } protected ResultActions doPost(String urlTemplate, T content, String... params) throws Exception { MockHttpServletRequestBuilder postRequest = post(urlTemplate, params); setJwtToken(postRequest); String json = json(content); postRequest.contentType(contentType).content(json); return mockMvc.perform(postRequest); } protected ResultActions doPostWithApiKey(String urlTemplate, T content, String... params) throws Exception { MockHttpServletRequestBuilder postRequest = post(urlTemplate, params); setApiKey(postRequest); String json = json(content); postRequest.contentType(contentType).content(json); return mockMvc.perform(postRequest); } protected ResultActions doPostAsync(String urlTemplate, T content, Long timeout, String... params) throws Exception { MockHttpServletRequestBuilder postRequest = post(urlTemplate, params); setJwtToken(postRequest); String json = json(content); postRequest.contentType(contentType).content(json); MvcResult result = mockMvc.perform(postRequest).andReturn(); result.getAsyncResult(timeout); return mockMvc.perform(asyncDispatch(result)); } protected ResultActions doDelete(String urlTemplate, String... params) throws Exception { MockHttpServletRequestBuilder deleteRequest = delete(urlTemplate); setJwtToken(deleteRequest); populateParams(deleteRequest, params); return mockMvc.perform(deleteRequest); } protected ResultActions doDeleteAsync(String urlTemplate, MultiValueMap params) throws Exception { MockHttpServletRequestBuilder deleteRequest = delete(urlTemplate) .params(params); setJwtToken(deleteRequest); MvcResult result = mockMvc.perform(deleteRequest).andReturn(); result.getAsyncResult(DEFAULT_TIMEOUT); return mockMvc.perform(asyncDispatch(result)); } protected ResultActions doDeleteWithApiKey(String urlTemplate, String... params) throws Exception { MockHttpServletRequestBuilder deleteRequest = delete(urlTemplate); setApiKey(deleteRequest); populateParams(deleteRequest, params); return mockMvc.perform(deleteRequest); } protected ResultActions doDeleteAsync(String urlTemplate, Long timeout, String... params) throws Exception { MockHttpServletRequestBuilder deleteRequest = delete(urlTemplate, params); setJwtToken(deleteRequest); // populateParams(deleteRequest, params); MvcResult result = mockMvc.perform(deleteRequest).andReturn(); result.getAsyncResult(timeout); return mockMvc.perform(asyncDispatch(result)); } protected void populateParams(MockHttpServletRequestBuilder request, String... params) { if (params != null && params.length > 0) { Assert.assertEquals(0, params.length % 2); MultiValueMap paramsMap = new LinkedMultiValueMap<>(); for (int i = 0; i < params.length; i += 2) { paramsMap.add(params[i], params[i + 1]); } request.params(paramsMap); } } @SuppressWarnings("unchecked") protected String json(Object o) throws IOException { MockHttpOutputMessage mockHttpOutputMessage = new MockHttpOutputMessage(); HttpMessageConverter converter = o instanceof String ? stringHttpMessageConverter : mappingJackson2HttpMessageConverter; converter.write(o, MediaType.APPLICATION_JSON, mockHttpOutputMessage); return mockHttpOutputMessage.getBodyAsString(); } @SuppressWarnings("unchecked") protected T readResponse(ResultActions result, Class responseClass) throws Exception { byte[] content = result.andReturn().getResponse().getContentAsByteArray(); MockHttpInputMessage mockHttpInputMessage = new MockHttpInputMessage(content); HttpMessageConverter converter = responseClass.equals(String.class) ? stringHttpMessageConverter : mappingJackson2HttpMessageConverter; return (T) converter.read(responseClass, mockHttpInputMessage); } protected T readResponse(ResultActions result, TypeReference type) throws Exception { return readResponse(result.andReturn(), type); } protected T readResponse(MvcResult result, TypeReference type) throws Exception { byte[] content = result.getResponse().getContentAsByteArray(); return JacksonUtil.OBJECT_MAPPER.readerFor(type).readValue(content); } protected String getErrorMessage(ResultActions result) throws Exception { return readResponse(result, JsonNode.class).get("message").asText(); } public class IdComparator implements Comparator { @Override public int compare(D o1, D o2) { return o1.getId().getId().compareTo(o2.getId().getId()); } } public class EntityIdComparator implements Comparator { @Override public int compare(D o1, D o2) { return o1.getId().compareTo(o2.getId()); } } protected static ResultMatcher statusReason(Matcher matcher) { return jsonPath("$.message", matcher); } protected Edge constructEdge(String name, String type) { return constructEdge(tenantId, name, type, StringUtils.randomAlphanumeric(20), StringUtils.randomAlphanumeric(20)); } protected Edge constructEdge(TenantId tenantId, String name, String type, String routingKey, String secret) { Edge edge = new Edge(); edge.setTenantId(tenantId); edge.setName(name); edge.setType(type); edge.setRoutingKey(routingKey); edge.setSecret(secret); return edge; } protected > ListenableFuture> deleteEntitiesAsync(String urlTemplate, List entities, ListeningExecutorService executor) { List> futures = new ArrayList<>(entities.size()); for (T entity : entities) { futures.add(executor.submit(() -> doDelete(urlTemplate + entity.getId().getId()) .andExpect(status().isOk()))); } return Futures.allAsList(futures); } protected void testEntityDaoWithRelationsOk(EntityId entityIdFrom, EntityId entityTo, String urlDelete) throws Exception { createEntityRelation(entityIdFrom, entityTo, "TEST_TYPE"); assertThat(findRelationsByTo(entityTo)).hasSize(1); doDelete(urlDelete).andExpect(status().isOk()); assertThat(findRelationsByTo(entityTo)).hasSize(0); } protected void testEntityDaoWithRelationsTransactionalException(Dao dao, EntityId entityIdFrom, EntityId entityTo, String urlDelete) throws Exception { Mockito.doThrow(new ConstraintViolationException("mock message", new SQLException(), "MOCK_CONSTRAINT")).when(dao).removeById(any(), any()); try { createEntityRelation(entityIdFrom, entityTo, "TEST_TRANSACTIONAL_TYPE"); assertThat(findRelationsByTo(entityTo)).hasSize(1); doDelete(urlDelete) .andExpect(status().isBadRequest()); assertThat(findRelationsByTo(entityTo)).hasSize(1); } finally { Mockito.reset(dao); } } protected void createEntityRelation(EntityId entityIdFrom, EntityId entityIdTo, String typeRelation) throws Exception { EntityRelation relation = new EntityRelation(entityIdFrom, entityIdTo, typeRelation); doPost("/api/relation", relation).andExpect(status().isOk()); } protected void deleteEntityRelation(EntityRelation entityRelation) throws Exception { String url = String.format("/api/relation?fromId=%s&fromType=%s&relationType=%s&toId=%s&toType=%s", entityRelation.getFrom().getId(), entityRelation.getFrom().getEntityType(), entityRelation.getType(), entityRelation.getTo().getId(), entityRelation.getTo().getEntityType()); doDelete(url); } protected List findRelationsByTo(EntityId entityId) throws Exception { String url = String.format("/api/relations?toId=%s&toType=%s", entityId.getId(), entityId.getEntityType().name()); MvcResult mvcResult = doGet(url).andReturn(); switch (mvcResult.getResponse().getStatus()) { case 200: return readResponse(mvcResult, new TypeReference<>() { }); case 404: return Collections.emptyList(); } throw new AssertionError("Unexpected status " + mvcResult.getResponse().getStatus()); } protected int getDeviceActorSubscriptionCount(DeviceId deviceId, FeatureType featureType) { DeviceActorMessageProcessor processor = getDeviceActorProcessor(deviceId); Map subscriptions = (Map) ReflectionTestUtils.getField(processor, getMapName(featureType)); return subscriptions.size(); } protected void awaitForDeviceActorToReceiveSubscription(DeviceId deviceId, FeatureType featureType, int subscriptionCount) { DeviceActorMessageProcessor processor = getDeviceActorProcessor(deviceId); Map subscriptions = (Map) ReflectionTestUtils.getField(processor, getMapName(featureType)); Awaitility.await("Device actor received subscription command from the transport").atMost(5, TimeUnit.SECONDS).until(() -> { log.warn("device {}, subscriptions.size() == {}", deviceId, subscriptions.size()); return subscriptions.size() == subscriptionCount; }); } protected void awaitForDeviceActorToProcessAllRpcResponses(DeviceId deviceId) { DeviceActorMessageProcessor processor = getDeviceActorProcessor(deviceId); Map toDeviceRpcPendingMap = (Map) ReflectionTestUtils.getField(processor, "toDeviceRpcPendingMap"); Awaitility.await("Device actor pending map is empty").atMost(5, TimeUnit.SECONDS).until(() -> { log.warn("device {}, toDeviceRpcPendingMap.size() == {}", deviceId, toDeviceRpcPendingMap.size()); return toDeviceRpcPendingMap.isEmpty(); }); } protected void awaitForClaimingInfoToBeRegistered(DeviceId deviceId) { CacheManager cacheManager = (CacheManager) ReflectionTestUtils.getField(claimDevicesService, "cacheManager"); Cache cache = cacheManager.getCache(CLAIM_DEVICES_CACHE); Awaitility.await("Claiming request from the transport was registered").atMost(5, TimeUnit.SECONDS).until(() -> { Cache.ValueWrapper value = cache.get(List.of(deviceId)); log.warn("device {}, claimingRequest registered: {}", deviceId, value); return value != null; }); } protected void awaitForCalculatedFieldEntityMessageProcessorToRegisterCfStateAsReadyToRefreshDynamicArguments(EntityId entityId, CalculatedFieldId cfId, int scheduledUpdateInterval) { CalculatedFieldEntityMessageProcessor processor = getCalculatedFieldEntityMessageProcessor(entityId); Map statesMap = (Map) ReflectionTestUtils.getField(processor, "states"); Awaitility.await("CF state for entity actor ready to refresh dynamic arguments").atMost(TIMEOUT, TimeUnit.SECONDS).until(() -> { CalculatedFieldState calculatedFieldState = statesMap.get(cfId); boolean isReady = calculatedFieldState != null && ((GeofencingCalculatedFieldState) calculatedFieldState).getLastScheduledRefreshTs() < System.currentTimeMillis() - TimeUnit.SECONDS.toMillis(scheduledUpdateInterval); log.warn("entityId {}, cfId {}, state ready to refresh == {}", entityId, cfId, isReady); return isReady; }); } protected static String getMapName(FeatureType featureType) { switch (featureType) { case ATTRIBUTES: return "attributeSubscriptions"; case RPC: return "rpcSubscriptions"; default: throw new RuntimeException("Not supported feature " + featureType + "!"); } } protected DeviceActorMessageProcessor getDeviceActorProcessor(DeviceId deviceId) { DefaultTbActorSystem actorSystem = (DefaultTbActorSystem) ReflectionTestUtils.getField(actorService, "system"); ConcurrentMap actors = (ConcurrentMap) ReflectionTestUtils.getField(actorSystem, "actors"); Awaitility.await("Device actor was created").atMost(TIMEOUT, TimeUnit.SECONDS) .until(() -> actors.containsKey(new TbEntityActorId(deviceId))); TbActorMailbox actorMailbox = actors.get(new TbEntityActorId(deviceId)); DeviceActor actor = (DeviceActor) ReflectionTestUtils.getField(actorMailbox, "actor"); return (DeviceActorMessageProcessor) ReflectionTestUtils.getField(actor, "processor"); } protected CalculatedFieldEntityMessageProcessor getCalculatedFieldEntityMessageProcessor(EntityId entityId) { DefaultTbActorSystem actorSystem = (DefaultTbActorSystem) ReflectionTestUtils.getField(actorService, "system"); ConcurrentMap actors = (ConcurrentMap) ReflectionTestUtils.getField(actorSystem, "actors"); Awaitility.await("CF entity actor was created").atMost(TIMEOUT, TimeUnit.SECONDS) .until(() -> actors.containsKey(new TbCalculatedFieldEntityActorId(entityId))); TbActorMailbox actorMailbox = actors.get(new TbCalculatedFieldEntityActorId(entityId)); CalculatedFieldEntityActor actor = (CalculatedFieldEntityActor) ReflectionTestUtils.getField(actorMailbox, "actor"); return (CalculatedFieldEntityMessageProcessor) ReflectionTestUtils.getField(actor, "processor"); } protected void updateDefaultTenantProfileConfig(Consumer updater) throws ThingsboardException { updateDefaultTenantProfile(tenantProfile -> { TenantProfileData profileData = tenantProfile.getProfileData(); DefaultTenantProfileConfiguration profileConfiguration = (DefaultTenantProfileConfiguration) profileData.getConfiguration(); updater.accept(profileConfiguration); tenantProfile.setProfileData(profileData); }); } protected void updateDefaultTenantProfile(Consumer updater) throws ThingsboardException { TenantProfile oldTenantProfile = tenantProfileService.findDefaultTenantProfile(TenantId.SYS_TENANT_ID); TenantProfile tenantProfile = JacksonUtil.clone(oldTenantProfile); updater.accept(tenantProfile); // user should be sysadmin as this operation allowed only for sysadmins. But for the simplification of the test - already existed variable provided. This affects only an audit log content tbTenantProfileService.save(TenantId.SYS_TENANT_ID, tenantProfile, oldTenantProfile, tenantAdminUser); } protected OAuth2Client createOauth2Client(TenantId tenantId, String title) { return createOauth2Client(tenantId, title, null); } protected OAuth2Client createOauth2Client(TenantId tenantId, String title, List platforms) { OAuth2Client oAuth2Client = new OAuth2Client(); oAuth2Client.setTenantId(tenantId); oAuth2Client.setTitle(title); oAuth2Client.setClientId(UUID.randomUUID().toString()); oAuth2Client.setClientSecret(UUID.randomUUID().toString()); oAuth2Client.setAuthorizationUri(UUID.randomUUID().toString()); oAuth2Client.setAccessTokenUri(UUID.randomUUID().toString()); oAuth2Client.setScope(Arrays.asList(UUID.randomUUID().toString(), UUID.randomUUID().toString())); oAuth2Client.setPlatforms(platforms == null ? Collections.emptyList() : platforms); oAuth2Client.setUserInfoUri(UUID.randomUUID().toString()); oAuth2Client.setUserNameAttributeName(UUID.randomUUID().toString()); oAuth2Client.setJwkSetUri(UUID.randomUUID().toString()); oAuth2Client.setClientAuthenticationMethod(UUID.randomUUID().toString()); oAuth2Client.setLoginButtonLabel(UUID.randomUUID().toString()); oAuth2Client.setLoginButtonIcon(UUID.randomUUID().toString()); oAuth2Client.setAdditionalInfo(JacksonUtil.newObjectNode().put(UUID.randomUUID().toString(), UUID.randomUUID().toString())); oAuth2Client.setMapperConfig( OAuth2MapperConfig.builder() .allowUserCreation(true) .activateUser(true) .type(MapperType.CUSTOM) .custom( OAuth2CustomMapperConfig.builder() .url(UUID.randomUUID().toString()) .build() ) .build()); return oAuth2Client; } protected TbResourceInfo uploadImage(HttpMethod httpMethod, String url, String filename, String mediaType, byte[] content) throws Exception { return this.uploadImage(httpMethod, url, null, filename, mediaType, content); } protected TbResourceInfo uploadImage(HttpMethod httpMethod, String url, String subType, String filename, String mediaType, byte[] content) throws Exception { return uploadResource(httpMethod, url, filename, mediaType, content, StringUtils.isNotEmpty(subType) ? List.of(new MockPart("imageSubType", subType.getBytes(StandardCharsets.UTF_8))) : null); } protected TbResourceInfo uploadResource(HttpMethod httpMethod, String url, String filename, String mediaType, byte[] content, List otherParts) throws Exception { MockMultipartFile file = new MockMultipartFile("file", filename, mediaType, content); var request = MockMvcRequestBuilders.multipart(httpMethod, url).file(file); if (otherParts != null && !otherParts.isEmpty()) { for (MockPart otherPart : otherParts) { request.part(otherPart); } } setJwtToken(request); return readResponse(mockMvc.perform(request).andExpect(status().isOk()), TbResourceInfo.class); } protected NotificationTarget createNotificationTarget(UserId... usersIds) { UserListFilter filter = new UserListFilter(); filter.setUsersIds(DaoUtil.toUUIDs(List.of(usersIds))); return createNotificationTarget(filter); } protected NotificationTarget createNotificationTarget(UsersFilter usersFilter) { NotificationTarget notificationTarget = new NotificationTarget(); notificationTarget.setName(usersFilter.toString() + RandomStringUtils.randomNumeric(5)); PlatformUsersNotificationTargetConfig targetConfig = new PlatformUsersNotificationTargetConfig(); targetConfig.setUsersFilter(usersFilter); notificationTarget.setConfiguration(targetConfig); return saveNotificationTarget(notificationTarget); } protected NotificationTarget saveNotificationTarget(NotificationTarget notificationTarget) { return doPost("/api/notification/target", notificationTarget, NotificationTarget.class); } protected NotificationTemplate createNotificationTemplate(NotificationType notificationType, String subject, String text, NotificationDeliveryMethod... deliveryMethods) { NotificationTemplate notificationTemplate = new NotificationTemplate(); notificationTemplate.setTenantId(tenantId); notificationTemplate.setName("Notification template: " + text); notificationTemplate.setNotificationType(notificationType); NotificationTemplateConfig config = new NotificationTemplateConfig(); config.setDeliveryMethodsTemplates(new HashMap<>()); for (NotificationDeliveryMethod deliveryMethod : deliveryMethods) { DeliveryMethodNotificationTemplate deliveryMethodNotificationTemplate; switch (deliveryMethod) { case WEB: { deliveryMethodNotificationTemplate = new WebDeliveryMethodNotificationTemplate(); break; } case EMAIL: { deliveryMethodNotificationTemplate = new EmailDeliveryMethodNotificationTemplate(); break; } case SMS: { deliveryMethodNotificationTemplate = new SmsDeliveryMethodNotificationTemplate(); break; } case MOBILE_APP: deliveryMethodNotificationTemplate = new MobileAppDeliveryMethodNotificationTemplate(); break; default: throw new IllegalArgumentException("Unsupported delivery method " + deliveryMethod); } deliveryMethodNotificationTemplate.setEnabled(true); deliveryMethodNotificationTemplate.setBody(text); if (deliveryMethodNotificationTemplate instanceof HasSubject) { ((HasSubject) deliveryMethodNotificationTemplate).setSubject(subject); } config.getDeliveryMethodsTemplates().put(deliveryMethod, deliveryMethodNotificationTemplate); } notificationTemplate.setConfiguration(config); return saveNotificationTemplate(notificationTemplate); } protected NotificationTemplate saveNotificationTemplate(NotificationTemplate notificationTemplate) { return doPost("/api/notification/template", notificationTemplate, NotificationTemplate.class); } protected List getMyNotifications(boolean unreadOnly, int limit) throws Exception { return getMyNotifications(NotificationDeliveryMethod.WEB, unreadOnly, limit); } protected List getMyNotifications(NotificationDeliveryMethod deliveryMethod, boolean unreadOnly, int limit) throws Exception { return doGetTypedWithPageLink("/api/notifications?unreadOnly={unreadOnly}&deliveryMethod={deliveryMethod}&", new TypeReference>() {}, new PageLink(limit, 0), unreadOnly, deliveryMethod).getData(); } protected Job findJobById(JobId jobId) throws Exception { return doGet("/api/job/" + jobId, Job.class); } protected List findJobs() throws Exception { return doGetTypedWithPageLink("/api/jobs?", new TypeReference>() {}, new PageLink(100, 0, null, new SortOrder("createdTime", SortOrder.Direction.DESC))).getData(); } protected List findJobs(List types, List entities) throws Exception { return doGetTypedWithPageLink("/api/jobs?types=" + types.stream().map(Enum::name).collect(Collectors.joining(",")) + "&entities=" + entities.stream().map(UUID::toString).collect(Collectors.joining(",")) + "&", new TypeReference>() {}, new PageLink(100, 0, null, new SortOrder("createdTime", SortOrder.Direction.DESC))).getData(); } protected void cancelJob(JobId jobId) throws Exception { doPost("/api/job/" + jobId + "/cancel").andExpect(status().isOk()); } protected void reprocessJob(JobId jobId) throws Exception { doPost("/api/job/" + jobId + "/reprocess").andExpect(status().isOk()); } protected void postTelemetry(EntityId entityId, String payload) throws Exception { doPostAsync("/api/plugins/telemetry/" + entityId.getEntityType() + "/" + entityId.getId() + "/timeseries/" + DataConstants.SERVER_SCOPE, JacksonUtil.toJsonNode(payload), 30_000L).andExpect(status().isOk()); } protected void postTelemetry(EntityId entityId, TsKvEntry entry) throws Exception { var values = JacksonUtil.newObjectNode(); JacksonUtil.addKvEntry(values, entry); var payload = JacksonUtil.newObjectNode() .put("ts", entry.getTs()) .set("values", values); var url = "/api/plugins/telemetry/" + entityId.getEntityType() + "/" + entityId.getId() + "/timeseries/any"; doPostAsync(url, payload, 30_000L).andExpect(status().isOk()); } protected void postAttributes(EntityId entityId, AttributeScope scope, String payload) throws Exception { doPostAsync("/api/plugins/telemetry/" + entityId.getEntityType() + "/" + entityId.getId() + "/attributes/" + scope, JacksonUtil.toJsonNode(payload), 30_000L).andExpect(status().isOk()); } protected void postAttributes(EntityId entityId, AttributeScope scope, KvEntry... attributes) throws Exception { postAttributes(entityId, scope, Arrays.asList(attributes)); } protected void postAttributes(EntityId entityId, AttributeScope scope, Collection attributes) throws Exception { var url = "/api/plugins/telemetry/" + entityId.getEntityType() + "/" + entityId.getId() + "/attributes/" + scope; var payload = JacksonUtil.newObjectNode(); for (KvEntry entry : attributes) { JacksonUtil.addKvEntry(payload, entry); } doPostAsync(url, payload, 30_000L).andExpect(status().isOk()); } protected CalculatedField saveCalculatedField(CalculatedField calculatedField) { return doPost("/api/calculatedField", calculatedField, CalculatedField.class); } protected AlarmRuleDefinition saveAlarmRule(AlarmRuleDefinition alarmRule) { return doPost("/api/alarm/rule", alarmRule, AlarmRuleDefinition.class); } protected PageData getEntityCalculatedFields(EntityId entityId, CalculatedFieldType type, PageLink pageLink) throws Exception { return doGetTypedWithPageLink("/api/" + entityId.getEntityType() + "/" + entityId.getId() + "/calculatedFields" + (type != null ? "?type=" + type.name() + "&" : "?"), new TypeReference<>() {}, pageLink); } protected PageData getCalculatedFieldNames(CalculatedFieldType type, PageLink pageLink) throws Exception { return doGetTypedWithPageLink("/api/calculatedFields/names?type=" + type + "&", new TypeReference>() {}, pageLink); } protected List getCalculatedFields(CalculatedFieldType type, EntityType entityType, List entities, List names) throws Exception { return doGetTypedWithPageLink("/api/calculatedFields?" + (type != null ? "types=" + type + "&" : "") + (entityType != null ? "entityType=" + entityType + "&" : "") + (entities != null ? "entities=" + String.join(",", entities.stream().map(UUID::toString).toList()) + "&" : "") + (names != null ? names.stream().map(name -> "name=" + name + "&").collect(Collectors.joining("")) : ""), new TypeReference>() {}, new PageLink(10)).getData(); } protected PageData getDebugEvents(TenantId tenantId, EntityId entityId, int limit) throws Exception { return getEvents(tenantId, entityId, EventType.DEBUG_RULE_NODE, limit); } protected PageData getEvents(TenantId tenantId, EntityId entityId, EventType eventType, int limit) throws Exception { TimePageLink pageLink = new TimePageLink(limit); return doGetTypedWithTimePageLink("/api/events/{entityType}/{entityId}/{eventType}?tenantId={tenantId}&", new TypeReference>() { }, pageLink, entityId.getEntityType(), entityId.getId(), eventType, tenantId.getId()); } }