两个不同的 Jenkins 构建器可以存在于同一个 hpi 中并共享相同的全局配置吗?

Question

我需要创建两个不同的 Jenkins Builder 类。每个执行不同的操作，并且每个都需要自己的 .jelly，但是，两者都需要相同的全局配置 （global.jelly），该配置指定主机和一些用户凭据。
两种构建器的实例在其 perform（） 期间将使用凭据（也在全局配置中指定）连接到主机（在全局配置中指定）。

问题在于，在 Jenkins 中，您将每个构建器的资源放在与构建器类名对应的文件夹中，并且该资源文件包含 global.config。

如果我将配置复制到两个构建器的资源文件夹，我会得到两个相同的全局配置部分......

是否可以创建一个带有两个 Builder 类的 .hpi 类，每个类都有自己的 config.jelly 和帮助.html文件，但两者都共享相同的全局配置 （global.jelly）？

Answer 1

是的，这是很有可能的，但不是以扩展生成器的常规方式。您需要将其用作工作属性。让我们举一个例子来解释这是如何完成的。

您将至少有 3 个类/包。

• MyPluginClass - 包含所有全局配置的字段。
• MyBuildStepAClass - 实现了构建步骤 A。
• MyBuildStepBClass - 实现了构建步骤 B。

构建步骤类MyBuildStepAClass和MyBuildStepBClass的代码将与通常为具有单个构建步骤的插件编写的代码相同。以下是MyBuildStepAClass的示例..

public class MyBuildStepAClass {
    private String name;
    .....
    @DataBoundConstructor
    public MyBuildStepAClass(String name, ....) {
        this.name = name;
        ....
    }
    public String getName() {
        return name;
    }
    public boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener) {
       //logic for perform.
       ............
       return true;
    }
    @Extension
    public static class Descriptor extends BuildStepDescriptor<Builder> {
         public Descriptor() {
            load();
         }
         @Override
         public boolean configure(StaplerRequest req, JSONObject formData) throws FormException {
             req.bindJSON(this, formData);
             save();
             return super.configure(req,formData);
         }
         @Override
         public String getDisplayName() {
             return "My Build Step A";
         }
    }
}

要在两个插件类之间共享配置，您将从JobProperty<Job<?,?>>扩展MyPluginClass（而不是Builder），并使用Jenkins.getInstance().getDescriptor(getclass());重写getDescriptor()方法以返回描述符

public class MyPluginClass extends JobProperty<Job<?, ?>>  {
    @Override
    public MyPluginClassDescriptor getDescriptor() {
        return (MyPluginClassDescriptor)Jenkins.getInstance().getDescriptor(getClass());
    }
    public static MyPluginClassDescriptor getMyPluginClassDescriptor() {
        return (MyPluginClassDescriptor)Jenkins.getInstance().getDescriptor(MyPluginClass.class);
    }

    @Extension
    public static final class MyPluginClassDescriptor extends JobPropertyDescriptor {
        private String globalField1 = "";
        public MyPluginClassDescriptor() {
            super(MyPluginClass.class);
            load();
        }
        @Override
        public boolean configure(StaplerRequest req, JSONObject formData) throws FormException {
            req.bindJSON(this, formData);
            save();
            return super.configure(req,formData);
        }
        @DataBoundConstructor
        public MyPluginClassDescriptor(String globalField1, ....) {
            this.globalField1 = globalField1;
        }
        @Override
        public String getDisplayName() {
            return "IIBCI Plugin Configuration";
        }
        public getGlobalField1() {
            return globalField1;
        }
}

每个构建步骤的global.jelly和单个config.jelly文件的内容将是正常的，因为您将引用它们。希望这可以帮助您了解JobProperty如何帮助您在不同的构建步骤中访问单个配置。

已更新以包含有关果冻文件的信息。

您将在包中有一个 global.jelly 文件用于MyPluginClass 。此果冻文件将包含要在全局配置中呈现/存储的字段。

<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
  <f:section title="MyPlugin configuration">
    <f:entry title="Global field1" field="globalField1">
      <f:textbox  />
    </f:entry>
  </f:section>
</j:jelly>

每个生成步骤都有自己的 index.jelly 文件，其中包含特定于生成步骤的 jelly 代码。希望这能更清楚..

Answer 2

完全避免global.jelly。这是半弃用的。 JobProperty也只适用于需要按作业配置的情况，而请求是关于全局配置的。

相反，请使用为此目的而设计的GlobalConfiguration API。有一个标准的原型显示了如何使用它。