Merge branch '22-increase-test-coverage-in-tmf639' into 'develop'

/*-

 * ========================LICENSE_START=================================

 * org.etsi.osl.tmf.api

 * %%

 * Copyright (C) 2019 - 2024 openslice.io

 * %%

 * 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.

 * =========================LICENSE_END==================================

 */

package org.etsi.osl.services.api.ri639;

import com.fasterxml.jackson.databind.ObjectMapper;

import jakarta.servlet.FilterChain;

import jakarta.servlet.ServletException;

import jakarta.servlet.http.HttpServletRequest;

import jakarta.servlet.http.HttpServletResponse;

import org.etsi.osl.tmf.ri639.api.*;

import org.junit.jupiter.api.Test;

import org.springframework.mock.web.MockHttpServletRequest;

import java.io.IOException;

import java.util.Optional;

import static org.junit.jupiter.api.Assertions.assertEquals;

import static org.junit.jupiter.api.Assertions.assertTrue;

import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.verify;

public class CommonTests {

    @Test

    public void testApiException() {

        int errorCode = 404;

        String errorMessage = "Not Found";

        ApiException exception = new ApiException(errorCode, errorMessage);

        assertEquals(errorMessage, exception.getMessage());

    }

    @Test

    public void testApiOriginFilter() throws IOException, ServletException {

        HttpServletRequest request = mock(HttpServletRequest.class);

        HttpServletResponse response = mock(HttpServletResponse.class);

        FilterChain chain = mock(FilterChain.class);

        ApiOriginFilter filter = new ApiOriginFilter();

        filter.doFilter(request, response, chain);

        verify(response).addHeader("Access-Control-Allow-Origin", "*");

        verify(response).addHeader("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");

        verify(response).addHeader("Access-Control-Allow-Headers", "Content-Type");

        verify(chain).doFilter(request, response);

    }

    @Test

    public void testApiResponseMessage() {

        int[] codes = {ApiResponseMessage.ERROR, ApiResponseMessage.WARNING, ApiResponseMessage.INFO, ApiResponseMessage.OK, ApiResponseMessage.TOO_BUSY, 6};

        String[] types = {"error", "warning", "info", "ok", "too busy", "unknown"};

        String[] messages = {"An error occured", "This is a warning", "Given info", "ok", "System is too busy", "unknown code"};

        for (int i = 0; i < codes.length; i++) {

            int code = codes[i];

            String type = types[i];

            String message = messages[i];

            ApiResponseMessage responseMessage = new ApiResponseMessage(code, message);

            assertEquals(message, responseMessage.getMessage());

            assertEquals(code, responseMessage.getCode());

            assertEquals(type, responseMessage.getType());

        }

        ApiResponseMessage responseMessage = new ApiResponseMessage();

        responseMessage.setMessage("Error");

        assertEquals("Error", responseMessage.getMessage());

        responseMessage.setType("ok");

        assertEquals("ok", responseMessage.getType());

        responseMessage.setCode(ApiResponseMessage.OK);

        assertEquals(ApiResponseMessage.OK, responseMessage.getCode());

    }

    @Test

    public void testHubApiController() {

        ObjectMapper objectMapper = new ObjectMapper();

        HttpServletRequest request = new MockHttpServletRequest();

        HubApiController controller = new HubApiController(objectMapper, request);

        Optional<ObjectMapper> returnedObjectMapper = controller.getObjectMapper();

        Optional<HttpServletRequest> returnedRequest = controller.getRequest();

        assertTrue(returnedObjectMapper.isPresent());

        assertTrue(returnedRequest.isPresent());

        assertEquals(objectMapper, returnedObjectMapper.get());

        assertEquals(request, returnedRequest.get());

    }

    @Test

