Skip to content

Commit

Permalink
Merge pull request #2550 from arunans23/service-improvement
Browse files Browse the repository at this point in the history 
Support hot deployment in Service Catalog
  • Loading branch information
@arunans23
arunans23 authored Jan 6, 2022
2 parents 28e527b + 4a7d51d commit c535721
Show file tree
Hide file tree
Showing 7 changed files with 151 additions and 52 deletions.
23 changes: 1 addition & 22 deletions ...in/java/org/wso2/micro/integrator/initializer/deployment/AppDeployerServiceComponent.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
import org.osgi.service.component.annotations.ReferenceCardinality;
import org.osgi.service.component.annotations.ReferencePolicy;
import org.wso2.carbon.securevault.SecretCallbackHandlerService;
import org.wso2.config.mapper.ConfigParser;
import org.wso2.micro.application.deployer.handler.DefaultAppDeployer;
import org.wso2.micro.core.CarbonAxisConfigurator;
import org.wso2.micro.integrator.dataservices.core.DBDeployer;
Expand All @@ -39,18 +38,10 @@
import org.wso2.micro.integrator.initializer.deployment.application.deployer.CappDeployer;
import org.wso2.micro.integrator.initializer.deployment.synapse.deployer.FileRegistryResourceDeployer;
import org.wso2.micro.integrator.initializer.deployment.synapse.deployer.SynapseAppDeployer;
import org.wso2.micro.integrator.initializer.serviceCatalog.ServiceCatalogExecutor;
import org.wso2.micro.integrator.initializer.services.SynapseEnvironmentService;
import org.wso2.micro.integrator.initializer.utils.ConfigurationHolder;
import org.wso2.micro.integrator.ndatasource.capp.deployer.DataSourceCappDeployer;

import java.util.ArrayList;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import static org.wso2.micro.integrator.initializer.utils.Constants.ENABLE;
import static org.wso2.micro.integrator.initializer.utils.Constants.SERVICE_CATALOG_CONFIG;

@Component(name = "org.wso2.micro.integrator.initializer.deployment.AppDeployerServiceComponent", immediate = true)
public class AppDeployerServiceComponent {
Expand Down Expand Up @@ -168,6 +159,7 @@ private void addCAppDeployer(DeploymentEngine deploymentEngine) {
// Initialize CApp deployer here
CappDeployer cappDeployer = new CappDeployer();
cappDeployer.setDirectory(artifactRepoPath + DeploymentConstants.CAPP_DIR_NAME);
cappDeployer.setSecretCallbackHandlerService(secretCallbackHandlerService);
cappDeployer.init(configCtx);

// Register application deployment handlers
Expand Down Expand Up @@ -211,19 +203,6 @@ private void invokeRegisteredDeployers() {
AxisConfigurator axisConfigurator = configCtx.getAxisConfiguration().getConfigurator();
if (axisConfigurator instanceof CarbonAxisConfigurator) {
((CarbonAxisConfigurator) axisConfigurator).deployServices();
Map<String, Object> catalogProperties;
if (ConfigParser.getParsedConfigs().get(SERVICE_CATALOG_CONFIG) != null) {
catalogProperties =
(Map<String, Object>) ((ArrayList) ConfigParser.getParsedConfigs().get(
SERVICE_CATALOG_CONFIG)).get(0);
if ((boolean) catalogProperties.get(ENABLE)) {
String repoLocation = ((CarbonAxisConfigurator) axisConfigurator).getRepoLocation();
ExecutorService executorService = Executors.newSingleThreadExecutor();
executorService.submit(new ServiceCatalogExecutor(repoLocation, secretCallbackHandlerService));
// we are not interested in the result of this thread execution
executorService.shutdown();
}
}
}
}

Expand Down
37 changes: 37 additions & 0 deletions ...a/org/wso2/micro/integrator/initializer/deployment/application/deployer/CappDeployer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,19 @@
import org.apache.synapse.config.SynapseConfigUtils;
import org.apache.synapse.config.SynapseConfiguration;
import org.apache.synapse.api.API;
import org.wso2.carbon.securevault.SecretCallbackHandlerService;
import org.wso2.micro.application.deployer.AppDeployerUtils;
import org.wso2.micro.application.deployer.CarbonApplication;
import org.wso2.micro.application.deployer.config.ApplicationConfiguration;
import org.wso2.micro.application.deployer.config.Artifact;
import org.wso2.micro.application.deployer.handler.AppDeploymentHandler;
import org.wso2.micro.core.CarbonAxisConfigurator;
import org.wso2.micro.core.util.CarbonException;
import org.wso2.micro.core.util.FileManipulator;
import org.wso2.micro.integrator.initializer.dashboard.ArtifactDeploymentListener;
import org.wso2.micro.integrator.initializer.serviceCatalog.ServiceCatalogDeployer;
import org.wso2.micro.integrator.initializer.utils.DeployerUtil;
import org.wso2.micro.integrator.initializer.utils.ServiceCatalogUtils;

import java.io.File;
import java.io.FileInputStream;
Expand All @@ -55,6 +59,8 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
Expand Down Expand Up @@ -86,6 +92,21 @@ public class CappDeployer extends AbstractDeployer {
*/
private String extension;

/**
* Service Catalog Executor threads for publishing Services to Service Catalog.
*/
private ExecutorService serviceCatalogExecutor;

/**
* Map object to store Service Catalog configuration
*/
private Map serviceCatalogConfiguration;

/**
* SecretCallbackHandlerService to read Service Catalog Configs
*/
private SecretCallbackHandlerService secretCallbackHandlerService;

public void init(ConfigurationContext configurationContext) {
if (log.isDebugEnabled()) {
log.debug("Initializing Capp Deployer..");
Expand All @@ -96,6 +117,12 @@ public void init(ConfigurationContext configurationContext) {
String appUnzipDir = AppDeployerUtils.getAppUnzipDir() + File.separator +
AppDeployerUtils.getTenantIdString();
FileManipulator.deleteDir(appUnzipDir);

if (ServiceCatalogUtils.isServiceCatalogEnabled()) {
serviceCatalogConfiguration = ServiceCatalogUtils.readConfiguration(secretCallbackHandlerService);
serviceCatalogExecutor = Executors.newFixedThreadPool(
ServiceCatalogUtils.getExecutorThreadCount(serviceCatalogConfiguration, 10));
}
}

public void setDirectory(String cAppDir) {
Expand Down Expand Up @@ -193,6 +220,12 @@ private void deployCarbonApps(String artifactPath) throws CarbonException {
faultyCAppObjects.add(currentApp);
faultyCapps.add(cAppName);
}
if (serviceCatalogConfiguration != null && !faultyCapps.contains(cAppName)) {
ServiceCatalogDeployer serviceDeployer = new ServiceCatalogDeployer(cAppName,
((CarbonAxisConfigurator) axisConfig.getAxisConfiguration().getConfigurator()).getRepoLocation(),
serviceCatalogConfiguration);
serviceCatalogExecutor.execute(serviceDeployer);
}
}

/**
Expand Down Expand Up @@ -658,6 +691,10 @@ public void cleanup() {
faultyCAppObjects.clear();
}

public void setSecretCallbackHandlerService(SecretCallbackHandlerService secretCallbackHandlerService) {
this.secretCallbackHandlerService = secretCallbackHandlerService;
}

/**
* Partially building the API to get the API name
*
Expand Down
44 changes: 23 additions & 21 deletions ...erviceCatalog/ServiceCatalogExecutor.java → ...erviceCatalog/ServiceCatalogDeployer.java
View file
Original file line number Diff line number Diff line change
@@ -1,45 +1,47 @@
/*
* Copyright (c) 2021, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
* Copyright (c) 2022, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
* WSO2 Inc. 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
* WSO2 Inc. 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
* 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
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.wso2.micro.integrator.initializer.serviceCatalog;

import org.wso2.carbon.securevault.SecretCallbackHandlerService;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.io.File;
import java.util.Map;

import static org.wso2.micro.integrator.initializer.utils.Constants.*;
import static org.wso2.micro.integrator.initializer.utils.Constants.SERVICE_CATALOG;
import static org.wso2.micro.integrator.initializer.utils.ServiceCatalogUtils.*;
import static org.wso2.micro.integrator.initializer.utils.ServiceCatalogUtils.publishToAPIM;

/**
* This class will publish the metadata to the service catalog in a separate thread.
*/
public class ServiceCatalogExecutor implements Runnable {

public class ServiceCatalogDeployer implements Runnable {

private static final Log log = LogFactory.getLog(ServiceCatalogDeployer.class);
private static final String CAPP_UNZIP_DIR;

private final String cAppName;
private final Map serviceCatalogConfiguration;
private final String repoLocation;
private final SecretCallbackHandlerService secretCallbackHandlerService;

public ServiceCatalogExecutor(String repoLocation,
SecretCallbackHandlerService secretCallbackHandlerService) {
public ServiceCatalogDeployer(String name, String repoLocation, Map serviceCatalogConfiguration) {
this.cAppName = name;
this.repoLocation = repoLocation;
this.secretCallbackHandlerService = secretCallbackHandlerService;
this.serviceCatalogConfiguration = serviceCatalogConfiguration;
}

static {
Expand All @@ -50,13 +52,13 @@ public ServiceCatalogExecutor(String repoLocation,

@Override
public void run() {
log.info("Executing Service Catalog deployer for CApp : " + cAppName);

// check pre-conditions
if (!checkPreConditions()) return;

Map<String, String> apimConfigs = readConfiguration(secretCallbackHandlerService);

// call service catalog and get all services
Map<String, String> md5MapOfAllService = getAllServices(apimConfigs);
Map<String, String> md5MapOfAllService = getAllServices(serviceCatalogConfiguration);
if (md5MapOfAllService == null) return; // error occurred while getting all services

// create temporary directory to hold metadata.
Expand All @@ -71,6 +73,6 @@ public void run() {
if (!archiveDir(CAPP_UNZIP_DIR + File.separator + ZIP_FOLDER_NAME, tempDir.getPath())) return;

// publish to service catalog endpoint.
publishToAPIM(apimConfigs, CAPP_UNZIP_DIR + File.separator + ZIP_FOLDER_NAME);
publishToAPIM(serviceCatalogConfiguration, CAPP_UNZIP_DIR + File.separator + ZIP_FOLDER_NAME);
}
}
1 change: 1 addition & 0 deletions ...ator.initializer/src/main/java/org/wso2/micro/integrator/initializer/utils/Constants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ public class Constants {
public static final String ENABLE = "enable";
public static final String USER_NAME = "username";
public static final String PASSWORD = "password";
public static final String SERVICE_CATALOG_EXECUTOR_THREADS = "executor_threads";

public static final String SERVICE_CATALOG_PUBLISH_ENDPOINT = "api/am/service-catalog/v0/services/import?overwrite" +
"=true";
Expand Down
51 changes: 50 additions & 1 deletion ...alizer/src/main/java/org/wso2/micro/integrator/initializer/utils/ServiceCatalogUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ public static Map<String, String> readConfiguration(SecretCallbackHandlerService

String userName = catalogProperties.get(USER_NAME);
String password = catalogProperties.get(PASSWORD);
String executorThreads = catalogProperties.get(SERVICE_CATALOG_EXECUTOR_THREADS);
if (secretResolver == null) {
secretResolver = SecretResolverFactory.create((OMElement) null, false);
}
Expand All @@ -402,6 +403,7 @@ public static Map<String, String> readConfiguration(SecretCallbackHandlerService
configMap.put(APIM_HOST, apimHost);
configMap.put(USER_NAME, userName);
configMap.put(PASSWORD, password);
configMap.put(SERVICE_CATALOG_EXECUTOR_THREADS, executorThreads);
return configMap;
}

Expand Down Expand Up @@ -575,7 +577,7 @@ public static boolean archiveDir(String destArchiveName, String sourceDir) {
if (alreadyUploaded) {
log.info("Service catalog already contains the latest configs, aborting the service-catalog uploader");
} else {
log.info("Could not find metadata to upload, aborting the service-catalog uploader");
log.info("Metadata not included, hence not publishing to Service Catalog");
}
return false;
}
Expand Down Expand Up @@ -871,4 +873,51 @@ private static String getProxyServiceUrlFromMetadata(File yamlFile) {
}
return currentServiceUrl;
}

/**
* Checks whether Service Catalog configuration is Enabled.
*
* @return whether Service Catalog is enabled.
*/
public static boolean isServiceCatalogEnabled() {
Map<String, Object> catalogProperties;
if (ConfigParser.getParsedConfigs().get(SERVICE_CATALOG_CONFIG) != null) {
catalogProperties =
(Map<String, Object>) ((ArrayList) ConfigParser.getParsedConfigs().get(
SERVICE_CATALOG_CONFIG)).get(0);
if ((boolean) catalogProperties.get(ENABLE)) {
return true;
}
}
return false;
}

/**
* Retrieve Executor Thread configuration for Service Catalog.
*
* @param serviceCatalogConfig Map containing deployment.toml configuration
* @param def Default value
*
* @return Executor Thread count.
*/
public static int getExecutorThreadCount(Map<String, String> serviceCatalogConfig, int def) {
String executorThreads = serviceCatalogConfig.get(SERVICE_CATALOG_EXECUTOR_THREADS);
int threads;
if (executorThreads != null) {
try {
threads = Integer.parseInt(executorThreads);
if (log.isDebugEnabled()) {
log.debug("Service Catalog Executor Thread count is set to " + threads);
}
} catch (NumberFormatException e) {
log.warn("Invalid Service Catalog Executor Thread count. Setting to default " + def);
return def;
}
return threads ;
}
if (log.isDebugEnabled()) {
log.debug("Service Catalog Executor Thread count is not defined. Setting to default " + def);
}
return def;
}
}
Loading

0 comments on commit c535721

Please sign in to comment.