Rundeck自定义步骤数据传递教程

Rundeck自定义步骤间数据传递的挑战

在Rundeck中开发自定义插件，特别是NodeStepPlugin，经常会遇到一个常见的需求：在一个自定义步骤中生成的数据，需要在后续的另一个自定义步骤中被访问和使用。例如，一个名为GeneratorPlugin的步骤负责生成一系列变量，而另一个名为ConsumerPlugin的步骤则需要获取这些变量以执行后续操作。

开发者通常会尝试通过Rundeck提供的执行上下文（ExecutionContext）来共享数据。初次尝试时，可能会想到使用context.getExecutionContext().getSharedDataContext()来存储数据，期望这些数据能在不同的步骤之间共享。然而，实践中发现，通过SharedDataContext存储的值似乎并不能有效地传播到后续的自定义步骤中，导致数据无法被ConsumerPlugin正确读取。这给需要跨步骤传递数据的场景带来了困扰。

解决方案：利用PrivateDataContext

经过深入研究和实践，我们发现解决Rundeck自定义步骤间数据传递问题的关键在于使用context.getExecutionContext().getPrivateDataContext()。与SharedDataContext不同，PrivateDataContext提供了一个在当前作业执行生命周期内，在不同步骤之间有效共享数据的机制。当一个自定义步骤将数据放入PrivateDataContext后，后续的步骤可以在同一个作业执行流程中成功地检索到这些数据。

实现细节与示例代码

下面将通过具体的Java代码示例，展示如何在GeneratorPlugin中写入数据，以及如何在ConsumerPlugin中读取这些数据。

1. 数据生成步骤 (GeneratorPlugin)

在数据生成步骤中，您需要通过context.getExecutionContext().getPrivateDataContext().put("key", "value")方法将需要共享的数据存储起来。

import com.dtolabs.rundeck.core.plugins.NodeStepPlugin;
import com.dtolabs.rundeck.core.plugins.Plugin;
import com.dtolabs.rundeck.plugins.descriptions.PluginDescription;
import com.dtolabs.rundeck.plugins.step.NodeStepException;
import com.dtolabs.rundeck.plugins.step.PluginLogger;
import com.dtolabs.rundeck.plugins.step.NodeStepPluginArguments;
import com.dtolabs.rundeck.plugins.step.NodeStepExecutionContext;
import com.dtolabs.rundeck.core.common.INodeEntry;

import java.util.Map;

@Plugin(name = "GeneratorPlugin", service = "NodeStep")
@PluginDescription(title = "数据生成器插件", description = "生成数据并存入PrivateDataContext")
public class GeneratorPlugin implements NodeStepPlugin {

    @Override
    public void executeNodeStep(
            NodeStepExecutionContext context,
            Map configuration,
            INodeEntry node
    ) throws NodeStepException {
        PluginLogger logger = context.getLogger();
        logger.log(3, "GeneratorPlugin 正在执行...");

        // 模拟生成一些数据
        String generatedValue1 = "Hello from Generator!";
        Integer generatedValue2 = 12345;
        Boolean generatedValue3 = true;

        // 将数据存入PrivateDataContext
        // 注意：Rundeck通常将所有数据存储为字符串，读取时可能需要类型转换
        context.getExecutionContext().getPrivateDataContext().put("my.generated.string", generatedValue1);
        context.getExecutionContext().getPrivateDataContext().put("my.generated.integer", String.valueOf(generatedValue2));
        context.getExecutionContext().getPrivateDataContext().put("my.generated.boolean", String.valueOf(generatedValue3));

        logger.log(3, "数据已存入PrivateDataContext: my.generated.string='" + generatedValue1 + "'");
        logger.log(3, "数据已存入PrivateDataContext: my.generated.integer='" + generatedValue2 + "'");
        logger.log(3, "数据已存入PrivateDataContext: my.generated.boolean='" + generatedValue3 + "'");
        logger.log(3, "GeneratorPlugin 执行完毕。");
    }
}

2. 数据消费步骤 (ConsumerPlugin)

在数据消费步骤中，您可以通过context.getExecutionContext().getPrivateDataContext().get("key")方法从PrivateDataContext中检索之前存储的数据。