    public void testListenerApiController() {

        ObjectMapper objectMapper = new ObjectMapper();

        HttpServletRequest request = new MockHttpServletRequest();

        ListenerApiController controller = new ListenerApiController(objectMapper, request);

        Optional<ObjectMapper> returnedObjectMapper = controller.getObjectMapper();

        Optional<HttpServletRequest> returnedRequest = controller.getRequest();

        assertTrue(returnedObjectMapper.isPresent());

        assertTrue(returnedRequest.isPresent());

        assertEquals(objectMapper, returnedObjectMapper.get());

        assertEquals(request, returnedRequest.get());

    }

    @Test

    public void testNotFoundException() {

        int errorCode = 404;

        String errorMessage = "Not Found";

        NotFoundException exception = new NotFoundException(errorCode, errorMessage);

        assertEquals(errorMessage, exception.getMessage());

    }

}

package org.etsi.osl.services.api.ri639;

import static org.assertj.core.api.Assertions.assertThat;

import static org.mockito.ArgumentMatchers.any;

import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.when;

import static org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.springSecurity;

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

import java.time.OffsetDateTime;

import java.time.ZoneOffset;

import java.util.List;

import java.security.Principal;

import com.fasterxml.jackson.core.type.TypeReference;

import com.fasterxml.jackson.databind.ObjectMapper;

import org.etsi.osl.tmf.JsonUtils;

import org.etsi.osl.tmf.OpenAPISpringBoot;

import org.etsi.osl.tmf.rcm634.model.ResourceSpecificationRef;

import org.etsi.osl.tmf.ri639.api.ResourceApiController;

import org.etsi.osl.tmf.ri639.model.LogicalResource;

import org.etsi.osl.tmf.ri639.model.Resource;

import org.etsi.osl.tmf.ri639.model.ResourceCreate;

import org.etsi.osl.tmf.ri639.reposervices.ResourceRepoService;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.http.HttpStatus;

import org.springframework.http.MediaType;

import org.springframework.security.test.context.support.WithMockUser;

import org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors;

import org.springframework.test.context.ActiveProfiles;

import org.springframework.test.context.junit4.SpringRunner;

import org.springframework.test.web.servlet.MockMvc;

import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;

import org.springframework.test.web.servlet.setup.MockMvcBuilders;

import org.springframework.transaction.annotation.Transactional;

import org.springframework.web.context.WebApplicationContext;

import org.springframework.http.ResponseEntity;

@RunWith(SpringRunner.class)

@Transactional

@SpringBootTest( webEnvironment = SpringBootTest.WebEnvironment.MOCK , classes = OpenAPISpringBoot.class)

@AutoConfigureMockMvc

@ActiveProfiles("testing")

public class ResourceApiControllerTest {

    private static final int FIXED_BOOTSTRAPS_RESOURCES = 0;

    @Autowired

    private MockMvc mvc;

    @Autowired

    ResourceRepoService resourceRepoService;

    @Autowired

    private WebApplicationContext context;

    @Autowired

    private ObjectMapper objectMapper;

    private ResourceApiController mockResourceApiController;

    private ResourceRepoService mockResourceRepoService;

    @Before

    public void setup() {

        mvc = MockMvcBuilders

                .webAppContextSetup(context)

                .apply(springSecurity())

                .build();

        // Mocks

        mockResourceRepoService = mock(ResourceRepoService.class);

        ObjectMapper mockObjectMapper = mock(ObjectMapper.class);

        mockResourceApiController = new ResourceApiController(mockObjectMapper, null);

    }

    @WithMockUser(username="osadmin", roles = {"ADMIN","USER"})

    @Test

    public void testListResource() throws Exception {

        String response = mvc.perform(MockMvcRequestBuilders.get("/resourceInventoryManagement/v4/resource")

                        .contentType(MediaType.APPLICATION_JSON))

                .andExpect(status().isOk() )

                .andReturn().getResponse().getContentAsString();

        List<Resource> resourceList = objectMapper.readValue(response, new TypeReference<List<Resource>>() {});

        assertThat(resourceList.size()).isEqualTo(resourceRepoService.findAll().size());

    }

    @WithMockUser(username="osadmin", roles = {"ADMIN","USER"})

    @Test

