io.github.microcks.service.ServiceService Maven / Gradle / Ivy
/*
* 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.service;
import io.github.microcks.domain.*;
import io.github.microcks.event.ChangeType;
import io.github.microcks.event.ServiceChangeEvent;
import io.github.microcks.repository.EventMessageRepository;
import io.github.microcks.repository.RequestRepository;
import io.github.microcks.repository.ResourceRepository;
import io.github.microcks.repository.ResponseRepository;
import io.github.microcks.repository.ServiceRepository;
import io.github.microcks.repository.TestResultRepository;
import io.github.microcks.security.AuthorizationChecker;
import io.github.microcks.security.UserInfo;
import io.github.microcks.util.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.ApplicationContext;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.Optional;
/**
* Bean defining service operations around Service domain objects.
* @author laurent
*/
@org.springframework.stereotype.Service
public class ServiceService {
/** A simple logger for diagnostic messages. */
private static Logger log = LoggerFactory.getLogger(ServiceService.class);
@Autowired
private ServiceRepository serviceRepository;
@Autowired
private ResourceRepository resourceRepository;
@Autowired
private RequestRepository requestRepository;
@Autowired
private ResponseRepository responseRepository;
@Autowired
private EventMessageRepository eventMessageRepository;
@Autowired
private TestResultRepository testResultRepository;
@Autowired
private ApplicationContext applicationContext;
@Autowired
private AuthorizationChecker authorizationChecker;
@Value("${async-api.default-binding}")
private final String defaultAsyncBinding = null;
@Value("${async-api.default-frequency}")
private final Long defaultAsyncFrequency = 30l;
/**
* Import definitions of services and bounded resources and messages into Microcks
* repository. This uses a MockRepositoryImporter underhood.
* @param repositoryUrl The String representing mock repository url.
* @param repositorySecret The authentication secret associated with the repository url. Can be set to null if none.
* @param disableSSLValidation Whether SSL certificates validation should be turned off.
* @param mainArtifact Whether this repository should be considered as main artifact for Services to import.
* @return The list of imported Services
* @throws MockRepositoryImportException if something goes wrong (URL not reachable nor readable, etc...)
*/
public List importServiceDefinition(String repositoryUrl, Secret repositorySecret, boolean disableSSLValidation, boolean mainArtifact) throws MockRepositoryImportException {
log.info("Importing service definitions from " + repositoryUrl);
File localFile = null;
if (repositoryUrl.startsWith("http")) {
try {
localFile = HTTPDownloader.handleHTTPDownloadToFile(repositoryUrl, repositorySecret, disableSSLValidation);
} catch (IOException ioe) {
log.error("Exception while downloading " + repositoryUrl, ioe);
throw new MockRepositoryImportException(repositoryUrl + " cannot be downloaded", ioe);
}
} else {
// Simply build localFile from repository url.
localFile = new File(repositoryUrl);
}
// Initialize a reference resolver to the folder of this repositoryUrl.
ReferenceResolver referenceResolver = new ReferenceResolver(
repositoryUrl.substring(0, repositoryUrl.lastIndexOf("/")),
repositorySecret,
disableSSLValidation);
return importServiceDefinition(localFile, referenceResolver,
new ArtifactInfo(repositoryUrl.substring(repositoryUrl.lastIndexOf("/") + 1), mainArtifact));
}
/**
* Import definitions of services and bounded resources and messages into Microcks
* repository. This uses a MockRepositoryImporter under hood.
* @param repositoryFile The File for mock repository.
* @param referenceResolver The Resolver to be used during import (may be null).
* @param artifactInfo The essential information on Artifact to import.
* @return The list of imported Services
* @throws MockRepositoryImportException if something goes wrong (URL not reachable nor readable, etc...)
*/
public List importServiceDefinition(File repositoryFile, ReferenceResolver referenceResolver, ArtifactInfo artifactInfo) throws MockRepositoryImportException {
// Retrieve the correct importer based on file path.
MockRepositoryImporter importer = null;
try {
importer = MockRepositoryImporterFactory.getMockRepositoryImporter(repositoryFile, referenceResolver);
} catch (IOException ioe) {
log.error("Exception while accessing file " + repositoryFile.getPath(), ioe);
throw new MockRepositoryImportException(ioe.getMessage(), ioe);
}
Service reference = null;
boolean serviceUpdate = false;
List services = importer.getServiceDefinitions();
for (Service service : services){
Service existingService = serviceRepository.findByNameAndVersion(service.getName(), service.getVersion());
log.debug("Service [{}, {}] exists ? {}", service.getName(), service.getVersion(), existingService != null);
// If it's the main artifact: retrieve previous id and props if update, save anyway.
if (artifactInfo.isMainArtifact()) {
if (existingService != null) {
// Retrieve its previous identifier and metadatas
// (backup metadata that may have been imported with extensions).
Metadata backup = service.getMetadata();
service.setId(existingService.getId());
service.setMetadata(existingService.getMetadata());
// If there was metadata found through extensions, overwrite historical ones.
if (backup != null) {
existingService.getMetadata().setLabels(backup.getLabels());
existingService.getMetadata().setAnnotations(backup.getAnnotations());
}
// Keep its overriden operation properties.
copyOverridenOperations(existingService, service);
serviceUpdate = true;
}
if (service.getMetadata() == null) {
service.setMetadata(new Metadata());
}
// For services of type EVENT, we should put default values on frequency and bindings.
if (service.getType().equals(ServiceType.EVENT)) {
manageEventServiceDefaults(service);
}
service.getMetadata().objectUpdated();
service.setSourceArtifact(artifactInfo.getArtifactName());
service = serviceRepository.save(service);
// We're dealing with main artifact so reference is saved or updated one.
reference = service;
} else {
// It's a secondary artifact just for messages or metadata. We'll have problems if not having an existing service...
if (existingService == null) {
log.warn("Trying to import {} as a secondary artifact but there's no existing [{}, {}] Service. Just skipping.",
artifactInfo.getArtifactName(), service.getName(), service.getVersion());
break;
}
// If metadata and operation properties found through metadata import,
// update the existing service with them.
if (service.getMetadata() != null) {
existingService.getMetadata().setLabels(service.getMetadata().getLabels());
existingService.getMetadata().setAnnotations(service.getMetadata().getAnnotations());
}
for (Operation operation : service.getOperations()) {
Operation existingOp = existingService.getOperations().stream()
.filter(op -> op.getName().equals(operation.getName())).findFirst().orElse(null);
if (existingOp != null) {
if (operation.getDefaultDelay() != null) {
existingOp.setDefaultDelay(operation.getDefaultDelay());
}
if (operation.getDispatcher() != null) {
existingOp.setDispatcher(operation.getDispatcher());
}
if (operation.getDispatcherRules() != null) {
existingOp.setDispatcherRules(operation.getDispatcherRules());
}
}
}
// We're dealing with secondary artifact so reference is the pre-existing one.
// Moreover, we should replace current imported service (unbound/unsaved)
// by reference in the results list.
reference = existingService;
services.remove(service);
services.add(reference);
}
// Remove resources previously attached to service.
List existingResources = resourceRepository.findByServiceIdAndSourceArtifact(
reference.getId(), artifactInfo.getArtifactName());
if (existingResources != null && existingResources.size() > 0){
resourceRepository.deleteAll(existingResources);
}
// Save new resources.
List resources = importer.getResourceDefinitions(service);
for (Resource resource : resources){
resource.setServiceId(reference.getId());
resource.setSourceArtifact(artifactInfo.getArtifactName());
}
resourceRepository.saveAll(resources);
for (Operation operation : reference.getOperations()){
String operationId = IdBuilder.buildOperationId(reference, operation);
// Remove messages previously attached to service.
requestRepository.deleteAll(requestRepository.findByOperationIdAndSourceArtifact(
operationId, artifactInfo.getArtifactName()));
responseRepository.deleteAll(responseRepository.findByOperationIdAndSourceArtifact(
operationId, artifactInfo.getArtifactName()));
eventMessageRepository.deleteAll(eventMessageRepository.findByOperationIdAndSourceArtifact(
operationId, artifactInfo.getArtifactName()));
List exchanges = importer.getMessageDefinitions(service, operation);
for (Exchange exchange : exchanges) {
if (exchange instanceof RequestResponsePair) {
RequestResponsePair pair = (RequestResponsePair)exchange;
// Associate request and response with operation and artifact.
pair.getRequest().setOperationId(operationId);
pair.getResponse().setOperationId(operationId);
pair.getRequest().setSourceArtifact(artifactInfo.getArtifactName());
pair.getResponse().setSourceArtifact(artifactInfo.getArtifactName());
// Save response and associate request with response before saving it.
responseRepository.save(pair.getResponse());
pair.getRequest().setResponseId(pair.getResponse().getId());
requestRepository.save(pair.getRequest());
} else if (exchange instanceof UnidirectionalEvent) {
UnidirectionalEvent event = (UnidirectionalEvent)exchange;
// Associate event message with operation and artifact before saving it..
event.getEventMessage().setOperationId(operationId);
event.getEventMessage().setSourceArtifact(artifactInfo.getArtifactName());
eventMessageRepository.save(event.getEventMessage());
}
}
}
// When extracting message information, we may have modified Operation because discovered new resource paths
// depending on variable URI parts. As a consequence, we got to update Service in repository.
serviceRepository.save(reference);
// Publish a Service update event before returning.
publishServiceChangeEvent(reference, serviceUpdate ? ChangeType.UPDATED : ChangeType.CREATED);
}
log.info("Having imported {} services definitions into repository", services.size());
return services;
}
/**
* Create a new Service concerning a GenericResource for dynamic mocking.
* @param name The name of the new Service to create
* @param version The version of the new Service to create
* @param resource The resource that will be exposed as CRUD operations for this service
* @return The newly created Service object
* @throws EntityAlreadyExistsException if a Service with same name and version is already present in store
*/
public Service createGenericResourceService(String name, String version, String resource)
throws EntityAlreadyExistsException {
log.info("Creating a new Service '{}-{}' for generic resource {}", name, version, resource);
// Check if corresponding Service already exists.
Service existingService = serviceRepository.findByNameAndVersion(name, version);
if (existingService != null) {
log.warn("A Service '{}-{}' is already existing. Throwing an Exception", name, version);
throw new EntityAlreadyExistsException(String.format("Service '%s-%s' is already present in store", name, version));
}
// Create new service with GENERIC_REST type.
Service service = new Service();
service.setName(name);
service.setVersion(version);
service.setType(ServiceType.GENERIC_REST);
service.setMetadata(new Metadata());
// Now create basic crud operations for the resource.
Operation createOp = new Operation();
createOp.setName("POST /" + resource);
createOp.setMethod("POST");
service.addOperation(createOp);
Operation getOp = new Operation();
getOp.setName("GET /" + resource + "/:id");
getOp.setMethod("GET");
getOp.setDispatcher(DispatchStyles.URI_PARTS);
getOp.setDispatcherRules("id");
service.addOperation(getOp);
Operation updateOp = new Operation();
updateOp.setName("PUT /" + resource + "/:id");
updateOp.setMethod("PUT");
updateOp.setDispatcher(DispatchStyles.URI_PARTS);
updateOp.setDispatcherRules("id");
service.addOperation(updateOp);
Operation listOp = new Operation();
listOp.setName("GET /" + resource);
listOp.setMethod("GET");
service.addOperation(listOp);
Operation delOp = new Operation();
delOp.setName("DELETE /" + resource + "/:id");
delOp.setMethod("DELETE");
delOp.setDispatcher(DispatchStyles.URI_PARTS);
delOp.setDispatcherRules("id");
service.addOperation(delOp);
serviceRepository.save(service);
log.info("Having create Service '{}' for generic resource {}", service.getId(), resource);
return service;
}
/**
* Remove a Service and its bound documents using the service id.
* @param id The identifier of service to remove.
* @param userInfo The current user information to check if authorized to delete
* @return True if service has been found and updated, false otherwise.
*/
public Boolean deleteService(String id, UserInfo userInfo){
// Get service to remove.
Service service = serviceRepository.findById(id).orElse(null);
if (authorizationChecker.hasRole(userInfo, AuthorizationChecker.ROLE_ADMIN)
|| authorizationChecker.hasRoleForService(userInfo, AuthorizationChecker.ROLE_MANAGER, service)) {
// Delete all resources first.
resourceRepository.deleteAll(resourceRepository.findByServiceId(id));
// Delete all requests and responses bound to service operation.
if (service != null) {
for (Operation operation : service.getOperations()) {
String operationId = IdBuilder.buildOperationId(service, operation);
requestRepository.deleteAll(requestRepository.findByOperationId(operationId));
responseRepository.deleteAll(responseRepository.findByOperationId(operationId));
}
}
// Delete all tests related to service.
testResultRepository.deleteAll(testResultRepository.findByServiceId(id));
// Finally delete service and publish event.
serviceRepository.delete(service);
publishServiceChangeEvent(service, ChangeType.DELETED);
log.info("Service [{}] has been fully deleted", id);
return true;
}
return false;
}
/**
* Update the metadata for a Service. Only deals with annotations and labels and
* takes care of updated the lastUpdate marker.
* @param id The identifier of service to update metadata for
* @param metadata The new metadata for this Service
* @param userInfo The current user information to check if authorized to do the update
* @return True if service has been found and updated, false otherwise.
*/
public Boolean updateMetadata(String id, Metadata metadata, UserInfo userInfo) {
Service service = serviceRepository.findById(id).orElse(null);
if (service != null && authorizationChecker.hasRoleForService(userInfo, AuthorizationChecker.ROLE_MANAGER, service)) {
service.getMetadata().setLabels(metadata.getLabels());
service.getMetadata().setAnnotations(metadata.getAnnotations());
service.getMetadata().objectUpdated();
serviceRepository.save(service);
return true;
}
return false;
}
/**
* Update the default delay of a Service operation
* @param id The identifier of service to update operation for
* @param operationName The name of operation to update delay for
* @param dispatcher The dispatcher to use for this operation
* @param dispatcherRules The dispatcher rules to use for this operation
* @param delay The new delay value for operation
* @param constraints Constraints for this operation parameters
* @param userInfo The current user information to check if authorized to do the update
* @return True if operation has been found and updated, false otherwise.
*/
public Boolean updateOperation(String id, String operationName, String dispatcher, String dispatcherRules, Long delay,
List constraints, UserInfo userInfo) {
Service service = serviceRepository.findById(id).orElse(null);
log.debug("Is user allowed? " + authorizationChecker.hasRoleForService(userInfo, AuthorizationChecker.ROLE_MANAGER, service));
if (service != null && authorizationChecker.hasRoleForService(userInfo, AuthorizationChecker.ROLE_MANAGER, service)) {
for (Operation operation : service.getOperations()) {
if (operation.getName().equals(operationName)) {
operation.setDispatcher(dispatcher);
operation.setDispatcherRules(dispatcherRules);
operation.setParameterConstraints(constraints);
operation.setDefaultDelay(delay);
operation.setOverride(true);
serviceRepository.save(service);
// Publish a Service update event before returning.
publishServiceChangeEvent(service, ChangeType.UPDATED);
return true;
}
}
}
return false;
}
/** Recopy overriden operation mutable properties into newService. */
private void copyOverridenOperations(Service existingService, Service newService) {
for (Operation existingOperation : existingService.getOperations()) {
if (existingOperation.hasOverride()) {
for (Operation op : newService.getOperations()) {
if (existingOperation.getName().equals(op.getName())) {
op.setDefaultDelay(existingOperation.getDefaultDelay());
op.setDispatcher(existingOperation.getDispatcher());
op.setDispatcherRules(existingOperation.getDispatcherRules());
op.setParameterConstraints(existingOperation.getParameterConstraints());
op.setOverride(true);
}
}
}
}
}
/** Manage the default values for Service of type EVENT */
private void manageEventServiceDefaults(Service service) {
// For services of type EVENT, we should put default values on frequency and bindings.
if (service.getType().equals(ServiceType.EVENT)) {
for (Operation operation : service.getOperations()) {
if (operation.getDefaultDelay() == null) {
operation.setDefaultDelay(defaultAsyncFrequency);
}
if (operation.getBindings() == null || operation.getBindings().isEmpty()) {
operation.addBinding(defaultAsyncBinding, new Binding(BindingType.valueOf(defaultAsyncBinding)));
}
}
}
}
/** Publish a ServiceChangeEvent towards minions or some other consumers. */
private void publishServiceChangeEvent(Service service, ChangeType changeType) {
ServiceChangeEvent event = new ServiceChangeEvent(this, service.getId(), changeType);
applicationContext.publishEvent(event);
log.debug("Service change event has been published");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy