-/**\r
- * Copyright 2017 ZTE Corporation.\r
- *\r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-package org.onap.holmes.engine.manager;\r
-\r
-\r
-import java.io.StringReader;\r
-import java.util.HashSet;\r
-import java.util.List;\r
-import java.util.Locale;\r
-import java.util.Set;\r
-import javax.annotation.PostConstruct;\r
-import javax.inject.Inject;\r
-import lombok.extern.slf4j.Slf4j;\r
-import org.drools.KnowledgeBase;\r
-import org.drools.KnowledgeBaseConfiguration;\r
-import org.drools.KnowledgeBaseFactory;\r
-import org.drools.builder.KnowledgeBuilder;\r
-import org.drools.builder.KnowledgeBuilderFactory;\r
-import org.drools.builder.ResourceType;\r
-import org.drools.conf.EventProcessingOption;\r
-import org.drools.definition.KnowledgePackage;\r
-import org.drools.io.Resource;\r
-import org.drools.io.ResourceFactory;\r
-import org.drools.runtime.StatefulKnowledgeSession;\r
-import org.drools.runtime.rule.FactHandle;\r
-import org.jvnet.hk2.annotations.Service;\r
-import org.onap.holmes.common.api.stat.VesAlarm;\r
-import org.onap.holmes.engine.request.DeployRuleRequest;\r
-import org.onap.holmes.common.api.entity.CorrelationRule;\r
-import org.onap.holmes.common.exception.CorrelationException;\r
-import org.onap.holmes.common.utils.ExceptionUtil;\r
-import org.onap.holmes.engine.wrapper.RuleMgtWrapper;\r
-\r
-@Slf4j\r
-@Service\r
-public class DroolsEngine {\r
-\r
- private final static int ENABLE = 1;\r
- private final Set<String> packageNames = new HashSet<String>();\r
- @Inject\r
- private RuleMgtWrapper ruleMgtWrapper;\r
- private KnowledgeBase kbase;\r
- private KnowledgeBaseConfiguration kconf;\r
- private StatefulKnowledgeSession ksession;\r
-\r
- @PostConstruct\r
- private void init() {\r
- try {\r
- // start engine\r
- start();\r
- } catch (Exception e) {\r
- log.error("Failed to start the service: " + e.getMessage(), e);\r
- throw ExceptionUtil.buildExceptionResponse("Failed to start the drools engine!");\r
- }\r
- }\r
-\r
- private void start() throws CorrelationException {\r
- log.info("Drools Engine Initialize Beginning...");\r
-\r
- initEngineParameter();\r
- initDeployRule();\r
-\r
- log.info("Business Rule Engine Initialize Successfully.");\r
- }\r
-\r
- public void stop() {\r
- this.ksession.dispose();\r
- }\r
-\r
- private void initEngineParameter() {\r
- this.kconf = KnowledgeBaseFactory.newKnowledgeBaseConfiguration();\r
-\r
- this.kconf.setOption(EventProcessingOption.STREAM);\r
-\r
- this.kconf.setProperty("drools.assertBehaviour", "equality");\r
-\r
- this.kbase = KnowledgeBaseFactory.newKnowledgeBase("D-ENGINE", this.kconf);\r
-\r
- this.ksession = kbase.newStatefulKnowledgeSession();\r
- }\r
-\r
- private void initDeployRule() throws CorrelationException {\r
- List<CorrelationRule> rules = ruleMgtWrapper.queryRuleByEnable(ENABLE);\r
-\r
- if (rules.isEmpty()) {\r
- return;\r
- }\r
- for (CorrelationRule rule : rules) {\r
- if (rule.getContent() != null) {\r
- deployRuleFromDB(rule.getContent());\r
- }\r
- }\r
- }\r
-\r
- private void deployRuleFromDB(String ruleContent) throws CorrelationException {\r
- StringReader reader = new StringReader(ruleContent);\r
- Resource res = ResourceFactory.newReaderResource(reader);\r
-\r
- KnowledgeBuilder kbuilder = KnowledgeBuilderFactory.newKnowledgeBuilder();\r
-\r
- kbuilder.add(res, ResourceType.DRL);\r
-\r
- try {\r
-\r
- kbase.addKnowledgePackages(kbuilder.getKnowledgePackages());\r
- } catch (Exception e) {\r
- throw new CorrelationException(e.getMessage(), e);\r
- }\r
- ksession.fireAllRules();\r
- }\r
-\r
- public synchronized String deployRule(DeployRuleRequest rule, Locale locale)\r
- throws CorrelationException {\r
- StringReader reader = new StringReader(rule.getContent());\r
- Resource res = ResourceFactory.newReaderResource(reader);\r
-\r
- KnowledgeBuilder kbuilder = KnowledgeBuilderFactory.newKnowledgeBuilder();\r
-\r
- kbuilder.add(res, ResourceType.DRL);\r
-\r
- judgeRuleContent(locale, kbuilder, true);\r
-\r
- String packageName = kbuilder.getKnowledgePackages().iterator().next().getName();\r
- try {\r
- packageNames.add(packageName);\r
- kbase.addKnowledgePackages(kbuilder.getKnowledgePackages());\r
- } catch (Exception e) {\r
- throw new CorrelationException("Failed to deploy the rule.", e);\r
- }\r
-\r
- ksession.fireAllRules();\r
- return packageName;\r
- }\r
-\r
- public synchronized void undeployRule(String packageName, Locale locale)\r
- throws CorrelationException {\r
-\r
- KnowledgePackage pkg = kbase.getKnowledgePackage(packageName);\r
-\r
- if (null == pkg) {\r
- throw new CorrelationException("The rule " + packageName + " does not exist!");\r
- }\r
-\r
- try {\r
- kbase.removeKnowledgePackage(pkg.getName());\r
- } catch (Exception e) {\r
- throw new CorrelationException("Failed to delete the rule: " + packageName, e);\r
- }\r
- packageNames.remove(pkg.getName());\r
- }\r
-\r
- public void compileRule(String content, Locale locale)\r
- throws CorrelationException {\r
- StringReader reader = new StringReader(content);\r
- Resource res = ResourceFactory.newReaderResource(reader);\r
-\r
- KnowledgeBuilder kbuilder = KnowledgeBuilderFactory.newKnowledgeBuilder();\r
-\r
- kbuilder.add(res, ResourceType.DRL);\r
-\r
- judgeRuleContent(locale, kbuilder, false);\r
- }\r
-\r
- private void judgeRuleContent(Locale locale, KnowledgeBuilder kbuilder, boolean judgePackageName)\r
- throws CorrelationException {\r
- if (kbuilder.hasErrors()) {\r
- String errorMsg = "There are errors in the rule: " + kbuilder.getErrors().toString();\r
- log.error(errorMsg);\r
- throw new CorrelationException(errorMsg);\r
- }\r
-\r
- String packageName = kbuilder.getKnowledgePackages().iterator().next().getName();\r
-\r
- if (packageNames.contains(packageName) && judgePackageName) {\r
- throw new CorrelationException("The rule " + packageName + " already exists in the drools engine.");\r
- }\r
- }\r
-\r
- public void putRaisedIntoStream(VesAlarm raiseAlarm) {\r
- FactHandle factHandle = this.ksession.getFactHandle(raiseAlarm);\r
- if (factHandle != null) {\r
- Object obj = this.ksession.getObject(factHandle);\r
- if (obj != null && obj instanceof VesAlarm) {\r
- raiseAlarm.setRootFlag(((VesAlarm) obj).getRootFlag());\r
- }\r
- this.ksession.retract(factHandle);\r
- }\r
- this.ksession.insert(raiseAlarm);\r
- this.ksession.fireAllRules();\r
- }\r
-\r
-}\r
+/**
+ * Copyright 2017 ZTE Corporation.
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.onap.holmes.engine.manager;
+
+import lombok.extern.slf4j.Slf4j;
+import org.drools.compiler.kie.builder.impl.InternalKieModule;
+import org.drools.core.util.StringUtils;
+import org.kie.api.KieServices;
+import org.kie.api.builder.*;
+import org.kie.api.builder.Message.Level;
+import org.kie.api.builder.model.KieBaseModel;
+import org.kie.api.builder.model.KieModuleModel;
+import org.kie.api.builder.model.KieSessionModel;
+import org.kie.api.conf.EqualityBehaviorOption;
+import org.kie.api.io.Resource;
+import org.kie.api.runtime.KieContainer;
+import org.kie.api.runtime.KieSession;
+import org.kie.api.runtime.rule.FactHandle;
+import org.onap.holmes.common.api.entity.AlarmInfo;
+import org.onap.holmes.common.api.entity.CorrelationRule;
+import org.onap.holmes.common.api.stat.VesAlarm;
+import org.onap.holmes.common.config.MicroServiceConfig;
+import org.onap.holmes.common.dmaap.store.ClosedLoopControlNameCache;
+import org.onap.holmes.common.exception.AlarmInfoException;
+import org.onap.holmes.common.exception.CorrelationException;
+import org.onap.holmes.common.utils.ExceptionUtil;
+import org.onap.holmes.engine.db.AlarmInfoDaoService;
+import org.onap.holmes.engine.request.DeployRuleRequest;
+import org.onap.holmes.engine.wrapper.RuleMgtWrapper;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.ApplicationArguments;
+import org.springframework.boot.ApplicationRunner;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.stream.Collectors;
+
+@Slf4j
+@Component
+public class DroolsEngine implements ApplicationRunner {
+ private final static int ENABLE = 1;
+ private final Map<String, String> deployed = new ConcurrentHashMap<>();
+ private RuleMgtWrapper ruleMgtWrapper;
+ private ClosedLoopControlNameCache closedLoopControlNameCache;
+ private AlarmInfoDaoService alarmInfoDaoService;
+ private KieServices ks = KieServices.Factory.get();
+ private ReleaseId releaseId = ks.newReleaseId("org.onap.holmes", "rules", "1.0.0-SNAPSHOT");
+ private ReleaseId compilationRelease = ks.newReleaseId("org.onap.holmes", "compilation", "1.0.0-SNAPSHOT");
+ private KieContainer container;
+ private KieSession session;
+ private String instanceIp;
+
+ @Autowired
+ public void setAlarmInfoDaoService(AlarmInfoDaoService alarmInfoDaoService) {
+ this.alarmInfoDaoService = alarmInfoDaoService;
+ }
+
+ @Autowired
+ public void setRuleMgtWrapper(RuleMgtWrapper ruleMgtWrapper) {
+ this.ruleMgtWrapper = ruleMgtWrapper;
+ }
+
+ @Autowired
+ public void setClosedLoopControlNameCache(ClosedLoopControlNameCache closedLoopControlNameCache) {
+ this.closedLoopControlNameCache = closedLoopControlNameCache;
+ }
+
+ @Override
+ public void run(ApplicationArguments args) {
+ instanceIp = MicroServiceConfig.getMicroServiceIpAndPort()[0];
+ try {
+ log.info("Drools engine initializing...");
+ initEngine();
+ log.info("Drools engine initialized.");
+
+ log.info("Start deploy existing rules...");
+ initRules();
+ log.info("All rules were deployed.");
+
+ log.info("Synchronizing alarms...");
+ syncAlarms();
+ log.info("Alarm synchronization succeeded.");
+ } catch (Exception e) {
+ log.error("Failed to startup the engine of Holmes: " + e.getMessage(), e);
+ throw ExceptionUtil.buildExceptionResponse("Failed to startup Drools!");
+ }
+ }
+
+ public void stop() {
+ session.dispose();
+ }
+
+ public void initEngine() {
+ KieModule km = null;
+ try {
+ String drl = "package holmes;";
+ deployed.put(getPackageName(drl), drl);
+ km = createAndDeployJar(ks, releaseId, new ArrayList<>(deployed.values()));
+ } catch (Exception e) {
+ log.error("Failed to initialize the engine service module.", e);
+ }
+ if (null != km) {
+ container = ks.newKieContainer(km.getReleaseId());
+ }
+ session = container.newKieSession();
+ deployed.clear();
+ }
+
+ private void initRules() throws CorrelationException {
+ List<CorrelationRule> rules = ruleMgtWrapper.queryRuleByEnable(ENABLE)
+ .stream()
+ .filter(r -> r.getEngineInstance().equals(instanceIp))
+ .collect(Collectors.toList());
+
+ if (rules.isEmpty()) {
+ return;
+ }
+
+ for (CorrelationRule rule : rules) {
+ if (!StringUtils.isEmpty(rule.getContent())) {
+ deployRule(rule.getContent());
+ closedLoopControlNameCache.put(rule.getPackageName(), rule.getClosedControlLoopName());
+ }
+ }
+
+ session.fireAllRules();
+ }
+
+ public void syncAlarms() throws AlarmInfoException {
+ alarmInfoDaoService.queryAllAlarm().forEach(alarmInfo -> putRaisedIntoStream(convertAlarmInfo2VesAlarm(alarmInfo)));
+ }
+
+ public String deployRule(DeployRuleRequest rule) throws CorrelationException {
+ return deployRule(rule.getContent());
+ }
+
+ private synchronized String deployRule(String rule) throws CorrelationException {
+ final String packageName = getPackageName(rule);
+
+ if (StringUtils.isEmpty(packageName)) {
+ throw new CorrelationException("The package name can not be empty.");
+ }
+
+ if (deployed.containsKey(packageName)) {
+ throw new CorrelationException("A rule with the same package name already exists in the system.");
+ }
+
+ if (!StringUtils.isEmpty(rule)) {
+ deployed.put(packageName, rule);
+ try {
+ refreshInMemRules();
+ } catch (CorrelationException e) {
+ deployed.remove(packageName);
+ throw e;
+ }
+ session.fireAllRules();
+ }
+
+ return packageName;
+ }
+
+ public synchronized void undeployRule(String packageName) throws CorrelationException {
+
+ if (StringUtils.isEmpty(packageName)) {
+ throw new CorrelationException("The package name should not be null.");
+ }
+
+ if (!deployed.containsKey(packageName)) {
+ throw new CorrelationException("The rule " + packageName + " does not exist!");
+ }
+
+ String removed = deployed.remove(packageName);
+ try {
+ refreshInMemRules();
+ } catch (Exception e) {
+ deployed.put(packageName, removed);
+ throw new CorrelationException("Failed to delete the rule: " + packageName, e);
+ }
+ }
+
+ private void refreshInMemRules() throws CorrelationException {
+ KieModule km = createAndDeployJar(ks, releaseId, new ArrayList<>(deployed.values()));
+ container.updateToVersion(km.getReleaseId());
+ }
+
+ public void compileRule(String content)
+ throws CorrelationException {
+
+ KieFileSystem kfs = ks.newKieFileSystem().generateAndWritePomXML(compilationRelease);
+ kfs.write("src/main/resources/rules/rule.drl", content);
+ KieBuilder builder = ks.newKieBuilder(kfs).buildAll();
+ if (builder.getResults().hasMessages(Message.Level.ERROR)) {
+ String errorMsg = "There are errors in the rule: " + builder.getResults()
+ .getMessages(Level.ERROR).toString();
+ log.info("Compilation failure: " + errorMsg);
+ throw new CorrelationException(errorMsg);
+ }
+
+ if (deployed.containsKey(getPackageName(content))) {
+ throw new CorrelationException("There's no compilation error. But a rule with the same package name already " +
+ "exists in the engine, which may cause a deployment failure.");
+ }
+
+ ks.getRepository().removeKieModule(compilationRelease);
+ }
+
+ public void putRaisedIntoStream(VesAlarm alarm) {
+ FactHandle factHandle = this.session.getFactHandle(alarm);
+ if (factHandle != null) {
+ Object obj = this.session.getObject(factHandle);
+ if (obj != null && obj instanceof VesAlarm) {
+ alarm.setRootFlag(((VesAlarm) obj).getRootFlag());
+ }
+ this.session.delete(factHandle);
+ }
+
+ this.session.insert(alarm);
+
+ this.session.fireAllRules();
+ }
+
+ public List<String> queryPackagesFromEngine() {
+ return container.getKieBase().getKiePackages().stream()
+ .filter(pkg -> pkg.getRules().size() != 0)
+ .map(pkg -> pkg.getName())
+ .collect(Collectors.toList());
+ }
+
+ private VesAlarm convertAlarmInfo2VesAlarm(AlarmInfo alarmInfo) {
+ VesAlarm vesAlarm = new VesAlarm();
+ vesAlarm.setEventId(alarmInfo.getEventId());
+ vesAlarm.setEventName(alarmInfo.getEventName());
+ vesAlarm.setStartEpochMicrosec(alarmInfo.getStartEpochMicroSec());
+ vesAlarm.setSourceId(alarmInfo.getSourceId());
+ vesAlarm.setSourceName(alarmInfo.getSourceName());
+ vesAlarm.setRootFlag(alarmInfo.getRootFlag());
+ vesAlarm.setAlarmIsCleared(alarmInfo.getAlarmIsCleared());
+ vesAlarm.setLastEpochMicrosec(alarmInfo.getLastEpochMicroSec());
+ return vesAlarm;
+ }
+
+ private AlarmInfo convertVesAlarm2AlarmInfo(VesAlarm vesAlarm) {
+ AlarmInfo alarmInfo = new AlarmInfo();
+ alarmInfo.setEventId(vesAlarm.getEventId());
+ alarmInfo.setEventName(vesAlarm.getEventName());
+ alarmInfo.setStartEpochMicroSec(vesAlarm.getStartEpochMicrosec());
+ alarmInfo.setLastEpochMicroSec(vesAlarm.getLastEpochMicrosec());
+ alarmInfo.setSourceId(vesAlarm.getSourceId());
+ alarmInfo.setSourceName(vesAlarm.getSourceName());
+ alarmInfo.setAlarmIsCleared(vesAlarm.getAlarmIsCleared());
+ alarmInfo.setRootFlag(vesAlarm.getRootFlag());
+
+ return alarmInfo;
+ }
+
+ private String getPackageName(String contents) {
+ String ret = contents.trim();
+ StringBuilder stringBuilder = new StringBuilder();
+ if (ret.startsWith("package")) {
+ ret = ret.substring(7).trim();
+ for (int i = 0; i < ret.length(); i++) {
+ char tmp = ret.charAt(i);
+ if (tmp == ';' || tmp == ' ' || tmp == '\n') {
+ break;
+ }
+ stringBuilder.append(tmp);
+ }
+ }
+ return stringBuilder.toString();
+ }
+
+ private KieModule createAndDeployJar(KieServices ks, ReleaseId releaseId, List<String> drls) throws CorrelationException {
+ byte[] jar = createJar(ks, releaseId, drls);
+ KieModule km = deployJarIntoRepository(ks, jar);
+ return km;
+ }
+
+ private byte[] createJar(KieServices ks, ReleaseId releaseId, List<String> drls) throws CorrelationException {
+ KieModuleModel kieModuleModel = ks.newKieModuleModel();
+ KieBaseModel kieBaseModel = kieModuleModel.newKieBaseModel("KBase")
+ .setDefault(true)
+ .setEqualsBehavior(EqualityBehaviorOption.EQUALITY);
+ kieBaseModel.newKieSessionModel("KSession")
+ .setDefault(true)
+ .setType(KieSessionModel.KieSessionType.STATEFUL);
+ KieFileSystem kfs = ks.newKieFileSystem().writeKModuleXML(kieModuleModel.toXML()).generateAndWritePomXML(releaseId);
+
+ int i = 0;
+ for (String drl : drls) {
+ if (!StringUtils.isEmpty(drl)) {
+ kfs.write("src/main/resources/" + getPackageName(drl) + ".drl", drl);
+ }
+ }
+ KieBuilder kb = ks.newKieBuilder(kfs).buildAll();
+ if (kb.getResults().hasMessages(Message.Level.ERROR)) {
+ StringBuilder sb = new StringBuilder();
+ for (Message msg : kb.getResults().getMessages()) {
+ sb.append(String.format("[%s]Line: %d, Col: %d\t%s\n", msg.getLevel().toString(), msg.getLine(),
+ msg.getColumn(), msg.getText()));
+ }
+ throw new CorrelationException("Failed to compile JAR. Details: \n" + sb.toString());
+ }
+
+ InternalKieModule kieModule = (InternalKieModule) ks.getRepository()
+ .getKieModule(releaseId);
+
+ return kieModule.getBytes();
+ }
+
+ private KieModule deployJarIntoRepository(KieServices ks, byte[] jar) {
+ Resource jarRes = ks.getResources().newByteArrayResource(jar);
+ return ks.getRepository().addKieModule(jarRes);
+ }
+}