io.github.microcks.web.TestController Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microcks-app Show documentation
There is a newer version: 1.11.2
/*
 * Licensed to Laurent Broudoux (the "Author") under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. Author licenses this
 * file to you 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 io.github.microcks.web;

import io.github.microcks.domain.*;
import io.github.microcks.repository.ServiceRepository;
import io.github.microcks.repository.TestResultRepository;
import io.github.microcks.service.MessageService;
import io.github.microcks.domain.RequestResponsePair;
import io.github.microcks.service.TestService;
import io.github.microcks.web.dto.HeaderDTO;
import io.github.microcks.web.dto.TestCaseReturnDTO;
import io.github.microcks.web.dto.TestRequestDTO;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Sort;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.nio.charset.StandardCharsets;
import java.util.*;

/**
 * A Rest controller for API defined on test results.
 * @author laurent
 */
@org.springframework.web.bind.annotation.RestController
@RequestMapping("/api")
public class TestController {

   /** A simple logger for diagnostic messages. */
   private static Logger log = LoggerFactory.getLogger(TestController.class);

   @Autowired
   private TestResultRepository testResultRepository;

   @Autowired
   private ServiceRepository serviceRepository;

   @Autowired
   private TestService testService;

   @Autowired
   private MessageService messageService;


   @RequestMapping(value = "/tests/service/{serviceId}", method = RequestMethod.GET)
   public List listTestsByService(
         @PathVariable("serviceId") String serviceId,
         @RequestParam(value = "page", required = false, defaultValue = "0") int page,
         @RequestParam(value = "size", required = false, defaultValue = "20") int size
      ) {
      log.debug("Getting tests list for service {}, page {} and size {}", serviceId, page, size);
      return testResultRepository.findByServiceId(serviceId,
            PageRequest.of(page, size, Sort.by(Sort.Direction.DESC, "testNumber")));
   }

   @RequestMapping(value = "/tests/service/{serviceId}/count", method = RequestMethod.GET)
   public Map countTestsByService(
         @PathVariable("serviceId") String serviceId
      ) {
      log.debug("Counting tests for service...");
      Map counter = new HashMap<>();
      counter.put("counter", testResultRepository.countByServiceId(serviceId));
      return counter;
   }

   @RequestMapping(value = "/tests", method = RequestMethod.POST)
   public ResponseEntity createTest(@RequestBody TestRequestDTO test) {
      log.debug("Creating new test for {} on endpoint {}", test.getServiceId(), test.getTestEndpoint());
      Service service = null;
      // serviceId may have the form of :
      if (test.getServiceId().contains(":")) {
         String name = test.getServiceId().substring(0, test.getServiceId().indexOf(':'));
         String version = test.getServiceId().substring(test.getServiceId().indexOf(':') + 1);
         service = serviceRepository.findByNameAndVersion(name, version);
      } else {
         service = serviceRepository.findById(test.getServiceId()).orElse(null);
      }
      TestRunnerType testRunner = TestRunnerType.valueOf(test.getRunnerType());
      // Build additional header entries for operations.
      OperationsHeaders operationsHeaders = buildOperationsHeaders(test.getOperationsHeaders());
      TestResult testResult = testService.launchTests(service, test.getTestEndpoint(), testRunner, operationsHeaders);
      return new ResponseEntity(testResult, HttpStatus.CREATED);
   }

   @RequestMapping(value = "/tests/{id}", method = RequestMethod.GET)
   public ResponseEntity getTestResult(@PathVariable("id") String testResultId) {
      log.debug("Getting TestResult with id {}", testResultId);
      return new ResponseEntity<>(testResultRepository.findById(testResultId).orElse(null), HttpStatus.OK);
   }

   @RequestMapping(value = "tests/{id}/messages/{testCaseId}", method = RequestMethod.GET)
   public List getMessagesForTestCase(
         @PathVariable("id") String testResultId,
         @PathVariable("testCaseId") String testCaseId
      ) {
      // We may have testCaseId being URLEncoded, with forbidden '/' replaced by '_' so unwrap id.
      try {
         testCaseId = URLDecoder.decode(testCaseId, StandardCharsets.UTF_8.toString());
         testCaseId = testCaseId.replace('_', '/');
      } catch (UnsupportedEncodingException e) {
         return null;
      }
      log.debug("Getting messages for testCase {} on test {}", testCaseId, testResultId);
      return messageService.getRequestResponseByTestCase(testCaseId);
   }

   @RequestMapping(value = "tests/{id}/testCaseResult", method = RequestMethod.POST)
   public ResponseEntity reportTestCaseResult(
         @PathVariable("id") String testResultId,
         @RequestBody TestCaseReturnDTO testCaseReturn
         ) {
      log.debug("Reporting testCase results on test {}", testResultId);
      TestCaseResult testCaseResult = testService.reportTestCaseResult(
            testResultId, testCaseReturn.getOperationName(), testCaseReturn.getTestReturns());
      if (testCaseResult != null) {
         return new ResponseEntity<>(testCaseResult, HttpStatus.OK);
      }
      return new ResponseEntity(HttpStatus.BAD_REQUEST);
   }

   /**
    * Build OperationsHeaders domain object from basic Map. Key is operation name, Value is
    * a header data transfer object.
    */
   private OperationsHeaders buildOperationsHeaders(Map> operationsHeaders) {
      OperationsHeaders result = new OperationsHeaders();
      if (operationsHeaders != null) {
         // Now browse different operations (globals included).
         for (Map.Entry> operationsHeadersEntry : operationsHeaders.entrySet()) {
            String operationName = operationsHeadersEntry.getKey();
            List operationHeaders = operationsHeadersEntry.getValue();
            Set headers = new HashSet<>();
            // Browse each header entry. Values are comma separated.
            for (HeaderDTO operationHeadersEntry : operationHeaders) {
               String[] headerValues = operationHeadersEntry.getValues().split(",");
               Header header = new Header();
               header.setName(operationHeadersEntry.getName());
               header.setValues(new HashSet<>(Arrays.asList(headerValues)));
               headers.add(header);
            }
            result.put(operationName, headers);
         }
         return result;
      }
      return null;
   }
}