BIGTOP-4332: Add templates to service metainfo indicates user unmodif…

…iable files (#152)

bigtop-manager-grpc/src/main/java/org/apache/bigtop/manager/grpc/payload/ComponentCommandPayload.java

@@ -19,6 +19,7 @@
 package org.apache.bigtop.manager.grpc.payload;
 
 import org.apache.bigtop.manager.grpc.pojo.PackageSpecificInfo;
+import org.apache.bigtop.manager.grpc.pojo.TemplateInfo;
 
 import lombok.Data;
 
@@ -44,6 +45,8 @@ public class ComponentCommandPayload {
 
     private List<PackageSpecificInfo> packageSpecifics;
 
+    private List<TemplateInfo> templates;
+
     /**
      * This field is exclusively used for Prometheus and Grafana within the infra services.
      * Includes cluster and corresponding hostname.

bigtop-manager-grpc/src/main/java/org/apache/bigtop/manager/grpc/pojo/TemplateInfo.java

@@ -0,0 +1,31 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF 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
+ *
+ *    https://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 org.apache.bigtop.manager.grpc.pojo;
+
+import lombok.Data;
+
+@Data
+public class TemplateInfo {
+
+    private String src;
+
+    private String dest;
+
+    private String content;
+}

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/helper/ComponentStageHelper.java

@@ -31,7 +31,6 @@
 import org.apache.bigtop.manager.server.command.task.Task;
 import org.apache.bigtop.manager.server.exception.ServerException;
 import org.apache.bigtop.manager.server.model.dto.CommandDTO;
-import org.apache.bigtop.manager.server.model.dto.ComponentDTO;
 import org.apache.bigtop.manager.server.model.dto.ServiceDTO;
 import org.apache.bigtop.manager.server.utils.StackUtils;
 
@@ -121,11 +120,10 @@ private static StageContext createStageContext(
         StageContext stageContext = StageContext.fromCommandDTO(commandDTO);
 
         ServiceDTO serviceDTO = StackUtils.getServiceDTOByComponentName(componentName);
-        ComponentDTO componentDTO = StackUtils.getComponentDTO(componentName);
 
         stageContext.setHostnames(hostnames);
-        stageContext.setServiceDTO(serviceDTO);
-        stageContext.setComponentDTO(componentDTO);
+        stageContext.setServiceName(serviceDTO.getName());
+        stageContext.setComponentName(componentName);
 
         return stageContext;
     }

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/AbstractComponentStage.java

@@ -25,6 +25,7 @@
 import org.apache.bigtop.manager.server.holder.SpringContextHolder;
 import org.apache.bigtop.manager.server.model.dto.ComponentDTO;
 import org.apache.bigtop.manager.server.model.dto.ServiceDTO;
+import org.apache.bigtop.manager.server.utils.StackUtils;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -55,17 +56,17 @@ protected void beforeCreateTasks() {
 
     @Override
     protected String getServiceName() {
-        return stageContext.getServiceDTO().getName();
+        return stageContext.getServiceName();
     }
 
     @Override
     protected String getComponentName() {
-        return stageContext.getComponentDTO().getName();
+        return stageContext.getComponentName();
     }
 
     protected TaskContext createTaskContext(String hostname) {
-        ServiceDTO serviceDTO = stageContext.getServiceDTO();
-        ComponentDTO componentDTO = stageContext.getComponentDTO();
+        ServiceDTO serviceDTO = StackUtils.getServiceDTO(stageContext.getServiceName());
+        ComponentDTO componentDTO = StackUtils.getComponentDTO(stageContext.getComponentName());
 
         TaskContext taskContext = new TaskContext();
         taskContext.setHostname(hostname);
@@ -79,7 +80,6 @@ protected TaskContext createTaskContext(String hostname) {
         taskContext.setRootDir(clusterPO.getRootDir());
 
         Map<String, Object> properties = new HashMap<>();
-        properties.put("packageSpecifics", serviceDTO.getPackageSpecifics());
         properties.put("clusterHosts", getClusterHosts());
         taskContext.setProperties(properties);
         return taskContext;

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/ComponentAddStage.java

@@ -20,6 +20,7 @@
 
 import org.apache.bigtop.manager.server.command.task.ComponentAddTask;
 import org.apache.bigtop.manager.server.command.task.Task;
+import org.apache.bigtop.manager.server.utils.StackUtils;
 
 public class ComponentAddStage extends AbstractComponentStage {
 
@@ -34,6 +35,7 @@ protected Task createTask(String hostname) {
 
     @Override
     public String getName() {
-        return "Add " + stageContext.getComponentDTO().getDisplayName();
+        return "Add "
+                + StackUtils.getComponentDTO(stageContext.getComponentName()).getDisplayName();
     }
 }

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/ComponentCheckStage.java

@@ -20,6 +20,7 @@
 
 import org.apache.bigtop.manager.server.command.task.ComponentCheckTask;
 import org.apache.bigtop.manager.server.command.task.Task;
+import org.apache.bigtop.manager.server.utils.StackUtils;
 
 public class ComponentCheckStage extends AbstractComponentStage {
 
@@ -34,6 +35,7 @@ protected Task createTask(String hostname) {
 
     @Override
     public String getName() {
-        return "Check " + stageContext.getComponentDTO().getDisplayName();
+        return "Check "
+                + StackUtils.getComponentDTO(stageContext.getComponentName()).getDisplayName();
     }
 }

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/ComponentConfigureStage.java

@@ -20,6 +20,7 @@
 
 import org.apache.bigtop.manager.server.command.task.ComponentConfigureTask;
 import org.apache.bigtop.manager.server.command.task.Task;
+import org.apache.bigtop.manager.server.utils.StackUtils;
 
 public class ComponentConfigureStage extends AbstractComponentStage {
 
@@ -34,6 +35,7 @@ protected Task createTask(String hostname) {
 
     @Override
     public String getName() {
-        return "Configure " + stageContext.getComponentDTO().getDisplayName();
+        return "Configure "
+                + StackUtils.getComponentDTO(stageContext.getComponentName()).getDisplayName();
     }
 }

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/ComponentInitStage.java

@@ -20,6 +20,7 @@
 
 import org.apache.bigtop.manager.server.command.task.ComponentInitTask;
 import org.apache.bigtop.manager.server.command.task.Task;
+import org.apache.bigtop.manager.server.utils.StackUtils;
 
 public class ComponentInitStage extends AbstractComponentStage {
 
@@ -34,6 +35,7 @@ protected Task createTask(String hostname) {
 
     @Override
     public String getName() {
-        return "Init " + stageContext.getComponentDTO().getDisplayName();
+        return "Init "
+                + StackUtils.getComponentDTO(stageContext.getComponentName()).getDisplayName();
     }
 }

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/ComponentPrepareStage.java

@@ -20,6 +20,7 @@
 
 import org.apache.bigtop.manager.server.command.task.ComponentPrepareTask;
 import org.apache.bigtop.manager.server.command.task.Task;
+import org.apache.bigtop.manager.server.utils.StackUtils;
 
 public class ComponentPrepareStage extends AbstractComponentStage {
 
@@ -34,6 +35,7 @@ protected Task createTask(String hostname) {
 
     @Override
     public String getName() {
-        return "Prepare " + stageContext.getComponentDTO().getDisplayName();
+        return "Prepare "
+                + StackUtils.getComponentDTO(stageContext.getComponentName()).getDisplayName();
     }
 }

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/ComponentStartStage.java

@@ -20,6 +20,7 @@
 
 import org.apache.bigtop.manager.server.command.task.ComponentStartTask;
 import org.apache.bigtop.manager.server.command.task.Task;
+import org.apache.bigtop.manager.server.utils.StackUtils;
 
 public class ComponentStartStage extends AbstractComponentStage {
 
@@ -34,6 +35,7 @@ protected Task createTask(String hostname) {
 
     @Override
     public String getName() {
-        return "Start " + stageContext.getComponentDTO().getDisplayName();
+        return "Start "
+                + StackUtils.getComponentDTO(stageContext.getComponentName()).getDisplayName();
     }
 }

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/ComponentStopStage.java

@@ -20,6 +20,7 @@
 
 import org.apache.bigtop.manager.server.command.task.ComponentStopTask;
 import org.apache.bigtop.manager.server.command.task.Task;
+import org.apache.bigtop.manager.server.utils.StackUtils;
 
 public class ComponentStopStage extends AbstractComponentStage {
 
@@ -34,6 +35,7 @@ protected Task createTask(String hostname) {
 
     @Override
     public String getName() {
-        return "Stop " + stageContext.getComponentDTO().getDisplayName();
+        return "Stop "
+                + StackUtils.getComponentDTO(stageContext.getComponentName()).getDisplayName();
     }
 }

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/stage/StageContext.java

@@ -22,8 +22,6 @@
 import org.apache.bigtop.manager.dao.repository.ClusterDao;
 import org.apache.bigtop.manager.server.holder.SpringContextHolder;
 import org.apache.bigtop.manager.server.model.dto.CommandDTO;
-import org.apache.bigtop.manager.server.model.dto.ComponentDTO;
-import org.apache.bigtop.manager.server.model.dto.ServiceDTO;
 import org.apache.bigtop.manager.server.model.dto.command.ClusterCommandDTO;
 
 import lombok.Data;
@@ -43,9 +41,9 @@ public class StageContext {
 
     private List<String> hostnames;
 
-    private ServiceDTO serviceDTO;
+    private String serviceName;
 
-    private ComponentDTO componentDTO;
+    private String componentName;
 
     public static StageContext fromCommandDTO(CommandDTO commandDTO) {
         StageContext context = new StageContext();

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/command/task/AbstractComponentTask.java

@@ -27,11 +27,14 @@
 import org.apache.bigtop.manager.grpc.payload.ComponentCommandPayload;
 import org.apache.bigtop.manager.grpc.pojo.PackageInfo;
 import org.apache.bigtop.manager.grpc.pojo.PackageSpecificInfo;
+import org.apache.bigtop.manager.grpc.pojo.TemplateInfo;
 import org.apache.bigtop.manager.server.grpc.GrpcClient;
 import org.apache.bigtop.manager.server.holder.SpringContextHolder;
 import org.apache.bigtop.manager.server.model.dto.PackageDTO;
 import org.apache.bigtop.manager.server.model.dto.PackageSpecificDTO;
+import org.apache.bigtop.manager.server.model.dto.ServiceDTO;
 import org.apache.bigtop.manager.server.model.dto.StackDTO;
+import org.apache.bigtop.manager.server.model.dto.TemplateDTO;
 import org.apache.bigtop.manager.server.utils.StackUtils;
 
 import java.util.ArrayList;
@@ -66,6 +69,8 @@ protected Boolean doRun(String hostname, Integer grpcPort) {
     @SuppressWarnings("unchecked")
     protected ComponentCommandRequest getComponentCommandRequest() {
         StackDTO stackDTO = StackUtils.getServiceStack(taskContext.getServiceName());
+        ServiceDTO serviceDTO = StackUtils.getServiceDTO(taskContext.getServiceName());
+
         ComponentCommandPayload payload = new ComponentCommandPayload();
         payload.setServiceName(taskContext.getServiceName());
         payload.setComponentName(taskContext.getComponentName());
@@ -75,10 +80,10 @@ protected ComponentCommandRequest getComponentCommandRequest() {
         payload.setCommand(getCommand().getCode());
         payload.setCustomCommand(getCustomCommand());
 
-        Map<String, Object> properties = taskContext.getProperties();
+        payload.setTemplates(convertTemplateInfo(serviceDTO.getName(), serviceDTO.getTemplates()));
+        payload.setPackageSpecifics(convertPackageSpecificInfo(serviceDTO.getPackageSpecifics()));
 
-        payload.setPackageSpecifics(
-                convertPackageSpecificInfo((List<PackageSpecificDTO>) properties.get("packageSpecifics")));
+        Map<String, Object> properties = taskContext.getProperties();
         if (stackDTO.getStackName().equals("infra")) {
             Map<String, List<String>> clusterHosts = (Map<String, List<String>>) properties.get("clusterHosts");
             payload.setClusterHosts(clusterHosts);
@@ -91,6 +96,25 @@ protected ComponentCommandRequest getComponentCommandRequest() {
         return requestBuilder.build();
     }
 
+    private List<TemplateInfo> convertTemplateInfo(String serviceName, List<TemplateDTO> templateDTOList) {
+        if (templateDTOList == null) {
+            return new ArrayList<>();
+        }
+
+        List<TemplateInfo> templateInfos = new ArrayList<>();
+        for (TemplateDTO templateDTO : templateDTOList) {
+            String content = StackUtils.SERVICE_TEMPLATE_MAP.get(serviceName).get(templateDTO.getSrc());
+
+            TemplateInfo templateInfo = new TemplateInfo();
+            templateInfo.setSrc(templateDTO.getSrc());
+            templateInfo.setDest(templateDTO.getDest());
+            templateInfo.setContent(content);
+            templateInfos.add(templateInfo);
+        }
+
+        return templateInfos;
+    }
+
     private List<PackageSpecificInfo> convertPackageSpecificInfo(List<PackageSpecificDTO> packageSpecificDTOList) {
         if (packageSpecificDTOList == null) {
             return new ArrayList<>();

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/model/dto/ServiceDTO.java

@@ -37,6 +37,8 @@ public class ServiceDTO {
 
     private List<PackageSpecificDTO> packageSpecifics;
 
+    private List<TemplateDTO> templates;
+
     private List<ComponentDTO> components;
 
     private List<ServiceConfigDTO> configs;

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/model/dto/TemplateDTO.java

@@ -0,0 +1,29 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF 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
+ *
+ *    https://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 org.apache.bigtop.manager.server.model.dto;
+
+import lombok.Data;
+
+@Data
+public class TemplateDTO {
+
+    private String src;
+
+    private String dest;
+}

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/stack/model/ServiceModel.java

@@ -50,6 +50,10 @@ public class ServiceModel {
     @XmlElements(@XmlElement(name = "component"))
     private List<ComponentModel> components;
 
+    @XmlElementWrapper(name = "templates")
+    @XmlElements(@XmlElement(name = "template"))
+    private List<TemplateModel> templates;
+
     @XmlElementWrapper(name = "required-services")
     @XmlElements(@XmlElement(name = "service"))
     private List<String> requiredServices;

bigtop-manager-server/src/main/java/org/apache/bigtop/manager/server/stack/model/TemplateModel.java

@@ -0,0 +1,33 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF 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
+ *
+ *    https://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 org.apache.bigtop.manager.server.stack.model;
+
+import lombok.Data;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+
+@Data
+@XmlAccessorType(XmlAccessType.FIELD)
+public class TemplateModel {
+
+    private String src;
+
+    private String dest;
+}