    public void testDeleteResource() throws Exception {

        String response = createResource();

        Resource responsesResource = JsonUtils.toJsonObj(response,  LogicalResource.class);

        String id = responsesResource.getId();

        mvc.perform(MockMvcRequestBuilders.delete("/resourceInventoryManagement/v4/resource/" + id )

                        .with( SecurityMockMvcRequestPostProcessors.csrf())

                        .contentType(MediaType.APPLICATION_JSON))

                .andExpect(status().isOk() )

                .andReturn().getResponse().getContentAsString();

        assertThat( resourceRepoService.findAll().size() ).isEqualTo( FIXED_BOOTSTRAPS_RESOURCES );

    }

    @WithMockUser(username="osadmin", roles = {"ADMIN","USER"})

    @Test

    public void testCreateResourceHandleException(){

        ResourceCreate resourceCreate = createResourceObject();

        when(mockResourceRepoService.addResource(any()))

                .thenThrow(new RuntimeException("Test exception"));

        ResponseEntity<Resource> response = mockResourceApiController.createResource(mock(Principal.class), resourceCreate);

        assertThat(response.getStatusCode()).isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR);

    }

    @WithMockUser(username="osadmin", roles = {"ADMIN","USER"})

    @Test

    public void testDeleteResourceHandleException() throws Exception{

        String response = createResource();

        Resource responsesResource = JsonUtils.toJsonObj(response,  LogicalResource.class);

        String id = responsesResource.getId();

        when(mockResourceRepoService.deleteByUuid(any()))

                .thenThrow(new RuntimeException("Test exception"));

        ResponseEntity<Void> responseDelete = mockResourceApiController.deleteResource(id);

        assertThat(responseDelete.getStatusCode()).isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR);

    }

    @WithMockUser(username="osadmin", roles = {"ADMIN","USER"})

    @Test

    public void testListResourceHandleException(){

        when(mockResourceRepoService.findAll())

                .thenThrow(new RuntimeException("Test exception"));

        ResponseEntity<List<Resource>> response = mockResourceApiController.listResource(mock(Principal.class), null, null, null, null);

        assertThat(response.getStatusCode()).isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR);

    }

    @WithMockUser(username="osadmin", roles = {"ADMIN","USER"})

    @Test

    public void testRetrieveResourceHandleException(){

        when(mockResourceRepoService.findByUuid(any()))

                .thenThrow(new RuntimeException("Test exception"));

        ResponseEntity<Resource> response = mockResourceApiController.retrieveResource(mock(Principal.class), "test id", "");

        assertThat(response.getStatusCode()).isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR);

    }

    private String createResource() throws Exception{

        ResourceCreate resourceCreate = createResourceObject();

        String response = mvc.perform(MockMvcRequestBuilders.post("/resourceInventoryManagement/v4/resource")

                        .with( SecurityMockMvcRequestPostProcessors.csrf())

                        .contentType(MediaType.APPLICATION_JSON)

                        .content( JsonUtils.toJson( resourceCreate ) ))

                .andExpect(status().isOk())

                .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))

                .andExpect(status().isOk())

                .andReturn().getResponse().getContentAsString();

        assertThat( resourceRepoService.findAll().size() ).isEqualTo( FIXED_BOOTSTRAPS_RESOURCES + 1 );

        return response;

    }

    private ResourceCreate createResourceObject() {

        ResourceCreate resourceCreate = new ResourceCreate();

        resourceCreate.setName("Test Resource");

        resourceCreate.setCategory("Experimentation");

        resourceCreate.setDescription("A Test Resource");

        resourceCreate.setStartOperatingDate( OffsetDateTime.now(ZoneOffset.UTC ).toString() );

        resourceCreate.setEndOperatingDate( OffsetDateTime.now(ZoneOffset.UTC ).toString() );

        ResourceSpecificationRef aServiceSpecificationRef = new ResourceSpecificationRef();

        resourceCreate.setResourceSpecification( aServiceSpecificationRef );

        return resourceCreate;

    }

}