import com.dtolabs.rundeck.core.plugins.NodeStepPlugin;
import com.dtolabs.rundeck.core.plugins.Plugin;
import com.dtolabs.rundeck.plugins.descriptions.PluginDescription;
import com.dtolabs.rundeck.plugins.step.NodeStepException;
import com.dtolabs.rundeck.plugins.step.PluginLogger;
import com.dtolabs.rundeck.plugins.step.NodeStepPluginArguments;
import com.dtolabs.rundeck.plugins.step.NodeStepExecutionContext;
import com.dtolabs.rundeck.core.common.INodeEntry;

import java.util.Map;

@Plugin(name = "ConsumerPlugin", service = "NodeStep")
@PluginDescription(title = "数据消费者插件", description = "从PrivateDataContext读取数据")
public class ConsumerPlugin implements NodeStepPlugin {

    @Override
    public void executeNodeStep(
            NodeStepExecutionContext context,
            Map configuration,
            INodeEntry node
    ) throws NodeStepException {
        PluginLogger logger = context.getLogger();
        logger.log(3, "ConsumerPlugin 正在执行...");

        // 从PrivateDataContext中读取数据
        String retrievedString = context.getExecutionContext().getPrivateDataContext().get("my.generated.string");
        String retrievedIntegerStr = context.getExecutionContext().getPrivateDataContext().get("my.generated.integer");
        String retrievedBooleanStr = context.getExecutionContext().getPrivateDataContext().get("my.generated.boolean");

        logger.log(3, "从PrivateDataContext读取数据: my.generated.string='" + retrievedString + "'");
        logger.log(3, "从PrivateDataContext读取数据: my.generated.integer='" + retrievedIntegerStr + "'");
        logger.log(3, "从PrivateDataContext读取数据: my.generated.boolean='" + retrievedBooleanStr + "'");

        // 进行类型转换（如果需要）
        Integer retrievedInteger = null;
        if (retrievedIntegerStr != null) {
            try {
                retrievedInteger = Integer.parseInt(retrievedIntegerStr);
                logger.log(3, "转换后的整数: " + retrievedInteger);
            } catch (NumberFormatException e) {
                logger.error("无法将 '" + retrievedIntegerStr + "' 转换为整数: " + e.getMessage());
            }
        }

        Boolean retrievedBoolean = null;
        if (retrievedBooleanStr != null) {
            retrievedBoolean = Boolean.parseBoolean(retrievedBooleanStr);
            logger.log(3, "转换后的布尔值: " + retrievedBoolean);
        }

        // 进一步处理读取到的数据...
        if (retrievedString != null && retrievedString.equals("Hello from Generator!")) {
            logger.log(3, "成功验证字符串数据。");
        } else {
            logger.error("字符串数据验证失败或未找到。");
        }

        logger.log(3, "ConsumerPlugin 执行完毕。");
    }
}

注意事项

1. 数据类型： PrivateDataContext通常以字符串形式存储所有值。当您存储非字符串类型（如整数、布尔值）时，它们会被隐式转换为字符串。在读取时，您需要根据实际需求进行显式的类型转换（例如，使用Integer.parseInt()或Boolean.parseBoolean()）。
2. 键名唯一性： 确保您使用的键名（例如"my.generated.string"）在整个作业执行过程中是唯一的，以避免不同步骤或插件之间的数据覆盖。
3. 数据生命周期： PrivateDataContext中的数据仅在当前Rundeck作业的执行生命周期内有效。一旦作业完成，这些数据就会被清除。它不适用于跨不同作业或跨Rundeck实例的持久化数据存储。
4. 错误处理： 在消费步骤中读取数据时，务必进行空值检查（null检查），因为如果前一个步骤未能成功存储数据，或者键名不匹配，get()方法可能会返回null。同时，对于类型转换，也应包含适当的异常处理机制（如try-catch块）。
5. 日志记录： 在开发和调试过程中，充分利用PluginLogger记录数据的存储和检索情况，这对于问题排查非常有帮助。

总结

通过利用Rundeck执行上下文中的getPrivateDataContext()，开发者可以有效地在不同的自定义NodeStepPlugin之间程序化地传递数据。这解决了getSharedDataContext()在某些场景下无法有效传播数据的问题，为Rundeck自定义插件提供了强大的数据共享能力。遵循本文提供的示例代码和注意事项，您可以构建出更加健壮和功能丰富的Rundeck自动化流程。